@wix/auto_sdk_ecom_orders 1.0.60 → 1.0.61

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 (33) hide show
  1. package/build/{internal/cjs/ecom-v1-order-orders.universal-Dg-mwHfT.d.ts → cjs/ecom-v1-order-orders.universal-edSkdncQ.d.ts} +531 -393
  2. package/build/cjs/index.d.ts +23 -9
  3. package/build/cjs/index.js +1 -0
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +31 -0
  6. package/build/cjs/index.typings.js +3078 -0
  7. package/build/cjs/index.typings.js.map +1 -0
  8. package/build/cjs/meta.d.ts +1 -1
  9. package/build/{internal/es/ecom-v1-order-orders.universal-Dg-mwHfT.d.mts → es/ecom-v1-order-orders.universal-edSkdncQ.d.mts} +531 -393
  10. package/build/es/index.d.mts +23 -9
  11. package/build/es/index.mjs +1 -0
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +31 -0
  14. package/build/es/index.typings.mjs +2979 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/es/meta.d.mts +1 -1
  17. package/build/{cjs/ecom-v1-order-orders.universal-C65mdJbP.d.ts → internal/cjs/ecom-v1-order-orders.universal-DeNyUgsJ.d.ts} +1211 -2
  18. package/build/internal/cjs/index.d.ts +41 -15
  19. package/build/internal/cjs/index.js +1 -0
  20. package/build/internal/cjs/index.js.map +1 -1
  21. package/build/internal/cjs/index.typings.d.ts +31 -0
  22. package/build/internal/cjs/index.typings.js +3078 -0
  23. package/build/internal/cjs/index.typings.js.map +1 -0
  24. package/build/internal/cjs/meta.d.ts +1 -1
  25. package/build/{es/ecom-v1-order-orders.universal-C65mdJbP.d.mts → internal/es/ecom-v1-order-orders.universal-DeNyUgsJ.d.mts} +1211 -2
  26. package/build/internal/es/index.d.mts +41 -15
  27. package/build/internal/es/index.mjs +1 -0
  28. package/build/internal/es/index.mjs.map +1 -1
  29. package/build/internal/es/index.typings.d.mts +31 -0
  30. package/build/internal/es/index.typings.mjs +2979 -0
  31. package/build/internal/es/index.typings.mjs.map +1 -0
  32. package/build/internal/es/meta.d.mts +1 -1
  33. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { SearchSpec, Search } from '@wix/sdk-types';
1
+ import { SearchSpec, Search, NonNullablePaths } from '@wix/sdk-types';
2
2
 
3
3
  interface Order {
4
4
  /**
@@ -283,12 +283,25 @@ interface OrderLineItem {
283
283
  locations?: LocationAndQuantity[];
284
284
  /** Address used for tax calculation. */
285
285
  taxableAddress?: TaxableAddress;
286
+ /**
287
+ * ID of the app managing the inventory.
288
+ * @internal
289
+ * @format GUID
290
+ */
291
+ inventoryAppId?: string | null;
286
292
  /**
287
293
  * Custom extended fields for the line item object.
288
294
  *
289
295
  * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
290
296
  */
291
297
  extendedFields?: ExtendedFields;
298
+ /**
299
+ * Modifier groups that were added to the item.
300
+ * @internal
301
+ * @readonly
302
+ * @maxSize 10
303
+ */
304
+ modifierGroups?: ModifierGroup[];
292
305
  }
293
306
  interface ProductName {
294
307
  /**
@@ -359,6 +372,11 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
359
372
  colorInfo?: Color;
360
373
  /** Description line name. */
361
374
  name?: DescriptionLineName;
375
+ /**
376
+ * Whether the description line originates from a modifier.
377
+ * @internal
378
+ */
379
+ modifierDescriptionLine?: boolean;
362
380
  }
363
381
  /** @oneof */
364
382
  interface DescriptionLineValueOneOf {
@@ -422,6 +440,8 @@ declare enum DescriptionLineType {
422
440
  /** Color type. */
423
441
  COLOR = "COLOR"
424
442
  }
443
+ /** @enumType */
444
+ type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
425
445
  interface FocalPoint {
426
446
  /** X-coordinate of the focal point. */
427
447
  x?: number;
@@ -601,6 +621,11 @@ interface SubscriptionInfo {
601
621
  * @targetRemovalDate 2025-10-01
602
622
  */
603
623
  subscriptionOptionTitle?: string;
624
+ /**
625
+ * Subscription title. For example, `"Monthly coffee Subscription"`.
626
+ * @internal
627
+ */
628
+ title?: SubscriptionTitle;
604
629
  /**
605
630
  * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
606
631
  * @maxLength 60
@@ -609,6 +634,11 @@ interface SubscriptionInfo {
609
634
  * @targetRemovalDate 2025-10-01
610
635
  */
611
636
  subscriptionOptionDescription?: string | null;
637
+ /**
638
+ * Subscription description. For example, `"1kg of selected coffee, once a month"`.
639
+ * @internal
640
+ */
641
+ description?: SubscriptionDescription;
612
642
  /**
613
643
  * Subscription detailed information.
614
644
  * @immutable
@@ -619,6 +649,11 @@ interface SubscriptionInfo {
619
649
  * @maxLength 1000
620
650
  */
621
651
  chargesDescription?: string | null;
652
+ /**
653
+ * Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
654
+ * @internal
655
+ */
656
+ billingAdjustment?: BillingAdjustment;
622
657
  }
623
658
  interface SubscriptionTitle {
624
659
  /**
@@ -668,6 +703,11 @@ interface SubscriptionSettings {
668
703
  enableCustomerCancellation?: boolean;
669
704
  /** Period until first cycle starts. If None => no free trial */
670
705
  freeTrialPeriod?: FreeTrialPeriod;
706
+ /**
707
+ * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
708
+ * @internal
709
+ */
710
+ startDate?: Date | null;
671
711
  }
672
712
  /** Frequency unit of recurring payment */
673
713
  declare enum SubscriptionFrequency {
@@ -1344,6 +1384,14 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1344
1384
  * @immutable
1345
1385
  */
1346
1386
  _id?: string | null;
1387
+ /**
1388
+ * Number of subscription billing cycles the discount applies to.
1389
+ * If None and discount is linked to subscription line item, it applies to all cycles.
1390
+ * @internal
1391
+ * @min 1
1392
+ * @max 999
1393
+ */
1394
+ subscriptionCycles?: number | null;
1347
1395
  }
1348
1396
  /** @oneof */
1349
1397
  interface AppliedDiscountDiscountSourceOneOf {
@@ -1385,6 +1433,13 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1385
1433
  description?: string | null;
1386
1434
  /** Discount amount. */
1387
1435
  amount?: Price;
1436
+ /**
1437
+ * Discount percentage.
1438
+ * @internal
1439
+ * @format DECIMAL_VALUE
1440
+ * @decimalValue options { gte:0, lte:100, maxScale:2 }
1441
+ */
1442
+ percentage?: string | null;
1388
1443
  }
1389
1444
  /** @oneof */
1390
1445
  interface MerchantDiscountMerchantDiscountReasonOneOf {
@@ -1447,6 +1502,70 @@ interface Activity extends ActivityContentOneOf {
1447
1502
  merchantComment?: MerchantComment;
1448
1503
  /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
1449
1504
  orderRefunded?: OrderRefunded;
1505
+ /**
1506
+ * Details of an initiated refund process.
1507
+ *
1508
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1509
+ * > In these cases, the `refund_id` will be identical across the activities.
1510
+ * @internal
1511
+ */
1512
+ refundInitiated?: RefundInitiated;
1513
+ /**
1514
+ * Details of a refunded payment.
1515
+ *
1516
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1517
+ * > In these cases, the `refund_id` will be identical across the activities.
1518
+ * @internal
1519
+ */
1520
+ paymentRefunded?: PaymentRefunded;
1521
+ /**
1522
+ * Details of a failed payment refund.
1523
+ *
1524
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1525
+ * > In these cases, the `refund_id` will be identical across the activities.
1526
+ * @internal
1527
+ */
1528
+ paymentRefundFailed?: PaymentRefundFailed;
1529
+ /**
1530
+ * Details of refund to store credit.
1531
+ * @internal
1532
+ */
1533
+ refundedAsStoreCredit?: RefundedAsStoreCredit;
1534
+ /**
1535
+ * Details of a pending payment
1536
+ * @internal
1537
+ */
1538
+ paymentPending?: PaymentPending;
1539
+ /**
1540
+ * Details of a canceled payment
1541
+ * @internal
1542
+ */
1543
+ paymentCanceled?: PaymentCanceled;
1544
+ /**
1545
+ * Details of a declined payment
1546
+ * @internal
1547
+ */
1548
+ paymentDeclined?: PaymentDeclined;
1549
+ /**
1550
+ * Receipt was added for associated payment
1551
+ * @internal
1552
+ */
1553
+ receiptCreated?: ReceiptCreated;
1554
+ /**
1555
+ * Receipt sent to customer
1556
+ * @internal
1557
+ */
1558
+ receiptSent?: ReceiptSent;
1559
+ /**
1560
+ * Order received a chargeback for one of its' payments.
1561
+ * @internal
1562
+ */
1563
+ chargebackCreated?: ChargebackCreated;
1564
+ /**
1565
+ * Chargeback reversed for one of the order's payments.
1566
+ * @internal
1567
+ */
1568
+ chargebackReversed?: ChargebackReversed;
1450
1569
  /**
1451
1570
  * Activity ID.
1452
1571
  * @format GUID
@@ -1475,6 +1594,70 @@ interface ActivityContentOneOf {
1475
1594
  merchantComment?: MerchantComment;
1476
1595
  /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
1477
1596
  orderRefunded?: OrderRefunded;
1597
+ /**
1598
+ * Details of an initiated refund process.
1599
+ *
1600
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1601
+ * > In these cases, the `refund_id` will be identical across the activities.
1602
+ * @internal
1603
+ */
1604
+ refundInitiated?: RefundInitiated;
1605
+ /**
1606
+ * Details of a refunded payment.
1607
+ *
1608
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1609
+ * > In these cases, the `refund_id` will be identical across the activities.
1610
+ * @internal
1611
+ */
1612
+ paymentRefunded?: PaymentRefunded;
1613
+ /**
1614
+ * Details of a failed payment refund.
1615
+ *
1616
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
1617
+ * > In these cases, the `refund_id` will be identical across the activities.
1618
+ * @internal
1619
+ */
1620
+ paymentRefundFailed?: PaymentRefundFailed;
1621
+ /**
1622
+ * Details of refund to store credit.
1623
+ * @internal
1624
+ */
1625
+ refundedAsStoreCredit?: RefundedAsStoreCredit;
1626
+ /**
1627
+ * Details of a pending payment
1628
+ * @internal
1629
+ */
1630
+ paymentPending?: PaymentPending;
1631
+ /**
1632
+ * Details of a canceled payment
1633
+ * @internal
1634
+ */
1635
+ paymentCanceled?: PaymentCanceled;
1636
+ /**
1637
+ * Details of a declined payment
1638
+ * @internal
1639
+ */
1640
+ paymentDeclined?: PaymentDeclined;
1641
+ /**
1642
+ * Receipt was added for associated payment
1643
+ * @internal
1644
+ */
1645
+ receiptCreated?: ReceiptCreated;
1646
+ /**
1647
+ * Receipt sent to customer
1648
+ * @internal
1649
+ */
1650
+ receiptSent?: ReceiptSent;
1651
+ /**
1652
+ * Order received a chargeback for one of its' payments.
1653
+ * @internal
1654
+ */
1655
+ chargebackCreated?: ChargebackCreated;
1656
+ /**
1657
+ * Chargeback reversed for one of the order's payments.
1658
+ * @internal
1659
+ */
1660
+ chargebackReversed?: ChargebackReversed;
1478
1661
  }
1479
1662
  interface CustomActivity {
1480
1663
  /**
@@ -2192,11 +2375,29 @@ interface BalanceSummary {
2192
2375
  * @readonly
2193
2376
  */
2194
2377
  authorized?: Price;
2378
+ /**
2379
+ * Sum of all pending refund transactions.
2380
+ * @internal
2381
+ * @readonly
2382
+ */
2383
+ pendingRefund?: Price;
2195
2384
  /**
2196
2385
  * Sum of all pending transactions.
2197
2386
  * @readonly
2198
2387
  */
2199
2388
  pending?: Price;
2389
+ /**
2390
+ * Sum of all transaction chargebacks.
2391
+ * @internal
2392
+ * @readonly
2393
+ */
2394
+ chargeback?: Price;
2395
+ /**
2396
+ * Sum of all chargeback reversals.
2397
+ * @internal
2398
+ * @readonly
2399
+ */
2400
+ chargebackReversal?: Price;
2200
2401
  }
2201
2402
  /**
2202
2403
  * Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
@@ -2258,6 +2459,14 @@ interface AdditionalFee {
2258
2459
  * @format GUID
2259
2460
  */
2260
2461
  lineItemIds?: string[];
2462
+ /**
2463
+ * Number of subscription billing cycles the additional fee applies to.
2464
+ * If None and additional fee is linked to subscription line item, it applies to all cycles.
2465
+ * @internal
2466
+ * @min 1
2467
+ * @max 999
2468
+ */
2469
+ subscriptionCycles?: number | null;
2261
2470
  }
2262
2471
  interface FulfillmentStatusesAggregate {
2263
2472
  /** Unique string values based on Fulfillment entities statuses */
@@ -2374,6 +2583,17 @@ interface PreparePaymentCollectionRequest {
2374
2583
  * @targetRemovalDate 2024-09-30
2375
2584
  */
2376
2585
  delayedCapture?: boolean;
2586
+ /**
2587
+ * Specifies whether payment collection is initiated by Merchant or User of User
2588
+ * Default: `true`
2589
+ * @internal
2590
+ */
2591
+ merchantInitiated?: boolean | null;
2592
+ /**
2593
+ * Redirect urls which are used to return buyer to third party system.
2594
+ * @internal
2595
+ */
2596
+ redirectUrls?: RedirectUrls;
2377
2597
  /** Delayed capture payment settings */
2378
2598
  delayedCaptureSettings?: DelayedCaptureSettings;
2379
2599
  }
@@ -2899,6 +3119,16 @@ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
2899
3119
  regularPaymentDetails?: RegularPaymentDetails;
2900
3120
  /** Gift card payment details. */
2901
3121
  giftcardPaymentDetails?: GiftCardPaymentDetails;
3122
+ /**
3123
+ * Receipt created by Wix
3124
+ * @internal
3125
+ */
3126
+ wixReceipt?: WixReceiptInfo;
3127
+ /**
3128
+ * Receipt created by an external system.
3129
+ * @internal
3130
+ */
3131
+ externalReceipt?: ExternalReceiptInfo;
2902
3132
  /**
2903
3133
  * Payment ID.
2904
3134
  * @format GUID
@@ -2920,6 +3150,14 @@ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
2920
3150
  * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
2921
3151
  */
2922
3152
  refundDisabled?: boolean;
3153
+ /**
3154
+ * Whether receipt generation for this payment are allowed.
3155
+ * + `true`: This payment supports receipt generation.
3156
+ * + `false`: This payment not supports receipt generation, or receipt already generated
3157
+ * @internal
3158
+ * @readonly
3159
+ */
3160
+ supportReceiptGeneration?: boolean;
2923
3161
  }
2924
3162
  /** @oneof */
2925
3163
  interface PaymentPaymentDetailsOneOf {
@@ -2930,6 +3168,16 @@ interface PaymentPaymentDetailsOneOf {
2930
3168
  }
2931
3169
  /** @oneof */
2932
3170
  interface PaymentReceiptInfoOneOf {
3171
+ /**
3172
+ * Receipt created by Wix
3173
+ * @internal
3174
+ */
3175
+ wixReceipt?: WixReceiptInfo;
3176
+ /**
3177
+ * Receipt created by an external system.
3178
+ * @internal
3179
+ */
3180
+ externalReceipt?: ExternalReceiptInfo;
2933
3181
  }
2934
3182
  interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
2935
3183
  /** Whether regular card used */
@@ -2967,6 +3215,12 @@ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetail
2967
3215
  savedPaymentMethod?: boolean;
2968
3216
  /** Authorization details. */
2969
3217
  authorizationDetails?: AuthorizationDetails;
3218
+ /**
3219
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
3220
+ * @internal
3221
+ * @maxLength 300
3222
+ */
3223
+ paymentProvider?: string | null;
2970
3224
  }
2971
3225
  /** @oneof */
2972
3226
  interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
@@ -3113,6 +3367,13 @@ interface GiftCardPaymentDetails {
3113
3367
  * @readonly
3114
3368
  */
3115
3369
  voided?: boolean;
3370
+ /**
3371
+ * Gift card obfuscated code.
3372
+ * @internal
3373
+ * @maxLength 30
3374
+ * @immutable
3375
+ */
3376
+ obfuscatedCode?: string | null;
3116
3377
  }
3117
3378
  interface MembershipPaymentDetails {
3118
3379
  /**
@@ -4550,6 +4811,40 @@ interface BatchOfTriggerReindexOrderRequest {
4550
4811
  /** @maxSize 25 */
4551
4812
  requests?: TriggerReindexOrderRequest[];
4552
4813
  }
4814
+ interface ChargebackCreated {
4815
+ /**
4816
+ * ID of the payment that received a chargeback.
4817
+ * @format GUID
4818
+ */
4819
+ paymentId?: string;
4820
+ /**
4821
+ * Chargeback ID.
4822
+ * @format GUID
4823
+ */
4824
+ chargebackId?: string;
4825
+ /** Chargeback amount. */
4826
+ amount?: Price;
4827
+ /** Payment details. */
4828
+ paymentDetails?: RegularPayment;
4829
+ }
4830
+ interface ChargebackReversed {
4831
+ /**
4832
+ * ID of the payment involved with the chargeback.
4833
+ * @format GUID
4834
+ */
4835
+ paymentId?: string;
4836
+ /**
4837
+ * Chargeback ID.
4838
+ * @format GUID
4839
+ */
4840
+ chargebackId?: string;
4841
+ /** Chargeback amount. */
4842
+ amount?: Price;
4843
+ /** Chargeback reversal amount. */
4844
+ reversalAmount?: Price;
4845
+ /** Payment details. */
4846
+ paymentDetails?: RegularPayment;
4847
+ }
4553
4848
  interface DiffmatokyPayload {
4554
4849
  left?: string;
4555
4850
  right?: string;
@@ -4761,6 +5056,36 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
4761
5056
  changedShippingInfo?: V1ShippingInformation;
4762
5057
  /** Remove existing shipping info. */
4763
5058
  shippingInfoRemoved?: boolean;
5059
+ /**
5060
+ * Buyer info and selected buyer option details.
5061
+ * @internal
5062
+ */
5063
+ changedBuyerInfo?: BuyerInfo;
5064
+ /**
5065
+ * Remove existing buyer info.
5066
+ * @internal
5067
+ */
5068
+ buyerInfoRemoved?: boolean;
5069
+ /**
5070
+ * Updated billing info.
5071
+ * @internal
5072
+ */
5073
+ changedBillingInfo?: AddressWithContact;
5074
+ /**
5075
+ * Remove existing billing info.
5076
+ * @internal
5077
+ */
5078
+ billingInfoRemoved?: boolean;
5079
+ /**
5080
+ * Updated recipient info.
5081
+ * @internal
5082
+ */
5083
+ changedRecipientInfo?: AddressWithContact;
5084
+ /**
5085
+ * Remove existing recipient info.
5086
+ * @internal
5087
+ */
5088
+ recipientInfoRemoved?: boolean;
4764
5089
  /**
4765
5090
  * Added/updated/removed order line items.
4766
5091
  * @maxSize 300
@@ -4802,12 +5127,42 @@ interface DraftOrderDiffsShippingUpdateInfoOneOf {
4802
5127
  }
4803
5128
  /** @oneof */
4804
5129
  interface DraftOrderDiffsBuyerUpdateInfoOneOf {
5130
+ /**
5131
+ * Buyer info and selected buyer option details.
5132
+ * @internal
5133
+ */
5134
+ changedBuyerInfo?: BuyerInfo;
5135
+ /**
5136
+ * Remove existing buyer info.
5137
+ * @internal
5138
+ */
5139
+ buyerInfoRemoved?: boolean;
4805
5140
  }
4806
5141
  /** @oneof */
4807
5142
  interface DraftOrderDiffsBillingUpdateInfoOneOf {
5143
+ /**
5144
+ * Updated billing info.
5145
+ * @internal
5146
+ */
5147
+ changedBillingInfo?: AddressWithContact;
5148
+ /**
5149
+ * Remove existing billing info.
5150
+ * @internal
5151
+ */
5152
+ billingInfoRemoved?: boolean;
4808
5153
  }
4809
5154
  /** @oneof */
4810
5155
  interface DraftOrderDiffsRecipientUpdateInfoOneOf {
5156
+ /**
5157
+ * Updated recipient info.
5158
+ * @internal
5159
+ */
5160
+ changedRecipientInfo?: AddressWithContact;
5161
+ /**
5162
+ * Remove existing recipient info.
5163
+ * @internal
5164
+ */
5165
+ recipientInfoRemoved?: boolean;
4811
5166
  }
4812
5167
  interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
4813
5168
  /** The line item was added. */
@@ -4907,8 +5262,21 @@ interface OrderLineItemChangedDetails {
4907
5262
  * @maxSize 5
4908
5263
  */
4909
5264
  locations?: LocationAndQuantity[];
5265
+ /**
5266
+ * ID of the app managing the inventory.
5267
+ * @internal
5268
+ * @format GUID
5269
+ */
5270
+ inventoryAppId?: string | null;
4910
5271
  /** Subscription info. */
4911
5272
  subscriptionInfo?: SubscriptionInfo;
5273
+ /**
5274
+ * Modifier groups that were added to the item.
5275
+ * @internal
5276
+ * @readonly
5277
+ * @maxSize 10
5278
+ */
5279
+ modifierGroups?: ModifierGroup[];
4912
5280
  }
4913
5281
  /** Type of selected payment option for catalog item */
4914
5282
  declare enum DeltaPaymentOptionType {
@@ -5295,6 +5663,35 @@ interface InternalActivity extends InternalActivityContentOneOf {
5295
5663
  draftOrderChangesApplied?: DraftOrderChangesApplied;
5296
5664
  /** Payment method is saved for order */
5297
5665
  savedPaymentMethod?: SavedPaymentMethod;
5666
+ /**
5667
+ * Details of an initiated refund process.
5668
+ *
5669
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5670
+ * > In these cases, the `refund_id` will be identical across the activities.
5671
+ * @internal
5672
+ */
5673
+ refundInitiated?: RefundInitiated;
5674
+ /**
5675
+ * Details of a refunded payment.
5676
+ *
5677
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5678
+ * > In these cases, the `refund_id` will be identical across the activities.
5679
+ * @internal
5680
+ */
5681
+ paymentRefunded?: PaymentRefunded;
5682
+ /**
5683
+ * Details of a failed payment refund.
5684
+ *
5685
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5686
+ * > In these cases, the `refund_id` will be identical across the activities.
5687
+ * @internal
5688
+ */
5689
+ paymentRefundFailed?: PaymentRefundFailed;
5690
+ /**
5691
+ * Details of refund to store credit.
5692
+ * @internal
5693
+ */
5694
+ refundedAsStoreCredit?: RefundedAsStoreCredit;
5298
5695
  /** Details of a pending payment */
5299
5696
  paymentPending?: PaymentPending;
5300
5697
  /** Details of a canceled payment */
@@ -5305,6 +5702,26 @@ interface InternalActivity extends InternalActivityContentOneOf {
5305
5702
  orderPending?: OrderPending;
5306
5703
  /** Order rejected */
5307
5704
  orderRejected?: OrderRejected;
5705
+ /**
5706
+ * Receipt was added for associated payment
5707
+ * @internal
5708
+ */
5709
+ receiptCreated?: ReceiptCreated;
5710
+ /**
5711
+ * Receipt sent to customer
5712
+ * @internal
5713
+ */
5714
+ receiptSent?: ReceiptSent;
5715
+ /**
5716
+ * Chargeback created for one of the order's payments.
5717
+ * @internal
5718
+ */
5719
+ chargebackCreated?: ChargebackCreated;
5720
+ /**
5721
+ * Chargeback reversed for one of the order's payments.
5722
+ * @internal
5723
+ */
5724
+ chargebackReversed?: ChargebackReversed;
5308
5725
  /**
5309
5726
  * Internal activity ID.
5310
5727
  * @format GUID
@@ -5369,6 +5786,35 @@ interface InternalActivityContentOneOf {
5369
5786
  draftOrderChangesApplied?: DraftOrderChangesApplied;
5370
5787
  /** Payment method is saved for order */
5371
5788
  savedPaymentMethod?: SavedPaymentMethod;
5789
+ /**
5790
+ * Details of an initiated refund process.
5791
+ *
5792
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5793
+ * > In these cases, the `refund_id` will be identical across the activities.
5794
+ * @internal
5795
+ */
5796
+ refundInitiated?: RefundInitiated;
5797
+ /**
5798
+ * Details of a refunded payment.
5799
+ *
5800
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5801
+ * > In these cases, the `refund_id` will be identical across the activities.
5802
+ * @internal
5803
+ */
5804
+ paymentRefunded?: PaymentRefunded;
5805
+ /**
5806
+ * Details of a failed payment refund.
5807
+ *
5808
+ * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
5809
+ * > In these cases, the `refund_id` will be identical across the activities.
5810
+ * @internal
5811
+ */
5812
+ paymentRefundFailed?: PaymentRefundFailed;
5813
+ /**
5814
+ * Details of refund to store credit.
5815
+ * @internal
5816
+ */
5817
+ refundedAsStoreCredit?: RefundedAsStoreCredit;
5372
5818
  /** Details of a pending payment */
5373
5819
  paymentPending?: PaymentPending;
5374
5820
  /** Details of a canceled payment */
@@ -5379,6 +5825,26 @@ interface InternalActivityContentOneOf {
5379
5825
  orderPending?: OrderPending;
5380
5826
  /** Order rejected */
5381
5827
  orderRejected?: OrderRejected;
5828
+ /**
5829
+ * Receipt was added for associated payment
5830
+ * @internal
5831
+ */
5832
+ receiptCreated?: ReceiptCreated;
5833
+ /**
5834
+ * Receipt sent to customer
5835
+ * @internal
5836
+ */
5837
+ receiptSent?: ReceiptSent;
5838
+ /**
5839
+ * Chargeback created for one of the order's payments.
5840
+ * @internal
5841
+ */
5842
+ chargebackCreated?: ChargebackCreated;
5843
+ /**
5844
+ * Chargeback reversed for one of the order's payments.
5845
+ * @internal
5846
+ */
5847
+ chargebackReversed?: ChargebackReversed;
5382
5848
  }
5383
5849
  /** Order placed */
5384
5850
  interface OrderPlaced {
@@ -6071,6 +6537,8 @@ declare enum SubdivisionType {
6071
6537
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
6072
6538
  COUNTRY = "COUNTRY"
6073
6539
  }
6540
+ /** @enumType */
6541
+ type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
6074
6542
  /** Subdivision Concordance values */
6075
6543
  interface StandardDetails {
6076
6544
  /**
@@ -6321,6 +6789,175 @@ interface TriggerSideEffectsFromLegacyData {
6321
6789
  orderId?: string;
6322
6790
  ordersExperiments?: OrdersExperiments;
6323
6791
  }
6792
+ type PreparePaymentCollectionApplicationErrors = {
6793
+ code?: 'PAYMENT_METHODS_NOT_FOUND';
6794
+ description?: string;
6795
+ data?: Record<string, any>;
6796
+ } | {
6797
+ code?: 'ORDER_CANCELED';
6798
+ description?: string;
6799
+ data?: Record<string, any>;
6800
+ } | {
6801
+ code?: 'INVALID_AMOUNT';
6802
+ description?: string;
6803
+ data?: Record<string, any>;
6804
+ } | {
6805
+ code?: 'ORDER_ALREADY_PAID';
6806
+ description?: string;
6807
+ data?: Record<string, any>;
6808
+ } | {
6809
+ code?: 'NO_ASSOCIATED_ECOM_ORDER';
6810
+ description?: string;
6811
+ data?: Record<string, any>;
6812
+ };
6813
+ type RecordManuallyCollectedPaymentApplicationErrors = {
6814
+ code?: 'ORDER_ALREADY_PAID';
6815
+ description?: string;
6816
+ data?: Record<string, any>;
6817
+ } | {
6818
+ code?: 'INVALID_AMOUNT';
6819
+ description?: string;
6820
+ data?: Record<string, any>;
6821
+ } | {
6822
+ code?: 'ORDER_CANCELED';
6823
+ description?: string;
6824
+ data?: Record<string, any>;
6825
+ };
6826
+ type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
6827
+ code?: 'ORDER_ALREADY_PAID';
6828
+ description?: string;
6829
+ data?: Record<string, any>;
6830
+ } | {
6831
+ code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
6832
+ description?: string;
6833
+ data?: Record<string, any>;
6834
+ };
6835
+ type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
6836
+ code?: 'ORDER_ALREADY_PAID';
6837
+ description?: string;
6838
+ data?: Record<string, any>;
6839
+ } | {
6840
+ code?: 'ORDER_CANCELED';
6841
+ description?: string;
6842
+ data?: Record<string, any>;
6843
+ };
6844
+ type TriggerRefundApplicationErrors = {
6845
+ code?: 'PAYMENTS_NOT_FOUND';
6846
+ description?: string;
6847
+ data?: Record<string, any>;
6848
+ } | {
6849
+ code?: 'REFUND_NOT_AVAILABLE';
6850
+ description?: string;
6851
+ data?: Record<string, any>;
6852
+ } | {
6853
+ code?: 'INVALID_AMOUNT';
6854
+ description?: string;
6855
+ data?: Record<string, any>;
6856
+ };
6857
+ type VoidAuthorizedPaymentsApplicationErrors = {
6858
+ code?: 'PAYMENT_ALREADY_VOIDED';
6859
+ description?: string;
6860
+ data?: Record<string, any>;
6861
+ } | {
6862
+ code?: 'PAYMENT_ALREADY_CAPTURED';
6863
+ description?: string;
6864
+ data?: Record<string, any>;
6865
+ } | {
6866
+ code?: 'PAYMENT_NOT_AUTHORIZED';
6867
+ description?: string;
6868
+ data?: Record<string, any>;
6869
+ } | {
6870
+ code?: 'PAYMENT_NOT_FOUND';
6871
+ description?: string;
6872
+ data?: Record<string, any>;
6873
+ } | {
6874
+ code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
6875
+ description?: string;
6876
+ data?: Record<string, any>;
6877
+ };
6878
+ type CaptureAuthorizedPaymentsApplicationErrors = {
6879
+ code?: 'INVALID_AMOUNT';
6880
+ description?: string;
6881
+ data?: Record<string, any>;
6882
+ } | {
6883
+ code?: 'NOT_REGULAR_ONLINE_PAYMENT';
6884
+ description?: string;
6885
+ data?: Record<string, any>;
6886
+ } | {
6887
+ code?: 'PAYMENT_ALREADY_VOIDED';
6888
+ description?: string;
6889
+ data?: Record<string, any>;
6890
+ } | {
6891
+ code?: 'PAYMENT_ALREADY_CAPTURED';
6892
+ description?: string;
6893
+ data?: Record<string, any>;
6894
+ } | {
6895
+ code?: 'PAYMENT_NOT_AUTHORIZED';
6896
+ description?: string;
6897
+ data?: Record<string, any>;
6898
+ } | {
6899
+ code?: 'PAYMENT_NOT_FOUND';
6900
+ description?: string;
6901
+ data?: Record<string, any>;
6902
+ } | {
6903
+ code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
6904
+ description?: string;
6905
+ data?: Record<string, any>;
6906
+ } | {
6907
+ code?: 'PAYMENT_HAS_PENDING_CAPTURE';
6908
+ description?: string;
6909
+ data?: Record<string, any>;
6910
+ };
6911
+ type GetOrderApplicationErrors = {
6912
+ code?: 'ORDER_NOT_FOUND';
6913
+ description?: string;
6914
+ data?: Record<string, any>;
6915
+ };
6916
+ type CreateOrderApplicationErrors = {
6917
+ code?: 'PURCHASED_DATE_CANNOT_BE_IN_FUTURE';
6918
+ description?: string;
6919
+ data?: Record<string, any>;
6920
+ };
6921
+ type UpdateOrderApplicationErrors = {
6922
+ code?: 'ORDER_IS_PENDING';
6923
+ description?: string;
6924
+ data?: Record<string, any>;
6925
+ } | {
6926
+ code?: 'ORDER_IS_REJECTED';
6927
+ description?: string;
6928
+ data?: Record<string, any>;
6929
+ };
6930
+ type CommitDeltasApplicationErrors = {
6931
+ code?: 'EMPTY_DELTAS_TO_COMMIT';
6932
+ description?: string;
6933
+ data?: Record<string, any>;
6934
+ };
6935
+ type CancelOrderApplicationErrors = {
6936
+ code?: 'ORDER_HAS_AUTHORIZED_TRANSACTION';
6937
+ description?: string;
6938
+ data?: Record<string, any>;
6939
+ } | {
6940
+ code?: 'ORDER_IS_PENDING';
6941
+ description?: string;
6942
+ data?: Record<string, any>;
6943
+ } | {
6944
+ code?: 'ORDER_IS_REJECTED';
6945
+ description?: string;
6946
+ data?: Record<string, any>;
6947
+ };
6948
+ type UpdateOrderStatusApplicationErrors = {
6949
+ code?: 'STATUS_NOT_SUPPORTED';
6950
+ description?: string;
6951
+ data?: Record<string, any>;
6952
+ } | {
6953
+ code?: 'UNSUPPORTED_TRANSITION';
6954
+ description?: string;
6955
+ data?: Record<string, any>;
6956
+ } | {
6957
+ code?: 'STATUS_ALREADY_SET';
6958
+ description?: string;
6959
+ data?: Record<string, any>;
6960
+ };
6324
6961
  interface BaseEventMetadata {
6325
6962
  /**
6326
6963
  * App instance ID.
@@ -6369,18 +7006,134 @@ interface OrderApprovedEnvelope {
6369
7006
  data: OrderApproved;
6370
7007
  metadata: EventMetadata;
6371
7008
  }
7009
+ /** @permissionScope Manage Stores - all permissions
7010
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7011
+ * @permissionScope Manage Stores
7012
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7013
+ * @permissionScope Read eCommerce - all read permissions
7014
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
7015
+ * @permissionScope Read Orders
7016
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
7017
+ * @permissionScope Read Stores - all read permissions
7018
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
7019
+ * @permissionScope Manage Restaurants - all permissions
7020
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7021
+ * @permissionScope Manage eCommerce - all permissions
7022
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
7023
+ * @permissionScope Manage Orders
7024
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
7025
+ * @permissionId ECOM.READ_ORDERS
7026
+ * @webhook
7027
+ * @eventType wix.ecom.v1.order_approved
7028
+ * @slug approved
7029
+ */
7030
+ declare function onOrderApproved(handler: (event: OrderApprovedEnvelope) => void | Promise<void>): void;
6372
7031
  interface OrderUpdatedEnvelope {
6373
7032
  entity: Order;
6374
7033
  metadata: EventMetadata;
6375
7034
  }
7035
+ /** @permissionScope Manage Stores - all permissions
7036
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7037
+ * @permissionScope Manage Stores
7038
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7039
+ * @permissionScope Read eCommerce - all read permissions
7040
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
7041
+ * @permissionScope Read Orders
7042
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
7043
+ * @permissionScope Read Stores - all read permissions
7044
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
7045
+ * @permissionScope Manage Restaurants - all permissions
7046
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7047
+ * @permissionScope Manage eCommerce - all permissions
7048
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
7049
+ * @permissionScope Manage Orders
7050
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
7051
+ * @permissionId ECOM.READ_ORDERS
7052
+ * @webhook
7053
+ * @eventType wix.ecom.v1.order_updated
7054
+ * @slug updated
7055
+ */
7056
+ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
6376
7057
  interface OrderCanceledEnvelope {
6377
7058
  data: OrderCanceledEventOrderCanceled;
6378
7059
  metadata: EventMetadata;
6379
7060
  }
7061
+ /**
7062
+ * Triggered when an order is canceled.
7063
+ * Learn more about [eCommerce webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
7064
+ * @permissionScope Manage Stores - all permissions
7065
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7066
+ * @permissionScope Manage Stores
7067
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7068
+ * @permissionScope Read eCommerce - all read permissions
7069
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
7070
+ * @permissionScope Read Orders
7071
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
7072
+ * @permissionScope Read Stores - all read permissions
7073
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
7074
+ * @permissionScope Manage Restaurants - all permissions
7075
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7076
+ * @permissionScope Manage eCommerce - all permissions
7077
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
7078
+ * @permissionScope Manage Orders
7079
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
7080
+ * @permissionId ECOM.READ_ORDERS
7081
+ * @webhook
7082
+ * @eventType wix.ecom.v1.order_canceled
7083
+ * @serviceIdentifier com.wix.ecom.orders.v1.Orders
7084
+ * @slug canceled
7085
+ */
7086
+ declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
6380
7087
  interface OrderCreatedEnvelope {
6381
7088
  entity: Order;
6382
7089
  metadata: EventMetadata;
6383
7090
  }
7091
+ /**
7092
+ * Triggered when an order is created.
7093
+ * Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
7094
+ * @permissionScope Manage Stores - all permissions
7095
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
7096
+ * @permissionScope Manage Stores
7097
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
7098
+ * @permissionScope Read eCommerce - all read permissions
7099
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
7100
+ * @permissionScope Read Orders
7101
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
7102
+ * @permissionScope Read Stores - all read permissions
7103
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
7104
+ * @permissionScope Manage Restaurants - all permissions
7105
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
7106
+ * @permissionScope Manage eCommerce - all permissions
7107
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
7108
+ * @permissionScope Manage Orders
7109
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
7110
+ * @permissionId ECOM.READ_ORDERS
7111
+ * @webhook
7112
+ * @eventType wix.ecom.v1.order_created
7113
+ * @serviceIdentifier com.wix.ecom.orders.v1.Orders
7114
+ * @slug created
7115
+ */
7116
+ declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
7117
+ type OrderNonNullablePaths = `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}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `status` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `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}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.amount.amount` | `activities.${number}.orderRefunded.amount.formattedAmount` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `payAfterFreeTrial.subtotal.amount` | `payAfterFreeTrial.subtotal.formattedAmount`;
7118
+ /**
7119
+ * Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
7120
+ * Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
7121
+ * 2nd step is an actual charge of prepared payment gateway order. This could be done either
7122
+ * via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
7123
+ * or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
7124
+ * @param ecomOrderId - Ecom order ID.
7125
+ * @param amount - Amount to collect
7126
+ * @public
7127
+ * @documentationMaturity preview
7128
+ * @requiredField amount
7129
+ * @requiredField ecomOrderId
7130
+ * @permissionId ECOM.COLLECT_PAYMENTS
7131
+ * @applicableIdentity APP
7132
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
7133
+ */
7134
+ declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
7135
+ __applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
7136
+ }>;
6384
7137
  interface PreparePaymentCollectionOptions {
6385
7138
  /**
6386
7139
  * Optional parameter. When present, payment collection will be performed using given payment gateway order.
@@ -6400,10 +7153,121 @@ interface PreparePaymentCollectionOptions {
6400
7153
  /** Delayed capture payment settings */
6401
7154
  delayedCaptureSettings?: DelayedCaptureSettings;
6402
7155
  }
7156
+ /**
7157
+ * Provides payment collectability status for given order. If payment collection is possible
7158
+ * response will contain collectable amount for given ecom order. If not - response will contain
7159
+ * reason why payment collection is not possible.
7160
+ * @param ecomOrderId - Ecom order ID.
7161
+ * @public
7162
+ * @documentationMaturity preview
7163
+ * @requiredField ecomOrderId
7164
+ * @permissionId ECOM.COLLECT_PAYMENTS
7165
+ * @applicableIdentity APP
7166
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
7167
+ */
7168
+ declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
7169
+ /**
7170
+ * Records and approves new manual payment with provided custom amount on given order.
7171
+ * Existing pending payments are ignored.
7172
+ * Custom amount is expected to be less or equal remaining amount to be paid on order (affected by approved payments, refunds and gift card payments)
7173
+ * @param orderId - Order ID.
7174
+ * @param amount - Amount to be recorded as approved manual payment for given order
7175
+ * @internal
7176
+ * @documentationMaturity preview
7177
+ * @requiredField amount
7178
+ * @requiredField orderId
7179
+ * @permissionId ECOM.COLLECT_PAYMENTS
7180
+ * @applicableIdentity APP
7181
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.RecordManuallyCollectedPayment
7182
+ */
7183
+ declare function recordManuallyCollectedPayment(orderId: string, amount: Price): Promise<void & {
7184
+ __applicationErrorsType?: RecordManuallyCollectedPaymentApplicationErrors;
7185
+ }>;
7186
+ /**
7187
+ * Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
7188
+ * In case the order already has an offline payment transaction associated with it
7189
+ * (usually when manual payment method is chosen at checkout) - This transaction will become approved.
7190
+ * In case the order has no payment transactions associated with it
7191
+ * (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction
7192
+ * will be created and approved.
7193
+ * @param ecomOrderId - Ecom order ID.
7194
+ * @internal
7195
+ * @documentationMaturity preview
7196
+ * @requiredField ecomOrderId
7197
+ * @permissionId ECOM.MODIFY_ORDERS
7198
+ * @applicableIdentity APP
7199
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.MarkOrderAsPaid
7200
+ */
7201
+ declare function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise<NonNullablePaths<MarkOrderAsPaidResponse, {
7202
+ [P in OrderNonNullablePaths]: `order.${P}`;
7203
+ }[OrderNonNullablePaths]> & {
7204
+ __applicationErrorsType?: PaymentCollectionMarkOrderAsPaidApplicationErrors;
7205
+ }>;
7206
+ /**
7207
+ * Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
7208
+ * @param ecomOrderIds - IDs of orders to mark as paid.
7209
+ * @internal
7210
+ * @documentationMaturity preview
7211
+ * @requiredField ecomOrderIds
7212
+ * @permissionId ECOM.MODIFY_ORDERS
7213
+ * @applicableIdentity APP
7214
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.BulkMarkOrdersAsPaid
7215
+ */
7216
+ declare function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds: string[]): Promise<NonNullablePaths<BulkMarkOrdersAsPaidResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
7217
+ [P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
7218
+ }[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
7219
+ /**
7220
+ * Checks whether this order can be refunded.
7221
+ * @param ecomOrderId - Order ID.
7222
+ * @internal
7223
+ * @documentationMaturity preview
7224
+ * @requiredField ecomOrderId
7225
+ * @permissionId ECOM.READ_TRANSACTIONS
7226
+ * @applicableIdentity APP
7227
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetRefundabilityStatus
7228
+ */
7229
+ declare function getRefundabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetRefundabilityStatusResponse, `refundabilities` | `refundabilities.${number}.nonRefundableReason` | `refundabilities.${number}.manuallyRefundableReason` | `refundabilities.${number}.paymentId` | `refundabilities.${number}.refundabilityStatus` | `refundablePerItem`>>;
7230
+ /**
7231
+ * Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:
7232
+ * 1. An explicit amount provided in the request, or;
7233
+ * 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.
7234
+ * As a result, an ID of the created payment gateway order would be returned.
7235
+ * You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).
7236
+ * @param ecomOrderId - Ecom order ID.
7237
+ * @internal
7238
+ * @documentationMaturity preview
7239
+ * @requiredField ecomOrderId
7240
+ * @permissionId ECOM.MODIFY_ORDERS
7241
+ * @applicableIdentity APP
7242
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CreatePaymentGatewayOrder
7243
+ */
7244
+ declare function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions): Promise<NonNullablePaths<CreatePaymentGatewayOrderResponse, `paymentGatewayOrderId`> & {
7245
+ __applicationErrorsType?: PaymentCollectionCreatePaymentGatewayOrderApplicationErrors;
7246
+ }>;
6403
7247
  interface PaymentCollectionCreatePaymentGatewayOrderOptions {
6404
7248
  /** Information about the user who initiated the payment. */
6405
7249
  chargedBy?: ChargedBy;
6406
7250
  }
7251
+ /** @param ecomOrderId - Order ID.
7252
+ * @param memberId - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
7253
+ * but a user which is using the membership on behalf of the a member
7254
+ * @internal
7255
+ * @documentationMaturity preview
7256
+ * @requiredField ecomOrderId
7257
+ * @requiredField memberId
7258
+ * @requiredField options.membershipCharges.appId
7259
+ * @requiredField options.membershipCharges.catalogReference
7260
+ * @requiredField options.membershipCharges.catalogReference.appId
7261
+ * @requiredField options.membershipCharges.catalogReference.catalogItemId
7262
+ * @requiredField options.membershipCharges.membershipId
7263
+ * @requiredField options.membershipCharges.membershipName
7264
+ * @requiredField options.membershipCharges.membershipName.original
7265
+ * @requiredField options.membershipCharges.rootCatalogItemId
7266
+ * @permissionId ECOM.MODIFY_TRANSACTIONS
7267
+ * @applicableIdentity APP
7268
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.ChargeMemberships
7269
+ */
7270
+ declare function chargeMemberships(ecomOrderId: string, memberId: string, options?: NonNullablePaths<ChargeMembershipsOptions, `membershipCharges.${number}.appId` | `membershipCharges.${number}.catalogReference` | `membershipCharges.${number}.catalogReference.appId` | `membershipCharges.${number}.catalogReference.catalogItemId` | `membershipCharges.${number}.membershipId` | `membershipCharges.${number}.membershipName` | `membershipCharges.${number}.membershipName.original` | `membershipCharges.${number}.rootCatalogItemId`>): Promise<void>;
6407
7271
  interface ChargeMembershipsOptions {
6408
7272
  /**
6409
7273
  * List of items to be paid by memberships
@@ -6412,12 +7276,83 @@ interface ChargeMembershipsOptions {
6412
7276
  */
6413
7277
  membershipCharges?: MembershipChargeItem[];
6414
7278
  }
7279
+ /**
7280
+ * Calls corresponding payment providers and creates refund transactions for requested payments.
7281
+ * Updates order transactions based on refund results.
7282
+ * For requested payments with `TriggerRefundRequest.payments.external_refund = true` will not call payment providers and
7283
+ * will only update order transactions.
7284
+ * @param ecomOrderId - The order this refund related to
7285
+ * @param payments - Refund operations information
7286
+ * @internal
7287
+ * @documentationMaturity preview
7288
+ * @requiredField ecomOrderId
7289
+ * @requiredField payments
7290
+ * @requiredField payments.paymentId
7291
+ * @permissionId ECOM.MODIFY_TRANSACTIONS
7292
+ * @applicableIdentity APP
7293
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.TriggerRefund
7294
+ */
7295
+ declare function triggerRefund(ecomOrderId: string, payments: NonNullablePaths<PaymentRefund, `paymentId`>[], options?: TriggerRefundOptions): Promise<NonNullablePaths<TriggerRefundResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending` | `failedPaymentIds` | `failedPaymentIds.${number}.originalIndex` | `failedPaymentIds.${number}.success` | `failedPaymentIds.${number}.error.code` | `failedPaymentIds.${number}.error.description`> & {
7296
+ __applicationErrorsType?: TriggerRefundApplicationErrors;
7297
+ }>;
6415
7298
  interface TriggerRefundOptions {
6416
7299
  /** Business model of a refund */
6417
7300
  details?: RefundDetails;
6418
7301
  /** Side effect details related to refund */
6419
7302
  sideEffects?: RefundSideEffects;
6420
7303
  }
7304
+ /**
7305
+ * Void authorized payments
7306
+ * Transaction statuses for related payments will be updated in async way
7307
+ * @param ecomOrderId - Wix eCommerce order ID
7308
+ * @param paymentIds - Payment IDs
7309
+ * @public
7310
+ * @documentationMaturity preview
7311
+ * @requiredField ecomOrderId
7312
+ * @requiredField paymentIds
7313
+ * @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
7314
+ * @applicableIdentity APP
7315
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
7316
+ */
7317
+ declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
7318
+ __applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
7319
+ }>;
7320
+ /**
7321
+ * Capture authorized payments
7322
+ * Transaction statuses for related payments will be updated in async way
7323
+ * @param ecomOrderId - Wix eCommerce order ID
7324
+ * @param payments - Capture payments information
7325
+ * @public
7326
+ * @documentationMaturity preview
7327
+ * @requiredField ecomOrderId
7328
+ * @requiredField payments
7329
+ * @requiredField payments.paymentId
7330
+ * @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
7331
+ * @applicableIdentity APP
7332
+ * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
7333
+ */
7334
+ declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
7335
+ __applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
7336
+ }>;
7337
+ /**
7338
+ * Retrieves an order.
7339
+ *
7340
+ *
7341
+ * The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.
7342
+ *
7343
+ * To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to [`listTransactionsForSingleOrder( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/listtransactionsforsingleorder).
7344
+ * @param _id - ID of the order to retrieve.
7345
+ * @public
7346
+ * @requiredField _id
7347
+ * @permissionId ECOM.READ_ORDERS
7348
+ * @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS
7349
+ * @applicableIdentity APP
7350
+ * @returns Fulfilled - The requested order.
7351
+ * @fqn com.wix.ecom.orders.v1.Orders.GetOrder
7352
+ */
7353
+ declare function getOrder(_id: string): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
7354
+ __applicationErrorsType?: GetOrderApplicationErrors;
7355
+ }>;
6421
7356
  interface OrderSearchSpec extends SearchSpec {
6422
7357
  paging: 'cursor';
6423
7358
  wql: [
@@ -6545,10 +7480,83 @@ type OrderSearch = {
6545
7480
  order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
6546
7481
  }[];
6547
7482
  };
7483
+ /**
7484
+ * Creates an order.
7485
+ *
7486
+ *
7487
+ * The `createOrder()` function returns a Promise that resolves when the order is created.
7488
+ *
7489
+ * > **Notes:**
7490
+ * > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.
7491
+ * > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.
7492
+ * @param order - Order info.
7493
+ * @public
7494
+ * @requiredField order
7495
+ * @requiredField order.billingInfo.contactDetails
7496
+ * @requiredField order.channelInfo
7497
+ * @requiredField order.currencyConversionDetails.conversionRate
7498
+ * @requiredField order.currencyConversionDetails.originalCurrency
7499
+ * @requiredField order.lineItems
7500
+ * @requiredField order.lineItems.catalogReference.appId
7501
+ * @requiredField order.lineItems.catalogReference.catalogItemId
7502
+ * @requiredField order.lineItems.itemType
7503
+ * @requiredField order.lineItems.price
7504
+ * @requiredField order.lineItems.productName
7505
+ * @requiredField order.lineItems.productName.original
7506
+ * @requiredField order.lineItems.quantity
7507
+ * @requiredField order.priceSummary
7508
+ * @permissionId ECOM.CREATE_ORDERS
7509
+ * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
7510
+ * @applicableIdentity APP
7511
+ * @returns Newly created order.
7512
+ * @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
7513
+ */
7514
+ declare function createOrder(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` | `priceSummary`>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
7515
+ __applicationErrorsType?: CreateOrderApplicationErrors;
7516
+ }>;
6548
7517
  interface CreateOrderOptions {
6549
7518
  /** Determine order lifecycle */
6550
7519
  settings?: OrderCreationSettings;
6551
7520
  }
7521
+ /**
7522
+ * Updates an order.
7523
+ *
7524
+ *
7525
+ * The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.
7526
+ *
7527
+ * Currently, the following fields can be updated:
7528
+ * + `order.buyerInfo.email`
7529
+ * + `order.buyerLanguage`
7530
+ * + `order.weightUnit`
7531
+ * + `order.billingInfo.address`
7532
+ * + `order.billingInfo.contactDetails`
7533
+ * + `order.archived`
7534
+ * + `order.attributionSource`
7535
+ * + `order.seenByAHuman`
7536
+ * + `order.recipientInfo.address`
7537
+ * + `order.recipientInfo.contactDetails`
7538
+ * + `order.shippingInfo.logistics.shippingDestination.address`
7539
+ * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
7540
+ *
7541
+ * To update a field's value, include the new value in the `order` object in the method parameters.
7542
+ * To remove a field's value, pass `null`.
7543
+ *
7544
+ * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
7545
+ *
7546
+ * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
7547
+ * @param _id - Order ID.
7548
+ * @public
7549
+ * @requiredField _id
7550
+ * @requiredField order
7551
+ * @permissionId ECOM.MODIFY_ORDERS
7552
+ * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
7553
+ * @applicableIdentity APP
7554
+ * @returns Newly created order.
7555
+ * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
7556
+ */
7557
+ declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
7558
+ __applicationErrorsType?: UpdateOrderApplicationErrors;
7559
+ }>;
6552
7560
  interface UpdateOrder {
6553
7561
  /**
6554
7562
  * Order ID.
@@ -6722,6 +7730,44 @@ interface UpdateOrder {
6722
7730
  */
6723
7731
  payAfterFreeTrial?: PriceSummary;
6724
7732
  }
7733
+ /**
7734
+ * Updates up to 100 orders.
7735
+ *
7736
+ *
7737
+ * The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
7738
+ *
7739
+ * Currently, the following fields can be updated:
7740
+ * + `order.buyerInfo.email`
7741
+ * + `order.buyerLanguage`
7742
+ * + `order.weightUnit`
7743
+ * + `order.billingInfo.address`
7744
+ * + `order.billingInfo.contactDetails`
7745
+ * + `order.archived`
7746
+ * + `order.attributionSource`
7747
+ * + `order.seenByAHuman`
7748
+ * + `order.recipientInfo.address`
7749
+ * + `order.recipientInfo.contactDetails`
7750
+ * + `order.shippingInfo.logistics.shippingDestination.address`
7751
+ * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
7752
+ *
7753
+ * To update a field's value, include the new value in the `orders.order` object in the method parameters.
7754
+ * To remove a field's value, pass `null`.
7755
+ *
7756
+ * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
7757
+ *
7758
+ * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
7759
+ * @param orders - Orders to update.
7760
+ * @public
7761
+ * @requiredField orders
7762
+ * @requiredField orders.order
7763
+ * @requiredField orders.order._id
7764
+ * @permissionId ECOM.MODIFY_ORDERS
7765
+ * @applicableIdentity APP
7766
+ * @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
7767
+ */
7768
+ declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
7769
+ [P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
7770
+ }[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
6725
7771
  interface BulkUpdateOrdersOptions {
6726
7772
  /**
6727
7773
  * Whether to return the full order entities.
@@ -6730,6 +7776,23 @@ interface BulkUpdateOrdersOptions {
6730
7776
  */
6731
7777
  returnEntity?: boolean;
6732
7778
  }
7779
+ /** @param _id - Order id to be updated
7780
+ * @internal
7781
+ * @documentationMaturity preview
7782
+ * @requiredField _id
7783
+ * @requiredField options.changes
7784
+ * @requiredField options.changes.priceSummary.subtotal
7785
+ * @requiredField options.changes.priceSummary.total
7786
+ * @permissionId ECOM.ORDERS_DELTAS_COMMIT
7787
+ * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
7788
+ * @applicableIdentity APP
7789
+ * @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
7790
+ */
7791
+ declare function commitDeltas(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
7792
+ [P in OrderNonNullablePaths]: `order.${P}`;
7793
+ }[OrderNonNullablePaths]> & {
7794
+ __applicationErrorsType?: CommitDeltasApplicationErrors;
7795
+ }>;
6733
7796
  interface CommitDeltasOptions {
6734
7797
  /**
6735
7798
  * Draft order Id representing this change.
@@ -6747,6 +7810,21 @@ interface CommitDeltasOptions {
6747
7810
  */
6748
7811
  reason?: string | null;
6749
7812
  }
7813
+ /** @internal
7814
+ * @documentationMaturity preview
7815
+ * @requiredField identifiers
7816
+ * @requiredField identifiers._id
7817
+ * @requiredField identifiers.lineItemId
7818
+ * @requiredField lineItem
7819
+ * @permissionId ECOM.MODIFY_ORDERS
7820
+ * @applicableIdentity APP
7821
+ * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
7822
+ * @deprecated
7823
+ * @targetRemovalDate 2024-02-15
7824
+ */
7825
+ declare function updateOrderLineItem(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
7826
+ [P in OrderNonNullablePaths]: `order.${P}`;
7827
+ }[OrderNonNullablePaths]>>;
6750
7828
  interface UpdateOrderLineItemIdentifiers {
6751
7829
  /**
6752
7830
  * Order ID
@@ -6870,13 +7948,61 @@ interface UpdateOrderLineItem {
6870
7948
  locations?: LocationAndQuantity[];
6871
7949
  /** Address used for tax calculation. */
6872
7950
  taxableAddress?: TaxableAddress;
7951
+ /**
7952
+ * ID of the app managing the inventory.
7953
+ * @internal
7954
+ * @format GUID
7955
+ */
7956
+ inventoryAppId?: string | null;
6873
7957
  /**
6874
7958
  * Custom extended fields for the line item object.
6875
7959
  *
6876
7960
  * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
6877
7961
  */
6878
7962
  extendedFields?: ExtendedFields;
7963
+ /**
7964
+ * Modifier groups that were added to the item.
7965
+ * @internal
7966
+ * @readonly
7967
+ * @maxSize 10
7968
+ */
7969
+ modifierGroups?: ModifierGroup[];
6879
7970
  }
7971
+ /**
7972
+ * Adds a merchant comment to an order.
7973
+ * > **Note:** Activities with type CustomActivity not supported
7974
+ * @param _id - Order ID.
7975
+ * @param activity - Activity info.
7976
+ * @internal
7977
+ * @documentationMaturity preview
7978
+ * @requiredField _id
7979
+ * @requiredField activity
7980
+ * @permissionId ECOM.MODIFY_ORDERS
7981
+ * @applicableIdentity APP
7982
+ * @fqn com.wix.ecom.orders.v1.Orders.AddActivity
7983
+ * @deprecated
7984
+ * @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
7985
+ * @targetRemovalDate 2024-11-01
7986
+ */
7987
+ declare function addActivity(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
7988
+ [P in OrderNonNullablePaths]: `order.${P}`;
7989
+ }[OrderNonNullablePaths] | `activityId`>>;
7990
+ /**
7991
+ * Updates an order's activity.
7992
+ * @param activity - Activity info.
7993
+ * @internal
7994
+ * @documentationMaturity preview
7995
+ * @requiredField activity
7996
+ * @requiredField identifiers
7997
+ * @requiredField identifiers._id
7998
+ * @requiredField identifiers.activityId
7999
+ * @permissionId ECOM.MODIFY_ORDERS
8000
+ * @applicableIdentity APP
8001
+ * @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
8002
+ */
8003
+ declare function updateActivity(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
8004
+ [P in OrderNonNullablePaths]: `order.${P}`;
8005
+ }[OrderNonNullablePaths]>>;
6880
8006
  interface UpdateActivityIdentifiers {
6881
8007
  /**
6882
8008
  * Order ID.
@@ -6890,6 +8016,22 @@ interface UpdateActivityIdentifiers {
6890
8016
  */
6891
8017
  activityId: string;
6892
8018
  }
8019
+ /**
8020
+ * Delete's an order's activity.
8021
+ *
8022
+ * Only custom activities and merchant comments can be deleted.
8023
+ * @internal
8024
+ * @documentationMaturity preview
8025
+ * @requiredField identifiers
8026
+ * @requiredField identifiers._id
8027
+ * @requiredField identifiers.activityId
8028
+ * @permissionId ECOM.MODIFY_ORDERS
8029
+ * @applicableIdentity APP
8030
+ * @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
8031
+ */
8032
+ declare function deleteActivity(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
8033
+ [P in OrderNonNullablePaths]: `order.${P}`;
8034
+ }[OrderNonNullablePaths]>>;
6893
8035
  interface DeleteActivityIdentifiers {
6894
8036
  /**
6895
8037
  * Order ID.
@@ -6903,6 +8045,23 @@ interface DeleteActivityIdentifiers {
6903
8045
  */
6904
8046
  activityId: string;
6905
8047
  }
8048
+ /**
8049
+ * Cancels an order.
8050
+ *
8051
+ *
8052
+ * The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
8053
+ * @param _id - Order ID.
8054
+ * @public
8055
+ * @requiredField _id
8056
+ * @permissionId ECOM.MODIFY_ORDERS
8057
+ * @applicableIdentity APP
8058
+ * @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
8059
+ */
8060
+ declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, {
8061
+ [P in OrderNonNullablePaths]: `order.${P}`;
8062
+ }[OrderNonNullablePaths]> & {
8063
+ __applicationErrorsType?: CancelOrderApplicationErrors;
8064
+ }>;
6906
8065
  interface CancelOrderOptions {
6907
8066
  /** Whether to send an order canceled email to the buyer. */
6908
8067
  sendOrderCanceledEmail?: boolean;
@@ -6915,6 +8074,43 @@ interface CancelOrderOptions {
6915
8074
  /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
6916
8075
  restockAllItems?: boolean;
6917
8076
  }
8077
+ /**
8078
+ * Updates order status.
8079
+ *
8080
+ * >CANCELED and REJECTED are final statuses. Update from either of those will fail.
8081
+ * >Updates into INITIALIZED are not supported.
8082
+ *
8083
+ * Approving order:
8084
+ * APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
8085
+ *
8086
+ * Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
8087
+ * will cause an error.
8088
+ *
8089
+ * Setting PENDING status:
8090
+ * Only orders in INITIALIZED status can be updated into PENDING.
8091
+ * @param orderId - Order ID.
8092
+ * @param status - New order status.
8093
+ * @internal
8094
+ * @documentationMaturity preview
8095
+ * @requiredField orderId
8096
+ * @requiredField status
8097
+ * @permissionId ECOM.ORDER_UPDATE_STATUS
8098
+ * @applicableIdentity APP
8099
+ * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
8100
+ */
8101
+ declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
8102
+ [P in OrderNonNullablePaths]: `order.${P}`;
8103
+ }[OrderNonNullablePaths]> & {
8104
+ __applicationErrorsType?: UpdateOrderStatusApplicationErrors;
8105
+ }>;
8106
+ /** @internal
8107
+ * @documentationMaturity preview
8108
+ * @requiredField options.aggregation
8109
+ * @permissionId ECOM.READ_ORDERS
8110
+ * @applicableIdentity APP
8111
+ * @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
8112
+ */
8113
+ declare function aggregateOrders(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
6918
8114
  interface AggregateOrdersOptions {
6919
8115
  /** Filter applied to original data */
6920
8116
  filter?: Record<string, any> | null;
@@ -6931,6 +8127,19 @@ interface AggregateOrdersOptions {
6931
8127
  */
6932
8128
  hierarchySeparatorOverride?: string | null;
6933
8129
  }
8130
+ /**
8131
+ * Synchronously update tags on multiple orders, by list of order IDs.
8132
+ *
8133
+ * > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
8134
+ * @param orderIds - IDs of orders to update tags for.
8135
+ * @public
8136
+ * @requiredField orderIds
8137
+ * @permissionId ECOM.MODIFY_ORDERS
8138
+ * @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS
8139
+ * @applicableIdentity APP
8140
+ * @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
8141
+ */
8142
+ declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
6934
8143
  interface BulkUpdateOrderTagsOptions {
6935
8144
  /** Tags to be added to orders */
6936
8145
  assignTags?: Tags;
@@ -6938,4 +8147,4 @@ interface BulkUpdateOrderTagsOptions {
6938
8147
  unassignTags?: Tags;
6939
8148
  }
6940
8149
 
6941
- export { ActionType as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, DurationUnit as E, FulfillmentStatus as F, type GetPaymentCollectabilityStatusResponse as G, PaymentCollectabilityStatus as H, ItemTypeItemType as I, JurisdictionType as J, ManuallyRefundableReason as K, LineItemQuantityChangeType as L, type MaskedOrder as M, NonRefundableReason as N, type Order as O, type Price as P, RestockType as Q, RefundableStatus as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, TransactionStatus as X, AuthorizationCaptureStatus as Y, AuthorizationVoidStatus as Z, Reason as _, type PreparePaymentCollectionOptions as a, type DeliveryLogistics as a$, MembershipPaymentStatus as a0, RefundStatus as a1, WebhookIdentityType as a2, TextDetection as a3, AnimationDetection as a4, PreviewEmailType as a5, State as a6, Namespace as a7, SortOrder as a8, VersioningMode as a9, type DigitalFile as aA, type SubscriptionInfo as aB, type SubscriptionTitle as aC, type SubscriptionDescription as aD, type SubscriptionSettings as aE, type FreeTrialPeriod as aF, type BillingAdjustment as aG, type BillingAdjustmentPriceSummary as aH, type PriceDescription as aI, type LocationAndQuantity as aJ, type TaxableAddress as aK, type TaxableAddressTaxableAddressDataOneOf as aL, type ExtendedFields as aM, type ModifierGroup as aN, type TranslatableString as aO, type ItemModifier as aP, type BuyerInfo as aQ, type BuyerInfoIdOneOf as aR, type CurrencyConversionDetails as aS, type PriceSummary as aT, type AddressWithContact as aU, type Address as aV, type StreetAddress as aW, type AddressLocation as aX, type FullAddressContactDetails as aY, type VatId as aZ, type V1ShippingInformation as a_, OrderApprovalStrategy as aa, DeltaPaymentOptionType as ab, InventoryAction as ac, Placement as ad, SubdivisionType as ae, SourceType as af, CustomFieldGroup as ag, ValueType as ah, DepositType as ai, InvoiceStatus as aj, type OrderLineItem as ak, type ProductName as al, type CatalogReference as am, type DescriptionLine as an, type DescriptionLineValueOneOf as ao, type DescriptionLineDescriptionLineValueOneOf as ap, type DescriptionLineName as aq, type PlainTextValue as ar, type Color as as, type FocalPoint as at, type PhysicalProperties as au, type ItemType as av, type ItemTypeItemTypeDataOneOf as aw, type ItemTaxFullDetails as ax, type LineItemTaxInfo as ay, type LineItemTaxBreakdown as az, type PreparePaymentCollectionResponse as b, type WixReceipt as b$, type DeliveryLogisticsAddressOneOf as b0, type PickupDetails as b1, type PickupAddress as b2, type DeliveryTimeSlot as b3, type ShippingPrice as b4, type ShippingRegion as b5, type TaxSummary as b6, type OrderTaxInfo as b7, type OrderTaxBreakdown as b8, type AppliedDiscount as b9, type TotalPriceChange as bA, type ShippingInformationChange as bB, type ShippingInformation as bC, type SavedPaymentMethod as bD, type AuthorizedPaymentCreated as bE, type AuthorizedPaymentCaptured as bF, type AuthorizedPaymentVoided as bG, type RefundInitiated as bH, type RefundedPayment as bI, type RefundedPaymentKindOneOf as bJ, type RegularPaymentRefund as bK, type GiftCardPaymentRefund as bL, type MembershipPaymentRefund as bM, type PaymentRefunded as bN, type PaymentRefundFailed as bO, type RefundedAsStoreCredit as bP, type PaymentPending as bQ, type PaymentPendingPaymentDetailsOneOf as bR, type RegularPayment as bS, type RegularPaymentPaymentMethodDetailsOneOf as bT, type CreditCardDetails as bU, type PaymentCanceled as bV, type PaymentCanceledPaymentDetailsOneOf as bW, type PaymentDeclined as bX, type PaymentDeclinedPaymentDetailsOneOf as bY, type ReceiptCreated as bZ, type ReceiptCreatedReceiptInfoOneOf as b_, type AppliedDiscountDiscountSourceOneOf as ba, type Coupon as bb, type MerchantDiscount as bc, type MerchantDiscountMerchantDiscountReasonOneOf as bd, type DiscountRule as be, type DiscountRuleName as bf, type LineItemDiscount as bg, type Activity as bh, type ActivityContentOneOf as bi, type CustomActivity as bj, type MerchantComment as bk, type OrderRefunded as bl, type OrderCreatedFromExchange as bm, type NewExchangeOrderCreated as bn, type LineItemExchangeData as bo, type DraftOrderChangesApplied as bp, type OrderChange as bq, type OrderChangeValueOneOf as br, type LineItemChanges as bs, type LineItemQuantityChange as bt, type LineItemPriceChange as bu, type ManagedLineItem as bv, type ManagedDiscount as bw, type TranslatedValue as bx, type LineItemAmount as by, type ManagedAdditionalFee as bz, type PaymentCapture as c, type CreditCardPaymentMethodDetails as c$, type ExternalReceipt as c0, type ReceiptSent as c1, type ReceiptSentReceiptInfoOneOf as c2, type CreatedBy as c3, type CreatedByStringOneOf as c4, type ChannelInfo as c5, type CustomField as c6, type BalanceSummary as c7, type Balance as c8, type AdditionalFee as c9, type Refundability as cA, type RefundabilityAdditionalRefundabilityInfoOneOf as cB, type CreatePaymentGatewayOrderRequest as cC, type ChargedBy as cD, type CreatePaymentGatewayOrderResponse as cE, type ChargeMembershipsRequest as cF, type MembershipChargeItem as cG, type MembershipName as cH, type ServiceProperties as cI, type ChargeMembershipsResponse as cJ, type TriggerRefundRequest as cK, type PaymentRefund as cL, type RefundDetails as cM, type RefundItem as cN, type LineItemRefund as cO, type AdditionalFeeRefund as cP, type ShippingRefund as cQ, type RefundSideEffects as cR, type RestockInfo as cS, type RestockItem as cT, type TriggerRefundResponse as cU, type OrderTransactions as cV, type Payment as cW, type PaymentPaymentDetailsOneOf as cX, type PaymentReceiptInfoOneOf as cY, type RegularPaymentDetails as cZ, type RegularPaymentDetailsPaymentMethodDetailsOneOf as c_, type FulfillmentStatusesAggregate as ca, type Tags as cb, type TagList as cc, type Location as cd, type OrderApproved as ce, type OrdersExperiments as cf, type OrderRejectedEventOrderRejected as cg, type OrderItemsRestocked as ch, type V1RestockItem as ci, type PreparePaymentCollectionRequest as cj, type RedirectUrls as ck, type DelayedCaptureSettings as cl, type Duration as cm, type GetPaymentCollectabilityStatusRequest as cn, type RecordManuallyCollectedPaymentRequest as co, type RecordManuallyCollectedPaymentResponse as cp, type MarkOrderAsPaidRequest as cq, type MarkOrderAsPaidResponse as cr, type BulkMarkOrdersAsPaidRequest as cs, type BulkMarkOrdersAsPaidResponse as ct, type BulkOrderResult as cu, type ItemMetadata as cv, type ApplicationError as cw, type BulkActionMetadata as cx, type GetRefundabilityStatusRequest as cy, type GetRefundabilityStatusResponse as cz, type OrderSearch as d, type PreviewCancelRefundEmailResponse as d$, type AuthorizationDetails as d0, type AuthorizationCapture as d1, type AuthorizationActionFailureDetails as d2, type AuthorizationVoid as d3, type V1ScheduledAction as d4, type GiftCardPaymentDetails as d5, type MembershipPaymentDetails as d6, type WixReceiptInfo as d7, type ExternalReceiptInfo as d8, type Refund as d9, type SendBuyerConfirmationEmailRequest as dA, type SendBuyerConfirmationEmailResponse as dB, type SendBuyerPaymentsReceivedEmailRequest as dC, type SendBuyerPaymentsReceivedEmailResponse as dD, type SendBuyerPickupConfirmationEmailRequest as dE, type SendBuyerPickupConfirmationEmailResponse as dF, type BulkSendBuyerPickupConfirmationEmailsRequest as dG, type BulkSendBuyerPickupConfirmationEmailsResponse as dH, type SendBuyerShippingConfirmationEmailRequest as dI, type SendBuyerShippingConfirmationEmailResponse as dJ, type BulkSendBuyerShippingConfirmationEmailsRequest as dK, type BulkSendBuyerShippingConfirmationEmailsResponse as dL, type SendMerchantOrderReceivedNotificationRequest as dM, type SendMerchantOrderReceivedNotificationResponse as dN, type SendCancelRefundEmailRequest as dO, type SendCancelRefundEmailResponse as dP, type SendRefundEmailRequest as dQ, type SendRefundEmailResponse as dR, type SendMerchantOrderReceivedPushRequest as dS, type SendMerchantOrderReceivedPushResponse as dT, type PreviewEmailByTypeRequest as dU, type PreviewEmailByTypeResponse as dV, type PreviewRefundEmailRequest as dW, type PreviewRefundEmailResponse as dX, type PreviewCancelEmailRequest as dY, type PreviewCancelEmailResponse as dZ, type PreviewCancelRefundEmailRequest as d_, type RefundTransaction as da, type RefundStatusInfo as db, type AggregatedRefundSummary as dc, type RefundItemsBreakdown as dd, type LineItemRefundSummary as de, type CalculateRefundRequest as df, type CalculateRefundItemRequest as dg, type CalculateRefundResponse as dh, type CalculateRefundItemResponse as di, type VoidAuthorizedPaymentsRequest as dj, type CaptureAuthorizedPaymentsRequest as dk, type ChargeSavedPaymentMethodRequest as dl, type ChargeSavedPaymentMethodResponse as dm, type DomainEvent as dn, type DomainEventBodyOneOf as dp, type EntityCreatedEvent as dq, type RestoreInfo as dr, type EntityUpdatedEvent as ds, type EntityDeletedEvent as dt, type ActionEvent as du, type Empty as dv, type MessageEnvelope as dw, type IdentificationData as dx, type IdentificationDataIdOneOf as dy, type ImageContent as dz, type CreateOrderOptions as e, type IndexingMessage as e$, type PreviewBuyerPaymentsReceivedEmailRequest as e0, type PreviewBuyerPaymentsReceivedEmailResponse as e1, type PreviewBuyerConfirmationEmailRequest as e2, type PreviewBuyerConfirmationEmailResponse as e3, type PreviewBuyerPickupConfirmationEmailRequest as e4, type PreviewBuyerPickupConfirmationEmailResponse as e5, type PreviewShippingConfirmationEmailRequest as e6, type PreviewShippingConfirmationEmailResponse as e7, type PreviewResendDownloadLinksEmailRequest as e8, type PreviewResendDownloadLinksEmailResponse as e9, type UpsertRefundRequest as eA, type UpsertRefundResponse as eB, type GetOrderOutOfBoxRequest as eC, type GetOrderOutOfBoxResponse as eD, type GetOrderAgcRequest as eE, type GetOrderAgcResponse as eF, type GetOrderWithFilterByLocationRequest as eG, type GetOrderWithFilterByLocationResponse as eH, type V1UpdateOrderRequest as eI, type V1UpdateOrderResponse as eJ, type UpdateInternalDocumentsEvent as eK, type UpdateInternalDocumentsEventOperationOneOf as eL, type InternalDocument as eM, type InternalDocumentUpdateOperation as eN, type DeleteByIdsOperation as eO, type DeleteByFilterOperation as eP, type InternalDocumentUpdateByFilterOperation as eQ, type InternalUpdateExistingOperation as eR, type VersionedDocumentUpdateOperation as eS, type VersionedDeleteByIdsOperation as eT, type VersionedDocumentId as eU, type TriggerReindexRequest as eV, type TriggerReindexResponse as eW, type BatchOfTriggerReindexOrderRequest as eX, type DiffmatokyPayload as eY, type ErrorInformation as eZ, type ContinueSideEffectsFlowInLegacyData as e_, type TriggerReindexOrderRequest as ea, type SnapshotMessage as eb, type PaymentStatusUpdated as ec, type GetMetasiteDataRequest as ed, type GetMetasiteDataResponse as ee, type MetaSite as ef, type App as eg, type SeoData as eh, type MetaTag as ei, type HtmlApplication as ej, type ExternalUriMapping as ek, type UserDataResponse as el, type QueryOrdersForMetasiteRequest as em, type InternalQueryOrdersRequest as en, type PlatformQuery as eo, type PlatformQueryPagingMethodOneOf as ep, type Sorting as eq, type PlatformPaging as er, type CursorPaging as es, type QueryOrdersForMetasiteResponse as et, type PlatformPagingMetadata as eu, type Cursors as ev, type GetOrderForMetasiteRequest as ew, type GetOrderForMetasiteResponse as ex, type ListOrderTransactionsForMetasiteRequest as ey, type ListOrderTransactionsForMetasiteResponse as ez, type BulkUpdateOrdersResponse as f, type UpdateOrderLineItemsResponse as f$, type GetOrderRequest as f0, type GetOrderResponse as f1, type InternalQueryOrdersResponse as f2, type QueryOrderRequest as f3, type QueryOrderResponse as f4, type SearchOrdersRequest as f5, type CursorSearch as f6, type CursorSearchPagingMethodOneOf as f7, type CursorPagingMetadata as f8, type CreateOrderRequest as f9, type LineItemDelta as fA, type LineItemDeltaDeltaOneOf as fB, type ArchiveOrderRequest as fC, type ArchiveOrderResponse as fD, type BulkArchiveOrdersRequest as fE, type BulkArchiveOrdersResponse as fF, type BulkArchiveOrdersByFilterRequest as fG, type BulkArchiveOrdersByFilterResponse as fH, type UnArchiveOrderRequest as fI, type UnArchiveOrderResponse as fJ, type BulkUnArchiveOrdersRequest as fK, type BulkUnArchiveOrdersResponse as fL, type BulkUnArchiveOrdersByFilterRequest as fM, type BulkUnArchiveOrdersByFilterResponse as fN, type UpdateBuyerInfoRequest as fO, type BuyerInfoUpdate as fP, type UpdateBuyerInfoResponse as fQ, type UpdateBuyerEmailRequest as fR, type UpdateBuyerEmailResponse as fS, type UpdateOrderShippingAddressRequest as fT, type UpdateOrderShippingAddressResponse as fU, type UpdateBillingContactDetailsRequest as fV, type UpdateBillingContactDetailsResponse as fW, type UpdateOrderLineItemRequest as fX, type UpdateOrderLineItemResponse as fY, type UpdateOrderLineItemsRequest as fZ, type MaskedOrderLineItem as f_, type OrderCreationSettings as fa, type OrderCreateNotifications as fb, type CreateOrderResponse as fc, type UpdateOrderRequest as fd, type UpdateOrderResponse as fe, type BulkUpdateOrdersRequest as ff, type CommitDeltasRequest as fg, type DraftOrderDiffs as fh, type DraftOrderDiffsShippingUpdateInfoOneOf as fi, type DraftOrderDiffsBuyerUpdateInfoOneOf as fj, type DraftOrderDiffsBillingUpdateInfoOneOf as fk, type DraftOrderDiffsRecipientUpdateInfoOneOf as fl, type V1LineItemDelta as fm, type V1LineItemDeltaDeltaOneOf as fn, type OrderLineItemChangedDetails as fo, type ItemChangedDetails as fp, type AppliedDiscountDelta as fq, type AppliedDiscountDeltaDeltaOneOf as fr, type AdditionalFeeDelta as fs, type AdditionalFeeDeltaDeltaOneOf as ft, type DraftOrderCommitSettings as fu, type InventoryUpdateDetails as fv, type CommitDeltasResponse as fw, type OrderDeltasCommitted as fx, type CommittedDiffs as fy, type CommittedDiffsShippingUpdateInfoOneOf as fz, type CancelOrderOptions as g, type V1CreatePaymentGatewayOrderResponse as g$, type AddInternalActivityRequest as g0, type InternalActivity as g1, type InternalActivityContentOneOf as g2, type OrderPlaced as g3, type OrderPaid as g4, type OrderFulfilled as g5, type OrderNotFulfilled as g6, type OrderCanceled as g7, type DownloadLinkSent as g8, type TrackingNumberAdded as g9, type MarkOrderAsSeenByHumanRequest as gA, type MarkOrderAsSeenByHumanResponse as gB, type CancelOrderRequest as gC, type OrderCanceledEventOrderCanceled as gD, type UpdateOrderStatusRequest as gE, type UpdateOrderStatusResponse as gF, type MarkAsFulfilledRequest as gG, type MarkAsFulfilledResponse as gH, type FulfillmentStatusUpdated as gI, type BulkMarkAsFulfilledRequest as gJ, type BulkMarkAsFulfilledResponse as gK, type BulkMarkAsFulfilledByFilterRequest as gL, type BulkMarkAsFulfilledByFilterResponse as gM, type MarkAsUnfulfilledRequest as gN, type MarkAsUnfulfilledResponse as gO, type BulkMarkAsUnfulfilledRequest as gP, type BulkMarkAsUnfulfilledResponse as gQ, type BulkMarkAsUnfulfilledByFilterRequest as gR, type BulkMarkAsUnfulfilledByFilterResponse as gS, type BulkSetBusinessLocationRequest as gT, type BulkSetBusinessLocationResponse as gU, type BulkSetBusinessLocationResult as gV, type V1MarkOrderAsPaidRequest as gW, type V1MarkOrderAsPaidResponse as gX, type V1BulkMarkOrdersAsPaidRequest as gY, type V1BulkMarkOrdersAsPaidResponse as gZ, type V1CreatePaymentGatewayOrderRequest as g_, type TrackingNumberEdited as ga, type TrackingLinkAdded as gb, type ShippingConfirmationEmailSent as gc, type InvoiceAdded as gd, type InvoiceSent as ge, type FulfillerEmailSent as gf, type ShippingAddressEdited as gg, type EmailEdited as gh, type PickupReadyEmailSent as gi, type OrderPartiallyPaid as gj, type OrderPending as gk, type OrderRejected as gl, type AddInternalActivityResponse as gm, type AddActivityRequest as gn, type PublicActivity as go, type PublicActivityContentOneOf as gp, type AddActivityResponse as gq, type AddActivitiesRequest as gr, type AddActivitiesResponse as gs, type UpdateActivityRequest as gt, type UpdateActivityResponse as gu, type DeleteActivityRequest as gv, type DeleteActivityResponse as gw, type UpdateLineItemsDescriptionLinesRequest as gx, type LineItemUpdate as gy, type UpdateLineItemsDescriptionLinesResponse as gz, type CancelOrderResponse as h, type GetShipmentsRequest as h0, type GetShipmentsResponse as h1, type AggregateOrdersRequest as h2, type AggregateOrdersResponse as h3, type DecrementItemsQuantityRequest as h4, type DecrementData as h5, type DecrementItemsQuantityResponse as h6, type BulkUpdateOrderTagsRequest as h7, type BulkUpdateOrderTagsResult as h8, type Task as h9, type Locale as hA, type TotalPrice as hB, type ItemizedFee as hC, type Discount as hD, type DiscountOneDiscountTypeOneOf as hE, type CalculatedTaxes as hF, type CalculatedTax as hG, type Payments as hH, type InvoicesPayment as hI, type MetaData as hJ, type InvoiceDynamicPriceTotals as hK, type CustomFieldValue as hL, type Value as hM, type Deposit as hN, type TriggerSideEffectsFromLegacyData as hO, type BaseEventMetadata as hP, type EventMetadata as hQ, type PaymentCollectionCreatePaymentGatewayOrderOptions as hR, type ChargeMembershipsOptions as hS, type TriggerRefundOptions as hT, type OrderSearchSpec as hU, type CommitDeltasOptions as hV, type UpdateOrderLineItemIdentifiers as hW, type UpdateOrderLineItem as hX, type UpdateActivityIdentifiers as hY, type DeleteActivityIdentifiers as hZ, type AggregateOrdersOptions as h_, type TaskKey as ha, type TaskAction as hb, type TaskActionActionOneOf as hc, type Complete as hd, type Cancel as he, type Reschedule as hf, type InvoiceSentEvent as hg, type IdAndVersion as hh, type InvoiceFields as hi, type Customer as hj, type Email as hk, type QuotesAddress as hl, type AddressDescription as hm, type Phone as hn, type Company as ho, type CommonAddress as hp, type CommonAddressStreetOneOf as hq, type Subdivision as hr, type StandardDetails as hs, type InvoiceDates as ht, type LineItems as hu, type LineItem as hv, type BigDecimalWrapper as hw, type LineItemTax as hx, type Source as hy, type LineItemMetaData as hz, type BulkUpdateOrderTagsOptions as i, type BulkUpdateOrderTagsResponse as j, type OrderApprovedEnvelope as k, type OrderUpdatedEnvelope as l, type OrderCanceledEnvelope as m, type OrderCreatedEnvelope as n, PaymentOptionType as o, SubscriptionFrequency as p, PaymentStatus as q, VatType as r, PickupMethod as s, OrderStatus as t, DiscountType as u, DiscountReason as v, ActivityType as w, AttributionSource as x, ChannelType as y, ScheduledAction as z };
8150
+ export { type AggregateOrdersResponse as $, type UpdateOrderLineItemIdentifiers as A, type BulkMarkOrdersAsPaidResponse as B, type CreatePaymentGatewayOrderResponse as C, type UpdateOrderLineItem as D, type UpdateOrderLineItemResponse as E, type PublicActivity as F, type GetPaymentCollectabilityStatusResponse as G, type AddActivityResponse as H, type UpdateActivityIdentifiers as I, type UpdateActivityResponse as J, type DeleteActivityIdentifiers as K, type DeleteActivityResponse as L, type MarkOrderAsPaidResponse as M, type CancelOrderOptions as N, type Order as O, type Price as P, type CancelOrderResponse as Q, type RecordManuallyCollectedPaymentApplicationErrors as R, type SearchOrdersResponse as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type CancelOrderApplicationErrors as W, type OrderStatusWithLiterals as X, type UpdateOrderStatusResponse as Y, type UpdateOrderStatusApplicationErrors as Z, type AggregateOrdersOptions as _, type PreparePaymentCollectionOptions as a, type DescriptionLineName as a$, type BulkUpdateOrderTagsOptions as a0, type BulkUpdateOrderTagsResponse as a1, type OrderApprovedEnvelope as a2, type OrderUpdatedEnvelope as a3, type OrderCanceledEnvelope as a4, type OrderCreatedEnvelope as a5, DescriptionLineType as a6, ItemTypeItemType as a7, PaymentOptionType as a8, JurisdictionType as a9, ActionType as aA, MembershipPaymentStatus as aB, RefundStatus as aC, WebhookIdentityType as aD, TextDetection as aE, AnimationDetection as aF, PreviewEmailType as aG, State as aH, Namespace as aI, SortOrder as aJ, VersioningMode as aK, OrderApprovalStrategy as aL, DeltaPaymentOptionType as aM, InventoryAction as aN, Placement as aO, SubdivisionType as aP, SourceType as aQ, CustomFieldGroup as aR, ValueType as aS, DepositType as aT, InvoiceStatus as aU, type OrderLineItem as aV, type ProductName as aW, type CatalogReference as aX, type DescriptionLine as aY, type DescriptionLineValueOneOf as aZ, type DescriptionLineDescriptionLineValueOneOf as a_, SubscriptionFrequency as aa, AdjustmentType as ab, TaxableAddressType as ac, PaymentStatus as ad, FulfillmentStatus as ae, WeightUnit as af, VatType as ag, PickupMethod as ah, OrderStatus as ai, DiscountType as aj, DiscountReason as ak, LineItemQuantityChangeType as al, ActivityType as am, AttributionSource as an, ChannelType as ao, ScheduledAction as ap, DurationUnit as aq, PaymentCollectabilityStatus as ar, RefundableStatus as as, NonRefundableReason as at, ManuallyRefundableReason as au, RestockType as av, TransactionStatus as aw, AuthorizationCaptureStatus as ax, AuthorizationVoidStatus as ay, Reason as az, type PreparePaymentCollectionResponse as b, type OrderChange as b$, type PlainTextValue as b0, type Color as b1, type FocalPoint as b2, type PhysicalProperties as b3, type ItemType as b4, type ItemTypeItemTypeDataOneOf as b5, type ItemTaxFullDetails as b6, type LineItemTaxInfo as b7, type LineItemTaxBreakdown as b8, type DigitalFile as b9, type DeliveryLogistics as bA, type DeliveryLogisticsAddressOneOf as bB, type PickupDetails as bC, type PickupAddress as bD, type DeliveryTimeSlot as bE, type ShippingPrice as bF, type ShippingRegion as bG, type TaxSummary as bH, type OrderTaxInfo as bI, type OrderTaxBreakdown as bJ, type AppliedDiscount as bK, type AppliedDiscountDiscountSourceOneOf as bL, type Coupon as bM, type MerchantDiscount as bN, type MerchantDiscountMerchantDiscountReasonOneOf as bO, type DiscountRule as bP, type DiscountRuleName as bQ, type LineItemDiscount as bR, type Activity as bS, type ActivityContentOneOf as bT, type CustomActivity as bU, type MerchantComment as bV, type OrderRefunded as bW, type OrderCreatedFromExchange as bX, type NewExchangeOrderCreated as bY, type LineItemExchangeData as bZ, type DraftOrderChangesApplied as b_, type SubscriptionInfo as ba, type SubscriptionTitle as bb, type SubscriptionDescription as bc, type SubscriptionSettings as bd, type FreeTrialPeriod as be, type BillingAdjustment as bf, type BillingAdjustmentPriceSummary as bg, type PriceDescription as bh, type LocationAndQuantity as bi, type TaxableAddress as bj, type TaxableAddressTaxableAddressDataOneOf as bk, type ExtendedFields as bl, type ModifierGroup as bm, type TranslatableString as bn, type ItemModifier as bo, type BuyerInfo as bp, type BuyerInfoIdOneOf as bq, type CurrencyConversionDetails as br, type PriceSummary as bs, type AddressWithContact as bt, type Address as bu, type StreetAddress as bv, type AddressLocation as bw, type FullAddressContactDetails as bx, type VatId as by, type V1ShippingInformation as bz, type PreparePaymentCollectionApplicationErrors as c, type MarkOrderAsPaidRequest as c$, type OrderChangeValueOneOf as c0, type LineItemChanges as c1, type LineItemQuantityChange as c2, type LineItemPriceChange as c3, type ManagedLineItem as c4, type ManagedDiscount as c5, type TranslatedValue as c6, type LineItemAmount as c7, type ManagedAdditionalFee as c8, type TotalPriceChange as c9, type WixReceipt as cA, type ExternalReceipt as cB, type ReceiptSent as cC, type ReceiptSentReceiptInfoOneOf as cD, type CreatedBy as cE, type CreatedByStringOneOf as cF, type ChannelInfo as cG, type CustomField as cH, type BalanceSummary as cI, type Balance as cJ, type AdditionalFee as cK, type FulfillmentStatusesAggregate as cL, type Tags as cM, type TagList as cN, type Location as cO, type OrderApproved as cP, type OrdersExperiments as cQ, type OrderRejectedEventOrderRejected as cR, type OrderItemsRestocked as cS, type V1RestockItem as cT, type PreparePaymentCollectionRequest as cU, type RedirectUrls as cV, type DelayedCaptureSettings as cW, type Duration as cX, type GetPaymentCollectabilityStatusRequest as cY, type RecordManuallyCollectedPaymentRequest as cZ, type RecordManuallyCollectedPaymentResponse as c_, type ShippingInformationChange as ca, type ShippingInformation as cb, type SavedPaymentMethod as cc, type AuthorizedPaymentCreated as cd, type AuthorizedPaymentCaptured as ce, type AuthorizedPaymentVoided as cf, type RefundInitiated as cg, type RefundedPayment as ch, type RefundedPaymentKindOneOf as ci, type RegularPaymentRefund as cj, type GiftCardPaymentRefund as ck, type MembershipPaymentRefund as cl, type PaymentRefunded as cm, type PaymentRefundFailed as cn, type RefundedAsStoreCredit as co, type PaymentPending as cp, type PaymentPendingPaymentDetailsOneOf as cq, type RegularPayment as cr, type RegularPaymentPaymentMethodDetailsOneOf as cs, type CreditCardDetails as ct, type PaymentCanceled as cu, type PaymentCanceledPaymentDetailsOneOf as cv, type PaymentDeclined as cw, type PaymentDeclinedPaymentDetailsOneOf as cx, type ReceiptCreated as cy, type ReceiptCreatedReceiptInfoOneOf as cz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as d, type MessageEnvelope as d$, type BulkMarkOrdersAsPaidRequest as d0, type BulkOrderResult as d1, type ItemMetadata as d2, type ApplicationError as d3, type BulkActionMetadata as d4, type GetRefundabilityStatusRequest as d5, type Refundability as d6, type RefundabilityAdditionalRefundabilityInfoOneOf as d7, type CreatePaymentGatewayOrderRequest as d8, type ChargedBy as d9, type V1ScheduledAction as dA, type GiftCardPaymentDetails as dB, type MembershipPaymentDetails as dC, type WixReceiptInfo as dD, type ExternalReceiptInfo as dE, type Refund as dF, type RefundTransaction as dG, type RefundStatusInfo as dH, type AggregatedRefundSummary as dI, type RefundItemsBreakdown as dJ, type LineItemRefundSummary as dK, type CalculateRefundRequest as dL, type CalculateRefundItemRequest as dM, type CalculateRefundResponse as dN, type CalculateRefundItemResponse as dO, type VoidAuthorizedPaymentsRequest as dP, type CaptureAuthorizedPaymentsRequest as dQ, type ChargeSavedPaymentMethodRequest as dR, type ChargeSavedPaymentMethodResponse as dS, type DomainEvent as dT, type DomainEventBodyOneOf as dU, type EntityCreatedEvent as dV, type RestoreInfo as dW, type EntityUpdatedEvent as dX, type EntityDeletedEvent as dY, type ActionEvent as dZ, type Empty as d_, type ChargeMembershipsRequest as da, type MembershipChargeItem as db, type MembershipName as dc, type ServiceProperties as dd, type ChargeMembershipsResponse as de, type TriggerRefundRequest as df, type RefundDetails as dg, type RefundItem as dh, type LineItemRefund as di, type AdditionalFeeRefund as dj, type ShippingRefund as dk, type RefundSideEffects as dl, type RestockInfo as dm, type RestockItem as dn, type OrderTransactions as dp, type Payment as dq, type PaymentPaymentDetailsOneOf as dr, type PaymentReceiptInfoOneOf as ds, type RegularPaymentDetails as dt, type RegularPaymentDetailsPaymentMethodDetailsOneOf as du, type CreditCardPaymentMethodDetails as dv, type AuthorizationDetails as dw, type AuthorizationCapture as dx, type AuthorizationActionFailureDetails as dy, type AuthorizationVoid as dz, type GetRefundabilityStatusResponse as e, type GetOrderForMetasiteRequest as e$, type IdentificationData as e0, type IdentificationDataIdOneOf as e1, type ImageContent as e2, type SendBuyerConfirmationEmailRequest as e3, type SendBuyerConfirmationEmailResponse as e4, type SendBuyerPaymentsReceivedEmailRequest as e5, type SendBuyerPaymentsReceivedEmailResponse as e6, type SendBuyerPickupConfirmationEmailRequest as e7, type SendBuyerPickupConfirmationEmailResponse as e8, type BulkSendBuyerPickupConfirmationEmailsRequest as e9, type PreviewBuyerPickupConfirmationEmailResponse as eA, type PreviewShippingConfirmationEmailRequest as eB, type PreviewShippingConfirmationEmailResponse as eC, type PreviewResendDownloadLinksEmailRequest as eD, type PreviewResendDownloadLinksEmailResponse as eE, type TriggerReindexOrderRequest as eF, type SnapshotMessage as eG, type PaymentStatusUpdated as eH, type GetMetasiteDataRequest as eI, type GetMetasiteDataResponse as eJ, type MetaSite as eK, type App as eL, type SeoData as eM, type MetaTag as eN, type HtmlApplication as eO, type ExternalUriMapping as eP, type UserDataResponse as eQ, type QueryOrdersForMetasiteRequest as eR, type InternalQueryOrdersRequest as eS, type PlatformQuery as eT, type PlatformQueryPagingMethodOneOf as eU, type Sorting as eV, type PlatformPaging as eW, type CursorPaging as eX, type QueryOrdersForMetasiteResponse as eY, type PlatformPagingMetadata as eZ, type Cursors as e_, type BulkSendBuyerPickupConfirmationEmailsResponse as ea, type SendBuyerShippingConfirmationEmailRequest as eb, type SendBuyerShippingConfirmationEmailResponse as ec, type BulkSendBuyerShippingConfirmationEmailsRequest as ed, type BulkSendBuyerShippingConfirmationEmailsResponse as ee, type SendMerchantOrderReceivedNotificationRequest as ef, type SendMerchantOrderReceivedNotificationResponse as eg, type SendCancelRefundEmailRequest as eh, type SendCancelRefundEmailResponse as ei, type SendRefundEmailRequest as ej, type SendRefundEmailResponse as ek, type SendMerchantOrderReceivedPushRequest as el, type SendMerchantOrderReceivedPushResponse as em, type PreviewEmailByTypeRequest as en, type PreviewEmailByTypeResponse as eo, type PreviewRefundEmailRequest as ep, type PreviewRefundEmailResponse as eq, type PreviewCancelEmailRequest as er, type PreviewCancelEmailResponse as es, type PreviewCancelRefundEmailRequest as et, type PreviewCancelRefundEmailResponse as eu, type PreviewBuyerPaymentsReceivedEmailRequest as ev, type PreviewBuyerPaymentsReceivedEmailResponse as ew, type PreviewBuyerConfirmationEmailRequest as ex, type PreviewBuyerConfirmationEmailResponse as ey, type PreviewBuyerPickupConfirmationEmailRequest as ez, type PaymentCollectionCreatePaymentGatewayOrderOptions as f, type DraftOrderCommitSettings as f$, type GetOrderForMetasiteResponse as f0, type ListOrderTransactionsForMetasiteRequest as f1, type ListOrderTransactionsForMetasiteResponse as f2, type UpsertRefundRequest as f3, type UpsertRefundResponse as f4, type GetOrderOutOfBoxRequest as f5, type GetOrderOutOfBoxResponse as f6, type GetOrderAgcRequest as f7, type GetOrderAgcResponse as f8, type GetOrderWithFilterByLocationRequest as f9, type QueryOrderRequest as fA, type QueryOrderResponse as fB, type SearchOrdersRequest as fC, type CursorSearch as fD, type CursorSearchPagingMethodOneOf as fE, type CursorPagingMetadata as fF, type CreateOrderRequest as fG, type OrderCreationSettings as fH, type OrderCreateNotifications as fI, type CreateOrderResponse as fJ, type UpdateOrderRequest as fK, type UpdateOrderResponse as fL, type BulkUpdateOrdersRequest as fM, type CommitDeltasRequest as fN, type DraftOrderDiffs as fO, type DraftOrderDiffsShippingUpdateInfoOneOf as fP, type DraftOrderDiffsBuyerUpdateInfoOneOf as fQ, type DraftOrderDiffsBillingUpdateInfoOneOf as fR, type DraftOrderDiffsRecipientUpdateInfoOneOf as fS, type V1LineItemDelta as fT, type V1LineItemDeltaDeltaOneOf as fU, type OrderLineItemChangedDetails as fV, type ItemChangedDetails as fW, type AppliedDiscountDelta as fX, type AppliedDiscountDeltaDeltaOneOf as fY, type AdditionalFeeDelta as fZ, type AdditionalFeeDeltaDeltaOneOf as f_, type GetOrderWithFilterByLocationResponse as fa, type V1UpdateOrderRequest as fb, type V1UpdateOrderResponse as fc, type UpdateInternalDocumentsEvent as fd, type UpdateInternalDocumentsEventOperationOneOf as fe, type InternalDocument as ff, type InternalDocumentUpdateOperation as fg, type DeleteByIdsOperation as fh, type DeleteByFilterOperation as fi, type InternalDocumentUpdateByFilterOperation as fj, type InternalUpdateExistingOperation as fk, type VersionedDocumentUpdateOperation as fl, type VersionedDeleteByIdsOperation as fm, type VersionedDocumentId as fn, type TriggerReindexRequest as fo, type TriggerReindexResponse as fp, type BatchOfTriggerReindexOrderRequest as fq, type ChargebackCreated as fr, type ChargebackReversed as fs, type DiffmatokyPayload as ft, type ErrorInformation as fu, type ContinueSideEffectsFlowInLegacyData as fv, type IndexingMessage as fw, type GetOrderRequest as fx, type GetOrderResponse as fy, type InternalQueryOrdersResponse as fz, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as g, type MarkOrderAsSeenByHumanRequest as g$, type InventoryUpdateDetails as g0, type OrderDeltasCommitted as g1, type CommittedDiffs as g2, type CommittedDiffsShippingUpdateInfoOneOf as g3, type LineItemDelta as g4, type LineItemDeltaDeltaOneOf as g5, type ArchiveOrderRequest as g6, type ArchiveOrderResponse as g7, type BulkArchiveOrdersRequest as g8, type BulkArchiveOrdersResponse as g9, type OrderFulfilled as gA, type OrderNotFulfilled as gB, type OrderCanceled as gC, type DownloadLinkSent as gD, type TrackingNumberAdded as gE, type TrackingNumberEdited as gF, type TrackingLinkAdded as gG, type ShippingConfirmationEmailSent as gH, type InvoiceAdded as gI, type InvoiceSent as gJ, type FulfillerEmailSent as gK, type ShippingAddressEdited as gL, type EmailEdited as gM, type PickupReadyEmailSent as gN, type OrderPartiallyPaid as gO, type OrderPending as gP, type OrderRejected as gQ, type AddInternalActivityResponse as gR, type AddActivityRequest as gS, type PublicActivityContentOneOf as gT, type AddActivitiesRequest as gU, type AddActivitiesResponse as gV, type UpdateActivityRequest as gW, type DeleteActivityRequest as gX, type UpdateLineItemsDescriptionLinesRequest as gY, type LineItemUpdate as gZ, type UpdateLineItemsDescriptionLinesResponse as g_, type BulkArchiveOrdersByFilterRequest as ga, type BulkArchiveOrdersByFilterResponse as gb, type UnArchiveOrderRequest as gc, type UnArchiveOrderResponse as gd, type BulkUnArchiveOrdersRequest as ge, type BulkUnArchiveOrdersResponse as gf, type BulkUnArchiveOrdersByFilterRequest as gg, type BulkUnArchiveOrdersByFilterResponse as gh, type UpdateBuyerInfoRequest as gi, type BuyerInfoUpdate as gj, type UpdateBuyerInfoResponse as gk, type UpdateBuyerEmailRequest as gl, type UpdateBuyerEmailResponse as gm, type UpdateOrderShippingAddressRequest as gn, type UpdateOrderShippingAddressResponse as go, type UpdateBillingContactDetailsRequest as gp, type UpdateBillingContactDetailsResponse as gq, type UpdateOrderLineItemRequest as gr, type UpdateOrderLineItemsRequest as gs, type MaskedOrderLineItem as gt, type UpdateOrderLineItemsResponse as gu, type AddInternalActivityRequest as gv, type InternalActivity as gw, type InternalActivityContentOneOf as gx, type OrderPlaced as gy, type OrderPaid as gz, type ChargeMembershipsOptions as h, type ItemizedFee as h$, type MarkOrderAsSeenByHumanResponse as h0, type CancelOrderRequest as h1, type OrderCanceledEventOrderCanceled as h2, type UpdateOrderStatusRequest as h3, type MarkAsFulfilledRequest as h4, type MarkAsFulfilledResponse as h5, type FulfillmentStatusUpdated as h6, type BulkMarkAsFulfilledRequest as h7, type BulkMarkAsFulfilledResponse as h8, type BulkMarkAsFulfilledByFilterRequest as h9, type TaskAction as hA, type TaskActionActionOneOf as hB, type Complete as hC, type Cancel as hD, type Reschedule as hE, type InvoiceSentEvent as hF, type IdAndVersion as hG, type InvoiceFields as hH, type Customer as hI, type Email as hJ, type QuotesAddress as hK, type AddressDescription as hL, type Phone as hM, type Company as hN, type CommonAddress as hO, type CommonAddressStreetOneOf as hP, type Subdivision as hQ, type StandardDetails as hR, type InvoiceDates as hS, type LineItems as hT, type LineItem as hU, type BigDecimalWrapper as hV, type LineItemTax as hW, type Source as hX, type LineItemMetaData as hY, type Locale as hZ, type TotalPrice as h_, type BulkMarkAsFulfilledByFilterResponse as ha, type MarkAsUnfulfilledRequest as hb, type MarkAsUnfulfilledResponse as hc, type BulkMarkAsUnfulfilledRequest as hd, type BulkMarkAsUnfulfilledResponse as he, type BulkMarkAsUnfulfilledByFilterRequest as hf, type BulkMarkAsUnfulfilledByFilterResponse as hg, type BulkSetBusinessLocationRequest as hh, type BulkSetBusinessLocationResponse as hi, type BulkSetBusinessLocationResult as hj, type V1MarkOrderAsPaidRequest as hk, type V1MarkOrderAsPaidResponse as hl, type V1BulkMarkOrdersAsPaidRequest as hm, type V1BulkMarkOrdersAsPaidResponse as hn, type V1CreatePaymentGatewayOrderRequest as ho, type V1CreatePaymentGatewayOrderResponse as hp, type GetShipmentsRequest as hq, type GetShipmentsResponse as hr, type AggregateOrdersRequest as hs, type DecrementItemsQuantityRequest as ht, type DecrementData as hu, type DecrementItemsQuantityResponse as hv, type BulkUpdateOrderTagsRequest as hw, type BulkUpdateOrderTagsResult as hx, type Task as hy, type TaskKey as hz, type PaymentRefund as i, type CustomFieldGroupWithLiterals as i$, type Discount as i0, type DiscountOneDiscountTypeOneOf as i1, type CalculatedTaxes as i2, type CalculatedTax as i3, type Payments as i4, type InvoicesPayment as i5, type MetaData as i6, type InvoiceDynamicPriceTotals as i7, type CustomFieldValue as i8, type Value as i9, type DurationUnitWithLiterals as iA, type PaymentCollectabilityStatusWithLiterals as iB, type RefundableStatusWithLiterals as iC, type NonRefundableReasonWithLiterals as iD, type ManuallyRefundableReasonWithLiterals as iE, type RestockTypeWithLiterals as iF, type TransactionStatusWithLiterals as iG, type AuthorizationCaptureStatusWithLiterals as iH, type AuthorizationVoidStatusWithLiterals as iI, type ReasonWithLiterals as iJ, type ActionTypeWithLiterals as iK, type MembershipPaymentStatusWithLiterals as iL, type RefundStatusWithLiterals as iM, type WebhookIdentityTypeWithLiterals as iN, type TextDetectionWithLiterals as iO, type AnimationDetectionWithLiterals as iP, type PreviewEmailTypeWithLiterals as iQ, type StateWithLiterals as iR, type NamespaceWithLiterals as iS, type SortOrderWithLiterals as iT, type VersioningModeWithLiterals as iU, type OrderApprovalStrategyWithLiterals as iV, type DeltaPaymentOptionTypeWithLiterals as iW, type InventoryActionWithLiterals as iX, type PlacementWithLiterals as iY, type SubdivisionTypeWithLiterals as iZ, type SourceTypeWithLiterals as i_, type Deposit as ia, type TriggerSideEffectsFromLegacyData as ib, type BaseEventMetadata as ic, type EventMetadata as id, type OrderSearchSpec as ie, type DescriptionLineTypeWithLiterals as ig, type ItemTypeItemTypeWithLiterals as ih, type PaymentOptionTypeWithLiterals as ii, type JurisdictionTypeWithLiterals as ij, type SubscriptionFrequencyWithLiterals as ik, type AdjustmentTypeWithLiterals as il, type TaxableAddressTypeWithLiterals as im, type PaymentStatusWithLiterals as io, type FulfillmentStatusWithLiterals as ip, type WeightUnitWithLiterals as iq, type VatTypeWithLiterals as ir, type PickupMethodWithLiterals as is, type DiscountTypeWithLiterals as it, type DiscountReasonWithLiterals as iu, type LineItemQuantityChangeTypeWithLiterals as iv, type ActivityTypeWithLiterals as iw, type AttributionSourceWithLiterals as ix, type ChannelTypeWithLiterals as iy, type ScheduledActionWithLiterals as iz, type TriggerRefundResponse as j, type ValueTypeWithLiterals as j0, type DepositTypeWithLiterals as j1, type InvoiceStatusWithLiterals as j2, onOrderApproved as j3, onOrderUpdated as j4, onOrderCanceled as j5, onOrderCreated as j6, preparePaymentCollection as j7, getPaymentCollectabilityStatus as j8, recordManuallyCollectedPayment as j9, paymentCollectionMarkOrderAsPaid as ja, paymentCollectionBulkMarkOrdersAsPaid as jb, getRefundabilityStatus as jc, paymentCollectionCreatePaymentGatewayOrder as jd, chargeMemberships as je, triggerRefund as jf, voidAuthorizedPayments as jg, captureAuthorizedPayments as jh, getOrder as ji, type CommonSearchWithEntityContext as jj, createOrder as jk, updateOrder as jl, bulkUpdateOrders as jm, commitDeltas as jn, updateOrderLineItem as jo, addActivity as jp, updateActivity as jq, deleteActivity as jr, cancelOrder as js, updateOrderStatus as jt, aggregateOrders as ju, bulkUpdateOrderTags as jv, type TriggerRefundApplicationErrors as k, type VoidAuthorizedPaymentsApplicationErrors as l, type PaymentCapture as m, type CaptureAuthorizedPaymentsResponse as n, type CaptureAuthorizedPaymentsApplicationErrors as o, type GetOrderApplicationErrors as p, type OrderSearch as q, type CreateOrderOptions as r, type CreateOrderApplicationErrors as s, type UpdateOrderApplicationErrors as t, type MaskedOrder as u, type BulkUpdateOrdersOptions as v, type BulkUpdateOrdersResponse as w, type CommitDeltasOptions as x, type CommitDeltasResponse as y, type CommitDeltasApplicationErrors as z };