@wix/auto_sdk_ecom_orders 1.0.108 → 1.0.109

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.
@@ -421,6 +421,16 @@ interface Color {
421
421
  /** HEX or RGB color code for display. */
422
422
  code?: string | null;
423
423
  }
424
+ declare enum DescriptionLineType {
425
+ /** Unrecognized type. */
426
+ UNRECOGNISED = "UNRECOGNISED",
427
+ /** Plain text type. */
428
+ PLAIN_TEXT = "PLAIN_TEXT",
429
+ /** Color type. */
430
+ COLOR = "COLOR"
431
+ }
432
+ /** @enumType */
433
+ type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
424
434
  interface Image {
425
435
  /** WixMedia image ID. */
426
436
  id?: string;
@@ -444,6 +454,16 @@ interface Image {
444
454
  */
445
455
  filename?: string | null;
446
456
  }
457
+ interface FocalPoint {
458
+ /** X-coordinate of the focal point. */
459
+ x?: number;
460
+ /** Y-coordinate of the focal point. */
461
+ y?: number;
462
+ /** crop by height */
463
+ height?: number | null;
464
+ /** crop by width */
465
+ width?: number | null;
466
+ }
447
467
  interface PhysicalProperties {
448
468
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
449
469
  weight?: number | null;
@@ -634,6 +654,34 @@ interface SubscriptionInfo {
634
654
  */
635
655
  chargesDescription?: string | null;
636
656
  }
657
+ interface SubscriptionTitle {
658
+ /**
659
+ * Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
660
+ * @minLength 1
661
+ * @maxLength 150
662
+ */
663
+ original?: string;
664
+ /**
665
+ * Subscription option name translated into the buyer's language.
666
+ *
667
+ * Default: Same as `original`.
668
+ * @minLength 1
669
+ * @maxLength 150
670
+ */
671
+ translated?: string | null;
672
+ }
673
+ interface SubscriptionDescription {
674
+ /**
675
+ * Subscription option description.
676
+ * @maxLength 500
677
+ */
678
+ original?: string;
679
+ /**
680
+ * Translated subscription option description.
681
+ * @maxLength 500
682
+ */
683
+ translated?: string | null;
684
+ }
637
685
  interface SubscriptionSettings {
638
686
  /** Frequency of recurring payment. */
639
687
  frequency?: SubscriptionFrequencyWithLiterals;
@@ -675,6 +723,29 @@ interface FreeTrialPeriod {
675
723
  */
676
724
  interval?: number;
677
725
  }
726
+ interface BillingAdjustment {
727
+ /** The type of adjustment. */
728
+ type?: AdjustmentTypeWithLiterals;
729
+ /** Summary of the prorated adjustment amount. */
730
+ priceSummary?: BillingAdjustmentPriceSummary;
731
+ }
732
+ declare enum AdjustmentType {
733
+ UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
734
+ /** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
735
+ EXTRA_CHARGE = "EXTRA_CHARGE",
736
+ /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
737
+ CREDIT = "CREDIT"
738
+ }
739
+ /** @enumType */
740
+ type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
741
+ interface BillingAdjustmentPriceSummary {
742
+ /** Subtotal of adjustment, before tax. */
743
+ subtotal?: Price;
744
+ /** Tax on adjustment. */
745
+ tax?: Price;
746
+ /** Total price after tax. */
747
+ total?: Price;
748
+ }
678
749
  interface PriceDescription {
679
750
  /**
680
751
  * __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
@@ -1396,6 +1467,15 @@ interface DiscountRuleName {
1396
1467
  */
1397
1468
  translated?: string | null;
1398
1469
  }
1470
+ interface LineItemDiscount {
1471
+ /**
1472
+ * ID of line item the discount applies to.
1473
+ * @format GUID
1474
+ */
1475
+ id?: string;
1476
+ /** Total discount for this line item. */
1477
+ totalDiscount?: Price;
1478
+ }
1399
1479
  interface Activity extends ActivityContentOneOf {
1400
1480
  /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
1401
1481
  customActivity?: CustomActivity;
@@ -1560,6 +1640,39 @@ interface OrderRefunded {
1560
1640
  */
1561
1641
  reason?: string;
1562
1642
  }
1643
+ interface OrderCreatedFromExchange {
1644
+ /**
1645
+ * ID of the original order for which the exchange happened.
1646
+ * @format GUID
1647
+ */
1648
+ originalOrderId?: string;
1649
+ }
1650
+ interface NewExchangeOrderCreated {
1651
+ /**
1652
+ * ID of the new order created as a result of an exchange of items.
1653
+ * @format GUID
1654
+ */
1655
+ exchangeOrderId?: string;
1656
+ /**
1657
+ * IDs of the items that were exchanged.
1658
+ * @minSize 1
1659
+ * @maxSize 300
1660
+ */
1661
+ lineItems?: LineItemExchangeData[];
1662
+ }
1663
+ interface LineItemExchangeData {
1664
+ /**
1665
+ * ID of the exchanged line item.
1666
+ * @format GUID
1667
+ */
1668
+ lineItemId?: string;
1669
+ /**
1670
+ * Line item quantity being exchanged.
1671
+ * @min 1
1672
+ * @max 100000
1673
+ */
1674
+ quantity?: number;
1675
+ }
1563
1676
  interface DraftOrderChangesApplied {
1564
1677
  /** Draft order id. */
1565
1678
  draftOrderId?: string;
@@ -1641,6 +1754,36 @@ interface LineItemPriceChange {
1641
1754
  /** Item price after update. */
1642
1755
  newPrice?: Price;
1643
1756
  }
1757
+ interface LineItemProductNameChange {
1758
+ /** Item product name before update. */
1759
+ originalProductName?: ProductName;
1760
+ /** Item product name after update. */
1761
+ newProductName?: ProductName;
1762
+ }
1763
+ interface LineItemDescriptionLineChange {
1764
+ /**
1765
+ * Description lines that were added to the line item.
1766
+ * @maxSize 20
1767
+ */
1768
+ addedDescriptionLines?: DescriptionLine[];
1769
+ /**
1770
+ * Description lines that were removed from the line item.
1771
+ * @maxSize 20
1772
+ */
1773
+ removedDescriptionLines?: DescriptionLine[];
1774
+ }
1775
+ interface LineItemModifiersChange {
1776
+ /**
1777
+ * Modifier groups that were added to the line item.
1778
+ * @maxSize 10
1779
+ */
1780
+ addedModifierGroups?: ModifierGroup[];
1781
+ /**
1782
+ * Modifier groups that were removed from the line item.
1783
+ * @maxSize 10
1784
+ */
1785
+ removedModifierGroups?: ModifierGroup[];
1786
+ }
1644
1787
  interface ManagedLineItem {
1645
1788
  /**
1646
1789
  * Line item ID.
@@ -2422,6 +2565,10 @@ interface AdditionalFee {
2422
2565
  */
2423
2566
  lineItemIds?: string[];
2424
2567
  }
2568
+ interface FulfillmentStatusesAggregate {
2569
+ /** Unique string values based on Fulfillment entities statuses */
2570
+ statuses?: string[] | null;
2571
+ }
2425
2572
  /**
2426
2573
  * Common object for tags.
2427
2574
  * Should be use as in this example:
@@ -2473,6 +2620,192 @@ interface Location {
2473
2620
  */
2474
2621
  name?: string;
2475
2622
  }
2623
+ /** Triggered when the order status changes to approved */
2624
+ interface OrderApproved {
2625
+ /** The order that was updated */
2626
+ order?: Order;
2627
+ }
2628
+ interface OrdersExperiments {
2629
+ epCommitTax?: boolean;
2630
+ moveMerchantEmailToEp?: boolean;
2631
+ moveBuyerOrderConfirmationEmailToEp?: boolean;
2632
+ producedByEpBridge?: boolean;
2633
+ enableRewrittenSideEffects?: boolean;
2634
+ }
2635
+ interface OrderRejectedEventOrderRejected {
2636
+ /** The order that was rejected */
2637
+ order?: Order;
2638
+ }
2639
+ /** Triggered when order items are marked as restocked */
2640
+ interface OrderItemsRestocked {
2641
+ /** The order which items were restocked */
2642
+ order?: Order;
2643
+ /** Restocked items and quantities */
2644
+ restockItems?: V1RestockItem[];
2645
+ }
2646
+ interface V1RestockItem {
2647
+ /**
2648
+ * ID of the line item being restocked.
2649
+ * @format GUID
2650
+ */
2651
+ lineItemId?: string;
2652
+ /**
2653
+ * Line item quantity being restocked.
2654
+ * @min 1
2655
+ * @max 100000
2656
+ */
2657
+ quantity?: number;
2658
+ }
2659
+ interface SendBuyerConfirmationEmailRequest {
2660
+ /** @format GUID */
2661
+ orderId?: string;
2662
+ }
2663
+ interface SendBuyerConfirmationEmailResponse {
2664
+ }
2665
+ interface SendBuyerPaymentsReceivedEmailRequest {
2666
+ /**
2667
+ * @minLength 1
2668
+ * @maxLength 100
2669
+ */
2670
+ orderId?: string;
2671
+ }
2672
+ interface SendBuyerPaymentsReceivedEmailResponse {
2673
+ }
2674
+ interface SendBuyerPickupConfirmationEmailRequest {
2675
+ /**
2676
+ * @minLength 1
2677
+ * @maxLength 100
2678
+ */
2679
+ orderId?: string;
2680
+ }
2681
+ interface SendBuyerPickupConfirmationEmailResponse {
2682
+ }
2683
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
2684
+ /**
2685
+ * IDs of orders to send pickup emails for.
2686
+ * @minSize 1
2687
+ * @maxSize 300
2688
+ */
2689
+ orderIds?: string[];
2690
+ }
2691
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
2692
+ }
2693
+ interface SendBuyerShippingConfirmationEmailRequest {
2694
+ /**
2695
+ * @minLength 1
2696
+ * @maxLength 100
2697
+ */
2698
+ orderId?: string;
2699
+ }
2700
+ interface SendBuyerShippingConfirmationEmailResponse {
2701
+ }
2702
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
2703
+ /**
2704
+ * IDs of orders to send pickup emails for.
2705
+ * @minSize 1
2706
+ * @maxSize 300
2707
+ */
2708
+ orderIds?: string[];
2709
+ }
2710
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
2711
+ }
2712
+ interface SendMerchantOrderReceivedNotificationRequest {
2713
+ /**
2714
+ * @minLength 1
2715
+ * @maxLength 100
2716
+ */
2717
+ orderId?: string;
2718
+ }
2719
+ interface SendMerchantOrderReceivedNotificationResponse {
2720
+ }
2721
+ interface SendCancelRefundEmailRequest {
2722
+ /**
2723
+ * The ID of order that is canceled/refunded
2724
+ * @minLength 1
2725
+ * @maxLength 100
2726
+ */
2727
+ orderId?: string;
2728
+ /**
2729
+ * Personal note added to the email (optional)
2730
+ * @minLength 1
2731
+ * @maxLength 1000
2732
+ */
2733
+ customMessage?: string | null;
2734
+ /** Refund amount */
2735
+ refundAmount?: Price;
2736
+ /**
2737
+ * Refund ID. (Optional)
2738
+ * @format GUID
2739
+ */
2740
+ refundId?: string | null;
2741
+ }
2742
+ interface SendCancelRefundEmailResponse {
2743
+ }
2744
+ interface SendRefundEmailRequest {
2745
+ /**
2746
+ * The ID of order that is refunded
2747
+ * @format GUID
2748
+ */
2749
+ orderId?: string;
2750
+ /**
2751
+ * Refund ID
2752
+ * @format GUID
2753
+ */
2754
+ refundId?: string;
2755
+ /**
2756
+ * Personal note added to the email (optional)
2757
+ * @minLength 1
2758
+ * @maxLength 1000
2759
+ */
2760
+ customMessage?: string | null;
2761
+ }
2762
+ interface SendRefundEmailResponse {
2763
+ }
2764
+ interface SendMerchantOrderReceivedPushRequest {
2765
+ /**
2766
+ * @minLength 1
2767
+ * @maxLength 100
2768
+ */
2769
+ orderId?: string;
2770
+ }
2771
+ interface SendMerchantOrderReceivedPushResponse {
2772
+ }
2773
+ interface PreviewEmailByTypeRequest {
2774
+ emailType?: PreviewEmailTypeWithLiterals;
2775
+ }
2776
+ declare enum PreviewEmailType {
2777
+ ORDER_PLACED = "ORDER_PLACED",
2778
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
2779
+ ORDER_SHIPPED = "ORDER_SHIPPED",
2780
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
2781
+ }
2782
+ /** @enumType */
2783
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
2784
+ interface PreviewEmailByTypeResponse {
2785
+ emailPreview?: string;
2786
+ }
2787
+ interface PreviewRefundEmailRequest {
2788
+ /**
2789
+ * @minLength 1
2790
+ * @maxLength 100
2791
+ */
2792
+ orderId?: string;
2793
+ /** Refund amount */
2794
+ refundAmount?: Price;
2795
+ /** Refund business details */
2796
+ details?: RefundDetails;
2797
+ /**
2798
+ * Personal note added to the email (optional)
2799
+ * @minLength 1
2800
+ * @maxLength 1000
2801
+ */
2802
+ customMessage?: string | null;
2803
+ /**
2804
+ * Refund ID. (Optional)
2805
+ * @format GUID
2806
+ */
2807
+ refundId?: string | null;
2808
+ }
2476
2809
  /** Business model of a refund request */
2477
2810
  interface RefundDetails {
2478
2811
  /**
@@ -2548,53 +2881,280 @@ interface ShippingRefund {
2548
2881
  */
2549
2882
  amount?: Price;
2550
2883
  }
2551
- interface PreparePaymentCollectionRequest {
2884
+ interface PreviewRefundEmailResponse {
2885
+ emailPreview?: string;
2886
+ }
2887
+ interface PreviewCancelEmailRequest {
2552
2888
  /**
2553
- * Ecom order ID.
2554
2889
  * @minLength 1
2555
2890
  * @maxLength 100
2556
2891
  */
2557
- ecomOrderId: string;
2558
- /** Amount to collect */
2559
- amount: Price;
2892
+ orderId?: string;
2560
2893
  /**
2561
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
2562
- * Existing payment gateway order will be updated with a new amount.
2563
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
2894
+ * Personal note added to the email (optional)
2895
+ * @minLength 1
2896
+ * @maxLength 1000
2564
2897
  */
2565
- paymentGatewayOrderId?: string | null;
2898
+ customMessage?: string | null;
2899
+ }
2900
+ interface PreviewCancelEmailResponse {
2901
+ emailPreview?: string;
2902
+ }
2903
+ interface PreviewCancelRefundEmailRequest {
2566
2904
  /**
2567
- * Whether to delay capture of the payment.
2568
- * Default: false
2569
- * @deprecated Whether to delay capture of the payment.
2570
- * Default: false
2571
- * @replacedBy delayed_capture_settings.scheduled_action
2572
- * @targetRemovalDate 2024-09-30
2905
+ * @minLength 1
2906
+ * @maxLength 100
2573
2907
  */
2574
- delayedCapture?: boolean;
2575
- /** Delayed capture payment settings */
2576
- delayedCaptureSettings?: DelayedCaptureSettings;
2908
+ orderId?: string;
2909
+ /**
2910
+ * Personal note added to the email (optional)
2911
+ * @minLength 1
2912
+ * @maxLength 1000
2913
+ */
2914
+ customMessage?: string | null;
2915
+ /** Refund amount */
2916
+ refundAmount?: Price;
2917
+ /**
2918
+ * Refund ID. (Optional)
2919
+ * @format GUID
2920
+ */
2921
+ refundId?: string | null;
2577
2922
  }
2578
- interface DelayedCaptureSettings {
2579
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
2580
- scheduledAction?: ScheduledActionWithLiterals;
2581
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
2582
- delayDuration?: Duration;
2923
+ interface PreviewCancelRefundEmailResponse {
2924
+ emailPreview?: string;
2583
2925
  }
2584
- declare enum ScheduledAction {
2585
- UNSPECIFIED = "UNSPECIFIED",
2586
- /** Whether payment will be auto-voided when duration passes */
2587
- VOID = "VOID",
2588
- /** Whether payment will be auto-captured when duration passes */
2589
- CAPTURE = "CAPTURE"
2926
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
2590
2927
  }
2591
- /** @enumType */
2592
- type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
2593
- interface Duration {
2594
- /**
2595
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
2596
- * @min 1
2597
- */
2928
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
2929
+ emailPreview?: string;
2930
+ }
2931
+ interface PreviewBuyerConfirmationEmailRequest {
2932
+ }
2933
+ interface PreviewBuyerConfirmationEmailResponse {
2934
+ emailPreview?: string;
2935
+ }
2936
+ interface PreviewBuyerPickupConfirmationEmailRequest {
2937
+ }
2938
+ interface PreviewBuyerPickupConfirmationEmailResponse {
2939
+ emailPreview?: string;
2940
+ }
2941
+ interface PreviewShippingConfirmationEmailRequest {
2942
+ }
2943
+ interface PreviewShippingConfirmationEmailResponse {
2944
+ emailPreview?: string;
2945
+ }
2946
+ interface PreviewResendDownloadLinksEmailRequest {
2947
+ }
2948
+ interface PreviewResendDownloadLinksEmailResponse {
2949
+ emailPreview?: string;
2950
+ }
2951
+ interface DomainEvent extends DomainEventBodyOneOf {
2952
+ createdEvent?: EntityCreatedEvent;
2953
+ updatedEvent?: EntityUpdatedEvent;
2954
+ deletedEvent?: EntityDeletedEvent;
2955
+ actionEvent?: ActionEvent;
2956
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2957
+ id?: string;
2958
+ /**
2959
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2960
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2961
+ */
2962
+ entityFqdn?: string;
2963
+ /**
2964
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2965
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2966
+ */
2967
+ slug?: string;
2968
+ /** ID of the entity associated with the event. */
2969
+ entityId?: string;
2970
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2971
+ eventTime?: Date | null;
2972
+ /**
2973
+ * Whether the event was triggered as a result of a privacy regulation application
2974
+ * (for example, GDPR).
2975
+ */
2976
+ triggeredByAnonymizeRequest?: boolean | null;
2977
+ /** If present, indicates the action that triggered the event. */
2978
+ originatedFrom?: string | null;
2979
+ /**
2980
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2981
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2982
+ */
2983
+ entityEventSequence?: string | null;
2984
+ }
2985
+ /** @oneof */
2986
+ interface DomainEventBodyOneOf {
2987
+ createdEvent?: EntityCreatedEvent;
2988
+ updatedEvent?: EntityUpdatedEvent;
2989
+ deletedEvent?: EntityDeletedEvent;
2990
+ actionEvent?: ActionEvent;
2991
+ }
2992
+ interface EntityCreatedEvent {
2993
+ entityAsJson?: string;
2994
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2995
+ restoreInfo?: RestoreInfo;
2996
+ }
2997
+ interface RestoreInfo {
2998
+ deletedDate?: Date | null;
2999
+ }
3000
+ interface EntityUpdatedEvent {
3001
+ /**
3002
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3003
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3004
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3005
+ */
3006
+ currentEntityAsJson?: string;
3007
+ }
3008
+ interface EntityDeletedEvent {
3009
+ /** Entity that was deleted. */
3010
+ deletedEntityAsJson?: string | null;
3011
+ }
3012
+ interface ActionEvent {
3013
+ bodyAsJson?: string;
3014
+ }
3015
+ interface Empty {
3016
+ }
3017
+ interface MessageEnvelope {
3018
+ /**
3019
+ * App instance ID.
3020
+ * @format GUID
3021
+ */
3022
+ instanceId?: string | null;
3023
+ /**
3024
+ * Event type.
3025
+ * @maxLength 150
3026
+ */
3027
+ eventType?: string;
3028
+ /** The identification type and identity data. */
3029
+ identity?: IdentificationData;
3030
+ /** Stringify payload. */
3031
+ data?: string;
3032
+ }
3033
+ interface IdentificationData extends IdentificationDataIdOneOf {
3034
+ /**
3035
+ * ID of a site visitor that has not logged in to the site.
3036
+ * @format GUID
3037
+ */
3038
+ anonymousVisitorId?: string;
3039
+ /**
3040
+ * ID of a site visitor that has logged in to the site.
3041
+ * @format GUID
3042
+ */
3043
+ memberId?: string;
3044
+ /**
3045
+ * ID of a Wix user (site owner, contributor, etc.).
3046
+ * @format GUID
3047
+ */
3048
+ wixUserId?: string;
3049
+ /**
3050
+ * ID of an app.
3051
+ * @format GUID
3052
+ */
3053
+ appId?: string;
3054
+ /** @readonly */
3055
+ identityType?: WebhookIdentityTypeWithLiterals;
3056
+ }
3057
+ /** @oneof */
3058
+ interface IdentificationDataIdOneOf {
3059
+ /**
3060
+ * ID of a site visitor that has not logged in to the site.
3061
+ * @format GUID
3062
+ */
3063
+ anonymousVisitorId?: string;
3064
+ /**
3065
+ * ID of a site visitor that has logged in to the site.
3066
+ * @format GUID
3067
+ */
3068
+ memberId?: string;
3069
+ /**
3070
+ * ID of a Wix user (site owner, contributor, etc.).
3071
+ * @format GUID
3072
+ */
3073
+ wixUserId?: string;
3074
+ /**
3075
+ * ID of an app.
3076
+ * @format GUID
3077
+ */
3078
+ appId?: string;
3079
+ }
3080
+ declare enum WebhookIdentityType {
3081
+ UNKNOWN = "UNKNOWN",
3082
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3083
+ MEMBER = "MEMBER",
3084
+ WIX_USER = "WIX_USER",
3085
+ APP = "APP"
3086
+ }
3087
+ /** @enumType */
3088
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3089
+ interface PreparePaymentCollectionRequest {
3090
+ /**
3091
+ * Ecom order ID.
3092
+ * @minLength 1
3093
+ * @maxLength 100
3094
+ */
3095
+ ecomOrderId: string;
3096
+ /** Amount to collect */
3097
+ amount: Price;
3098
+ /**
3099
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
3100
+ * Existing payment gateway order will be updated with a new amount.
3101
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
3102
+ */
3103
+ paymentGatewayOrderId?: string | null;
3104
+ /**
3105
+ * Whether to delay capture of the payment.
3106
+ * Default: false
3107
+ * @deprecated Whether to delay capture of the payment.
3108
+ * Default: false
3109
+ * @replacedBy delayed_capture_settings.scheduled_action
3110
+ * @targetRemovalDate 2024-09-30
3111
+ */
3112
+ delayedCapture?: boolean;
3113
+ /** Delayed capture payment settings */
3114
+ delayedCaptureSettings?: DelayedCaptureSettings;
3115
+ }
3116
+ interface RedirectUrls {
3117
+ /**
3118
+ * URL to redirect buyer in case of approved (successful) transaction
3119
+ * @format WEB_URL
3120
+ */
3121
+ successUrl?: string | null;
3122
+ /**
3123
+ * URL to redirect buyer in case of buyer canceled the transaction
3124
+ * @format WEB_URL
3125
+ */
3126
+ cancelUrl?: string | null;
3127
+ /**
3128
+ * URL to redirect buyer in case of failed/rejected transaction
3129
+ * @format WEB_URL
3130
+ */
3131
+ errorUrl?: string | null;
3132
+ /**
3133
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
3134
+ * @format WEB_URL
3135
+ */
3136
+ pendingUrl?: string | null;
3137
+ }
3138
+ interface DelayedCaptureSettings {
3139
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
3140
+ scheduledAction?: ScheduledActionWithLiterals;
3141
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
3142
+ delayDuration?: Duration;
3143
+ }
3144
+ declare enum ScheduledAction {
3145
+ UNSPECIFIED = "UNSPECIFIED",
3146
+ /** Whether payment will be auto-voided when duration passes */
3147
+ VOID = "VOID",
3148
+ /** Whether payment will be auto-captured when duration passes */
3149
+ CAPTURE = "CAPTURE"
3150
+ }
3151
+ /** @enumType */
3152
+ type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
3153
+ interface Duration {
3154
+ /**
3155
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
3156
+ * @min 1
3157
+ */
2598
3158
  count?: number;
2599
3159
  /** Duration unit: MINUTES, HOURS and DAYS */
2600
3160
  unit?: DurationUnitWithLiterals;
@@ -3274,6 +3834,79 @@ interface GiftCardPaymentDetails {
3274
3834
  */
3275
3835
  voided?: boolean;
3276
3836
  }
3837
+ interface MembershipPaymentDetails {
3838
+ /**
3839
+ * Membership ID.
3840
+ * @minLength 1
3841
+ * @maxLength 100
3842
+ */
3843
+ membershipId?: string;
3844
+ /**
3845
+ * ID of the line item this membership applies to.
3846
+ * @minLength 1
3847
+ * @maxLength 100
3848
+ */
3849
+ lineItemId?: string;
3850
+ /** Payment status. */
3851
+ status?: MembershipPaymentStatusWithLiterals;
3852
+ /** Membership name. */
3853
+ name?: MembershipName;
3854
+ /**
3855
+ * The transaction ID in the membership system. Can be used to void the transaction.
3856
+ * @minLength 1
3857
+ * @maxLength 100
3858
+ */
3859
+ externalTransactionId?: string | null;
3860
+ /**
3861
+ * Whether the membership is voided.
3862
+ * @readonly
3863
+ */
3864
+ voided?: boolean;
3865
+ /**
3866
+ * ID of the application providing this payment option.
3867
+ * @format GUID
3868
+ */
3869
+ providerAppId?: string;
3870
+ }
3871
+ declare enum MembershipPaymentStatus {
3872
+ /** Payment was charged. */
3873
+ CHARGED = "CHARGED",
3874
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
3875
+ CHARGE_FAILED = "CHARGE_FAILED"
3876
+ }
3877
+ /** @enumType */
3878
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
3879
+ interface WixReceiptInfo {
3880
+ /**
3881
+ * Receipt ID
3882
+ * @format GUID
3883
+ */
3884
+ receiptId?: string;
3885
+ /**
3886
+ * Display number of receipt
3887
+ * @minLength 1
3888
+ * @maxLength 40
3889
+ */
3890
+ displayNumber?: string | null;
3891
+ }
3892
+ interface ExternalReceiptInfo {
3893
+ /**
3894
+ * External receipt ID
3895
+ * @maxLength 100
3896
+ */
3897
+ receiptId?: string | null;
3898
+ /**
3899
+ * ID of the app providing the receipt
3900
+ * @format GUID
3901
+ */
3902
+ appId?: string | null;
3903
+ /**
3904
+ * Display number of receipt
3905
+ * @minLength 1
3906
+ * @maxLength 40
3907
+ */
3908
+ displayNumber?: string | null;
3909
+ }
3277
3910
  interface Refund {
3278
3911
  /**
3279
3912
  * Refund ID.
@@ -3398,6 +4031,62 @@ interface LineItemRefundSummary {
3398
4031
  /** Total refunded amount for the line item. */
3399
4032
  totalRefundedAmount?: Price;
3400
4033
  }
4034
+ interface CalculateRefundRequest {
4035
+ /**
4036
+ * Order ID
4037
+ * @minLength 1
4038
+ * @maxLength 100
4039
+ */
4040
+ ecomOrderId?: string;
4041
+ /**
4042
+ * Refunded line items and quantity
4043
+ * @maxSize 300
4044
+ */
4045
+ refundItems?: CalculateRefundItemRequest[];
4046
+ /** Should include shipping in refund calculation */
4047
+ refundShipping?: boolean;
4048
+ }
4049
+ interface CalculateRefundItemRequest {
4050
+ /**
4051
+ * ID of the line item being refunded
4052
+ * @format GUID
4053
+ */
4054
+ id?: string;
4055
+ /**
4056
+ * How much of that line item is being refunded
4057
+ * @min 1
4058
+ * @max 100000
4059
+ */
4060
+ quantity?: number;
4061
+ }
4062
+ interface CalculateRefundResponse {
4063
+ /** Total refundable amount */
4064
+ total?: Price;
4065
+ /** Tax cost of the order */
4066
+ tax?: Price;
4067
+ /** Discount given for this order */
4068
+ discount?: Price;
4069
+ /** Total cost of the order (without tax) */
4070
+ subtotal?: Price;
4071
+ /** Total shipping cost for order */
4072
+ shipping?: Price;
4073
+ /** Previous refund given on that order */
4074
+ previouslyRefundedAmount?: Price;
4075
+ /**
4076
+ * The refundable items of that order
4077
+ * @maxSize 300
4078
+ */
4079
+ items?: CalculateRefundItemResponse[];
4080
+ }
4081
+ interface CalculateRefundItemResponse {
4082
+ /**
4083
+ * Line item ID
4084
+ * @format GUID
4085
+ */
4086
+ id?: string;
4087
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
4088
+ price?: Price;
4089
+ }
3401
4090
  interface VoidAuthorizedPaymentsRequest {
3402
4091
  /**
3403
4092
  * Wix eCommerce order ID
@@ -3447,47 +4136,292 @@ interface CaptureAuthorizedPaymentsResponse {
3447
4136
  /** All order's transactions after the capture was triggered */
3448
4137
  orderTransactions?: OrderTransactions;
3449
4138
  }
3450
- interface GetOrderRequest {
4139
+ interface ChargeSavedPaymentMethodRequest {
3451
4140
  /**
3452
- * ID of the order to retrieve.
4141
+ * Ecom Order ID.
3453
4142
  * @minLength 1
3454
4143
  * @maxLength 100
3455
4144
  */
3456
- id: string;
4145
+ ecomOrderId?: string;
4146
+ /** Amount to be charged */
4147
+ amount?: Price;
3457
4148
  }
3458
- interface GetOrderResponse {
3459
- /** The requested order. */
3460
- order?: Order;
4149
+ interface ChargeSavedPaymentMethodResponse {
4150
+ /** Payment gateway's order ID (e.g Wix Payments) */
4151
+ paymentGatewayOrderId?: string;
3461
4152
  }
3462
- interface Sorting {
4153
+ interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
4154
+ /** insert/update documents */
4155
+ update?: InternalDocumentUpdateOperation;
4156
+ /** delete by document ids */
4157
+ deleteByIds?: DeleteByIdsOperation;
4158
+ /** delete documents matching filter */
4159
+ deleteByFilter?: DeleteByFilterOperation;
4160
+ /** update internal documents matching filter */
4161
+ updateByFilter?: InternalDocumentUpdateByFilterOperation;
4162
+ /** update only existing documents */
4163
+ updateExisting?: InternalUpdateExistingOperation;
4164
+ /** insert/update documents with versioning */
4165
+ versionedUpdate?: VersionedDocumentUpdateOperation;
4166
+ /** delete by document ids with versioning */
4167
+ versionedDeleteByIds?: VersionedDeleteByIdsOperation;
4168
+ /**
4169
+ * type of the documents
4170
+ * @minLength 2
4171
+ */
4172
+ documentType?: string;
4173
+ /**
4174
+ * language of the documents (mandatory)
4175
+ * @minLength 2
4176
+ */
4177
+ language?: string | null;
4178
+ /**
4179
+ * one or more search documents
4180
+ * @deprecated
4181
+ */
4182
+ addDocuments?: InternalDocument[];
3463
4183
  /**
3464
- * Name of the field to sort by.
3465
- * @maxLength 512
4184
+ * one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
4185
+ * @deprecated
3466
4186
  */
3467
- fieldName?: string;
3468
- /** Sort order. */
3469
- order?: SortOrderWithLiterals;
4187
+ removeDocumentIds?: string[];
4188
+ /** id to pass to processing notification */
4189
+ correlationId?: string | null;
4190
+ /** when event was created / issued */
4191
+ issuedAt?: Date | null;
3470
4192
  }
3471
- declare enum SortOrder {
3472
- ASC = "ASC",
3473
- DESC = "DESC"
4193
+ /** @oneof */
4194
+ interface UpdateInternalDocumentsEventOperationOneOf {
4195
+ /** insert/update documents */
4196
+ update?: InternalDocumentUpdateOperation;
4197
+ /** delete by document ids */
4198
+ deleteByIds?: DeleteByIdsOperation;
4199
+ /** delete documents matching filter */
4200
+ deleteByFilter?: DeleteByFilterOperation;
4201
+ /** update internal documents matching filter */
4202
+ updateByFilter?: InternalDocumentUpdateByFilterOperation;
4203
+ /** update only existing documents */
4204
+ updateExisting?: InternalUpdateExistingOperation;
4205
+ /** insert/update documents with versioning */
4206
+ versionedUpdate?: VersionedDocumentUpdateOperation;
4207
+ /** delete by document ids with versioning */
4208
+ versionedDeleteByIds?: VersionedDeleteByIdsOperation;
4209
+ }
4210
+ interface InternalDocument {
4211
+ /** document with mandatory fields (id) and with fields specific to the type of the document */
4212
+ document?: Record<string, any> | null;
4213
+ }
4214
+ interface InternalDocumentUpdateOperation {
4215
+ /** documents to index or update */
4216
+ documents?: InternalDocument[];
4217
+ }
4218
+ interface DeleteByIdsOperation {
4219
+ /** ids of the documents to delete */
4220
+ documentIds?: string[];
4221
+ /**
4222
+ * tenant id for custom tenancy strategy
4223
+ * @minLength 2
4224
+ * @maxLength 300
4225
+ */
4226
+ tenantId?: string | null;
3474
4227
  }
3475
- /** @enumType */
3476
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
3477
- interface CursorPaging {
4228
+ interface DeleteByFilterOperation {
4229
+ /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
4230
+ filter?: Record<string, any> | null;
3478
4231
  /**
3479
- * Maximum number of items to return in the results.
3480
- * @max 100
4232
+ * tenant id for custom tenancy strategy
4233
+ * @minLength 2
4234
+ * @maxLength 300
3481
4235
  */
3482
- limit?: number | null;
4236
+ tenantId?: string | null;
4237
+ }
4238
+ interface InternalDocumentUpdateByFilterOperation {
4239
+ /** documents matching this filter will be updated */
4240
+ filter?: Record<string, any> | null;
4241
+ /** partial document to apply */
4242
+ document?: InternalDocument;
3483
4243
  /**
3484
- * Pointer to the next or previous page in the list of results.
3485
- *
3486
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
3487
- * Not relevant for the first request.
3488
- * @maxLength 16000
4244
+ * tenant id for custom tenancy strategy
4245
+ * @minLength 2
4246
+ * @maxLength 300
3489
4247
  */
3490
- cursor?: string | null;
4248
+ tenantId?: string | null;
4249
+ }
4250
+ interface InternalUpdateExistingOperation {
4251
+ /** documents to update */
4252
+ documents?: InternalDocument[];
4253
+ }
4254
+ interface VersionedDocumentUpdateOperation {
4255
+ /** documents to create or overwrite */
4256
+ documents?: InternalDocument[];
4257
+ /** versioning mode to use instead of default */
4258
+ versioningMode?: VersioningModeWithLiterals;
4259
+ }
4260
+ declare enum VersioningMode {
4261
+ /** use default versioning mode agreed with search team */
4262
+ DEFAULT = "DEFAULT",
4263
+ /** execute only if version is greater than existing */
4264
+ GREATER_THAN = "GREATER_THAN",
4265
+ /** execute only if version is greater or equal to existing */
4266
+ GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
4267
+ }
4268
+ /** @enumType */
4269
+ type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
4270
+ interface VersionedDeleteByIdsOperation {
4271
+ /** ids with version of the documents to delete */
4272
+ documentIds?: VersionedDocumentId[];
4273
+ /**
4274
+ * tenant id for custom tenancy strategy
4275
+ * @minLength 2
4276
+ * @maxLength 300
4277
+ */
4278
+ tenantId?: string | null;
4279
+ }
4280
+ interface VersionedDocumentId {
4281
+ /** document id */
4282
+ documentId?: string;
4283
+ /** document version */
4284
+ version?: string;
4285
+ /** versioning mode to use instead of default */
4286
+ versioningMode?: VersioningModeWithLiterals;
4287
+ }
4288
+ interface TriggerReindexRequest {
4289
+ /** @format GUID */
4290
+ metasiteId?: string;
4291
+ /**
4292
+ * @minLength 1
4293
+ * @maxLength 100
4294
+ * @maxSize 100
4295
+ */
4296
+ orderIds?: string[];
4297
+ }
4298
+ interface TriggerReindexResponse {
4299
+ }
4300
+ interface BatchOfTriggerReindexOrderRequest {
4301
+ /** @maxSize 25 */
4302
+ requests?: TriggerReindexOrderRequest[];
4303
+ }
4304
+ interface TriggerReindexOrderRequest {
4305
+ /** @format GUID */
4306
+ metasiteId?: string;
4307
+ /**
4308
+ * @minLength 1
4309
+ * @maxLength 100
4310
+ */
4311
+ orderId?: string;
4312
+ }
4313
+ interface DiffmatokyPayload {
4314
+ left?: string;
4315
+ right?: string;
4316
+ compareChannel?: string;
4317
+ entityId?: string;
4318
+ errorInformation?: ErrorInformation;
4319
+ tags?: string[];
4320
+ }
4321
+ interface ErrorInformation {
4322
+ stackTrace?: string;
4323
+ }
4324
+ interface ContinueSideEffectsFlowInLegacyData {
4325
+ storeId?: string;
4326
+ orderId?: string;
4327
+ ordersExperiments?: OrdersExperiments;
4328
+ }
4329
+ interface SnapshotMessage {
4330
+ id?: string;
4331
+ opType?: number;
4332
+ }
4333
+ interface IndexingMessage {
4334
+ id?: string;
4335
+ opType?: number;
4336
+ requiredVersions?: string[];
4337
+ }
4338
+ interface GetOrderRequest {
4339
+ /**
4340
+ * ID of the order to retrieve.
4341
+ * @minLength 1
4342
+ * @maxLength 100
4343
+ */
4344
+ id: string;
4345
+ }
4346
+ interface GetOrderResponse {
4347
+ /** The requested order. */
4348
+ order?: Order;
4349
+ }
4350
+ interface InternalQueryOrdersRequest {
4351
+ /** Query options. */
4352
+ query?: PlatformQuery;
4353
+ }
4354
+ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
4355
+ /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
4356
+ paging?: PlatformPaging;
4357
+ /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
4358
+ cursorPaging?: CursorPaging;
4359
+ /** Filter object. */
4360
+ filter?: Record<string, any> | null;
4361
+ /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
4362
+ sort?: Sorting[];
4363
+ }
4364
+ /** @oneof */
4365
+ interface PlatformQueryPagingMethodOneOf {
4366
+ /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
4367
+ paging?: PlatformPaging;
4368
+ /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
4369
+ cursorPaging?: CursorPaging;
4370
+ }
4371
+ interface Sorting {
4372
+ /**
4373
+ * Name of the field to sort by.
4374
+ * @maxLength 512
4375
+ */
4376
+ fieldName?: string;
4377
+ /** Sort order. */
4378
+ order?: SortOrderWithLiterals;
4379
+ }
4380
+ declare enum SortOrder {
4381
+ ASC = "ASC",
4382
+ DESC = "DESC"
4383
+ }
4384
+ /** @enumType */
4385
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
4386
+ interface PlatformPaging {
4387
+ /**
4388
+ * Number of items to load.
4389
+ * @max 100
4390
+ */
4391
+ limit?: number | null;
4392
+ /** Number of items to skip in the current sort order. */
4393
+ offset?: number | null;
4394
+ }
4395
+ interface CursorPaging {
4396
+ /**
4397
+ * Maximum number of items to return in the results.
4398
+ * @max 100
4399
+ */
4400
+ limit?: number | null;
4401
+ /**
4402
+ * Pointer to the next or previous page in the list of results.
4403
+ *
4404
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
4405
+ * Not relevant for the first request.
4406
+ * @maxLength 16000
4407
+ */
4408
+ cursor?: string | null;
4409
+ }
4410
+ interface InternalQueryOrdersResponse {
4411
+ /** List of orders. */
4412
+ orders?: Order[];
4413
+ /** Details on the paged set of results returned. */
4414
+ metadata?: PlatformPagingMetadata;
4415
+ }
4416
+ interface PlatformPagingMetadata {
4417
+ /** The number of items returned in this response. */
4418
+ count?: number | null;
4419
+ /** The offset which was requested. Returned if offset paging was used. */
4420
+ offset?: number | null;
4421
+ /** The total number of items that match the query. Returned if offset paging was used. */
4422
+ total?: number | null;
4423
+ /** Cursors to navigate through result pages. Returned if cursor paging was used. */
4424
+ cursors?: Cursors;
3491
4425
  }
3492
4426
  interface Cursors {
3493
4427
  /**
@@ -3501,6 +4435,16 @@ interface Cursors {
3501
4435
  */
3502
4436
  prev?: string | null;
3503
4437
  }
4438
+ interface QueryOrderRequest {
4439
+ /** Query options. */
4440
+ query?: PlatformQuery;
4441
+ }
4442
+ interface QueryOrderResponse {
4443
+ /** List of orders. */
4444
+ orders?: Order[];
4445
+ /** Details on the paged set of results returned. */
4446
+ metadata?: PlatformPagingMetadata;
4447
+ }
3504
4448
  interface SearchOrdersRequest {
3505
4449
  /** Search options. */
3506
4450
  search?: CursorSearch;
@@ -3900,129 +4844,885 @@ interface CommitDeltasResponse {
3900
4844
  /** Order after deltas are applied */
3901
4845
  order?: Order;
3902
4846
  }
3903
- interface UpdateOrderLineItemRequest {
4847
+ /** Triggered when order is edited by draftOrders */
4848
+ interface OrderDeltasCommitted {
4849
+ /** The order after committed changes. */
4850
+ order?: Order;
4851
+ /** Draft order Id representing this change. */
4852
+ draftOrderId?: string;
4853
+ /** Applied changes. */
4854
+ changes?: CommittedDiffs;
4855
+ /** Side-effects requested to happen as a result of this edit. */
4856
+ commitSettings?: DraftOrderCommitSettings;
3904
4857
  /**
3905
- * Order ID
3906
- * @minLength 1
3907
- * @maxLength 100
4858
+ * Date and time when order deltas were committed.
4859
+ * @readonly
3908
4860
  */
3909
- id: string;
3910
- /** Order line item to update */
3911
- lineItem: OrderLineItem;
4861
+ commitDate?: Date | null;
3912
4862
  }
3913
- interface UpdateOrderLineItemResponse {
3914
- /** Updated order data */
3915
- order?: Order;
4863
+ interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
4864
+ /** Shipping info and selected shipping option details. */
4865
+ changedShippingInfo?: V1ShippingInformation;
4866
+ /** Remove existing shipping info. */
4867
+ shippingInfoRemoved?: boolean;
4868
+ /**
4869
+ * Added/updated/removed order line items.
4870
+ * @maxSize 300
4871
+ */
4872
+ lineItems?: LineItemDelta[];
4873
+ /**
4874
+ * Added/updated/removed discounts.
4875
+ * @maxSize 320
4876
+ */
4877
+ appliedDiscounts?: AppliedDiscountDelta[];
4878
+ /**
4879
+ * Added/updated/removed additional fee.
4880
+ * @maxSize 100
4881
+ */
4882
+ additionalFees?: AdditionalFeeDelta[];
3916
4883
  }
3917
- interface AddActivityRequest {
4884
+ /** @oneof */
4885
+ interface CommittedDiffsShippingUpdateInfoOneOf {
4886
+ /** Shipping info and selected shipping option details. */
4887
+ changedShippingInfo?: V1ShippingInformation;
4888
+ /** Remove existing shipping info. */
4889
+ shippingInfoRemoved?: boolean;
4890
+ }
4891
+ interface LineItemDelta extends LineItemDeltaDeltaOneOf {
4892
+ lineItemAdded?: boolean;
4893
+ changedDetails?: ItemChangedDetails;
4894
+ lineItemRemoved?: OrderLineItemChangedDetails;
4895
+ /**
4896
+ * Line item ID.
4897
+ * @format GUID
4898
+ */
4899
+ lineItemId?: string;
4900
+ }
4901
+ /** @oneof */
4902
+ interface LineItemDeltaDeltaOneOf {
4903
+ lineItemAdded?: boolean;
4904
+ changedDetails?: ItemChangedDetails;
4905
+ lineItemRemoved?: OrderLineItemChangedDetails;
4906
+ }
4907
+ interface ArchiveOrderRequest {
3918
4908
  /**
3919
4909
  * Order ID.
3920
4910
  * @minLength 1
3921
4911
  * @maxLength 100
3922
4912
  */
3923
- id: string;
3924
- /** Activity info. */
3925
- activity: PublicActivity;
3926
- }
3927
- interface PublicActivity extends PublicActivityContentOneOf {
3928
- /** Custom activity details. */
3929
- customActivity?: CustomActivity;
3930
- /** Merchant commment. */
3931
- merchantComment?: MerchantComment;
3932
- }
3933
- /** @oneof */
3934
- interface PublicActivityContentOneOf {
3935
- /** Custom activity details. */
3936
- customActivity?: CustomActivity;
3937
- /** Merchant commment. */
3938
- merchantComment?: MerchantComment;
4913
+ id?: string;
3939
4914
  }
3940
- interface AddActivityResponse {
3941
- /** Updated order. */
4915
+ interface ArchiveOrderResponse {
4916
+ /** Archived order. */
3942
4917
  order?: Order;
4918
+ }
4919
+ interface BulkArchiveOrdersRequest {
3943
4920
  /**
3944
- * ID of the added activity.
3945
- * Use this ID to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activity) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activity) the activity.
3946
- * @format GUID
4921
+ * IDs of orders to archive.
4922
+ * @minSize 1
4923
+ * @maxSize 1000
3947
4924
  */
3948
- activityId?: string;
4925
+ ids?: string[];
4926
+ /** Whether to return the full updated order entities in the response. */
4927
+ returnFullEntity?: boolean;
3949
4928
  }
3950
- interface UpdateActivityRequest {
4929
+ interface BulkArchiveOrdersResponse {
4930
+ /** Items updated by bulk action. */
4931
+ results?: BulkOrderResult[];
4932
+ /** Bulk action metadata. */
4933
+ bulkActionMetadata?: BulkActionMetadata;
4934
+ }
4935
+ interface BulkArchiveOrdersByFilterRequest {
4936
+ /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
4937
+ filter?: Record<string, any> | null;
4938
+ }
4939
+ interface BulkArchiveOrdersByFilterResponse {
4940
+ /** Items updated by bulk action. */
4941
+ results?: BulkOrderResult[];
4942
+ /** Bulk action metadata. */
4943
+ bulkActionMetadata?: BulkActionMetadata;
4944
+ }
4945
+ interface UnArchiveOrderRequest {
3951
4946
  /**
3952
4947
  * Order ID.
3953
4948
  * @minLength 1
3954
4949
  * @maxLength 100
3955
4950
  */
3956
- id: string;
4951
+ id?: string;
4952
+ }
4953
+ interface UnArchiveOrderResponse {
4954
+ /** Unarchived order. */
4955
+ order?: Order;
4956
+ }
4957
+ interface BulkUnArchiveOrdersRequest {
3957
4958
  /**
3958
- * ID of the activity to update.
3959
- * @format GUID
4959
+ * IDs or orders to unarchive.
4960
+ * @minSize 1
4961
+ * @maxSize 1000
3960
4962
  */
3961
- activityId: string;
3962
- /** Activity info. */
3963
- activity: PublicActivity;
4963
+ ids?: string[];
4964
+ /** Whether to return the full updated order entities in the response. */
4965
+ returnFullEntity?: boolean;
3964
4966
  }
3965
- interface UpdateActivityResponse {
3966
- /** Updated order. */
3967
- order?: Order;
4967
+ interface BulkUnArchiveOrdersResponse {
4968
+ /** Items updated by bulk action. */
4969
+ results?: BulkOrderResult[];
4970
+ /** Bulk action metadata. */
4971
+ bulkActionMetadata?: BulkActionMetadata;
3968
4972
  }
3969
- interface DeleteActivityRequest {
4973
+ interface BulkUnArchiveOrdersByFilterRequest {
4974
+ /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
4975
+ filter?: Record<string, any> | null;
4976
+ }
4977
+ interface BulkUnArchiveOrdersByFilterResponse {
4978
+ /** Items updated by bulk action. */
4979
+ results?: BulkOrderResult[];
4980
+ /** Bulk action metadata. */
4981
+ bulkActionMetadata?: BulkActionMetadata;
4982
+ }
4983
+ interface UpdateBuyerInfoRequest {
3970
4984
  /**
3971
4985
  * Order ID.
3972
4986
  * @minLength 1
3973
4987
  * @maxLength 100
4988
+ * @readonly
3974
4989
  */
3975
- id: string;
4990
+ id?: string;
4991
+ /** Buyer info. */
4992
+ buyerInfo?: BuyerInfoUpdate;
4993
+ }
4994
+ interface BuyerInfoUpdate {
3976
4995
  /**
3977
- * ID of the activity to delete.
4996
+ * Contact ID.
3978
4997
  * @format GUID
3979
4998
  */
3980
- activityId: string;
4999
+ contactId?: string | null;
5000
+ /**
5001
+ * Email associated with the buyer.
5002
+ * @format EMAIL
5003
+ */
5004
+ email?: string | null;
3981
5005
  }
3982
- interface DeleteActivityResponse {
5006
+ interface UpdateBuyerInfoResponse {
3983
5007
  /** Updated order. */
3984
5008
  order?: Order;
3985
5009
  }
3986
- interface CancelOrderRequest {
5010
+ interface UpdateBuyerEmailRequest {
3987
5011
  /**
3988
- * Order ID.
3989
5012
  * @minLength 1
3990
5013
  * @maxLength 100
5014
+ * @readonly
3991
5015
  */
3992
- id: string;
3993
- /** Whether to send an order canceled email to the buyer. */
3994
- sendOrderCanceledEmail?: boolean;
3995
- /**
3996
- * Custom note to be added to the email (optional).
3997
- * @minLength 1
3998
- * @maxLength 1000
3999
- */
4000
- customMessage?: string | null;
4001
- /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
4002
- restockAllItems?: boolean;
5016
+ id?: string;
5017
+ /** @format EMAIL */
5018
+ email?: string | null;
4003
5019
  }
4004
- interface CancelOrderResponse {
4005
- /** Canceled order. */
5020
+ interface UpdateBuyerEmailResponse {
4006
5021
  order?: Order;
4007
5022
  }
4008
- interface UpdateOrderStatusRequest {
5023
+ interface UpdateOrderShippingAddressRequest {
4009
5024
  /**
4010
5025
  * Order ID.
4011
- * @format GUID
5026
+ * @minLength 1
5027
+ * @maxLength 100
4012
5028
  */
4013
- orderId: string;
4014
- /** New order status. */
4015
- status: OrderStatusWithLiterals;
5029
+ id?: string;
5030
+ /** Shipping address and contact details to be updated. */
5031
+ shippingAddress?: AddressWithContact;
4016
5032
  }
4017
- interface UpdateOrderStatusResponse {
5033
+ interface UpdateOrderShippingAddressResponse {
4018
5034
  /** Updated order. */
4019
5035
  order?: Order;
4020
5036
  }
4021
- interface AggregateOrdersRequest {
4022
- /** Filter applied to original data */
4023
- filter?: Record<string, any> | null;
4024
- /** This is an object defining aggregation itself */
4025
- aggregation: Record<string, any> | null;
5037
+ interface UpdateBillingContactDetailsRequest {
5038
+ /**
5039
+ * Order ID.
5040
+ * @minLength 1
5041
+ * @maxLength 100
5042
+ * @readonly
5043
+ */
5044
+ id?: string;
5045
+ /** Contact details. */
5046
+ addressContactDetails?: FullAddressContactDetails;
5047
+ }
5048
+ interface UpdateBillingContactDetailsResponse {
5049
+ /** Updated order. */
5050
+ order?: Order;
5051
+ }
5052
+ interface UpdateOrderLineItemRequest {
5053
+ /**
5054
+ * Order ID
5055
+ * @minLength 1
5056
+ * @maxLength 100
5057
+ */
5058
+ id: string;
5059
+ /** Order line item to update */
5060
+ lineItem: OrderLineItem;
5061
+ }
5062
+ interface UpdateOrderLineItemResponse {
5063
+ /** Updated order data */
5064
+ order?: Order;
5065
+ }
5066
+ interface UpdateOrderLineItemsRequest {
5067
+ /**
5068
+ * Order ID
5069
+ * @minLength 1
5070
+ * @maxLength 100
5071
+ */
5072
+ orderId?: string;
5073
+ /**
5074
+ * Order line items to update
5075
+ * @minSize 1
5076
+ * @maxSize 300
5077
+ */
5078
+ lineItems?: MaskedOrderLineItem[];
5079
+ }
5080
+ interface MaskedOrderLineItem {
5081
+ /** Order line item to update */
5082
+ lineItem?: OrderLineItem;
5083
+ }
5084
+ interface UpdateOrderLineItemsResponse {
5085
+ /** Updated order data */
5086
+ order?: Order;
5087
+ }
5088
+ interface AddInternalActivityRequest {
5089
+ /**
5090
+ * Order ID.
5091
+ * @minLength 1
5092
+ * @maxLength 100
5093
+ */
5094
+ id?: string;
5095
+ /** Activity info. */
5096
+ activity?: InternalActivity;
5097
+ }
5098
+ interface InternalActivity extends InternalActivityContentOneOf {
5099
+ /** Order refunded. */
5100
+ orderRefunded?: OrderRefunded;
5101
+ /** Order placed. */
5102
+ orderPlaced?: OrderPlaced;
5103
+ /** Order paid. Either by the store owner (for offline orders), or when an online transaction was confirmed. */
5104
+ orderPaid?: OrderPaid;
5105
+ /** Order shipping status set as fulfilled. */
5106
+ orderFulfilled?: OrderFulfilled;
5107
+ /** Order shipping status set as not fulfilled. */
5108
+ orderNotFulfilled?: OrderNotFulfilled;
5109
+ /** Order canceled. */
5110
+ orderCanceled?: OrderCanceled;
5111
+ /** Download link was sent (relevant for orders with digital line items). */
5112
+ downloadLinkSent?: DownloadLinkSent;
5113
+ /** Shipping tracking number added to order. */
5114
+ trackingNumberAdded?: TrackingNumberAdded;
5115
+ /** Shipping tracking number was edited. */
5116
+ trackingNumberEdited?: TrackingNumberEdited;
5117
+ /** Shipping tracking link added to order. */
5118
+ trackingLinkAdded?: TrackingLinkAdded;
5119
+ /** An email confirmation of order shipment was sent. */
5120
+ shippingConfirmationEmailSent?: ShippingConfirmationEmailSent;
5121
+ /** Invoice was added to order. */
5122
+ invoiceAdded?: InvoiceAdded;
5123
+ /** Invoice sent to customer via email. */
5124
+ invoiceSent?: InvoiceSent;
5125
+ /** Email sent to fulfiller. */
5126
+ fulfillerEmailSent?: FulfillerEmailSent;
5127
+ /** Shipping address was updated. */
5128
+ shippingAddressEdited?: ShippingAddressEdited;
5129
+ /** Order email was updated. */
5130
+ emailEdited?: EmailEdited;
5131
+ /** Email notification for pickup sent. */
5132
+ pickupReadyEmailSent?: PickupReadyEmailSent;
5133
+ /** Order created as a result of items exchange. */
5134
+ orderCreatedFromExchange?: OrderCreatedFromExchange;
5135
+ /** New exchange order created. */
5136
+ newExchangeOrderCreated?: NewExchangeOrderCreated;
5137
+ /** Order partially paid. During the checkout for orders with deposit items. */
5138
+ orderPartiallyPaid?: OrderPartiallyPaid;
5139
+ /** Draft order changes applied. */
5140
+ draftOrderChangesApplied?: DraftOrderChangesApplied;
5141
+ /** Payment method is saved for order. */
5142
+ savedPaymentMethod?: SavedPaymentMethod;
5143
+ /** Details of an authorized payment created. */
5144
+ authorizedPaymentCreated?: AuthorizedPaymentCreated;
5145
+ /** Details of an authorized payment captured. */
5146
+ authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
5147
+ /** Details of an authorized payment voided. */
5148
+ authorizedPaymentVoided?: AuthorizedPaymentVoided;
5149
+ /**
5150
+ * Details of an initiated refund process.
5151
+ *
5152
+ * > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
5153
+ * > In these cases, the `refundId` will be identical across the activities.
5154
+ */
5155
+ refundInitiated?: RefundInitiated;
5156
+ /**
5157
+ * Details of a refunded payment.
5158
+ *
5159
+ * > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
5160
+ * > In these cases, the `refundId` will be identical across the activities.
5161
+ */
5162
+ paymentRefunded?: PaymentRefunded;
5163
+ /**
5164
+ * Details of a failed payment refund.
5165
+ *
5166
+ * > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
5167
+ * > In these cases, the `refundId` will be identical across the activities.
5168
+ */
5169
+ paymentRefundFailed?: PaymentRefundFailed;
5170
+ /** Details of refund to store credit. */
5171
+ refundedAsStoreCredit?: RefundedAsStoreCredit;
5172
+ /** Details of a pending payment. */
5173
+ paymentPending?: PaymentPending;
5174
+ /** Details of a canceled payment. */
5175
+ paymentCanceled?: PaymentCanceled;
5176
+ /** Details of a declined payment. */
5177
+ paymentDeclined?: PaymentDeclined;
5178
+ /** Order pending. */
5179
+ orderPending?: OrderPending;
5180
+ /** Order rejected. */
5181
+ orderRejected?: OrderRejected;
5182
+ /** Receipt was added for associated payment. */
5183
+ receiptCreated?: ReceiptCreated;
5184
+ /** Receipt sent to customer. */
5185
+ receiptSent?: ReceiptSent;
5186
+ /** Chargeback created for one of the order's payments. */
5187
+ chargebackCreated?: ChargebackCreated;
5188
+ /** Chargeback reversed for one of the order's payments. */
5189
+ chargebackReversed?: ChargebackReversed;
5190
+ /**
5191
+ * Internal activity ID.
5192
+ * @format GUID
5193
+ * @readonly
5194
+ */
5195
+ id?: string | null;
5196
+ /**
5197
+ * Internal activity author's email.
5198
+ * @format EMAIL
5199
+ * @readonly
5200
+ */
5201
+ authorEmail?: string | null;
5202
+ /**
5203
+ * Internal activity creation date and time.
5204
+ * @readonly
5205
+ */
5206
+ createdDate?: Date | null;
5207
+ }
5208
+ /** @oneof */
5209
+ interface InternalActivityContentOneOf {
5210
+ /** Order refunded. */
5211
+ orderRefunded?: OrderRefunded;
5212
+ /** Order placed. */
5213
+ orderPlaced?: OrderPlaced;
5214
+ /** Order paid. Either by the store owner (for offline orders), or when an online transaction was confirmed. */
5215
+ orderPaid?: OrderPaid;
5216
+ /** Order shipping status set as fulfilled. */
5217
+ orderFulfilled?: OrderFulfilled;
5218
+ /** Order shipping status set as not fulfilled. */
5219
+ orderNotFulfilled?: OrderNotFulfilled;
5220
+ /** Order canceled. */
5221
+ orderCanceled?: OrderCanceled;
5222
+ /** Download link was sent (relevant for orders with digital line items). */
5223
+ downloadLinkSent?: DownloadLinkSent;
5224
+ /** Shipping tracking number added to order. */
5225
+ trackingNumberAdded?: TrackingNumberAdded;
5226
+ /** Shipping tracking number was edited. */
5227
+ trackingNumberEdited?: TrackingNumberEdited;
5228
+ /** Shipping tracking link added to order. */
5229
+ trackingLinkAdded?: TrackingLinkAdded;
5230
+ /** An email confirmation of order shipment was sent. */
5231
+ shippingConfirmationEmailSent?: ShippingConfirmationEmailSent;
5232
+ /** Invoice was added to order. */
5233
+ invoiceAdded?: InvoiceAdded;
5234
+ /** Invoice sent to customer via email. */
5235
+ invoiceSent?: InvoiceSent;
5236
+ /** Email sent to fulfiller. */
5237
+ fulfillerEmailSent?: FulfillerEmailSent;
5238
+ /** Shipping address was updated. */
5239
+ shippingAddressEdited?: ShippingAddressEdited;
5240
+ /** Order email was updated. */
5241
+ emailEdited?: EmailEdited;
5242
+ /** Email notification for pickup sent. */
5243
+ pickupReadyEmailSent?: PickupReadyEmailSent;
5244
+ /** Order created as a result of items exchange. */
5245
+ orderCreatedFromExchange?: OrderCreatedFromExchange;
5246
+ /** New exchange order created. */
5247
+ newExchangeOrderCreated?: NewExchangeOrderCreated;
5248
+ /** Order partially paid. During the checkout for orders with deposit items. */
5249
+ orderPartiallyPaid?: OrderPartiallyPaid;
5250
+ /** Draft order changes applied. */
5251
+ draftOrderChangesApplied?: DraftOrderChangesApplied;
5252
+ /** Payment method is saved for order. */
5253
+ savedPaymentMethod?: SavedPaymentMethod;
5254
+ /** Details of an authorized payment created. */
5255
+ authorizedPaymentCreated?: AuthorizedPaymentCreated;
5256
+ /** Details of an authorized payment captured. */
5257
+ authorizedPaymentCaptured?: AuthorizedPaymentCaptured;
5258
+ /** Details of an authorized payment voided. */
5259
+ authorizedPaymentVoided?: AuthorizedPaymentVoided;
5260
+ /**
5261
+ * Details of an initiated refund process.
5262
+ *
5263
+ * > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
5264
+ * > In these cases, the `refundId` will be identical across the activities.
5265
+ */
5266
+ refundInitiated?: RefundInitiated;
5267
+ /**
5268
+ * Details of a refunded payment.
5269
+ *
5270
+ * > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
5271
+ * > In these cases, the `refundId` will be identical across the activities.
5272
+ */
5273
+ paymentRefunded?: PaymentRefunded;
5274
+ /**
5275
+ * Details of a failed payment refund.
5276
+ *
5277
+ * > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities.
5278
+ * > In these cases, the `refundId` will be identical across the activities.
5279
+ */
5280
+ paymentRefundFailed?: PaymentRefundFailed;
5281
+ /** Details of refund to store credit. */
5282
+ refundedAsStoreCredit?: RefundedAsStoreCredit;
5283
+ /** Details of a pending payment. */
5284
+ paymentPending?: PaymentPending;
5285
+ /** Details of a canceled payment. */
5286
+ paymentCanceled?: PaymentCanceled;
5287
+ /** Details of a declined payment. */
5288
+ paymentDeclined?: PaymentDeclined;
5289
+ /** Order pending. */
5290
+ orderPending?: OrderPending;
5291
+ /** Order rejected. */
5292
+ orderRejected?: OrderRejected;
5293
+ /** Receipt was added for associated payment. */
5294
+ receiptCreated?: ReceiptCreated;
5295
+ /** Receipt sent to customer. */
5296
+ receiptSent?: ReceiptSent;
5297
+ /** Chargeback created for one of the order's payments. */
5298
+ chargebackCreated?: ChargebackCreated;
5299
+ /** Chargeback reversed for one of the order's payments. */
5300
+ chargebackReversed?: ChargebackReversed;
5301
+ }
5302
+ /** Order placed */
5303
+ interface OrderPlaced {
5304
+ }
5305
+ /** Order marked as paid, either by the store owner (for offline orders), or when an online transaction was confirmed */
5306
+ interface OrderPaid {
5307
+ }
5308
+ /** Order shipping status set as fulfilled */
5309
+ interface OrderFulfilled {
5310
+ }
5311
+ /** Order shipping status set as not fulfilled */
5312
+ interface OrderNotFulfilled {
5313
+ }
5314
+ /** Order canceled */
5315
+ interface OrderCanceled {
5316
+ }
5317
+ /** A download link was sent (relevant for orders with digital line items) */
5318
+ interface DownloadLinkSent {
5319
+ }
5320
+ /** Shipping tracking number was set */
5321
+ interface TrackingNumberAdded {
5322
+ }
5323
+ /** Shipping tracking number was edited */
5324
+ interface TrackingNumberEdited {
5325
+ }
5326
+ /** Shipping tracking link was set */
5327
+ interface TrackingLinkAdded {
5328
+ }
5329
+ /** An email confirmation of order shipment was sent */
5330
+ interface ShippingConfirmationEmailSent {
5331
+ }
5332
+ /** Invoice was set in the order */
5333
+ interface InvoiceAdded {
5334
+ }
5335
+ /** Invoice sent to customer via email */
5336
+ interface InvoiceSent {
5337
+ }
5338
+ /** Email was sent to fulfiller */
5339
+ interface FulfillerEmailSent {
5340
+ }
5341
+ /** Shipping address was updated */
5342
+ interface ShippingAddressEdited {
5343
+ }
5344
+ /** Order email was updated */
5345
+ interface EmailEdited {
5346
+ }
5347
+ /** An email notification for pickup was sent */
5348
+ interface PickupReadyEmailSent {
5349
+ }
5350
+ /** Order marked as partially paid when an online transaction was confirmed with partial minimal required amount of total sum */
5351
+ interface OrderPartiallyPaid {
5352
+ }
5353
+ /** Order reject */
5354
+ interface OrderPending {
5355
+ }
5356
+ /** Order reject */
5357
+ interface OrderRejected {
5358
+ }
5359
+ interface AddInternalActivityResponse {
5360
+ /** Updated order. */
5361
+ order?: Order;
5362
+ /**
5363
+ * ID of the added internal activity.
5364
+ * Use this ID to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activity) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activity) the activity.
5365
+ * @format GUID
5366
+ */
5367
+ activityId?: string;
5368
+ }
5369
+ interface AddActivityRequest {
5370
+ /**
5371
+ * Order ID.
5372
+ * @minLength 1
5373
+ * @maxLength 100
5374
+ */
5375
+ id: string;
5376
+ /** Activity info. */
5377
+ activity: PublicActivity;
5378
+ }
5379
+ interface PublicActivity extends PublicActivityContentOneOf {
5380
+ /** Custom activity details. */
5381
+ customActivity?: CustomActivity;
5382
+ /** Merchant commment. */
5383
+ merchantComment?: MerchantComment;
5384
+ }
5385
+ /** @oneof */
5386
+ interface PublicActivityContentOneOf {
5387
+ /** Custom activity details. */
5388
+ customActivity?: CustomActivity;
5389
+ /** Merchant commment. */
5390
+ merchantComment?: MerchantComment;
5391
+ }
5392
+ interface AddActivityResponse {
5393
+ /** Updated order. */
5394
+ order?: Order;
5395
+ /**
5396
+ * ID of the added activity.
5397
+ * Use this ID to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activity) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activity) the activity.
5398
+ * @format GUID
5399
+ */
5400
+ activityId?: string;
5401
+ }
5402
+ interface AddActivitiesRequest {
5403
+ /**
5404
+ * Order ID.
5405
+ * @format GUID
5406
+ */
5407
+ orderId?: string;
5408
+ /**
5409
+ * Activities to add.
5410
+ * @minSize 1
5411
+ * @maxSize 300
5412
+ */
5413
+ activities?: PublicActivity[];
5414
+ }
5415
+ interface AddActivitiesResponse {
5416
+ /** Updated order. */
5417
+ order?: Order;
5418
+ /**
5419
+ * IDs of the added activities.
5420
+ * Use this IDs to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activities) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activities) the activities.
5421
+ * @format GUID
5422
+ */
5423
+ activityIds?: string[];
5424
+ }
5425
+ interface UpdateActivityRequest {
5426
+ /**
5427
+ * Order ID.
5428
+ * @minLength 1
5429
+ * @maxLength 100
5430
+ */
5431
+ id: string;
5432
+ /**
5433
+ * ID of the activity to update.
5434
+ * @format GUID
5435
+ */
5436
+ activityId: string;
5437
+ /** Activity info. */
5438
+ activity: PublicActivity;
5439
+ }
5440
+ interface UpdateActivityResponse {
5441
+ /** Updated order. */
5442
+ order?: Order;
5443
+ }
5444
+ interface DeleteActivityRequest {
5445
+ /**
5446
+ * Order ID.
5447
+ * @minLength 1
5448
+ * @maxLength 100
5449
+ */
5450
+ id: string;
5451
+ /**
5452
+ * ID of the activity to delete.
5453
+ * @format GUID
5454
+ */
5455
+ activityId: string;
5456
+ }
5457
+ interface DeleteActivityResponse {
5458
+ /** Updated order. */
5459
+ order?: Order;
5460
+ }
5461
+ interface UpdateLineItemsDescriptionLinesRequest {
5462
+ /**
5463
+ * Order ID.
5464
+ * @minLength 1
5465
+ * @maxLength 100
5466
+ */
5467
+ id?: string;
5468
+ /**
5469
+ * Line items.
5470
+ * @minSize 1
5471
+ * @maxSize 300
5472
+ */
5473
+ lineItems?: LineItemUpdate[];
5474
+ }
5475
+ interface LineItemUpdate {
5476
+ /**
5477
+ * Line item ID.
5478
+ * @format GUID
5479
+ */
5480
+ lineItemId?: string;
5481
+ /**
5482
+ * Description lines' info.
5483
+ * If description line already exists for this name, it will be replaced.
5484
+ * @minSize 1
5485
+ * @maxSize 20
5486
+ */
5487
+ descriptionLines?: DescriptionLine[];
5488
+ }
5489
+ interface UpdateLineItemsDescriptionLinesResponse {
5490
+ /** Updated order. */
5491
+ order?: Order;
5492
+ }
5493
+ interface MarkOrderAsSeenByHumanRequest {
5494
+ /**
5495
+ * Order ID.
5496
+ * @minLength 1
5497
+ * @maxLength 100
5498
+ */
5499
+ id?: string;
5500
+ }
5501
+ interface MarkOrderAsSeenByHumanResponse {
5502
+ /** Updated order. */
5503
+ order?: Order;
5504
+ }
5505
+ interface CancelOrderRequest {
5506
+ /**
5507
+ * Order ID.
5508
+ * @minLength 1
5509
+ * @maxLength 100
5510
+ */
5511
+ id: string;
5512
+ /** Whether to send an order canceled email to the buyer. */
5513
+ sendOrderCanceledEmail?: boolean;
5514
+ /**
5515
+ * Custom note to be added to the email (optional).
5516
+ * @minLength 1
5517
+ * @maxLength 1000
5518
+ */
5519
+ customMessage?: string | null;
5520
+ /** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
5521
+ restockAllItems?: boolean;
5522
+ }
5523
+ interface CancelOrderResponse {
5524
+ /** Canceled order. */
5525
+ order?: Order;
5526
+ }
5527
+ interface OrderCanceledEventOrderCanceled {
5528
+ /** The order that was cancelled */
5529
+ order?: Order;
5530
+ /** Should restock all items on that order */
5531
+ restockAllItems?: boolean;
5532
+ /** Should send a confirmation mail to the customer */
5533
+ sendOrderCanceledEmail?: boolean;
5534
+ /** Personal note added to the email */
5535
+ customMessage?: string | null;
5536
+ }
5537
+ interface UpdateOrderStatusRequest {
5538
+ /**
5539
+ * Order ID.
5540
+ * @format GUID
5541
+ */
5542
+ orderId: string;
5543
+ /** New order status. */
5544
+ status: OrderStatusWithLiterals;
5545
+ }
5546
+ interface UpdateOrderStatusResponse {
5547
+ /** Updated order. */
5548
+ order?: Order;
5549
+ }
5550
+ interface MarkAsFulfilledRequest {
5551
+ /**
5552
+ * Order ID.
5553
+ * @minLength 1
5554
+ * @maxLength 100
5555
+ */
5556
+ id?: string;
5557
+ }
5558
+ interface MarkAsFulfilledResponse {
5559
+ /** Updated order. */
5560
+ order?: Order;
5561
+ }
5562
+ /** Triggered when the fulfillment status of an order is updated */
5563
+ interface FulfillmentStatusUpdated {
5564
+ /** The order that was updated */
5565
+ order?: Order;
5566
+ /** The previous status (before the update) */
5567
+ previousFulfillmentStatus?: FulfillmentStatusWithLiterals;
5568
+ /** the new status (after the update) */
5569
+ newFulfillmentStatus?: FulfillmentStatusWithLiterals;
5570
+ /** the action that caused this update */
5571
+ action?: string;
5572
+ }
5573
+ interface BulkMarkAsFulfilledRequest {
5574
+ /**
5575
+ * IDs of orders to be marked as fulfilled.
5576
+ * @minSize 1
5577
+ * @maxSize 1000
5578
+ */
5579
+ ids?: string[];
5580
+ /** Whether to return the full updated order entities in the response. */
5581
+ returnFullEntity?: boolean;
5582
+ }
5583
+ interface BulkMarkAsFulfilledResponse {
5584
+ /** Items updated by bulk action. */
5585
+ results?: BulkOrderResult[];
5586
+ /** Bulk action metadata. */
5587
+ bulkActionMetadata?: BulkActionMetadata;
5588
+ }
5589
+ interface BulkMarkAsFulfilledByFilterRequest {
5590
+ /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
5591
+ filter?: Record<string, any> | null;
5592
+ }
5593
+ interface BulkMarkAsFulfilledByFilterResponse {
5594
+ /** Items updated by bulk action. */
5595
+ results?: BulkOrderResult[];
5596
+ /** Bulk action metadata. */
5597
+ bulkActionMetadata?: BulkActionMetadata;
5598
+ }
5599
+ interface MarkAsUnfulfilledRequest {
5600
+ /**
5601
+ * Order ID.
5602
+ * @minLength 1
5603
+ * @maxLength 100
5604
+ */
5605
+ id?: string;
5606
+ }
5607
+ interface MarkAsUnfulfilledResponse {
5608
+ /** Updated order. */
5609
+ order?: Order;
5610
+ }
5611
+ interface BulkMarkAsUnfulfilledRequest {
5612
+ /**
5613
+ * IDs of orders to be marked as not fulfilled.
5614
+ * @minSize 1
5615
+ * @maxSize 1000
5616
+ */
5617
+ ids?: string[];
5618
+ /** Whether to return the full updated order entities in the response. */
5619
+ returnFullEntity?: boolean;
5620
+ }
5621
+ interface BulkMarkAsUnfulfilledResponse {
5622
+ /** Items updated by bulk action. */
5623
+ results?: BulkOrderResult[];
5624
+ /** Bulk action metadata. */
5625
+ bulkActionMetadata?: BulkActionMetadata;
5626
+ }
5627
+ interface BulkMarkAsUnfulfilledByFilterRequest {
5628
+ /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
5629
+ filter?: Record<string, any> | null;
5630
+ }
5631
+ interface BulkMarkAsUnfulfilledByFilterResponse {
5632
+ /** Items updated by bulk action. */
5633
+ results?: BulkOrderResult[];
5634
+ /** Bulk action metadata. */
5635
+ bulkActionMetadata?: BulkActionMetadata;
5636
+ }
5637
+ interface BulkSetBusinessLocationRequest {
5638
+ /**
5639
+ * IDs of orders to update location for.
5640
+ * @minSize 1
5641
+ * @maxSize 100
5642
+ * @format GUID
5643
+ */
5644
+ orderIds?: string[];
5645
+ /** Business location. */
5646
+ businessLocation?: Location;
5647
+ }
5648
+ interface BulkSetBusinessLocationResponse {
5649
+ /**
5650
+ * Bulk action results.
5651
+ * @minSize 1
5652
+ * @maxSize 100
5653
+ */
5654
+ results?: BulkSetBusinessLocationResult[];
5655
+ /** Bulk action metadata. */
5656
+ bulkActionMetadata?: BulkActionMetadata;
5657
+ }
5658
+ interface BulkSetBusinessLocationResult {
5659
+ itemMetadata?: ItemMetadata;
5660
+ }
5661
+ interface V1MarkOrderAsPaidRequest {
5662
+ /**
5663
+ * Order ID.
5664
+ * @minLength 1
5665
+ * @maxLength 100
5666
+ */
5667
+ id?: string;
5668
+ }
5669
+ interface V1MarkOrderAsPaidResponse {
5670
+ /** Updated order. */
5671
+ order?: Order;
5672
+ }
5673
+ /** Triggered when the payment status of an order is updated */
5674
+ interface PaymentStatusUpdated {
5675
+ /** The order that was updated */
5676
+ order?: Order;
5677
+ /** The previous status (before the update) */
5678
+ previousPaymentStatus?: PaymentStatusWithLiterals;
5679
+ }
5680
+ interface V1BulkMarkOrdersAsPaidRequest {
5681
+ /**
5682
+ * IDs of orders to mark as paid.
5683
+ * @minSize 1
5684
+ * @maxSize 100
5685
+ * @minLength 1
5686
+ * @maxLength 100
5687
+ */
5688
+ ids?: string[];
5689
+ }
5690
+ interface V1BulkMarkOrdersAsPaidResponse {
5691
+ /**
5692
+ * Items updated by the bulk action.
5693
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5694
+ */
5695
+ results?: BulkOrderResult[];
5696
+ /** Bulk action metadata. */
5697
+ bulkActionMetadata?: BulkActionMetadata;
5698
+ }
5699
+ interface V1CreatePaymentGatewayOrderRequest {
5700
+ /**
5701
+ * eCom Order ID
5702
+ * @minLength 1
5703
+ * @maxLength 100
5704
+ */
5705
+ ecomOrderId?: string;
5706
+ }
5707
+ interface V1CreatePaymentGatewayOrderResponse {
5708
+ /** ID of the order created in the payment gateway */
5709
+ paymentGatewayOrderId?: string;
5710
+ }
5711
+ interface GetShipmentsRequest {
5712
+ /**
5713
+ * @minLength 1
5714
+ * @maxLength 100
5715
+ */
5716
+ id?: string;
5717
+ }
5718
+ interface GetShipmentsResponse {
5719
+ shipmentIds?: string[];
5720
+ }
5721
+ interface AggregateOrdersRequest {
5722
+ /** Filter applied to original data */
5723
+ filter?: Record<string, any> | null;
5724
+ /** This is an object defining aggregation itself */
5725
+ aggregation: Record<string, any> | null;
4026
5726
  /**
4027
5727
  * Optional custom separator string that can be used to override default separator value '|'
4028
5728
  * for hierarchical responses of multifaceted aggregation requests like:
@@ -4037,6 +5737,39 @@ interface AggregateOrdersRequest {
4037
5737
  interface AggregateOrdersResponse {
4038
5738
  aggregates?: Record<string, any> | null;
4039
5739
  }
5740
+ interface DecrementItemsQuantityRequest {
5741
+ /**
5742
+ * Order ID
5743
+ * @minLength 1
5744
+ * @maxLength 100
5745
+ */
5746
+ id?: string;
5747
+ /**
5748
+ * Which items to decrement, and how much to decrement from each one
5749
+ * @minSize 1
5750
+ * @maxSize 300
5751
+ */
5752
+ decrementData?: DecrementData[];
5753
+ }
5754
+ interface DecrementData {
5755
+ /**
5756
+ * ID of the line item being decremented.
5757
+ * @format GUID
5758
+ */
5759
+ lineItemId?: string;
5760
+ /**
5761
+ * Line item quantity being decremented.
5762
+ * @min 1
5763
+ * @max 100000
5764
+ */
5765
+ decrementBy?: number;
5766
+ /** Whether to restock the line item (triggers inventory update). */
5767
+ restock?: boolean;
5768
+ }
5769
+ interface DecrementItemsQuantityResponse {
5770
+ /** Updated order data */
5771
+ order?: Order;
5772
+ }
4040
5773
  interface BulkUpdateOrderTagsRequest {
4041
5774
  /**
4042
5775
  * IDs of orders to update tags for.
@@ -4061,6 +5794,651 @@ interface BulkUpdateOrderTagsResponse {
4061
5794
  interface BulkUpdateOrderTagsResult {
4062
5795
  itemMetadata?: ItemMetadata;
4063
5796
  }
5797
+ interface Task {
5798
+ key?: TaskKey;
5799
+ executeAt?: Date | null;
5800
+ payload?: string | null;
5801
+ }
5802
+ interface TaskKey {
5803
+ appId?: string;
5804
+ instanceId?: string;
5805
+ subjectId?: string | null;
5806
+ }
5807
+ interface TaskAction extends TaskActionActionOneOf {
5808
+ complete?: Complete;
5809
+ cancel?: Cancel;
5810
+ reschedule?: Reschedule;
5811
+ }
5812
+ /** @oneof */
5813
+ interface TaskActionActionOneOf {
5814
+ complete?: Complete;
5815
+ cancel?: Cancel;
5816
+ reschedule?: Reschedule;
5817
+ }
5818
+ interface Complete {
5819
+ }
5820
+ interface Cancel {
5821
+ }
5822
+ interface Reschedule {
5823
+ executeAt?: Date | null;
5824
+ payload?: string | null;
5825
+ }
5826
+ interface InvoiceSentEvent {
5827
+ id?: IdAndVersion;
5828
+ /** @readonly */
5829
+ data?: InvoiceFields;
5830
+ /** @readonly */
5831
+ status?: InvoiceStatusWithLiterals;
5832
+ }
5833
+ interface IdAndVersion {
5834
+ /** @format GUID */
5835
+ id?: string | null;
5836
+ version?: number | null;
5837
+ }
5838
+ interface InvoiceFields {
5839
+ /** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
5840
+ number?: string | null;
5841
+ /**
5842
+ * The invoice 3-letter currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format.
5843
+ * @format CURRENCY
5844
+ */
5845
+ currencyCode?: string | null;
5846
+ /** The invoice customer. The customer must be a contact of the site, with an email. */
5847
+ customer?: Customer;
5848
+ /**
5849
+ * Invoice dates: issue date and due date are mandatory and provided when the invoice is created.
5850
+ * Last seen date is the optional date when the invoice was last seen be UoU.
5851
+ */
5852
+ dates?: InvoiceDates;
5853
+ /**
5854
+ * Line items containing the details of the products or services relevant to the invoice, with their name, prices,
5855
+ * and quantity. There must be at least one line item on the invoice.
5856
+ */
5857
+ lineItems?: LineItems;
5858
+ /**
5859
+ * Locale of the invoice, containing the language.
5860
+ * This field is not mandatory but is used for display purposes, to determine the appearance of numbers and dates
5861
+ * on the invoice.
5862
+ */
5863
+ locale?: Locale;
5864
+ /**
5865
+ * The totals on the invoice.
5866
+ * The totals.subtotal, totals.total and totals.taxed_amount are calculated by the server based on the line items.
5867
+ * Alternatively, these fields can be provided in the invoice creation request, in this case, these values are fixed.
5868
+ * The totals contain fees and a discount, that apply to the invoice.
5869
+ */
5870
+ totals?: TotalPrice;
5871
+ /** An optional discount on the invoice. */
5872
+ discount?: Discount;
5873
+ /** The taxes of the invoice. */
5874
+ taxes?: CalculatedTaxes;
5875
+ /** The payments on the invoice. The invoice has status paid if its payments cover the invoice total. */
5876
+ payments?: Payments;
5877
+ /** Invoice metadata */
5878
+ metaData?: MetaData;
5879
+ /**
5880
+ * Not used
5881
+ * @deprecated
5882
+ */
5883
+ creationAdditional_BIInformation?: string | null;
5884
+ /**
5885
+ * The balance and amount paid on the invoice.
5886
+ * This read-only field is calculated based on the invoice totals and payments.
5887
+ * @readonly
5888
+ */
5889
+ dynamicTotals?: InvoiceDynamicPriceTotals;
5890
+ /** The invoice title */
5891
+ title?: string | null;
5892
+ /** Invoice custom fields */
5893
+ customFields?: CustomFieldValue[];
5894
+ /**
5895
+ * Not used
5896
+ * @deprecated
5897
+ */
5898
+ designTemplateId?: string | null;
5899
+ /**
5900
+ * Not used
5901
+ * @deprecated
5902
+ */
5903
+ createOrder?: boolean | null;
5904
+ /** The optional deposit of the invoice */
5905
+ deposit?: Deposit;
5906
+ /** Associated checkout for this invoice */
5907
+ ecomCheckoutId?: string | null;
5908
+ }
5909
+ interface Customer {
5910
+ contactId?: string | null;
5911
+ name?: string | null;
5912
+ email?: Email;
5913
+ address?: QuotesAddress;
5914
+ phone?: Phone;
5915
+ company?: Company;
5916
+ firstName?: string | null;
5917
+ lastName?: string | null;
5918
+ billingAddress?: CommonAddress;
5919
+ shippingAddress?: CommonAddress;
5920
+ }
5921
+ interface Email {
5922
+ address?: string;
5923
+ }
5924
+ interface QuotesAddress {
5925
+ street?: string | null;
5926
+ city?: string | null;
5927
+ zip?: string | null;
5928
+ state?: string | null;
5929
+ country?: string | null;
5930
+ /** @readonly */
5931
+ description?: AddressDescription;
5932
+ }
5933
+ interface AddressDescription {
5934
+ content?: string;
5935
+ placement?: PlacementWithLiterals;
5936
+ }
5937
+ declare enum Placement {
5938
+ Unknown = "Unknown",
5939
+ Replace = "Replace",
5940
+ Before = "Before",
5941
+ After = "After"
5942
+ }
5943
+ /** @enumType */
5944
+ type PlacementWithLiterals = Placement | 'Unknown' | 'Replace' | 'Before' | 'After';
5945
+ interface Phone {
5946
+ number?: string;
5947
+ }
5948
+ interface Company {
5949
+ name?: string;
5950
+ id?: string | null;
5951
+ }
5952
+ /** Physical address */
5953
+ interface CommonAddress extends CommonAddressStreetOneOf {
5954
+ /** Street name and number. */
5955
+ streetAddress?: StreetAddress;
5956
+ /** Main address line, usually street and number as free text. */
5957
+ addressLine?: string | null;
5958
+ /**
5959
+ * Country code.
5960
+ * @format COUNTRY
5961
+ */
5962
+ country?: string | null;
5963
+ /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
5964
+ subdivision?: string | null;
5965
+ /** City name. */
5966
+ city?: string | null;
5967
+ /** Zip/postal code. */
5968
+ postalCode?: string | null;
5969
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
5970
+ addressLine2?: string | null;
5971
+ }
5972
+ /** @oneof */
5973
+ interface CommonAddressStreetOneOf {
5974
+ /** Street name and number. */
5975
+ streetAddress?: StreetAddress;
5976
+ /** Main address line, usually street and number as free text. */
5977
+ addressLine?: string | null;
5978
+ }
5979
+ interface Subdivision {
5980
+ /** Short subdivision code. */
5981
+ code?: string;
5982
+ /** Subdivision full name. */
5983
+ name?: string;
5984
+ }
5985
+ declare enum SubdivisionType {
5986
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
5987
+ /** State */
5988
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
5989
+ /** County */
5990
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
5991
+ /** City/town */
5992
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
5993
+ /** Neighborhood/quarter */
5994
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
5995
+ /** Street/block */
5996
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
5997
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
5998
+ COUNTRY = "COUNTRY"
5999
+ }
6000
+ /** @enumType */
6001
+ 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';
6002
+ /** Subdivision Concordance values */
6003
+ interface StandardDetails {
6004
+ /**
6005
+ * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
6006
+ * @maxLength 20
6007
+ */
6008
+ iso31662?: string | null;
6009
+ }
6010
+ interface InvoiceDates {
6011
+ /** use UTC midnight date to set the issue date according to the site time zone */
6012
+ issueDate?: Date | null;
6013
+ /** use UTC midnight date to set the due date according to the site time zone */
6014
+ dueDate?: Date | null;
6015
+ /** <a href="http://joda-time.sourceforge.net/timezones.html">Valid time zones</a> */
6016
+ timeZoneCode?: string | null;
6017
+ /**
6018
+ * ignored in request use in response to get the site time zone
6019
+ * @readonly
6020
+ */
6021
+ lastSeenDate?: Date | null;
6022
+ }
6023
+ interface LineItems {
6024
+ lineItems?: LineItem[];
6025
+ }
6026
+ interface LineItem {
6027
+ /** @format GUID */
6028
+ id?: string;
6029
+ name?: string;
6030
+ description?: string | null;
6031
+ price?: BigDecimalWrapper;
6032
+ taxedTotal?: BigDecimalWrapper;
6033
+ quantity?: BigDecimalWrapper;
6034
+ taxes?: LineItemTax[];
6035
+ /** The source of the line item */
6036
+ source?: Source;
6037
+ /** The line-item level metadata. */
6038
+ metadata?: LineItemMetaData;
6039
+ }
6040
+ interface BigDecimalWrapper {
6041
+ serializedValue?: number;
6042
+ }
6043
+ interface LineItemTax {
6044
+ name?: string;
6045
+ rate?: BigDecimalWrapper;
6046
+ code?: string | null;
6047
+ }
6048
+ interface Source {
6049
+ /**
6050
+ * Source app or service ID.
6051
+ * @readonly
6052
+ */
6053
+ sourceId?: string;
6054
+ /**
6055
+ * App or service type.
6056
+ * @readonly
6057
+ */
6058
+ sourceType?: SourceTypeWithLiterals;
6059
+ }
6060
+ declare enum SourceType {
6061
+ UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
6062
+ WIX_APP = "WIX_APP",
6063
+ EXTERNAL = "EXTERNAL",
6064
+ ADMIN = "ADMIN",
6065
+ OTHER = "OTHER"
6066
+ }
6067
+ /** @enumType */
6068
+ type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'WIX_APP' | 'EXTERNAL' | 'ADMIN' | 'OTHER';
6069
+ interface LineItemMetaData {
6070
+ metadata?: Record<string, string>;
6071
+ }
6072
+ interface Locale {
6073
+ /** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
6074
+ language?: string;
6075
+ /** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
6076
+ country?: string | null;
6077
+ invariant?: string | null;
6078
+ }
6079
+ interface TotalPrice {
6080
+ /** the subtotal of the line items without the tax reduction */
6081
+ subtotal?: BigDecimalWrapper;
6082
+ /** the total price taking into account the itemized fees and the taxes */
6083
+ total?: BigDecimalWrapper;
6084
+ fees?: ItemizedFee[];
6085
+ discountAmount?: BigDecimalWrapper;
6086
+ taxedAmount?: BigDecimalWrapper;
6087
+ }
6088
+ interface ItemizedFee {
6089
+ name?: string;
6090
+ price?: BigDecimalWrapper;
6091
+ }
6092
+ interface Discount extends DiscountOneDiscountTypeOneOf {
6093
+ /** Discount as percentage value. */
6094
+ percentage?: BigDecimalWrapper;
6095
+ }
6096
+ /** @oneof */
6097
+ interface DiscountOneDiscountTypeOneOf {
6098
+ /** Discount as percentage value. */
6099
+ percentage?: BigDecimalWrapper;
6100
+ }
6101
+ interface CalculatedTaxes {
6102
+ /** consider calculated or not - cannot enforce set */
6103
+ taxes?: CalculatedTax[];
6104
+ }
6105
+ interface CalculatedTax {
6106
+ name?: string;
6107
+ rate?: BigDecimalWrapper;
6108
+ /** the costs on which the taxes are applied */
6109
+ taxable?: BigDecimalWrapper;
6110
+ /** the taxes as a result of the */
6111
+ taxed?: BigDecimalWrapper;
6112
+ code?: string | null;
6113
+ }
6114
+ interface Payments {
6115
+ payments?: InvoicesPayment[];
6116
+ }
6117
+ interface InvoicesPayment {
6118
+ /** document */
6119
+ id?: string;
6120
+ type?: string;
6121
+ amount?: BigDecimalWrapper;
6122
+ date?: Date | null;
6123
+ /**
6124
+ * The orderId of the order in cashier associated with the payment.
6125
+ * This field is populated for external payments that are charged by invoices via AddPayment endpoint.
6126
+ */
6127
+ orderId?: string | null;
6128
+ /**
6129
+ * The transactionId corresponding to the orderId of the payment which are returned by cashier.
6130
+ * This field is populated for external payments that are charged by invoices via AddPayment endpoint as well.
6131
+ */
6132
+ transactionId?: string | null;
6133
+ }
6134
+ interface MetaData {
6135
+ notes?: string | null;
6136
+ legalTerms?: string | null;
6137
+ sourceUrl?: string | null;
6138
+ sourceProperties?: Record<string, string>;
6139
+ source?: string | null;
6140
+ sourceRefId?: string | null;
6141
+ /** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
6142
+ allowEditByOthers?: boolean | null;
6143
+ }
6144
+ interface InvoiceDynamicPriceTotals {
6145
+ paidAmount?: BigDecimalWrapper;
6146
+ balance?: BigDecimalWrapper;
6147
+ }
6148
+ /**
6149
+ * A custom field value is used to add additional data to a financial document or to a financial document template.
6150
+ * The custom field value may be based on a custom field definition.
6151
+ */
6152
+ interface CustomFieldValue {
6153
+ /**
6154
+ * The unique id of the custom field value
6155
+ * @format GUID
6156
+ * @readonly
6157
+ */
6158
+ id?: string | null;
6159
+ /**
6160
+ * The display name of the custom field value
6161
+ * @maxLength 50
6162
+ */
6163
+ displayName?: string;
6164
+ /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
6165
+ namespace?: string | null;
6166
+ /** The group of the custom field indicates its intended placement in the financial document */
6167
+ group?: CustomFieldGroupWithLiterals;
6168
+ /** The value of the custom field */
6169
+ value?: Value;
6170
+ /**
6171
+ * The optional key of the custom field definition on which the custom field value is based
6172
+ * @maxLength 50
6173
+ */
6174
+ originCustomFieldKey?: string | null;
6175
+ }
6176
+ declare enum CustomFieldGroup {
6177
+ UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
6178
+ BUSINESS_DETAILS = "BUSINESS_DETAILS",
6179
+ CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
6180
+ DOCUMENT = "DOCUMENT",
6181
+ FOOTER = "FOOTER",
6182
+ OTHER = "OTHER"
6183
+ }
6184
+ /** @enumType */
6185
+ type CustomFieldGroupWithLiterals = CustomFieldGroup | 'UNKNOWN_CUSTOM_FIELD_GROUP' | 'BUSINESS_DETAILS' | 'CUSTOMER_DETAILS' | 'DOCUMENT' | 'FOOTER' | 'OTHER';
6186
+ interface Value {
6187
+ value?: string;
6188
+ valueType?: ValueTypeWithLiterals;
6189
+ }
6190
+ declare enum ValueType {
6191
+ UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
6192
+ STRING = "STRING",
6193
+ DATE = "DATE",
6194
+ BOOLEAN = "BOOLEAN",
6195
+ NUMBER = "NUMBER"
6196
+ }
6197
+ /** @enumType */
6198
+ type ValueTypeWithLiterals = ValueType | 'UNKNOWN_VALUE_TYPE' | 'STRING' | 'DATE' | 'BOOLEAN' | 'NUMBER';
6199
+ interface Deposit {
6200
+ /**
6201
+ * The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total.
6202
+ * @format DECIMAL_VALUE
6203
+ * @decimalValue options { gt:0.00 }
6204
+ */
6205
+ flatAmount?: string;
6206
+ /**
6207
+ * The read-only percentage value of the deposit.
6208
+ * It is computed according to the flat_amount and the invoice total and is rounded to 2 digits precision.
6209
+ * @format DECIMAL_VALUE
6210
+ * @decimalValue options { gt:0.00, lte:100 }
6211
+ * @readonly
6212
+ */
6213
+ percentage?: string;
6214
+ /** The type of the deposit. The default is FLAT. */
6215
+ type?: DepositTypeWithLiterals;
6216
+ }
6217
+ declare enum DepositType {
6218
+ UNKNOWN = "UNKNOWN",
6219
+ FLAT = "FLAT",
6220
+ PERCENTAGE = "PERCENTAGE"
6221
+ }
6222
+ /** @enumType */
6223
+ type DepositTypeWithLiterals = DepositType | 'UNKNOWN' | 'FLAT' | 'PERCENTAGE';
6224
+ /**
6225
+ * InvoiceStatus allowed transitions based on current status:
6226
+ * Draft -> Deleted, Paid, Partially Paid, Sent
6227
+ * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
6228
+ * Processing -> PartiallyPaid, Paid, Sent
6229
+ * Paid -> Void
6230
+ * PartiallyPaid -> Void, (PartialAndOverdue)
6231
+ * Void -> Deleted
6232
+ * Deleted
6233
+ */
6234
+ declare enum InvoiceStatus {
6235
+ Draft = "Draft",
6236
+ Sent = "Sent",
6237
+ Processing = "Processing",
6238
+ Paid = "Paid",
6239
+ Overdue = "Overdue",
6240
+ Void = "Void",
6241
+ Deleted = "Deleted",
6242
+ PartiallyPaid = "PartiallyPaid",
6243
+ PartialAndOverdue = "PartialAndOverdue"
6244
+ }
6245
+ /** @enumType */
6246
+ type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
6247
+ interface TriggerSideEffectsFromLegacyData {
6248
+ storeId?: string;
6249
+ orderId?: string;
6250
+ ordersExperiments?: OrdersExperiments;
6251
+ }
6252
+ /** @docsIgnore */
6253
+ type PreparePaymentCollectionApplicationErrors = {
6254
+ code?: 'PAYMENT_METHODS_NOT_FOUND';
6255
+ description?: string;
6256
+ data?: Record<string, any>;
6257
+ } | {
6258
+ code?: 'ORDER_CANCELED';
6259
+ description?: string;
6260
+ data?: Record<string, any>;
6261
+ } | {
6262
+ code?: 'INVALID_AMOUNT';
6263
+ description?: string;
6264
+ data?: Record<string, any>;
6265
+ } | {
6266
+ code?: 'ORDER_ALREADY_PAID';
6267
+ description?: string;
6268
+ data?: Record<string, any>;
6269
+ } | {
6270
+ code?: 'NO_ASSOCIATED_ECOM_ORDER';
6271
+ description?: string;
6272
+ data?: Record<string, any>;
6273
+ } | {
6274
+ code?: 'ORDER_HAS_CHARGEBACKS';
6275
+ description?: string;
6276
+ data?: Record<string, any>;
6277
+ };
6278
+ /** @docsIgnore */
6279
+ type RecordManuallyCollectedPaymentApplicationErrors = {
6280
+ code?: 'ORDER_ALREADY_PAID';
6281
+ description?: string;
6282
+ data?: Record<string, any>;
6283
+ } | {
6284
+ code?: 'INVALID_AMOUNT';
6285
+ description?: string;
6286
+ data?: Record<string, any>;
6287
+ } | {
6288
+ code?: 'ORDER_CANCELED';
6289
+ description?: string;
6290
+ data?: Record<string, any>;
6291
+ };
6292
+ /** @docsIgnore */
6293
+ type PaymentCollectionMarkOrderAsPaidApplicationErrors = {
6294
+ code?: 'ORDER_ALREADY_PAID';
6295
+ description?: string;
6296
+ data?: Record<string, any>;
6297
+ } | {
6298
+ code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
6299
+ description?: string;
6300
+ data?: Record<string, any>;
6301
+ } | {
6302
+ code?: 'ORDER_HAS_CHARGEBACKS';
6303
+ description?: string;
6304
+ data?: Record<string, any>;
6305
+ };
6306
+ /** @docsIgnore */
6307
+ type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors = {
6308
+ code?: 'ORDER_ALREADY_PAID';
6309
+ description?: string;
6310
+ data?: Record<string, any>;
6311
+ } | {
6312
+ code?: 'ORDER_CANCELED';
6313
+ description?: string;
6314
+ data?: Record<string, any>;
6315
+ };
6316
+ /** @docsIgnore */
6317
+ type TriggerRefundApplicationErrors = {
6318
+ code?: 'PAYMENTS_NOT_FOUND';
6319
+ description?: string;
6320
+ data?: Record<string, any>;
6321
+ } | {
6322
+ code?: 'REFUND_NOT_AVAILABLE';
6323
+ description?: string;
6324
+ data?: Record<string, any>;
6325
+ } | {
6326
+ code?: 'INVALID_AMOUNT';
6327
+ description?: string;
6328
+ data?: Record<string, any>;
6329
+ };
6330
+ /** @docsIgnore */
6331
+ type VoidAuthorizedPaymentsApplicationErrors = {
6332
+ code?: 'PAYMENT_ALREADY_VOIDED';
6333
+ description?: string;
6334
+ data?: Record<string, any>;
6335
+ } | {
6336
+ code?: 'PAYMENT_ALREADY_CAPTURED';
6337
+ description?: string;
6338
+ data?: Record<string, any>;
6339
+ } | {
6340
+ code?: 'PAYMENT_NOT_AUTHORIZED';
6341
+ description?: string;
6342
+ data?: Record<string, any>;
6343
+ } | {
6344
+ code?: 'PAYMENT_NOT_FOUND';
6345
+ description?: string;
6346
+ data?: Record<string, any>;
6347
+ } | {
6348
+ code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
6349
+ description?: string;
6350
+ data?: Record<string, any>;
6351
+ };
6352
+ /** @docsIgnore */
6353
+ type CaptureAuthorizedPaymentsApplicationErrors = {
6354
+ code?: 'INVALID_AMOUNT';
6355
+ description?: string;
6356
+ data?: Record<string, any>;
6357
+ } | {
6358
+ code?: 'NOT_REGULAR_ONLINE_PAYMENT';
6359
+ description?: string;
6360
+ data?: Record<string, any>;
6361
+ } | {
6362
+ code?: 'PAYMENT_ALREADY_VOIDED';
6363
+ description?: string;
6364
+ data?: Record<string, any>;
6365
+ } | {
6366
+ code?: 'PAYMENT_ALREADY_CAPTURED';
6367
+ description?: string;
6368
+ data?: Record<string, any>;
6369
+ } | {
6370
+ code?: 'PAYMENT_NOT_AUTHORIZED';
6371
+ description?: string;
6372
+ data?: Record<string, any>;
6373
+ } | {
6374
+ code?: 'PAYMENT_NOT_FOUND';
6375
+ description?: string;
6376
+ data?: Record<string, any>;
6377
+ } | {
6378
+ code?: 'PAYMENT_GATEWAY_ID_NOT_FOUND';
6379
+ description?: string;
6380
+ data?: Record<string, any>;
6381
+ } | {
6382
+ code?: 'PAYMENT_HAS_PENDING_CAPTURE';
6383
+ description?: string;
6384
+ data?: Record<string, any>;
6385
+ };
6386
+ /** @docsIgnore */
6387
+ type GetOrderApplicationErrors = {
6388
+ code?: 'ORDER_NOT_FOUND';
6389
+ description?: string;
6390
+ data?: Record<string, any>;
6391
+ };
6392
+ /** @docsIgnore */
6393
+ type CreateOrderApplicationErrors = {
6394
+ code?: 'PURCHASED_DATE_CANNOT_BE_IN_FUTURE';
6395
+ description?: string;
6396
+ data?: Record<string, any>;
6397
+ };
6398
+ /** @docsIgnore */
6399
+ type UpdateOrderApplicationErrors = {
6400
+ code?: 'ORDER_IS_PENDING';
6401
+ description?: string;
6402
+ data?: Record<string, any>;
6403
+ } | {
6404
+ code?: 'ORDER_IS_REJECTED';
6405
+ description?: string;
6406
+ data?: Record<string, any>;
6407
+ };
6408
+ /** @docsIgnore */
6409
+ type CommitDeltasApplicationErrors = {
6410
+ code?: 'EMPTY_DELTAS_TO_COMMIT';
6411
+ description?: string;
6412
+ data?: Record<string, any>;
6413
+ };
6414
+ /** @docsIgnore */
6415
+ type CancelOrderApplicationErrors = {
6416
+ code?: 'ORDER_HAS_AUTHORIZED_TRANSACTION';
6417
+ description?: string;
6418
+ data?: Record<string, any>;
6419
+ } | {
6420
+ code?: 'ORDER_IS_PENDING';
6421
+ description?: string;
6422
+ data?: Record<string, any>;
6423
+ } | {
6424
+ code?: 'ORDER_IS_REJECTED';
6425
+ description?: string;
6426
+ data?: Record<string, any>;
6427
+ };
6428
+ /** @docsIgnore */
6429
+ type UpdateOrderStatusApplicationErrors = {
6430
+ code?: 'STATUS_NOT_SUPPORTED';
6431
+ description?: string;
6432
+ data?: Record<string, any>;
6433
+ } | {
6434
+ code?: 'UNSUPPORTED_TRANSITION';
6435
+ description?: string;
6436
+ data?: Record<string, any>;
6437
+ } | {
6438
+ code?: 'STATUS_ALREADY_SET';
6439
+ description?: string;
6440
+ data?: Record<string, any>;
6441
+ };
4064
6442
 
4065
6443
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4066
6444
  getUrl: (context: any) => string;
@@ -4139,4 +6517,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
4139
6517
  declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
4140
6518
  declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
4141
6519
 
4142
- export { type __PublicMethodMetaInfo, addActivity, aggregateOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, commitDeltas, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
6520
+ export { type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, type BatchOfTriggerReindexOrderRequest as BatchOfTriggerReindexOrderRequestOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasApplicationErrors as CommitDeltasApplicationErrorsOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type ContinueSideEffectsFlowInLegacyData as ContinueSideEffectsFlowInLegacyDataOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type IndexingMessage as IndexingMessageOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, ItemTypeItemType as ItemTypeItemTypeOriginal, type ItemTypeItemTypeWithLiterals as ItemTypeItemTypeWithLiteralsOriginal, type ItemType as ItemTypeOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type ModifierGroup as ModifierGroupOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, type SnapshotMessage as SnapshotMessageOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, type StreetAddress as StreetAddressOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type TriggerSideEffectsFromLegacyData as TriggerSideEffectsFromLegacyDataOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type __PublicMethodMetaInfo, addActivity, aggregateOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, commitDeltas, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };