@wix/auto_sdk_ecom_checkout 1.0.43 → 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,15 +178,6 @@ interface Checkout {
176
178
  * @immutable
177
179
  */
178
180
  externalReference?: ExternalReference;
179
- /**
180
- * Order ID.
181
- *
182
- * This field is empty until the checkout completes and becomes an order.
183
- * @internal
184
- * @format GUID
185
- * @readonly
186
- */
187
- orderId?: string | null;
188
181
  /**
189
182
  * Payment for subscriptions after free trial period.
190
183
  * @readonly
@@ -197,23 +190,6 @@ interface Checkout {
197
190
  * @format GUID
198
191
  */
199
192
  businessLocationId?: string | null;
200
- /**
201
- * Whether payment is required to create an order.
202
- *
203
- * Payment is required if any of the following conditions are met:
204
- * 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.
205
- * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
206
- * @internal
207
- * @readonly
208
- */
209
- paymentRequired?: boolean;
210
- /**
211
- * Charges information for each subscription in the checkout.
212
- * @internal
213
- * @readonly
214
- * @maxSize 100
215
- */
216
- subscriptionCharges?: SubscriptionCharges[];
217
193
  /**
218
194
  * Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
219
195
  * @readonly
@@ -398,25 +374,12 @@ interface LineItem {
398
374
  savePaymentMethod?: boolean;
399
375
  /** Address to use for tax calculation purposes. */
400
376
  taxableAddress?: TaxableAddress;
401
- /**
402
- * Custom extended fields for the line item object.
403
- *
404
- * [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.
405
- * @internal
406
- */
407
- extendedFields?: ExtendedFields;
408
377
  /**
409
378
  * Policies to be displayed to the customer on the checkout page.
410
379
  * @readonly
411
380
  * @maxSize 5
412
381
  */
413
382
  policies?: Policy[];
414
- /**
415
- * ID of the app managing the inventory.
416
- * @internal
417
- * @format GUID
418
- */
419
- inventoryAppId?: string | null;
420
383
  /**
421
384
  * Whether the item can only be purchased by site members.
422
385
  *
@@ -591,11 +554,6 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
591
554
  colorInfo?: Color;
592
555
  /** Description line name. */
593
556
  name?: DescriptionLineName;
594
- /**
595
- * Whether the description line originates from a modifier.
596
- * @internal
597
- */
598
- modifierDescriptionLine?: boolean;
599
557
  }
600
558
  /** @oneof */
601
559
  interface DescriptionLineValueOneOf {
@@ -659,6 +617,8 @@ declare enum DescriptionLineType {
659
617
  /** Color type. */
660
618
  COLOR = "COLOR"
661
619
  }
620
+ /** @enumType */
621
+ type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
662
622
  interface FocalPoint {
663
623
  /** X-coordinate of the focal point. */
664
624
  x?: number;
@@ -765,11 +725,6 @@ interface SubscriptionSettings {
765
725
  * If None => no free trial
766
726
  */
767
727
  freeTrialPeriod?: FreeTrialPeriod;
768
- /**
769
- * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
770
- * @internal
771
- */
772
- startDate?: Date | null;
773
728
  }
774
729
  /** Frequency unit of recurring payment */
775
730
  declare enum SubscriptionFrequency {
@@ -1608,14 +1563,6 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1608
1563
  * @targetRemovalDate 2024-06-01
1609
1564
  */
1610
1565
  lineItemIds?: string[];
1611
- /**
1612
- * Number of subscription cycle this discount applies to
1613
- * default None - all billing cycle
1614
- * @internal
1615
- * @min 1
1616
- * @max 999
1617
- */
1618
- subscriptionCycles?: number | null;
1619
1566
  }
1620
1567
  /** @oneof */
1621
1568
  interface AppliedDiscountDiscountSourceOneOf {
@@ -2031,14 +1978,6 @@ interface AdditionalFee {
2031
1978
  * @format GUID
2032
1979
  */
2033
1980
  lineItemIds?: string[];
2034
- /**
2035
- * Number of subscription cycle this fee applies to
2036
- * default None - all billing cycle
2037
- * @internal
2038
- * @min 1
2039
- * @max 999
2040
- */
2041
- subscriptionCycles?: number | null;
2042
1981
  /** the source the additional fee was added from */
2043
1982
  source?: AdditionalFeeSourceWithLiterals;
2044
1983
  }
@@ -2138,11 +2077,6 @@ interface TargetLineItem {
2138
2077
  name?: NameInLineItemWithLiterals;
2139
2078
  /** ID of the line item containing the violation. */
2140
2079
  _id?: string | null;
2141
- /**
2142
- * Suggested fix for resolving the line item violation.
2143
- * @internal
2144
- */
2145
- suggestedFix?: SuggestedFixWithLiterals;
2146
2080
  }
2147
2081
  interface CustomSettings {
2148
2082
  /**
@@ -2380,20 +2314,6 @@ interface CustomLineItem {
2380
2314
  deliveryProfileId?: string | null;
2381
2315
  /** 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. */
2382
2316
  catalogReference?: CatalogReference;
2383
- /**
2384
- * Whether the price is not yet defined, and will be updated after the order is created.
2385
- *
2386
- * Default: `false`
2387
- * @internal
2388
- */
2389
- priceUndetermined?: boolean;
2390
- /**
2391
- * Whether the line item quantity is fixed and cannot be changed.
2392
- *
2393
- * Default: `false`
2394
- * @internal
2395
- */
2396
- fixedQuantity?: boolean;
2397
2317
  /**
2398
2318
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
2399
2319
  * @minLength 1
@@ -2413,12 +2333,6 @@ interface CustomLineItem {
2413
2333
  * @maxSize 5
2414
2334
  */
2415
2335
  policies?: Policy[];
2416
- /**
2417
- * ID of the app managing the inventory.
2418
- * @internal
2419
- * @format GUID
2420
- */
2421
- inventoryAppId?: string | null;
2422
2336
  /**
2423
2337
  * Whether the item can only be purchased by site members.
2424
2338
  *
@@ -2776,12 +2690,6 @@ interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOne
2776
2690
  * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
2777
2691
  */
2778
2692
  paymentGatewayOrderId?: string | null;
2779
- /**
2780
- * Whether an order was successfully created from this checkout and the payment transaction was completed
2781
- * @internal
2782
- * @readonly
2783
- */
2784
- checkoutCompleted?: boolean;
2785
2693
  }
2786
2694
  /** @oneof */
2787
2695
  interface CreateOrderAndChargeResponseIdOneOf {
@@ -2818,12 +2726,6 @@ interface MarkCheckoutAsCompletedRequest {
2818
2726
  * @format GUID
2819
2727
  */
2820
2728
  _id: string;
2821
- /**
2822
- * Order ID.
2823
- * @internal
2824
- * @format GUID
2825
- */
2826
- orderId?: string | null;
2827
2729
  }
2828
2730
  interface MarkCheckoutAsCompletedResponse {
2829
2731
  }
@@ -3642,6 +3544,280 @@ declare enum WebhookIdentityType {
3642
3544
  }
3643
3545
  /** @enumType */
3644
3546
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3547
+ type CreateCheckoutApplicationErrors = {
3548
+ code?: 'SELECTED_CARRIER_SERVICE_OPTION_NOT_FOUND';
3549
+ description?: string;
3550
+ data?: ShippingCalculationErrorData;
3551
+ } | {
3552
+ code?: 'INVALID_SELECTED_CARRIER_SERVICE_OPTION';
3553
+ description?: string;
3554
+ data?: Record<string, any>;
3555
+ } | {
3556
+ code?: 'GIFT_CARD_NOT_FOUND';
3557
+ description?: string;
3558
+ data?: Record<string, any>;
3559
+ } | {
3560
+ code?: 'GIFT_CARD_CODE_INVALID';
3561
+ description?: string;
3562
+ data?: Record<string, any>;
3563
+ } | {
3564
+ code?: 'GIFT_CARD_IS_EMPTY';
3565
+ description?: string;
3566
+ data?: Record<string, any>;
3567
+ } | {
3568
+ code?: 'GIFT_CARD_DISABLED';
3569
+ description?: string;
3570
+ data?: Record<string, any>;
3571
+ } | {
3572
+ code?: 'GIFT_CARD_EXPIRED';
3573
+ description?: string;
3574
+ data?: Record<string, any>;
3575
+ } | {
3576
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
3577
+ description?: string;
3578
+ data?: Record<string, any>;
3579
+ } | {
3580
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
3581
+ description?: string;
3582
+ data?: Record<string, any>;
3583
+ } | {
3584
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
3585
+ description?: string;
3586
+ data?: Record<string, any>;
3587
+ } | {
3588
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
3589
+ description?: string;
3590
+ data?: Record<string, any>;
3591
+ } | {
3592
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
3593
+ description?: string;
3594
+ data?: Record<string, any>;
3595
+ } | {
3596
+ code?: 'SITE_MUST_ACCEPT_PAYMENTS';
3597
+ description?: string;
3598
+ data?: Record<string, any>;
3599
+ };
3600
+ type UpdateCheckoutApplicationErrors = {
3601
+ code?: 'SELECTED_CARRIER_SERVICE_OPTION_NOT_FOUND';
3602
+ description?: string;
3603
+ data?: ShippingCalculationErrorData;
3604
+ } | {
3605
+ code?: 'INVALID_SELECTED_CARRIER_SERVICE_OPTION';
3606
+ description?: string;
3607
+ data?: Record<string, any>;
3608
+ } | {
3609
+ code?: 'GIFT_CARD_NOT_FOUND';
3610
+ description?: string;
3611
+ data?: Record<string, any>;
3612
+ } | {
3613
+ code?: 'GIFT_CARD_CODE_INVALID';
3614
+ description?: string;
3615
+ data?: Record<string, any>;
3616
+ } | {
3617
+ code?: 'GIFT_CARD_IS_EMPTY';
3618
+ description?: string;
3619
+ data?: Record<string, any>;
3620
+ } | {
3621
+ code?: 'GIFT_CARD_DISABLED';
3622
+ description?: string;
3623
+ data?: Record<string, any>;
3624
+ } | {
3625
+ code?: 'GIFT_CARD_EXPIRED';
3626
+ description?: string;
3627
+ data?: Record<string, any>;
3628
+ } | {
3629
+ code?: 'ERROR_COUPON_USAGE_EXCEEDED';
3630
+ description?: string;
3631
+ data?: Record<string, any>;
3632
+ } | {
3633
+ code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
3634
+ description?: string;
3635
+ data?: Record<string, any>;
3636
+ } | {
3637
+ code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
3638
+ description?: string;
3639
+ data?: Record<string, any>;
3640
+ } | {
3641
+ code?: 'ERROR_COUPON_HAS_EXPIRED';
3642
+ description?: string;
3643
+ data?: Record<string, any>;
3644
+ } | {
3645
+ code?: 'ERROR_COUPON_DOES_NOT_EXIST';
3646
+ description?: string;
3647
+ data?: Record<string, any>;
3648
+ };
3649
+ type AddToCheckoutApplicationErrors = {
3650
+ code?: 'CHECKOUT_IS_COMPLETE';
3651
+ description?: string;
3652
+ data?: Record<string, any>;
3653
+ };
3654
+ type CreateOrderApplicationErrors = {
3655
+ code?: 'PAYMENT_ERROR';
3656
+ description?: string;
3657
+ data?: PaymentErrorResponseData;
3658
+ } | {
3659
+ code?: 'PAYMENT_PROVIDER_IS_NOT_AVAILABLE_ON_SITE';
3660
+ description?: string;
3661
+ data?: Record<string, any>;
3662
+ } | {
3663
+ code?: 'CHECKOUT_ALREADY_PAID';
3664
+ description?: string;
3665
+ data?: DoublePaymentErrorData;
3666
+ } | {
3667
+ code?: 'CHECKOUT_PAYMENT_ALREADY_IN_PROGRESS';
3668
+ description?: string;
3669
+ data?: DoublePaymentErrorData;
3670
+ } | {
3671
+ code?: 'CALCULATION_ERROR';
3672
+ description?: string;
3673
+ data?: CalculationErrors;
3674
+ } | {
3675
+ code?: 'REDEEM_GIFT_CARD_ERROR';
3676
+ description?: string;
3677
+ data?: RedeemErrorData;
3678
+ } | {
3679
+ code?: 'PARTIAL_OUT_OF_STOCK';
3680
+ description?: string;
3681
+ data?: Record<string, any>;
3682
+ } | {
3683
+ code?: 'FULL_OUT_OF_STOCK';
3684
+ description?: string;
3685
+ data?: Record<string, any>;
3686
+ } | {
3687
+ code?: 'EMPTY_CHECKOUT';
3688
+ description?: string;
3689
+ data?: Record<string, any>;
3690
+ } | {
3691
+ code?: 'CHECKOUT_CHANGED';
3692
+ description?: string;
3693
+ data?: Record<string, any>;
3694
+ } | {
3695
+ code?: 'SUBSCRIPTION_WITH_ZERO_TOTAL';
3696
+ description?: string;
3697
+ data?: Record<string, any>;
3698
+ } | {
3699
+ code?: 'SUBSCRIPTION_WITH_SEVERAL_LINE_ITEMS';
3700
+ description?: string;
3701
+ data?: Record<string, any>;
3702
+ } | {
3703
+ code?: 'SUBSCRIPTION_WITH_GIFT_CARD';
3704
+ description?: string;
3705
+ data?: Record<string, any>;
3706
+ } | {
3707
+ code?: 'NO_SELECTED_CARRIER_SERVICE_OPTION';
3708
+ description?: string;
3709
+ data?: Record<string, any>;
3710
+ } | {
3711
+ code?: 'VIOLATIONS_WITH_ERROR_SEVERITY';
3712
+ description?: string;
3713
+ data?: ViolationsList;
3714
+ } | {
3715
+ code?: 'FAILED_TO_RETRIEVE_VALIDATIONS_VIOLATIONS';
3716
+ description?: string;
3717
+ data?: Record<string, any>;
3718
+ } | {
3719
+ code?: 'NO_SAVE_PAYMENT_METHOD_CONFIRMATION';
3720
+ description?: string;
3721
+ data?: Record<string, any>;
3722
+ } | {
3723
+ code?: 'SELECTED_CARRIER_SERVICE_OPTION_NO_LONGER_AVAILABLE';
3724
+ description?: string;
3725
+ data?: Record<string, any>;
3726
+ } | {
3727
+ code?: 'MEMBERS_ONLY_ITEM';
3728
+ description?: string;
3729
+ data?: Record<string, any>;
3730
+ } | {
3731
+ code?: 'GIFT_CARD_CANNOT_BE_USED_TO_PURCHASE_GIFT_CARD';
3732
+ description?: string;
3733
+ data?: Record<string, any>;
3734
+ } | {
3735
+ code?: 'COUPON_CANNOT_BE_USED_TO_PURCHASE_GIFT_CARD';
3736
+ description?: string;
3737
+ data?: Record<string, any>;
3738
+ };
3739
+ type CreateOrderAndChargeApplicationErrors = {
3740
+ code?: 'PAYMENT_ERROR';
3741
+ description?: string;
3742
+ data?: PaymentErrorResponseData;
3743
+ } | {
3744
+ code?: 'PAYMENT_PROVIDER_IS_NOT_AVAILABLE_ON_SITE';
3745
+ description?: string;
3746
+ data?: Record<string, any>;
3747
+ } | {
3748
+ code?: 'CHECKOUT_ALREADY_PAID';
3749
+ description?: string;
3750
+ data?: DoublePaymentErrorData;
3751
+ } | {
3752
+ code?: 'CHECKOUT_PAYMENT_ALREADY_IN_PROGRESS';
3753
+ description?: string;
3754
+ data?: DoublePaymentErrorData;
3755
+ } | {
3756
+ code?: 'CALCULATION_ERROR';
3757
+ description?: string;
3758
+ data?: CalculationErrors;
3759
+ } | {
3760
+ code?: 'REDEEM_GIFT_CARD_ERROR';
3761
+ description?: string;
3762
+ data?: RedeemErrorData;
3763
+ } | {
3764
+ code?: 'PARTIAL_OUT_OF_STOCK';
3765
+ description?: string;
3766
+ data?: Record<string, any>;
3767
+ } | {
3768
+ code?: 'FULL_OUT_OF_STOCK';
3769
+ description?: string;
3770
+ data?: Record<string, any>;
3771
+ } | {
3772
+ code?: 'EMPTY_CHECKOUT';
3773
+ description?: string;
3774
+ data?: Record<string, any>;
3775
+ } | {
3776
+ code?: 'CHECKOUT_CHANGED';
3777
+ description?: string;
3778
+ data?: Record<string, any>;
3779
+ } | {
3780
+ code?: 'SUBSCRIPTION_WITH_ZERO_TOTAL';
3781
+ description?: string;
3782
+ data?: Record<string, any>;
3783
+ } | {
3784
+ code?: 'SUBSCRIPTION_WITH_SEVERAL_LINE_ITEMS';
3785
+ description?: string;
3786
+ data?: Record<string, any>;
3787
+ } | {
3788
+ code?: 'SUBSCRIPTION_WITH_GIFT_CARD';
3789
+ description?: string;
3790
+ data?: Record<string, any>;
3791
+ } | {
3792
+ code?: 'NO_SELECTED_CARRIER_SERVICE_OPTION';
3793
+ description?: string;
3794
+ data?: Record<string, any>;
3795
+ } | {
3796
+ code?: 'NO_SAVE_PAYMENT_METHOD_CONFIRMATION';
3797
+ description?: string;
3798
+ data?: Record<string, any>;
3799
+ } | {
3800
+ code?: 'SELECTED_CARRIER_SERVICE_OPTION_NO_LONGER_AVAILABLE';
3801
+ description?: string;
3802
+ data?: Record<string, any>;
3803
+ } | {
3804
+ code?: 'MEMBERS_ONLY_ITEM';
3805
+ description?: string;
3806
+ data?: Record<string, any>;
3807
+ } | {
3808
+ code?: 'GIFT_CARD_CANNOT_BE_USED_TO_PURCHASE_GIFT_CARD';
3809
+ description?: string;
3810
+ data?: Record<string, any>;
3811
+ } | {
3812
+ code?: 'COUPON_CANNOT_BE_USED_TO_PURCHASE_GIFT_CARD';
3813
+ description?: string;
3814
+ data?: Record<string, any>;
3815
+ };
3816
+ type MarkCheckoutAsCompletedAndRedirectToUrlApplicationErrors = {
3817
+ code?: 'UNAUTHENTICATED_TOKEN';
3818
+ description?: string;
3819
+ data?: Record<string, any>;
3820
+ };
3645
3821
  interface BaseEventMetadata {
3646
3822
  /**
3647
3823
  * App instance ID.
@@ -3690,17 +3866,143 @@ interface CheckoutCompletedEnvelope {
3690
3866
  data: CheckoutMarkedAsCompleted;
3691
3867
  metadata: EventMetadata;
3692
3868
  }
3869
+ /**
3870
+ * Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed.
3871
+ * @permissionScope Manage Stores - all permissions
3872
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3873
+ * @permissionScope Manage Stores
3874
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3875
+ * @permissionScope Read eCommerce - all read permissions
3876
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3877
+ * @permissionScope Read Orders
3878
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3879
+ * @permissionScope Read Stores - all read permissions
3880
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3881
+ * @permissionScope Manage Restaurants - all permissions
3882
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3883
+ * @permissionScope Manage eCommerce - all permissions
3884
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3885
+ * @permissionScope Manage Orders
3886
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3887
+ * @permissionId ECOM.READ_CHECKOUTS
3888
+ * @webhook
3889
+ * @eventType wix.ecom.v1.checkout_completed
3890
+ * @slug completed
3891
+ */
3892
+ declare function onCheckoutCompleted(handler: (event: CheckoutCompletedEnvelope) => void | Promise<void>): void;
3693
3893
  interface CheckoutCreatedEnvelope {
3694
3894
  entity: Checkout;
3695
3895
  metadata: EventMetadata;
3696
3896
  }
3897
+ /**
3898
+ * Triggered when a checkout is created.
3899
+ * @permissionScope Manage Stores - all permissions
3900
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3901
+ * @permissionScope Manage Stores
3902
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3903
+ * @permissionScope Read eCommerce - all read permissions
3904
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3905
+ * @permissionScope Read Orders
3906
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3907
+ * @permissionScope Read Stores - all read permissions
3908
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3909
+ * @permissionScope Manage Restaurants - all permissions
3910
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3911
+ * @permissionScope Manage eCommerce - all permissions
3912
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3913
+ * @permissionScope Manage Orders
3914
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3915
+ * @permissionId ECOM.READ_CHECKOUTS
3916
+ * @webhook
3917
+ * @eventType wix.ecom.v1.checkout_created
3918
+ * @slug created
3919
+ */
3920
+ declare function onCheckoutCreated(handler: (event: CheckoutCreatedEnvelope) => void | Promise<void>): void;
3697
3921
  interface CheckoutDeletedEnvelope {
3698
3922
  metadata: EventMetadata;
3699
3923
  }
3924
+ /**
3925
+ * Triggered when a checkout is deleted.
3926
+ * @permissionScope Manage Stores - all permissions
3927
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3928
+ * @permissionScope Manage Stores
3929
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3930
+ * @permissionScope Read eCommerce - all read permissions
3931
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3932
+ * @permissionScope Read Orders
3933
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3934
+ * @permissionScope Read Stores - all read permissions
3935
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3936
+ * @permissionScope Manage Restaurants - all permissions
3937
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3938
+ * @permissionScope Manage eCommerce - all permissions
3939
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3940
+ * @permissionScope Manage Orders
3941
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3942
+ * @permissionId ECOM.READ_CHECKOUTS
3943
+ * @webhook
3944
+ * @eventType wix.ecom.v1.checkout_deleted
3945
+ * @slug deleted
3946
+ */
3947
+ declare function onCheckoutDeleted(handler: (event: CheckoutDeletedEnvelope) => void | Promise<void>): void;
3700
3948
  interface CheckoutUpdatedEnvelope {
3701
3949
  entity: Checkout;
3702
3950
  metadata: EventMetadata;
3703
3951
  }
3952
+ /**
3953
+ * Triggered when a checkout is updated.
3954
+ * @permissionScope Manage Stores - all permissions
3955
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3956
+ * @permissionScope Manage Stores
3957
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3958
+ * @permissionScope Read eCommerce - all read permissions
3959
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3960
+ * @permissionScope Read Orders
3961
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3962
+ * @permissionScope Read Stores - all read permissions
3963
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3964
+ * @permissionScope Manage Restaurants - all permissions
3965
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3966
+ * @permissionScope Manage eCommerce - all permissions
3967
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3968
+ * @permissionScope Manage Orders
3969
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3970
+ * @permissionId ECOM.READ_CHECKOUTS
3971
+ * @webhook
3972
+ * @eventType wix.ecom.v1.checkout_updated
3973
+ * @slug updated
3974
+ */
3975
+ declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelope) => void | Promise<void>): void;
3976
+ 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`;
3977
+ /**
3978
+ * Creates a checkout.
3979
+ *
3980
+ * A checkout must include at least 1 item in `lineItems` or `customLineItems`.
3981
+ *
3982
+ * If passing `checkoutInfo.customFields`, then `checkoutInfo.customFields.value` is a required field.
3983
+ * @public
3984
+ * @requiredField options.channelType
3985
+ * @requiredField options.checkoutInfo.customFields.value
3986
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id
3987
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId
3988
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds
3989
+ * @requiredField options.customLineItems.itemType
3990
+ * @requiredField options.customLineItems.price
3991
+ * @requiredField options.customLineItems.productName
3992
+ * @requiredField options.lineItems.catalogReference
3993
+ * @requiredField options.lineItems.catalogReference.appId
3994
+ * @requiredField options.lineItems.quantity
3995
+ * @param options - Checkout creation options.
3996
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3997
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
3998
+ * @applicableIdentity APP
3999
+ * @applicableIdentity VISITOR
4000
+ * @returns Newly created checkout.
4001
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateCheckout
4002
+ */
4003
+ 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> & {
4004
+ __applicationErrorsType?: CreateCheckoutApplicationErrors;
4005
+ }>;
3704
4006
  interface CreateCheckoutOptions {
3705
4007
  /** Checkout information. */
3706
4008
  checkoutInfo?: Checkout;
@@ -3739,6 +4041,85 @@ interface CreateCheckoutOptions {
3739
4041
  */
3740
4042
  overrideCheckoutUrl?: string | null;
3741
4043
  }
4044
+ /**
4045
+ * Retrieves a checkout.
4046
+ * @param _id - Checkout ID.
4047
+ * @public
4048
+ * @requiredField _id
4049
+ * @permissionId ECOM.READ_CHECKOUTS
4050
+ * @applicableIdentity APP
4051
+ * @applicableIdentity VISITOR
4052
+ * @returns Retrieved checkout.
4053
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckout
4054
+ */
4055
+ declare function getCheckout(_id: string): Promise<NonNullablePaths<Checkout, CheckoutNonNullablePaths>>;
4056
+ /**
4057
+ * Retrieves the checkout associated with a specified cart.
4058
+ * @param _id - Cart ID.
4059
+ * @public
4060
+ * @requiredField _id
4061
+ * @permissionId ECOM.READ_CHECKOUTS
4062
+ * @applicableIdentity APP
4063
+ * @applicableIdentity VISITOR
4064
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutByCartId
4065
+ */
4066
+ declare function getCheckoutByCartId(_id: string): Promise<NonNullablePaths<GetCheckoutByCartIdResponse, {
4067
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4068
+ }[CheckoutNonNullablePaths]>>;
4069
+ /**
4070
+ * Retrieves the checkout page URL of a specified checkout.
4071
+ *
4072
+ * By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page.
4073
+ * However, if `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
4074
+ * @param _id - Checkout ID.
4075
+ * @public
4076
+ * @requiredField _id
4077
+ * @permissionId ECOM.READ_CHECKOUTS
4078
+ * @applicableIdentity APP
4079
+ * @applicableIdentity VISITOR
4080
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutURL
4081
+ */
4082
+ declare function getCheckoutUrl(_id: string): Promise<NonNullablePaths<GetCheckoutURLResponse, `checkoutUrl`>>;
4083
+ /**
4084
+ * Updates a checkout.
4085
+ *
4086
+ * Use this method to update checkout fields such as billing and shipping info, or to add a coupon code or gift card.
4087
+ *
4088
+ * To update a checkout's `lineItems`, `completed` status, or to remove coupons and gift cards, see these methods:
4089
+ * + Add to Checkout: Add line items to the checkout.
4090
+ * + Update Line Items Quantity: Update the quantity of 1 or more line items in the checkout.
4091
+ * + Remove Line Items: Remove a line item from the checkout.
4092
+ * + Mark Checkout As Completed: To update `completed` to `true` if the checkout was completed through a non-Wix orders or payments system.
4093
+ * + Remove Coupon: To remove an applied coupon from the checkout.
4094
+ * + Remove Gift Card: To remove an applied gift card from the checkout.
4095
+ *
4096
+ * >**Notes:**
4097
+ * > + If nothing is passed in the request, the call will fail.
4098
+ * > + The `checkout.buyerInfo.email` may not be removed once it is set.
4099
+ * @param _id - Checkout ID.
4100
+ * @public
4101
+ * @requiredField _id
4102
+ * @requiredField checkout
4103
+ * @requiredField checkout.customFields.value
4104
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
4105
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
4106
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
4107
+ * @requiredField options.customLineItems.itemType
4108
+ * @requiredField options.customLineItems.productName
4109
+ * @requiredField options.lineItems.catalogReference
4110
+ * @requiredField options.lineItems.catalogReference.appId
4111
+ * @requiredField options.lineItems.quantity
4112
+ * @param options - Checkout update options.
4113
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4114
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
4115
+ * @applicableIdentity APP
4116
+ * @applicableIdentity VISITOR
4117
+ * @returns Updated checkout.
4118
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateCheckout
4119
+ */
4120
+ 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> & {
4121
+ __applicationErrorsType?: UpdateCheckoutApplicationErrors;
4122
+ }>;
3742
4123
  interface UpdateCheckout {
3743
4124
  /**
3744
4125
  * Checkout ID.
@@ -3917,15 +4298,6 @@ interface UpdateCheckout {
3917
4298
  * @immutable
3918
4299
  */
3919
4300
  externalReference?: ExternalReference;
3920
- /**
3921
- * Order ID.
3922
- *
3923
- * This field is empty until the checkout completes and becomes an order.
3924
- * @internal
3925
- * @format GUID
3926
- * @readonly
3927
- */
3928
- orderId?: string | null;
3929
4301
  /**
3930
4302
  * Payment for subscriptions after free trial period.
3931
4303
  * @readonly
@@ -3938,23 +4310,6 @@ interface UpdateCheckout {
3938
4310
  * @format GUID
3939
4311
  */
3940
4312
  businessLocationId?: string | null;
3941
- /**
3942
- * Whether payment is required to create an order.
3943
- *
3944
- * Payment is required if any of the following conditions are met:
3945
- * 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.
3946
- * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
3947
- * @internal
3948
- * @readonly
3949
- */
3950
- paymentRequired?: boolean;
3951
- /**
3952
- * Charges information for each subscription in the checkout.
3953
- * @internal
3954
- * @readonly
3955
- * @maxSize 100
3956
- */
3957
- subscriptionCharges?: SubscriptionCharges[];
3958
4313
  /**
3959
4314
  * Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3960
4315
  * @readonly
@@ -3994,6 +4349,75 @@ interface UpdateCheckoutOptions {
3994
4349
  */
3995
4350
  customLineItems?: CustomLineItem[];
3996
4351
  }
4352
+ /**
4353
+ * Removes the coupon from a specified checkout.
4354
+ * @param _id - ID of the checkout to remove the coupon from.
4355
+ * @public
4356
+ * @requiredField _id
4357
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4358
+ * @applicableIdentity APP
4359
+ * @applicableIdentity VISITOR
4360
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveCoupon
4361
+ */
4362
+ declare function removeCoupon(_id: string): Promise<NonNullablePaths<RemoveCouponResponse, {
4363
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4364
+ }[CheckoutNonNullablePaths]>>;
4365
+ /**
4366
+ * Removes the gift card from a specified checkout.
4367
+ *
4368
+ * A checkout can only hold 1 gift card.
4369
+ * @param _id - ID of the checkout to remove the gift card from.
4370
+ * @public
4371
+ * @requiredField _id
4372
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4373
+ * @applicableIdentity APP
4374
+ * @applicableIdentity VISITOR
4375
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveGiftCard
4376
+ */
4377
+ declare function removeGiftCard(_id: string): Promise<NonNullablePaths<RemoveGiftCardResponse, {
4378
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4379
+ }[CheckoutNonNullablePaths]>>;
4380
+ /**
4381
+ * Removes the `overrideCheckoutUrl` from a specified checkout.
4382
+ *
4383
+ * When `overrideCheckoutUrl` is removed, the `checkoutUrl` will be set to the default, standard
4384
+ * Wix checkout page URL.
4385
+ * @param _id - ID of the checkout to remove the override checkout url from.
4386
+ * @public
4387
+ * @requiredField _id
4388
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4389
+ * @applicableIdentity APP
4390
+ * @applicableIdentity VISITOR
4391
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveOverrideCheckoutUrl
4392
+ */
4393
+ declare function removeOverrideCheckoutUrl(_id: string): Promise<NonNullablePaths<RemoveOverrideCheckoutUrlResponse, {
4394
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4395
+ }[CheckoutNonNullablePaths]>>;
4396
+ /**
4397
+ * Adds catalog line items and/or custom line items to a checkout.
4398
+ *
4399
+ * 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
4400
+ * to a checkout, the `lineItems.catalogReference.appId` and `lineItems.catalogReference.catalogItemId` fields are required.
4401
+ * @param _id - Checkout ID.
4402
+ * @public
4403
+ * @requiredField _id
4404
+ * @requiredField options.customLineItems.itemType
4405
+ * @requiredField options.customLineItems.productName
4406
+ * @requiredField options.lineItems.catalogReference
4407
+ * @requiredField options.lineItems.catalogReference.appId
4408
+ * @requiredField options.lineItems.quantity
4409
+ * @param options - Items to be added to checkout.
4410
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4411
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
4412
+ * @applicableIdentity APP
4413
+ * @applicableIdentity VISITOR
4414
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.AddToCheckout
4415
+ */
4416
+ 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, {
4417
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4418
+ }[CheckoutNonNullablePaths]> & {
4419
+ __applicationErrorsType?: AddToCheckoutApplicationErrors;
4420
+ }>;
3997
4421
  interface AddToCheckoutOptions {
3998
4422
  /**
3999
4423
  * Catalog line items.
@@ -4009,6 +4433,47 @@ interface AddToCheckoutOptions {
4009
4433
  */
4010
4434
  customLineItems?: CustomLineItem[];
4011
4435
  }
4436
+ /**
4437
+ * Removes line items from the specified checkout.
4438
+ * @param _id - ID of the checkout to remove line items from.
4439
+ * @param lineItemIds - IDs of the line items to remove from the checkout.
4440
+ *
4441
+ * To find the IDs of the checkout line items you'd like to remove,
4442
+ * pass the checkout ID to Get Checkout and look for the IDs under
4443
+ * `lineItems`.
4444
+ * @public
4445
+ * @requiredField _id
4446
+ * @requiredField lineItemIds
4447
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4448
+ * @applicableIdentity APP
4449
+ * @applicableIdentity VISITOR
4450
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveLineItems
4451
+ */
4452
+ declare function removeLineItems(_id: string, lineItemIds: string[]): Promise<NonNullablePaths<RemoveLineItemsResponse, {
4453
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4454
+ }[CheckoutNonNullablePaths]>>;
4455
+ /**
4456
+ * Creates an order from a specified checkout.
4457
+ *
4458
+ * For an order to be created from a checkout, the following requirements must be met:
4459
+ * + A checkout cannot have calculation errors. Pass the checkout ID to Get Checkout and review the `calculationErrors` field.
4460
+ * + A checkout must have at least 1 line item or custom line item.
4461
+ * + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
4462
+ * + If there is a payment to be made, meaning that `priceSummary.total` is greater than `0`, the `billingInfo.address` field are required.
4463
+ * + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields are required.
4464
+ * + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field are required.
4465
+ * @param _id - Checkout ID.
4466
+ * @public
4467
+ * @requiredField _id
4468
+ * @param options - Additional order creation options.
4469
+ * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
4470
+ * @applicableIdentity APP
4471
+ * @applicableIdentity VISITOR
4472
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrder
4473
+ */
4474
+ declare function createOrder(_id: string, options?: CreateOrderOptions): Promise<NonNullablePaths<CreateOrderResponse, `orderId` | `subscriptionId`> & {
4475
+ __applicationErrorsType?: CreateOrderApplicationErrors;
4476
+ }>;
4012
4477
  interface CreateOrderOptions {
4013
4478
  /** Whether the payment method should be saved on the order. */
4014
4479
  savePaymentMethod?: boolean;
@@ -4023,5 +4488,59 @@ interface CreateOrderAndChargeOptions {
4023
4488
  /** Whether to authorize the payment and delay the capture. */
4024
4489
  delayCapture?: boolean;
4025
4490
  }
4491
+ /**
4492
+ * Marks a checkout as completed and redirects to a specified URL.
4493
+ * @param token - Server-signed JWT token with required information to complete checkout
4494
+ * @public
4495
+ * @documentationMaturity preview
4496
+ * @requiredField token
4497
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4498
+ * @applicableIdentity APP
4499
+ * @applicableIdentity VISITOR
4500
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompletedAndRedirectToUrl
4501
+ */
4502
+ declare function markCheckoutAsCompletedAndRedirectToUrl(token: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`> & {
4503
+ __applicationErrorsType?: MarkCheckoutAsCompletedAndRedirectToUrlApplicationErrors;
4504
+ }>;
4505
+ /**
4506
+ * Sets `completed` to `true` to mark a checkout as completed.
4507
+ *
4508
+ * When an order is completed through Wix, the `completed` field in the associated checkout object
4509
+ * will automatically be updated to `true`. If an order is completed through a separate system,
4510
+ * use this method to manually mark the checkout as completed.
4511
+ * @param _id - Checkout ID.
4512
+ * @public
4513
+ * @requiredField _id
4514
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4515
+ * @applicableIdentity APP
4516
+ * @applicableIdentity VISITOR
4517
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompleted
4518
+ */
4519
+ declare function markCheckoutAsCompleted(_id: string): Promise<void>;
4520
+ /**
4521
+ * Updates the quantity of one or more line items in a checkout.
4522
+ *
4523
+ * This method is only for updating the quantity of line items. To entirely remove a line item from
4524
+ * the checkout, use the Remove Line Items method.
4525
+ * To add a new line item to the checkout, use the Add to Checkout method.
4526
+ *
4527
+ * This method checks the amount of stock remaining for this line item. If the specified `quantity`
4528
+ * is greater than the remaining stock, then the `quantity` returned in the response is the total amount
4529
+ * of remaining stock.
4530
+ * @param _id - Checkout ID.
4531
+ * @param lineItems - Line item info to update.
4532
+ * @public
4533
+ * @requiredField _id
4534
+ * @requiredField lineItems
4535
+ * @requiredField lineItems._id
4536
+ * @requiredField lineItems.quantity
4537
+ * @permissionId ECOM.MODIFY_CHECKOUTS
4538
+ * @applicableIdentity APP
4539
+ * @applicableIdentity VISITOR
4540
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateLineItemsQuantity
4541
+ */
4542
+ declare function updateLineItemsQuantity(_id: string, lineItems: NonNullablePaths<LineItemQuantityUpdate, `_id` | `quantity`>[]): Promise<NonNullablePaths<UpdateLineItemsQuantityResponse, {
4543
+ [P in CheckoutNonNullablePaths]: `checkout.${P}`;
4544
+ }[CheckoutNonNullablePaths]>>;
4026
4545
 
4027
- export { DiscountDiscountType as $, type AddToCheckoutOptions as A, FallbackReason as B, type CreateCheckoutOptions as C, DescriptionLineType as D, ChannelType as E, FileType as F, type GetCheckoutByCartIdResponse as G, AdditionalFeeSource as H, ItemAvailabilityStatus as I, JurisdictionType as J, Severity as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, NameInLineItem as O, PaymentOptionType as P, SuggestedFix as Q, type RemoveCouponResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCheckout as U, GetCheckoutPaymentSettingsResponsePaymentOption as V, WeightUnit as W, IdentityType as X, LineItemType as Y, MediaItemType as Z, VatType as _, type Checkout as a, type PriceSummary as a$, ChannelInfoChannelType as a0, WebhookIdentityType as a1, type LineItem as a2, type CatalogReference as a3, type ProductName as a4, type MultiCurrencyPrice as a5, type ItemTaxFullDetails as a6, type TaxRateBreakdown as a7, type TaxBreakdown as a8, type DescriptionLine as a9, type ModifierGroup as aA, type TranslatableString as aB, type ItemModifier as aC, type AddressWithContact as aD, type ApiAddress as aE, type StreetAddress as aF, type AddressLocation as aG, type FullAddressContactDetails as aH, type CommonVatId as aI, type ShippingInfo as aJ, type SelectedCarrierServiceOption as aK, type DeliveryLogistics as aL, type PickupDetails as aM, type DeliveryTimeSlot as aN, type SelectedCarrierServiceOptionPrices as aO, type SelectedCarrierServiceOptionOtherCharge as aP, type DeliveryAllocation as aQ, type Carrier as aR, type Region as aS, type ApplicableLineItems as aT, type ShippingRegion as aU, type CarrierServiceOption as aV, type ShippingOption as aW, type ShippingPrice as aX, type OtherCharge as aY, type BuyerInfo as aZ, type BuyerInfoIdOneOf as a_, type DescriptionLineValueOneOf as aa, type DescriptionLineDescriptionLineValueOneOf as ab, type DescriptionLineName as ac, type PlainTextValue as ad, type Color as ae, type FocalPoint as af, type ItemAvailabilityInfo as ag, type PhysicalProperties as ah, type Scope as ai, type Group as aj, type ItemType as ak, type ItemTypeItemTypeDataOneOf as al, type SubscriptionOptionInfo as am, type SubscriptionSettings as an, type FreeTrialPeriod as ao, type Title as ap, type Description as aq, type SecuredMedia as ar, type ServiceProperties as as, type PriceDescription as at, type CatalogOverrideFields as au, type PaymentOption as av, type TaxableAddress as aw, type TaxableAddressTaxableAddressDataOneOf as ax, type ExtendedFields as ay, type Policy as az, type GetWixCheckoutURLResponse as b, type UpdateCheckoutResponse as b$, type CalculationErrors as b0, type CalculationErrorsShippingCalculationErrorOneOf as b1, type Details as b2, type DetailsKindOneOf as b3, type ApplicationError as b4, type ValidationError as b5, type FieldViolation as b6, type SystemError as b7, type CarrierErrors as b8, type CarrierError as b9, type Target as bA, type TargetTargetTypeOneOf as bB, type Other as bC, type TargetLineItem as bD, type CustomSettings as bE, type CustomContentReference as bF, type ExternalReference as bG, type SubscriptionCharges as bH, type Charge as bI, type UpdatedCheckoutMessage as bJ, type CheckoutMarkedAsCompleted as bK, type CreateCheckoutRequest as bL, type CustomLineItem as bM, type V1ModifierGroup as bN, type V1ItemModifier as bO, type MerchantDiscountInput as bP, type CreateCheckoutResponse as bQ, type ShippingCalculationErrorData as bR, type ShippingCalculationErrorDataShippingCalculationErrorOneOf as bS, type GetCheckoutRequest as bT, type GetCheckoutResponse as bU, type GetCheckoutWithAllExtendedFieldsRequest as bV, type GetCheckoutWithAllExtendedFieldsResponse as bW, type GetCheckoutByCartIdRequest as bX, type GetWixCheckoutURLRequest as bY, type GetCheckoutURLRequest as bZ, type UpdateCheckoutRequest as b_, type GiftCard as ba, type AppliedDiscount as bb, type AppliedDiscountDiscountSourceOneOf as bc, type Coupon as bd, type MerchantDiscount as be, type DiscountRule as bf, type DiscountRuleName as bg, type LineItemDiscount as bh, type CustomField as bi, type TaxSummary as bj, type TaxCalculationDetails as bk, type TaxCalculationDetailsCalculationDetailsOneOf as bl, type AutoTaxFallbackCalculationDetails as bm, type AggregatedTaxBreakdown as bn, type CreatedBy as bo, type CreatedByIdOneOf as bp, type MembershipOptions as bq, type Membership as br, type MembershipName as bs, type MembershipPaymentCredits as bt, type InvalidMembership as bu, type SelectedMemberships as bv, type SelectedMembership as bw, type AdditionalFee as bx, type ConversionInfo as by, type Violation as bz, type GetCheckoutURLResponse as c, type RemoveCouponRequest as c0, type RemoveGiftCardRequest as c1, type RemoveOverrideCheckoutUrlRequest as c2, type AddToCheckoutRequest as c3, type RemoveLineItemsRequest as c4, type CreateOrderRequest as c5, type CreateOrderResponseIdOneOf as c6, type PaymentErrorResponseData as c7, type DoublePaymentErrorData as c8, type DoublePaymentErrorDataIdOneOf as c9, type Street as cA, type VatId as cB, type V1ShippingInfo as cC, type V1ShippingInfoDetailsOneOf as cD, type ShipmentDetails as cE, type V1PickupDetails as cF, type PickupAddress as cG, type AppliedCoupon as cH, type V1CustomField as cI, type V1SubscriptionOptionInfo as cJ, type Discount as cK, type ChannelInfo as cL, type V1SubscriptionSettings as cM, type BillingInfo as cN, type Empty as cO, type DomainEvent as cP, type DomainEventBodyOneOf as cQ, type EntityCreatedEvent as cR, type RestoreInfo as cS, type EntityUpdatedEvent as cT, type EntityDeletedEvent as cU, type ActionEvent as cV, type MessageEnvelope as cW, type IdentificationData as cX, type IdentificationDataIdOneOf as cY, type BaseEventMetadata as cZ, type EventMetadata as c_, type RedeemErrorData as ca, type ViolationsList as cb, type CreateOrderAndChargeRequest as cc, type CreateOrderAndChargeResponseIdOneOf as cd, type MarkCheckoutAsCompletedAndRedirectToUrlRequest as ce, type HeadersEntry as cf, type MarkCheckoutAsCompletedRequest as cg, type MarkCheckoutAsCompletedResponse as ch, type UpdateLineItemsQuantityRequest as ci, type GetCheckoutPaymentSettingsRequest as cj, type DeleteCheckoutRequest as ck, type DeleteCheckoutResponse as cl, type SubscriptionCreated as cm, type Subscription as cn, type V1BuyerInfo as co, type V1LineItem as cp, type OptionSelection as cq, type CustomTextFieldSelection as cr, type ChargeDetails as cs, type ProductDetails as ct, type MediaItem as cu, type Totals as cv, type StoreSettings as cw, type Address as cx, type AddressAddressLine1OptionsOneOf as cy, type FullName as cz, type UpdateCheckoutOptions as d, type RemoveGiftCardResponse as e, type RemoveOverrideCheckoutUrlResponse as f, type AddToCheckoutResponse as g, type RemoveLineItemsResponse as h, type CreateOrderOptions as i, type CreateOrderResponse as j, type CreateOrderAndChargeOptions as k, type CreateOrderAndChargeResponse as l, type RawHttpResponse as m, type UpdateLineItemsQuantityResponse as n, type GetCheckoutPaymentSettingsResponse as o, type CheckoutCompletedEnvelope as p, type CheckoutCreatedEnvelope as q, type CheckoutDeletedEnvelope as r, type CheckoutUpdatedEnvelope as s, ItemTypeItemType as t, CommonVatType as u, PickupMethod as v, ChargeType as w, RuleType as x, DiscountType as y, RateType as z };
4546
+ 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, getCheckout, getCheckoutByCartId, getCheckoutUrl, markCheckoutAsCompleted, markCheckoutAsCompletedAndRedirectToUrl, onCheckoutCompleted, onCheckoutCreated, onCheckoutDeleted, onCheckoutUpdated, removeCoupon, removeGiftCard, removeLineItems, removeOverrideCheckoutUrl, updateCheckout, updateLineItemsQuantity };