@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.
Files changed (29) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-2uoEHa97.d.ts → ecom-v1-order-orders.universal-g2cTULHD.d.ts} +1697 -1693
  2. package/build/cjs/index.d.ts +8 -8
  3. package/build/cjs/index.js +80 -80
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +80 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1691 -1687
  9. package/build/cjs/meta.js +80 -80
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-2uoEHa97.d.mts → ecom-v1-order-orders.universal-g2cTULHD.d.mts} +1697 -1693
  12. package/build/es/index.d.mts +8 -8
  13. package/build/es/index.mjs +80 -80
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +80 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1691 -1687
  19. package/build/es/meta.mjs +80 -80
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-BVqsClnV.d.ts → ecom-v1-order-orders.universal-OwKKeXav.d.ts} +1827 -1833
  22. package/build/internal/cjs/index.d.ts +14 -14
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1815 -1821
  25. package/build/internal/es/{ecom-v1-order-orders.universal-BVqsClnV.d.mts → ecom-v1-order-orders.universal-OwKKeXav.d.mts} +1827 -1833
  26. package/build/internal/es/index.d.mts +14 -14
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1815 -1821
  29. package/package.json +2 -2
@@ -509,6 +509,10 @@ interface PhysicalProperties {
509
509
  sku?: string | null;
510
510
  /** Whether this line item is shippable. */
511
511
  shippable?: boolean;
512
+ /** Product dimensions (length, width, height of the physical product). */
513
+ productDimensions?: Dimensions;
514
+ /** Package dimensions (length, width, height of the shipping package). */
515
+ packageDimensions?: Dimensions;
512
516
  }
513
517
  interface Dimensions {
514
518
  /**
@@ -4109,163 +4113,461 @@ interface BulkDeleteImportedOrdersResponse {
4109
4113
  */
4110
4114
  jobId?: string;
4111
4115
  }
4112
- interface SendBuyerConfirmationEmailRequest {
4116
+ interface V1TriggerReindexRequest {
4113
4117
  /** @format GUID */
4114
- orderId?: string;
4115
- }
4116
- interface SendBuyerConfirmationEmailResponse {
4117
- }
4118
- interface SendBuyerPaymentsReceivedEmailRequest {
4118
+ metasiteId?: string;
4119
4119
  /**
4120
4120
  * @minLength 1
4121
4121
  * @maxLength 100
4122
+ * @maxSize 100
4122
4123
  */
4123
- orderId?: string;
4124
+ orderIds?: string[];
4124
4125
  }
4125
- interface SendBuyerPaymentsReceivedEmailResponse {
4126
+ interface V1TriggerReindexResponse {
4126
4127
  }
4127
- interface SendBuyerPickupConfirmationEmailRequest {
4128
+ interface V1TriggerReindexOrderRequest {
4129
+ /** @format GUID */
4130
+ metasiteId?: string;
4128
4131
  /**
4129
4132
  * @minLength 1
4130
4133
  * @maxLength 100
4131
4134
  */
4132
4135
  orderId?: string;
4133
4136
  }
4134
- interface SendBuyerPickupConfirmationEmailResponse {
4135
- }
4136
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
4137
- /**
4138
- * IDs of orders to send pickup emails for.
4139
- * @minSize 1
4140
- * @maxSize 300
4141
- */
4142
- orderIds?: string[];
4143
- }
4144
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
4145
- }
4146
- interface SendBuyerShippingConfirmationEmailRequest {
4137
+ interface PreparePaymentCollectionRequest {
4147
4138
  /**
4139
+ * Ecom order ID.
4148
4140
  * @minLength 1
4149
4141
  * @maxLength 100
4150
4142
  */
4151
- orderId?: string;
4152
- }
4153
- interface SendBuyerShippingConfirmationEmailResponse {
4154
- }
4155
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
4143
+ ecomOrderId: string;
4144
+ /** Amount to collect */
4145
+ amount: Price;
4156
4146
  /**
4157
- * IDs of orders to send pickup emails for.
4158
- * @minSize 1
4159
- * @maxSize 300
4147
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4148
+ * Existing payment gateway order will be updated with a new amount.
4149
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4160
4150
  */
4161
- orderIds?: string[];
4162
- }
4163
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
4164
- }
4165
- interface SendMerchantOrderReceivedNotificationRequest {
4151
+ paymentGatewayOrderId?: string | null;
4166
4152
  /**
4167
- * @minLength 1
4168
- * @maxLength 100
4153
+ * Whether to delay capture of the payment.
4154
+ * Default: false
4155
+ * @deprecated Whether to delay capture of the payment.
4156
+ * Default: false
4157
+ * @replacedBy delayed_capture_settings.scheduled_action
4158
+ * @targetRemovalDate 2024-09-30
4169
4159
  */
4170
- orderId?: string;
4171
- }
4172
- interface SendMerchantOrderReceivedNotificationResponse {
4160
+ delayedCapture?: boolean;
4161
+ /** Delayed capture payment settings */
4162
+ delayedCaptureSettings?: DelayedCaptureSettings;
4173
4163
  }
4174
- interface SendCancelRefundEmailRequest {
4164
+ interface RedirectUrls {
4175
4165
  /**
4176
- * The ID of order that is canceled/refunded
4177
- * @minLength 1
4178
- * @maxLength 100
4166
+ * URL to redirect buyer in case of approved (successful) transaction
4167
+ * @format WEB_URL
4179
4168
  */
4180
- orderId?: string;
4169
+ successUrl?: string | null;
4181
4170
  /**
4182
- * Personal note added to the email (optional)
4183
- * @minLength 1
4184
- * @maxLength 1000
4171
+ * URL to redirect buyer in case of buyer canceled the transaction
4172
+ * @format WEB_URL
4185
4173
  */
4186
- customMessage?: string | null;
4187
- /** Refund amount */
4188
- refundAmount?: Price;
4174
+ cancelUrl?: string | null;
4189
4175
  /**
4190
- * Refund ID. (Optional)
4191
- * @format GUID
4176
+ * URL to redirect buyer in case of failed/rejected transaction
4177
+ * @format WEB_URL
4192
4178
  */
4193
- refundId?: string | null;
4194
- }
4195
- interface SendCancelRefundEmailResponse {
4196
- }
4197
- interface SendRefundEmailRequest {
4179
+ errorUrl?: string | null;
4198
4180
  /**
4199
- * The ID of order that is refunded
4200
- * @format GUID
4181
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4182
+ * @format WEB_URL
4201
4183
  */
4202
- orderId?: string;
4184
+ pendingUrl?: string | null;
4185
+ }
4186
+ interface DelayedCaptureSettings {
4187
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4188
+ scheduledAction?: ScheduledActionWithLiterals;
4189
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4190
+ delayDuration?: Duration;
4191
+ }
4192
+ declare enum ScheduledAction {
4193
+ /** Whether payment will be auto-voided when duration passes */
4194
+ VOID = "VOID",
4195
+ /** Whether payment will be auto-captured when duration passes */
4196
+ CAPTURE = "CAPTURE"
4197
+ }
4198
+ /** @enumType */
4199
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4200
+ interface Duration {
4203
4201
  /**
4204
- * Refund ID
4205
- * @format GUID
4202
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4203
+ * @min 1
4206
4204
  */
4207
- refundId?: string;
4205
+ count?: number;
4206
+ /** Duration unit: MINUTES, HOURS and DAYS */
4207
+ unit?: DurationUnitWithLiterals;
4208
+ }
4209
+ declare enum DurationUnit {
4210
+ MINUTES = "MINUTES",
4211
+ HOURS = "HOURS",
4212
+ DAYS = "DAYS"
4213
+ }
4214
+ /** @enumType */
4215
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4216
+ interface PreparePaymentCollectionResponse {
4217
+ /** Payment gateway order id which is associated with given payment */
4218
+ paymentGatewayOrderId?: string;
4219
+ }
4220
+ interface GetPaymentCollectabilityStatusRequest {
4208
4221
  /**
4209
- * Personal note added to the email (optional)
4222
+ * Ecom order ID.
4210
4223
  * @minLength 1
4211
- * @maxLength 1000
4224
+ * @maxLength 100
4212
4225
  */
4213
- customMessage?: string | null;
4214
- }
4215
- interface SendRefundEmailResponse {
4226
+ ecomOrderId: string;
4216
4227
  }
4217
- interface SendFulfillmentEmailRequest {
4218
- /** @format GUID */
4219
- orderId?: string;
4220
- /** @format GUID */
4221
- fulfillerId?: string;
4228
+ interface GetPaymentCollectabilityStatusResponse {
4229
+ /** Payment collectability status */
4230
+ status?: PaymentCollectabilityStatusWithLiterals;
4231
+ /** Collectable order amount */
4232
+ amount?: Price;
4222
4233
  }
4223
- interface SendFulfillmentEmailResponse {
4234
+ declare enum PaymentCollectabilityStatus {
4235
+ UNKNOWN = "UNKNOWN",
4236
+ COLLECTABLE = "COLLECTABLE",
4237
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4238
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4239
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4240
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4241
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4242
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4243
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4244
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4245
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4246
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4247
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4224
4248
  }
4225
- interface SendMerchantOrderReceivedPushRequest {
4249
+ /** @enumType */
4250
+ 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';
4251
+ interface RecordManuallyCollectedPaymentRequest {
4226
4252
  /**
4253
+ * Order ID.
4227
4254
  * @minLength 1
4228
4255
  * @maxLength 100
4229
4256
  */
4230
- orderId?: string;
4257
+ orderId: string;
4258
+ /** Amount to be recorded as approved manual payment for given order */
4259
+ amount: Price;
4231
4260
  }
4232
- interface SendMerchantOrderReceivedPushResponse {
4261
+ /**
4262
+ * User-defined payment method name.
4263
+ * Allows specifying either a predefined type or a custom name.
4264
+ */
4265
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4266
+ /** Predefined payment method. */
4267
+ predefined?: PredefinedPaymentMethodWithLiterals;
4268
+ /**
4269
+ * Custom payment method name provided by user.
4270
+ *
4271
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4272
+ * @minLength 1
4273
+ * @maxLength 150
4274
+ */
4275
+ custom?: string | null;
4233
4276
  }
4234
- interface PreviewEmailByTypeRequest {
4235
- emailType?: PreviewEmailTypeWithLiterals;
4277
+ /** @oneof */
4278
+ interface UserDefinedPaymentMethodNameKindOneOf {
4279
+ /** Predefined payment method. */
4280
+ predefined?: PredefinedPaymentMethodWithLiterals;
4281
+ /**
4282
+ * Custom payment method name provided by user.
4283
+ *
4284
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4285
+ * @minLength 1
4286
+ * @maxLength 150
4287
+ */
4288
+ custom?: string | null;
4236
4289
  }
4237
- declare enum PreviewEmailType {
4238
- ORDER_PLACED = "ORDER_PLACED",
4239
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4240
- ORDER_SHIPPED = "ORDER_SHIPPED",
4241
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4290
+ /** Predefined payment method types for offline/manual payments. */
4291
+ declare enum PredefinedPaymentMethod {
4292
+ /** Cash payment. */
4293
+ CASH = "CASH",
4294
+ /** Bank transfer. */
4295
+ BANK_TRANSFER = "BANK_TRANSFER",
4296
+ /** Payment by check. */
4297
+ CHECK = "CHECK"
4242
4298
  }
4243
4299
  /** @enumType */
4244
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4245
- interface PreviewEmailByTypeResponse {
4246
- emailPreview?: string;
4300
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4301
+ interface RecordManuallyCollectedPaymentResponse {
4247
4302
  }
4248
- interface PreviewRefundEmailRequest {
4303
+ interface MarkOrderAsPaidRequest {
4249
4304
  /**
4305
+ * Ecom order ID.
4250
4306
  * @minLength 1
4251
4307
  * @maxLength 100
4252
4308
  */
4253
- orderId?: string;
4254
- /** Refund amount */
4255
- refundAmount?: Price;
4256
- /** Refund business details */
4257
- details?: RefundDetails;
4309
+ ecomOrderId: string;
4310
+ }
4311
+ interface MarkOrderAsPaidResponse {
4312
+ /** Updated order. */
4313
+ order?: Order;
4314
+ }
4315
+ interface BulkMarkOrdersAsPaidRequest {
4258
4316
  /**
4259
- * Personal note added to the email (optional)
4317
+ * IDs of orders to mark as paid.
4318
+ * @minSize 1
4319
+ * @maxSize 100
4260
4320
  * @minLength 1
4261
- * @maxLength 1000
4321
+ * @maxLength 100
4262
4322
  */
4263
- customMessage?: string | null;
4323
+ ecomOrderIds: string[];
4324
+ }
4325
+ interface BulkMarkOrdersAsPaidResponse {
4264
4326
  /**
4265
- * Refund ID. (Optional)
4266
- * @format GUID
4327
+ * Items updated by the bulk action.
4328
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4267
4329
  */
4268
- refundId?: string | null;
4330
+ results?: BulkOrderResult[];
4331
+ /** Bulk action metadata. */
4332
+ bulkActionMetadata?: BulkActionMetadata;
4333
+ }
4334
+ interface BulkOrderResult {
4335
+ /** Item metadata. */
4336
+ itemMetadata?: ItemMetadata;
4337
+ /**
4338
+ * Updated order.
4339
+ *
4340
+ * Returned when `returnFullEntity = true`.
4341
+ */
4342
+ item?: Order;
4343
+ }
4344
+ interface ItemMetadata {
4345
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4346
+ _id?: string | null;
4347
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
4348
+ originalIndex?: number;
4349
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4350
+ success?: boolean;
4351
+ /** Details about the error in case of failure. */
4352
+ error?: ApplicationError;
4353
+ }
4354
+ interface ApplicationError {
4355
+ /** Error code. */
4356
+ code?: string;
4357
+ /** Description of the error. */
4358
+ description?: string;
4359
+ /** Data related to the error. */
4360
+ data?: Record<string, any> | null;
4361
+ }
4362
+ interface BulkActionMetadata {
4363
+ /** Number of items that were successfully processed. */
4364
+ totalSuccesses?: number;
4365
+ /** Number of items that couldn't be processed. */
4366
+ totalFailures?: number;
4367
+ /** Number of failures without details because detailed failure threshold was exceeded. */
4368
+ undetailedFailures?: number;
4369
+ }
4370
+ interface GetRefundabilityStatusRequest {
4371
+ /**
4372
+ * Order ID.
4373
+ * @minLength 1
4374
+ * @maxLength 100
4375
+ */
4376
+ ecomOrderId: string;
4377
+ }
4378
+ interface GetRefundabilityStatusResponse {
4379
+ /**
4380
+ * Refundability details.
4381
+ * @maxSize 300
4382
+ */
4383
+ refundabilities?: Refundability[];
4384
+ /**
4385
+ * Whether the order supports refunding per item.
4386
+ * @deprecated
4387
+ */
4388
+ refundablePerItem?: boolean;
4389
+ }
4390
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4391
+ /** Reason why payment is not refundable. */
4392
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4393
+ /** Reason why payment is only refundable manually. */
4394
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4395
+ /** Payment ID. */
4396
+ paymentId?: string;
4397
+ /** Payment refundability status. */
4398
+ refundabilityStatus?: RefundableStatusWithLiterals;
4399
+ /** Link to payment provider dashboard. */
4400
+ providerLink?: string | null;
4401
+ }
4402
+ /** @oneof */
4403
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
4404
+ /** Reason why payment is not refundable. */
4405
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4406
+ /** Reason why payment is only refundable manually. */
4407
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4408
+ }
4409
+ declare enum RefundableStatus {
4410
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
4411
+ MANUAL = "MANUAL",
4412
+ REFUNDABLE = "REFUNDABLE"
4413
+ }
4414
+ /** @enumType */
4415
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4416
+ declare enum NonRefundableReason {
4417
+ NONE = "NONE",
4418
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
4419
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4420
+ INTERNAL_ERROR = "INTERNAL_ERROR",
4421
+ NOT_PAID = "NOT_PAID",
4422
+ ACCESS_DENIED = "ACCESS_DENIED",
4423
+ ZERO_PRICE = "ZERO_PRICE",
4424
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4425
+ PENDING_REFUND = "PENDING_REFUND",
4426
+ FORBIDDEN = "FORBIDDEN",
4427
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4428
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
4429
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4430
+ }
4431
+ /** @enumType */
4432
+ 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';
4433
+ declare enum ManuallyRefundableReason {
4434
+ EXPIRED = "EXPIRED",
4435
+ NOT_SUPPORTED = "NOT_SUPPORTED",
4436
+ OFFLINE = "OFFLINE",
4437
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4438
+ }
4439
+ /** @enumType */
4440
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4441
+ interface CreatePaymentGatewayOrderRequest {
4442
+ /**
4443
+ * Ecom order ID.
4444
+ * @minLength 1
4445
+ * @maxLength 100
4446
+ */
4447
+ ecomOrderId: string;
4448
+ /** Information about the user who initiated the payment. */
4449
+ chargedBy?: ChargedBy;
4450
+ }
4451
+ interface ChargedBy {
4452
+ /**
4453
+ * ID - id of the user who initiated the payment
4454
+ * @format GUID
4455
+ */
4456
+ _id?: string;
4457
+ /**
4458
+ * Full name - name of the user who initiated the payment
4459
+ * @minLength 1
4460
+ * @maxLength 200
4461
+ */
4462
+ fullName?: string | null;
4463
+ }
4464
+ interface CreatePaymentGatewayOrderResponse {
4465
+ /** ID of the order created in the payment gateway */
4466
+ paymentGatewayOrderId?: string;
4467
+ }
4468
+ interface ChargeMembershipsRequest {
4469
+ /**
4470
+ * Order ID.
4471
+ * @minLength 1
4472
+ * @maxLength 100
4473
+ */
4474
+ ecomOrderId: string;
4475
+ /**
4476
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4477
+ * but a user which is using the membership on behalf of the a member
4478
+ * @format GUID
4479
+ */
4480
+ memberId: string;
4481
+ /**
4482
+ * List of items to be paid by memberships
4483
+ * @minSize 1
4484
+ * @maxSize 300
4485
+ */
4486
+ membershipCharges?: MembershipChargeItem[];
4487
+ }
4488
+ interface MembershipChargeItem {
4489
+ /**
4490
+ * The id of used membership
4491
+ * @minLength 1
4492
+ * @maxLength 100
4493
+ */
4494
+ membershipId?: string;
4495
+ /**
4496
+ * ID of the application providing this payment option
4497
+ * @format GUID
4498
+ */
4499
+ appId?: string;
4500
+ /** The name of used membership */
4501
+ membershipName?: MembershipName;
4502
+ /** Additional data about this membership */
4503
+ membershipAdditionalData?: Record<string, any> | null;
4504
+ /** Catalog and item reference info. */
4505
+ catalogReference?: CatalogReference;
4506
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
4507
+ serviceProperties?: ServiceProperties;
4508
+ /**
4509
+ * Usually would be the same as catalogReference.catalogItemId
4510
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
4511
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4512
+ * @minLength 1
4513
+ * @maxLength 36
4514
+ */
4515
+ rootCatalogItemId?: string | null;
4516
+ /**
4517
+ * line item id of Checkout/Order line item
4518
+ * @minLength 1
4519
+ * @maxLength 100
4520
+ */
4521
+ lineItemId?: string;
4522
+ }
4523
+ interface MembershipName {
4524
+ /**
4525
+ * Membership name in the site's original language.
4526
+ * @maxLength 100
4527
+ */
4528
+ original?: string;
4529
+ /**
4530
+ * Membership name translated into the buyer's language.
4531
+ *
4532
+ * Default: The value of `original`
4533
+ * @maxLength 100
4534
+ */
4535
+ translated?: string | null;
4536
+ }
4537
+ interface ChargeMembershipsResponse {
4538
+ }
4539
+ interface TriggerRefundRequest {
4540
+ /**
4541
+ * The order this refund related to
4542
+ * @minLength 1
4543
+ * @maxLength 100
4544
+ */
4545
+ ecomOrderId: string;
4546
+ /**
4547
+ * Refund operations information
4548
+ * @minSize 1
4549
+ * @maxSize 1
4550
+ */
4551
+ payments: PaymentRefund[];
4552
+ /** Business model of a refund */
4553
+ details?: RefundDetails;
4554
+ /** Side effect details related to refund */
4555
+ sideEffects?: RefundSideEffects;
4556
+ }
4557
+ interface PaymentRefund {
4558
+ /**
4559
+ * Specific payment within the order to refund
4560
+ * @format GUID
4561
+ */
4562
+ paymentId?: string;
4563
+ /** Refund amount. Not relevant for membership and gift card refunds. */
4564
+ amount?: Price;
4565
+ /**
4566
+ * Whether refund is made externally and manually (on the payment provider's side)
4567
+ * 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.
4568
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4569
+ */
4570
+ externalRefund?: boolean;
4269
4571
  }
4270
4572
  /** Business model of a refund request */
4271
4573
  interface RefundDetails {
@@ -4342,1945 +4644,1647 @@ interface ShippingRefund {
4342
4644
  */
4343
4645
  amount?: Price;
4344
4646
  }
4345
- interface PreviewRefundEmailResponse {
4346
- emailPreview?: string;
4347
- }
4348
- interface PreviewCancelEmailRequest {
4647
+ interface RefundSideEffects {
4648
+ /** Inventory restock details as part of this refund. */
4649
+ restockInfo?: RestockInfo;
4650
+ /** Whether to send a refund confirmation email to the customer. */
4651
+ sendOrderRefundedEmail?: boolean;
4349
4652
  /**
4653
+ * Custom message added to the refund confirmation email.
4350
4654
  * @minLength 1
4351
- * @maxLength 100
4655
+ * @maxLength 1000
4352
4656
  */
4353
- orderId?: string;
4354
- /**
4355
- * Personal note added to the email (optional)
4356
- * @minLength 1
4357
- * @maxLength 1000
4358
- */
4359
- customMessage?: string | null;
4360
- }
4361
- interface PreviewCancelEmailResponse {
4362
- emailPreview?: string;
4363
- }
4364
- interface PreviewCancelRefundEmailRequest {
4365
- /**
4366
- * @minLength 1
4367
- * @maxLength 100
4368
- */
4369
- orderId?: string;
4370
- /**
4371
- * Personal note added to the email (optional)
4372
- * @minLength 1
4373
- * @maxLength 1000
4374
- */
4375
- customMessage?: string | null;
4376
- /** Refund amount */
4377
- refundAmount?: Price;
4378
- /**
4379
- * Refund ID. (Optional)
4380
- * @format GUID
4381
- */
4382
- refundId?: string | null;
4383
- }
4384
- interface PreviewCancelRefundEmailResponse {
4385
- emailPreview?: string;
4386
- }
4387
- interface PreviewBuyerPaymentsReceivedEmailRequest {
4388
- }
4389
- interface PreviewBuyerPaymentsReceivedEmailResponse {
4390
- emailPreview?: string;
4391
- }
4392
- interface PreviewBuyerConfirmationEmailRequest {
4393
- }
4394
- interface PreviewBuyerConfirmationEmailResponse {
4395
- emailPreview?: string;
4396
- }
4397
- interface PreviewBuyerPickupConfirmationEmailRequest {
4398
- }
4399
- interface PreviewBuyerPickupConfirmationEmailResponse {
4400
- emailPreview?: string;
4401
- }
4402
- interface PreviewShippingConfirmationEmailRequest {
4403
- }
4404
- interface PreviewShippingConfirmationEmailResponse {
4405
- emailPreview?: string;
4406
- }
4407
- interface PreviewResendDownloadLinksEmailRequest {
4408
- }
4409
- interface PreviewResendDownloadLinksEmailResponse {
4410
- emailPreview?: string;
4411
- }
4412
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4413
- /** Emitted on a meta site creation. */
4414
- siteCreated?: SiteCreated;
4415
- /** Emitted on a meta site transfer completion. */
4416
- siteTransferred?: SiteTransferred;
4417
- /** Emitted on a meta site deletion. */
4418
- siteDeleted?: SiteDeleted;
4419
- /** Emitted on a meta site restoration. */
4420
- siteUndeleted?: SiteUndeleted;
4421
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4422
- sitePublished?: SitePublished;
4423
- /** Emitted on a meta site unpublish. */
4424
- siteUnpublished?: SiteUnpublished;
4425
- /** Emitted when meta site is marked as template. */
4426
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4427
- /** Emitted when meta site is marked as a WixSite. */
4428
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4429
- /** Emitted when an application is provisioned (installed). */
4430
- serviceProvisioned?: ServiceProvisioned;
4431
- /** Emitted when an application is removed (uninstalled). */
4432
- serviceRemoved?: ServiceRemoved;
4433
- /** Emitted when meta site name (URL slug) is changed. */
4434
- siteRenamedPayload?: SiteRenamed;
4435
- /** Emitted when meta site was permanently deleted. */
4436
- hardDeleted?: SiteHardDeleted;
4437
- /** Emitted on a namespace change. */
4438
- namespaceChanged?: NamespaceChanged;
4439
- /** Emitted when Studio is attached. */
4440
- studioAssigned?: StudioAssigned;
4441
- /** Emitted when Studio is detached. */
4442
- studioUnassigned?: StudioUnassigned;
4443
- /**
4444
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4445
- * the actual URL.
4446
- *
4447
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4448
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4449
- */
4450
- urlChanged?: SiteUrlChanged;
4451
- /** Site is marked as PurgedExternally */
4452
- sitePurgedExternally?: SitePurgedExternally;
4453
- /** Emitted when Odeditor is attached. */
4454
- odeditorAssigned?: OdeditorAssigned;
4455
- /** Emitted when Odeditor is detached. */
4456
- odeditorUnassigned?: OdeditorUnassigned;
4457
- /** Emitted when Picasso is attached. */
4458
- picassoAssigned?: PicassoAssigned;
4459
- /** Emitted when Picasso is detached. */
4460
- picassoUnassigned?: PicassoUnassigned;
4461
- /** Emitted when Wixel is attached. */
4462
- wixelAssigned?: WixelAssigned;
4463
- /** Emitted when Wixel is detached. */
4464
- wixelUnassigned?: WixelUnassigned;
4465
- /** Emitted when StudioTwo is attached. */
4466
- studioTwoAssigned?: StudioTwoAssigned;
4467
- /** Emitted when StudioTwo is detached. */
4468
- studioTwoUnassigned?: StudioTwoUnassigned;
4469
- /** Emitted when media from user domain is enabled. */
4470
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4471
- /** Emitted when media from user domain is disabled. */
4472
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4473
- /** Emitted when Editorless is attached. */
4474
- editorlessAssigned?: EditorlessAssigned;
4475
- /** Emitted when Editorless is detached. */
4476
- editorlessUnassigned?: EditorlessUnassigned;
4477
- /**
4478
- * A meta site id.
4479
- * @format GUID
4480
- */
4481
- metaSiteId?: string;
4482
- /** A meta site version. Monotonically increasing. */
4483
- version?: string;
4484
- /** A timestamp of the event. */
4485
- timestamp?: string;
4486
- /**
4487
- * TODO(meta-site): Change validation once validations are disabled for consumers
4488
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4489
- * @maxSize 4000
4490
- */
4491
- assets?: Asset[];
4492
- }
4493
- /** @oneof */
4494
- interface MetaSiteSpecialEventPayloadOneOf {
4495
- /** Emitted on a meta site creation. */
4496
- siteCreated?: SiteCreated;
4497
- /** Emitted on a meta site transfer completion. */
4498
- siteTransferred?: SiteTransferred;
4499
- /** Emitted on a meta site deletion. */
4500
- siteDeleted?: SiteDeleted;
4501
- /** Emitted on a meta site restoration. */
4502
- siteUndeleted?: SiteUndeleted;
4503
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4504
- sitePublished?: SitePublished;
4505
- /** Emitted on a meta site unpublish. */
4506
- siteUnpublished?: SiteUnpublished;
4507
- /** Emitted when meta site is marked as template. */
4508
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4509
- /** Emitted when meta site is marked as a WixSite. */
4510
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4511
- /** Emitted when an application is provisioned (installed). */
4512
- serviceProvisioned?: ServiceProvisioned;
4513
- /** Emitted when an application is removed (uninstalled). */
4514
- serviceRemoved?: ServiceRemoved;
4515
- /** Emitted when meta site name (URL slug) is changed. */
4516
- siteRenamedPayload?: SiteRenamed;
4517
- /** Emitted when meta site was permanently deleted. */
4518
- hardDeleted?: SiteHardDeleted;
4519
- /** Emitted on a namespace change. */
4520
- namespaceChanged?: NamespaceChanged;
4521
- /** Emitted when Studio is attached. */
4522
- studioAssigned?: StudioAssigned;
4523
- /** Emitted when Studio is detached. */
4524
- studioUnassigned?: StudioUnassigned;
4525
- /**
4526
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4527
- * the actual URL.
4528
- *
4529
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4530
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4531
- */
4532
- urlChanged?: SiteUrlChanged;
4533
- /** Site is marked as PurgedExternally */
4534
- sitePurgedExternally?: SitePurgedExternally;
4535
- /** Emitted when Odeditor is attached. */
4536
- odeditorAssigned?: OdeditorAssigned;
4537
- /** Emitted when Odeditor is detached. */
4538
- odeditorUnassigned?: OdeditorUnassigned;
4539
- /** Emitted when Picasso is attached. */
4540
- picassoAssigned?: PicassoAssigned;
4541
- /** Emitted when Picasso is detached. */
4542
- picassoUnassigned?: PicassoUnassigned;
4543
- /** Emitted when Wixel is attached. */
4544
- wixelAssigned?: WixelAssigned;
4545
- /** Emitted when Wixel is detached. */
4546
- wixelUnassigned?: WixelUnassigned;
4547
- /** Emitted when StudioTwo is attached. */
4548
- studioTwoAssigned?: StudioTwoAssigned;
4549
- /** Emitted when StudioTwo is detached. */
4550
- studioTwoUnassigned?: StudioTwoUnassigned;
4551
- /** Emitted when media from user domain is enabled. */
4552
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4553
- /** Emitted when media from user domain is disabled. */
4554
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4555
- /** Emitted when Editorless is attached. */
4556
- editorlessAssigned?: EditorlessAssigned;
4557
- /** Emitted when Editorless is detached. */
4558
- editorlessUnassigned?: EditorlessUnassigned;
4559
- }
4560
- interface Asset {
4561
- /**
4562
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4563
- * @maxLength 36
4564
- */
4565
- appDefId?: string;
4566
- /**
4567
- * An instance id. For legacy reasons may be UUID or a string.
4568
- * @maxLength 200
4569
- */
4570
- instanceId?: string;
4571
- /** An application state. */
4572
- state?: StateWithLiterals;
4573
- }
4574
- declare enum State {
4575
- UNKNOWN = "UNKNOWN",
4576
- ENABLED = "ENABLED",
4577
- DISABLED = "DISABLED",
4578
- PENDING = "PENDING",
4579
- DEMO = "DEMO"
4580
- }
4581
- /** @enumType */
4582
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4583
- interface SiteCreated {
4584
- /**
4585
- * A template identifier (empty if not created from a template).
4586
- * @maxLength 36
4587
- */
4588
- originTemplateId?: string;
4589
- /**
4590
- * An account id of the owner.
4591
- * @format GUID
4592
- */
4593
- ownerId?: string;
4594
- /** A context in which meta site was created. */
4595
- context?: SiteCreatedContextWithLiterals;
4596
- /**
4597
- * A meta site id from which this site was created.
4598
- *
4599
- * In case of a creation from a template it's a template id.
4600
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4601
- * @format GUID
4602
- */
4603
- originMetaSiteId?: string | null;
4604
- /**
4605
- * A meta site name (URL slug).
4606
- * @maxLength 20
4607
- */
4608
- siteName?: string;
4609
- /** A namespace. */
4610
- namespace?: NamespaceWithLiterals;
4611
- }
4612
- declare enum SiteCreatedContext {
4613
- /** A valid option, we don't expose all reasons why site might be created. */
4614
- OTHER = "OTHER",
4615
- /** A meta site was created from template. */
4616
- FROM_TEMPLATE = "FROM_TEMPLATE",
4617
- /** A meta site was created by copying of the transfferred meta site. */
4618
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4619
- /** A copy of existing meta site. */
4620
- DUPLICATE = "DUPLICATE",
4621
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4622
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4623
- /** deprecated A meta site was created for Flash editor. */
4624
- FLASH = "FLASH"
4625
- }
4626
- /** @enumType */
4627
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4628
- declare enum Namespace {
4629
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4630
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4631
- WIX = "WIX",
4632
- /** 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. */
4633
- SHOUT_OUT = "SHOUT_OUT",
4634
- /** 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. */
4635
- ALBUMS = "ALBUMS",
4636
- /** 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. */
4637
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4638
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4639
- HOTELS = "HOTELS",
4640
- /** 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. */
4641
- CLUBS = "CLUBS",
4642
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4643
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4644
- /**
4645
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
4646
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
4647
- */
4648
- DEV_SITE = "DEV_SITE",
4649
- /** 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. */
4650
- LOGOS = "LOGOS",
4651
- /** 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. */
4652
- VIDEO_MAKER = "VIDEO_MAKER",
4653
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4654
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4655
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4656
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4657
+ customMessage?: string | null;
4658
+ }
4659
+ interface RestockInfo {
4660
+ /** Restock type. */
4661
+ type?: RestockTypeWithLiterals;
4657
4662
  /**
4658
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4659
- *
4660
- * Meta site with this namespace will *not* be shown in a user's site list by default.
4663
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4664
+ * @maxSize 300
4661
4665
  */
4662
- HTML_DRAFT = "HTML_DRAFT",
4666
+ items?: RestockItem[];
4667
+ }
4668
+ declare enum RestockType {
4669
+ NO_ITEMS = "NO_ITEMS",
4670
+ ALL_ITEMS = "ALL_ITEMS",
4671
+ SOME_ITEMS = "SOME_ITEMS"
4672
+ }
4673
+ /** @enumType */
4674
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4675
+ interface RestockItem {
4663
4676
  /**
4664
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4665
- * Will be accessible from Site List and will not have a website app.
4666
- * Once the user attaches a site, the site will become a regular wixsite.
4677
+ * ID of the line item being restocked.
4678
+ * @format GUID
4667
4679
  */
4668
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
4669
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4670
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
4671
- /** It is to be used in the Business First efforts. */
4672
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
4673
- /** Bookings business flow with no site. */
4674
- ANYWHERE = "ANYWHERE",
4675
- /** Namespace for Headless Backoffice with no editor */
4676
- HEADLESS = "HEADLESS",
4680
+ lineItemId?: string;
4677
4681
  /**
4678
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4679
- * The site will be used for account level CSM feature for enterprise
4682
+ * Line item quantity being restocked.
4683
+ * @min 1
4684
+ * @max 100000
4680
4685
  */
4681
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4682
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4683
- RISE = "RISE",
4686
+ quantity?: number;
4687
+ }
4688
+ interface TriggerRefundResponse {
4689
+ /** All order's transactions after the refunds were added */
4690
+ orderTransactions?: OrderTransactions;
4691
+ /** Created refund ID */
4692
+ refundId?: string | null;
4693
+ /** Payment ID's that the refund execution had failed for */
4694
+ failedPaymentIds?: ItemMetadata[];
4695
+ }
4696
+ /**
4697
+ * A record of all payments and refunds associated with an order.
4698
+ *
4699
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4700
+ */
4701
+ interface OrderTransactions {
4684
4702
  /**
4685
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4686
- * There's a blank site behind the scene but it's blank).
4687
- * The Mobile company will be the owner of this namespace.
4703
+ * Order ID.
4704
+ * @format GUID
4688
4705
  */
4689
- BRANDED_FIRST = "BRANDED_FIRST",
4690
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4691
- NOWNIA = "NOWNIA",
4706
+ orderId?: string;
4692
4707
  /**
4693
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
4694
- * The Partners company owns this namespace.
4708
+ * Record of payments made to the merchant.
4709
+ * @maxSize 100
4695
4710
  */
4696
- UGC_TEMPLATE = "UGC_TEMPLATE",
4697
- /** Codux Headless Sites */
4698
- CODUX = "CODUX",
4699
- /** Bobb - AI Design Creator. */
4700
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4711
+ payments?: Payment[];
4701
4712
  /**
4702
- * Shared Blog Site is a unique single site across Enterprise account,
4703
- * This site will hold all Blog posts related to the Marketing product.
4713
+ * Record of refunds made to the buyer.
4714
+ * @maxSize 300
4704
4715
  */
4705
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4706
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4707
- STANDALONE_FORMS = "STANDALONE_FORMS",
4708
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4709
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
4710
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4711
- MIMIR = "MIMIR",
4712
- /** Wix Twins platform. */
4713
- TWINS = "TWINS",
4714
- /** Wix Nano. */
4715
- NANO = "NANO",
4716
- /** Base44 headless sites. */
4717
- BASE44 = "BASE44",
4718
- /** Wix Channels Sites */
4719
- CHANNELS = "CHANNELS",
4720
- /** Nautilus platform. */
4721
- NAUTILUS = "NAUTILUS",
4716
+ refunds?: Refund[];
4717
+ }
4718
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
4719
+ /** Regular payment details. */
4720
+ regularPaymentDetails?: RegularPaymentDetails;
4721
+ /** Gift card payment details. */
4722
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4723
+ /** Membership payment details. */
4724
+ membershipPaymentDetails?: MembershipPaymentDetails;
4722
4725
  /**
4723
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
4724
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
4726
+ * Payment ID.
4727
+ * @format GUID
4728
+ * @readonly
4725
4729
  */
4726
- SYMPHONY = "SYMPHONY",
4727
- /** Nautilus platform app. */
4728
- NAUTILUS_APPS = "NAUTILUS_APPS",
4730
+ _id?: string | null;
4731
+ /** 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. */
4732
+ _createdDate?: Date | null;
4729
4733
  /**
4730
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
4731
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
4734
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4735
+ * @readonly
4732
4736
  */
4733
- VIBU = "VIBU",
4737
+ _updatedDate?: Date | null;
4738
+ /** Payment amount. */
4739
+ amount?: Price;
4734
4740
  /**
4735
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
4736
- * (an Enterprise account may have several), holding that BrandKit's brand definition
4737
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
4738
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
4741
+ * Whether refunds for this payment are disabled.
4742
+ * + `true`: This payment is not refundable.
4743
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4739
4744
  */
4740
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
4745
+ refundDisabled?: boolean;
4741
4746
  /**
4742
- * Dev-center development sites (com.wixpress.devcenter.dsm).
4743
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
4747
+ * Whether receipt generation is allowed for this payment.
4748
+ * + `true`: This payment supports receipt generation.
4749
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
4750
+ * @readonly
4744
4751
  */
4745
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
4746
- }
4747
- /** @enumType */
4748
- 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';
4749
- /** Site transferred to another user. */
4750
- interface SiteTransferred {
4752
+ supportReceiptGeneration?: boolean;
4753
+ /** Details about cash rounding applied to this payment, when relevant. */
4754
+ cashRounding?: CashRoundingDetails;
4751
4755
  /**
4752
- * A previous owner id (user that transfers meta site).
4753
- * @format GUID
4756
+ * Overall payment status.
4757
+ *
4758
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
4754
4759
  */
4755
- oldOwnerId?: string;
4760
+ status?: PaymentStatusWithLiterals;
4756
4761
  /**
4757
- * A new owner id (user that accepts meta site).
4762
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
4758
4763
  * @format GUID
4759
4764
  */
4760
- newOwnerId?: string;
4761
- }
4762
- /** Soft deletion of the meta site. Could be restored. */
4763
- interface SiteDeleted {
4764
- /** A deletion context. */
4765
- deleteContext?: DeleteContext;
4766
- }
4767
- interface DeleteContext {
4768
- /** When the meta site was deleted. */
4769
- dateDeleted?: Date | null;
4770
- /** A status. */
4771
- deleteStatus?: DeleteStatusWithLiterals;
4772
- /**
4773
- * A reason (flow).
4774
- * @maxLength 255
4775
- */
4776
- deleteOrigin?: string;
4777
- /**
4778
- * A service that deleted it.
4779
- * @maxLength 255
4780
- */
4781
- initiatorId?: string | null;
4765
+ chargeCorrelationId?: string | null;
4782
4766
  }
4783
- declare enum DeleteStatus {
4784
- UNKNOWN = "UNKNOWN",
4785
- TRASH = "TRASH",
4786
- DELETED = "DELETED",
4787
- PENDING_PURGE = "PENDING_PURGE",
4788
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4767
+ /** @oneof */
4768
+ interface PaymentPaymentDetailsOneOf {
4769
+ /** Regular payment details. */
4770
+ regularPaymentDetails?: RegularPaymentDetails;
4771
+ /** Gift card payment details. */
4772
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4773
+ /** Membership payment details. */
4774
+ membershipPaymentDetails?: MembershipPaymentDetails;
4789
4775
  }
4790
- /** @enumType */
4791
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4792
- /** Restoration of the meta site. */
4793
- interface SiteUndeleted {
4776
+ /** @oneof */
4777
+ interface PaymentReceiptInfoOneOf {
4794
4778
  }
4795
- /** First publish of a meta site. Or subsequent publish after unpublish. */
4796
- interface SitePublished {
4779
+ /** @oneof */
4780
+ interface PaymentStatusDetailsOneOf {
4797
4781
  }
4798
- interface SiteUnpublished {
4782
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4783
+ /** Credit card details. */
4784
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4799
4785
  /**
4800
- * A list of URLs previously associated with the meta site.
4801
- * @maxLength 4000
4802
- * @maxSize 10000
4786
+ * Wix Payments order ID.
4787
+ * @maxLength 100
4803
4788
  */
4804
- urls?: string[];
4805
- }
4806
- interface SiteMarkedAsTemplate {
4807
- }
4808
- interface SiteMarkedAsWixSite {
4809
- }
4810
- /**
4811
- * Represents a service provisioned a site.
4812
- *
4813
- * Note on `origin_instance_id`:
4814
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4815
- * This is because of the following scenario:
4816
- *
4817
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
4818
- * such as a product catalog. When you create a site from this template, you inherit this
4819
- * default product catalog. However, if the template's product catalog is modified,
4820
- * your site will retain the catalog as it was at the time of site creation. This ensures that
4821
- * your site remains consistent with what you initially received and does not include any
4822
- * changes made to the original template afterward.
4823
- * To ensure this, the TPA on the template gets a new instance_id.
4824
- */
4825
- interface ServiceProvisioned {
4789
+ paymentOrderId?: string | null;
4826
4790
  /**
4827
- * Either UUID or EmbeddedServiceType.
4828
- * @maxLength 36
4791
+ * Payment gateway's transaction ID.
4792
+ * This field is only returned when the value of `offline_payment` is `false`.
4793
+ * @maxLength 100
4794
+ */
4795
+ gatewayTransactionId?: string | null;
4796
+ /**
4797
+ * Payment method.
4798
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4799
+ * Non-exhaustive list of supported values:
4800
+ * + `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`
4801
+ * @maxLength 150
4802
+ * @deprecated Payment method.
4803
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4804
+ * Non-exhaustive list of supported values:
4805
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
4806
+ * @replacedBy payment_method_name
4807
+ * @targetRemovalDate 2026-07-01
4829
4808
  */
4830
- appDefId?: string;
4809
+ paymentMethod?: string | null;
4831
4810
  /**
4832
- * Not only UUID. Something here could be something weird.
4833
- * @maxLength 36
4811
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4812
+ * @maxLength 100
4834
4813
  */
4835
- instanceId?: string;
4814
+ providerTransactionId?: string | null;
4815
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4816
+ offlinePayment?: boolean;
4836
4817
  /**
4837
- * An instance id from which this instance is originated.
4838
- * @maxLength 36
4818
+ * Payment status.
4819
+ * @deprecated Payment status.
4820
+ * @replacedBy payment.status
4821
+ * @targetRemovalDate 2026-11-01
4839
4822
  */
4840
- originInstanceId?: string;
4823
+ status?: TransactionStatusWithLiterals;
4824
+ /** Whether there is a payment agreement that allows for future charges. */
4825
+ savedPaymentMethod?: boolean;
4826
+ /** Authorization details. */
4827
+ authorizationDetails?: AuthorizationDetails;
4841
4828
  /**
4842
- * A version.
4843
- * @maxLength 500
4829
+ * Record of chargebacks made by the buyer.
4830
+ * @maxSize 6
4844
4831
  */
4845
- version?: string | null;
4832
+ chargebacks?: Chargeback[];
4833
+ /** Platform fee amount associated with this payment. */
4834
+ platformFee?: Price;
4846
4835
  /**
4847
- * The origin meta site id
4848
- * @format GUID
4836
+ * Payment method with buyer and optional owner translations.
4837
+ * Non-exhaustive list of supported values:
4838
+ * + `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`
4849
4839
  */
4850
- originMetaSiteId?: string | null;
4840
+ paymentMethodName?: PaymentMethodName;
4851
4841
  }
4852
- interface ServiceRemoved {
4853
- /**
4854
- * Either UUID or EmbeddedServiceType.
4855
- * @maxLength 36
4856
- */
4857
- appDefId?: string;
4842
+ /** @oneof */
4843
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4844
+ /** Credit card details. */
4845
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4846
+ }
4847
+ declare enum TransactionStatus {
4848
+ UNDEFINED = "UNDEFINED",
4849
+ APPROVED = "APPROVED",
4850
+ PENDING = "PENDING",
4851
+ PENDING_MERCHANT = "PENDING_MERCHANT",
4852
+ CANCELED = "CANCELED",
4853
+ DECLINED = "DECLINED",
4854
+ REFUNDED = "REFUNDED",
4855
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4856
+ AUTHORIZED = "AUTHORIZED",
4857
+ VOIDED = "VOIDED"
4858
+ }
4859
+ /** @enumType */
4860
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4861
+ interface CreditCardPaymentMethodDetails {
4858
4862
  /**
4859
- * Not only UUID. Something here could be something weird.
4860
- * @maxLength 36
4863
+ * The last 4 digits of the card number.
4864
+ * @maxLength 4
4861
4865
  */
4862
- instanceId?: string;
4866
+ lastFourDigits?: string | null;
4863
4867
  /**
4864
- * A version.
4865
- * @maxLength 500
4868
+ * Card issuer's brand.
4869
+ * @maxLength 100
4866
4870
  */
4867
- version?: string | null;
4871
+ brand?: string | null;
4868
4872
  }
4869
- /** Rename of the site. Meaning, free public url has been changed as well. */
4870
- interface SiteRenamed {
4873
+ interface AuthorizationDetails {
4871
4874
  /**
4872
- * A new meta site name (URL slug).
4873
- * @maxLength 20
4875
+ * Whether the authorized payment is of a delayed capture.
4876
+ * @readonly
4874
4877
  */
4875
- newSiteName?: string;
4878
+ delayedCapture?: boolean;
4879
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4880
+ authorizedDate?: Date | null;
4876
4881
  /**
4877
- * A previous meta site name (URL slug).
4878
- * @maxLength 255
4882
+ * List of captures associated with payment
4883
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4884
+ * @maxSize 1
4879
4885
  */
4880
- oldSiteName?: string;
4881
- }
4882
- /**
4883
- * Hard deletion of the meta site.
4884
- *
4885
- * Could not be restored. Therefore it's desirable to cleanup data.
4886
- */
4887
- interface SiteHardDeleted {
4888
- /** A deletion context. */
4889
- deleteContext?: DeleteContext;
4890
- }
4891
- interface NamespaceChanged {
4892
- /** A previous namespace. */
4893
- oldNamespace?: NamespaceWithLiterals;
4894
- /** A new namespace. */
4895
- newNamespace?: NamespaceWithLiterals;
4896
- }
4897
- /** Assigned Studio editor */
4898
- interface StudioAssigned {
4899
- }
4900
- /** Unassigned Studio editor */
4901
- interface StudioUnassigned {
4902
- }
4903
- /**
4904
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4905
- *
4906
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4907
- * with sites and its urls, you need to listen to another topic/event. Read about it:
4908
- *
4909
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4910
- */
4911
- interface SiteUrlChanged {
4886
+ captures?: AuthorizationCapture[];
4887
+ /** Void associated with payment */
4888
+ void?: AuthorizationVoid;
4889
+ /** Scheduled action for this transaction */
4890
+ scheduledAction?: V1ScheduledAction;
4912
4891
  }
4913
- /**
4914
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4915
- * Consumed by other teams to remove relevant data.
4916
- */
4917
- interface SitePurgedExternally {
4892
+ interface AuthorizationCapture {
4918
4893
  /**
4919
- * @maxLength 2048
4920
- * @maxSize 100
4921
- * @deprecated
4922
- * @targetRemovalDate 2025-04-15
4894
+ * Capture ID.
4895
+ * @format GUID
4896
+ * @readonly
4923
4897
  */
4924
- appDefId?: string[];
4925
- }
4926
- /** Assigned Odeditor */
4927
- interface OdeditorAssigned {
4928
- }
4929
- /** Unassigned Odeditor */
4930
- interface OdeditorUnassigned {
4931
- }
4932
- /** Assigned Picasso editor */
4933
- interface PicassoAssigned {
4934
- }
4935
- /** Unassigned Picasso */
4936
- interface PicassoUnassigned {
4937
- }
4938
- /** Assigned Wixel */
4939
- interface WixelAssigned {
4940
- }
4941
- /** Unassigned Wixel */
4942
- interface WixelUnassigned {
4943
- }
4944
- /** Assigned StudioTwo */
4945
- interface StudioTwoAssigned {
4946
- }
4947
- /** Unassigned StudioTwo */
4948
- interface StudioTwoUnassigned {
4949
- }
4950
- /** Media from user domain is enabled. */
4951
- interface UserDomainMediaEnabled {
4952
- }
4953
- /** Media from user domain is disabled. */
4954
- interface UserDomainMediaDisabled {
4955
- }
4956
- /** Assigned Editorless */
4957
- interface EditorlessAssigned {
4958
- }
4959
- /** Unassigned Editorless */
4960
- interface EditorlessUnassigned {
4898
+ _id?: string | null;
4899
+ /** Status of this capture action */
4900
+ status?: AuthorizationCaptureStatusWithLiterals;
4901
+ /**
4902
+ * Amount of this capture
4903
+ * @immutable
4904
+ */
4905
+ amount?: Price;
4906
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4907
+ _createdDate?: Date | null;
4908
+ /** In case of status is FAILED may contain failure details */
4909
+ failureDetails?: AuthorizationActionFailureDetails;
4961
4910
  }
4962
- interface HasCustomEmailConfigurationsRequest {
4911
+ declare enum AuthorizationCaptureStatus {
4912
+ /** Capture operation still in progress. */
4913
+ PENDING = "PENDING",
4914
+ /** Capture operation succeeded. */
4915
+ SUCCEEDED = "SUCCEEDED",
4916
+ /** Capture operation failed. */
4917
+ FAILED = "FAILED"
4963
4918
  }
4964
- interface HasCustomEmailConfigurationsResponse {
4965
- hasCustomConfigurations?: boolean;
4919
+ /** @enumType */
4920
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4921
+ interface AuthorizationActionFailureDetails {
4922
+ /** @maxLength 100 */
4923
+ failureCode?: string;
4966
4924
  }
4967
- interface AddToAutomationMigrationPopulationRequest {
4968
- /** When true, sends custom email configurations to automation system via email */
4969
- sendCustomEmailConfigs?: boolean;
4970
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4971
- origin?: OriginWithLiterals;
4925
+ interface AuthorizationVoid {
4926
+ /** Status of this void action */
4927
+ status?: AuthorizationVoidStatusWithLiterals;
4928
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4929
+ voidedDate?: Date | null;
4930
+ /** In case of status is FAILED may contain failure details */
4931
+ failureDetails?: AuthorizationActionFailureDetails;
4932
+ /** Reason of void action */
4933
+ reason?: ReasonWithLiterals;
4972
4934
  }
4973
- declare enum Origin {
4974
- OPT_IN = "OPT_IN",
4975
- MIGRATION = "MIGRATION"
4935
+ declare enum AuthorizationVoidStatus {
4936
+ /** Void operation still in progress. */
4937
+ PENDING = "PENDING",
4938
+ /** Void operation succeeded. */
4939
+ SUCCEEDED = "SUCCEEDED",
4940
+ /** Void operation failed. */
4941
+ FAILED = "FAILED"
4976
4942
  }
4977
4943
  /** @enumType */
4978
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4979
- interface AddToAutomationMigrationPopulationResponse {
4980
- success?: boolean;
4944
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4945
+ /** Reason the authorization was voided. */
4946
+ declare enum Reason {
4947
+ /** Authorization was voided by user. */
4948
+ MANUAL = "MANUAL",
4949
+ /** Authorization passed execution date. */
4950
+ SCHEDULED = "SCHEDULED"
4981
4951
  }
4982
- interface IsInAutomationMigrationPopulationRequest {
4952
+ /** @enumType */
4953
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4954
+ interface V1ScheduledAction {
4955
+ /** Type of the action. */
4956
+ actionType?: ActionTypeWithLiterals;
4957
+ /** The date and time of the action. */
4958
+ executionDate?: Date | null;
4983
4959
  }
4984
- interface IsInAutomationMigrationPopulationResponse {
4985
- inPopulation?: boolean;
4960
+ declare enum ActionType {
4961
+ VOID = "VOID",
4962
+ CAPTURE = "CAPTURE"
4986
4963
  }
4987
- interface PreparePaymentCollectionRequest {
4988
- /**
4989
- * Ecom order ID.
4990
- * @minLength 1
4991
- * @maxLength 100
4992
- */
4993
- ecomOrderId: string;
4994
- /** Amount to collect */
4995
- amount: Price;
4996
- /**
4997
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4998
- * Existing payment gateway order will be updated with a new amount.
4999
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
5000
- */
5001
- paymentGatewayOrderId?: string | null;
4964
+ /** @enumType */
4965
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4966
+ interface Chargeback {
5002
4967
  /**
5003
- * Whether to delay capture of the payment.
5004
- * Default: false
5005
- * @deprecated Whether to delay capture of the payment.
5006
- * Default: false
5007
- * @replacedBy delayed_capture_settings.scheduled_action
5008
- * @targetRemovalDate 2024-09-30
4968
+ * Chargeback ID.
4969
+ * @format GUID
4970
+ * @readonly
4971
+ * @immutable
5009
4972
  */
5010
- delayedCapture?: boolean;
5011
- /** Delayed capture payment settings */
5012
- delayedCaptureSettings?: DelayedCaptureSettings;
5013
- }
5014
- interface RedirectUrls {
4973
+ _id?: string;
5015
4974
  /**
5016
- * URL to redirect buyer in case of approved (successful) transaction
5017
- * @format WEB_URL
4975
+ * 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.
4976
+ * @readonly
4977
+ * @immutable
5018
4978
  */
5019
- successUrl?: string | null;
4979
+ _createdDate?: Date | null;
5020
4980
  /**
5021
- * URL to redirect buyer in case of buyer canceled the transaction
5022
- * @format WEB_URL
4981
+ * 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.
4982
+ * @readonly
5023
4983
  */
5024
- cancelUrl?: string | null;
4984
+ _updatedDate?: Date | null;
5025
4985
  /**
5026
- * URL to redirect buyer in case of failed/rejected transaction
5027
- * @format WEB_URL
4986
+ * Amount.
4987
+ * @readonly
4988
+ * @immutable
5028
4989
  */
5029
- errorUrl?: string | null;
4990
+ amount?: Price;
5030
4991
  /**
5031
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
5032
- * @format WEB_URL
4992
+ * Reversal amount. Present only when status is REVERSED.
4993
+ * @readonly
5033
4994
  */
5034
- pendingUrl?: string | null;
5035
- }
5036
- interface DelayedCaptureSettings {
5037
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5038
- scheduledAction?: ScheduledActionWithLiterals;
5039
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
5040
- delayDuration?: Duration;
5041
- }
5042
- declare enum ScheduledAction {
5043
- /** Whether payment will be auto-voided when duration passes */
5044
- VOID = "VOID",
5045
- /** Whether payment will be auto-captured when duration passes */
5046
- CAPTURE = "CAPTURE"
5047
- }
5048
- /** @enumType */
5049
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5050
- interface Duration {
4995
+ reversalAmount?: Price;
5051
4996
  /**
5052
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5053
- * @min 1
4997
+ * Status.
4998
+ *
4999
+ * Default: `"APPROVED"`.
5054
5000
  */
5055
- count?: number;
5056
- /** Duration unit: MINUTES, HOURS and DAYS */
5057
- unit?: DurationUnitWithLiterals;
5058
- }
5059
- declare enum DurationUnit {
5060
- MINUTES = "MINUTES",
5061
- HOURS = "HOURS",
5062
- DAYS = "DAYS"
5063
- }
5064
- /** @enumType */
5065
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5066
- interface PreparePaymentCollectionResponse {
5067
- /** Payment gateway order id which is associated with given payment */
5068
- paymentGatewayOrderId?: string;
5069
- }
5070
- interface GetPaymentCollectabilityStatusRequest {
5001
+ status?: ChargebackStatusWithLiterals;
5071
5002
  /**
5072
- * Ecom order ID.
5073
- * @minLength 1
5074
- * @maxLength 100
5003
+ * External chargeback ID.
5004
+ * @format GUID
5005
+ * @readonly
5006
+ * @immutable
5075
5007
  */
5076
- ecomOrderId: string;
5077
- }
5078
- interface GetPaymentCollectabilityStatusResponse {
5079
- /** Payment collectability status */
5080
- status?: PaymentCollectabilityStatusWithLiterals;
5081
- /** Collectable order amount */
5082
- amount?: Price;
5008
+ externalId?: string | null;
5083
5009
  }
5084
- declare enum PaymentCollectabilityStatus {
5085
- UNKNOWN = "UNKNOWN",
5086
- COLLECTABLE = "COLLECTABLE",
5087
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5088
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5089
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5090
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5091
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5092
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5093
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5094
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5095
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5096
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5097
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5010
+ declare enum ChargebackStatus {
5011
+ /** Chargeback was approved. */
5012
+ APPROVED = "APPROVED",
5013
+ /** Chargeback was reversed. */
5014
+ REVERSED = "REVERSED"
5098
5015
  }
5099
5016
  /** @enumType */
5100
- 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';
5101
- interface RecordManuallyCollectedPaymentRequest {
5102
- /**
5103
- * Order ID.
5104
- * @minLength 1
5105
- * @maxLength 100
5106
- */
5107
- orderId: string;
5108
- /** Amount to be recorded as approved manual payment for given order */
5109
- amount: Price;
5110
- }
5111
- /**
5112
- * User-defined payment method name.
5113
- * Allows specifying either a predefined type or a custom name.
5114
- */
5115
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5116
- /** Predefined payment method. */
5117
- predefined?: PredefinedPaymentMethodWithLiterals;
5017
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5018
+ interface PaymentMethodName {
5118
5019
  /**
5119
- * Custom payment method name provided by user.
5120
- *
5121
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5122
- * @minLength 1
5020
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5123
5021
  * @maxLength 150
5124
5022
  */
5125
- custom?: string | null;
5126
- }
5127
- /** @oneof */
5128
- interface UserDefinedPaymentMethodNameKindOneOf {
5129
- /** Predefined payment method. */
5130
- predefined?: PredefinedPaymentMethodWithLiterals;
5023
+ buyerLanguageName?: string | null;
5131
5024
  /**
5132
- * Custom payment method name provided by user.
5025
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5133
5026
  *
5134
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5135
- * @minLength 1
5027
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5136
5028
  * @maxLength 150
5137
5029
  */
5138
- custom?: string | null;
5139
- }
5140
- /** Predefined payment method types for offline/manual payments. */
5141
- declare enum PredefinedPaymentMethod {
5142
- /** Cash payment. */
5143
- CASH = "CASH",
5144
- /** Bank transfer. */
5145
- BANK_TRANSFER = "BANK_TRANSFER",
5146
- /** Payment by check. */
5147
- CHECK = "CHECK"
5148
- }
5149
- /** @enumType */
5150
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5151
- interface RecordManuallyCollectedPaymentResponse {
5152
- }
5153
- interface MarkOrderAsPaidRequest {
5030
+ siteLanguageName?: string | null;
5154
5031
  /**
5155
- * Ecom order ID.
5156
- * @minLength 1
5157
- * @maxLength 100
5032
+ * User-provided payment method name.
5033
+ *
5034
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5158
5035
  */
5159
- ecomOrderId: string;
5160
- }
5161
- interface MarkOrderAsPaidResponse {
5162
- /** Updated order. */
5163
- order?: Order;
5036
+ userDefinedName?: UserDefinedPaymentMethodName;
5164
5037
  }
5165
- interface BulkMarkOrdersAsPaidRequest {
5038
+ interface GiftCardPaymentDetails {
5166
5039
  /**
5167
- * IDs of orders to mark as paid.
5168
- * @minSize 1
5169
- * @maxSize 100
5170
- * @minLength 1
5040
+ * Gift card payment ID.
5171
5041
  * @maxLength 100
5172
5042
  */
5173
- ecomOrderIds: string[];
5174
- }
5175
- interface BulkMarkOrdersAsPaidResponse {
5043
+ giftCardPaymentId?: string;
5176
5044
  /**
5177
- * Items updated by the bulk action.
5178
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5045
+ * ID of the app that created the gift card.
5046
+ * @format GUID
5179
5047
  */
5180
- results?: BulkOrderResult[];
5181
- /** Bulk action metadata. */
5182
- bulkActionMetadata?: BulkActionMetadata;
5183
- }
5184
- interface BulkOrderResult {
5185
- /** Item metadata. */
5186
- itemMetadata?: ItemMetadata;
5048
+ appId?: string;
5187
5049
  /**
5188
- * Updated order.
5189
- *
5190
- * Returned when `returnFullEntity = true`.
5191
- */
5192
- item?: Order;
5193
- }
5194
- interface ItemMetadata {
5195
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5196
- _id?: string | null;
5197
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5198
- originalIndex?: number;
5199
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5200
- success?: boolean;
5201
- /** Details about the error in case of failure. */
5202
- error?: ApplicationError;
5203
- }
5204
- interface ApplicationError {
5205
- /** Error code. */
5206
- code?: string;
5207
- /** Description of the error. */
5208
- description?: string;
5209
- /** Data related to the error. */
5210
- data?: Record<string, any> | null;
5211
- }
5212
- interface BulkActionMetadata {
5213
- /** Number of items that were successfully processed. */
5214
- totalSuccesses?: number;
5215
- /** Number of items that couldn't be processed. */
5216
- totalFailures?: number;
5217
- /** Number of failures without details because detailed failure threshold was exceeded. */
5218
- undetailedFailures?: number;
5050
+ * Whether the gift card is voided.
5051
+ * @readonly
5052
+ * @deprecated Whether the gift card is voided.
5053
+ * @replacedBy payment.status
5054
+ * @targetRemovalDate 2026-11-01
5055
+ */
5056
+ voided?: boolean;
5057
+ /**
5058
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5059
+ * @maxLength 30
5060
+ * @immutable
5061
+ */
5062
+ obfuscatedCode?: string | null;
5219
5063
  }
5220
- interface GetRefundabilityStatusRequest {
5064
+ interface MembershipPaymentDetails {
5221
5065
  /**
5222
- * Order ID.
5066
+ * Membership ID.
5067
+ * @maxLength 200
5068
+ */
5069
+ membershipId?: string;
5070
+ /**
5071
+ * ID of the line item this membership applies to.
5223
5072
  * @minLength 1
5224
5073
  * @maxLength 100
5225
5074
  */
5226
- ecomOrderId: string;
5227
- }
5228
- interface GetRefundabilityStatusResponse {
5075
+ lineItemId?: string;
5229
5076
  /**
5230
- * Refundability details.
5231
- * @maxSize 300
5077
+ * Payment status.
5078
+ * @deprecated Payment status.
5079
+ * @replacedBy payment.status
5080
+ * @targetRemovalDate 2026-11-01
5232
5081
  */
5233
- refundabilities?: Refundability[];
5082
+ status?: MembershipPaymentStatusWithLiterals;
5083
+ /** Membership name. */
5084
+ name?: MembershipName;
5234
5085
  /**
5235
- * Whether the order supports refunding per item.
5236
- * @deprecated
5086
+ * The transaction ID in the membership system. Can be used to void the transaction.
5087
+ * @minLength 1
5088
+ * @maxLength 100
5237
5089
  */
5238
- refundablePerItem?: boolean;
5239
- }
5240
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5241
- /** Reason why payment is not refundable. */
5242
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5243
- /** Reason why payment is only refundable manually. */
5244
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5245
- /** Payment ID. */
5246
- paymentId?: string;
5247
- /** Payment refundability status. */
5248
- refundabilityStatus?: RefundableStatusWithLiterals;
5249
- /** Link to payment provider dashboard. */
5250
- providerLink?: string | null;
5251
- }
5252
- /** @oneof */
5253
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5254
- /** Reason why payment is not refundable. */
5255
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5256
- /** Reason why payment is only refundable manually. */
5257
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5258
- }
5259
- declare enum RefundableStatus {
5260
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5261
- MANUAL = "MANUAL",
5262
- REFUNDABLE = "REFUNDABLE"
5263
- }
5264
- /** @enumType */
5265
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5266
- declare enum NonRefundableReason {
5267
- NONE = "NONE",
5268
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5269
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5270
- INTERNAL_ERROR = "INTERNAL_ERROR",
5271
- NOT_PAID = "NOT_PAID",
5272
- ACCESS_DENIED = "ACCESS_DENIED",
5273
- ZERO_PRICE = "ZERO_PRICE",
5274
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5275
- PENDING_REFUND = "PENDING_REFUND",
5276
- FORBIDDEN = "FORBIDDEN",
5277
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5278
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5279
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5090
+ externalTransactionId?: string | null;
5091
+ /**
5092
+ * Whether the membership is voided.
5093
+ * @readonly
5094
+ * @deprecated Whether the membership is voided.
5095
+ * @replacedBy payment.status
5096
+ * @targetRemovalDate 2026-11-01
5097
+ */
5098
+ voided?: boolean;
5099
+ /**
5100
+ * ID of the application providing this payment option.
5101
+ * @format GUID
5102
+ */
5103
+ providerAppId?: string;
5104
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5105
+ futureMembership?: FutureMembershipDetails;
5280
5106
  }
5281
- /** @enumType */
5282
- 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';
5283
- declare enum ManuallyRefundableReason {
5284
- EXPIRED = "EXPIRED",
5285
- NOT_SUPPORTED = "NOT_SUPPORTED",
5286
- OFFLINE = "OFFLINE",
5287
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5107
+ declare enum MembershipPaymentStatus {
5108
+ /** Payment was charged. */
5109
+ CHARGED = "CHARGED",
5110
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5111
+ CHARGE_FAILED = "CHARGE_FAILED",
5112
+ /** Payment is pending. */
5113
+ CHARGE_PENDING = "CHARGE_PENDING",
5114
+ /** Payment was voided. */
5115
+ VOIDED = "VOIDED"
5288
5116
  }
5289
5117
  /** @enumType */
5290
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5291
- interface CreatePaymentGatewayOrderRequest {
5118
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5119
+ interface FutureMembershipDetails {
5292
5120
  /**
5293
- * Ecom order ID.
5294
- * @minLength 1
5295
- * @maxLength 100
5121
+ * ID of the plan line item in the order from which the membership will be created.
5122
+ * @format GUID
5296
5123
  */
5297
- ecomOrderId: string;
5298
- /** Information about the user who initiated the payment. */
5299
- chargedBy?: ChargedBy;
5124
+ lineItemId?: string;
5125
+ /**
5126
+ * ID of the benefit the future membership will grant.
5127
+ * @maxLength 200
5128
+ */
5129
+ benefitId?: string;
5300
5130
  }
5301
- interface ChargedBy {
5131
+ interface WixReceiptInfo {
5302
5132
  /**
5303
- * ID - id of the user who initiated the payment
5133
+ * Receipt ID
5304
5134
  * @format GUID
5305
5135
  */
5306
- _id?: string;
5136
+ receiptId?: string;
5307
5137
  /**
5308
- * Full name - name of the user who initiated the payment
5138
+ * Display number of receipt
5309
5139
  * @minLength 1
5310
- * @maxLength 200
5140
+ * @maxLength 40
5311
5141
  */
5312
- fullName?: string | null;
5313
- }
5314
- interface CreatePaymentGatewayOrderResponse {
5315
- /** ID of the order created in the payment gateway */
5316
- paymentGatewayOrderId?: string;
5142
+ displayNumber?: string | null;
5317
5143
  }
5318
- interface ChargeMembershipsRequest {
5144
+ interface ExternalReceiptInfo {
5319
5145
  /**
5320
- * Order ID.
5321
- * @minLength 1
5146
+ * External receipt ID
5322
5147
  * @maxLength 100
5323
5148
  */
5324
- ecomOrderId: string;
5149
+ receiptId?: string | null;
5325
5150
  /**
5326
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5327
- * but a user which is using the membership on behalf of the a member
5151
+ * ID of the app providing the receipt
5328
5152
  * @format GUID
5329
5153
  */
5330
- memberId: string;
5154
+ appId?: string | null;
5331
5155
  /**
5332
- * List of items to be paid by memberships
5333
- * @minSize 1
5334
- * @maxSize 300
5156
+ * Display number of receipt
5157
+ * @minLength 1
5158
+ * @maxLength 40
5335
5159
  */
5336
- membershipCharges?: MembershipChargeItem[];
5160
+ displayNumber?: string | null;
5337
5161
  }
5338
- interface MembershipChargeItem {
5162
+ interface CashRoundingDetails {
5339
5163
  /**
5340
- * The id of used membership
5341
- * @minLength 1
5342
- * @maxLength 100
5164
+ * Payment amount before cash rounding was applied.
5165
+ * When provided, balance and status calculations use this value instead of `amount`
5166
+ * to prevent false overpayment or underpayment due to rounding.
5343
5167
  */
5344
- membershipId?: string;
5168
+ unroundedAmount?: Price;
5345
5169
  /**
5346
- * ID of the application providing this payment option
5347
- * @format GUID
5170
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5171
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5172
+ * @readonly
5348
5173
  */
5349
- appId?: string;
5350
- /** The name of used membership */
5351
- membershipName?: MembershipName;
5352
- /** Additional data about this membership */
5353
- membershipAdditionalData?: Record<string, any> | null;
5354
- /** Catalog and item reference info. */
5355
- catalogReference?: CatalogReference;
5356
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5357
- serviceProperties?: ServiceProperties;
5174
+ roundingAdjustment?: CashRounding;
5175
+ }
5176
+ declare enum PaymentStatus {
5177
+ /** Payment was charged successfully. */
5178
+ APPROVED = "APPROVED",
5179
+ /** Payment is being processed and hasn't been confirmed yet. */
5180
+ PENDING = "PENDING",
5181
+ /** 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. */
5182
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5183
+ /** Payment was canceled before it was charged. */
5184
+ CANCELED = "CANCELED",
5185
+ /** Payment was declined by the payment provider. */
5186
+ DECLINED = "DECLINED",
5187
+ /** Payment was fully refunded. */
5188
+ REFUNDED = "REFUNDED",
5189
+ /** Part of the payment amount was refunded. */
5190
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5191
+ /** 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. */
5192
+ AUTHORIZED = "AUTHORIZED",
5193
+ /**
5194
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5195
+ *
5196
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5197
+ */
5198
+ VOIDED = "VOIDED"
5199
+ }
5200
+ /** @enumType */
5201
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5202
+ interface CanceledStatusDetails {
5203
+ reason?: CanceledReasonWithLiterals;
5204
+ }
5205
+ declare enum CanceledReason {
5206
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5207
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5208
+ /** Payment was not completed by user and expired. */
5209
+ EXPIRED = "EXPIRED"
5210
+ }
5211
+ /** @enumType */
5212
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5213
+ interface DeclinedStatusDetails {
5214
+ reason?: DeclinedReasonWithLiterals;
5215
+ }
5216
+ declare enum DeclinedReason {
5217
+ /** Corresponding charge failed. */
5218
+ CHARGE_FAILED = "CHARGE_FAILED",
5219
+ /** Payment details expired. */
5220
+ EXPIRED = "EXPIRED",
5221
+ /** Insufficient funds. */
5222
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5223
+ /** Gift card was disabled before charge was attempted. */
5224
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5225
+ }
5226
+ /** @enumType */
5227
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5228
+ interface VoidedStatusDetails {
5229
+ reason?: VoidedReasonWithLiterals;
5230
+ }
5231
+ declare enum VoidedReason {
5232
+ /** Payment was voided by merchant request. */
5233
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5234
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5235
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5236
+ }
5237
+ /** @enumType */
5238
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5239
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5240
+ }
5241
+ /** @oneof */
5242
+ interface PaymentStatusDetailsStatusDetailsOneOf {
5243
+ }
5244
+ interface Refund {
5358
5245
  /**
5359
- * Usually would be the same as catalogReference.catalogItemId
5360
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5361
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5362
- * @minLength 1
5363
- * @maxLength 36
5246
+ * Refund ID.
5247
+ * @format GUID
5248
+ * @readonly
5364
5249
  */
5365
- rootCatalogItemId?: string | null;
5250
+ _id?: string;
5366
5251
  /**
5367
- * line item id of Checkout/Order line item
5368
- * @minLength 1
5369
- * @maxLength 100
5252
+ * List of transactions.
5253
+ * @maxSize 50
5370
5254
  */
5371
- lineItemId?: string;
5372
- }
5373
- interface MembershipName {
5255
+ transactions?: RefundTransaction[];
5256
+ /** Refund business details. */
5257
+ details?: RefundDetails;
5374
5258
  /**
5375
- * Membership name in the site's original language.
5376
- * @maxLength 100
5259
+ * 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.
5260
+ * @readonly
5261
+ * @immutable
5377
5262
  */
5378
- original?: string;
5263
+ _createdDate?: Date | null;
5379
5264
  /**
5380
- * Membership name translated into the buyer's language.
5265
+ * Aggregated refund summary.
5381
5266
  *
5382
- * Default: The value of `original`
5383
- * @maxLength 100
5384
- */
5385
- translated?: string | null;
5386
- }
5387
- interface ChargeMembershipsResponse {
5388
- }
5389
- interface TriggerRefundRequest {
5390
- /**
5391
- * The order this refund related to
5392
- * @minLength 1
5393
- * @maxLength 100
5267
+ * 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.
5268
+ * @readonly
5394
5269
  */
5395
- ecomOrderId: string;
5270
+ summary?: AggregatedRefundSummary;
5396
5271
  /**
5397
- * Refund operations information
5398
- * @minSize 1
5399
- * @maxSize 1
5272
+ * ID of the app that initiated this refund.
5273
+ * @format GUID
5274
+ * @readonly
5275
+ * @immutable
5400
5276
  */
5401
- payments: PaymentRefund[];
5402
- /** Business model of a refund */
5403
- details?: RefundDetails;
5404
- /** Side effect details related to refund */
5405
- sideEffects?: RefundSideEffects;
5277
+ requestingServiceAppId?: string | null;
5406
5278
  }
5407
- interface PaymentRefund {
5279
+ interface RefundTransaction {
5408
5280
  /**
5409
- * Specific payment within the order to refund
5281
+ * ID of the payment associated with this refund.
5410
5282
  * @format GUID
5283
+ * @immutable
5411
5284
  */
5412
5285
  paymentId?: string;
5413
- /** Refund amount. Not relevant for membership and gift card refunds. */
5286
+ /**
5287
+ * Refund amount.
5288
+ * @immutable
5289
+ */
5414
5290
  amount?: Price;
5291
+ /** Refund status. */
5292
+ refundStatus?: RefundStatusWithLiterals;
5293
+ /** Optional details of current refund status. */
5294
+ refundStatusInfo?: RefundStatusInfo;
5415
5295
  /**
5416
- * Whether refund is made externally and manually (on the payment provider's side)
5417
- * 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.
5418
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5296
+ * Payment gateway's refund ID.
5297
+ * This field is only returned when the value of `external_refund` is `false`.
5298
+ * @format GUID
5299
+ */
5300
+ gatewayRefundId?: string | null;
5301
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5302
+ providerRefundId?: string | null;
5303
+ /**
5304
+ * Whether refund was made externally and manually on the payment provider's side.
5305
+ * @immutable
5419
5306
  */
5420
5307
  externalRefund?: boolean;
5421
5308
  }
5422
- interface RefundSideEffects {
5423
- /** Inventory restock details as part of this refund. */
5424
- restockInfo?: RestockInfo;
5425
- /** Whether to send a refund confirmation email to the customer. */
5426
- sendOrderRefundedEmail?: boolean;
5309
+ /** Refund transaction status. */
5310
+ declare enum RefundStatus {
5311
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5312
+ PENDING = "PENDING",
5313
+ /** Refund transaction succeeded. */
5314
+ SUCCEEDED = "SUCCEEDED",
5315
+ /** Refund transaction failed. */
5316
+ FAILED = "FAILED",
5317
+ /** Refund request acknowledged, and will be executed soon. */
5318
+ SCHEDULED = "SCHEDULED",
5319
+ /** Refund was initiated on payment provider side. */
5320
+ STARTED = "STARTED"
5321
+ }
5322
+ /** @enumType */
5323
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5324
+ interface RefundStatusInfo {
5427
5325
  /**
5428
- * Custom message added to the refund confirmation email.
5326
+ * Reason code for the refund's current status.
5327
+ *
5328
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5329
+ * @minLength 1
5330
+ * @maxLength 10
5331
+ */
5332
+ paymentGatewayReasonCode?: string | null;
5333
+ /**
5334
+ * Free text explanation of current refund status.
5429
5335
  * @minLength 1
5430
5336
  * @maxLength 1000
5431
5337
  */
5432
- customMessage?: string | null;
5338
+ description?: string | null;
5433
5339
  }
5434
- interface RestockInfo {
5435
- /** Restock type. */
5436
- type?: RestockTypeWithLiterals;
5340
+ interface AggregatedRefundSummary {
5341
+ /** Total amount requested for refund. */
5342
+ requestedRefund?: Price;
5343
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5344
+ pendingRefund?: Price;
5345
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5346
+ refunded?: Price;
5347
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
5348
+ failedRefundAmount?: Price;
5349
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
5350
+ pending?: boolean;
5351
+ /** Breakdown of refunded items. Available only after refund is complete. */
5352
+ breakdown?: RefundItemsBreakdown;
5353
+ }
5354
+ interface RefundItemsBreakdown {
5437
5355
  /**
5438
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5356
+ * Refunded line items and the amount refunded for each.
5439
5357
  * @maxSize 300
5440
5358
  */
5441
- items?: RestockItem[];
5442
- }
5443
- declare enum RestockType {
5444
- NO_ITEMS = "NO_ITEMS",
5445
- ALL_ITEMS = "ALL_ITEMS",
5446
- SOME_ITEMS = "SOME_ITEMS"
5359
+ lineItems?: LineItemRefundSummary[];
5447
5360
  }
5448
- /** @enumType */
5449
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5450
- interface RestockItem {
5361
+ interface LineItemRefundSummary {
5451
5362
  /**
5452
- * ID of the line item being restocked.
5363
+ * ID of the refunded line item.
5453
5364
  * @format GUID
5454
5365
  */
5455
5366
  lineItemId?: string;
5456
- /**
5457
- * Line item quantity being restocked.
5458
- * @min 1
5459
- * @max 100000
5460
- */
5461
- quantity?: number;
5462
- }
5463
- interface TriggerRefundResponse {
5464
- /** All order's transactions after the refunds were added */
5465
- orderTransactions?: OrderTransactions;
5466
- /** Created refund ID */
5467
- refundId?: string | null;
5468
- /** Payment ID's that the refund execution had failed for */
5469
- failedPaymentIds?: ItemMetadata[];
5367
+ /** Total refunded amount for the line item. */
5368
+ totalRefundedAmount?: Price;
5470
5369
  }
5471
- /**
5472
- * A record of all payments and refunds associated with an order.
5473
- *
5474
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5475
- */
5476
- interface OrderTransactions {
5477
- /**
5478
- * Order ID.
5479
- * @format GUID
5480
- */
5481
- orderId?: string;
5370
+ interface CalculateRefundRequest {
5482
5371
  /**
5483
- * Record of payments made to the merchant.
5484
- * @maxSize 100
5372
+ * Order ID
5373
+ * @minLength 1
5374
+ * @maxLength 100
5485
5375
  */
5486
- payments?: Payment[];
5376
+ ecomOrderId?: string;
5487
5377
  /**
5488
- * Record of refunds made to the buyer.
5378
+ * Refunded line items and quantity
5489
5379
  * @maxSize 300
5490
5380
  */
5491
- refunds?: Refund[];
5381
+ refundItems?: CalculateRefundItemRequest[];
5382
+ /** Should include shipping in refund calculation */
5383
+ refundShipping?: boolean;
5492
5384
  }
5493
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5494
- /** Regular payment details. */
5495
- regularPaymentDetails?: RegularPaymentDetails;
5496
- /** Gift card payment details. */
5497
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5498
- /** Membership payment details. */
5499
- membershipPaymentDetails?: MembershipPaymentDetails;
5385
+ interface CalculateRefundItemRequest {
5500
5386
  /**
5501
- * Payment ID.
5387
+ * ID of the line item being refunded
5502
5388
  * @format GUID
5503
- * @readonly
5504
- */
5505
- _id?: string | null;
5506
- /** 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. */
5507
- _createdDate?: Date | null;
5508
- /**
5509
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5510
- * @readonly
5511
- */
5512
- _updatedDate?: Date | null;
5513
- /** Payment amount. */
5514
- amount?: Price;
5515
- /**
5516
- * Whether refunds for this payment are disabled.
5517
- * + `true`: This payment is not refundable.
5518
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5519
5389
  */
5520
- refundDisabled?: boolean;
5390
+ _id?: string;
5521
5391
  /**
5522
- * Whether receipt generation is allowed for this payment.
5523
- * + `true`: This payment supports receipt generation.
5524
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5525
- * @readonly
5392
+ * How much of that line item is being refunded
5393
+ * @min 1
5394
+ * @max 100000
5526
5395
  */
5527
- supportReceiptGeneration?: boolean;
5528
- /** Details about cash rounding applied to this payment, when relevant. */
5529
- cashRounding?: CashRoundingDetails;
5396
+ quantity?: number;
5397
+ }
5398
+ interface CalculateRefundResponse {
5399
+ /** Total refundable amount */
5400
+ total?: Price;
5401
+ /** Tax cost of the order */
5402
+ tax?: Price;
5403
+ /** Discount given for this order */
5404
+ discount?: Price;
5405
+ /** Total cost of the order (without tax) */
5406
+ subtotal?: Price;
5407
+ /** Total shipping cost for order */
5408
+ shipping?: Price;
5409
+ /** Previous refund given on that order */
5410
+ previouslyRefundedAmount?: Price;
5530
5411
  /**
5531
- * Overall payment status.
5532
- *
5533
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5412
+ * The refundable items of that order
5413
+ * @maxSize 300
5534
5414
  */
5535
- status?: PaymentStatusWithLiterals;
5415
+ items?: CalculateRefundItemResponse[];
5416
+ }
5417
+ interface CalculateRefundItemResponse {
5536
5418
  /**
5537
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5419
+ * Line item ID
5538
5420
  * @format GUID
5539
5421
  */
5540
- chargeCorrelationId?: string | null;
5541
- }
5542
- /** @oneof */
5543
- interface PaymentPaymentDetailsOneOf {
5544
- /** Regular payment details. */
5545
- regularPaymentDetails?: RegularPaymentDetails;
5546
- /** Gift card payment details. */
5547
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5548
- /** Membership payment details. */
5549
- membershipPaymentDetails?: MembershipPaymentDetails;
5550
- }
5551
- /** @oneof */
5552
- interface PaymentReceiptInfoOneOf {
5553
- }
5554
- /** @oneof */
5555
- interface PaymentStatusDetailsOneOf {
5422
+ _id?: string;
5423
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5424
+ price?: Price;
5556
5425
  }
5557
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5558
- /** Credit card details. */
5559
- creditCardDetails?: CreditCardPaymentMethodDetails;
5560
- /**
5561
- * Wix Payments order ID.
5562
- * @maxLength 100
5563
- */
5564
- paymentOrderId?: string | null;
5426
+ interface VoidAuthorizedPaymentsRequest {
5565
5427
  /**
5566
- * Payment gateway's transaction ID.
5567
- * This field is only returned when the value of `offline_payment` is `false`.
5428
+ * Wix eCommerce order ID
5429
+ * @minLength 1
5568
5430
  * @maxLength 100
5569
5431
  */
5570
- gatewayTransactionId?: string | null;
5432
+ ecomOrderId: string;
5571
5433
  /**
5572
- * Payment method.
5573
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5574
- * Non-exhaustive list of supported values:
5575
- * + `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`
5576
- * @maxLength 150
5577
- * @deprecated Payment method.
5578
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5579
- * Non-exhaustive list of supported values:
5580
- * + `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`
5581
- * @replacedBy payment_method_name
5582
- * @targetRemovalDate 2026-07-01
5434
+ * Payment IDs
5435
+ * @minSize 1
5436
+ * @maxSize 100
5437
+ * @format GUID
5583
5438
  */
5584
- paymentMethod?: string | null;
5439
+ paymentIds: string[];
5440
+ }
5441
+ interface VoidAuthorizedPaymentsResponse {
5442
+ /** All order's transactions after the void was triggered */
5443
+ orderTransactions?: OrderTransactions;
5444
+ }
5445
+ interface CaptureAuthorizedPaymentsRequest {
5585
5446
  /**
5586
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5447
+ * Wix eCommerce order ID
5448
+ * @minLength 1
5587
5449
  * @maxLength 100
5588
5450
  */
5589
- providerTransactionId?: string | null;
5590
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5591
- offlinePayment?: boolean;
5451
+ ecomOrderId: string;
5592
5452
  /**
5593
- * Payment status.
5594
- * @deprecated Payment status.
5595
- * @replacedBy payment.status
5596
- * @targetRemovalDate 2026-11-01
5453
+ * Capture payments information
5454
+ * @minSize 1
5455
+ * @maxSize 100
5597
5456
  */
5598
- status?: TransactionStatusWithLiterals;
5599
- /** Whether there is a payment agreement that allows for future charges. */
5600
- savedPaymentMethod?: boolean;
5601
- /** Authorization details. */
5602
- authorizationDetails?: AuthorizationDetails;
5457
+ payments: PaymentCapture[];
5458
+ }
5459
+ interface PaymentCapture {
5603
5460
  /**
5604
- * Record of chargebacks made by the buyer.
5605
- * @maxSize 6
5461
+ * Payment ID
5462
+ * @format GUID
5606
5463
  */
5607
- chargebacks?: Chargeback[];
5608
- /** Platform fee amount associated with this payment. */
5609
- platformFee?: Price;
5464
+ paymentId?: string | null;
5610
5465
  /**
5611
- * Payment method with buyer and optional owner translations.
5612
- * Non-exhaustive list of supported values:
5613
- * + `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`
5466
+ * Capture amount.
5467
+ * If not provided - full authorized amount will be captured.
5614
5468
  */
5615
- paymentMethodName?: PaymentMethodName;
5616
- }
5617
- /** @oneof */
5618
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5619
- /** Credit card details. */
5620
- creditCardDetails?: CreditCardPaymentMethodDetails;
5469
+ amount?: Price;
5621
5470
  }
5622
- declare enum TransactionStatus {
5623
- UNDEFINED = "UNDEFINED",
5624
- APPROVED = "APPROVED",
5625
- PENDING = "PENDING",
5626
- PENDING_MERCHANT = "PENDING_MERCHANT",
5627
- CANCELED = "CANCELED",
5628
- DECLINED = "DECLINED",
5629
- REFUNDED = "REFUNDED",
5630
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5631
- AUTHORIZED = "AUTHORIZED",
5632
- VOIDED = "VOIDED"
5471
+ interface CaptureAuthorizedPaymentsResponse {
5472
+ /** All order's transactions after the capture was triggered */
5473
+ orderTransactions?: OrderTransactions;
5633
5474
  }
5634
- /** @enumType */
5635
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5636
- interface CreditCardPaymentMethodDetails {
5637
- /**
5638
- * The last 4 digits of the card number.
5639
- * @maxLength 4
5640
- */
5641
- lastFourDigits?: string | null;
5475
+ interface ChargeSavedPaymentMethodRequest {
5642
5476
  /**
5643
- * Card issuer's brand.
5477
+ * Ecom Order ID.
5478
+ * @minLength 1
5644
5479
  * @maxLength 100
5645
5480
  */
5646
- brand?: string | null;
5481
+ ecomOrderId?: string;
5482
+ /** Amount to be charged */
5483
+ amount?: Price;
5647
5484
  }
5648
- interface AuthorizationDetails {
5649
- /**
5650
- * Whether the authorized payment is of a delayed capture.
5651
- * @readonly
5652
- */
5653
- delayedCapture?: boolean;
5654
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5655
- authorizedDate?: Date | null;
5485
+ interface ChargeSavedPaymentMethodResponse {
5486
+ /** Payment gateway's order ID (e.g Wix Payments) */
5487
+ paymentGatewayOrderId?: string;
5488
+ }
5489
+ interface SendBuyerConfirmationEmailRequest {
5490
+ /** @format GUID */
5491
+ orderId?: string;
5492
+ }
5493
+ interface SendBuyerConfirmationEmailResponse {
5494
+ }
5495
+ interface SendBuyerPaymentsReceivedEmailRequest {
5656
5496
  /**
5657
- * List of captures associated with payment
5658
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5659
- * @maxSize 1
5497
+ * @minLength 1
5498
+ * @maxLength 100
5660
5499
  */
5661
- captures?: AuthorizationCapture[];
5662
- /** Void associated with payment */
5663
- void?: AuthorizationVoid;
5664
- /** Scheduled action for this transaction */
5665
- scheduledAction?: V1ScheduledAction;
5500
+ orderId?: string;
5666
5501
  }
5667
- interface AuthorizationCapture {
5502
+ interface SendBuyerPaymentsReceivedEmailResponse {
5503
+ }
5504
+ interface SendBuyerPickupConfirmationEmailRequest {
5668
5505
  /**
5669
- * Capture ID.
5670
- * @format GUID
5671
- * @readonly
5506
+ * @minLength 1
5507
+ * @maxLength 100
5672
5508
  */
5673
- _id?: string | null;
5674
- /** Status of this capture action */
5675
- status?: AuthorizationCaptureStatusWithLiterals;
5509
+ orderId?: string;
5510
+ }
5511
+ interface SendBuyerPickupConfirmationEmailResponse {
5512
+ }
5513
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
5676
5514
  /**
5677
- * Amount of this capture
5678
- * @immutable
5515
+ * IDs of orders to send pickup emails for.
5516
+ * @minSize 1
5517
+ * @maxSize 300
5679
5518
  */
5680
- amount?: Price;
5681
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5682
- _createdDate?: Date | null;
5683
- /** In case of status is FAILED may contain failure details */
5684
- failureDetails?: AuthorizationActionFailureDetails;
5519
+ orderIds?: string[];
5685
5520
  }
5686
- declare enum AuthorizationCaptureStatus {
5687
- /** Capture operation still in progress. */
5688
- PENDING = "PENDING",
5689
- /** Capture operation succeeded. */
5690
- SUCCEEDED = "SUCCEEDED",
5691
- /** Capture operation failed. */
5692
- FAILED = "FAILED"
5521
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
5693
5522
  }
5694
- /** @enumType */
5695
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5696
- interface AuthorizationActionFailureDetails {
5697
- /** @maxLength 100 */
5698
- failureCode?: string;
5523
+ interface SendBuyerShippingConfirmationEmailRequest {
5524
+ /**
5525
+ * @minLength 1
5526
+ * @maxLength 100
5527
+ */
5528
+ orderId?: string;
5699
5529
  }
5700
- interface AuthorizationVoid {
5701
- /** Status of this void action */
5702
- status?: AuthorizationVoidStatusWithLiterals;
5703
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5704
- voidedDate?: Date | null;
5705
- /** In case of status is FAILED may contain failure details */
5706
- failureDetails?: AuthorizationActionFailureDetails;
5707
- /** Reason of void action */
5708
- reason?: ReasonWithLiterals;
5530
+ interface SendBuyerShippingConfirmationEmailResponse {
5709
5531
  }
5710
- declare enum AuthorizationVoidStatus {
5711
- /** Void operation still in progress. */
5712
- PENDING = "PENDING",
5713
- /** Void operation succeeded. */
5714
- SUCCEEDED = "SUCCEEDED",
5715
- /** Void operation failed. */
5716
- FAILED = "FAILED"
5532
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
5533
+ /**
5534
+ * IDs of orders to send pickup emails for.
5535
+ * @minSize 1
5536
+ * @maxSize 300
5537
+ */
5538
+ orderIds?: string[];
5717
5539
  }
5718
- /** @enumType */
5719
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5720
- /** Reason the authorization was voided. */
5721
- declare enum Reason {
5722
- /** Authorization was voided by user. */
5723
- MANUAL = "MANUAL",
5724
- /** Authorization passed execution date. */
5725
- SCHEDULED = "SCHEDULED"
5540
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
5726
5541
  }
5727
- /** @enumType */
5728
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5729
- interface V1ScheduledAction {
5730
- /** Type of the action. */
5731
- actionType?: ActionTypeWithLiterals;
5732
- /** The date and time of the action. */
5733
- executionDate?: Date | null;
5542
+ interface SendMerchantOrderReceivedNotificationRequest {
5543
+ /**
5544
+ * @minLength 1
5545
+ * @maxLength 100
5546
+ */
5547
+ orderId?: string;
5734
5548
  }
5735
- declare enum ActionType {
5736
- VOID = "VOID",
5737
- CAPTURE = "CAPTURE"
5549
+ interface SendMerchantOrderReceivedNotificationResponse {
5738
5550
  }
5739
- /** @enumType */
5740
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5741
- interface Chargeback {
5551
+ interface SendCancelRefundEmailRequest {
5742
5552
  /**
5743
- * Chargeback ID.
5744
- * @format GUID
5745
- * @readonly
5746
- * @immutable
5553
+ * The ID of order that is canceled/refunded
5554
+ * @minLength 1
5555
+ * @maxLength 100
5747
5556
  */
5748
- _id?: string;
5557
+ orderId?: string;
5749
5558
  /**
5750
- * 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.
5751
- * @readonly
5752
- * @immutable
5559
+ * Personal note added to the email (optional)
5560
+ * @minLength 1
5561
+ * @maxLength 1000
5753
5562
  */
5754
- _createdDate?: Date | null;
5563
+ customMessage?: string | null;
5564
+ /** Refund amount */
5565
+ refundAmount?: Price;
5755
5566
  /**
5756
- * 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.
5757
- * @readonly
5567
+ * Refund ID. (Optional)
5568
+ * @format GUID
5758
5569
  */
5759
- _updatedDate?: Date | null;
5570
+ refundId?: string | null;
5571
+ }
5572
+ interface SendCancelRefundEmailResponse {
5573
+ }
5574
+ interface SendRefundEmailRequest {
5760
5575
  /**
5761
- * Amount.
5762
- * @readonly
5763
- * @immutable
5576
+ * The ID of order that is refunded
5577
+ * @format GUID
5764
5578
  */
5765
- amount?: Price;
5579
+ orderId?: string;
5766
5580
  /**
5767
- * Reversal amount. Present only when status is REVERSED.
5768
- * @readonly
5581
+ * Refund ID
5582
+ * @format GUID
5769
5583
  */
5770
- reversalAmount?: Price;
5584
+ refundId?: string;
5771
5585
  /**
5772
- * Status.
5773
- *
5774
- * Default: `"APPROVED"`.
5586
+ * Personal note added to the email (optional)
5587
+ * @minLength 1
5588
+ * @maxLength 1000
5775
5589
  */
5776
- status?: ChargebackStatusWithLiterals;
5590
+ customMessage?: string | null;
5591
+ }
5592
+ interface SendRefundEmailResponse {
5593
+ }
5594
+ interface SendFulfillmentEmailRequest {
5595
+ /** @format GUID */
5596
+ orderId?: string;
5597
+ /** @format GUID */
5598
+ fulfillerId?: string;
5599
+ }
5600
+ interface SendFulfillmentEmailResponse {
5601
+ }
5602
+ interface SendMerchantOrderReceivedPushRequest {
5777
5603
  /**
5778
- * External chargeback ID.
5779
- * @format GUID
5780
- * @readonly
5781
- * @immutable
5604
+ * @minLength 1
5605
+ * @maxLength 100
5782
5606
  */
5783
- externalId?: string | null;
5607
+ orderId?: string;
5784
5608
  }
5785
- declare enum ChargebackStatus {
5786
- /** Chargeback was approved. */
5787
- APPROVED = "APPROVED",
5788
- /** Chargeback was reversed. */
5789
- REVERSED = "REVERSED"
5609
+ interface SendMerchantOrderReceivedPushResponse {
5610
+ }
5611
+ interface PreviewEmailByTypeRequest {
5612
+ emailType?: PreviewEmailTypeWithLiterals;
5613
+ }
5614
+ declare enum PreviewEmailType {
5615
+ ORDER_PLACED = "ORDER_PLACED",
5616
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5617
+ ORDER_SHIPPED = "ORDER_SHIPPED",
5618
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5790
5619
  }
5791
5620
  /** @enumType */
5792
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5793
- interface PaymentMethodName {
5621
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5622
+ interface PreviewEmailByTypeResponse {
5623
+ emailPreview?: string;
5624
+ }
5625
+ interface PreviewRefundEmailRequest {
5794
5626
  /**
5795
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5796
- * @maxLength 150
5627
+ * @minLength 1
5628
+ * @maxLength 100
5797
5629
  */
5798
- buyerLanguageName?: string | null;
5630
+ orderId?: string;
5631
+ /** Refund amount */
5632
+ refundAmount?: Price;
5633
+ /** Refund business details */
5634
+ details?: RefundDetails;
5799
5635
  /**
5800
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5801
- *
5802
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5803
- * @maxLength 150
5636
+ * Personal note added to the email (optional)
5637
+ * @minLength 1
5638
+ * @maxLength 1000
5804
5639
  */
5805
- siteLanguageName?: string | null;
5640
+ customMessage?: string | null;
5806
5641
  /**
5807
- * User-provided payment method name.
5808
- *
5809
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5642
+ * Refund ID. (Optional)
5643
+ * @format GUID
5810
5644
  */
5811
- userDefinedName?: UserDefinedPaymentMethodName;
5645
+ refundId?: string | null;
5812
5646
  }
5813
- interface GiftCardPaymentDetails {
5647
+ interface PreviewRefundEmailResponse {
5648
+ emailPreview?: string;
5649
+ }
5650
+ interface PreviewCancelEmailRequest {
5814
5651
  /**
5815
- * Gift card payment ID.
5652
+ * @minLength 1
5816
5653
  * @maxLength 100
5817
5654
  */
5818
- giftCardPaymentId?: string;
5655
+ orderId?: string;
5819
5656
  /**
5820
- * ID of the app that created the gift card.
5821
- * @format GUID
5657
+ * Personal note added to the email (optional)
5658
+ * @minLength 1
5659
+ * @maxLength 1000
5822
5660
  */
5823
- appId?: string;
5661
+ customMessage?: string | null;
5662
+ }
5663
+ interface PreviewCancelEmailResponse {
5664
+ emailPreview?: string;
5665
+ }
5666
+ interface PreviewCancelRefundEmailRequest {
5824
5667
  /**
5825
- * Whether the gift card is voided.
5826
- * @readonly
5827
- * @deprecated Whether the gift card is voided.
5828
- * @replacedBy payment.status
5829
- * @targetRemovalDate 2026-11-01
5668
+ * @minLength 1
5669
+ * @maxLength 100
5830
5670
  */
5831
- voided?: boolean;
5671
+ orderId?: string;
5832
5672
  /**
5833
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5834
- * @maxLength 30
5835
- * @immutable
5673
+ * Personal note added to the email (optional)
5674
+ * @minLength 1
5675
+ * @maxLength 1000
5836
5676
  */
5837
- obfuscatedCode?: string | null;
5677
+ customMessage?: string | null;
5678
+ /** Refund amount */
5679
+ refundAmount?: Price;
5680
+ /**
5681
+ * Refund ID. (Optional)
5682
+ * @format GUID
5683
+ */
5684
+ refundId?: string | null;
5838
5685
  }
5839
- interface MembershipPaymentDetails {
5686
+ interface PreviewCancelRefundEmailResponse {
5687
+ emailPreview?: string;
5688
+ }
5689
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5690
+ }
5691
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
5692
+ emailPreview?: string;
5693
+ }
5694
+ interface PreviewBuyerConfirmationEmailRequest {
5695
+ }
5696
+ interface PreviewBuyerConfirmationEmailResponse {
5697
+ emailPreview?: string;
5698
+ }
5699
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5700
+ }
5701
+ interface PreviewBuyerPickupConfirmationEmailResponse {
5702
+ emailPreview?: string;
5703
+ }
5704
+ interface PreviewShippingConfirmationEmailRequest {
5705
+ }
5706
+ interface PreviewShippingConfirmationEmailResponse {
5707
+ emailPreview?: string;
5708
+ }
5709
+ interface PreviewResendDownloadLinksEmailRequest {
5710
+ }
5711
+ interface PreviewResendDownloadLinksEmailResponse {
5712
+ emailPreview?: string;
5713
+ }
5714
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5715
+ /** Emitted on a meta site creation. */
5716
+ siteCreated?: SiteCreated;
5717
+ /** Emitted on a meta site transfer completion. */
5718
+ siteTransferred?: SiteTransferred;
5719
+ /** Emitted on a meta site deletion. */
5720
+ siteDeleted?: SiteDeleted;
5721
+ /** Emitted on a meta site restoration. */
5722
+ siteUndeleted?: SiteUndeleted;
5723
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5724
+ sitePublished?: SitePublished;
5725
+ /** Emitted on a meta site unpublish. */
5726
+ siteUnpublished?: SiteUnpublished;
5727
+ /** Emitted when meta site is marked as template. */
5728
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5729
+ /** Emitted when meta site is marked as a WixSite. */
5730
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5731
+ /** Emitted when an application is provisioned (installed). */
5732
+ serviceProvisioned?: ServiceProvisioned;
5733
+ /** Emitted when an application is removed (uninstalled). */
5734
+ serviceRemoved?: ServiceRemoved;
5735
+ /** Emitted when meta site name (URL slug) is changed. */
5736
+ siteRenamedPayload?: SiteRenamed;
5737
+ /** Emitted when meta site was permanently deleted. */
5738
+ hardDeleted?: SiteHardDeleted;
5739
+ /** Emitted on a namespace change. */
5740
+ namespaceChanged?: NamespaceChanged;
5741
+ /** Emitted when Studio is attached. */
5742
+ studioAssigned?: StudioAssigned;
5743
+ /** Emitted when Studio is detached. */
5744
+ studioUnassigned?: StudioUnassigned;
5840
5745
  /**
5841
- * Membership ID.
5842
- * @maxLength 200
5746
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5747
+ * the actual URL.
5748
+ *
5749
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5750
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5843
5751
  */
5844
- membershipId?: string;
5752
+ urlChanged?: SiteUrlChanged;
5753
+ /** Site is marked as PurgedExternally */
5754
+ sitePurgedExternally?: SitePurgedExternally;
5755
+ /** Emitted when Odeditor is attached. */
5756
+ odeditorAssigned?: OdeditorAssigned;
5757
+ /** Emitted when Odeditor is detached. */
5758
+ odeditorUnassigned?: OdeditorUnassigned;
5759
+ /** Emitted when Picasso is attached. */
5760
+ picassoAssigned?: PicassoAssigned;
5761
+ /** Emitted when Picasso is detached. */
5762
+ picassoUnassigned?: PicassoUnassigned;
5763
+ /** Emitted when Wixel is attached. */
5764
+ wixelAssigned?: WixelAssigned;
5765
+ /** Emitted when Wixel is detached. */
5766
+ wixelUnassigned?: WixelUnassigned;
5767
+ /** Emitted when StudioTwo is attached. */
5768
+ studioTwoAssigned?: StudioTwoAssigned;
5769
+ /** Emitted when StudioTwo is detached. */
5770
+ studioTwoUnassigned?: StudioTwoUnassigned;
5771
+ /** Emitted when media from user domain is enabled. */
5772
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5773
+ /** Emitted when media from user domain is disabled. */
5774
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5775
+ /** Emitted when Editorless is attached. */
5776
+ editorlessAssigned?: EditorlessAssigned;
5777
+ /** Emitted when Editorless is detached. */
5778
+ editorlessUnassigned?: EditorlessUnassigned;
5845
5779
  /**
5846
- * ID of the line item this membership applies to.
5847
- * @minLength 1
5848
- * @maxLength 100
5780
+ * A meta site id.
5781
+ * @format GUID
5849
5782
  */
5850
- lineItemId?: string;
5783
+ metaSiteId?: string;
5784
+ /** A meta site version. Monotonically increasing. */
5785
+ version?: string;
5786
+ /** A timestamp of the event. */
5787
+ timestamp?: string;
5851
5788
  /**
5852
- * Payment status.
5853
- * @deprecated Payment status.
5854
- * @replacedBy payment.status
5855
- * @targetRemovalDate 2026-11-01
5789
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5790
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5791
+ * @maxSize 4000
5856
5792
  */
5857
- status?: MembershipPaymentStatusWithLiterals;
5858
- /** Membership name. */
5859
- name?: MembershipName;
5793
+ assets?: Asset[];
5794
+ }
5795
+ /** @oneof */
5796
+ interface MetaSiteSpecialEventPayloadOneOf {
5797
+ /** Emitted on a meta site creation. */
5798
+ siteCreated?: SiteCreated;
5799
+ /** Emitted on a meta site transfer completion. */
5800
+ siteTransferred?: SiteTransferred;
5801
+ /** Emitted on a meta site deletion. */
5802
+ siteDeleted?: SiteDeleted;
5803
+ /** Emitted on a meta site restoration. */
5804
+ siteUndeleted?: SiteUndeleted;
5805
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5806
+ sitePublished?: SitePublished;
5807
+ /** Emitted on a meta site unpublish. */
5808
+ siteUnpublished?: SiteUnpublished;
5809
+ /** Emitted when meta site is marked as template. */
5810
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5811
+ /** Emitted when meta site is marked as a WixSite. */
5812
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5813
+ /** Emitted when an application is provisioned (installed). */
5814
+ serviceProvisioned?: ServiceProvisioned;
5815
+ /** Emitted when an application is removed (uninstalled). */
5816
+ serviceRemoved?: ServiceRemoved;
5817
+ /** Emitted when meta site name (URL slug) is changed. */
5818
+ siteRenamedPayload?: SiteRenamed;
5819
+ /** Emitted when meta site was permanently deleted. */
5820
+ hardDeleted?: SiteHardDeleted;
5821
+ /** Emitted on a namespace change. */
5822
+ namespaceChanged?: NamespaceChanged;
5823
+ /** Emitted when Studio is attached. */
5824
+ studioAssigned?: StudioAssigned;
5825
+ /** Emitted when Studio is detached. */
5826
+ studioUnassigned?: StudioUnassigned;
5860
5827
  /**
5861
- * The transaction ID in the membership system. Can be used to void the transaction.
5862
- * @minLength 1
5863
- * @maxLength 100
5828
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5829
+ * the actual URL.
5830
+ *
5831
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5832
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5864
5833
  */
5865
- externalTransactionId?: string | null;
5834
+ urlChanged?: SiteUrlChanged;
5835
+ /** Site is marked as PurgedExternally */
5836
+ sitePurgedExternally?: SitePurgedExternally;
5837
+ /** Emitted when Odeditor is attached. */
5838
+ odeditorAssigned?: OdeditorAssigned;
5839
+ /** Emitted when Odeditor is detached. */
5840
+ odeditorUnassigned?: OdeditorUnassigned;
5841
+ /** Emitted when Picasso is attached. */
5842
+ picassoAssigned?: PicassoAssigned;
5843
+ /** Emitted when Picasso is detached. */
5844
+ picassoUnassigned?: PicassoUnassigned;
5845
+ /** Emitted when Wixel is attached. */
5846
+ wixelAssigned?: WixelAssigned;
5847
+ /** Emitted when Wixel is detached. */
5848
+ wixelUnassigned?: WixelUnassigned;
5849
+ /** Emitted when StudioTwo is attached. */
5850
+ studioTwoAssigned?: StudioTwoAssigned;
5851
+ /** Emitted when StudioTwo is detached. */
5852
+ studioTwoUnassigned?: StudioTwoUnassigned;
5853
+ /** Emitted when media from user domain is enabled. */
5854
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5855
+ /** Emitted when media from user domain is disabled. */
5856
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5857
+ /** Emitted when Editorless is attached. */
5858
+ editorlessAssigned?: EditorlessAssigned;
5859
+ /** Emitted when Editorless is detached. */
5860
+ editorlessUnassigned?: EditorlessUnassigned;
5861
+ }
5862
+ interface Asset {
5866
5863
  /**
5867
- * Whether the membership is voided.
5868
- * @readonly
5869
- * @deprecated Whether the membership is voided.
5870
- * @replacedBy payment.status
5871
- * @targetRemovalDate 2026-11-01
5864
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5865
+ * @maxLength 36
5872
5866
  */
5873
- voided?: boolean;
5867
+ appDefId?: string;
5874
5868
  /**
5875
- * ID of the application providing this payment option.
5876
- * @format GUID
5869
+ * An instance id. For legacy reasons may be UUID or a string.
5870
+ * @maxLength 200
5877
5871
  */
5878
- providerAppId?: string;
5879
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5880
- futureMembership?: FutureMembershipDetails;
5872
+ instanceId?: string;
5873
+ /** An application state. */
5874
+ state?: StateWithLiterals;
5881
5875
  }
5882
- declare enum MembershipPaymentStatus {
5883
- /** Payment was charged. */
5884
- CHARGED = "CHARGED",
5885
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5886
- CHARGE_FAILED = "CHARGE_FAILED",
5887
- /** Payment is pending. */
5888
- CHARGE_PENDING = "CHARGE_PENDING",
5889
- /** Payment was voided. */
5890
- VOIDED = "VOIDED"
5876
+ declare enum State {
5877
+ UNKNOWN = "UNKNOWN",
5878
+ ENABLED = "ENABLED",
5879
+ DISABLED = "DISABLED",
5880
+ PENDING = "PENDING",
5881
+ DEMO = "DEMO"
5891
5882
  }
5892
5883
  /** @enumType */
5893
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5894
- interface FutureMembershipDetails {
5884
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5885
+ interface SiteCreated {
5895
5886
  /**
5896
- * ID of the plan line item in the order from which the membership will be created.
5897
- * @format GUID
5887
+ * A template identifier (empty if not created from a template).
5888
+ * @maxLength 36
5898
5889
  */
5899
- lineItemId?: string;
5890
+ originTemplateId?: string;
5900
5891
  /**
5901
- * ID of the benefit the future membership will grant.
5902
- * @maxLength 200
5892
+ * An account id of the owner.
5893
+ * @format GUID
5903
5894
  */
5904
- benefitId?: string;
5905
- }
5906
- interface WixReceiptInfo {
5895
+ ownerId?: string;
5896
+ /** A context in which meta site was created. */
5897
+ context?: SiteCreatedContextWithLiterals;
5907
5898
  /**
5908
- * Receipt ID
5899
+ * A meta site id from which this site was created.
5900
+ *
5901
+ * In case of a creation from a template it's a template id.
5902
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5909
5903
  * @format GUID
5910
5904
  */
5911
- receiptId?: string;
5905
+ originMetaSiteId?: string | null;
5912
5906
  /**
5913
- * Display number of receipt
5914
- * @minLength 1
5915
- * @maxLength 40
5907
+ * A meta site name (URL slug).
5908
+ * @maxLength 20
5916
5909
  */
5917
- displayNumber?: string | null;
5910
+ siteName?: string;
5911
+ /** A namespace. */
5912
+ namespace?: NamespaceWithLiterals;
5918
5913
  }
5919
- interface ExternalReceiptInfo {
5914
+ declare enum SiteCreatedContext {
5915
+ /** A valid option, we don't expose all reasons why site might be created. */
5916
+ OTHER = "OTHER",
5917
+ /** A meta site was created from template. */
5918
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5919
+ /** A meta site was created by copying of the transfferred meta site. */
5920
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5921
+ /** A copy of existing meta site. */
5922
+ DUPLICATE = "DUPLICATE",
5923
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5924
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5925
+ /** deprecated A meta site was created for Flash editor. */
5926
+ FLASH = "FLASH"
5927
+ }
5928
+ /** @enumType */
5929
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5930
+ declare enum Namespace {
5931
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5932
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5933
+ WIX = "WIX",
5934
+ /** 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. */
5935
+ SHOUT_OUT = "SHOUT_OUT",
5936
+ /** 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. */
5937
+ ALBUMS = "ALBUMS",
5938
+ /** 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. */
5939
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5940
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5941
+ HOTELS = "HOTELS",
5942
+ /** 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. */
5943
+ CLUBS = "CLUBS",
5944
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5945
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5920
5946
  /**
5921
- * External receipt ID
5922
- * @maxLength 100
5947
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5948
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5923
5949
  */
5924
- receiptId?: string | null;
5950
+ DEV_SITE = "DEV_SITE",
5951
+ /** 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. */
5952
+ LOGOS = "LOGOS",
5953
+ /** 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. */
5954
+ VIDEO_MAKER = "VIDEO_MAKER",
5955
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5956
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5957
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5958
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5925
5959
  /**
5926
- * ID of the app providing the receipt
5927
- * @format GUID
5960
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5961
+ *
5962
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5928
5963
  */
5929
- appId?: string | null;
5964
+ HTML_DRAFT = "HTML_DRAFT",
5930
5965
  /**
5931
- * Display number of receipt
5932
- * @minLength 1
5933
- * @maxLength 40
5966
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5967
+ * Will be accessible from Site List and will not have a website app.
5968
+ * Once the user attaches a site, the site will become a regular wixsite.
5934
5969
  */
5935
- displayNumber?: string | null;
5936
- }
5937
- interface CashRoundingDetails {
5970
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5971
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5972
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5973
+ /** It is to be used in the Business First efforts. */
5974
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5975
+ /** Bookings business flow with no site. */
5976
+ ANYWHERE = "ANYWHERE",
5977
+ /** Namespace for Headless Backoffice with no editor */
5978
+ HEADLESS = "HEADLESS",
5938
5979
  /**
5939
- * Payment amount before cash rounding was applied.
5940
- * When provided, balance and status calculations use this value instead of `amount`
5941
- * to prevent false overpayment or underpayment due to rounding.
5980
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5981
+ * The site will be used for account level CSM feature for enterprise
5942
5982
  */
5943
- unroundedAmount?: Price;
5983
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5984
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5985
+ RISE = "RISE",
5944
5986
  /**
5945
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5946
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5947
- * @readonly
5987
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5988
+ * There's a blank site behind the scene but it's blank).
5989
+ * The Mobile company will be the owner of this namespace.
5948
5990
  */
5949
- roundingAdjustment?: CashRounding;
5950
- }
5951
- declare enum PaymentStatus {
5952
- /** Payment was charged successfully. */
5953
- APPROVED = "APPROVED",
5954
- /** Payment is being processed and hasn't been confirmed yet. */
5955
- PENDING = "PENDING",
5956
- /** 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. */
5957
- PENDING_MERCHANT = "PENDING_MERCHANT",
5958
- /** Payment was canceled before it was charged. */
5959
- CANCELED = "CANCELED",
5960
- /** Payment was declined by the payment provider. */
5961
- DECLINED = "DECLINED",
5962
- /** Payment was fully refunded. */
5963
- REFUNDED = "REFUNDED",
5964
- /** Part of the payment amount was refunded. */
5965
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5966
- /** 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. */
5967
- AUTHORIZED = "AUTHORIZED",
5991
+ BRANDED_FIRST = "BRANDED_FIRST",
5992
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5993
+ NOWNIA = "NOWNIA",
5968
5994
  /**
5969
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5970
- *
5971
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5995
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5996
+ * The Partners company owns this namespace.
5972
5997
  */
5973
- VOIDED = "VOIDED"
5974
- }
5975
- /** @enumType */
5976
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5977
- interface CanceledStatusDetails {
5978
- reason?: CanceledReasonWithLiterals;
5979
- }
5980
- declare enum CanceledReason {
5981
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5982
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5983
- /** Payment was not completed by user and expired. */
5984
- EXPIRED = "EXPIRED"
5985
- }
5986
- /** @enumType */
5987
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5988
- interface DeclinedStatusDetails {
5989
- reason?: DeclinedReasonWithLiterals;
5990
- }
5991
- declare enum DeclinedReason {
5992
- /** Corresponding charge failed. */
5993
- CHARGE_FAILED = "CHARGE_FAILED",
5994
- /** Payment details expired. */
5995
- EXPIRED = "EXPIRED",
5996
- /** Insufficient funds. */
5997
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5998
- /** Gift card was disabled before charge was attempted. */
5999
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6000
- }
6001
- /** @enumType */
6002
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6003
- interface VoidedStatusDetails {
6004
- reason?: VoidedReasonWithLiterals;
6005
- }
6006
- declare enum VoidedReason {
6007
- /** Payment was voided by merchant request. */
6008
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
6009
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6010
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6011
- }
6012
- /** @enumType */
6013
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6014
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6015
- }
6016
- /** @oneof */
6017
- interface PaymentStatusDetailsStatusDetailsOneOf {
6018
- }
6019
- interface Refund {
5998
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5999
+ /** Codux Headless Sites */
6000
+ CODUX = "CODUX",
6001
+ /** Bobb - AI Design Creator. */
6002
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6020
6003
  /**
6021
- * Refund ID.
6022
- * @format GUID
6023
- * @readonly
6004
+ * Shared Blog Site is a unique single site across Enterprise account,
6005
+ * This site will hold all Blog posts related to the Marketing product.
6024
6006
  */
6025
- _id?: string;
6007
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6008
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6009
+ STANDALONE_FORMS = "STANDALONE_FORMS",
6010
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6011
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
6012
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6013
+ MIMIR = "MIMIR",
6014
+ /** Wix Twins platform. */
6015
+ TWINS = "TWINS",
6016
+ /** Wix Nano. */
6017
+ NANO = "NANO",
6018
+ /** Base44 headless sites. */
6019
+ BASE44 = "BASE44",
6020
+ /** Wix Channels Sites */
6021
+ CHANNELS = "CHANNELS",
6022
+ /** Nautilus platform. */
6023
+ NAUTILUS = "NAUTILUS",
6026
6024
  /**
6027
- * List of transactions.
6028
- * @maxSize 50
6025
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6026
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6029
6027
  */
6030
- transactions?: RefundTransaction[];
6031
- /** Refund business details. */
6032
- details?: RefundDetails;
6028
+ SYMPHONY = "SYMPHONY",
6029
+ /** Nautilus platform app. */
6030
+ NAUTILUS_APPS = "NAUTILUS_APPS",
6033
6031
  /**
6034
- * 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.
6035
- * @readonly
6036
- * @immutable
6032
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6033
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6037
6034
  */
6038
- _createdDate?: Date | null;
6035
+ VIBU = "VIBU",
6039
6036
  /**
6040
- * Aggregated refund summary.
6041
- *
6042
- * 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.
6043
- * @readonly
6037
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6038
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
6039
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6040
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
6044
6041
  */
6045
- summary?: AggregatedRefundSummary;
6042
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6046
6043
  /**
6047
- * ID of the app that initiated this refund.
6048
- * @format GUID
6049
- * @readonly
6050
- * @immutable
6044
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
6045
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6051
6046
  */
6052
- requestingServiceAppId?: string | null;
6047
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6053
6048
  }
6054
- interface RefundTransaction {
6049
+ /** @enumType */
6050
+ 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';
6051
+ /** Site transferred to another user. */
6052
+ interface SiteTransferred {
6055
6053
  /**
6056
- * ID of the payment associated with this refund.
6054
+ * A previous owner id (user that transfers meta site).
6057
6055
  * @format GUID
6058
- * @immutable
6059
6056
  */
6060
- paymentId?: string;
6057
+ oldOwnerId?: string;
6061
6058
  /**
6062
- * Refund amount.
6063
- * @immutable
6059
+ * A new owner id (user that accepts meta site).
6060
+ * @format GUID
6064
6061
  */
6065
- amount?: Price;
6066
- /** Refund status. */
6067
- refundStatus?: RefundStatusWithLiterals;
6068
- /** Optional details of current refund status. */
6069
- refundStatusInfo?: RefundStatusInfo;
6062
+ newOwnerId?: string;
6063
+ }
6064
+ /** Soft deletion of the meta site. Could be restored. */
6065
+ interface SiteDeleted {
6066
+ /** A deletion context. */
6067
+ deleteContext?: DeleteContext;
6068
+ }
6069
+ interface DeleteContext {
6070
+ /** When the meta site was deleted. */
6071
+ dateDeleted?: Date | null;
6072
+ /** A status. */
6073
+ deleteStatus?: DeleteStatusWithLiterals;
6070
6074
  /**
6071
- * Payment gateway's refund ID.
6072
- * This field is only returned when the value of `external_refund` is `false`.
6073
- * @format GUID
6075
+ * A reason (flow).
6076
+ * @maxLength 255
6074
6077
  */
6075
- gatewayRefundId?: string | null;
6076
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6077
- providerRefundId?: string | null;
6078
+ deleteOrigin?: string;
6078
6079
  /**
6079
- * Whether refund was made externally and manually on the payment provider's side.
6080
- * @immutable
6080
+ * A service that deleted it.
6081
+ * @maxLength 255
6081
6082
  */
6082
- externalRefund?: boolean;
6083
+ initiatorId?: string | null;
6083
6084
  }
6084
- /** Refund transaction status. */
6085
- declare enum RefundStatus {
6086
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6087
- PENDING = "PENDING",
6088
- /** Refund transaction succeeded. */
6089
- SUCCEEDED = "SUCCEEDED",
6090
- /** Refund transaction failed. */
6091
- FAILED = "FAILED",
6092
- /** Refund request acknowledged, and will be executed soon. */
6093
- SCHEDULED = "SCHEDULED",
6094
- /** Refund was initiated on payment provider side. */
6095
- STARTED = "STARTED"
6085
+ declare enum DeleteStatus {
6086
+ UNKNOWN = "UNKNOWN",
6087
+ TRASH = "TRASH",
6088
+ DELETED = "DELETED",
6089
+ PENDING_PURGE = "PENDING_PURGE",
6090
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6096
6091
  }
6097
6092
  /** @enumType */
6098
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6099
- interface RefundStatusInfo {
6100
- /**
6101
- * Reason code for the refund's current status.
6102
- *
6103
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6104
- * @minLength 1
6105
- * @maxLength 10
6106
- */
6107
- paymentGatewayReasonCode?: string | null;
6093
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6094
+ /** Restoration of the meta site. */
6095
+ interface SiteUndeleted {
6096
+ }
6097
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
6098
+ interface SitePublished {
6099
+ }
6100
+ interface SiteUnpublished {
6108
6101
  /**
6109
- * Free text explanation of current refund status.
6110
- * @minLength 1
6111
- * @maxLength 1000
6102
+ * A list of URLs previously associated with the meta site.
6103
+ * @maxLength 4000
6104
+ * @maxSize 10000
6112
6105
  */
6113
- description?: string | null;
6106
+ urls?: string[];
6114
6107
  }
6115
- interface AggregatedRefundSummary {
6116
- /** Total amount requested for refund. */
6117
- requestedRefund?: Price;
6118
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6119
- pendingRefund?: Price;
6120
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6121
- refunded?: Price;
6122
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
6123
- failedRefundAmount?: Price;
6124
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
6125
- pending?: boolean;
6126
- /** Breakdown of refunded items. Available only after refund is complete. */
6127
- breakdown?: RefundItemsBreakdown;
6108
+ interface SiteMarkedAsTemplate {
6128
6109
  }
6129
- interface RefundItemsBreakdown {
6110
+ interface SiteMarkedAsWixSite {
6111
+ }
6112
+ /**
6113
+ * Represents a service provisioned a site.
6114
+ *
6115
+ * Note on `origin_instance_id`:
6116
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6117
+ * This is because of the following scenario:
6118
+ *
6119
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
6120
+ * such as a product catalog. When you create a site from this template, you inherit this
6121
+ * default product catalog. However, if the template's product catalog is modified,
6122
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
6123
+ * your site remains consistent with what you initially received and does not include any
6124
+ * changes made to the original template afterward.
6125
+ * To ensure this, the TPA on the template gets a new instance_id.
6126
+ */
6127
+ interface ServiceProvisioned {
6130
6128
  /**
6131
- * Refunded line items and the amount refunded for each.
6132
- * @maxSize 300
6129
+ * Either UUID or EmbeddedServiceType.
6130
+ * @maxLength 36
6133
6131
  */
6134
- lineItems?: LineItemRefundSummary[];
6135
- }
6136
- interface LineItemRefundSummary {
6132
+ appDefId?: string;
6137
6133
  /**
6138
- * ID of the refunded line item.
6139
- * @format GUID
6134
+ * Not only UUID. Something here could be something weird.
6135
+ * @maxLength 36
6140
6136
  */
6141
- lineItemId?: string;
6142
- /** Total refunded amount for the line item. */
6143
- totalRefundedAmount?: Price;
6144
- }
6145
- interface CalculateRefundRequest {
6137
+ instanceId?: string;
6146
6138
  /**
6147
- * Order ID
6148
- * @minLength 1
6149
- * @maxLength 100
6139
+ * An instance id from which this instance is originated.
6140
+ * @maxLength 36
6150
6141
  */
6151
- ecomOrderId?: string;
6142
+ originInstanceId?: string;
6152
6143
  /**
6153
- * Refunded line items and quantity
6154
- * @maxSize 300
6144
+ * A version.
6145
+ * @maxLength 500
6155
6146
  */
6156
- refundItems?: CalculateRefundItemRequest[];
6157
- /** Should include shipping in refund calculation */
6158
- refundShipping?: boolean;
6159
- }
6160
- interface CalculateRefundItemRequest {
6147
+ version?: string | null;
6161
6148
  /**
6162
- * ID of the line item being refunded
6149
+ * The origin meta site id
6163
6150
  * @format GUID
6164
6151
  */
6165
- _id?: string;
6152
+ originMetaSiteId?: string | null;
6153
+ }
6154
+ interface ServiceRemoved {
6166
6155
  /**
6167
- * How much of that line item is being refunded
6168
- * @min 1
6169
- * @max 100000
6156
+ * Either UUID or EmbeddedServiceType.
6157
+ * @maxLength 36
6170
6158
  */
6171
- quantity?: number;
6172
- }
6173
- interface CalculateRefundResponse {
6174
- /** Total refundable amount */
6175
- total?: Price;
6176
- /** Tax cost of the order */
6177
- tax?: Price;
6178
- /** Discount given for this order */
6179
- discount?: Price;
6180
- /** Total cost of the order (without tax) */
6181
- subtotal?: Price;
6182
- /** Total shipping cost for order */
6183
- shipping?: Price;
6184
- /** Previous refund given on that order */
6185
- previouslyRefundedAmount?: Price;
6159
+ appDefId?: string;
6186
6160
  /**
6187
- * The refundable items of that order
6188
- * @maxSize 300
6161
+ * Not only UUID. Something here could be something weird.
6162
+ * @maxLength 36
6189
6163
  */
6190
- items?: CalculateRefundItemResponse[];
6191
- }
6192
- interface CalculateRefundItemResponse {
6164
+ instanceId?: string;
6193
6165
  /**
6194
- * Line item ID
6195
- * @format GUID
6166
+ * A version.
6167
+ * @maxLength 500
6196
6168
  */
6197
- _id?: string;
6198
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6199
- price?: Price;
6169
+ version?: string | null;
6200
6170
  }
6201
- interface VoidAuthorizedPaymentsRequest {
6171
+ /** Rename of the site. Meaning, free public url has been changed as well. */
6172
+ interface SiteRenamed {
6202
6173
  /**
6203
- * Wix eCommerce order ID
6204
- * @minLength 1
6205
- * @maxLength 100
6174
+ * A new meta site name (URL slug).
6175
+ * @maxLength 20
6206
6176
  */
6207
- ecomOrderId: string;
6177
+ newSiteName?: string;
6208
6178
  /**
6209
- * Payment IDs
6210
- * @minSize 1
6211
- * @maxSize 100
6212
- * @format GUID
6179
+ * A previous meta site name (URL slug).
6180
+ * @maxLength 255
6213
6181
  */
6214
- paymentIds: string[];
6182
+ oldSiteName?: string;
6215
6183
  }
6216
- interface VoidAuthorizedPaymentsResponse {
6217
- /** All order's transactions after the void was triggered */
6218
- orderTransactions?: OrderTransactions;
6184
+ /**
6185
+ * Hard deletion of the meta site.
6186
+ *
6187
+ * Could not be restored. Therefore it's desirable to cleanup data.
6188
+ */
6189
+ interface SiteHardDeleted {
6190
+ /** A deletion context. */
6191
+ deleteContext?: DeleteContext;
6219
6192
  }
6220
- interface CaptureAuthorizedPaymentsRequest {
6221
- /**
6222
- * Wix eCommerce order ID
6223
- * @minLength 1
6224
- * @maxLength 100
6225
- */
6226
- ecomOrderId: string;
6193
+ interface NamespaceChanged {
6194
+ /** A previous namespace. */
6195
+ oldNamespace?: NamespaceWithLiterals;
6196
+ /** A new namespace. */
6197
+ newNamespace?: NamespaceWithLiterals;
6198
+ }
6199
+ /** Assigned Studio editor */
6200
+ interface StudioAssigned {
6201
+ }
6202
+ /** Unassigned Studio editor */
6203
+ interface StudioUnassigned {
6204
+ }
6205
+ /**
6206
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6207
+ *
6208
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6209
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
6210
+ *
6211
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6212
+ */
6213
+ interface SiteUrlChanged {
6214
+ }
6215
+ /**
6216
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6217
+ * Consumed by other teams to remove relevant data.
6218
+ */
6219
+ interface SitePurgedExternally {
6227
6220
  /**
6228
- * Capture payments information
6229
- * @minSize 1
6221
+ * @maxLength 2048
6230
6222
  * @maxSize 100
6223
+ * @deprecated
6224
+ * @targetRemovalDate 2025-04-15
6231
6225
  */
6232
- payments: PaymentCapture[];
6226
+ appDefId?: string[];
6233
6227
  }
6234
- interface PaymentCapture {
6235
- /**
6236
- * Payment ID
6237
- * @format GUID
6238
- */
6239
- paymentId?: string | null;
6240
- /**
6241
- * Capture amount.
6242
- * If not provided - full authorized amount will be captured.
6243
- */
6244
- amount?: Price;
6228
+ /** Assigned Odeditor */
6229
+ interface OdeditorAssigned {
6245
6230
  }
6246
- interface CaptureAuthorizedPaymentsResponse {
6247
- /** All order's transactions after the capture was triggered */
6248
- orderTransactions?: OrderTransactions;
6231
+ /** Unassigned Odeditor */
6232
+ interface OdeditorUnassigned {
6249
6233
  }
6250
- interface ChargeSavedPaymentMethodRequest {
6251
- /**
6252
- * Ecom Order ID.
6253
- * @minLength 1
6254
- * @maxLength 100
6255
- */
6256
- ecomOrderId?: string;
6257
- /** Amount to be charged */
6258
- amount?: Price;
6234
+ /** Assigned Picasso editor */
6235
+ interface PicassoAssigned {
6259
6236
  }
6260
- interface ChargeSavedPaymentMethodResponse {
6261
- /** Payment gateway's order ID (e.g Wix Payments) */
6262
- paymentGatewayOrderId?: string;
6237
+ /** Unassigned Picasso */
6238
+ interface PicassoUnassigned {
6263
6239
  }
6264
- interface V1TriggerReindexRequest {
6265
- /** @format GUID */
6266
- metasiteId?: string;
6267
- /**
6268
- * @minLength 1
6269
- * @maxLength 100
6270
- * @maxSize 100
6271
- */
6272
- orderIds?: string[];
6240
+ /** Assigned Wixel */
6241
+ interface WixelAssigned {
6273
6242
  }
6274
- interface V1TriggerReindexResponse {
6243
+ /** Unassigned Wixel */
6244
+ interface WixelUnassigned {
6275
6245
  }
6276
- interface V1TriggerReindexOrderRequest {
6277
- /** @format GUID */
6278
- metasiteId?: string;
6279
- /**
6280
- * @minLength 1
6281
- * @maxLength 100
6282
- */
6283
- orderId?: string;
6246
+ /** Assigned StudioTwo */
6247
+ interface StudioTwoAssigned {
6248
+ }
6249
+ /** Unassigned StudioTwo */
6250
+ interface StudioTwoUnassigned {
6251
+ }
6252
+ /** Media from user domain is enabled. */
6253
+ interface UserDomainMediaEnabled {
6254
+ }
6255
+ /** Media from user domain is disabled. */
6256
+ interface UserDomainMediaDisabled {
6257
+ }
6258
+ /** Assigned Editorless */
6259
+ interface EditorlessAssigned {
6260
+ }
6261
+ /** Unassigned Editorless */
6262
+ interface EditorlessUnassigned {
6263
+ }
6264
+ interface HasCustomEmailConfigurationsRequest {
6265
+ }
6266
+ interface HasCustomEmailConfigurationsResponse {
6267
+ hasCustomConfigurations?: boolean;
6268
+ }
6269
+ interface AddToAutomationMigrationPopulationRequest {
6270
+ /** When true, sends custom email configurations to automation system via email */
6271
+ sendCustomEmailConfigs?: boolean;
6272
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6273
+ origin?: OriginWithLiterals;
6274
+ }
6275
+ declare enum Origin {
6276
+ OPT_IN = "OPT_IN",
6277
+ MIGRATION = "MIGRATION"
6278
+ }
6279
+ /** @enumType */
6280
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6281
+ interface AddToAutomationMigrationPopulationResponse {
6282
+ success?: boolean;
6283
+ }
6284
+ interface IsInAutomationMigrationPopulationRequest {
6285
+ }
6286
+ interface IsInAutomationMigrationPopulationResponse {
6287
+ inPopulation?: boolean;
6284
6288
  }
6285
6289
  interface DiffmatokyPayload {
6286
6290
  left?: string;
@@ -8612,7 +8616,7 @@ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void |
8612
8616
  * @applicableIdentity APP
8613
8617
  * @fqn com.wix.ecom.orders.importer.v1.OrderImports.ImportOrder
8614
8618
  */
8615
- 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> & {
8619
+ 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> & {
8616
8620
  __applicationErrorsType?: ImportOrderApplicationErrors;
8617
8621
  }>;
8618
8622
  /**
@@ -8781,7 +8785,7 @@ declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNul
8781
8785
  * @returns Fulfilled - The requested order.
8782
8786
  * @fqn com.wix.ecom.orders.v1.Orders.GetOrder
8783
8787
  */
8784
- 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> & {
8788
+ 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> & {
8785
8789
  __applicationErrorsType?: GetOrderApplicationErrors;
8786
8790
  }>;
8787
8791
  interface OrderSearchSpec extends SearchSpec {
@@ -8954,7 +8958,7 @@ declare const utils: {
8954
8958
  * @returns Newly created order.
8955
8959
  * @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
8956
8960
  */
8957
- 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> & {
8961
+ 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> & {
8958
8962
  __applicationErrorsType?: CreateOrderApplicationErrors;
8959
8963
  }>;
8960
8964
  interface CreateOrderOptions {
@@ -8997,7 +9001,7 @@ interface CreateOrderOptions {
8997
9001
  * @returns Newly created order.
8998
9002
  * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
8999
9003
  */
9000
- 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> & {
9004
+ 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> & {
9001
9005
  __applicationErrorsType?: UpdateOrderApplicationErrors;
9002
9006
  }>;
9003
9007
  interface UpdateOrder {
@@ -9419,7 +9423,7 @@ interface UpdateOrderLineItem {
9419
9423
  * @applicableIdentity APP
9420
9424
  * @fqn com.wix.ecom.orders.v1.Orders.AddActivities
9421
9425
  */
9422
- 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>>;
9426
+ 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>>;
9423
9427
  interface AddActivitiesOptions {
9424
9428
  /**
9425
9429
  * Activities to add to the order.
@@ -9465,7 +9469,7 @@ interface DeleteActivityIdentifiers {
9465
9469
  * @applicableIdentity APP
9466
9470
  * @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
9467
9471
  */
9468
- 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> & {
9472
+ 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> & {
9469
9473
  __applicationErrorsType?: CancelOrderApplicationErrors;
9470
9474
  }>;
9471
9475
  interface CancelOrderOptions {
@@ -9516,4 +9520,4 @@ interface BulkUpdateOrderTagsOptions {
9516
9520
  unassignTags?: TagsTags;
9517
9521
  }
9518
9522
 
9519
- export { RepriceStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type DescriptionLine as a$, BaseRateSource as a0, PaymentStatusEnumPaymentStatus as a1, FulfillmentStatus as a2, WeightUnit as a3, VatType as a4, PickupMethod as a5, OrderStatus as a6, CrossBorderNotApplicableReason as a7, CrossBorderRepricingMode as a8, DiscountType as a9, NonRefundableReason as aA, ManuallyRefundableReason as aB, RestockType as aC, TransactionStatus as aD, AuthorizationCaptureStatus as aE, AuthorizationVoidStatus as aF, Reason as aG, ActionType as aH, ChargebackStatus as aI, MembershipPaymentStatus as aJ, PaymentStatus as aK, CanceledReason as aL, DeclinedReason as aM, VoidedReason as aN, RefundStatus as aO, SortOrder as aP, OrderApprovalStrategy as aQ, Placement as aR, SubdivisionType as aS, SourceType as aT, CustomFieldGroup as aU, ValueType as aV, DepositType as aW, InvoiceStatus as aX, type OrderLineItem as aY, type ProductName as aZ, type CatalogReference as a_, DiscountValueType as aa, DiscountReason as ab, LineItemQuantityChangeType as ac, ActivityType as ad, OrderActivityTypeEnumActivityType as ae, AttributionSource as af, ChannelType as ag, AdditionalFeeSource as ah, OrderActionType as ai, SpecificItemsCouponBehavior as aj, ChargeType as ak, VersioningMode as al, DeltaPaymentOptionType as am, InventoryAction as an, WebhookIdentityType as ao, PreviewEmailType as ap, State as aq, SiteCreatedContext as ar, Namespace as as, DeleteStatus as at, Origin as au, ScheduledAction as av, DurationUnit as aw, PaymentCollectabilityStatus as ax, PredefinedPaymentMethod as ay, RefundableStatus as az, type SetOrderNumberCounterResponse as b, type MerchantDiscount as b$, type DescriptionLineValueOneOf as b0, type DescriptionLineDescriptionLineValueOneOf as b1, type DescriptionLineName as b2, type PlainTextValue as b3, type Color as b4, type FocalPoint as b5, type PhysicalProperties as b6, type Dimensions as b7, type ItemType as b8, type ItemTypeItemTypeDataOneOf as b9, type BuyerInfo as bA, type BuyerInfoIdOneOf as bB, type CurrencyConversionDetails as bC, type CrossBorderRepricing as bD, type PriceSummary as bE, type AddressWithContact as bF, type Address as bG, type StreetAddress as bH, type AddressLocation as bI, type FullAddressContactDetails as bJ, type VatId as bK, type V1ShippingInformation as bL, type DeliveryLogistics as bM, type DeliveryLogisticsAddressOneOf as bN, type PickupDetails as bO, type PickupAddress as bP, type DeliveryTimeSlot as bQ, type ShippingPrice as bR, type ShippingRegion as bS, type TaxSummary as bT, type OrderTaxInfo as bU, type OrderTaxBreakdown as bV, type CrossBorderCalculation as bW, type AppliedDiscount as bX, type AppliedDiscountDiscountSourceOneOf as bY, type Coupon as bZ, type CouponDiscountValueOneOf as b_, type RestockLocation as ba, type ItemTaxFullDetails as bb, type LineItemTaxInfo as bc, type LineItemTaxBreakdown as bd, type DigitalFile as be, type SubscriptionInfo as bf, type SubscriptionTitle as bg, type SubscriptionDescription as bh, type SubscriptionSettings as bi, type FreeTrialPeriod as bj, type BillingSettings as bk, type BillingAdjustment as bl, type BillingAdjustmentPriceSummary as bm, type CyclePriceOverride as bn, type PriceDescription as bo, type LocationAndQuantity as bp, type TaxableAddress as bq, type TaxableAddressTaxableAddressDataOneOf as br, type DecimalQuantity as bs, type DecimalQuantityUnitOneOf as bt, type TranslatableString as bu, type ExtendedFields as bv, type ModifierGroup as bw, type ItemModifier as bx, type ServiceProperties as by, type CrossBorderPriceAdjustment as bz, type SetOrderNumberCounterApplicationErrors as c, type CreatedBy as c$, type MerchantDiscountMerchantDiscountReasonOneOf as c0, type DiscountRule as c1, type DiscountRuleDiscountValueOneOf as c2, type DiscountRuleName as c3, type LineItemDiscount as c4, type ItemCombination as c5, type ItemCombinationLineItem as c6, type Activity as c7, type ActivityContentOneOf as c8, type CustomActivity as c9, type AuthorizedPaymentVoided as cA, type RefundInitiated as cB, type RefundedPayment as cC, type RefundedPaymentKindOneOf as cD, type RegularPaymentRefund as cE, type GiftCardPaymentRefund as cF, type MembershipPaymentRefund as cG, type PaymentRefunded as cH, type PaymentRefundFailed as cI, type RefundedAsStoreCredit as cJ, type PaymentPending as cK, type PaymentPendingPaymentDetailsOneOf as cL, type RegularPayment as cM, type RegularPaymentPaymentMethodDetailsOneOf as cN, type CreditCardDetails as cO, type PaymentCanceled as cP, type PaymentCanceledPaymentDetailsOneOf as cQ, type PaymentDeclined as cR, type PaymentDeclinedPaymentDetailsOneOf as cS, type ReceiptCreated as cT, type ReceiptCreatedReceiptInfoOneOf as cU, type WixReceipt as cV, type ExternalReceipt as cW, type ReceiptSent as cX, type ReceiptSentReceiptInfoOneOf as cY, type ChargebackCreated as cZ, type ChargebackReversed as c_, type MerchantComment as ca, type OrderRefunded as cb, type OrderCreatedFromExchange as cc, type NewExchangeOrderCreated as cd, type LineItemExchangeData as ce, type DraftOrderChangesApplied as cf, type OrderChange as cg, type OrderChangeValueOneOf as ch, type LineItemChanges as ci, type LineItemQuantityChange as cj, type LineItemPriceChange as ck, type LineItemProductNameChange as cl, type LineItemDescriptionLineChange as cm, type LineItemModifiersChange as cn, type ManagedLineItem as co, type ManagedDiscount as cp, type TranslatedValue as cq, type LineItemAmount as cr, type ManagedAdditionalFee as cs, type TotalPriceChange as ct, type ShippingInformationChange as cu, type ShippingInformation as cv, type PricesRecalculatedForDestination as cw, type SavedPaymentMethod as cx, type AuthorizedPaymentCreated as cy, type AuthorizedPaymentCaptured as cz, type PreparePaymentCollectionOptions as d, type EntityUpdatedEvent as d$, type CreatedByStringOneOf as d0, type ChannelInfo as d1, type CustomField as d2, type BalanceSummary as d3, type Balance as d4, type CashRounding as d5, type AdditionalFee as d6, type FulfillmentStatusesAggregate as d7, type Tags as d8, type TagList as d9, type V1RestockItem as dA, type OrderImported as dB, type ImportedOrderDeleted as dC, type PaymentStatusUpdated as dD, type FulfillmentStatusUpdated as dE, type OrderCanceledEventOrderCanceled as dF, type OrderDeltasCommitted as dG, type CommittedDiffs as dH, type CommittedDiffsShippingUpdateInfoOneOf as dI, type ItemChangedDetails as dJ, type OrderLineItemChangedDetails as dK, type DecimalQuantityUpdate as dL, type CrossBorderAdjustmentUpdate as dM, type LineItemDelta as dN, type LineItemDeltaDeltaOneOf as dO, type AppliedDiscountDelta as dP, type AppliedDiscountDeltaDeltaOneOf as dQ, type AdditionalFeeDelta as dR, type AdditionalFeeDeltaDeltaOneOf as dS, type DraftOrderCommitSettings as dT, type InventoryUpdateDetails as dU, type TriggerReindexRequest as dV, type TriggerReindexResponse as dW, type DomainEvent as dX, type DomainEventBodyOneOf as dY, type EntityCreatedEvent as dZ, type RestoreInfo as d_, type Location as da, type OrderSettings as db, type OrderSettingsAllowedActionsOneOf as dc, type OrderSettingsEditableByOneOf as dd, type CustomAllowedActions as de, type OwnerApps as df, type FormInfo as dg, type FormIdentifier as dh, type PlatformFeeSummary as di, type PlatformFee as dj, type UpdateInternalDocumentsEvent as dk, type UpdateInternalDocumentsEventOperationOneOf as dl, type InternalDocument as dm, type InternalDocumentUpdateOperation as dn, type DeleteByIdsOperation as dp, type DeleteByFilterOperation as dq, type InternalDocumentUpdateByFilterOperation as dr, type InternalUpdateExistingOperation as ds, type VersionedDocumentUpdateOperation as dt, type VersionedDeleteByIdsOperation as du, type VersionedDocumentId as dv, type OrderApproved as dw, type OrdersExperiments as dx, type OrderRejectedEventOrderRejected as dy, type OrderItemsRestocked as dz, type PreparePaymentCollectionResponse as e, type SiteUndeleted as e$, type EntityDeletedEvent as e0, type ActionEvent as e1, type Empty as e2, type TriggerReindexOrderRequest as e3, type MessageEnvelope as e4, type IdentificationData as e5, type IdentificationDataIdOneOf as e6, type AccountInfo as e7, type ImportOrderRequest as e8, type SetOrderNumberCounterRequest as e9, type RefundDetails as eA, type RefundItem as eB, type LineItemRefund as eC, type AdditionalFeeRefund as eD, type ShippingRefund as eE, type PreviewRefundEmailResponse as eF, type PreviewCancelEmailRequest as eG, type PreviewCancelEmailResponse as eH, type PreviewCancelRefundEmailRequest as eI, type PreviewCancelRefundEmailResponse as eJ, type PreviewBuyerPaymentsReceivedEmailRequest as eK, type PreviewBuyerPaymentsReceivedEmailResponse as eL, type PreviewBuyerConfirmationEmailRequest as eM, type PreviewBuyerConfirmationEmailResponse as eN, type PreviewBuyerPickupConfirmationEmailRequest as eO, type PreviewBuyerPickupConfirmationEmailResponse as eP, type PreviewShippingConfirmationEmailRequest as eQ, type PreviewShippingConfirmationEmailResponse as eR, type PreviewResendDownloadLinksEmailRequest as eS, type PreviewResendDownloadLinksEmailResponse as eT, type MetaSiteSpecialEvent as eU, type MetaSiteSpecialEventPayloadOneOf as eV, type Asset as eW, type SiteCreated as eX, type SiteTransferred as eY, type SiteDeleted as eZ, type DeleteContext as e_, type BulkDeleteImportedOrdersRequest as ea, type SendBuyerConfirmationEmailRequest as eb, type SendBuyerConfirmationEmailResponse as ec, type SendBuyerPaymentsReceivedEmailRequest as ed, type SendBuyerPaymentsReceivedEmailResponse as ee, type SendBuyerPickupConfirmationEmailRequest as ef, type SendBuyerPickupConfirmationEmailResponse as eg, type BulkSendBuyerPickupConfirmationEmailsRequest as eh, type BulkSendBuyerPickupConfirmationEmailsResponse as ei, type SendBuyerShippingConfirmationEmailRequest as ej, type SendBuyerShippingConfirmationEmailResponse as ek, type BulkSendBuyerShippingConfirmationEmailsRequest as el, type BulkSendBuyerShippingConfirmationEmailsResponse as em, type SendMerchantOrderReceivedNotificationRequest as en, type SendMerchantOrderReceivedNotificationResponse as eo, type SendCancelRefundEmailRequest as ep, type SendCancelRefundEmailResponse as eq, type SendRefundEmailRequest as er, type SendRefundEmailResponse as es, type SendFulfillmentEmailRequest as et, type SendFulfillmentEmailResponse as eu, type SendMerchantOrderReceivedPushRequest as ev, type SendMerchantOrderReceivedPushResponse as ew, type PreviewEmailByTypeRequest as ex, type PreviewEmailByTypeResponse as ey, type PreviewRefundEmailRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type RestockItem as f$, type SitePublished as f0, type SiteUnpublished as f1, type SiteMarkedAsTemplate as f2, type SiteMarkedAsWixSite as f3, type ServiceProvisioned as f4, type ServiceRemoved as f5, type SiteRenamed as f6, type SiteHardDeleted as f7, type NamespaceChanged as f8, type StudioAssigned as f9, type RecordManuallyCollectedPaymentRequest as fA, type UserDefinedPaymentMethodName as fB, type UserDefinedPaymentMethodNameKindOneOf as fC, type RecordManuallyCollectedPaymentResponse as fD, type MarkOrderAsPaidRequest as fE, type MarkOrderAsPaidResponse as fF, type BulkMarkOrdersAsPaidRequest as fG, type BulkMarkOrdersAsPaidResponse as fH, type BulkOrderResult as fI, type ItemMetadata as fJ, type ApplicationError as fK, type BulkActionMetadata as fL, type GetRefundabilityStatusRequest as fM, type GetRefundabilityStatusResponse as fN, type Refundability as fO, type RefundabilityAdditionalRefundabilityInfoOneOf as fP, type CreatePaymentGatewayOrderRequest as fQ, type ChargedBy as fR, type CreatePaymentGatewayOrderResponse as fS, type ChargeMembershipsRequest as fT, type MembershipChargeItem as fU, type MembershipName as fV, type ChargeMembershipsResponse as fW, type TriggerRefundRequest as fX, type PaymentRefund as fY, type RefundSideEffects as fZ, type RestockInfo as f_, type StudioUnassigned as fa, type SiteUrlChanged as fb, type SitePurgedExternally as fc, type OdeditorAssigned as fd, type OdeditorUnassigned as fe, type PicassoAssigned as ff, type PicassoUnassigned as fg, type WixelAssigned as fh, type WixelUnassigned as fi, type StudioTwoAssigned as fj, type StudioTwoUnassigned as fk, type UserDomainMediaEnabled as fl, type UserDomainMediaDisabled as fm, type EditorlessAssigned as fn, type EditorlessUnassigned as fo, type HasCustomEmailConfigurationsRequest as fp, type HasCustomEmailConfigurationsResponse as fq, type AddToAutomationMigrationPopulationRequest as fr, type AddToAutomationMigrationPopulationResponse as fs, type IsInAutomationMigrationPopulationRequest as ft, type IsInAutomationMigrationPopulationResponse as fu, type PreparePaymentCollectionRequest as fv, type RedirectUrls as fw, type DelayedCaptureSettings as fx, type Duration as fy, type GetPaymentCollectabilityStatusRequest as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type CreateOrderRequest as g$, type TriggerRefundResponse as g0, type OrderTransactions as g1, type Payment as g2, type PaymentPaymentDetailsOneOf as g3, type PaymentReceiptInfoOneOf as g4, type PaymentStatusDetailsOneOf as g5, type RegularPaymentDetails as g6, type RegularPaymentDetailsPaymentMethodDetailsOneOf as g7, type CreditCardPaymentMethodDetails as g8, type AuthorizationDetails as g9, type CalculateRefundItemResponse as gA, type VoidAuthorizedPaymentsRequest as gB, type CaptureAuthorizedPaymentsRequest as gC, type ChargeSavedPaymentMethodRequest as gD, type ChargeSavedPaymentMethodResponse as gE, type V1TriggerReindexRequest as gF, type V1TriggerReindexResponse as gG, type V1TriggerReindexOrderRequest as gH, type DiffmatokyPayload as gI, type ErrorInformation as gJ, type GetOrderRequest as gK, type GetOrderResponse as gL, type InternalQueryOrdersRequest as gM, type PlatformQuery as gN, type PlatformQueryPagingMethodOneOf as gO, type Sorting as gP, type PlatformPaging as gQ, type CursorPaging as gR, type InternalQueryOrdersResponse as gS, type PlatformPagingMetadata as gT, type Cursors as gU, type QueryOrderRequest as gV, type QueryOrderResponse as gW, type SearchOrdersRequest as gX, type CursorSearch as gY, type CursorSearchPagingMethodOneOf as gZ, type CursorPagingMetadata as g_, type AuthorizationCapture as ga, type AuthorizationActionFailureDetails as gb, type AuthorizationVoid as gc, type V1ScheduledAction as gd, type Chargeback as ge, type PaymentMethodName as gf, type GiftCardPaymentDetails as gg, type MembershipPaymentDetails as gh, type FutureMembershipDetails as gi, type WixReceiptInfo as gj, type ExternalReceiptInfo as gk, type CashRoundingDetails as gl, type CanceledStatusDetails as gm, type DeclinedStatusDetails as gn, type VoidedStatusDetails as go, type PaymentStatusDetails as gp, type PaymentStatusDetailsStatusDetailsOneOf as gq, type Refund as gr, type RefundTransaction as gs, type RefundStatusInfo as gt, type AggregatedRefundSummary as gu, type RefundItemsBreakdown as gv, type LineItemRefundSummary as gw, type CalculateRefundRequest as gx, type CalculateRefundItemRequest as gy, type CalculateRefundResponse as gz, type PaymentCapture as h, type OrderRejected as h$, type OrderCreationSettings as h0, type OrderCreationSettingsEditableByOneOf as h1, type OrderCreateNotifications as h2, type CreateOrderResponse as h3, type UpdateOrderRequest as h4, type UpdateOrderResponse as h5, type BulkUpdateOrdersRequest as h6, type CommitDeltasRequest as h7, type DraftOrderDiffs as h8, type DraftOrderDiffsShippingUpdateInfoOneOf as h9, type UpdateBillingContactDetailsResponse as hA, type UpdateOrderLineItemRequest as hB, type UpdateOrderLineItemResponse as hC, type UpdateOrderLineItemsRequest as hD, type MaskedOrderLineItem as hE, type UpdateOrderLineItemsResponse as hF, type AddInternalActivityRequest as hG, type InternalActivity as hH, type InternalActivityContentOneOf as hI, type OrderPlaced as hJ, type OrderPaid as hK, type OrderFulfilled as hL, type OrderNotFulfilled as hM, type OrderCanceled as hN, type DownloadLinkSent as hO, type TrackingNumberAdded as hP, type TrackingNumberEdited as hQ, type TrackingLinkAdded as hR, type ShippingConfirmationEmailSent as hS, type InvoiceAdded as hT, type InvoiceSent as hU, type FulfillerEmailSent as hV, type ShippingAddressEdited as hW, type EmailEdited as hX, type PickupReadyEmailSent as hY, type OrderPartiallyPaid as hZ, type OrderPending as h_, type DraftOrderDiffsBuyerUpdateInfoOneOf as ha, type DraftOrderDiffsBillingUpdateInfoOneOf as hb, type DraftOrderDiffsRecipientUpdateInfoOneOf as hc, type V1LineItemDelta as hd, type V1LineItemDeltaDeltaOneOf as he, type CommitDeltasResponse as hf, type ArchiveOrderRequest as hg, type ArchiveOrderResponse as hh, type BulkArchiveOrdersRequest as hi, type BulkArchiveOrdersResponse as hj, type BulkArchiveOrdersByFilterRequest as hk, type BulkArchiveOrdersByFilterResponse as hl, type UnArchiveOrderRequest as hm, type UnArchiveOrderResponse as hn, type BulkUnArchiveOrdersRequest as ho, type BulkUnArchiveOrdersResponse as hp, type BulkUnArchiveOrdersByFilterRequest as hq, type BulkUnArchiveOrdersByFilterResponse as hr, type UpdateBuyerInfoRequest as hs, type BuyerInfoUpdate as ht, type UpdateBuyerInfoResponse as hu, type UpdateBuyerEmailRequest as hv, type UpdateBuyerEmailResponse as hw, type UpdateOrderShippingAddressRequest as hx, type UpdateOrderShippingAddressResponse as hy, type UpdateBillingContactDetailsRequest as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type InvoiceFields as i$, type AddInternalActivityResponse as i0, type AddActivityRequest as i1, type PublicActivity as i2, type PublicActivityContentOneOf as i3, type AddActivityResponse as i4, type AddActivitiesRequest as i5, type UpdateActivityRequest as i6, type UpdateActivityResponse as i7, type DeleteActivityRequest as i8, type DeleteActivityResponse as i9, type V1MarkOrderAsPaidResponse as iA, type V1BulkMarkOrdersAsPaidRequest as iB, type V1BulkMarkOrdersAsPaidResponse as iC, type V1CreatePaymentGatewayOrderRequest as iD, type V1CreatePaymentGatewayOrderResponse as iE, type GetShipmentsRequest as iF, type GetShipmentsResponse as iG, type AggregateOrdersRequest as iH, type AggregateOrdersResponse as iI, type DecrementItemsQuantityRequest as iJ, type DecrementData as iK, type DecrementItemsQuantityResponse as iL, type BulkUpdateOrderTagsRequest as iM, type TagsTags as iN, type TagsTagList as iO, type BulkUpdateOrderTagsResult as iP, type SendOrderUpdatedDomainEventRequest as iQ, type SendOrderUpdatedDomainEventResponse as iR, type Task as iS, type TaskKey as iT, type TaskAction as iU, type TaskActionActionOneOf as iV, type Complete as iW, type Cancel as iX, type Reschedule as iY, type InvoiceSentEvent as iZ, type IdAndVersion as i_, type UpdateLineItemsDescriptionLinesRequest as ia, type LineItemUpdate as ib, type UpdateLineItemsDescriptionLinesResponse as ic, type MarkOrderAsSeenByHumanRequest as id, type MarkOrderAsSeenByHumanResponse as ie, type CancelOrderRequest as ig, type UpdateOrderStatusRequest as ih, type UpdateOrderStatusResponse as ii, type MarkAsFulfilledRequest as ij, type MarkAsFulfilledResponse as ik, type BulkMarkAsFulfilledRequest as il, type BulkMarkAsFulfilledResponse as im, type BulkMarkAsFulfilledByFilterRequest as io, type BulkMarkAsFulfilledByFilterResponse as ip, type MarkAsUnfulfilledRequest as iq, type MarkAsUnfulfilledResponse as ir, type BulkMarkAsUnfulfilledRequest as is, type BulkMarkAsUnfulfilledResponse as it, type BulkMarkAsUnfulfilledByFilterRequest as iu, type BulkMarkAsUnfulfilledByFilterResponse as iv, type BulkSetBusinessLocationRequest as iw, type BulkSetBusinessLocationResponse as ix, type BulkSetBusinessLocationResult as iy, type V1MarkOrderAsPaidRequest as iz, type GetOrderApplicationErrors as j, type PickupMethodWithLiterals as j$, type Customer as j0, type Email as j1, type QuotesAddress as j2, type AddressDescription as j3, type Phone as j4, type Company as j5, type CommonAddress as j6, type CommonAddressStreetOneOf as j7, type Subdivision as j8, type StandardDetails as j9, type PaymentCollectionMarkOrderAsPaidOptions as jA, type PaymentCollectionCreatePaymentGatewayOrderOptions as jB, type ChargeMembershipsOptions as jC, type TriggerRefundOptions as jD, type OrderSearchSpec as jE, type UpdateOrderLineItemIdentifiers as jF, type UpdateOrderLineItem as jG, type UpdateActivityIdentifiers as jH, type DeleteActivityIdentifiers as jI, type AggregateOrdersOptions as jJ, utils as jK, type DescriptionLineTypeWithLiterals as jL, type DimensionsUnitWithLiterals as jM, type ItemTypePresetWithLiterals as jN, type PaymentOptionTypeWithLiterals as jO, type JurisdictionTypeWithLiterals as jP, type SubscriptionFrequencyWithLiterals as jQ, type ProductPeriodAlignmentWithLiterals as jR, type AdjustmentTypeWithLiterals as jS, type TaxableAddressTypeWithLiterals as jT, type MeasurementUnitWithLiterals as jU, type RepriceStatusWithLiterals as jV, type BaseRateSourceWithLiterals as jW, type PaymentStatusEnumPaymentStatusWithLiterals as jX, type FulfillmentStatusWithLiterals as jY, type WeightUnitWithLiterals as jZ, type VatTypeWithLiterals as j_, type ShippingContactDetails as ja, type InvoiceDates as jb, type LineItems as jc, type LineItem as jd, type BigDecimalWrapper as je, type LineItemTax as jf, type Source as jg, type LineItemMetaData as jh, type Locale as ji, type TotalPrice as jj, type ItemizedFee as jk, type Discount as jl, type DiscountOneDiscountTypeOneOf as jm, type CalculatedTaxes as jn, type CalculatedTax as jo, type Payments as jp, type InvoicesPayment as jq, type MetaData as jr, type InvoiceDynamicPriceTotals as js, type CustomFieldValue as jt, type Value as ju, type Deposit as jv, type BaseEventMetadata as jw, type EventMetadata as jx, type AccountInfoMetadata as jy, type RecordManuallyCollectedPaymentOptions as jz, type OrderSearch as k, onOrderCreated as k$, type OrderStatusWithLiterals as k0, type CrossBorderNotApplicableReasonWithLiterals as k1, type CrossBorderRepricingModeWithLiterals as k2, type DiscountTypeWithLiterals as k3, type DiscountValueTypeWithLiterals as k4, type DiscountReasonWithLiterals as k5, type LineItemQuantityChangeTypeWithLiterals as k6, type ActivityTypeWithLiterals as k7, type OrderActivityTypeEnumActivityTypeWithLiterals as k8, type AttributionSourceWithLiterals as k9, type ReasonWithLiterals as kA, type ActionTypeWithLiterals as kB, type ChargebackStatusWithLiterals as kC, type MembershipPaymentStatusWithLiterals as kD, type PaymentStatusWithLiterals as kE, type CanceledReasonWithLiterals as kF, type DeclinedReasonWithLiterals as kG, type VoidedReasonWithLiterals as kH, type RefundStatusWithLiterals as kI, type SortOrderWithLiterals as kJ, type OrderApprovalStrategyWithLiterals as kK, type PlacementWithLiterals as kL, type SubdivisionTypeWithLiterals as kM, type SourceTypeWithLiterals as kN, type CustomFieldGroupWithLiterals as kO, type ValueTypeWithLiterals as kP, type DepositTypeWithLiterals as kQ, type InvoiceStatusWithLiterals as kR, type RecordManuallyCollectedPaymentApplicationErrors as kS, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kT, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kU, type TriggerRefundApplicationErrors as kV, type UpdateOrderStatusApplicationErrors as kW, type CommonSearchWithEntityContext as kX, onOrderApproved as kY, onOrderCanceled as kZ, onOrderCommitted as k_, type ChannelTypeWithLiterals as ka, type AdditionalFeeSourceWithLiterals as kb, type OrderActionTypeWithLiterals as kc, type SpecificItemsCouponBehaviorWithLiterals as kd, type ChargeTypeWithLiterals as ke, type VersioningModeWithLiterals as kf, type DeltaPaymentOptionTypeWithLiterals as kg, type InventoryActionWithLiterals as kh, type WebhookIdentityTypeWithLiterals as ki, type PreviewEmailTypeWithLiterals as kj, type StateWithLiterals as kk, type SiteCreatedContextWithLiterals as kl, type NamespaceWithLiterals as km, type DeleteStatusWithLiterals as kn, type OriginWithLiterals as ko, type ScheduledActionWithLiterals as kp, type DurationUnitWithLiterals as kq, type PaymentCollectabilityStatusWithLiterals as kr, type PredefinedPaymentMethodWithLiterals as ks, type RefundableStatusWithLiterals as kt, type NonRefundableReasonWithLiterals as ku, type ManuallyRefundableReasonWithLiterals as kv, type RestockTypeWithLiterals as kw, type TransactionStatusWithLiterals as kx, type AuthorizationCaptureStatusWithLiterals as ky, type AuthorizationVoidStatusWithLiterals as kz, type SearchOrdersResponse 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, voidAuthorizedPayments as la, captureAuthorizedPayments as lb, getOrder as lc, createOrder as ld, updateOrder as le, bulkUpdateOrders as lf, addActivities as lg, cancelOrder as lh, bulkUpdateOrderTags as li, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };
9523
+ export { RepriceStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type DescriptionLine as a$, BaseRateSource as a0, PaymentStatusEnumPaymentStatus as a1, FulfillmentStatus as a2, WeightUnit as a3, VatType as a4, PickupMethod as a5, OrderStatus as a6, CrossBorderNotApplicableReason as a7, CrossBorderRepricingMode as a8, DiscountType as a9, Reason as aA, ActionType as aB, ChargebackStatus as aC, MembershipPaymentStatus as aD, PaymentStatus as aE, CanceledReason as aF, DeclinedReason as aG, VoidedReason as aH, RefundStatus as aI, PreviewEmailType as aJ, State as aK, SiteCreatedContext as aL, Namespace as aM, DeleteStatus as aN, Origin as aO, SortOrder as aP, OrderApprovalStrategy as aQ, Placement as aR, SubdivisionType as aS, SourceType as aT, CustomFieldGroup as aU, ValueType as aV, DepositType as aW, InvoiceStatus as aX, type OrderLineItem as aY, type ProductName as aZ, type CatalogReference as a_, DiscountValueType as aa, DiscountReason as ab, LineItemQuantityChangeType as ac, ActivityType as ad, OrderActivityTypeEnumActivityType as ae, AttributionSource as af, ChannelType as ag, AdditionalFeeSource as ah, OrderActionType as ai, SpecificItemsCouponBehavior as aj, ChargeType as ak, VersioningMode as al, DeltaPaymentOptionType as am, InventoryAction as an, WebhookIdentityType as ao, ScheduledAction as ap, DurationUnit as aq, PaymentCollectabilityStatus as ar, PredefinedPaymentMethod as as, RefundableStatus as at, NonRefundableReason as au, ManuallyRefundableReason as av, RestockType as aw, TransactionStatus as ax, AuthorizationCaptureStatus as ay, AuthorizationVoidStatus as az, type SetOrderNumberCounterResponse as b, type MerchantDiscount as b$, type DescriptionLineValueOneOf as b0, type DescriptionLineDescriptionLineValueOneOf as b1, type DescriptionLineName as b2, type PlainTextValue as b3, type Color as b4, type FocalPoint as b5, type PhysicalProperties as b6, type Dimensions as b7, type ItemType as b8, type ItemTypeItemTypeDataOneOf as b9, type BuyerInfo as bA, type BuyerInfoIdOneOf as bB, type CurrencyConversionDetails as bC, type CrossBorderRepricing as bD, type PriceSummary as bE, type AddressWithContact as bF, type Address as bG, type StreetAddress as bH, type AddressLocation as bI, type FullAddressContactDetails as bJ, type VatId as bK, type V1ShippingInformation as bL, type DeliveryLogistics as bM, type DeliveryLogisticsAddressOneOf as bN, type PickupDetails as bO, type PickupAddress as bP, type DeliveryTimeSlot as bQ, type ShippingPrice as bR, type ShippingRegion as bS, type TaxSummary as bT, type OrderTaxInfo as bU, type OrderTaxBreakdown as bV, type CrossBorderCalculation as bW, type AppliedDiscount as bX, type AppliedDiscountDiscountSourceOneOf as bY, type Coupon as bZ, type CouponDiscountValueOneOf as b_, type RestockLocation as ba, type ItemTaxFullDetails as bb, type LineItemTaxInfo as bc, type LineItemTaxBreakdown as bd, type DigitalFile as be, type SubscriptionInfo as bf, type SubscriptionTitle as bg, type SubscriptionDescription as bh, type SubscriptionSettings as bi, type FreeTrialPeriod as bj, type BillingSettings as bk, type BillingAdjustment as bl, type BillingAdjustmentPriceSummary as bm, type CyclePriceOverride as bn, type PriceDescription as bo, type LocationAndQuantity as bp, type TaxableAddress as bq, type TaxableAddressTaxableAddressDataOneOf as br, type DecimalQuantity as bs, type DecimalQuantityUnitOneOf as bt, type TranslatableString as bu, type ExtendedFields as bv, type ModifierGroup as bw, type ItemModifier as bx, type ServiceProperties as by, type CrossBorderPriceAdjustment as bz, type SetOrderNumberCounterApplicationErrors as c, type CreatedBy as c$, type MerchantDiscountMerchantDiscountReasonOneOf as c0, type DiscountRule as c1, type DiscountRuleDiscountValueOneOf as c2, type DiscountRuleName as c3, type LineItemDiscount as c4, type ItemCombination as c5, type ItemCombinationLineItem as c6, type Activity as c7, type ActivityContentOneOf as c8, type CustomActivity as c9, type AuthorizedPaymentVoided as cA, type RefundInitiated as cB, type RefundedPayment as cC, type RefundedPaymentKindOneOf as cD, type RegularPaymentRefund as cE, type GiftCardPaymentRefund as cF, type MembershipPaymentRefund as cG, type PaymentRefunded as cH, type PaymentRefundFailed as cI, type RefundedAsStoreCredit as cJ, type PaymentPending as cK, type PaymentPendingPaymentDetailsOneOf as cL, type RegularPayment as cM, type RegularPaymentPaymentMethodDetailsOneOf as cN, type CreditCardDetails as cO, type PaymentCanceled as cP, type PaymentCanceledPaymentDetailsOneOf as cQ, type PaymentDeclined as cR, type PaymentDeclinedPaymentDetailsOneOf as cS, type ReceiptCreated as cT, type ReceiptCreatedReceiptInfoOneOf as cU, type WixReceipt as cV, type ExternalReceipt as cW, type ReceiptSent as cX, type ReceiptSentReceiptInfoOneOf as cY, type ChargebackCreated as cZ, type ChargebackReversed as c_, type MerchantComment as ca, type OrderRefunded as cb, type OrderCreatedFromExchange as cc, type NewExchangeOrderCreated as cd, type LineItemExchangeData as ce, type DraftOrderChangesApplied as cf, type OrderChange as cg, type OrderChangeValueOneOf as ch, type LineItemChanges as ci, type LineItemQuantityChange as cj, type LineItemPriceChange as ck, type LineItemProductNameChange as cl, type LineItemDescriptionLineChange as cm, type LineItemModifiersChange as cn, type ManagedLineItem as co, type ManagedDiscount as cp, type TranslatedValue as cq, type LineItemAmount as cr, type ManagedAdditionalFee as cs, type TotalPriceChange as ct, type ShippingInformationChange as cu, type ShippingInformation as cv, type PricesRecalculatedForDestination as cw, type SavedPaymentMethod as cx, type AuthorizedPaymentCreated as cy, type AuthorizedPaymentCaptured as cz, type PreparePaymentCollectionOptions as d, type EntityUpdatedEvent as d$, type CreatedByStringOneOf as d0, type ChannelInfo as d1, type CustomField as d2, type BalanceSummary as d3, type Balance as d4, type CashRounding as d5, type AdditionalFee as d6, type FulfillmentStatusesAggregate as d7, type Tags as d8, type TagList as d9, type V1RestockItem as dA, type OrderImported as dB, type ImportedOrderDeleted as dC, type PaymentStatusUpdated as dD, type FulfillmentStatusUpdated as dE, type OrderCanceledEventOrderCanceled as dF, type OrderDeltasCommitted as dG, type CommittedDiffs as dH, type CommittedDiffsShippingUpdateInfoOneOf as dI, type ItemChangedDetails as dJ, type OrderLineItemChangedDetails as dK, type DecimalQuantityUpdate as dL, type CrossBorderAdjustmentUpdate as dM, type LineItemDelta as dN, type LineItemDeltaDeltaOneOf as dO, type AppliedDiscountDelta as dP, type AppliedDiscountDeltaDeltaOneOf as dQ, type AdditionalFeeDelta as dR, type AdditionalFeeDeltaDeltaOneOf as dS, type DraftOrderCommitSettings as dT, type InventoryUpdateDetails as dU, type TriggerReindexRequest as dV, type TriggerReindexResponse as dW, type DomainEvent as dX, type DomainEventBodyOneOf as dY, type EntityCreatedEvent as dZ, type RestoreInfo as d_, type Location as da, type OrderSettings as db, type OrderSettingsAllowedActionsOneOf as dc, type OrderSettingsEditableByOneOf as dd, type CustomAllowedActions as de, type OwnerApps as df, type FormInfo as dg, type FormIdentifier as dh, type PlatformFeeSummary as di, type PlatformFee as dj, type UpdateInternalDocumentsEvent as dk, type UpdateInternalDocumentsEventOperationOneOf as dl, type InternalDocument as dm, type InternalDocumentUpdateOperation as dn, type DeleteByIdsOperation as dp, type DeleteByFilterOperation as dq, type InternalDocumentUpdateByFilterOperation as dr, type InternalUpdateExistingOperation as ds, type VersionedDocumentUpdateOperation as dt, type VersionedDeleteByIdsOperation as du, type VersionedDocumentId as dv, type OrderApproved as dw, type OrdersExperiments as dx, type OrderRejectedEventOrderRejected as dy, type OrderItemsRestocked as dz, type PreparePaymentCollectionResponse as e, type AuthorizationActionFailureDetails as e$, type EntityDeletedEvent as e0, type ActionEvent as e1, type Empty as e2, type TriggerReindexOrderRequest as e3, type MessageEnvelope as e4, type IdentificationData as e5, type IdentificationDataIdOneOf as e6, type AccountInfo as e7, type ImportOrderRequest as e8, type SetOrderNumberCounterRequest as e9, type ChargedBy as eA, type CreatePaymentGatewayOrderResponse as eB, type ChargeMembershipsRequest as eC, type MembershipChargeItem as eD, type MembershipName as eE, type ChargeMembershipsResponse as eF, type TriggerRefundRequest as eG, type PaymentRefund as eH, type RefundDetails as eI, type RefundItem as eJ, type LineItemRefund as eK, type AdditionalFeeRefund as eL, type ShippingRefund as eM, type RefundSideEffects as eN, type RestockInfo as eO, type RestockItem as eP, type TriggerRefundResponse as eQ, type OrderTransactions as eR, type Payment as eS, type PaymentPaymentDetailsOneOf as eT, type PaymentReceiptInfoOneOf as eU, type PaymentStatusDetailsOneOf as eV, type RegularPaymentDetails as eW, type RegularPaymentDetailsPaymentMethodDetailsOneOf as eX, type CreditCardPaymentMethodDetails as eY, type AuthorizationDetails as eZ, type AuthorizationCapture as e_, type BulkDeleteImportedOrdersRequest as ea, type V1TriggerReindexRequest as eb, type V1TriggerReindexResponse as ec, type V1TriggerReindexOrderRequest as ed, type PreparePaymentCollectionRequest as ee, type RedirectUrls as ef, type DelayedCaptureSettings as eg, type Duration as eh, type GetPaymentCollectabilityStatusRequest as ei, type RecordManuallyCollectedPaymentRequest as ej, type UserDefinedPaymentMethodName as ek, type UserDefinedPaymentMethodNameKindOneOf as el, type RecordManuallyCollectedPaymentResponse as em, type MarkOrderAsPaidRequest as en, type MarkOrderAsPaidResponse as eo, type BulkMarkOrdersAsPaidRequest as ep, type BulkMarkOrdersAsPaidResponse as eq, type BulkOrderResult as er, type ItemMetadata as es, type ApplicationError as et, type BulkActionMetadata as eu, type GetRefundabilityStatusRequest as ev, type GetRefundabilityStatusResponse as ew, type Refundability as ex, type RefundabilityAdditionalRefundabilityInfoOneOf as ey, type CreatePaymentGatewayOrderRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type PreviewBuyerPickupConfirmationEmailRequest as f$, type AuthorizationVoid as f0, type V1ScheduledAction as f1, type Chargeback as f2, type PaymentMethodName as f3, type GiftCardPaymentDetails as f4, type MembershipPaymentDetails as f5, type FutureMembershipDetails as f6, type WixReceiptInfo as f7, type ExternalReceiptInfo as f8, type CashRoundingDetails as f9, type BulkSendBuyerPickupConfirmationEmailsResponse as fA, type SendBuyerShippingConfirmationEmailRequest as fB, type SendBuyerShippingConfirmationEmailResponse as fC, type BulkSendBuyerShippingConfirmationEmailsRequest as fD, type BulkSendBuyerShippingConfirmationEmailsResponse as fE, type SendMerchantOrderReceivedNotificationRequest as fF, type SendMerchantOrderReceivedNotificationResponse as fG, type SendCancelRefundEmailRequest as fH, type SendCancelRefundEmailResponse as fI, type SendRefundEmailRequest as fJ, type SendRefundEmailResponse as fK, type SendFulfillmentEmailRequest as fL, type SendFulfillmentEmailResponse as fM, type SendMerchantOrderReceivedPushRequest as fN, type SendMerchantOrderReceivedPushResponse as fO, type PreviewEmailByTypeRequest as fP, type PreviewEmailByTypeResponse as fQ, type PreviewRefundEmailRequest as fR, type PreviewRefundEmailResponse as fS, type PreviewCancelEmailRequest as fT, type PreviewCancelEmailResponse as fU, type PreviewCancelRefundEmailRequest as fV, type PreviewCancelRefundEmailResponse as fW, type PreviewBuyerPaymentsReceivedEmailRequest as fX, type PreviewBuyerPaymentsReceivedEmailResponse as fY, type PreviewBuyerConfirmationEmailRequest as fZ, type PreviewBuyerConfirmationEmailResponse as f_, type CanceledStatusDetails as fa, type DeclinedStatusDetails as fb, type VoidedStatusDetails as fc, type PaymentStatusDetails as fd, type PaymentStatusDetailsStatusDetailsOneOf as fe, type Refund as ff, type RefundTransaction as fg, type RefundStatusInfo as fh, type AggregatedRefundSummary as fi, type RefundItemsBreakdown as fj, type LineItemRefundSummary as fk, type CalculateRefundRequest as fl, type CalculateRefundItemRequest as fm, type CalculateRefundResponse as fn, type CalculateRefundItemResponse as fo, type VoidAuthorizedPaymentsRequest as fp, type CaptureAuthorizedPaymentsRequest as fq, type ChargeSavedPaymentMethodRequest as fr, type ChargeSavedPaymentMethodResponse as fs, type SendBuyerConfirmationEmailRequest as ft, type SendBuyerConfirmationEmailResponse as fu, type SendBuyerPaymentsReceivedEmailRequest as fv, type SendBuyerPaymentsReceivedEmailResponse as fw, type SendBuyerPickupConfirmationEmailRequest as fx, type SendBuyerPickupConfirmationEmailResponse as fy, type BulkSendBuyerPickupConfirmationEmailsRequest as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type CreateOrderRequest as g$, type PreviewBuyerPickupConfirmationEmailResponse as g0, type PreviewShippingConfirmationEmailRequest as g1, type PreviewShippingConfirmationEmailResponse as g2, type PreviewResendDownloadLinksEmailRequest as g3, type PreviewResendDownloadLinksEmailResponse as g4, type MetaSiteSpecialEvent as g5, type MetaSiteSpecialEventPayloadOneOf as g6, type Asset as g7, type SiteCreated as g8, type SiteTransferred as g9, type EditorlessAssigned as gA, type EditorlessUnassigned as gB, type HasCustomEmailConfigurationsRequest as gC, type HasCustomEmailConfigurationsResponse as gD, type AddToAutomationMigrationPopulationRequest as gE, type AddToAutomationMigrationPopulationResponse as gF, type IsInAutomationMigrationPopulationRequest as gG, type IsInAutomationMigrationPopulationResponse as gH, type DiffmatokyPayload as gI, type ErrorInformation as gJ, type GetOrderRequest as gK, type GetOrderResponse as gL, type InternalQueryOrdersRequest as gM, type PlatformQuery as gN, type PlatformQueryPagingMethodOneOf as gO, type Sorting as gP, type PlatformPaging as gQ, type CursorPaging as gR, type InternalQueryOrdersResponse as gS, type PlatformPagingMetadata as gT, type Cursors as gU, type QueryOrderRequest as gV, type QueryOrderResponse as gW, type SearchOrdersRequest as gX, type CursorSearch as gY, type CursorSearchPagingMethodOneOf as gZ, type CursorPagingMetadata as g_, type SiteDeleted as ga, type DeleteContext as gb, type SiteUndeleted as gc, type SitePublished as gd, type SiteUnpublished as ge, type SiteMarkedAsTemplate as gf, type SiteMarkedAsWixSite as gg, type ServiceProvisioned as gh, type ServiceRemoved as gi, type SiteRenamed as gj, type SiteHardDeleted as gk, type NamespaceChanged as gl, type StudioAssigned as gm, type StudioUnassigned as gn, type SiteUrlChanged as go, type SitePurgedExternally as gp, type OdeditorAssigned as gq, type OdeditorUnassigned as gr, type PicassoAssigned as gs, type PicassoUnassigned as gt, type WixelAssigned as gu, type WixelUnassigned as gv, type StudioTwoAssigned as gw, type StudioTwoUnassigned as gx, type UserDomainMediaEnabled as gy, type UserDomainMediaDisabled as gz, type PaymentCapture as h, type OrderRejected as h$, type OrderCreationSettings as h0, type OrderCreationSettingsEditableByOneOf as h1, type OrderCreateNotifications as h2, type CreateOrderResponse as h3, type UpdateOrderRequest as h4, type UpdateOrderResponse as h5, type BulkUpdateOrdersRequest as h6, type CommitDeltasRequest as h7, type DraftOrderDiffs as h8, type DraftOrderDiffsShippingUpdateInfoOneOf as h9, type UpdateBillingContactDetailsResponse as hA, type UpdateOrderLineItemRequest as hB, type UpdateOrderLineItemResponse as hC, type UpdateOrderLineItemsRequest as hD, type MaskedOrderLineItem as hE, type UpdateOrderLineItemsResponse as hF, type AddInternalActivityRequest as hG, type InternalActivity as hH, type InternalActivityContentOneOf as hI, type OrderPlaced as hJ, type OrderPaid as hK, type OrderFulfilled as hL, type OrderNotFulfilled as hM, type OrderCanceled as hN, type DownloadLinkSent as hO, type TrackingNumberAdded as hP, type TrackingNumberEdited as hQ, type TrackingLinkAdded as hR, type ShippingConfirmationEmailSent as hS, type InvoiceAdded as hT, type InvoiceSent as hU, type FulfillerEmailSent as hV, type ShippingAddressEdited as hW, type EmailEdited as hX, type PickupReadyEmailSent as hY, type OrderPartiallyPaid as hZ, type OrderPending as h_, type DraftOrderDiffsBuyerUpdateInfoOneOf as ha, type DraftOrderDiffsBillingUpdateInfoOneOf as hb, type DraftOrderDiffsRecipientUpdateInfoOneOf as hc, type V1LineItemDelta as hd, type V1LineItemDeltaDeltaOneOf as he, type CommitDeltasResponse as hf, type ArchiveOrderRequest as hg, type ArchiveOrderResponse as hh, type BulkArchiveOrdersRequest as hi, type BulkArchiveOrdersResponse as hj, type BulkArchiveOrdersByFilterRequest as hk, type BulkArchiveOrdersByFilterResponse as hl, type UnArchiveOrderRequest as hm, type UnArchiveOrderResponse as hn, type BulkUnArchiveOrdersRequest as ho, type BulkUnArchiveOrdersResponse as hp, type BulkUnArchiveOrdersByFilterRequest as hq, type BulkUnArchiveOrdersByFilterResponse as hr, type UpdateBuyerInfoRequest as hs, type BuyerInfoUpdate as ht, type UpdateBuyerInfoResponse as hu, type UpdateBuyerEmailRequest as hv, type UpdateBuyerEmailResponse as hw, type UpdateOrderShippingAddressRequest as hx, type UpdateOrderShippingAddressResponse as hy, type UpdateBillingContactDetailsRequest as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type InvoiceFields as i$, type AddInternalActivityResponse as i0, type AddActivityRequest as i1, type PublicActivity as i2, type PublicActivityContentOneOf as i3, type AddActivityResponse as i4, type AddActivitiesRequest as i5, type UpdateActivityRequest as i6, type UpdateActivityResponse as i7, type DeleteActivityRequest as i8, type DeleteActivityResponse as i9, type V1MarkOrderAsPaidResponse as iA, type V1BulkMarkOrdersAsPaidRequest as iB, type V1BulkMarkOrdersAsPaidResponse as iC, type V1CreatePaymentGatewayOrderRequest as iD, type V1CreatePaymentGatewayOrderResponse as iE, type GetShipmentsRequest as iF, type GetShipmentsResponse as iG, type AggregateOrdersRequest as iH, type AggregateOrdersResponse as iI, type DecrementItemsQuantityRequest as iJ, type DecrementData as iK, type DecrementItemsQuantityResponse as iL, type BulkUpdateOrderTagsRequest as iM, type TagsTags as iN, type TagsTagList as iO, type BulkUpdateOrderTagsResult as iP, type SendOrderUpdatedDomainEventRequest as iQ, type SendOrderUpdatedDomainEventResponse as iR, type Task as iS, type TaskKey as iT, type TaskAction as iU, type TaskActionActionOneOf as iV, type Complete as iW, type Cancel as iX, type Reschedule as iY, type InvoiceSentEvent as iZ, type IdAndVersion as i_, type UpdateLineItemsDescriptionLinesRequest as ia, type LineItemUpdate as ib, type UpdateLineItemsDescriptionLinesResponse as ic, type MarkOrderAsSeenByHumanRequest as id, type MarkOrderAsSeenByHumanResponse as ie, type CancelOrderRequest as ig, type UpdateOrderStatusRequest as ih, type UpdateOrderStatusResponse as ii, type MarkAsFulfilledRequest as ij, type MarkAsFulfilledResponse as ik, type BulkMarkAsFulfilledRequest as il, type BulkMarkAsFulfilledResponse as im, type BulkMarkAsFulfilledByFilterRequest as io, type BulkMarkAsFulfilledByFilterResponse as ip, type MarkAsUnfulfilledRequest as iq, type MarkAsUnfulfilledResponse as ir, type BulkMarkAsUnfulfilledRequest as is, type BulkMarkAsUnfulfilledResponse as it, type BulkMarkAsUnfulfilledByFilterRequest as iu, type BulkMarkAsUnfulfilledByFilterResponse as iv, type BulkSetBusinessLocationRequest as iw, type BulkSetBusinessLocationResponse as ix, type BulkSetBusinessLocationResult as iy, type V1MarkOrderAsPaidRequest as iz, type GetOrderApplicationErrors as j, type PickupMethodWithLiterals as j$, type Customer as j0, type Email as j1, type QuotesAddress as j2, type AddressDescription as j3, type Phone as j4, type Company as j5, type CommonAddress as j6, type CommonAddressStreetOneOf as j7, type Subdivision as j8, type StandardDetails as j9, type PaymentCollectionMarkOrderAsPaidOptions as jA, type PaymentCollectionCreatePaymentGatewayOrderOptions as jB, type ChargeMembershipsOptions as jC, type TriggerRefundOptions as jD, type OrderSearchSpec as jE, type UpdateOrderLineItemIdentifiers as jF, type UpdateOrderLineItem as jG, type UpdateActivityIdentifiers as jH, type DeleteActivityIdentifiers as jI, type AggregateOrdersOptions as jJ, utils as jK, type DescriptionLineTypeWithLiterals as jL, type DimensionsUnitWithLiterals as jM, type ItemTypePresetWithLiterals as jN, type PaymentOptionTypeWithLiterals as jO, type JurisdictionTypeWithLiterals as jP, type SubscriptionFrequencyWithLiterals as jQ, type ProductPeriodAlignmentWithLiterals as jR, type AdjustmentTypeWithLiterals as jS, type TaxableAddressTypeWithLiterals as jT, type MeasurementUnitWithLiterals as jU, type RepriceStatusWithLiterals as jV, type BaseRateSourceWithLiterals as jW, type PaymentStatusEnumPaymentStatusWithLiterals as jX, type FulfillmentStatusWithLiterals as jY, type WeightUnitWithLiterals as jZ, type VatTypeWithLiterals as j_, type ShippingContactDetails as ja, type InvoiceDates as jb, type LineItems as jc, type LineItem as jd, type BigDecimalWrapper as je, type LineItemTax as jf, type Source as jg, type LineItemMetaData as jh, type Locale as ji, type TotalPrice as jj, type ItemizedFee as jk, type Discount as jl, type DiscountOneDiscountTypeOneOf as jm, type CalculatedTaxes as jn, type CalculatedTax as jo, type Payments as jp, type InvoicesPayment as jq, type MetaData as jr, type InvoiceDynamicPriceTotals as js, type CustomFieldValue as jt, type Value as ju, type Deposit as jv, type BaseEventMetadata as jw, type EventMetadata as jx, type AccountInfoMetadata as jy, type RecordManuallyCollectedPaymentOptions as jz, type OrderSearch as k, onOrderCreated as k$, type OrderStatusWithLiterals as k0, type CrossBorderNotApplicableReasonWithLiterals as k1, type CrossBorderRepricingModeWithLiterals as k2, type DiscountTypeWithLiterals as k3, type DiscountValueTypeWithLiterals as k4, type DiscountReasonWithLiterals as k5, type LineItemQuantityChangeTypeWithLiterals as k6, type ActivityTypeWithLiterals as k7, type OrderActivityTypeEnumActivityTypeWithLiterals as k8, type AttributionSourceWithLiterals as k9, type DeclinedReasonWithLiterals as kA, type VoidedReasonWithLiterals as kB, type RefundStatusWithLiterals as kC, type PreviewEmailTypeWithLiterals as kD, type StateWithLiterals as kE, type SiteCreatedContextWithLiterals as kF, type NamespaceWithLiterals as kG, type DeleteStatusWithLiterals as kH, type OriginWithLiterals as kI, type SortOrderWithLiterals as kJ, type OrderApprovalStrategyWithLiterals as kK, type PlacementWithLiterals as kL, type SubdivisionTypeWithLiterals as kM, type SourceTypeWithLiterals as kN, type CustomFieldGroupWithLiterals as kO, type ValueTypeWithLiterals as kP, type DepositTypeWithLiterals as kQ, type InvoiceStatusWithLiterals as kR, type RecordManuallyCollectedPaymentApplicationErrors as kS, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kT, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kU, type TriggerRefundApplicationErrors as kV, type UpdateOrderStatusApplicationErrors as kW, type CommonSearchWithEntityContext as kX, onOrderApproved as kY, onOrderCanceled as kZ, onOrderCommitted as k_, type ChannelTypeWithLiterals as ka, type AdditionalFeeSourceWithLiterals as kb, type OrderActionTypeWithLiterals as kc, type SpecificItemsCouponBehaviorWithLiterals as kd, type ChargeTypeWithLiterals as ke, type VersioningModeWithLiterals as kf, type DeltaPaymentOptionTypeWithLiterals as kg, type InventoryActionWithLiterals as kh, type WebhookIdentityTypeWithLiterals as ki, type ScheduledActionWithLiterals as kj, type DurationUnitWithLiterals as kk, type PaymentCollectabilityStatusWithLiterals as kl, type PredefinedPaymentMethodWithLiterals as km, type RefundableStatusWithLiterals as kn, type NonRefundableReasonWithLiterals as ko, type ManuallyRefundableReasonWithLiterals as kp, type RestockTypeWithLiterals as kq, type TransactionStatusWithLiterals as kr, type AuthorizationCaptureStatusWithLiterals as ks, type AuthorizationVoidStatusWithLiterals as kt, type ReasonWithLiterals as ku, type ActionTypeWithLiterals as kv, type ChargebackStatusWithLiterals as kw, type MembershipPaymentStatusWithLiterals as kx, type PaymentStatusWithLiterals as ky, type CanceledReasonWithLiterals as kz, type SearchOrdersResponse 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, voidAuthorizedPayments as la, captureAuthorizedPayments as lb, getOrder as lc, createOrder as ld, updateOrder as le, bulkUpdateOrders as lf, addActivities as lg, cancelOrder as lh, bulkUpdateOrderTags as li, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };