@wix/auto_sdk_ecom_checkout 1.0.42 → 1.0.44

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.
@@ -1,3 +1,5 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
1
3
  interface Checkout {
2
4
  /**
3
5
  * Checkout ID.
@@ -176,6 +178,15 @@ interface Checkout {
176
178
  * @immutable
177
179
  */
178
180
  externalReference?: ExternalReference;
181
+ /**
182
+ * Order ID.
183
+ *
184
+ * This field is empty until the checkout completes and becomes an order.
185
+ * @internal
186
+ * @format GUID
187
+ * @readonly
188
+ */
189
+ orderId?: string | null;
179
190
  /**
180
191
  * Payment for subscriptions after free trial period.
181
192
  * @readonly
@@ -188,6 +199,23 @@ interface Checkout {
188
199
  * @format GUID
189
200
  */
190
201
  businessLocationId?: string | null;
202
+ /**
203
+ * Whether payment is required to create an order.
204
+ *
205
+ * Payment is required if any of the following conditions are met:
206
+ * 1. At least one item requires a payment method. This can be because the item has the `savePaymentMethod` field set to `true`, or the item is a subscription with a price greater than zero.
207
+ * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
208
+ * @internal
209
+ * @readonly
210
+ */
211
+ paymentRequired?: boolean;
212
+ /**
213
+ * Charges information for each subscription in the checkout.
214
+ * @internal
215
+ * @readonly
216
+ * @maxSize 100
217
+ */
218
+ subscriptionCharges?: SubscriptionCharges[];
191
219
  /**
192
220
  * Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
193
221
  * @readonly
@@ -372,12 +400,25 @@ interface LineItem {
372
400
  savePaymentMethod?: boolean;
373
401
  /** Address to use for tax calculation purposes. */
374
402
  taxableAddress?: TaxableAddress;
403
+ /**
404
+ * Custom extended fields for the line item object.
405
+ *
406
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
407
+ * @internal
408
+ */
409
+ extendedFields?: ExtendedFields;
375
410
  /**
376
411
  * Policies to be displayed to the customer on the checkout page.
377
412
  * @readonly
378
413
  * @maxSize 5
379
414
  */
380
415
  policies?: Policy[];
416
+ /**
417
+ * ID of the app managing the inventory.
418
+ * @internal
419
+ * @format GUID
420
+ */
421
+ inventoryAppId?: string | null;
381
422
  /**
382
423
  * Whether the item can only be purchased by site members.
383
424
  *
@@ -552,6 +593,11 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
552
593
  colorInfo?: Color;
553
594
  /** Description line name. */
554
595
  name?: DescriptionLineName;
596
+ /**
597
+ * Whether the description line originates from a modifier.
598
+ * @internal
599
+ */
600
+ modifierDescriptionLine?: boolean;
555
601
  }
556
602
  /** @oneof */
557
603
  interface DescriptionLineValueOneOf {
@@ -615,6 +661,8 @@ declare enum DescriptionLineType {
615
661
  /** Color type. */
616
662
  COLOR = "COLOR"
617
663
  }
664
+ /** @enumType */
665
+ type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
618
666
  interface FocalPoint {
619
667
  /** X-coordinate of the focal point. */
620
668
  x?: number;
@@ -721,6 +769,11 @@ interface SubscriptionSettings {
721
769
  * If None => no free trial
722
770
  */
723
771
  freeTrialPeriod?: FreeTrialPeriod;
772
+ /**
773
+ * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
774
+ * @internal
775
+ */
776
+ startDate?: Date | null;
724
777
  }
725
778
  /** Frequency unit of recurring payment */
726
779
  declare enum SubscriptionFrequency {
@@ -1559,6 +1612,14 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1559
1612
  * @targetRemovalDate 2024-06-01
1560
1613
  */
1561
1614
  lineItemIds?: string[];
1615
+ /**
1616
+ * Number of subscription cycle this discount applies to
1617
+ * default None - all billing cycle
1618
+ * @internal
1619
+ * @min 1
1620
+ * @max 999
1621
+ */
1622
+ subscriptionCycles?: number | null;
1562
1623
  }
1563
1624
  /** @oneof */
1564
1625
  interface AppliedDiscountDiscountSourceOneOf {
@@ -1974,6 +2035,14 @@ interface AdditionalFee {
1974
2035
  * @format GUID
1975
2036
  */
1976
2037
  lineItemIds?: string[];
2038
+ /**
2039
+ * Number of subscription cycle this fee applies to
2040
+ * default None - all billing cycle
2041
+ * @internal
2042
+ * @min 1
2043
+ * @max 999
2044
+ */
2045
+ subscriptionCycles?: number | null;
1977
2046
  /** the source the additional fee was added from */
1978
2047
  source?: AdditionalFeeSourceWithLiterals;
1979
2048
  }
@@ -2060,6 +2129,8 @@ declare enum SuggestedFix {
2060
2129
  /** The line item should be removed from the cart or checkout to resolve the violation. */
2061
2130
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2062
2131
  }
2132
+ /** @enumType */
2133
+ type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2063
2134
  /** General (other) violation. */
2064
2135
  interface Other {
2065
2136
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
@@ -2071,6 +2142,11 @@ interface TargetLineItem {
2071
2142
  name?: NameInLineItemWithLiterals;
2072
2143
  /** ID of the line item containing the violation. */
2073
2144
  _id?: string | null;
2145
+ /**
2146
+ * Suggested fix for resolving the line item violation.
2147
+ * @internal
2148
+ */
2149
+ suggestedFix?: SuggestedFixWithLiterals;
2074
2150
  }
2075
2151
  interface CustomSettings {
2076
2152
  /**
@@ -2308,6 +2384,20 @@ interface CustomLineItem {
2308
2384
  deliveryProfileId?: string | null;
2309
2385
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
2310
2386
  catalogReference?: CatalogReference;
2387
+ /**
2388
+ * Whether the price is not yet defined, and will be updated after the order is created.
2389
+ *
2390
+ * Default: `false`
2391
+ * @internal
2392
+ */
2393
+ priceUndetermined?: boolean;
2394
+ /**
2395
+ * Whether the line item quantity is fixed and cannot be changed.
2396
+ *
2397
+ * Default: `false`
2398
+ * @internal
2399
+ */
2400
+ fixedQuantity?: boolean;
2311
2401
  /**
2312
2402
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
2313
2403
  * @minLength 1
@@ -2327,6 +2417,12 @@ interface CustomLineItem {
2327
2417
  * @maxSize 5
2328
2418
  */
2329
2419
  policies?: Policy[];
2420
+ /**
2421
+ * ID of the app managing the inventory.
2422
+ * @internal
2423
+ * @format GUID
2424
+ */
2425
+ inventoryAppId?: string | null;
2330
2426
  /**
2331
2427
  * Whether the item can only be purchased by site members.
2332
2428
  *
@@ -2684,6 +2780,12 @@ interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOne
2684
2780
  * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
2685
2781
  */
2686
2782
  paymentGatewayOrderId?: string | null;
2783
+ /**
2784
+ * Whether an order was successfully created from this checkout and the payment transaction was completed
2785
+ * @internal
2786
+ * @readonly
2787
+ */
2788
+ checkoutCompleted?: boolean;
2687
2789
  }
2688
2790
  /** @oneof */
2689
2791
  interface CreateOrderAndChargeResponseIdOneOf {
@@ -2720,6 +2822,12 @@ interface MarkCheckoutAsCompletedRequest {
2720
2822
  * @format GUID
2721
2823
  */
2722
2824
  _id: string;
2825
+ /**
2826
+ * Order ID.
2827
+ * @internal
2828
+ * @format GUID
2829
+ */
2830
+ orderId?: string | null;
2723
2831
  }
2724
2832
  interface MarkCheckoutAsCompletedResponse {
2725
2833
  }
@@ -3538,6 +3646,280 @@ declare enum WebhookIdentityType {
3538
3646
  }
3539
3647
  /** @enumType */
3540
3648
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3649
+ type CreateCheckoutApplicationErrors = {
3650
+ code?: 'SELECTED_CARRIER_SERVICE_OPTION_NOT_FOUND';
3651
+ description?: string;
3652
+ data?: ShippingCalculationErrorData;
3653
+ } | {
3654
+ code?: 'INVALID_SELECTED_CARRIER_SERVICE_OPTION';
3655
+ description?: string;
3656
+ data?: Record<string, any>;
3657
+ } | {
3658
+ code?: 'GIFT_CARD_NOT_FOUND';
3659
+ description?: string;
3660
+ data?: Record<string, any>;
3661
+ } | {
3662
+ code?: 'GIFT_CARD_CODE_INVALID';
3663
+ description?: string;
3664
+ data?: Record<string, any>;
3665
+ } | {
3666
+ code?: 'GIFT_CARD_IS_EMPTY';
3667
+ description?: string;
3668
+ data?: Record<string, any>;
3669
+ } | {
3670
+ code?: 'GIFT_CARD_DISABLED';
3671
+ description?: string;
3672
+ data?: Record<string, any>;
3673
+ } | {
3674
+ code?: 'GIFT_CARD_EXPIRED';
3675
+ description?: string;
3676
+ data?: Record<string, any>;
3677
+ } | {
3678
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
3679
+ description?: string;
3680
+ data?: Record<string, any>;
3681
+ } | {
3682
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
3683
+ description?: string;
3684
+ data?: Record<string, any>;
3685
+ } | {
3686
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
3687
+ description?: string;
3688
+ data?: Record<string, any>;
3689
+ } | {
3690
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
3691
+ description?: string;
3692
+ data?: Record<string, any>;
3693
+ } | {
3694
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
3695
+ description?: string;
3696
+ data?: Record<string, any>;
3697
+ } | {
3698
+ code?: 'SITE_MUST_ACCEPT_PAYMENTS';
3699
+ description?: string;
3700
+ data?: Record<string, any>;
3701
+ };
3702
+ type UpdateCheckoutApplicationErrors = {
3703
+ code?: 'SELECTED_CARRIER_SERVICE_OPTION_NOT_FOUND';
3704
+ description?: string;
3705
+ data?: ShippingCalculationErrorData;
3706
+ } | {
3707
+ code?: 'INVALID_SELECTED_CARRIER_SERVICE_OPTION';
3708
+ description?: string;
3709
+ data?: Record<string, any>;
3710
+ } | {
3711
+ code?: 'GIFT_CARD_NOT_FOUND';
3712
+ description?: string;
3713
+ data?: Record<string, any>;
3714
+ } | {
3715
+ code?: 'GIFT_CARD_CODE_INVALID';
3716
+ description?: string;
3717
+ data?: Record<string, any>;
3718
+ } | {
3719
+ code?: 'GIFT_CARD_IS_EMPTY';
3720
+ description?: string;
3721
+ data?: Record<string, any>;
3722
+ } | {
3723
+ code?: 'GIFT_CARD_DISABLED';
3724
+ description?: string;
3725
+ data?: Record<string, any>;
3726
+ } | {
3727
+ code?: 'GIFT_CARD_EXPIRED';
3728
+ description?: string;
3729
+ data?: Record<string, any>;
3730
+ } | {
3731
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
3732
+ description?: string;
3733
+ data?: Record<string, any>;
3734
+ } | {
3735
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
3736
+ description?: string;
3737
+ data?: Record<string, any>;
3738
+ } | {
3739
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
3740
+ description?: string;
3741
+ data?: Record<string, any>;
3742
+ } | {
3743
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
3744
+ description?: string;
3745
+ data?: Record<string, any>;
3746
+ } | {
3747
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
3748
+ description?: string;
3749
+ data?: Record<string, any>;
3750
+ };
3751
+ type AddToCheckoutApplicationErrors = {
3752
+ code?: 'CHECKOUT_IS_COMPLETE';
3753
+ description?: string;
3754
+ data?: Record<string, any>;
3755
+ };
3756
+ type CreateOrderApplicationErrors = {
3757
+ code?: 'PAYMENT_ERROR';
3758
+ description?: string;
3759
+ data?: PaymentErrorResponseData;
3760
+ } | {
3761
+ code?: 'PAYMENT_PROVIDER_IS_NOT_AVAILABLE_ON_SITE';
3762
+ description?: string;
3763
+ data?: Record<string, any>;
3764
+ } | {
3765
+ code?: 'CHECKOUT_ALREADY_PAID';
3766
+ description?: string;
3767
+ data?: DoublePaymentErrorData;
3768
+ } | {
3769
+ code?: 'CHECKOUT_PAYMENT_ALREADY_IN_PROGRESS';
3770
+ description?: string;
3771
+ data?: DoublePaymentErrorData;
3772
+ } | {
3773
+ code?: 'CALCULATION_ERROR';
3774
+ description?: string;
3775
+ data?: CalculationErrors;
3776
+ } | {
3777
+ code?: 'REDEEM_GIFT_CARD_ERROR';
3778
+ description?: string;
3779
+ data?: RedeemErrorData;
3780
+ } | {
3781
+ code?: 'PARTIAL_OUT_OF_STOCK';
3782
+ description?: string;
3783
+ data?: Record<string, any>;
3784
+ } | {
3785
+ code?: 'FULL_OUT_OF_STOCK';
3786
+ description?: string;
3787
+ data?: Record<string, any>;
3788
+ } | {
3789
+ code?: 'EMPTY_CHECKOUT';
3790
+ description?: string;
3791
+ data?: Record<string, any>;
3792
+ } | {
3793
+ code?: 'CHECKOUT_CHANGED';
3794
+ description?: string;
3795
+ data?: Record<string, any>;
3796
+ } | {
3797
+ code?: 'SUBSCRIPTION_WITH_ZERO_TOTAL';
3798
+ description?: string;
3799
+ data?: Record<string, any>;
3800
+ } | {
3801
+ code?: 'SUBSCRIPTION_WITH_SEVERAL_LINE_ITEMS';
3802
+ description?: string;
3803
+ data?: Record<string, any>;
3804
+ } | {
3805
+ code?: 'SUBSCRIPTION_WITH_GIFT_CARD';
3806
+ description?: string;
3807
+ data?: Record<string, any>;
3808
+ } | {
3809
+ code?: 'NO_SELECTED_CARRIER_SERVICE_OPTION';
3810
+ description?: string;
3811
+ data?: Record<string, any>;
3812
+ } | {
3813
+ code?: 'VIOLATIONS_WITH_ERROR_SEVERITY';
3814
+ description?: string;
3815
+ data?: ViolationsList;
3816
+ } | {
3817
+ code?: 'FAILED_TO_RETRIEVE_VALIDATIONS_VIOLATIONS';
3818
+ description?: string;
3819
+ data?: Record<string, any>;
3820
+ } | {
3821
+ code?: 'NO_SAVE_PAYMENT_METHOD_CONFIRMATION';
3822
+ description?: string;
3823
+ data?: Record<string, any>;
3824
+ } | {
3825
+ code?: 'SELECTED_CARRIER_SERVICE_OPTION_NO_LONGER_AVAILABLE';
3826
+ description?: string;
3827
+ data?: Record<string, any>;
3828
+ } | {
3829
+ code?: 'MEMBERS_ONLY_ITEM';
3830
+ description?: string;
3831
+ data?: Record<string, any>;
3832
+ } | {
3833
+ code?: 'GIFT_CARD_CANNOT_BE_USED_TO_PURCHASE_GIFT_CARD';
3834
+ description?: string;
3835
+ data?: Record<string, any>;
3836
+ } | {
3837
+ code?: 'COUPON_CANNOT_BE_USED_TO_PURCHASE_GIFT_CARD';
3838
+ description?: string;
3839
+ data?: Record<string, any>;
3840
+ };
3841
+ type CreateOrderAndChargeApplicationErrors = {
3842
+ code?: 'PAYMENT_ERROR';
3843
+ description?: string;
3844
+ data?: PaymentErrorResponseData;
3845
+ } | {
3846
+ code?: 'PAYMENT_PROVIDER_IS_NOT_AVAILABLE_ON_SITE';
3847
+ description?: string;
3848
+ data?: Record<string, any>;
3849
+ } | {
3850
+ code?: 'CHECKOUT_ALREADY_PAID';
3851
+ description?: string;
3852
+ data?: DoublePaymentErrorData;
3853
+ } | {
3854
+ code?: 'CHECKOUT_PAYMENT_ALREADY_IN_PROGRESS';
3855
+ description?: string;
3856
+ data?: DoublePaymentErrorData;
3857
+ } | {
3858
+ code?: 'CALCULATION_ERROR';
3859
+ description?: string;
3860
+ data?: CalculationErrors;
3861
+ } | {
3862
+ code?: 'REDEEM_GIFT_CARD_ERROR';
3863
+ description?: string;
3864
+ data?: RedeemErrorData;
3865
+ } | {
3866
+ code?: 'PARTIAL_OUT_OF_STOCK';
3867
+ description?: string;
3868
+ data?: Record<string, any>;
3869
+ } | {
3870
+ code?: 'FULL_OUT_OF_STOCK';
3871
+ description?: string;
3872
+ data?: Record<string, any>;
3873
+ } | {
3874
+ code?: 'EMPTY_CHECKOUT';
3875
+ description?: string;
3876
+ data?: Record<string, any>;
3877
+ } | {
3878
+ code?: 'CHECKOUT_CHANGED';
3879
+ description?: string;
3880
+ data?: Record<string, any>;
3881
+ } | {
3882
+ code?: 'SUBSCRIPTION_WITH_ZERO_TOTAL';
3883
+ description?: string;
3884
+ data?: Record<string, any>;
3885
+ } | {
3886
+ code?: 'SUBSCRIPTION_WITH_SEVERAL_LINE_ITEMS';
3887
+ description?: string;
3888
+ data?: Record<string, any>;
3889
+ } | {
3890
+ code?: 'SUBSCRIPTION_WITH_GIFT_CARD';
3891
+ description?: string;
3892
+ data?: Record<string, any>;
3893
+ } | {
3894
+ code?: 'NO_SELECTED_CARRIER_SERVICE_OPTION';
3895
+ description?: string;
3896
+ data?: Record<string, any>;
3897
+ } | {
3898
+ code?: 'NO_SAVE_PAYMENT_METHOD_CONFIRMATION';
3899
+ description?: string;
3900
+ data?: Record<string, any>;
3901
+ } | {
3902
+ code?: 'SELECTED_CARRIER_SERVICE_OPTION_NO_LONGER_AVAILABLE';
3903
+ description?: string;
3904
+ data?: Record<string, any>;
3905
+ } | {
3906
+ code?: 'MEMBERS_ONLY_ITEM';
3907
+ description?: string;
3908
+ data?: Record<string, any>;
3909
+ } | {
3910
+ code?: 'GIFT_CARD_CANNOT_BE_USED_TO_PURCHASE_GIFT_CARD';
3911
+ description?: string;
3912
+ data?: Record<string, any>;
3913
+ } | {
3914
+ code?: 'COUPON_CANNOT_BE_USED_TO_PURCHASE_GIFT_CARD';
3915
+ description?: string;
3916
+ data?: Record<string, any>;
3917
+ };
3918
+ type MarkCheckoutAsCompletedAndRedirectToUrlApplicationErrors = {
3919
+ code?: 'UNAUTHENTICATED_TOKEN';
3920
+ description?: string;
3921
+ data?: Record<string, any>;
3922
+ };
3541
3923
  interface BaseEventMetadata {
3542
3924
  /**
3543
3925
  * App instance ID.
@@ -3586,17 +3968,143 @@ interface CheckoutCompletedEnvelope {
3586
3968
  data: CheckoutMarkedAsCompleted;
3587
3969
  metadata: EventMetadata;
3588
3970
  }
3971
+ /**
3972
+ * Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed.
3973
+ * @permissionScope Manage Stores - all permissions
3974
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3975
+ * @permissionScope Manage Stores
3976
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3977
+ * @permissionScope Read eCommerce - all read permissions
3978
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3979
+ * @permissionScope Read Orders
3980
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3981
+ * @permissionScope Read Stores - all read permissions
3982
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3983
+ * @permissionScope Manage Restaurants - all permissions
3984
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3985
+ * @permissionScope Manage eCommerce - all permissions
3986
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3987
+ * @permissionScope Manage Orders
3988
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3989
+ * @permissionId ECOM.READ_CHECKOUTS
3990
+ * @webhook
3991
+ * @eventType wix.ecom.v1.checkout_completed
3992
+ * @slug completed
3993
+ */
3994
+ declare function onCheckoutCompleted(handler: (event: CheckoutCompletedEnvelope) => void | Promise<void>): void;
3589
3995
  interface CheckoutCreatedEnvelope {
3590
3996
  entity: Checkout;
3591
3997
  metadata: EventMetadata;
3592
3998
  }
3999
+ /**
4000
+ * Triggered when a checkout is created.
4001
+ * @permissionScope Manage Stores - all permissions
4002
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4003
+ * @permissionScope Manage Stores
4004
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4005
+ * @permissionScope Read eCommerce - all read permissions
4006
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
4007
+ * @permissionScope Read Orders
4008
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
4009
+ * @permissionScope Read Stores - all read permissions
4010
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
4011
+ * @permissionScope Manage Restaurants - all permissions
4012
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4013
+ * @permissionScope Manage eCommerce - all permissions
4014
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4015
+ * @permissionScope Manage Orders
4016
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
4017
+ * @permissionId ECOM.READ_CHECKOUTS
4018
+ * @webhook
4019
+ * @eventType wix.ecom.v1.checkout_created
4020
+ * @slug created
4021
+ */
4022
+ declare function onCheckoutCreated(handler: (event: CheckoutCreatedEnvelope) => void | Promise<void>): void;
3593
4023
  interface CheckoutDeletedEnvelope {
3594
4024
  metadata: EventMetadata;
3595
4025
  }
4026
+ /**
4027
+ * Triggered when a checkout is deleted.
4028
+ * @permissionScope Manage Stores - all permissions
4029
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4030
+ * @permissionScope Manage Stores
4031
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4032
+ * @permissionScope Read eCommerce - all read permissions
4033
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
4034
+ * @permissionScope Read Orders
4035
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
4036
+ * @permissionScope Read Stores - all read permissions
4037
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
4038
+ * @permissionScope Manage Restaurants - all permissions
4039
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4040
+ * @permissionScope Manage eCommerce - all permissions
4041
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4042
+ * @permissionScope Manage Orders
4043
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
4044
+ * @permissionId ECOM.READ_CHECKOUTS
4045
+ * @webhook
4046
+ * @eventType wix.ecom.v1.checkout_deleted
4047
+ * @slug deleted
4048
+ */
4049
+ declare function onCheckoutDeleted(handler: (event: CheckoutDeletedEnvelope) => void | Promise<void>): void;
3596
4050
  interface CheckoutUpdatedEnvelope {
3597
4051
  entity: Checkout;
3598
4052
  metadata: EventMetadata;
3599
4053
  }
4054
+ /**
4055
+ * Triggered when a checkout is updated.
4056
+ * @permissionScope Manage Stores - all permissions
4057
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4058
+ * @permissionScope Manage Stores
4059
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
4060
+ * @permissionScope Read eCommerce - all read permissions
4061
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
4062
+ * @permissionScope Read Orders
4063
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
4064
+ * @permissionScope Read Stores - all read permissions
4065
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
4066
+ * @permissionScope Manage Restaurants - all permissions
4067
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4068
+ * @permissionScope Manage eCommerce - all permissions
4069
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4070
+ * @permissionScope Manage Orders
4071
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
4072
+ * @permissionId ECOM.READ_CHECKOUTS
4073
+ * @webhook
4074
+ * @eventType wix.ecom.v1.checkout_updated
4075
+ * @slug updated
4076
+ */
4077
+ declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelope) => void | Promise<void>): void;
4078
+ type CheckoutNonNullablePaths = `lineItems` | `lineItems.${number}.quantity` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.productName.original` | `lineItems.${number}.price.amount` | `lineItems.${number}.price.convertedAmount` | `lineItems.${number}.price.formattedAmount` | `lineItems.${number}.price.formattedConvertedAmount` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.availability.status` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.subscriptionOptionInfo.title.original` | `lineItems.${number}.subscriptionOptionInfo.description.original` | `lineItems.${number}.paymentOption` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.customLineItem` | `lineItems.${number}.catalogOverrideFields.paymentOption.value` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.savePaymentMethod` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.membersOnly` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.shippingDestination.address.streetAddress.number` | `shippingInfo.shippingDestination.address.streetAddress.name` | `shippingInfo.shippingDestination.contactDetails.vatId._id` | `shippingInfo.shippingDestination.contactDetails.vatId.type` | `shippingInfo.selectedCarrierServiceOption.code` | `shippingInfo.selectedCarrierServiceOption.title` | `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.businessLocation` | `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.pickupMethod` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.amount` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.convertedAmount` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.formattedAmount` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.formattedConvertedAmount` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.taxRate` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.rateBreakdown` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.rateBreakdown.${number}.name` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.rateBreakdown.${number}.rate` | `shippingInfo.selectedCarrierServiceOption.requestedShippingOption` | `shippingInfo.selectedCarrierServiceOption.otherCharges` | `shippingInfo.selectedCarrierServiceOption.otherCharges.${number}.type` | `shippingInfo.selectedCarrierServiceOption.deliveryAllocations` | `shippingInfo.selectedCarrierServiceOption.deliveryAllocations.${number}.deliveryCarrier.code` | `shippingInfo.region._id` | `shippingInfo.region.name` | `shippingInfo.carrierServiceOptions` | `shippingInfo.carrierServiceOptions.${number}.carrierId` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `conversionCurrency` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.convertedAmount` | `priceSummary.subtotal.formattedAmount` | `priceSummary.subtotal.formattedConvertedAmount` | `calculationErrors.generalShippingCalculationError.applicationError.code` | `calculationErrors.generalShippingCalculationError.applicationError.description` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculationErrors.carrierErrors.errors` | `calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculationErrors.orderValidationErrors` | `giftCard._id` | `giftCard.obfuscatedCode` | `giftCard.amount.amount` | `giftCard.amount.convertedAmount` | `giftCard.amount.formattedAmount` | `giftCard.amount.formattedConvertedAmount` | `giftCard.appId` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.convertedAmount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.coupon.amount.formattedConvertedAmount` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `customFields` | `customFields.${number}.title` | `weightUnit` | `taxSummary.taxableAmount.amount` | `taxSummary.taxableAmount.convertedAmount` | `taxSummary.taxableAmount.formattedAmount` | `taxSummary.taxableAmount.formattedConvertedAmount` | `taxSummary.calculationDetails.manualRateReason` | `taxSummary.calculationDetails.autoTaxFallbackDetails.fallbackReason` | `taxSummary.calculationDetails.autoTaxFallbackDetails.error.code` | `taxSummary.calculationDetails.autoTaxFallbackDetails.error.description` | `taxSummary.calculationDetails.rateType` | `currency` | `channelType` | `siteLanguage` | `buyerLanguage` | `completed` | `taxIncludedInPrice` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `payNow.subtotal.amount` | `payNow.subtotal.convertedAmount` | `payNow.subtotal.formattedAmount` | `payNow.subtotal.formattedConvertedAmount` | `payLater.subtotal.amount` | `payLater.subtotal.convertedAmount` | `payLater.subtotal.formattedAmount` | `payLater.subtotal.formattedConvertedAmount` | `membershipOptions.eligibleMemberships` | `membershipOptions.eligibleMemberships.${number}._id` | `membershipOptions.eligibleMemberships.${number}.appId` | `membershipOptions.eligibleMemberships.${number}.name.original` | `membershipOptions.eligibleMemberships.${number}.credits.total` | `membershipOptions.eligibleMemberships.${number}.credits.remaining` | `membershipOptions.invalidMemberships` | `membershipOptions.invalidMemberships.${number}.reason` | `membershipOptions.selectedMemberships.memberships` | `membershipOptions.selectedMemberships.memberships.${number}._id` | `membershipOptions.selectedMemberships.memberships.${number}.appId` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.convertedAmount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.price.formattedConvertedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}.source` | `violations` | `violations.${number}.severity` | `violations.${number}.target.other.name` | `violations.${number}.target.lineItem.name` | `customSettings.lockGiftCard` | `customSettings.lockCouponCode` | `customSettings.disabledPolicyAgreementCheckbox` | `customSettings.disabledManualPayment` | `customContentReference.appId` | `customContentReference.componentId` | `externalReference.appId` | `payAfterFreeTrial.subtotal.amount` | `payAfterFreeTrial.subtotal.convertedAmount` | `payAfterFreeTrial.subtotal.formattedAmount` | `payAfterFreeTrial.subtotal.formattedConvertedAmount` | `paymentCurrency`;
4079
+ /**
4080
+ * Creates a checkout.
4081
+ *
4082
+ * A checkout must include at least 1 item in `lineItems` or `customLineItems`.
4083
+ *
4084
+ * If passing `checkoutInfo.customFields`, then `checkoutInfo.customFields.value` is a required field.
4085
+ * @public
4086
+ * @requiredField options.channelType
4087
+ * @requiredField options.checkoutInfo.customFields.value
4088
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id
4089
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId
4090
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds
4091
+ * @requiredField options.customLineItems.itemType
4092
+ * @requiredField options.customLineItems.price
4093
+ * @requiredField options.customLineItems.productName
4094
+ * @requiredField options.lineItems.catalogReference
4095
+ * @requiredField options.lineItems.catalogReference.appId
4096
+ * @requiredField options.lineItems.quantity
4097
+ * @param options - Checkout creation options.
4098
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4099
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
4100
+ * @applicableIdentity APP
4101
+ * @applicableIdentity VISITOR
4102
+ * @returns Newly created checkout.
4103
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateCheckout
4104
+ */
4105
+ declare function createCheckout(options?: NonNullablePaths<CreateCheckoutOptions, `channelType` | `checkoutInfo.customFields.${number}.value` | `checkoutInfo.membershipOptions.selectedMemberships.memberships.${number}._id` | `checkoutInfo.membershipOptions.selectedMemberships.memberships.${number}.appId` | `checkoutInfo.membershipOptions.selectedMemberships.memberships.${number}.lineItemIds` | `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.modifierGroups.${number}.modifiers.${number}.label` | `customLineItems.${number}.price` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.quantity`>): Promise<NonNullablePaths<Checkout, CheckoutNonNullablePaths> & {
4106
+ __applicationErrorsType?: CreateCheckoutApplicationErrors;
4107
+ }>;
3600
4108
  interface CreateCheckoutOptions {
3601
4109
  /** Checkout information. */
3602
4110
  checkoutInfo?: Checkout;
@@ -3635,6 +4143,97 @@ interface CreateCheckoutOptions {
3635
4143
  */
3636
4144
  overrideCheckoutUrl?: string | null;
3637
4145
  }
4146
+ /**
4147
+ * Retrieves a checkout.
4148
+ * @param _id - Checkout ID.
4149
+ * @public
4150
+ * @requiredField _id
4151
+ * @permissionId ECOM.READ_CHECKOUTS
4152
+ * @applicableIdentity APP
4153
+ * @applicableIdentity VISITOR
4154
+ * @returns Retrieved checkout.
4155
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckout
4156
+ */
4157
+ declare function getCheckout(_id: string): Promise<NonNullablePaths<Checkout, CheckoutNonNullablePaths>>;
4158
+ /**
4159
+ * Retrieves the checkout associated with a specified cart.
4160
+ * @param _id - Cart ID.
4161
+ * @public
4162
+ * @requiredField _id
4163
+ * @permissionId ECOM.READ_CHECKOUTS
4164
+ * @applicableIdentity APP
4165
+ * @applicableIdentity VISITOR
4166
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutByCartId
4167
+ */
4168
+ declare function getCheckoutByCartId(_id: string): Promise<NonNullablePaths<GetCheckoutByCartIdResponse, {
4169
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4170
+ }[CheckoutNonNullablePaths]>>;
4171
+ /**
4172
+ * Deprecated and will be removed soon, use GetCheckoutURL
4173
+ * @param _id - Checkout ID.
4174
+ * @internal
4175
+ * @documentationMaturity preview
4176
+ * @requiredField _id
4177
+ * @permissionId ECOM.READ_CHECKOUTS
4178
+ * @applicableIdentity APP
4179
+ * @applicableIdentity VISITOR
4180
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetWixCheckoutURL
4181
+ */
4182
+ declare function getWixCheckoutUrl(_id: string): Promise<NonNullablePaths<GetWixCheckoutURLResponse, `checkoutUrl`>>;
4183
+ /**
4184
+ * Retrieves the checkout page URL of a specified checkout.
4185
+ *
4186
+ * By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page.
4187
+ * However, if `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
4188
+ * @param _id - Checkout ID.
4189
+ * @public
4190
+ * @requiredField _id
4191
+ * @permissionId ECOM.READ_CHECKOUTS
4192
+ * @applicableIdentity APP
4193
+ * @applicableIdentity VISITOR
4194
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutURL
4195
+ */
4196
+ declare function getCheckoutUrl(_id: string): Promise<NonNullablePaths<GetCheckoutURLResponse, `checkoutUrl`>>;
4197
+ /**
4198
+ * Updates a checkout.
4199
+ *
4200
+ * Use this method to update checkout fields such as billing and shipping info, or to add a coupon code or gift card.
4201
+ *
4202
+ * To update a checkout's `lineItems`, `completed` status, or to remove coupons and gift cards, see these methods:
4203
+ * + Add to Checkout: Add line items to the checkout.
4204
+ * + Update Line Items Quantity: Update the quantity of 1 or more line items in the checkout.
4205
+ * + Remove Line Items: Remove a line item from the checkout.
4206
+ * + Mark Checkout As Completed: To update `completed` to `true` if the checkout was completed through a non-Wix orders or payments system.
4207
+ * + Remove Coupon: To remove an applied coupon from the checkout.
4208
+ * + Remove Gift Card: To remove an applied gift card from the checkout.
4209
+ *
4210
+ * >**Notes:**
4211
+ * > + If nothing is passed in the request, the call will fail.
4212
+ * > + The `checkout.buyerInfo.email` may not be removed once it is set.
4213
+ * @param _id - Checkout ID.
4214
+ * @public
4215
+ * @requiredField _id
4216
+ * @requiredField checkout
4217
+ * @requiredField checkout.customFields.value
4218
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
4219
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
4220
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
4221
+ * @requiredField options.customLineItems.itemType
4222
+ * @requiredField options.customLineItems.productName
4223
+ * @requiredField options.lineItems.catalogReference
4224
+ * @requiredField options.lineItems.catalogReference.appId
4225
+ * @requiredField options.lineItems.quantity
4226
+ * @param options - Checkout update options.
4227
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4228
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
4229
+ * @applicableIdentity APP
4230
+ * @applicableIdentity VISITOR
4231
+ * @returns Updated checkout.
4232
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateCheckout
4233
+ */
4234
+ declare function updateCheckout(_id: string, checkout: NonNullablePaths<UpdateCheckout, `customFields.${number}.value` | `membershipOptions.selectedMemberships.memberships.${number}._id` | `membershipOptions.selectedMemberships.memberships.${number}.appId` | `membershipOptions.selectedMemberships.memberships.${number}.lineItemIds`>, options?: NonNullablePaths<UpdateCheckoutOptions, `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.modifierGroups.${number}.modifiers.${number}.label` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.quantity`>): Promise<NonNullablePaths<Checkout, CheckoutNonNullablePaths> & {
4235
+ __applicationErrorsType?: UpdateCheckoutApplicationErrors;
4236
+ }>;
3638
4237
  interface UpdateCheckout {
3639
4238
  /**
3640
4239
  * Checkout ID.
@@ -3813,6 +4412,15 @@ interface UpdateCheckout {
3813
4412
  * @immutable
3814
4413
  */
3815
4414
  externalReference?: ExternalReference;
4415
+ /**
4416
+ * Order ID.
4417
+ *
4418
+ * This field is empty until the checkout completes and becomes an order.
4419
+ * @internal
4420
+ * @format GUID
4421
+ * @readonly
4422
+ */
4423
+ orderId?: string | null;
3816
4424
  /**
3817
4425
  * Payment for subscriptions after free trial period.
3818
4426
  * @readonly
@@ -3825,6 +4433,23 @@ interface UpdateCheckout {
3825
4433
  * @format GUID
3826
4434
  */
3827
4435
  businessLocationId?: string | null;
4436
+ /**
4437
+ * Whether payment is required to create an order.
4438
+ *
4439
+ * Payment is required if any of the following conditions are met:
4440
+ * 1. At least one item requires a payment method. This can be because the item has the `savePaymentMethod` field set to `true`, or the item is a subscription with a price greater than zero.
4441
+ * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
4442
+ * @internal
4443
+ * @readonly
4444
+ */
4445
+ paymentRequired?: boolean;
4446
+ /**
4447
+ * Charges information for each subscription in the checkout.
4448
+ * @internal
4449
+ * @readonly
4450
+ * @maxSize 100
4451
+ */
4452
+ subscriptionCharges?: SubscriptionCharges[];
3828
4453
  /**
3829
4454
  * Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3830
4455
  * @readonly
@@ -3864,6 +4489,75 @@ interface UpdateCheckoutOptions {
3864
4489
  */
3865
4490
  customLineItems?: CustomLineItem[];
3866
4491
  }
4492
+ /**
4493
+ * Removes the coupon from a specified checkout.
4494
+ * @param _id - ID of the checkout to remove the coupon from.
4495
+ * @public
4496
+ * @requiredField _id
4497
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4498
+ * @applicableIdentity APP
4499
+ * @applicableIdentity VISITOR
4500
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveCoupon
4501
+ */
4502
+ declare function removeCoupon(_id: string): Promise<NonNullablePaths<RemoveCouponResponse, {
4503
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4504
+ }[CheckoutNonNullablePaths]>>;
4505
+ /**
4506
+ * Removes the gift card from a specified checkout.
4507
+ *
4508
+ * A checkout can only hold 1 gift card.
4509
+ * @param _id - ID of the checkout to remove the gift card from.
4510
+ * @public
4511
+ * @requiredField _id
4512
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4513
+ * @applicableIdentity APP
4514
+ * @applicableIdentity VISITOR
4515
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveGiftCard
4516
+ */
4517
+ declare function removeGiftCard(_id: string): Promise<NonNullablePaths<RemoveGiftCardResponse, {
4518
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4519
+ }[CheckoutNonNullablePaths]>>;
4520
+ /**
4521
+ * Removes the `overrideCheckoutUrl` from a specified checkout.
4522
+ *
4523
+ * When `overrideCheckoutUrl` is removed, the `checkoutUrl` will be set to the default, standard
4524
+ * Wix checkout page URL.
4525
+ * @param _id - ID of the checkout to remove the override checkout url from.
4526
+ * @public
4527
+ * @requiredField _id
4528
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4529
+ * @applicableIdentity APP
4530
+ * @applicableIdentity VISITOR
4531
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveOverrideCheckoutUrl
4532
+ */
4533
+ declare function removeOverrideCheckoutUrl(_id: string): Promise<NonNullablePaths<RemoveOverrideCheckoutUrlResponse, {
4534
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4535
+ }[CheckoutNonNullablePaths]>>;
4536
+ /**
4537
+ * Adds catalog line items and/or custom line items to a checkout.
4538
+ *
4539
+ * When adding catalog ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)) items
4540
+ * to a checkout, the `lineItems.catalogReference.appId` and `lineItems.catalogReference.catalogItemId` fields are required.
4541
+ * @param _id - Checkout ID.
4542
+ * @public
4543
+ * @requiredField _id
4544
+ * @requiredField options.customLineItems.itemType
4545
+ * @requiredField options.customLineItems.productName
4546
+ * @requiredField options.lineItems.catalogReference
4547
+ * @requiredField options.lineItems.catalogReference.appId
4548
+ * @requiredField options.lineItems.quantity
4549
+ * @param options - Items to be added to checkout.
4550
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4551
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
4552
+ * @applicableIdentity APP
4553
+ * @applicableIdentity VISITOR
4554
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.AddToCheckout
4555
+ */
4556
+ declare function addToCheckout(_id: string, options?: NonNullablePaths<AddToCheckoutOptions, `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.modifierGroups.${number}.modifiers.${number}.label` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.quantity`>): Promise<NonNullablePaths<AddToCheckoutResponse, {
4557
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4558
+ }[CheckoutNonNullablePaths]> & {
4559
+ __applicationErrorsType?: AddToCheckoutApplicationErrors;
4560
+ }>;
3867
4561
  interface AddToCheckoutOptions {
3868
4562
  /**
3869
4563
  * Catalog line items.
@@ -3879,12 +4573,67 @@ interface AddToCheckoutOptions {
3879
4573
  */
3880
4574
  customLineItems?: CustomLineItem[];
3881
4575
  }
4576
+ /**
4577
+ * Removes line items from the specified checkout.
4578
+ * @param _id - ID of the checkout to remove line items from.
4579
+ * @param lineItemIds - IDs of the line items to remove from the checkout.
4580
+ *
4581
+ * To find the IDs of the checkout line items you'd like to remove,
4582
+ * pass the checkout ID to Get Checkout and look for the IDs under
4583
+ * `lineItems`.
4584
+ * @public
4585
+ * @requiredField _id
4586
+ * @requiredField lineItemIds
4587
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4588
+ * @applicableIdentity APP
4589
+ * @applicableIdentity VISITOR
4590
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveLineItems
4591
+ */
4592
+ declare function removeLineItems(_id: string, lineItemIds: string[]): Promise<NonNullablePaths<RemoveLineItemsResponse, {
4593
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4594
+ }[CheckoutNonNullablePaths]>>;
4595
+ /**
4596
+ * Creates an order from a specified checkout.
4597
+ *
4598
+ * For an order to be created from a checkout, the following requirements must be met:
4599
+ * + A checkout cannot have calculation errors. Pass the checkout ID to Get Checkout and review the `calculationErrors` field.
4600
+ * + A checkout must have at least 1 line item or custom line item.
4601
+ * + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
4602
+ * + If there is a payment to be made, meaning that `priceSummary.total` is greater than `0`, the `billingInfo.address` field are required.
4603
+ * + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields are required.
4604
+ * + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field are required.
4605
+ * @param _id - Checkout ID.
4606
+ * @public
4607
+ * @requiredField _id
4608
+ * @param options - Additional order creation options.
4609
+ * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
4610
+ * @applicableIdentity APP
4611
+ * @applicableIdentity VISITOR
4612
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrder
4613
+ */
4614
+ declare function createOrder(_id: string, options?: CreateOrderOptions): Promise<NonNullablePaths<CreateOrderResponse, `orderId` | `subscriptionId`> & {
4615
+ __applicationErrorsType?: CreateOrderApplicationErrors;
4616
+ }>;
3882
4617
  interface CreateOrderOptions {
3883
4618
  /** Whether the payment method should be saved on the order. */
3884
4619
  savePaymentMethod?: boolean;
3885
4620
  /** Whether to authorize the payment and delay the capture. */
3886
4621
  delayCapture?: boolean;
3887
4622
  }
4623
+ /**
4624
+ * Deprecated (use createOrder instead)
4625
+ * @param _id - Checkout ID.
4626
+ * @internal
4627
+ * @documentationMaturity preview
4628
+ * @requiredField _id
4629
+ * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
4630
+ * @applicableIdentity APP
4631
+ * @applicableIdentity VISITOR
4632
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrderAndCharge
4633
+ */
4634
+ declare function createOrderAndCharge(_id: string, options?: CreateOrderAndChargeOptions): Promise<NonNullablePaths<CreateOrderAndChargeResponse, `orderId` | `subscriptionId`> & {
4635
+ __applicationErrorsType?: CreateOrderAndChargeApplicationErrors;
4636
+ }>;
3888
4637
  interface CreateOrderAndChargeOptions {
3889
4638
  /** Payment token. */
3890
4639
  paymentToken?: string | null;
@@ -3893,5 +4642,67 @@ interface CreateOrderAndChargeOptions {
3893
4642
  /** Whether to authorize the payment and delay the capture. */
3894
4643
  delayCapture?: boolean;
3895
4644
  }
4645
+ /**
4646
+ * Marks a checkout as completed and redirects to a specified URL.
4647
+ * @param token - Server-signed JWT token with required information to complete checkout
4648
+ * @public
4649
+ * @documentationMaturity preview
4650
+ * @requiredField token
4651
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4652
+ * @applicableIdentity APP
4653
+ * @applicableIdentity VISITOR
4654
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompletedAndRedirectToUrl
4655
+ */
4656
+ declare function markCheckoutAsCompletedAndRedirectToUrl(token: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`> & {
4657
+ __applicationErrorsType?: MarkCheckoutAsCompletedAndRedirectToUrlApplicationErrors;
4658
+ }>;
4659
+ /**
4660
+ * Sets `completed` to `true` to mark a checkout as completed.
4661
+ *
4662
+ * When an order is completed through Wix, the `completed` field in the associated checkout object
4663
+ * will automatically be updated to `true`. If an order is completed through a separate system,
4664
+ * use this method to manually mark the checkout as completed.
4665
+ * @param _id - Checkout ID.
4666
+ * @public
4667
+ * @requiredField _id
4668
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4669
+ * @applicableIdentity APP
4670
+ * @applicableIdentity VISITOR
4671
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompleted
4672
+ */
4673
+ declare function markCheckoutAsCompleted(_id: string): Promise<void>;
4674
+ /**
4675
+ * Updates the quantity of one or more line items in a checkout.
4676
+ *
4677
+ * This method is only for updating the quantity of line items. To entirely remove a line item from
4678
+ * the checkout, use the Remove Line Items method.
4679
+ * To add a new line item to the checkout, use the Add to Checkout method.
4680
+ *
4681
+ * This method checks the amount of stock remaining for this line item. If the specified `quantity`
4682
+ * is greater than the remaining stock, then the `quantity` returned in the response is the total amount
4683
+ * of remaining stock.
4684
+ * @param _id - Checkout ID.
4685
+ * @param lineItems - Line item info to update.
4686
+ * @public
4687
+ * @requiredField _id
4688
+ * @requiredField lineItems
4689
+ * @requiredField lineItems._id
4690
+ * @requiredField lineItems.quantity
4691
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4692
+ * @applicableIdentity APP
4693
+ * @applicableIdentity VISITOR
4694
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateLineItemsQuantity
4695
+ */
4696
+ declare function updateLineItemsQuantity(_id: string, lineItems: NonNullablePaths<LineItemQuantityUpdate, `_id` | `quantity`>[]): Promise<NonNullablePaths<UpdateLineItemsQuantityResponse, {
4697
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4698
+ }[CheckoutNonNullablePaths]>>;
4699
+ /** @param _id - Checkout ID.
4700
+ * @internal
4701
+ * @documentationMaturity preview
4702
+ * @requiredField _id
4703
+ * @permissionId ECOM.READ_PAYMENT_SETTINGS
4704
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutPaymentSettings
4705
+ */
4706
+ declare function getCheckoutPaymentSettings(_id: string): Promise<NonNullablePaths<GetCheckoutPaymentSettingsResponse, `blockedPaymentOptions`>>;
3896
4707
 
3897
- export { type CatalogReference as $, type AddToCheckoutOptions as A, NameInLineItem as B, type CreateCheckoutOptions as C, DescriptionLineType as D, SuggestedFix as E, FileType as F, type GetCheckoutByCartIdResponse as G, GetCheckoutPaymentSettingsResponsePaymentOption as H, ItemAvailabilityStatus as I, JurisdictionType as J, IdentityType as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, LineItemType as O, PaymentOptionType as P, MediaItemType as Q, type RemoveCouponResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCheckout as U, VatType as V, WeightUnit as W, DiscountDiscountType as X, ChannelInfoChannelType as Y, WebhookIdentityType as Z, type LineItem as _, type Checkout as a, type DetailsKindOneOf as a$, type ProductName as a0, type MultiCurrencyPrice as a1, type ItemTaxFullDetails as a2, type TaxRateBreakdown as a3, type TaxBreakdown as a4, type DescriptionLine as a5, type DescriptionLineValueOneOf as a6, type DescriptionLineDescriptionLineValueOneOf as a7, type DescriptionLineName as a8, type PlainTextValue as a9, type ApiAddress as aA, type StreetAddress as aB, type AddressLocation as aC, type FullAddressContactDetails as aD, type CommonVatId as aE, type ShippingInfo as aF, type SelectedCarrierServiceOption as aG, type DeliveryLogistics as aH, type PickupDetails as aI, type DeliveryTimeSlot as aJ, type SelectedCarrierServiceOptionPrices as aK, type SelectedCarrierServiceOptionOtherCharge as aL, type DeliveryAllocation as aM, type Carrier as aN, type Region as aO, type ApplicableLineItems as aP, type ShippingRegion as aQ, type CarrierServiceOption as aR, type ShippingOption as aS, type ShippingPrice as aT, type OtherCharge as aU, type BuyerInfo as aV, type BuyerInfoIdOneOf as aW, type PriceSummary as aX, type CalculationErrors as aY, type CalculationErrorsShippingCalculationErrorOneOf as aZ, type Details as a_, type Color as aa, type FocalPoint as ab, type ItemAvailabilityInfo as ac, type PhysicalProperties as ad, type Scope as ae, type Group as af, type ItemType as ag, type ItemTypeItemTypeDataOneOf as ah, type SubscriptionOptionInfo as ai, type SubscriptionSettings as aj, type FreeTrialPeriod as ak, type Title as al, type Description as am, type SecuredMedia as an, type ServiceProperties as ao, type PriceDescription as ap, type CatalogOverrideFields as aq, type PaymentOption as ar, type TaxableAddress as as, type TaxableAddressTaxableAddressDataOneOf as at, type ExtendedFields as au, type Policy as av, type ModifierGroup as aw, type TranslatableString as ax, type ItemModifier as ay, type AddressWithContact as az, type GetCheckoutURLResponse as b, type RemoveOverrideCheckoutUrlRequest as b$, type ApplicationError as b0, type ValidationError as b1, type FieldViolation as b2, type SystemError as b3, type CarrierErrors as b4, type CarrierError as b5, type GiftCard as b6, type AppliedDiscount as b7, type AppliedDiscountDiscountSourceOneOf as b8, type Coupon as b9, type CustomSettings as bA, type CustomContentReference as bB, type ExternalReference as bC, type SubscriptionCharges as bD, type Charge as bE, type UpdatedCheckoutMessage as bF, type CheckoutMarkedAsCompleted as bG, type CreateCheckoutRequest as bH, type CustomLineItem as bI, type V1ModifierGroup as bJ, type V1ItemModifier as bK, type MerchantDiscountInput as bL, type CreateCheckoutResponse as bM, type ShippingCalculationErrorData as bN, type ShippingCalculationErrorDataShippingCalculationErrorOneOf as bO, type GetCheckoutRequest as bP, type GetCheckoutResponse as bQ, type GetCheckoutWithAllExtendedFieldsRequest as bR, type GetCheckoutWithAllExtendedFieldsResponse as bS, type GetCheckoutByCartIdRequest as bT, type GetWixCheckoutURLRequest as bU, type GetWixCheckoutURLResponse as bV, type GetCheckoutURLRequest as bW, type UpdateCheckoutRequest as bX, type UpdateCheckoutResponse as bY, type RemoveCouponRequest as bZ, type RemoveGiftCardRequest as b_, type MerchantDiscount as ba, type DiscountRule as bb, type DiscountRuleName as bc, type LineItemDiscount as bd, type CustomField as be, type TaxSummary as bf, type TaxCalculationDetails as bg, type TaxCalculationDetailsCalculationDetailsOneOf as bh, type AutoTaxFallbackCalculationDetails as bi, type AggregatedTaxBreakdown as bj, type CreatedBy as bk, type CreatedByIdOneOf as bl, type MembershipOptions as bm, type Membership as bn, type MembershipName as bo, type MembershipPaymentCredits as bp, type InvalidMembership as bq, type SelectedMemberships as br, type SelectedMembership as bs, type AdditionalFee as bt, type ConversionInfo as bu, type Violation as bv, type Target as bw, type TargetTargetTypeOneOf as bx, type Other as by, type TargetLineItem as bz, type UpdateCheckoutOptions as c, type AddToCheckoutRequest as c0, type RemoveLineItemsRequest as c1, type CreateOrderRequest as c2, type CreateOrderResponseIdOneOf as c3, type PaymentErrorResponseData as c4, type DoublePaymentErrorData as c5, type DoublePaymentErrorDataIdOneOf as c6, type RedeemErrorData as c7, type ViolationsList as c8, type CreateOrderAndChargeRequest as c9, type VatId as cA, type V1ShippingInfo as cB, type V1ShippingInfoDetailsOneOf as cC, type ShipmentDetails as cD, type V1PickupDetails as cE, type PickupAddress as cF, type AppliedCoupon as cG, type V1CustomField as cH, type V1SubscriptionOptionInfo as cI, type Discount as cJ, type ChannelInfo as cK, type V1SubscriptionSettings as cL, type BillingInfo as cM, type Empty as cN, type DomainEvent as cO, type DomainEventBodyOneOf as cP, type EntityCreatedEvent as cQ, type RestoreInfo as cR, type EntityUpdatedEvent as cS, type EntityDeletedEvent as cT, type ActionEvent as cU, type MessageEnvelope as cV, type IdentificationData as cW, type IdentificationDataIdOneOf as cX, type BaseEventMetadata as cY, type EventMetadata as cZ, type CreateOrderAndChargeOptions as c_, type CreateOrderAndChargeResponse as ca, type CreateOrderAndChargeResponseIdOneOf as cb, type MarkCheckoutAsCompletedAndRedirectToUrlRequest as cc, type HeadersEntry as cd, type MarkCheckoutAsCompletedRequest as ce, type MarkCheckoutAsCompletedResponse as cf, type UpdateLineItemsQuantityRequest as cg, type GetCheckoutPaymentSettingsRequest as ch, type GetCheckoutPaymentSettingsResponse as ci, type DeleteCheckoutRequest as cj, type DeleteCheckoutResponse as ck, type SubscriptionCreated as cl, type Subscription as cm, type V1BuyerInfo as cn, type V1LineItem as co, type OptionSelection as cp, type CustomTextFieldSelection as cq, type ChargeDetails as cr, type ProductDetails as cs, type MediaItem as ct, type Totals as cu, type StoreSettings as cv, type Address as cw, type AddressAddressLine1OptionsOneOf as cx, type FullName as cy, type Street as cz, type RemoveGiftCardResponse as d, type RemoveOverrideCheckoutUrlResponse as e, type AddToCheckoutResponse as f, type RemoveLineItemsResponse as g, type CreateOrderOptions as h, type CreateOrderResponse as i, type RawHttpResponse as j, type UpdateLineItemsQuantityResponse as k, type CheckoutCompletedEnvelope as l, type CheckoutCreatedEnvelope as m, type CheckoutDeletedEnvelope as n, type CheckoutUpdatedEnvelope as o, ItemTypeItemType as p, CommonVatType as q, PickupMethod as r, ChargeType as s, RuleType as t, DiscountType as u, RateType as v, FallbackReason as w, ChannelType as x, AdditionalFeeSource as y, Severity as z };
4708
+ export { type ActionEvent, type AddToCheckoutApplicationErrors, type AddToCheckoutOptions, type AddToCheckoutRequest, type AddToCheckoutResponse, type AdditionalFee, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressAddressLine1OptionsOneOf, type AddressLocation, type AddressWithContact, type AggregatedTaxBreakdown, type ApiAddress, type ApplicableLineItems, type ApplicationError, type AppliedCoupon, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, type AutoTaxFallbackCalculationDetails, type BaseEventMetadata, type BillingInfo, type BuyerInfo, type BuyerInfoIdOneOf, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type CatalogOverrideFields, type CatalogReference, type ChannelInfo, ChannelInfoChannelType, type ChannelInfoChannelTypeWithLiterals, ChannelType, type ChannelTypeWithLiterals, type Charge, type ChargeDetails, ChargeType, type ChargeTypeWithLiterals, type Checkout, type CheckoutCompletedEnvelope, type CheckoutCreatedEnvelope, type CheckoutDeletedEnvelope, type CheckoutMarkedAsCompleted, type CheckoutUpdatedEnvelope, type Color, type CommonVatId, CommonVatType, type CommonVatTypeWithLiterals, type ConversionInfo, type Coupon, type CreateCheckoutApplicationErrors, type CreateCheckoutOptions, type CreateCheckoutRequest, type CreateCheckoutResponse, type CreateOrderAndChargeApplicationErrors, type CreateOrderAndChargeOptions, type CreateOrderAndChargeRequest, type CreateOrderAndChargeResponse, type CreateOrderAndChargeResponseIdOneOf, type CreateOrderApplicationErrors, type CreateOrderOptions, type CreateOrderRequest, type CreateOrderResponse, type CreateOrderResponseIdOneOf, type CreatedBy, type CreatedByIdOneOf, type CustomContentReference, type CustomField, type CustomLineItem, type CustomSettings, type CustomTextFieldSelection, type DeleteCheckoutRequest, type DeleteCheckoutResponse, type DeliveryAllocation, type DeliveryLogistics, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Discount, DiscountDiscountType, type DiscountDiscountTypeWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type DoublePaymentErrorData, type DoublePaymentErrorDataIdOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type ExternalReference, FallbackReason, type FallbackReasonWithLiterals, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type FullName, type GetCheckoutByCartIdRequest, type GetCheckoutByCartIdResponse, type GetCheckoutPaymentSettingsRequest, type GetCheckoutPaymentSettingsResponse, GetCheckoutPaymentSettingsResponsePaymentOption, type GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals, type GetCheckoutRequest, type GetCheckoutResponse, type GetCheckoutURLRequest, type GetCheckoutURLResponse, type GetCheckoutWithAllExtendedFieldsRequest, type GetCheckoutWithAllExtendedFieldsResponse, type GetWixCheckoutURLRequest, type GetWixCheckoutURLResponse, type GiftCard, type Group, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InvalidMembership, type ItemAvailabilityInfo, ItemAvailabilityStatus, type ItemAvailabilityStatusWithLiterals, type ItemModifier, type ItemTaxFullDetails, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItem, type LineItemDiscount, type LineItemQuantityUpdate, LineItemType, type LineItemTypeWithLiterals, ManualCalculationReason, type ManualCalculationReasonWithLiterals, type MarkCheckoutAsCompletedAndRedirectToUrlApplicationErrors, type MarkCheckoutAsCompletedAndRedirectToUrlRequest, type MarkCheckoutAsCompletedRequest, type MarkCheckoutAsCompletedResponse, type MediaItem, MediaItemType, type MediaItemTypeWithLiterals, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MerchantDiscount, type MerchantDiscountInput, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type OptionSelection, type Other, type OtherCharge, type PaymentErrorResponseData, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type Policy, type PriceDescription, type PriceSummary, type ProductDetails, type ProductName, RateType, type RateTypeWithLiterals, type RawHttpResponse, type RedeemErrorData, type Region, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveGiftCardRequest, type RemoveGiftCardResponse, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RemoveOverrideCheckoutUrlRequest, type RemoveOverrideCheckoutUrlResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMemberships, type ServiceProperties, Severity, type SeverityWithLiterals, type ShipmentDetails, type ShippingCalculationErrorData, type ShippingCalculationErrorDataShippingCalculationErrorOneOf, type ShippingInfo, type ShippingOption, type ShippingPrice, type ShippingRegion, type StoreSettings, type Street, type StreetAddress, type Subscription, type SubscriptionCharges, type SubscriptionCreated, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetLineItem, type TargetTargetTypeOneOf, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type Totals, type TranslatableString, type UpdateCheckout, type UpdateCheckoutApplicationErrors, type UpdateCheckoutOptions, type UpdateCheckoutRequest, type UpdateCheckoutResponse, type UpdateLineItemsQuantityRequest, type UpdateLineItemsQuantityResponse, type UpdatedCheckoutMessage, type V1BuyerInfo, type V1CustomField, type V1ItemModifier, type V1LineItem, type V1ModifierGroup, type V1PickupDetails, type V1ShippingInfo, type V1ShippingInfoDetailsOneOf, type V1SubscriptionOptionInfo, type V1SubscriptionSettings, type ValidationError, type VatId, VatType, type VatTypeWithLiterals, type Violation, type ViolationsList, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addToCheckout, createCheckout, createOrder, createOrderAndCharge, getCheckout, getCheckoutByCartId, getCheckoutPaymentSettings, getCheckoutUrl, getWixCheckoutUrl, markCheckoutAsCompleted, markCheckoutAsCompletedAndRedirectToUrl, onCheckoutCompleted, onCheckoutCreated, onCheckoutDeleted, onCheckoutUpdated, removeCoupon, removeGiftCard, removeLineItems, removeOverrideCheckoutUrl, updateCheckout, updateLineItemsQuantity };