@wix/auto_sdk_ecom_cart-v-2 1.0.32 → 1.0.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +1107 -185
  2. package/build/cjs/index.js +67 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +1 -1
  5. package/build/cjs/index.typings.js +67 -0
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +1106 -184
  8. package/build/cjs/meta.js +67 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +1107 -185
  11. package/build/es/index.mjs +59 -0
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +1 -1
  14. package/build/es/index.typings.mjs +59 -0
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +1106 -184
  17. package/build/es/meta.mjs +59 -0
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +6 -4
  20. package/build/internal/cjs/index.js +67 -0
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +1186 -198
  23. package/build/internal/cjs/index.typings.js +67 -0
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +1106 -184
  26. package/build/internal/cjs/meta.js +67 -0
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +6 -4
  29. package/build/internal/es/index.mjs +59 -0
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +1186 -198
  32. package/build/internal/es/index.typings.mjs +59 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +1106 -184
  35. package/build/internal/es/meta.mjs +59 -0
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -46,7 +46,7 @@ interface Cart {
46
46
  * @maxSize 1
47
47
  * @readonly
48
48
  */
49
- coupons?: Coupon[];
49
+ coupons?: V2Coupon[];
50
50
  /** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
51
51
  source?: CartSource;
52
52
  /** Information about the site from which the Cart's line items were added. */
@@ -141,7 +141,7 @@ interface V2LineItem {
141
141
  * Additional Fees to be added to this item calculation.
142
142
  * @maxSize 5
143
143
  */
144
- additionalFees?: AdditionalFee[];
144
+ additionalFees?: V1AdditionalFee[];
145
145
  /**
146
146
  * Modifier groups that were added to the item.
147
147
  * @maxSize 25
@@ -741,7 +741,7 @@ interface ItemPaymentConfig {
741
741
  * Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`.
742
742
  * This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`.
743
743
  */
744
- selectedMembership?: SelectedMembership;
744
+ selectedMembership?: V2SelectedMembership;
745
745
  /**
746
746
  * Type of selected payment option for current item.
747
747
  *
@@ -749,7 +749,7 @@ interface ItemPaymentConfig {
749
749
  */
750
750
  paymentOption?: PaymentOptionTypeWithLiterals;
751
751
  }
752
- interface SelectedMembership {
752
+ interface V2SelectedMembership {
753
753
  /**
754
754
  * Membership ID.
755
755
  * @minLength 1
@@ -791,7 +791,7 @@ interface ExtendedFields {
791
791
  */
792
792
  namespaces?: Record<string, Record<string, any>>;
793
793
  }
794
- interface AdditionalFee {
794
+ interface V1AdditionalFee {
795
795
  /**
796
796
  * Additional fee's unique code or ID.
797
797
  * @minLength 1
@@ -896,7 +896,7 @@ interface Group {
896
896
  /** Item ID (when the coupon scope is limited to just one item). */
897
897
  entityId?: string | null;
898
898
  }
899
- interface Coupon {
899
+ interface V2Coupon {
900
900
  /**
901
901
  * ID of the coupon in the Cart.
902
902
  * @format GUID
@@ -1316,7 +1316,7 @@ interface PaymentInfo {
1316
1316
  * @readonly
1317
1317
  * @maxSize 1
1318
1318
  */
1319
- giftCards?: GiftCard[];
1319
+ giftCards?: V2GiftCard[];
1320
1320
  /**
1321
1321
  * The currency used for processing the payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1322
1322
  *
@@ -1330,7 +1330,7 @@ interface PaymentInfo {
1330
1330
  /** Full contact details for billing. */
1331
1331
  billingContact?: FullAddressContactDetails;
1332
1332
  }
1333
- interface GiftCard {
1333
+ interface V2GiftCard {
1334
1334
  /**
1335
1335
  * A unique identifier of the gift card within the Cart.
1336
1336
  * @format GUID
@@ -1389,39 +1389,7 @@ interface CartSettings {
1389
1389
  /** Whether to disable manual payment option for this checkout. */
1390
1390
  manualPaymentDisabled?: boolean | null;
1391
1391
  }
1392
- interface CustomField {
1393
- /** Custom field value. */
1394
- value?: any;
1395
- /**
1396
- * Custom field title.
1397
- * @minLength 1
1398
- * @maxLength 500
1399
- */
1400
- title?: string;
1401
- /**
1402
- * Translated custom field title.
1403
- * @minLength 1
1404
- * @maxLength 500
1405
- */
1406
- translatedTitle?: string | null;
1407
- }
1408
1392
  interface LegacyFields {
1409
- /**
1410
- * The applied discounts of the Cart.
1411
- * Discounts that are no longer applied are not included in this list.
1412
- * @maxSize 100
1413
- */
1414
- appliedDiscounts?: Discount[];
1415
- /** The coupon discount amount. */
1416
- couponDiscount?: ConvertedMoney;
1417
- /** The sum of all line items after applying all discounts. */
1418
- subtotalAfterCouponDiscount?: ConvertedMoney;
1419
- /**
1420
- * Indicates that this cart was created by the Buy Now flow.
1421
- * Used by the Cart API proxy to determine whether to produce legacy V1 domain events.
1422
- * @immutable
1423
- */
1424
- buyNow?: boolean;
1425
1393
  }
1426
1394
  interface Discount {
1427
1395
  /** The display name of the discount. */
@@ -1489,6 +1457,22 @@ interface DiscountBenefitValueOneOf {
1489
1457
  /** A specific monetary value deducted from the total cost. */
1490
1458
  amountOff?: ConvertedMoney;
1491
1459
  }
1460
+ interface CustomField {
1461
+ /** Custom field value. */
1462
+ value?: any;
1463
+ /**
1464
+ * Custom field title.
1465
+ * @minLength 1
1466
+ * @maxLength 500
1467
+ */
1468
+ title?: string;
1469
+ /**
1470
+ * Translated custom field title.
1471
+ * @minLength 1
1472
+ * @maxLength 500
1473
+ */
1474
+ translatedTitle?: string | null;
1475
+ }
1492
1476
  interface CartSummary {
1493
1477
  /**
1494
1478
  * The Cart ID.
@@ -1518,9 +1502,9 @@ interface CartSummary {
1518
1502
  */
1519
1503
  additionalFees?: V2AdditionalFee[];
1520
1504
  /** Summary of tax calculations applied to the cart. */
1521
- taxSummary?: TaxSummary;
1505
+ taxSummary?: V2TaxSummary;
1522
1506
  /** Summary of all calculated price components in the cart. */
1523
- priceSummary?: PriceSummary;
1507
+ priceSummary?: V2PriceSummary;
1524
1508
  /** Payment details summarizing how the customer will pay for the order. */
1525
1509
  paymentSummary?: PaymentSummary;
1526
1510
  /**
@@ -1543,7 +1527,7 @@ interface CartSummary {
1543
1527
  * List of errors that occurred during the calculation process, returned by Totals Calculator.
1544
1528
  * TODO: Temporary field for backward compatibility; will be removed once we introduce the unified 'violations' model.
1545
1529
  */
1546
- calculationErrors?: CalculationErrors;
1530
+ calculationErrors?: V2CalculationErrors;
1547
1531
  /**
1548
1532
  * List of business violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
1549
1533
  * TODO: Temporary field for backward compatibility; will be removed once we introduce the unified 'violations' model.
@@ -1618,7 +1602,7 @@ interface V2AdditionalFee {
1618
1602
  */
1619
1603
  subscriptionCycles?: number | null;
1620
1604
  }
1621
- interface TaxSummary {
1605
+ interface V2TaxSummary {
1622
1606
  /**
1623
1607
  * List of taxes applied to the cart.
1624
1608
  * May contain multiple entries when advanced tax rates are configured by the merchant,
@@ -1679,7 +1663,7 @@ interface AdditionalFeeTax {
1679
1663
  /** Tax amount applied to the additional fee. */
1680
1664
  tax?: ConvertedMoney;
1681
1665
  }
1682
- interface PriceSummary {
1666
+ interface V2PriceSummary {
1683
1667
  /**
1684
1668
  * Total price of all line items after applying item-level discounts.
1685
1669
  * Includes tax if `tax_summary.prices_include_tax` is true.
@@ -1717,7 +1701,7 @@ interface PaymentSummary {
1717
1701
  * A list of valid memberships that will be charged as part of the order.
1718
1702
  * @maxSize 300
1719
1703
  */
1720
- memberships?: Membership[];
1704
+ memberships?: V2Membership[];
1721
1705
  /**
1722
1706
  * Charges information for each subscription in the checkout.
1723
1707
  * @maxSize 100
@@ -1743,7 +1727,7 @@ interface GiftCardSummary {
1743
1727
  /** The amount to be reduced from the gift card's balance. */
1744
1728
  redeemAmount?: ConvertedMoney;
1745
1729
  }
1746
- interface Membership {
1730
+ interface V2Membership {
1747
1731
  /**
1748
1732
  * Membership ID.
1749
1733
  * @minLength 1
@@ -1790,15 +1774,15 @@ interface Charge {
1790
1774
  /** The number of cycles for which the charge is applicable. */
1791
1775
  cycleCount?: number | null;
1792
1776
  /** Charge summary. */
1793
- priceSummary?: PriceSummary;
1777
+ priceSummary?: V2PriceSummary;
1794
1778
  /** The billing date from which the charge starts. */
1795
1779
  cycleBillingDate?: Date | null;
1796
1780
  }
1797
- interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1781
+ interface V2CalculationErrors extends V2CalculationErrorsShippingCalculationErrorOneOf {
1798
1782
  /** General shipping calculation error. */
1799
1783
  generalShippingCalculationError?: Details;
1800
1784
  /** Carrier errors. */
1801
- carrierErrors?: CarrierErrors;
1785
+ carrierErrors?: V2CarrierErrors;
1802
1786
  /** Tax calculation error. */
1803
1787
  taxCalculationError?: Details;
1804
1788
  /** Coupon calculation error. */
@@ -1819,11 +1803,11 @@ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOne
1819
1803
  discountsCalculationError?: Details;
1820
1804
  }
1821
1805
  /** @oneof */
1822
- interface CalculationErrorsShippingCalculationErrorOneOf {
1806
+ interface V2CalculationErrorsShippingCalculationErrorOneOf {
1823
1807
  /** General shipping calculation error. */
1824
1808
  generalShippingCalculationError?: Details;
1825
1809
  /** Carrier errors. */
1826
- carrierErrors?: CarrierErrors;
1810
+ carrierErrors?: V2CarrierErrors;
1827
1811
  }
1828
1812
  interface Details extends DetailsKindOneOf {
1829
1813
  applicationError?: ApplicationError;
@@ -1921,14 +1905,14 @@ interface SystemError {
1921
1905
  /** Error code. */
1922
1906
  errorCode?: string | null;
1923
1907
  }
1924
- interface CarrierErrors {
1908
+ interface V2CarrierErrors {
1925
1909
  /**
1926
1910
  * Carrier errors.
1927
1911
  * @maxSize 100
1928
1912
  */
1929
- errors?: CarrierError[];
1913
+ errors?: V2CarrierError[];
1930
1914
  }
1931
- interface CarrierError {
1915
+ interface V2CarrierError {
1932
1916
  /**
1933
1917
  * Carrier ID.
1934
1918
  * @format GUID
@@ -2058,7 +2042,7 @@ interface CatalogItemInput {
2058
2042
  */
2059
2043
  quantity?: number;
2060
2044
  /** Selected membership to be used as payment for this item. */
2061
- selectedMembership?: SelectedMembership;
2045
+ selectedMembership?: V2SelectedMembership;
2062
2046
  /**
2063
2047
  * Overriding values for catalog item properties.
2064
2048
  * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
@@ -2370,7 +2354,7 @@ interface SelectedMembershipUpdate {
2370
2354
  *
2371
2355
  * To just remove current selected membership, and not replace with a new one, pass an empty value here.
2372
2356
  */
2373
- newMembership?: SelectedMembership;
2357
+ newMembership?: V2SelectedMembership;
2374
2358
  }
2375
2359
  interface UpdateLineItemsInCurrentCartResponse {
2376
2360
  /** Updated Cart. */
@@ -2624,6 +2608,34 @@ interface GetCartResponse {
2624
2608
  /** The requested Cart. */
2625
2609
  cart?: Cart;
2626
2610
  }
2611
+ /** temp for client testing */
2612
+ interface DummyErrorDataMethodLevel {
2613
+ /** This is a dummy field. */
2614
+ invalidItems?: LineItemIdentifier[];
2615
+ /** The fresh cart after resolving the error. */
2616
+ freshCart?: Cart;
2617
+ /** dummy string */
2618
+ dummyMethod?: string;
2619
+ }
2620
+ interface LineItemIdentifier extends LineItemIdentifierIdOneOf {
2621
+ /**
2622
+ * Line Item ID.
2623
+ * @format GUID
2624
+ */
2625
+ lineItemId?: string;
2626
+ /** Catalog reference. */
2627
+ catalogReference?: CatalogReference;
2628
+ }
2629
+ /** @oneof */
2630
+ interface LineItemIdentifierIdOneOf {
2631
+ /**
2632
+ * Line Item ID.
2633
+ * @format GUID
2634
+ */
2635
+ lineItemId?: string;
2636
+ /** Catalog reference. */
2637
+ catalogReference?: CatalogReference;
2638
+ }
2627
2639
  interface UpdateCartRequest {
2628
2640
  /** Cart to be updated, may be partial. */
2629
2641
  cart: Cart;
@@ -2681,199 +2693,1167 @@ interface CalculateCartResponse {
2681
2693
  /** The calculation summary. */
2682
2694
  summary?: CartSummary;
2683
2695
  }
2684
- interface GetCheckoutURLRequest {
2696
+ interface CalculateCartWithFullResponseResponse {
2697
+ /** The Cart that was calculated. */
2698
+ cart?: Cart;
2699
+ /** The calculation summary. */
2700
+ summary?: CartSummary;
2685
2701
  /**
2686
- * ID of the Cart to calculate.
2687
- * @format GUID
2702
+ * Totals payload used for backward compatibility with legacy clients.
2703
+ * Used by the Cart and Checkout proxies.
2688
2704
  */
2689
- cartId: string;
2705
+ totalsResponse?: CalculateTotalsResponse;
2706
+ }
2707
+ interface CalculateTotalsResponse {
2708
+ /** Calculate line items. */
2709
+ calculatedLineItems?: CalculatedLineItem[];
2710
+ /** Price summary. */
2711
+ priceSummary?: PriceSummary;
2712
+ /** Details of applied gift card. */
2713
+ giftCard?: GiftCard;
2714
+ /** Tax summary. */
2715
+ taxSummary?: TaxSummary;
2716
+ /** Shipping information. */
2717
+ shippingInfo?: ShippingInformation;
2690
2718
  /**
2691
- * Checkout currency parameter to append as a query param
2719
+ * Applied discounts.
2720
+ * @maxSize 320
2721
+ */
2722
+ appliedDiscounts?: AppliedDiscount[];
2723
+ /** Calculation errors. */
2724
+ calculationErrors?: CalculationErrors;
2725
+ /** Weight unit. */
2726
+ weightUnit?: WeightUnitWithLiterals;
2727
+ /**
2728
+ * Currency.
2692
2729
  * @format CURRENCY
2693
2730
  */
2694
- currencyCode?: string | null;
2695
- }
2696
- interface GetCheckoutURLResponse {
2731
+ currency?: string;
2697
2732
  /**
2698
- * The checkout URL.
2699
- * @format WEB_URL
2733
+ * This is the display currency. Converted prices are presented in this currency.
2734
+ * @readonly
2735
+ * @format CURRENCY
2700
2736
  */
2701
- checkoutUrl?: string;
2702
- }
2703
- interface PlaceOrderRequest {
2737
+ conversionCurrency?: string;
2738
+ /** Whether tax is included in price. */
2739
+ taxIncludedInPrice?: boolean;
2704
2740
  /**
2705
- * Cart ID.
2706
- * @format GUID
2741
+ * Minimal amount to pay in order to place the order.
2742
+ * @readonly
2707
2743
  */
2708
- cartId: string;
2744
+ payNow?: PriceSummary;
2709
2745
  /**
2710
- * The price verification token received from `CalculateCart`'s response.
2711
- * Used to verify that the prices shown to the customer have not changed before completing checkout.
2712
- * @maxLength 3000
2746
+ * Remaining amount for the order to be fully paid.
2747
+ * @readonly
2713
2748
  */
2714
- priceVerificationToken?: string | null;
2749
+ payLater?: PriceSummary;
2750
+ /** Information about valid and invalid memberships, and which ones are selected for usage. */
2751
+ membershipOptions?: MembershipOptions;
2715
2752
  /**
2716
- * Payment token.
2717
- * @maxLength 100
2753
+ * Additional Fees
2754
+ * @maxSize 100
2718
2755
  */
2719
- paymentToken?: string | null;
2720
- /** Urls to redirect to after payment is made. */
2721
- redirectUrls?: RedirectUrls;
2722
- /** Indicates the payment method should be saved on the order */
2723
- savePaymentMethod?: boolean;
2724
- /** Indicates whether to authorize the payment and delay the capture */
2725
- delayCapture?: boolean;
2726
- }
2727
- interface RedirectUrls {
2756
+ additionalFees?: AdditionalFee[];
2728
2757
  /**
2729
- * URL to redirect to if payment is canceled (usually checkout url).
2730
- * @format WEB_URL
2758
+ * The site currency.
2759
+ * @readonly
2760
+ * @format CURRENCY
2731
2761
  */
2732
- cancelUrl?: string;
2762
+ siteCurrency?: string;
2733
2763
  /**
2734
- * URL to redirect to if an error occurred on payment (usually checkout url).
2735
- * @format WEB_URL
2764
+ * The rate used when converting from the site currency to the checkout currency.
2765
+ * @readonly
2766
+ * @decimalValue options { gt:0, lte:1000000000000000 }
2736
2767
  */
2737
- errorUrl?: string;
2768
+ checkoutConversionRate?: string | null;
2738
2769
  /**
2739
- * URL to redirect to after successful payment, excepts order place holder {orderId}.
2740
- * @maxLength 2000
2770
+ * The pay now total amount after the gift card is applied.
2771
+ * @readonly
2741
2772
  */
2742
- successUrl?: string | null;
2773
+ payNowTotalAfterGiftCard?: MultiCurrencyPrice;
2743
2774
  /**
2744
- * URL to redirect to if payment is pending, excepts order place holder {orderId}.
2745
- * @maxLength 2000
2775
+ * The total amount after gift card is applied.
2776
+ * @readonly
2746
2777
  */
2747
- pendingUrl?: string | null;
2778
+ totalAfterGiftCard?: MultiCurrencyPrice;
2779
+ /**
2780
+ * Payment for subscriptions after free trial period.
2781
+ * @readonly
2782
+ */
2783
+ payAfterFreeTrial?: PriceSummary;
2748
2784
  }
2749
- interface PlaceOrderResponse {
2785
+ interface CalculatedLineItem {
2786
+ /** Line item ID. */
2787
+ lineItemId?: string;
2788
+ /** Price breakdown for this line item. */
2789
+ pricesBreakdown?: LineItemPricesData;
2750
2790
  /**
2751
- * The order ID of the created order.
2752
- * @format GUID
2791
+ * Type of selected payment option for current item. Supported values:
2792
+ * + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item will happen as part of the checkout
2793
+ * + `"FULL_PAYMENT_OFFLINE"` - The entire payment for this item will happen after the checkout
2794
+ * + `"MEMBERSHIP"` - This item cannot be paid via monetary payment options, only via non monetary option such membership. When this option is used, price must be set to 0
2795
+ * + `"DEPOSIT_ONLINE"` - Partial payment of the given item will happen as part of the checkout. Amount to be paid is defined by deposit_amount field.
2753
2796
  */
2754
- orderId?: string;
2797
+ paymentOption?: PaymentOptionTypeWithLiterals;
2798
+ /** tax calculation address. */
2799
+ taxableAddress?: TaxableAddress;
2755
2800
  /**
2756
- * Payment response token.
2757
- * @maxLength 1000
2801
+ * Calculated modifiers.
2802
+ * @internal
2803
+ * @maxSize 625
2804
+ */
2805
+ modifiers?: CalculatedItemModifier[];
2806
+ }
2807
+ interface LineItemPricesData {
2808
+ /** Total price after discounts, tax, and modifiers. */
2809
+ totalPriceAfterTax?: MultiCurrencyPrice;
2810
+ /** Total price after discounts and modifiers, and before tax. */
2811
+ totalPriceBeforeTax?: MultiCurrencyPrice;
2812
+ /** Tax details. */
2813
+ taxDetails?: ItemTaxFullDetails;
2814
+ /** Total discount applied for the line item. */
2815
+ totalDiscount?: MultiCurrencyPrice;
2816
+ /** Catalog price after catalog-defined discount, automatic discounts, and modifiers. */
2817
+ price?: MultiCurrencyPrice;
2818
+ /**
2819
+ * Item price before automatic discounts, coupons, and global discounts; after catalog-defined discounts and modifiers.
2820
+ * Defaults to `price` when not provided.
2758
2821
  */
2759
- paymentResponseToken?: string | null;
2822
+ priceBeforeDiscounts?: MultiCurrencyPrice;
2823
+ /** Total line item price after catalog-defined discounts, automatic discounts, and modifiers. */
2824
+ lineItemPrice?: MultiCurrencyPrice;
2760
2825
  /**
2761
- * The payment gateway is Cashier.
2762
- * payment_gateway_order_id will be returned given that money was charged.
2763
- * In some cases, money will not be charged:
2764
- * If the total price is 0 - For example, could be a free item or a an item with 100% discount
2765
- * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
2766
- * @maxLength 50
2826
+ * Item price before all discounts and modifiers.
2827
+ * Defaults to `price` when not provided.
2767
2828
  */
2768
- paymentGatewayOrderId?: string | null;
2769
- /** Whether an order was successfully created from this cart and the payment transaction was completed. */
2770
- completed?: boolean;
2771
- }
2772
- interface AddLineItemsRequest {
2829
+ fullPrice?: MultiCurrencyPrice;
2773
2830
  /**
2774
- * Cart ID.
2775
- * @format GUID
2831
+ * Total price of all item modifiers.
2832
+ * @internal
2776
2833
  */
2777
- cartId: string;
2834
+ modifiers?: MultiCurrencyPrice;
2778
2835
  /**
2779
- * A list of catalog items to add to the cart.
2780
- * @maxSize 300
2836
+ * Item price before tax, automatic discounts, coupons, and global discounts; after catalog-defined discounts and modifiers.
2837
+ * @internal
2781
2838
  */
2782
- catalogItems?: CatalogItemInput[];
2839
+ priceBeforeDiscountsAndTax?: MultiCurrencyPrice;
2783
2840
  /**
2784
- * A list of custom items to add to the cart.
2785
- * @maxSize 300
2841
+ * Partial payment to be paid upfront during the checkout.
2842
+ * Applies to catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
2786
2843
  */
2787
- customItems?: CustomItemInput[];
2788
- }
2789
- interface AddLineItemsResponse {
2790
- /** Updated Cart. */
2791
- cart?: Cart;
2844
+ depositAmount?: MultiCurrencyPrice;
2792
2845
  }
2793
- interface RemoveLineItemsRequest {
2846
+ interface MultiCurrencyPrice {
2794
2847
  /**
2795
- * Cart ID.
2796
- * @format GUID
2848
+ * Amount.
2849
+ * @decimalValue options { gte:0, lte:1000000000000000 }
2797
2850
  */
2798
- cartId: string;
2851
+ amount?: string;
2799
2852
  /**
2800
- * Line item IDs to remove from cart.
2801
- * @format GUID
2802
- * @minSize 1
2803
- * @maxSize 100
2853
+ * Converted amount.
2854
+ * @readonly
2855
+ * @decimalValue options { gte:0, lte:1000000000000000 }
2804
2856
  */
2805
- lineItemIds: string[];
2806
- }
2807
- interface RemoveLineItemsResponse {
2808
- /** Updated Cart. */
2809
- cart?: Cart;
2810
- }
2811
- interface UpdateLineItemsRequest {
2857
+ convertedAmount?: string;
2812
2858
  /**
2813
- * Cart ID.
2814
- * @format GUID
2859
+ * Amount formatted with currency symbol.
2860
+ * @readonly
2815
2861
  */
2816
- cartId: string;
2862
+ formattedAmount?: string;
2817
2863
  /**
2818
- * Line item updates to apply.
2819
- * @minSize 1
2820
- * @maxSize 300
2864
+ * Converted amount formatted with currency symbol.
2865
+ * @readonly
2821
2866
  */
2822
- lineItems?: LineItemUpdate[];
2823
- }
2824
- interface UpdateLineItemsResponse {
2825
- /** Updated Cart. */
2826
- cart?: Cart;
2867
+ formattedConvertedAmount?: string;
2827
2868
  }
2828
- interface AddCouponRequest {
2869
+ interface ItemTaxFullDetails {
2870
+ /** Amount for which tax is calculated. */
2871
+ taxableAmount?: MultiCurrencyPrice;
2829
2872
  /**
2830
- * Cart ID.
2831
- * @format GUID
2873
+ * Tax rate %, as a decimal point between 0 and 1.
2874
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
2832
2875
  */
2833
- cartId: string;
2876
+ taxRate?: string;
2877
+ /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
2878
+ totalTax?: MultiCurrencyPrice;
2834
2879
  /**
2835
- * Coupon to apply.
2836
- *
2837
- * Currently only one is supported.
2838
- * @minLength 1
2839
- * @maxLength 50
2880
+ * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.
2881
+ * @readonly
2882
+ * @deprecated
2840
2883
  */
2841
- couponCode: string;
2842
- }
2843
- interface AddCouponResponse {
2844
- /** Updated Cart. */
2845
- cart?: Cart;
2846
- }
2847
- interface RemoveCouponRequest {
2884
+ rateBreakdown?: TaxRateBreakdown[];
2848
2885
  /**
2849
- * Cart ID.
2850
- * @format GUID
2886
+ * The amount of this line item that was exempt.
2887
+ * @internal
2851
2888
  */
2852
- cartId: string;
2889
+ exemptAmount?: MultiCurrencyPrice;
2853
2890
  /**
2854
- * Discount ID.
2855
- * @format GUID
2891
+ * tax information for a line item.
2892
+ * @maxSize 1000
2893
+ * @readonly
2856
2894
  */
2857
- couponId: string;
2858
- }
2859
- interface RemoveCouponResponse {
2860
- /** Updated Cart. */
2861
- cart?: Cart;
2895
+ taxBreakdown?: TaxBreakdown[];
2862
2896
  }
2863
- interface SetDeliveryMethodRequest {
2897
+ interface TaxRateBreakdown {
2864
2898
  /**
2865
- * Cart ID.
2866
- * @format GUID
2899
+ * Name of tax against which the calculation was performed.
2900
+ * @maxLength 100
2867
2901
  */
2868
- cartId: string;
2869
- /** Delivery method. */
2870
- deliveryMethod: DeliveryMethodInput;
2871
- }
2872
- interface SetDeliveryMethodResponse {
2873
- /** Updated Cart. */
2874
- cart?: Cart;
2875
- }
2876
- interface AddGiftCardRequest {
2902
+ name?: string;
2903
+ /**
2904
+ * Rate at which this tax detail was calculated.
2905
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
2906
+ */
2907
+ rate?: string;
2908
+ /** Amount of tax for this tax detail. */
2909
+ tax?: MultiCurrencyPrice;
2910
+ /**
2911
+ * The amount of this line item that was exempt from this authority.
2912
+ * @internal
2913
+ */
2914
+ exemptAmount?: MultiCurrencyPrice;
2915
+ }
2916
+ /**
2917
+ * TaxBreakdown represents tax information for a line item.
2918
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
2919
+ */
2920
+ interface TaxBreakdown {
2921
+ /**
2922
+ * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
2923
+ * @maxLength 200
2924
+ */
2925
+ jurisdiction?: string | null;
2926
+ /** The amount of this line item price that was considered nontaxable. (Decimal value) */
2927
+ nonTaxableAmount?: MultiCurrencyPrice;
2928
+ /**
2929
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
2930
+ * @decimalValue options { gte:0, maxScale:6 }
2931
+ */
2932
+ rate?: string | null;
2933
+ /** The amount of tax estimated for this line item. (Decimal value) */
2934
+ taxAmount?: MultiCurrencyPrice;
2935
+ /** The taxable amount of this line item. */
2936
+ taxableAmount?: MultiCurrencyPrice;
2937
+ /**
2938
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
2939
+ * @maxLength 200
2940
+ */
2941
+ taxType?: string | null;
2942
+ /**
2943
+ * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
2944
+ * This name should be explicit enough to allow the merchant to understand what tax was calculated.
2945
+ * @maxLength 200
2946
+ */
2947
+ taxName?: string | null;
2948
+ /** The type of the jurisdiction in which this tax detail applies. */
2949
+ jurisdictionType?: JurisdictionTypeWithLiterals;
2950
+ /**
2951
+ * The amount of this line item that was exempt from this authority.
2952
+ * @internal
2953
+ */
2954
+ exemptAmount?: MultiCurrencyPrice;
2955
+ }
2956
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
2957
+ declare enum JurisdictionType {
2958
+ UNDEFINED = "UNDEFINED",
2959
+ COUNTRY = "COUNTRY",
2960
+ STATE = "STATE",
2961
+ COUNTY = "COUNTY",
2962
+ CITY = "CITY",
2963
+ SPECIAL = "SPECIAL"
2964
+ }
2965
+ /** @enumType */
2966
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
2967
+ interface CalculatedItemModifier {
2968
+ /**
2969
+ * Modifier ID.
2970
+ * @minLength 1
2971
+ * @maxLength 36
2972
+ */
2973
+ _id?: string;
2974
+ /**
2975
+ * ID of the group this modifier belongs to.
2976
+ * @minLength 1
2977
+ * @maxLength 36
2978
+ */
2979
+ groupId?: string;
2980
+ /**
2981
+ * Modifier price.
2982
+ * @readonly
2983
+ */
2984
+ price?: MultiCurrencyPrice;
2985
+ }
2986
+ interface PriceSummary {
2987
+ /** Subtotal of all line items, before discounts and before tax. */
2988
+ subtotal?: MultiCurrencyPrice;
2989
+ /** Total shipping price, before discounts and before tax. */
2990
+ shipping?: MultiCurrencyPrice;
2991
+ /** Total tax. */
2992
+ tax?: MultiCurrencyPrice;
2993
+ /** Total calculated discount value. */
2994
+ discount?: MultiCurrencyPrice;
2995
+ /** Total price after discounts, gift cards, and tax. */
2996
+ total?: MultiCurrencyPrice;
2997
+ /** Total additional fees price before tax. */
2998
+ additionalFees?: MultiCurrencyPrice;
2999
+ }
3000
+ interface GiftCard {
3001
+ /**
3002
+ * Gift Card ID.
3003
+ * @deprecated
3004
+ */
3005
+ _id?: string;
3006
+ /** Gift card obfuscated code. */
3007
+ obfuscatedCode?: string;
3008
+ /** Actual amount to be redeemed from the gift card. */
3009
+ amount?: MultiCurrencyPrice;
3010
+ /**
3011
+ * App ID of the gift card provider.
3012
+ * @format GUID
3013
+ */
3014
+ appId?: string;
3015
+ /**
3016
+ * External ID in the gift card provider's system.
3017
+ * Used for integration and tracking across different platforms.
3018
+ * @minLength 1
3019
+ * @maxLength 50
3020
+ */
3021
+ externalId?: string | null;
3022
+ /** Requested amount to redeem from the gift card. */
3023
+ requestedAmount?: MultiCurrencyPrice;
3024
+ }
3025
+ interface TaxSummary {
3026
+ /**
3027
+ * Amount for which tax is calculated, added from line items.
3028
+ * @readonly
3029
+ */
3030
+ taxableAmount?: MultiCurrencyPrice;
3031
+ /**
3032
+ * Calculated tax, added from line items.
3033
+ * @readonly
3034
+ */
3035
+ totalTax?: MultiCurrencyPrice;
3036
+ /**
3037
+ * Tax calculator that was active when the order was created.
3038
+ * @deprecated
3039
+ */
3040
+ calculationDetails?: TaxCalculationDetails;
3041
+ /**
3042
+ * The amount of this estimate that was exempt (for all line items).
3043
+ * @internal
3044
+ * @readonly
3045
+ */
3046
+ totalExempt?: MultiCurrencyPrice;
3047
+ /**
3048
+ * Default name of the tax that was calculated.
3049
+ * @internal
3050
+ * @maxLength 200
3051
+ */
3052
+ taxName?: string | null;
3053
+ }
3054
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
3055
+ /** Reason the manual calculation was used. */
3056
+ manualRateReason?: ManualCalculationReasonWithLiterals;
3057
+ /** Details of the fallback rate calculation. */
3058
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
3059
+ /** Rate calculation type. */
3060
+ rateType?: RateTypeWithLiterals;
3061
+ }
3062
+ /** @oneof */
3063
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
3064
+ /** Reason the manual calculation was used. */
3065
+ manualRateReason?: ManualCalculationReasonWithLiterals;
3066
+ /** Details of the fallback rate calculation. */
3067
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
3068
+ }
3069
+ declare enum RateType {
3070
+ /** no tax being collected for this request due to location of purchase */
3071
+ NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
3072
+ /** manual rate used for calculation */
3073
+ MANUAL_RATE = "MANUAL_RATE",
3074
+ /** autotax rate used for calculation */
3075
+ AUTO_RATE = "AUTO_RATE",
3076
+ /** fallback rate used for calculation */
3077
+ FALLBACK_RATE = "FALLBACK_RATE"
3078
+ }
3079
+ /** @enumType */
3080
+ type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
3081
+ declare enum ManualCalculationReason {
3082
+ /** user set calculator in Business Manager to be Manual */
3083
+ GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
3084
+ /** specific region is on manual even though Global setting is Auto-tax */
3085
+ REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
3086
+ }
3087
+ /** @enumType */
3088
+ type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
3089
+ interface AutoTaxFallbackCalculationDetails {
3090
+ /** reason for fallback */
3091
+ fallbackReason?: FallbackReasonWithLiterals;
3092
+ /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
3093
+ error?: ApplicationError;
3094
+ }
3095
+ declare enum FallbackReason {
3096
+ /** auto-tax failed to be calculated */
3097
+ AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
3098
+ /** auto-tax was temporarily deactivated on a system-level */
3099
+ AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
3100
+ }
3101
+ /** @enumType */
3102
+ type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
3103
+ /**
3104
+ * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
3105
+ * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
3106
+ */
3107
+ interface AggregatedTaxBreakdown {
3108
+ /**
3109
+ * The name of the tax against which this tax amount was calculated.
3110
+ * @maxLength 200
3111
+ */
3112
+ taxName?: string;
3113
+ /**
3114
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
3115
+ * @maxLength 200
3116
+ */
3117
+ taxType?: string;
3118
+ /**
3119
+ * The name of the jurisdiction in which this tax detail applies.
3120
+ * @maxLength 200
3121
+ */
3122
+ jurisdiction?: string;
3123
+ /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
3124
+ jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
3125
+ /**
3126
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
3127
+ * @decimalValue options { gte:0, maxScale:6 }
3128
+ */
3129
+ rate?: string;
3130
+ /** The sum of all the tax from line items that calculated by the tax identifiers. */
3131
+ aggregatedTaxAmount?: MultiCurrencyPrice;
3132
+ /** The sum of all the taxable amount from line items for tax identifiers. */
3133
+ aggregatedTaxableAmount?: MultiCurrencyPrice;
3134
+ /**
3135
+ * The aggregated exempt amount from all line items for tax identifiers.
3136
+ * @internal
3137
+ */
3138
+ aggregatedExemptAmount?: MultiCurrencyPrice;
3139
+ }
3140
+ interface ShippingInformation {
3141
+ /** Shipping region. */
3142
+ region?: ShippingRegion;
3143
+ /** Selected shipping option. */
3144
+ selectedCarrierServiceOption?: SelectedCarrierServiceOption;
3145
+ /** All shipping options. */
3146
+ carrierServiceOptions?: CarrierServiceOption[];
3147
+ }
3148
+ interface ShippingRegion {
3149
+ /**
3150
+ * Shipping region ID.
3151
+ * @format GUID
3152
+ * @readonly
3153
+ */
3154
+ _id?: string;
3155
+ /**
3156
+ * Shipping region name.
3157
+ * @maxLength 100
3158
+ */
3159
+ name?: string;
3160
+ }
3161
+ interface SelectedCarrierServiceOption {
3162
+ /**
3163
+ * Unique identifier of selected option. For example, "usps_std_overnight".
3164
+ * @maxLength 100
3165
+ */
3166
+ code?: string;
3167
+ /**
3168
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
3169
+ * For example, "Standard" or "First-Class Package International".
3170
+ * @maxLength 250
3171
+ * @readonly
3172
+ */
3173
+ title?: string;
3174
+ /**
3175
+ * Delivery logistics.
3176
+ * @readonly
3177
+ */
3178
+ logistics?: DeliveryLogistics;
3179
+ /**
3180
+ * Shipping costs.
3181
+ * @readonly
3182
+ */
3183
+ cost?: SelectedCarrierServiceOptionPrices;
3184
+ /**
3185
+ * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
3186
+ * @readonly
3187
+ */
3188
+ requestedShippingOption?: boolean;
3189
+ /**
3190
+ * Other charges
3191
+ * @deprecated Other charges
3192
+ * @replacedBy additional_fees
3193
+ * @targetRemovalDate 2025-10-01
3194
+ */
3195
+ otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
3196
+ /**
3197
+ * This carrier's unique ID
3198
+ * @format GUID
3199
+ */
3200
+ carrierId?: string | null;
3201
+ /**
3202
+ * Delivery solution allocations to different delivery carriers and delivery regions
3203
+ * @maxSize 300
3204
+ */
3205
+ deliveryAllocations?: DeliveryAllocation[];
3206
+ /** If the delivery solution is a partial and doesn't apply to all items. */
3207
+ partial?: boolean | null;
3208
+ }
3209
+ interface DeliveryLogistics {
3210
+ /**
3211
+ * Expected delivery time, in free text. For example, "3-5 business days".
3212
+ * @maxLength 500
3213
+ */
3214
+ deliveryTime?: string | null;
3215
+ /**
3216
+ * Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
3217
+ * @maxLength 1000
3218
+ */
3219
+ instructions?: string | null;
3220
+ /** Pickup details. */
3221
+ pickupDetails?: PickupDetails;
3222
+ }
3223
+ interface PickupDetails {
3224
+ /** Pickup address. */
3225
+ address?: Address;
3226
+ /**
3227
+ * Whether the pickup address is that of a business - this may effect tax calculation.
3228
+ * @deprecated
3229
+ */
3230
+ businessLocation?: boolean;
3231
+ /** Pickup method */
3232
+ pickupMethod?: PickupMethodWithLiterals;
3233
+ }
3234
+ declare enum PickupMethod {
3235
+ UNKNOWN_METHOD = "UNKNOWN_METHOD",
3236
+ STORE_PICKUP = "STORE_PICKUP",
3237
+ PICKUP_POINT = "PICKUP_POINT"
3238
+ }
3239
+ /** @enumType */
3240
+ type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
3241
+ interface DeliveryTimeSlot {
3242
+ /** starting time of the delivery time slot */
3243
+ from?: Date | null;
3244
+ /** ending time of the delivery time slot */
3245
+ to?: Date | null;
3246
+ }
3247
+ interface SelectedCarrierServiceOptionPrices {
3248
+ /** Total shipping price, after discount and after tax. */
3249
+ totalPriceAfterTax?: MultiCurrencyPrice;
3250
+ /** Total price of shipping after discounts (when relevant), and before tax. */
3251
+ totalPriceBeforeTax?: MultiCurrencyPrice;
3252
+ /** Tax details. */
3253
+ taxDetails?: ItemTaxFullDetails;
3254
+ /** Shipping discount before tax. */
3255
+ totalDiscount?: MultiCurrencyPrice;
3256
+ /** Shipping price before discount and before tax. */
3257
+ price?: MultiCurrencyPrice;
3258
+ }
3259
+ interface SelectedCarrierServiceOptionOtherCharge {
3260
+ /** Type of additional cost. */
3261
+ type?: ChargeTypeWithLiterals;
3262
+ /**
3263
+ * Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
3264
+ * @maxLength 200
3265
+ */
3266
+ details?: string | null;
3267
+ /** Price of added charge. */
3268
+ cost?: SelectedCarrierServiceOptionPrices;
3269
+ }
3270
+ declare enum ChargeType {
3271
+ HANDLING_FEE = "HANDLING_FEE",
3272
+ INSURANCE = "INSURANCE"
3273
+ }
3274
+ /** @enumType */
3275
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
3276
+ interface DeliveryAllocation {
3277
+ /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
3278
+ deliveryCarrier?: Carrier;
3279
+ /** The delivery region that are relevant for this delivery solution. */
3280
+ deliveryRegion?: Region;
3281
+ /** Populated if the delivery solution is a partially supplied by this carrier. */
3282
+ applicableLineItems?: ApplicableLineItems;
3283
+ }
3284
+ interface Carrier {
3285
+ /**
3286
+ * The carrier app id
3287
+ * @format GUID
3288
+ */
3289
+ appId?: string | null;
3290
+ /**
3291
+ * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
3292
+ * @maxLength 250
3293
+ */
3294
+ code?: string;
3295
+ }
3296
+ interface Region {
3297
+ /**
3298
+ * The delivery region id.
3299
+ * @format GUID
3300
+ */
3301
+ _id?: string | null;
3302
+ /**
3303
+ * The delivery region name.
3304
+ * @maxLength 100
3305
+ */
3306
+ name?: string | null;
3307
+ }
3308
+ interface ApplicableLineItems {
3309
+ /**
3310
+ * Line items that the delivery solution is for.
3311
+ * @maxSize 300
3312
+ * @minLength 1
3313
+ * @maxLength 100
3314
+ */
3315
+ lineItemIds?: string[];
3316
+ }
3317
+ interface CarrierServiceOption {
3318
+ /**
3319
+ * Carrier ID.
3320
+ * @format GUID
3321
+ */
3322
+ carrierId?: string;
3323
+ /** Shipping options offered by this carrier for this request. */
3324
+ shippingOptions?: ShippingOption[];
3325
+ }
3326
+ interface ShippingOption {
3327
+ /**
3328
+ * Unique code of provided shipping option like "usps_std_overnight".
3329
+ * For legacy calculators this would be the UUID of the option.
3330
+ * @maxLength 100
3331
+ */
3332
+ code?: string;
3333
+ /**
3334
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
3335
+ * For example, "Standard" or "First-Class Package International".
3336
+ * @maxLength 250
3337
+ */
3338
+ title?: string;
3339
+ /** Delivery logistics. */
3340
+ logistics?: DeliveryLogistics;
3341
+ /** Sipping price information. */
3342
+ cost?: ShippingPrice;
3343
+ /**
3344
+ * Delivery solution allocations to different delivery carriers and delivery regions
3345
+ * @maxSize 300
3346
+ */
3347
+ deliveryAllocations?: DeliveryAllocation[];
3348
+ /** If the delivery solution is a partial and doesn't apply to all items. */
3349
+ partial?: boolean | null;
3350
+ }
3351
+ interface ShippingPrice {
3352
+ /** Shipping price. */
3353
+ price?: MultiCurrencyPrice;
3354
+ /** Other costs such as insurance, handling & packaging for fragile items, etc. */
3355
+ otherCharges?: OtherCharge[];
3356
+ }
3357
+ interface OtherCharge {
3358
+ /** Type of additional cost. */
3359
+ type?: ChargeTypeWithLiterals;
3360
+ /** Price of added cost. */
3361
+ price?: MultiCurrencyPrice;
3362
+ /**
3363
+ * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
3364
+ * @maxLength 250
3365
+ */
3366
+ details?: string | null;
3367
+ }
3368
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
3369
+ /** Coupon details. */
3370
+ coupon?: Coupon;
3371
+ /** Merchant discount. */
3372
+ merchantDiscount?: MerchantDiscount;
3373
+ /** Discount rule */
3374
+ discountRule?: DiscountRule;
3375
+ /** Discount type. */
3376
+ discountType?: DiscountTypeWithLiterals;
3377
+ /**
3378
+ * IDs of line items the discount applies to.
3379
+ * @format GUID
3380
+ * @deprecated IDs of line items the discount applies to.
3381
+ * @replacedBy line_items_discounts
3382
+ * @targetRemovalDate 2025-12-31
3383
+ */
3384
+ lineItemIds?: string[];
3385
+ /**
3386
+ * Number of subscription cycle this discount applies to
3387
+ * default None - all billing cycle
3388
+ * @internal
3389
+ * @min 1
3390
+ * @max 999
3391
+ */
3392
+ subscriptionCycles?: number | null;
3393
+ }
3394
+ /** @oneof */
3395
+ interface AppliedDiscountDiscountSourceOneOf {
3396
+ /** Coupon details. */
3397
+ coupon?: Coupon;
3398
+ /** Merchant discount. */
3399
+ merchantDiscount?: MerchantDiscount;
3400
+ /** Discount rule */
3401
+ discountRule?: DiscountRule;
3402
+ }
3403
+ declare enum DiscountType {
3404
+ GLOBAL = "GLOBAL",
3405
+ SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
3406
+ SHIPPING = "SHIPPING"
3407
+ }
3408
+ /** @enumType */
3409
+ type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
3410
+ /** Coupon */
3411
+ interface Coupon {
3412
+ /** Coupon ID. */
3413
+ _id?: string;
3414
+ /** Coupon code. */
3415
+ code?: string;
3416
+ /** Coupon value. */
3417
+ amount?: MultiCurrencyPrice;
3418
+ /** Coupon name. */
3419
+ name?: string;
3420
+ }
3421
+ interface MerchantDiscount {
3422
+ /** Discount value. */
3423
+ amount?: MultiCurrencyPrice;
3424
+ /**
3425
+ * Discount Percentage. Will be calculated from items price before other discounts.
3426
+ * @min 1
3427
+ * @max 100
3428
+ */
3429
+ percentage?: number | null;
3430
+ }
3431
+ interface DiscountRule {
3432
+ /**
3433
+ * Discount rule ID
3434
+ * @format GUID
3435
+ */
3436
+ _id?: string;
3437
+ /** Discount rule name */
3438
+ name?: DiscountRuleName;
3439
+ /** Discount value. */
3440
+ amount?: MultiCurrencyPrice;
3441
+ }
3442
+ interface DiscountRuleName {
3443
+ /**
3444
+ * Original discount rule name (in site's default language).
3445
+ * @minLength 1
3446
+ * @maxLength 256
3447
+ */
3448
+ original?: string;
3449
+ /**
3450
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
3451
+ * @minLength 1
3452
+ * @maxLength 500
3453
+ */
3454
+ translated?: string | null;
3455
+ }
3456
+ interface LineItemDiscount {
3457
+ /**
3458
+ * ID of line item the discount applies to.
3459
+ * @format GUID
3460
+ */
3461
+ _id?: string;
3462
+ /** Discount value. */
3463
+ totalDiscountAmount?: MultiCurrencyPrice;
3464
+ }
3465
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
3466
+ /** General shipping calculation error. */
3467
+ generalShippingCalculationError?: Details;
3468
+ /** Carrier errors. */
3469
+ carrierErrors?: CarrierErrors;
3470
+ /** Tax calculation error. */
3471
+ taxCalculationError?: Details;
3472
+ /** Coupon calculation error. */
3473
+ couponCalculationError?: Details;
3474
+ /** Gift card calculation error. */
3475
+ giftCardCalculationError?: Details;
3476
+ /** Order validation errors. */
3477
+ orderValidationErrors?: ApplicationError[];
3478
+ /**
3479
+ * Membership payment methods calculation errors
3480
+ * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
3481
+ */
3482
+ membershipError?: Details;
3483
+ /** Discount Rule calculation error. */
3484
+ discountsCalculationError?: Details;
3485
+ }
3486
+ /** @oneof */
3487
+ interface CalculationErrorsShippingCalculationErrorOneOf {
3488
+ /** General shipping calculation error. */
3489
+ generalShippingCalculationError?: Details;
3490
+ /** Carrier errors. */
3491
+ carrierErrors?: CarrierErrors;
3492
+ }
3493
+ interface CarrierErrors {
3494
+ /** Carrier errors. */
3495
+ errors?: CarrierError[];
3496
+ }
3497
+ interface CarrierError {
3498
+ /** Carrier ID. */
3499
+ carrierId?: string;
3500
+ /** Error details. */
3501
+ error?: Details;
3502
+ }
3503
+ interface MembershipOptions {
3504
+ /**
3505
+ * List of payment options that can be used.
3506
+ * @maxSize 300
3507
+ */
3508
+ eligibleMemberships?: Membership[];
3509
+ /**
3510
+ * List of payment options that are owned by the member, but cannot be used due to reason provided.
3511
+ * @maxSize 300
3512
+ */
3513
+ invalidMemberships?: InvalidMembership[];
3514
+ /**
3515
+ * The selected membership payment options and which line items they apply to.
3516
+ * @maxSize 300
3517
+ */
3518
+ selectedMemberships?: SelectedMembership[];
3519
+ }
3520
+ interface Membership {
3521
+ /**
3522
+ * Membership ID.
3523
+ * @minLength 1
3524
+ * @maxLength 100
3525
+ */
3526
+ _id?: string;
3527
+ /**
3528
+ * ID of the application providing this payment option.
3529
+ * @format GUID
3530
+ */
3531
+ appId?: string;
3532
+ /** The name of this membership. */
3533
+ name?: MembershipName;
3534
+ /**
3535
+ * Line item IDs which are "paid" for by this membership.
3536
+ * @minSize 1
3537
+ * @maxSize 300
3538
+ * @minLength 1
3539
+ * @maxLength 100
3540
+ */
3541
+ lineItemIds?: string[];
3542
+ /** Optional - For a membership that has limited credits, information about credit usage. */
3543
+ credits?: MembershipPaymentCredits;
3544
+ /** Optional - TMembership expiry date. */
3545
+ expirationDate?: Date | null;
3546
+ /** Additional data about this membership. */
3547
+ additionalData?: Record<string, any> | null;
3548
+ }
3549
+ interface MembershipName {
3550
+ /**
3551
+ * Membership name.
3552
+ * @maxLength 100
3553
+ */
3554
+ original?: string;
3555
+ /**
3556
+ * Translated membership name. Defaults to `original` when not provided.
3557
+ * @maxLength 100
3558
+ */
3559
+ translated?: string | null;
3560
+ }
3561
+ interface MembershipPaymentCredits {
3562
+ /**
3563
+ * Membership's total amount of credits.
3564
+ * @min 1
3565
+ */
3566
+ total?: number;
3567
+ /** Membership's remaining amount of credits. */
3568
+ remaining?: number;
3569
+ }
3570
+ interface InvalidMembership {
3571
+ /** Membership details. */
3572
+ membership?: Membership;
3573
+ /**
3574
+ * Reason why this membership is invalid and cannot be used.
3575
+ * @minLength 1
3576
+ * @maxLength 100
3577
+ */
3578
+ reason?: string;
3579
+ }
3580
+ interface SelectedMembership {
3581
+ /**
3582
+ * Membership ID.
3583
+ * @minLength 1
3584
+ * @maxLength 100
3585
+ */
3586
+ _id?: string;
3587
+ /**
3588
+ * ID of the app providing this payment option.
3589
+ * @format GUID
3590
+ */
3591
+ appId?: string;
3592
+ /**
3593
+ * IDs of the line items this membership applies to.
3594
+ * @minSize 1
3595
+ * @maxSize 300
3596
+ * @minLength 1
3597
+ * @maxLength 100
3598
+ */
3599
+ lineItemIds?: string[];
3600
+ }
3601
+ interface AdditionalFee {
3602
+ /**
3603
+ * Additional fee's unique code (or ID) for future processing.
3604
+ * @minLength 1
3605
+ * @maxLength 100
3606
+ */
3607
+ code?: string | null;
3608
+ /**
3609
+ * Translated additional fee's name.
3610
+ * @minLength 1
3611
+ * @maxLength 50
3612
+ */
3613
+ name?: string;
3614
+ /** Additional fee's price. */
3615
+ price?: MultiCurrencyPrice;
3616
+ /** Tax details. */
3617
+ taxDetails?: ItemTaxFullDetails;
3618
+ /**
3619
+ * Provider's app id.
3620
+ * @minLength 1
3621
+ * @maxLength 100
3622
+ */
3623
+ providerAppId?: string | null;
3624
+ /** Additional fee's price before tax. */
3625
+ priceBeforeTax?: MultiCurrencyPrice;
3626
+ /** Additional fee's price after tax. */
3627
+ priceAfterTax?: MultiCurrencyPrice;
3628
+ /**
3629
+ * Optional - Line items associated with this additional fee.
3630
+ * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
3631
+ * @format GUID
3632
+ */
3633
+ lineItemIds?: string[];
3634
+ /**
3635
+ * Number of subscription cycle this fee applies to
3636
+ * default None - all billing cycle
3637
+ * @internal
3638
+ * @min 1
3639
+ * @max 999
3640
+ */
3641
+ subscriptionCycles?: number | null;
3642
+ /** the source the additional fee was added from */
3643
+ source?: AdditionalFeeSourceWithLiterals;
3644
+ /**
3645
+ * The translated name of the additional fee. The translation language is determined by the `languages` field in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
3646
+ * @minLength 1
3647
+ * @maxLength 50
3648
+ */
3649
+ translatedName?: string | null;
3650
+ }
3651
+ declare enum AdditionalFeeSource {
3652
+ UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
3653
+ /** The additional fee was added by an additional fee service plugin */
3654
+ SERVICE_PLUGIN = "SERVICE_PLUGIN",
3655
+ /** The additional fee was added on the item either via the catalog or on custom line item */
3656
+ ITEM = "ITEM",
3657
+ /** The additional fee was added manually on the request */
3658
+ MANUAL = "MANUAL",
3659
+ /** The additional fee was added by the shipping provider */
3660
+ SHIPPING = "SHIPPING"
3661
+ }
3662
+ /** @enumType */
3663
+ type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
3664
+ interface GetCheckoutURLRequest {
3665
+ /**
3666
+ * ID of the Cart to calculate.
3667
+ * @format GUID
3668
+ */
3669
+ cartId: string;
3670
+ /**
3671
+ * Checkout currency parameter to append as a query param
3672
+ * @format CURRENCY
3673
+ */
3674
+ currencyCode?: string | null;
3675
+ }
3676
+ interface GetCheckoutURLResponse {
3677
+ /**
3678
+ * The checkout URL.
3679
+ * @format WEB_URL
3680
+ */
3681
+ checkoutUrl?: string;
3682
+ }
3683
+ interface PlaceOrderRequest {
3684
+ /**
3685
+ * Cart ID.
3686
+ * @format GUID
3687
+ */
3688
+ cartId: string;
3689
+ /**
3690
+ * The price verification token received from `CalculateCart`'s response.
3691
+ * Used to verify that the prices shown to the customer have not changed before completing checkout.
3692
+ * @maxLength 3000
3693
+ */
3694
+ priceVerificationToken?: string | null;
3695
+ /**
3696
+ * Payment token.
3697
+ * @maxLength 100
3698
+ */
3699
+ paymentToken?: string | null;
3700
+ /** Urls to redirect to after payment is made. */
3701
+ redirectUrls?: RedirectUrls;
3702
+ /** Indicates the payment method should be saved on the order */
3703
+ savePaymentMethod?: boolean;
3704
+ /** Indicates whether to authorize the payment and delay the capture */
3705
+ delayCapture?: boolean;
3706
+ }
3707
+ interface RedirectUrls {
3708
+ /**
3709
+ * URL to redirect to if payment is canceled (usually checkout url).
3710
+ * @format WEB_URL
3711
+ */
3712
+ cancelUrl?: string;
3713
+ /**
3714
+ * URL to redirect to if an error occurred on payment (usually checkout url).
3715
+ * @format WEB_URL
3716
+ */
3717
+ errorUrl?: string;
3718
+ /**
3719
+ * URL to redirect to after successful payment, excepts order place holder {orderId}.
3720
+ * @maxLength 2000
3721
+ */
3722
+ successUrl?: string | null;
3723
+ /**
3724
+ * URL to redirect to if payment is pending, excepts order place holder {orderId}.
3725
+ * @maxLength 2000
3726
+ */
3727
+ pendingUrl?: string | null;
3728
+ }
3729
+ interface PlaceOrderResponse {
3730
+ /**
3731
+ * The order ID of the created order.
3732
+ * @format GUID
3733
+ */
3734
+ orderId?: string;
3735
+ /**
3736
+ * Payment response token.
3737
+ * @maxLength 1000
3738
+ */
3739
+ paymentResponseToken?: string | null;
3740
+ /**
3741
+ * The payment gateway is Cashier.
3742
+ * payment_gateway_order_id will be returned given that money was charged.
3743
+ * In some cases, money will not be charged:
3744
+ * If the total price is 0 - For example, could be a free item or a an item with 100% discount
3745
+ * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
3746
+ * @maxLength 50
3747
+ */
3748
+ paymentGatewayOrderId?: string | null;
3749
+ /** Whether an order was successfully created from this cart and the payment transaction was completed. */
3750
+ completed?: boolean;
3751
+ }
3752
+ interface AddLineItemsRequest {
3753
+ /**
3754
+ * Cart ID.
3755
+ * @format GUID
3756
+ */
3757
+ cartId: string;
3758
+ /**
3759
+ * A list of catalog items to add to the cart.
3760
+ * @maxSize 300
3761
+ */
3762
+ catalogItems?: CatalogItemInput[];
3763
+ /**
3764
+ * A list of custom items to add to the cart.
3765
+ * @maxSize 300
3766
+ */
3767
+ customItems?: CustomItemInput[];
3768
+ }
3769
+ interface AddLineItemsResponse {
3770
+ /** Updated Cart. */
3771
+ cart?: Cart;
3772
+ }
3773
+ interface RemoveLineItemsRequest {
3774
+ /**
3775
+ * Cart ID.
3776
+ * @format GUID
3777
+ */
3778
+ cartId: string;
3779
+ /**
3780
+ * Line item IDs to remove from cart.
3781
+ * @format GUID
3782
+ * @minSize 1
3783
+ * @maxSize 100
3784
+ */
3785
+ lineItemIds: string[];
3786
+ }
3787
+ interface RemoveLineItemsResponse {
3788
+ /** Updated Cart. */
3789
+ cart?: Cart;
3790
+ }
3791
+ interface UpdateLineItemsRequest {
3792
+ /**
3793
+ * Cart ID.
3794
+ * @format GUID
3795
+ */
3796
+ cartId: string;
3797
+ /**
3798
+ * Line item updates to apply.
3799
+ * @minSize 1
3800
+ * @maxSize 300
3801
+ */
3802
+ lineItems?: LineItemUpdate[];
3803
+ }
3804
+ interface UpdateLineItemsResponse {
3805
+ /** Updated Cart. */
3806
+ cart?: Cart;
3807
+ }
3808
+ interface AddCouponRequest {
3809
+ /**
3810
+ * Cart ID.
3811
+ * @format GUID
3812
+ */
3813
+ cartId: string;
3814
+ /**
3815
+ * Coupon to apply.
3816
+ *
3817
+ * Currently only one is supported.
3818
+ * @minLength 1
3819
+ * @maxLength 50
3820
+ */
3821
+ couponCode: string;
3822
+ }
3823
+ interface AddCouponResponse {
3824
+ /** Updated Cart. */
3825
+ cart?: Cart;
3826
+ }
3827
+ interface RemoveCouponRequest {
3828
+ /**
3829
+ * Cart ID.
3830
+ * @format GUID
3831
+ */
3832
+ cartId: string;
3833
+ /**
3834
+ * Discount ID.
3835
+ * @format GUID
3836
+ */
3837
+ couponId: string;
3838
+ }
3839
+ interface RemoveCouponResponse {
3840
+ /** Updated Cart. */
3841
+ cart?: Cart;
3842
+ }
3843
+ interface SetDeliveryMethodRequest {
3844
+ /**
3845
+ * Cart ID.
3846
+ * @format GUID
3847
+ */
3848
+ cartId: string;
3849
+ /** Delivery method. */
3850
+ deliveryMethod: DeliveryMethodInput;
3851
+ }
3852
+ interface SetDeliveryMethodResponse {
3853
+ /** Updated Cart. */
3854
+ cart?: Cart;
3855
+ }
3856
+ interface AddGiftCardRequest {
2877
3857
  /**
2878
3858
  * Cart ID.
2879
3859
  * @format GUID
@@ -2942,6 +3922,12 @@ interface HeadersEntry {
2942
3922
  key?: string;
2943
3923
  value?: string;
2944
3924
  }
3925
+ /** @docsIgnore */
3926
+ type GetCartApplicationErrors = {
3927
+ code?: 'DUMMY_ERROR_METHOD_CODE';
3928
+ description?: string;
3929
+ data?: DummyErrorDataMethodLevel;
3930
+ };
2945
3931
  /**
2946
3932
  * Creates a Cart.
2947
3933
  * @internal
@@ -3009,7 +3995,9 @@ interface CreateCartOptions {
3009
3995
  * @returns The requested Cart.
3010
3996
  * @fqn wix.ecom.cart.v2.CartService.GetCart
3011
3997
  */
3012
- declare function getCart(cartId: string): Promise<NonNullablePaths<Cart, `_id` | `revision` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.name.original` | `lineItems.${number}.quantityInfo.confirmedQuantity` | `lineItems.${number}.quantityInfo.requestedQuantity` | `lineItems.${number}.quantityInfo.fixedQuantity` | `lineItems.${number}.pricing.unitPrice.amount` | `lineItems.${number}.pricing.unitPrice.convertedAmount` | `lineItems.${number}.pricing.priceDescription.original` | `lineItems.${number}.pricing.priceUndetermined` | `lineItems.${number}.source.catalogReference.catalogItemId` | `lineItems.${number}.source.catalogReference.appId` | `lineItems.${number}.attributes.itemType.preset` | `lineItems.${number}.attributes.itemType.custom` | `lineItems.${number}.attributes.physicalProperties.shippable` | `lineItems.${number}.attributes.membersOnly` | `lineItems.${number}.taxConfig.taxableAddress.addressType` | `lineItems.${number}.paymentConfig.savePaymentMethod` | `lineItems.${number}.paymentConfig.selectedMembership._id` | `lineItems.${number}.paymentConfig.selectedMembership.appId` | `lineItems.${number}.paymentConfig.paymentOption` | `lineItems.${number}.status` | `lineItems.${number}.customLineItem` | `coupons` | `coupons.${number}._id` | `coupons.${number}.code` | `source.channelType` | `source.externalReferences` | `source.externalReferences.${number}.appId` | `source.createdBy.visitorId` | `source.createdBy.memberId` | `source.createdBy.userId` | `source.createdBy.appId` | `source.customContentReference.appId` | `source.customContentReference.componentId` | `businessInfo.languageCode` | `businessInfo.currencyCode` | `customerInfo.visitorId` | `customerInfo.memberId` | `customerInfo.userId` | `customerInfo.vatId._id` | `customerInfo.vatId.type` | `customerInfo.languageCode` | `customerInfo.currencyCode` | `deliveryInfo.address.streetAddress.number` | `deliveryInfo.address.streetAddress.name` | `deliveryInfo.method.code` | `deliveryInfo.method.pickup` | `deliveryInfo.weightUnit` | `taxInfo.pricesIncludeTax` | `paymentInfo.giftCards` | `paymentInfo.giftCards.${number}._id` | `paymentInfo.giftCards.${number}.obfuscatedCode` | `paymentInfo.giftCards.${number}.appId` | `paymentInfo.currencyCode` | `orderPlaced` | `currentCart`, 6>>;
3998
+ declare function getCart(cartId: string): Promise<NonNullablePaths<Cart, `_id` | `revision` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.name.original` | `lineItems.${number}.quantityInfo.confirmedQuantity` | `lineItems.${number}.quantityInfo.requestedQuantity` | `lineItems.${number}.quantityInfo.fixedQuantity` | `lineItems.${number}.pricing.unitPrice.amount` | `lineItems.${number}.pricing.unitPrice.convertedAmount` | `lineItems.${number}.pricing.priceDescription.original` | `lineItems.${number}.pricing.priceUndetermined` | `lineItems.${number}.source.catalogReference.catalogItemId` | `lineItems.${number}.source.catalogReference.appId` | `lineItems.${number}.attributes.itemType.preset` | `lineItems.${number}.attributes.itemType.custom` | `lineItems.${number}.attributes.physicalProperties.shippable` | `lineItems.${number}.attributes.membersOnly` | `lineItems.${number}.taxConfig.taxableAddress.addressType` | `lineItems.${number}.paymentConfig.savePaymentMethod` | `lineItems.${number}.paymentConfig.selectedMembership._id` | `lineItems.${number}.paymentConfig.selectedMembership.appId` | `lineItems.${number}.paymentConfig.paymentOption` | `lineItems.${number}.status` | `lineItems.${number}.customLineItem` | `coupons` | `coupons.${number}._id` | `coupons.${number}.code` | `source.channelType` | `source.externalReferences` | `source.externalReferences.${number}.appId` | `source.createdBy.visitorId` | `source.createdBy.memberId` | `source.createdBy.userId` | `source.createdBy.appId` | `source.customContentReference.appId` | `source.customContentReference.componentId` | `businessInfo.languageCode` | `businessInfo.currencyCode` | `customerInfo.visitorId` | `customerInfo.memberId` | `customerInfo.userId` | `customerInfo.vatId._id` | `customerInfo.vatId.type` | `customerInfo.languageCode` | `customerInfo.currencyCode` | `deliveryInfo.address.streetAddress.number` | `deliveryInfo.address.streetAddress.name` | `deliveryInfo.method.code` | `deliveryInfo.method.pickup` | `deliveryInfo.weightUnit` | `taxInfo.pricesIncludeTax` | `paymentInfo.giftCards` | `paymentInfo.giftCards.${number}._id` | `paymentInfo.giftCards.${number}.obfuscatedCode` | `paymentInfo.giftCards.${number}.appId` | `paymentInfo.currencyCode` | `orderPlaced` | `currentCart`, 6> & {
3999
+ __applicationErrorsType?: GetCartApplicationErrors;
4000
+ }>;
3013
4001
  /**
3014
4002
  * Updates a Cart.
3015
4003
  *
@@ -3074,7 +4062,7 @@ interface UpdateCart {
3074
4062
  * @maxSize 1
3075
4063
  * @readonly
3076
4064
  */
3077
- coupons?: Coupon[];
4065
+ coupons?: V2Coupon[];
3078
4066
  /** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
3079
4067
  source?: CartSource;
3080
4068
  /** Information about the site from which the Cart's line items were added. */
@@ -3416,4 +4404,4 @@ interface MarkCartAsCompletedOptions {
3416
4404
  */
3417
4405
  declare function handleAsyncCheckoutCompletion(token: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`, 4>>;
3418
4406
 
3419
- export { type ActionEvent, type AddCouponRequest, type AddCouponResponse, type AddCouponToCurrentCartRequest, type AddCouponToCurrentCartResponse, type AddGiftCardRequest, type AddGiftCardResponse, type AddGiftCardToCurrentCartRequest, type AddGiftCardToCurrentCartResponse, type AddLineItemsOptions, type AddLineItemsRequest, type AddLineItemsResponse, type AddLineItemsToCurrentCartRequest, type AddLineItemsToCurrentCartResponse, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type ApplicationError, type BusinessInfo, type CalculateCartOptions, type CalculateCartRequest, type CalculateCartResponse, type CalculateCurrentCartRequest, type CalculateCurrentCartResponse, type CalculationConfig, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type CarrierError, type CarrierErrors, type Cart, type CartSettings, type CartSource, type CartSummary, type CatalogItemInput, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, type Charge, type Color, type ConvertedMoney, type Coupon, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCurrentCartRequest, type CreateCurrentCartResponse, type CreatedBy, type CreatedByIdOneOf, type CustomContentReference, type CustomField, type CustomItemAttributes, type CustomItemDeliveryConfig, type CustomItemInput, type CustomItemPaymentConfig, type CustomItemPricingInfo, type CustomItemQuantityInfo, type CustomItemSource, type CustomItemTaxConfig, type CustomerInfo, type CustomerInfoIdOneOf, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeleteCurrentCartResponse, type DeliveryInfo, type DeliveryMethod, type DeliveryMethodInput, type DeliverySummary, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Discount, type DiscountBenefit, type DiscountBenefitValueOneOf, DiscountScope, type DiscountScopeWithLiterals, type DiscountSource, DiscountSourceType, type DiscountSourceTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type ExternalReference, type FieldViolation, FileType, type FileTypeWithLiterals, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartRequest, type GetCartResponse, type GetCheckoutURLRequest, type GetCheckoutURLResponse, type GetCheckoutUrlOptions, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardSummary, type Group, type HandleAsyncCheckoutCompletionRequest, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ItemAttributes, type ItemDeliveryConfig, type ItemDiscount, type ItemModifier, type ItemPaymentConfig, type ItemPriceBreakdown, type ItemPricingInfo, type ItemQuantityInfo, type ItemSource, ItemStatus, type ItemStatusWithLiterals, type ItemTaxConfig, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, type LegacyFields, type LineItem, type LineItemSummary, type LineItemTax, type LineItemUpdate, type MarkCartAsCompletedOptions, type MarkCartAsCompletedRequest, type MarkCartAsCompletedResponse, type Membership, type MessageEnvelope, type ModifierGroup, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type PaymentInfo, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PaymentSummary, type PhysicalProperties, type PlaceOrderOptions, type PlaceOrderRequest, type PlaceOrderResponse, type PlainTextValue, type Policy, type PriceDescription, type PriceSummary, type QuantityUpdate, type RawHttpResponse, type RedirectUrls, type RefreshCartRequest, type RefreshCartResponse, type RefreshCurrentCartRequest, type RefreshCurrentCartResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponFromCurrentCartResponse, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveGiftCardFromCurrentCartRequest, type RemoveGiftCardFromCurrentCartResponse, type RemoveGiftCardRequest, type RemoveGiftCardResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsFromCurrentCartResponse, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedMembership, type SelectedMembershipUpdate, type ServiceProperties, type SetDeliveryMethodForCurrentCartRequest, type SetDeliveryMethodForCurrentCartResponse, type SetDeliveryMethodRequest, type SetDeliveryMethodResponse, Severity, type SeverityWithLiterals, type StreetAddress, type SubscriptionCharges, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetTargetTypeOneOf, type Tax, type TaxDetails, type TaxInfo, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UnmarkAsCurrentCartRequest, type UnmarkAsCurrentCartResponse, type UpdateCart, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartRequest, type UpdateCurrentCartResponse, type UpdateLineItemsInCurrentCartRequest, type UpdateLineItemsInCurrentCartResponse, type UpdateLineItemsOptions, type UpdateLineItemsRequest, type UpdateLineItemsResponse, type V2AdditionalFee, type V2LineItem, type ValidationError, ValidationsConfig, type ValidationsConfigWithLiterals, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addCoupon, addGiftCard, addLineItems, calculateCart, createCart, deleteCart, getCart, getCheckoutUrl, handleAsyncCheckoutCompletion, markCartAsCompleted, placeOrder, refreshCart, removeCoupon, removeGiftCard, removeLineItems, setDeliveryMethod, updateCart, updateLineItems };
4407
+ export { type ActionEvent, type AddCouponRequest, type AddCouponResponse, type AddCouponToCurrentCartRequest, type AddCouponToCurrentCartResponse, type AddGiftCardRequest, type AddGiftCardResponse, type AddGiftCardToCurrentCartRequest, type AddGiftCardToCurrentCartResponse, type AddLineItemsOptions, type AddLineItemsRequest, type AddLineItemsResponse, type AddLineItemsToCurrentCartRequest, type AddLineItemsToCurrentCartResponse, type AdditionalFee, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type AdditionalFeeTax, type Address, type AddressLocation, type AggregatedTaxBreakdown, type ApplicableLineItems, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, type AutoTaxFallbackCalculationDetails, type BusinessInfo, type CalculateCartOptions, type CalculateCartRequest, type CalculateCartResponse, type CalculateCartWithFullResponseResponse, type CalculateCurrentCartRequest, type CalculateCurrentCartResponse, type CalculateTotalsResponse, type CalculatedItemModifier, type CalculatedLineItem, type CalculationConfig, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type Cart, type CartSettings, type CartSource, type CartSummary, type CatalogItemInput, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, type Charge, ChargeType, type ChargeTypeWithLiterals, type Color, type ConvertedMoney, type Coupon, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCurrentCartRequest, type CreateCurrentCartResponse, type CreatedBy, type CreatedByIdOneOf, type CustomContentReference, type CustomField, type CustomItemAttributes, type CustomItemDeliveryConfig, type CustomItemInput, type CustomItemPaymentConfig, type CustomItemPricingInfo, type CustomItemQuantityInfo, type CustomItemSource, type CustomItemTaxConfig, type CustomerInfo, type CustomerInfoIdOneOf, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeleteCurrentCartResponse, type DeliveryAllocation, type DeliveryInfo, type DeliveryLogistics, type DeliveryMethod, type DeliveryMethodInput, type DeliverySummary, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Discount, type DiscountBenefit, type DiscountBenefitValueOneOf, type DiscountRule, type DiscountRuleName, DiscountScope, type DiscountScopeWithLiterals, type DiscountSource, DiscountSourceType, type DiscountSourceTypeWithLiterals, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type DummyErrorDataMethodLevel, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type ExternalReference, FallbackReason, type FallbackReasonWithLiterals, type FieldViolation, FileType, type FileTypeWithLiterals, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartApplicationErrors, type GetCartRequest, type GetCartResponse, type GetCheckoutURLRequest, type GetCheckoutURLResponse, type GetCheckoutUrlOptions, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardSummary, type Group, type HandleAsyncCheckoutCompletionRequest, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type InvalidMembership, type ItemAttributes, type ItemDeliveryConfig, type ItemDiscount, type ItemModifier, type ItemPaymentConfig, type ItemPriceBreakdown, type ItemPricingInfo, type ItemQuantityInfo, type ItemSource, ItemStatus, type ItemStatusWithLiterals, type ItemTaxConfig, type ItemTaxFullDetails, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LegacyFields, type LineItem, type LineItemDiscount, type LineItemIdentifier, type LineItemIdentifierIdOneOf, type LineItemPricesData, type LineItemSummary, type LineItemTax, type LineItemUpdate, ManualCalculationReason, type ManualCalculationReasonWithLiterals, type MarkCartAsCompletedOptions, type MarkCartAsCompletedRequest, type MarkCartAsCompletedResponse, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MerchantDiscount, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type OtherCharge, type PaymentInfo, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PaymentSummary, type PhysicalProperties, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlaceOrderOptions, type PlaceOrderRequest, type PlaceOrderResponse, type PlainTextValue, type Policy, type PriceDescription, type PriceSummary, type QuantityUpdate, RateType, type RateTypeWithLiterals, type RawHttpResponse, type RedirectUrls, type RefreshCartRequest, type RefreshCartResponse, type RefreshCurrentCartRequest, type RefreshCurrentCartResponse, type Region, type RemoveCouponFromCurrentCartRequest, type RemoveCouponFromCurrentCartResponse, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveGiftCardFromCurrentCartRequest, type RemoveGiftCardFromCurrentCartResponse, type RemoveGiftCardRequest, type RemoveGiftCardResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsFromCurrentCartResponse, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMembershipUpdate, type ServiceProperties, type SetDeliveryMethodForCurrentCartRequest, type SetDeliveryMethodForCurrentCartResponse, type SetDeliveryMethodRequest, type SetDeliveryMethodResponse, Severity, type SeverityWithLiterals, type ShippingInformation, type ShippingOption, type ShippingPrice, type ShippingRegion, type StreetAddress, type SubscriptionCharges, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetTargetTypeOneOf, type Tax, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxDetails, type TaxInfo, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UnmarkAsCurrentCartRequest, type UnmarkAsCurrentCartResponse, type UpdateCart, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartRequest, type UpdateCurrentCartResponse, type UpdateLineItemsInCurrentCartRequest, type UpdateLineItemsInCurrentCartResponse, type UpdateLineItemsOptions, type UpdateLineItemsRequest, type UpdateLineItemsResponse, type V1AdditionalFee, type V2AdditionalFee, type V2CalculationErrors, type V2CalculationErrorsShippingCalculationErrorOneOf, type V2CarrierError, type V2CarrierErrors, type V2Coupon, type V2GiftCard, type V2LineItem, type V2Membership, type V2PriceSummary, type V2SelectedMembership, type V2TaxSummary, type ValidationError, ValidationsConfig, type ValidationsConfigWithLiterals, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addCoupon, addGiftCard, addLineItems, calculateCart, createCart, deleteCart, getCart, getCheckoutUrl, handleAsyncCheckoutCompletion, markCartAsCompleted, placeOrder, refreshCart, removeCoupon, removeGiftCard, removeLineItems, setDeliveryMethod, updateCart, updateLineItems };