@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.
- package/build/cjs/index.d.ts +1107 -185
- package/build/cjs/index.js +67 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -1
- package/build/cjs/index.typings.js +67 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1106 -184
- package/build/cjs/meta.js +67 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +1107 -185
- package/build/es/index.mjs +59 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1 -1
- package/build/es/index.typings.mjs +59 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1106 -184
- package/build/es/meta.mjs +59 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +6 -4
- package/build/internal/cjs/index.js +67 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +1186 -198
- package/build/internal/cjs/index.typings.js +67 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1106 -184
- package/build/internal/cjs/meta.js +67 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +6 -4
- package/build/internal/es/index.mjs +59 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +1186 -198
- package/build/internal/es/index.typings.mjs +59 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1106 -184
- package/build/internal/es/meta.mjs +59 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -47,7 +47,7 @@ interface Cart {
|
|
|
47
47
|
* @maxSize 1
|
|
48
48
|
* @readonly
|
|
49
49
|
*/
|
|
50
|
-
coupons?:
|
|
50
|
+
coupons?: V2Coupon[];
|
|
51
51
|
/** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
|
|
52
52
|
source?: CartSource;
|
|
53
53
|
/** Information about the site from which the Cart's line items were added. */
|
|
@@ -142,7 +142,7 @@ interface V2LineItem {
|
|
|
142
142
|
* Additional Fees to be added to this item calculation.
|
|
143
143
|
* @maxSize 5
|
|
144
144
|
*/
|
|
145
|
-
additionalFees?:
|
|
145
|
+
additionalFees?: V1AdditionalFee[];
|
|
146
146
|
/**
|
|
147
147
|
* Modifier groups that were added to the item.
|
|
148
148
|
* @maxSize 25
|
|
@@ -774,7 +774,7 @@ interface ItemPaymentConfig {
|
|
|
774
774
|
* Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`.
|
|
775
775
|
* This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`.
|
|
776
776
|
*/
|
|
777
|
-
selectedMembership?:
|
|
777
|
+
selectedMembership?: V2SelectedMembership;
|
|
778
778
|
/**
|
|
779
779
|
* Type of selected payment option for current item.
|
|
780
780
|
*
|
|
@@ -782,7 +782,7 @@ interface ItemPaymentConfig {
|
|
|
782
782
|
*/
|
|
783
783
|
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
784
784
|
}
|
|
785
|
-
interface
|
|
785
|
+
interface V2SelectedMembership {
|
|
786
786
|
/**
|
|
787
787
|
* Membership ID.
|
|
788
788
|
* @minLength 1
|
|
@@ -824,7 +824,7 @@ interface ExtendedFields {
|
|
|
824
824
|
*/
|
|
825
825
|
namespaces?: Record<string, Record<string, any>>;
|
|
826
826
|
}
|
|
827
|
-
interface
|
|
827
|
+
interface V1AdditionalFee {
|
|
828
828
|
/**
|
|
829
829
|
* Additional fee's unique code or ID.
|
|
830
830
|
* @minLength 1
|
|
@@ -921,7 +921,7 @@ interface Group {
|
|
|
921
921
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
922
922
|
entityId?: string | null;
|
|
923
923
|
}
|
|
924
|
-
interface
|
|
924
|
+
interface V2Coupon {
|
|
925
925
|
/**
|
|
926
926
|
* ID of the coupon in the Cart.
|
|
927
927
|
* @format GUID
|
|
@@ -1341,7 +1341,7 @@ interface PaymentInfo {
|
|
|
1341
1341
|
* @readonly
|
|
1342
1342
|
* @maxSize 1
|
|
1343
1343
|
*/
|
|
1344
|
-
giftCards?:
|
|
1344
|
+
giftCards?: V2GiftCard[];
|
|
1345
1345
|
/**
|
|
1346
1346
|
* The currency used for processing the payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1347
1347
|
*
|
|
@@ -1355,7 +1355,7 @@ interface PaymentInfo {
|
|
|
1355
1355
|
/** Full contact details for billing. */
|
|
1356
1356
|
billingContact?: FullAddressContactDetails;
|
|
1357
1357
|
}
|
|
1358
|
-
interface
|
|
1358
|
+
interface V2GiftCard {
|
|
1359
1359
|
/**
|
|
1360
1360
|
* A unique identifier of the gift card within the Cart.
|
|
1361
1361
|
* @format GUID
|
|
@@ -1414,39 +1414,7 @@ interface CartSettings {
|
|
|
1414
1414
|
/** Whether to disable manual payment option for this checkout. */
|
|
1415
1415
|
manualPaymentDisabled?: boolean | null;
|
|
1416
1416
|
}
|
|
1417
|
-
interface CustomField {
|
|
1418
|
-
/** Custom field value. */
|
|
1419
|
-
value?: any;
|
|
1420
|
-
/**
|
|
1421
|
-
* Custom field title.
|
|
1422
|
-
* @minLength 1
|
|
1423
|
-
* @maxLength 500
|
|
1424
|
-
*/
|
|
1425
|
-
title?: string;
|
|
1426
|
-
/**
|
|
1427
|
-
* Translated custom field title.
|
|
1428
|
-
* @minLength 1
|
|
1429
|
-
* @maxLength 500
|
|
1430
|
-
*/
|
|
1431
|
-
translatedTitle?: string | null;
|
|
1432
|
-
}
|
|
1433
1417
|
interface LegacyFields {
|
|
1434
|
-
/**
|
|
1435
|
-
* The applied discounts of the Cart.
|
|
1436
|
-
* Discounts that are no longer applied are not included in this list.
|
|
1437
|
-
* @maxSize 100
|
|
1438
|
-
*/
|
|
1439
|
-
appliedDiscounts?: Discount[];
|
|
1440
|
-
/** The coupon discount amount. */
|
|
1441
|
-
couponDiscount?: ConvertedMoney;
|
|
1442
|
-
/** The sum of all line items after applying all discounts. */
|
|
1443
|
-
subtotalAfterCouponDiscount?: ConvertedMoney;
|
|
1444
|
-
/**
|
|
1445
|
-
* Indicates that this cart was created by the Buy Now flow.
|
|
1446
|
-
* Used by the Cart API proxy to determine whether to produce legacy V1 domain events.
|
|
1447
|
-
* @immutable
|
|
1448
|
-
*/
|
|
1449
|
-
buyNow?: boolean;
|
|
1450
1418
|
}
|
|
1451
1419
|
interface Discount {
|
|
1452
1420
|
/** The display name of the discount. */
|
|
@@ -1514,6 +1482,22 @@ interface DiscountBenefitValueOneOf {
|
|
|
1514
1482
|
/** A specific monetary value deducted from the total cost. */
|
|
1515
1483
|
amountOff?: ConvertedMoney;
|
|
1516
1484
|
}
|
|
1485
|
+
interface CustomField {
|
|
1486
|
+
/** Custom field value. */
|
|
1487
|
+
value?: any;
|
|
1488
|
+
/**
|
|
1489
|
+
* Custom field title.
|
|
1490
|
+
* @minLength 1
|
|
1491
|
+
* @maxLength 500
|
|
1492
|
+
*/
|
|
1493
|
+
title?: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* Translated custom field title.
|
|
1496
|
+
* @minLength 1
|
|
1497
|
+
* @maxLength 500
|
|
1498
|
+
*/
|
|
1499
|
+
translatedTitle?: string | null;
|
|
1500
|
+
}
|
|
1517
1501
|
interface CartSummary {
|
|
1518
1502
|
/**
|
|
1519
1503
|
* The Cart ID.
|
|
@@ -1543,9 +1527,9 @@ interface CartSummary {
|
|
|
1543
1527
|
*/
|
|
1544
1528
|
additionalFees?: V2AdditionalFee[];
|
|
1545
1529
|
/** Summary of tax calculations applied to the cart. */
|
|
1546
|
-
taxSummary?:
|
|
1530
|
+
taxSummary?: V2TaxSummary;
|
|
1547
1531
|
/** Summary of all calculated price components in the cart. */
|
|
1548
|
-
priceSummary?:
|
|
1532
|
+
priceSummary?: V2PriceSummary;
|
|
1549
1533
|
/** Payment details summarizing how the customer will pay for the order. */
|
|
1550
1534
|
paymentSummary?: PaymentSummary;
|
|
1551
1535
|
/**
|
|
@@ -1568,7 +1552,7 @@ interface CartSummary {
|
|
|
1568
1552
|
* List of errors that occurred during the calculation process, returned by Totals Calculator.
|
|
1569
1553
|
* TODO: Temporary field for backward compatibility; will be removed once we introduce the unified 'violations' model.
|
|
1570
1554
|
*/
|
|
1571
|
-
calculationErrors?:
|
|
1555
|
+
calculationErrors?: V2CalculationErrors;
|
|
1572
1556
|
/**
|
|
1573
1557
|
* 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)).
|
|
1574
1558
|
* TODO: Temporary field for backward compatibility; will be removed once we introduce the unified 'violations' model.
|
|
@@ -1643,7 +1627,7 @@ interface V2AdditionalFee {
|
|
|
1643
1627
|
*/
|
|
1644
1628
|
subscriptionCycles?: number | null;
|
|
1645
1629
|
}
|
|
1646
|
-
interface
|
|
1630
|
+
interface V2TaxSummary {
|
|
1647
1631
|
/**
|
|
1648
1632
|
* List of taxes applied to the cart.
|
|
1649
1633
|
* May contain multiple entries when advanced tax rates are configured by the merchant,
|
|
@@ -1704,7 +1688,7 @@ interface AdditionalFeeTax {
|
|
|
1704
1688
|
/** Tax amount applied to the additional fee. */
|
|
1705
1689
|
tax?: ConvertedMoney;
|
|
1706
1690
|
}
|
|
1707
|
-
interface
|
|
1691
|
+
interface V2PriceSummary {
|
|
1708
1692
|
/**
|
|
1709
1693
|
* Total price of all line items after applying item-level discounts.
|
|
1710
1694
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
@@ -1742,7 +1726,7 @@ interface PaymentSummary {
|
|
|
1742
1726
|
* A list of valid memberships that will be charged as part of the order.
|
|
1743
1727
|
* @maxSize 300
|
|
1744
1728
|
*/
|
|
1745
|
-
memberships?:
|
|
1729
|
+
memberships?: V2Membership[];
|
|
1746
1730
|
/**
|
|
1747
1731
|
* Charges information for each subscription in the checkout.
|
|
1748
1732
|
* @maxSize 100
|
|
@@ -1768,7 +1752,7 @@ interface GiftCardSummary {
|
|
|
1768
1752
|
/** The amount to be reduced from the gift card's balance. */
|
|
1769
1753
|
redeemAmount?: ConvertedMoney;
|
|
1770
1754
|
}
|
|
1771
|
-
interface
|
|
1755
|
+
interface V2Membership {
|
|
1772
1756
|
/**
|
|
1773
1757
|
* Membership ID.
|
|
1774
1758
|
* @minLength 1
|
|
@@ -1815,15 +1799,15 @@ interface Charge {
|
|
|
1815
1799
|
/** The number of cycles for which the charge is applicable. */
|
|
1816
1800
|
cycleCount?: number | null;
|
|
1817
1801
|
/** Charge summary. */
|
|
1818
|
-
priceSummary?:
|
|
1802
|
+
priceSummary?: V2PriceSummary;
|
|
1819
1803
|
/** The billing date from which the charge starts. */
|
|
1820
1804
|
cycleBillingDate?: Date | null;
|
|
1821
1805
|
}
|
|
1822
|
-
interface
|
|
1806
|
+
interface V2CalculationErrors extends V2CalculationErrorsShippingCalculationErrorOneOf {
|
|
1823
1807
|
/** General shipping calculation error. */
|
|
1824
1808
|
generalShippingCalculationError?: Details;
|
|
1825
1809
|
/** Carrier errors. */
|
|
1826
|
-
carrierErrors?:
|
|
1810
|
+
carrierErrors?: V2CarrierErrors;
|
|
1827
1811
|
/** Tax calculation error. */
|
|
1828
1812
|
taxCalculationError?: Details;
|
|
1829
1813
|
/** Coupon calculation error. */
|
|
@@ -1844,11 +1828,11 @@ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOne
|
|
|
1844
1828
|
discountsCalculationError?: Details;
|
|
1845
1829
|
}
|
|
1846
1830
|
/** @oneof */
|
|
1847
|
-
interface
|
|
1831
|
+
interface V2CalculationErrorsShippingCalculationErrorOneOf {
|
|
1848
1832
|
/** General shipping calculation error. */
|
|
1849
1833
|
generalShippingCalculationError?: Details;
|
|
1850
1834
|
/** Carrier errors. */
|
|
1851
|
-
carrierErrors?:
|
|
1835
|
+
carrierErrors?: V2CarrierErrors;
|
|
1852
1836
|
}
|
|
1853
1837
|
interface Details extends DetailsKindOneOf {
|
|
1854
1838
|
applicationError?: ApplicationError;
|
|
@@ -1946,14 +1930,14 @@ interface SystemError {
|
|
|
1946
1930
|
/** Error code. */
|
|
1947
1931
|
errorCode?: string | null;
|
|
1948
1932
|
}
|
|
1949
|
-
interface
|
|
1933
|
+
interface V2CarrierErrors {
|
|
1950
1934
|
/**
|
|
1951
1935
|
* Carrier errors.
|
|
1952
1936
|
* @maxSize 100
|
|
1953
1937
|
*/
|
|
1954
|
-
errors?:
|
|
1938
|
+
errors?: V2CarrierError[];
|
|
1955
1939
|
}
|
|
1956
|
-
interface
|
|
1940
|
+
interface V2CarrierError {
|
|
1957
1941
|
/**
|
|
1958
1942
|
* Carrier ID.
|
|
1959
1943
|
* @format GUID
|
|
@@ -2078,7 +2062,7 @@ interface CatalogItemInput {
|
|
|
2078
2062
|
*/
|
|
2079
2063
|
quantity?: number;
|
|
2080
2064
|
/** Selected membership to be used as payment for this item. */
|
|
2081
|
-
selectedMembership?:
|
|
2065
|
+
selectedMembership?: V2SelectedMembership;
|
|
2082
2066
|
/**
|
|
2083
2067
|
* Overriding values for catalog item properties.
|
|
2084
2068
|
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
@@ -2390,7 +2374,7 @@ interface SelectedMembershipUpdate {
|
|
|
2390
2374
|
*
|
|
2391
2375
|
* To just remove current selected membership, and not replace with a new one, pass an empty value here.
|
|
2392
2376
|
*/
|
|
2393
|
-
newMembership?:
|
|
2377
|
+
newMembership?: V2SelectedMembership;
|
|
2394
2378
|
}
|
|
2395
2379
|
interface UpdateLineItemsInCurrentCartResponse {
|
|
2396
2380
|
/** Updated Cart. */
|
|
@@ -2646,6 +2630,34 @@ interface GetCartResponse {
|
|
|
2646
2630
|
/** The requested Cart. */
|
|
2647
2631
|
cart?: Cart;
|
|
2648
2632
|
}
|
|
2633
|
+
/** temp for client testing */
|
|
2634
|
+
interface DummyErrorDataMethodLevel {
|
|
2635
|
+
/** This is a dummy field. */
|
|
2636
|
+
invalidItems?: LineItemIdentifier[];
|
|
2637
|
+
/** The fresh cart after resolving the error. */
|
|
2638
|
+
freshCart?: Cart;
|
|
2639
|
+
/** dummy string */
|
|
2640
|
+
dummyMethod?: string;
|
|
2641
|
+
}
|
|
2642
|
+
interface LineItemIdentifier extends LineItemIdentifierIdOneOf {
|
|
2643
|
+
/**
|
|
2644
|
+
* Line Item ID.
|
|
2645
|
+
* @format GUID
|
|
2646
|
+
*/
|
|
2647
|
+
lineItemId?: string;
|
|
2648
|
+
/** Catalog reference. */
|
|
2649
|
+
catalogReference?: CatalogReference;
|
|
2650
|
+
}
|
|
2651
|
+
/** @oneof */
|
|
2652
|
+
interface LineItemIdentifierIdOneOf {
|
|
2653
|
+
/**
|
|
2654
|
+
* Line Item ID.
|
|
2655
|
+
* @format GUID
|
|
2656
|
+
*/
|
|
2657
|
+
lineItemId?: string;
|
|
2658
|
+
/** Catalog reference. */
|
|
2659
|
+
catalogReference?: CatalogReference;
|
|
2660
|
+
}
|
|
2649
2661
|
interface UpdateCartRequest {
|
|
2650
2662
|
/** Cart to be updated, may be partial. */
|
|
2651
2663
|
cart: Cart;
|
|
@@ -2703,189 +2715,1093 @@ interface CalculateCartResponse {
|
|
|
2703
2715
|
/** The calculation summary. */
|
|
2704
2716
|
summary?: CartSummary;
|
|
2705
2717
|
}
|
|
2706
|
-
interface
|
|
2718
|
+
interface CalculateCartWithFullResponseResponse {
|
|
2719
|
+
/** The Cart that was calculated. */
|
|
2720
|
+
cart?: Cart;
|
|
2721
|
+
/** The calculation summary. */
|
|
2722
|
+
summary?: CartSummary;
|
|
2707
2723
|
/**
|
|
2708
|
-
*
|
|
2709
|
-
*
|
|
2724
|
+
* Totals payload used for backward compatibility with legacy clients.
|
|
2725
|
+
* Used by the Cart and Checkout proxies.
|
|
2710
2726
|
*/
|
|
2711
|
-
|
|
2727
|
+
totalsResponse?: CalculateTotalsResponse;
|
|
2728
|
+
}
|
|
2729
|
+
interface CalculateTotalsResponse {
|
|
2730
|
+
/** Calculate line items. */
|
|
2731
|
+
calculatedLineItems?: CalculatedLineItem[];
|
|
2732
|
+
/** Price summary. */
|
|
2733
|
+
priceSummary?: PriceSummary;
|
|
2734
|
+
/** Details of applied gift card. */
|
|
2735
|
+
giftCard?: GiftCard;
|
|
2736
|
+
/** Tax summary. */
|
|
2737
|
+
taxSummary?: TaxSummary;
|
|
2738
|
+
/** Shipping information. */
|
|
2739
|
+
shippingInfo?: ShippingInformation;
|
|
2712
2740
|
/**
|
|
2713
|
-
*
|
|
2741
|
+
* Applied discounts.
|
|
2742
|
+
* @maxSize 320
|
|
2743
|
+
*/
|
|
2744
|
+
appliedDiscounts?: AppliedDiscount[];
|
|
2745
|
+
/** Calculation errors. */
|
|
2746
|
+
calculationErrors?: CalculationErrors;
|
|
2747
|
+
/** Weight unit. */
|
|
2748
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
2749
|
+
/**
|
|
2750
|
+
* Currency.
|
|
2714
2751
|
* @format CURRENCY
|
|
2715
2752
|
*/
|
|
2716
|
-
|
|
2717
|
-
}
|
|
2718
|
-
interface GetCheckoutURLResponse {
|
|
2753
|
+
currency?: string;
|
|
2719
2754
|
/**
|
|
2720
|
-
*
|
|
2721
|
-
* @
|
|
2755
|
+
* This is the display currency. Converted prices are presented in this currency.
|
|
2756
|
+
* @readonly
|
|
2757
|
+
* @format CURRENCY
|
|
2722
2758
|
*/
|
|
2723
|
-
|
|
2724
|
-
|
|
2725
|
-
|
|
2759
|
+
conversionCurrency?: string;
|
|
2760
|
+
/** Whether tax is included in price. */
|
|
2761
|
+
taxIncludedInPrice?: boolean;
|
|
2726
2762
|
/**
|
|
2727
|
-
*
|
|
2728
|
-
* @
|
|
2763
|
+
* Minimal amount to pay in order to place the order.
|
|
2764
|
+
* @readonly
|
|
2729
2765
|
*/
|
|
2730
|
-
|
|
2766
|
+
payNow?: PriceSummary;
|
|
2731
2767
|
/**
|
|
2732
|
-
*
|
|
2733
|
-
*
|
|
2734
|
-
* @maxLength 3000
|
|
2768
|
+
* Remaining amount for the order to be fully paid.
|
|
2769
|
+
* @readonly
|
|
2735
2770
|
*/
|
|
2736
|
-
|
|
2771
|
+
payLater?: PriceSummary;
|
|
2772
|
+
/** Information about valid and invalid memberships, and which ones are selected for usage. */
|
|
2773
|
+
membershipOptions?: MembershipOptions;
|
|
2737
2774
|
/**
|
|
2738
|
-
*
|
|
2739
|
-
* @
|
|
2775
|
+
* Additional Fees
|
|
2776
|
+
* @maxSize 100
|
|
2740
2777
|
*/
|
|
2741
|
-
|
|
2742
|
-
/** Urls to redirect to after payment is made. */
|
|
2743
|
-
redirectUrls?: RedirectUrls;
|
|
2744
|
-
/** Indicates the payment method should be saved on the order */
|
|
2745
|
-
savePaymentMethod?: boolean;
|
|
2746
|
-
/** Indicates whether to authorize the payment and delay the capture */
|
|
2747
|
-
delayCapture?: boolean;
|
|
2748
|
-
}
|
|
2749
|
-
interface RedirectUrls {
|
|
2778
|
+
additionalFees?: AdditionalFee[];
|
|
2750
2779
|
/**
|
|
2751
|
-
*
|
|
2752
|
-
* @
|
|
2780
|
+
* The site currency.
|
|
2781
|
+
* @readonly
|
|
2782
|
+
* @format CURRENCY
|
|
2753
2783
|
*/
|
|
2754
|
-
|
|
2784
|
+
siteCurrency?: string;
|
|
2755
2785
|
/**
|
|
2756
|
-
*
|
|
2757
|
-
* @
|
|
2786
|
+
* The rate used when converting from the site currency to the checkout currency.
|
|
2787
|
+
* @readonly
|
|
2788
|
+
* @decimalValue options { gt:0, lte:1000000000000000 }
|
|
2758
2789
|
*/
|
|
2759
|
-
|
|
2790
|
+
checkoutConversionRate?: string | null;
|
|
2760
2791
|
/**
|
|
2761
|
-
*
|
|
2762
|
-
* @
|
|
2792
|
+
* The pay now total amount after the gift card is applied.
|
|
2793
|
+
* @readonly
|
|
2763
2794
|
*/
|
|
2764
|
-
|
|
2795
|
+
payNowTotalAfterGiftCard?: MultiCurrencyPrice;
|
|
2765
2796
|
/**
|
|
2766
|
-
*
|
|
2767
|
-
* @
|
|
2797
|
+
* The total amount after gift card is applied.
|
|
2798
|
+
* @readonly
|
|
2768
2799
|
*/
|
|
2769
|
-
|
|
2800
|
+
totalAfterGiftCard?: MultiCurrencyPrice;
|
|
2801
|
+
/**
|
|
2802
|
+
* Payment for subscriptions after free trial period.
|
|
2803
|
+
* @readonly
|
|
2804
|
+
*/
|
|
2805
|
+
payAfterFreeTrial?: PriceSummary;
|
|
2770
2806
|
}
|
|
2771
|
-
interface
|
|
2807
|
+
interface CalculatedLineItem {
|
|
2808
|
+
/** Line item ID. */
|
|
2809
|
+
lineItemId?: string;
|
|
2810
|
+
/** Price breakdown for this line item. */
|
|
2811
|
+
pricesBreakdown?: LineItemPricesData;
|
|
2772
2812
|
/**
|
|
2773
|
-
*
|
|
2774
|
-
*
|
|
2813
|
+
* Type of selected payment option for current item. Supported values:
|
|
2814
|
+
* + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item will happen as part of the checkout
|
|
2815
|
+
* + `"FULL_PAYMENT_OFFLINE"` - The entire payment for this item will happen after the checkout
|
|
2816
|
+
* + `"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
|
|
2817
|
+
* + `"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.
|
|
2775
2818
|
*/
|
|
2776
|
-
|
|
2819
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
2820
|
+
/** tax calculation address. */
|
|
2821
|
+
taxableAddress?: TaxableAddress;
|
|
2822
|
+
}
|
|
2823
|
+
interface LineItemPricesData {
|
|
2824
|
+
/** Total price after discounts, tax, and modifiers. */
|
|
2825
|
+
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
2826
|
+
/** Total price after discounts and modifiers, and before tax. */
|
|
2827
|
+
totalPriceBeforeTax?: MultiCurrencyPrice;
|
|
2828
|
+
/** Tax details. */
|
|
2829
|
+
taxDetails?: ItemTaxFullDetails;
|
|
2830
|
+
/** Total discount applied for the line item. */
|
|
2831
|
+
totalDiscount?: MultiCurrencyPrice;
|
|
2832
|
+
/** Catalog price after catalog-defined discount, automatic discounts, and modifiers. */
|
|
2833
|
+
price?: MultiCurrencyPrice;
|
|
2834
|
+
/**
|
|
2835
|
+
* Item price before automatic discounts, coupons, and global discounts; after catalog-defined discounts and modifiers.
|
|
2836
|
+
* Defaults to `price` when not provided.
|
|
2837
|
+
*/
|
|
2838
|
+
priceBeforeDiscounts?: MultiCurrencyPrice;
|
|
2839
|
+
/** Total line item price after catalog-defined discounts, automatic discounts, and modifiers. */
|
|
2840
|
+
lineItemPrice?: MultiCurrencyPrice;
|
|
2777
2841
|
/**
|
|
2778
|
-
*
|
|
2779
|
-
*
|
|
2842
|
+
* Item price before all discounts and modifiers.
|
|
2843
|
+
* Defaults to `price` when not provided.
|
|
2780
2844
|
*/
|
|
2781
|
-
|
|
2845
|
+
fullPrice?: MultiCurrencyPrice;
|
|
2782
2846
|
/**
|
|
2783
|
-
*
|
|
2784
|
-
*
|
|
2785
|
-
* In some cases, money will not be charged:
|
|
2786
|
-
* If the total price is 0 - For example, could be a free item or a an item with 100% discount
|
|
2787
|
-
* If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
|
|
2788
|
-
* @maxLength 50
|
|
2847
|
+
* Partial payment to be paid upfront during the checkout.
|
|
2848
|
+
* Applies to catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
2789
2849
|
*/
|
|
2790
|
-
|
|
2791
|
-
/** Whether an order was successfully created from this cart and the payment transaction was completed. */
|
|
2792
|
-
completed?: boolean;
|
|
2850
|
+
depositAmount?: MultiCurrencyPrice;
|
|
2793
2851
|
}
|
|
2794
|
-
interface
|
|
2852
|
+
interface MultiCurrencyPrice {
|
|
2795
2853
|
/**
|
|
2796
|
-
*
|
|
2797
|
-
* @
|
|
2854
|
+
* Amount.
|
|
2855
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
2798
2856
|
*/
|
|
2799
|
-
|
|
2857
|
+
amount?: string;
|
|
2800
2858
|
/**
|
|
2801
|
-
*
|
|
2802
|
-
* @
|
|
2859
|
+
* Converted amount.
|
|
2860
|
+
* @readonly
|
|
2861
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
2803
2862
|
*/
|
|
2804
|
-
|
|
2863
|
+
convertedAmount?: string;
|
|
2805
2864
|
/**
|
|
2806
|
-
*
|
|
2807
|
-
* @
|
|
2865
|
+
* Amount formatted with currency symbol.
|
|
2866
|
+
* @readonly
|
|
2808
2867
|
*/
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
|
|
2868
|
+
formattedAmount?: string;
|
|
2869
|
+
/**
|
|
2870
|
+
* Converted amount formatted with currency symbol.
|
|
2871
|
+
* @readonly
|
|
2872
|
+
*/
|
|
2873
|
+
formattedConvertedAmount?: string;
|
|
2814
2874
|
}
|
|
2815
|
-
interface
|
|
2875
|
+
interface ItemTaxFullDetails {
|
|
2876
|
+
/** Amount for which tax is calculated. */
|
|
2877
|
+
taxableAmount?: MultiCurrencyPrice;
|
|
2816
2878
|
/**
|
|
2817
|
-
*
|
|
2818
|
-
* @
|
|
2879
|
+
* Tax rate %, as a decimal point between 0 and 1.
|
|
2880
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
2819
2881
|
*/
|
|
2820
|
-
|
|
2882
|
+
taxRate?: string;
|
|
2883
|
+
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
2884
|
+
totalTax?: MultiCurrencyPrice;
|
|
2821
2885
|
/**
|
|
2822
|
-
*
|
|
2823
|
-
* @
|
|
2824
|
-
* @
|
|
2825
|
-
* @maxSize 100
|
|
2886
|
+
* If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.
|
|
2887
|
+
* @readonly
|
|
2888
|
+
* @deprecated
|
|
2826
2889
|
*/
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2890
|
+
rateBreakdown?: TaxRateBreakdown[];
|
|
2891
|
+
/**
|
|
2892
|
+
* tax information for a line item.
|
|
2893
|
+
* @maxSize 1000
|
|
2894
|
+
* @readonly
|
|
2895
|
+
*/
|
|
2896
|
+
taxBreakdown?: TaxBreakdown[];
|
|
2832
2897
|
}
|
|
2833
|
-
interface
|
|
2898
|
+
interface TaxRateBreakdown {
|
|
2834
2899
|
/**
|
|
2835
|
-
*
|
|
2836
|
-
* @
|
|
2900
|
+
* Name of tax against which the calculation was performed.
|
|
2901
|
+
* @maxLength 100
|
|
2837
2902
|
*/
|
|
2838
|
-
|
|
2903
|
+
name?: string;
|
|
2839
2904
|
/**
|
|
2840
|
-
*
|
|
2841
|
-
* @
|
|
2842
|
-
* @maxSize 300
|
|
2905
|
+
* Rate at which this tax detail was calculated.
|
|
2906
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
2843
2907
|
*/
|
|
2844
|
-
|
|
2908
|
+
rate?: string;
|
|
2909
|
+
/** Amount of tax for this tax detail. */
|
|
2910
|
+
tax?: MultiCurrencyPrice;
|
|
2845
2911
|
}
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
|
|
2850
|
-
interface
|
|
2912
|
+
/**
|
|
2913
|
+
* TaxBreakdown represents tax information for a line item.
|
|
2914
|
+
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
2915
|
+
*/
|
|
2916
|
+
interface TaxBreakdown {
|
|
2851
2917
|
/**
|
|
2852
|
-
*
|
|
2853
|
-
* @
|
|
2918
|
+
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
2919
|
+
* @maxLength 200
|
|
2854
2920
|
*/
|
|
2855
|
-
|
|
2921
|
+
jurisdiction?: string | null;
|
|
2922
|
+
/** The amount of this line item price that was considered nontaxable. (Decimal value) */
|
|
2923
|
+
nonTaxableAmount?: MultiCurrencyPrice;
|
|
2856
2924
|
/**
|
|
2857
|
-
*
|
|
2858
|
-
*
|
|
2859
|
-
* Currently only one is supported.
|
|
2860
|
-
* @minLength 1
|
|
2861
|
-
* @maxLength 50
|
|
2925
|
+
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
|
|
2926
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
2862
2927
|
*/
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2866
|
-
/**
|
|
2867
|
-
|
|
2868
|
-
}
|
|
2869
|
-
interface RemoveCouponRequest {
|
|
2928
|
+
rate?: string | null;
|
|
2929
|
+
/** The amount of tax estimated for this line item. (Decimal value) */
|
|
2930
|
+
taxAmount?: MultiCurrencyPrice;
|
|
2931
|
+
/** The taxable amount of this line item. */
|
|
2932
|
+
taxableAmount?: MultiCurrencyPrice;
|
|
2870
2933
|
/**
|
|
2871
|
-
*
|
|
2872
|
-
* @
|
|
2934
|
+
* The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
|
|
2935
|
+
* @maxLength 200
|
|
2873
2936
|
*/
|
|
2874
|
-
|
|
2937
|
+
taxType?: string | null;
|
|
2875
2938
|
/**
|
|
2876
|
-
*
|
|
2877
|
-
*
|
|
2939
|
+
* The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
|
|
2940
|
+
* This name should be explicit enough to allow the merchant to understand what tax was calculated.
|
|
2941
|
+
* @maxLength 200
|
|
2878
2942
|
*/
|
|
2879
|
-
|
|
2943
|
+
taxName?: string | null;
|
|
2944
|
+
/** The type of the jurisdiction in which this tax detail applies. */
|
|
2945
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
2880
2946
|
}
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2947
|
+
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
2948
|
+
declare enum JurisdictionType {
|
|
2949
|
+
UNDEFINED = "UNDEFINED",
|
|
2950
|
+
COUNTRY = "COUNTRY",
|
|
2951
|
+
STATE = "STATE",
|
|
2952
|
+
COUNTY = "COUNTY",
|
|
2953
|
+
CITY = "CITY",
|
|
2954
|
+
SPECIAL = "SPECIAL"
|
|
2884
2955
|
}
|
|
2885
|
-
|
|
2956
|
+
/** @enumType */
|
|
2957
|
+
type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
2958
|
+
interface CalculatedItemModifier {
|
|
2886
2959
|
/**
|
|
2887
|
-
*
|
|
2888
|
-
* @
|
|
2960
|
+
* Modifier ID.
|
|
2961
|
+
* @minLength 1
|
|
2962
|
+
* @maxLength 36
|
|
2963
|
+
*/
|
|
2964
|
+
id?: string;
|
|
2965
|
+
/**
|
|
2966
|
+
* ID of the group this modifier belongs to.
|
|
2967
|
+
* @minLength 1
|
|
2968
|
+
* @maxLength 36
|
|
2969
|
+
*/
|
|
2970
|
+
groupId?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
* Modifier price.
|
|
2973
|
+
* @readonly
|
|
2974
|
+
*/
|
|
2975
|
+
price?: MultiCurrencyPrice;
|
|
2976
|
+
}
|
|
2977
|
+
interface PriceSummary {
|
|
2978
|
+
/** Subtotal of all line items, before discounts and before tax. */
|
|
2979
|
+
subtotal?: MultiCurrencyPrice;
|
|
2980
|
+
/** Total shipping price, before discounts and before tax. */
|
|
2981
|
+
shipping?: MultiCurrencyPrice;
|
|
2982
|
+
/** Total tax. */
|
|
2983
|
+
tax?: MultiCurrencyPrice;
|
|
2984
|
+
/** Total calculated discount value. */
|
|
2985
|
+
discount?: MultiCurrencyPrice;
|
|
2986
|
+
/** Total price after discounts, gift cards, and tax. */
|
|
2987
|
+
total?: MultiCurrencyPrice;
|
|
2988
|
+
/** Total additional fees price before tax. */
|
|
2989
|
+
additionalFees?: MultiCurrencyPrice;
|
|
2990
|
+
}
|
|
2991
|
+
interface GiftCard {
|
|
2992
|
+
/**
|
|
2993
|
+
* Gift Card ID.
|
|
2994
|
+
* @deprecated
|
|
2995
|
+
*/
|
|
2996
|
+
id?: string;
|
|
2997
|
+
/** Gift card obfuscated code. */
|
|
2998
|
+
obfuscatedCode?: string;
|
|
2999
|
+
/** Actual amount to be redeemed from the gift card. */
|
|
3000
|
+
amount?: MultiCurrencyPrice;
|
|
3001
|
+
/**
|
|
3002
|
+
* App ID of the gift card provider.
|
|
3003
|
+
* @format GUID
|
|
3004
|
+
*/
|
|
3005
|
+
appId?: string;
|
|
3006
|
+
/**
|
|
3007
|
+
* External ID in the gift card provider's system.
|
|
3008
|
+
* Used for integration and tracking across different platforms.
|
|
3009
|
+
* @minLength 1
|
|
3010
|
+
* @maxLength 50
|
|
3011
|
+
*/
|
|
3012
|
+
externalId?: string | null;
|
|
3013
|
+
/** Requested amount to redeem from the gift card. */
|
|
3014
|
+
requestedAmount?: MultiCurrencyPrice;
|
|
3015
|
+
}
|
|
3016
|
+
interface TaxSummary {
|
|
3017
|
+
/**
|
|
3018
|
+
* Amount for which tax is calculated, added from line items.
|
|
3019
|
+
* @readonly
|
|
3020
|
+
*/
|
|
3021
|
+
taxableAmount?: MultiCurrencyPrice;
|
|
3022
|
+
/**
|
|
3023
|
+
* Calculated tax, added from line items.
|
|
3024
|
+
* @readonly
|
|
3025
|
+
*/
|
|
3026
|
+
totalTax?: MultiCurrencyPrice;
|
|
3027
|
+
/**
|
|
3028
|
+
* Tax calculator that was active when the order was created.
|
|
3029
|
+
* @deprecated
|
|
3030
|
+
*/
|
|
3031
|
+
calculationDetails?: TaxCalculationDetails;
|
|
3032
|
+
}
|
|
3033
|
+
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
3034
|
+
/** Reason the manual calculation was used. */
|
|
3035
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
3036
|
+
/** Details of the fallback rate calculation. */
|
|
3037
|
+
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
3038
|
+
/** Rate calculation type. */
|
|
3039
|
+
rateType?: RateTypeWithLiterals;
|
|
3040
|
+
}
|
|
3041
|
+
/** @oneof */
|
|
3042
|
+
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
3043
|
+
/** Reason the manual calculation was used. */
|
|
3044
|
+
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
3045
|
+
/** Details of the fallback rate calculation. */
|
|
3046
|
+
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
3047
|
+
}
|
|
3048
|
+
declare enum RateType {
|
|
3049
|
+
/** no tax being collected for this request due to location of purchase */
|
|
3050
|
+
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
3051
|
+
/** manual rate used for calculation */
|
|
3052
|
+
MANUAL_RATE = "MANUAL_RATE",
|
|
3053
|
+
/** autotax rate used for calculation */
|
|
3054
|
+
AUTO_RATE = "AUTO_RATE",
|
|
3055
|
+
/** fallback rate used for calculation */
|
|
3056
|
+
FALLBACK_RATE = "FALLBACK_RATE"
|
|
3057
|
+
}
|
|
3058
|
+
/** @enumType */
|
|
3059
|
+
type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
|
|
3060
|
+
declare enum ManualCalculationReason {
|
|
3061
|
+
/** user set calculator in Business Manager to be Manual */
|
|
3062
|
+
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
3063
|
+
/** specific region is on manual even though Global setting is Auto-tax */
|
|
3064
|
+
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
3065
|
+
}
|
|
3066
|
+
/** @enumType */
|
|
3067
|
+
type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
|
|
3068
|
+
interface AutoTaxFallbackCalculationDetails {
|
|
3069
|
+
/** reason for fallback */
|
|
3070
|
+
fallbackReason?: FallbackReasonWithLiterals;
|
|
3071
|
+
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
3072
|
+
error?: ApplicationError;
|
|
3073
|
+
}
|
|
3074
|
+
declare enum FallbackReason {
|
|
3075
|
+
/** auto-tax failed to be calculated */
|
|
3076
|
+
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
3077
|
+
/** auto-tax was temporarily deactivated on a system-level */
|
|
3078
|
+
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
3079
|
+
}
|
|
3080
|
+
/** @enumType */
|
|
3081
|
+
type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
|
|
3082
|
+
/**
|
|
3083
|
+
* 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.
|
|
3084
|
+
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
3085
|
+
*/
|
|
3086
|
+
interface AggregatedTaxBreakdown {
|
|
3087
|
+
/**
|
|
3088
|
+
* The name of the tax against which this tax amount was calculated.
|
|
3089
|
+
* @maxLength 200
|
|
3090
|
+
*/
|
|
3091
|
+
taxName?: string;
|
|
3092
|
+
/**
|
|
3093
|
+
* The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
|
|
3094
|
+
* @maxLength 200
|
|
3095
|
+
*/
|
|
3096
|
+
taxType?: string;
|
|
3097
|
+
/**
|
|
3098
|
+
* The name of the jurisdiction in which this tax detail applies.
|
|
3099
|
+
* @maxLength 200
|
|
3100
|
+
*/
|
|
3101
|
+
jurisdiction?: string;
|
|
3102
|
+
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
3103
|
+
jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
|
|
3104
|
+
/**
|
|
3105
|
+
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
|
|
3106
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
3107
|
+
*/
|
|
3108
|
+
rate?: string;
|
|
3109
|
+
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
3110
|
+
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
3111
|
+
/** The sum of all the taxable amount from line items for tax identifiers. */
|
|
3112
|
+
aggregatedTaxableAmount?: MultiCurrencyPrice;
|
|
3113
|
+
}
|
|
3114
|
+
interface ShippingInformation {
|
|
3115
|
+
/** Shipping region. */
|
|
3116
|
+
region?: ShippingRegion;
|
|
3117
|
+
/** Selected shipping option. */
|
|
3118
|
+
selectedCarrierServiceOption?: SelectedCarrierServiceOption;
|
|
3119
|
+
/** All shipping options. */
|
|
3120
|
+
carrierServiceOptions?: CarrierServiceOption[];
|
|
3121
|
+
}
|
|
3122
|
+
interface ShippingRegion {
|
|
3123
|
+
/**
|
|
3124
|
+
* Shipping region ID.
|
|
3125
|
+
* @format GUID
|
|
3126
|
+
* @readonly
|
|
3127
|
+
*/
|
|
3128
|
+
id?: string;
|
|
3129
|
+
/**
|
|
3130
|
+
* Shipping region name.
|
|
3131
|
+
* @maxLength 100
|
|
3132
|
+
*/
|
|
3133
|
+
name?: string;
|
|
3134
|
+
}
|
|
3135
|
+
interface SelectedCarrierServiceOption {
|
|
3136
|
+
/**
|
|
3137
|
+
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
3138
|
+
* @maxLength 100
|
|
3139
|
+
*/
|
|
3140
|
+
code?: string;
|
|
3141
|
+
/**
|
|
3142
|
+
* Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
|
|
3143
|
+
* For example, "Standard" or "First-Class Package International".
|
|
3144
|
+
* @maxLength 250
|
|
3145
|
+
* @readonly
|
|
3146
|
+
*/
|
|
3147
|
+
title?: string;
|
|
3148
|
+
/**
|
|
3149
|
+
* Delivery logistics.
|
|
3150
|
+
* @readonly
|
|
3151
|
+
*/
|
|
3152
|
+
logistics?: DeliveryLogistics;
|
|
3153
|
+
/**
|
|
3154
|
+
* Shipping costs.
|
|
3155
|
+
* @readonly
|
|
3156
|
+
*/
|
|
3157
|
+
cost?: SelectedCarrierServiceOptionPrices;
|
|
3158
|
+
/**
|
|
3159
|
+
* Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
|
|
3160
|
+
* @readonly
|
|
3161
|
+
*/
|
|
3162
|
+
requestedShippingOption?: boolean;
|
|
3163
|
+
/**
|
|
3164
|
+
* Other charges
|
|
3165
|
+
* @deprecated Other charges
|
|
3166
|
+
* @replacedBy additional_fees
|
|
3167
|
+
* @targetRemovalDate 2025-10-01
|
|
3168
|
+
*/
|
|
3169
|
+
otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
|
|
3170
|
+
/**
|
|
3171
|
+
* This carrier's unique ID
|
|
3172
|
+
* @format GUID
|
|
3173
|
+
*/
|
|
3174
|
+
carrierId?: string | null;
|
|
3175
|
+
/**
|
|
3176
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
3177
|
+
* @maxSize 300
|
|
3178
|
+
*/
|
|
3179
|
+
deliveryAllocations?: DeliveryAllocation[];
|
|
3180
|
+
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
3181
|
+
partial?: boolean | null;
|
|
3182
|
+
}
|
|
3183
|
+
interface DeliveryLogistics {
|
|
3184
|
+
/**
|
|
3185
|
+
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
3186
|
+
* @maxLength 500
|
|
3187
|
+
*/
|
|
3188
|
+
deliveryTime?: string | null;
|
|
3189
|
+
/**
|
|
3190
|
+
* Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
|
|
3191
|
+
* @maxLength 1000
|
|
3192
|
+
*/
|
|
3193
|
+
instructions?: string | null;
|
|
3194
|
+
/** Pickup details. */
|
|
3195
|
+
pickupDetails?: PickupDetails;
|
|
3196
|
+
}
|
|
3197
|
+
interface PickupDetails {
|
|
3198
|
+
/** Pickup address. */
|
|
3199
|
+
address?: Address;
|
|
3200
|
+
/**
|
|
3201
|
+
* Whether the pickup address is that of a business - this may effect tax calculation.
|
|
3202
|
+
* @deprecated
|
|
3203
|
+
*/
|
|
3204
|
+
businessLocation?: boolean;
|
|
3205
|
+
/** Pickup method */
|
|
3206
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
3207
|
+
}
|
|
3208
|
+
declare enum PickupMethod {
|
|
3209
|
+
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
3210
|
+
STORE_PICKUP = "STORE_PICKUP",
|
|
3211
|
+
PICKUP_POINT = "PICKUP_POINT"
|
|
3212
|
+
}
|
|
3213
|
+
/** @enumType */
|
|
3214
|
+
type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
3215
|
+
interface DeliveryTimeSlot {
|
|
3216
|
+
/** starting time of the delivery time slot */
|
|
3217
|
+
from?: Date | null;
|
|
3218
|
+
/** ending time of the delivery time slot */
|
|
3219
|
+
to?: Date | null;
|
|
3220
|
+
}
|
|
3221
|
+
interface SelectedCarrierServiceOptionPrices {
|
|
3222
|
+
/** Total shipping price, after discount and after tax. */
|
|
3223
|
+
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
3224
|
+
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
3225
|
+
totalPriceBeforeTax?: MultiCurrencyPrice;
|
|
3226
|
+
/** Tax details. */
|
|
3227
|
+
taxDetails?: ItemTaxFullDetails;
|
|
3228
|
+
/** Shipping discount before tax. */
|
|
3229
|
+
totalDiscount?: MultiCurrencyPrice;
|
|
3230
|
+
/** Shipping price before discount and before tax. */
|
|
3231
|
+
price?: MultiCurrencyPrice;
|
|
3232
|
+
}
|
|
3233
|
+
interface SelectedCarrierServiceOptionOtherCharge {
|
|
3234
|
+
/** Type of additional cost. */
|
|
3235
|
+
type?: ChargeTypeWithLiterals;
|
|
3236
|
+
/**
|
|
3237
|
+
* Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
|
|
3238
|
+
* @maxLength 200
|
|
3239
|
+
*/
|
|
3240
|
+
details?: string | null;
|
|
3241
|
+
/** Price of added charge. */
|
|
3242
|
+
cost?: SelectedCarrierServiceOptionPrices;
|
|
3243
|
+
}
|
|
3244
|
+
declare enum ChargeType {
|
|
3245
|
+
HANDLING_FEE = "HANDLING_FEE",
|
|
3246
|
+
INSURANCE = "INSURANCE"
|
|
3247
|
+
}
|
|
3248
|
+
/** @enumType */
|
|
3249
|
+
type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
|
|
3250
|
+
interface DeliveryAllocation {
|
|
3251
|
+
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
3252
|
+
deliveryCarrier?: Carrier;
|
|
3253
|
+
/** The delivery region that are relevant for this delivery solution. */
|
|
3254
|
+
deliveryRegion?: Region;
|
|
3255
|
+
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
3256
|
+
applicableLineItems?: ApplicableLineItems;
|
|
3257
|
+
}
|
|
3258
|
+
interface Carrier {
|
|
3259
|
+
/**
|
|
3260
|
+
* The carrier app id
|
|
3261
|
+
* @format GUID
|
|
3262
|
+
*/
|
|
3263
|
+
appId?: string | null;
|
|
3264
|
+
/**
|
|
3265
|
+
* Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
|
|
3266
|
+
* @maxLength 250
|
|
3267
|
+
*/
|
|
3268
|
+
code?: string;
|
|
3269
|
+
}
|
|
3270
|
+
interface Region {
|
|
3271
|
+
/**
|
|
3272
|
+
* The delivery region id.
|
|
3273
|
+
* @format GUID
|
|
3274
|
+
*/
|
|
3275
|
+
id?: string | null;
|
|
3276
|
+
/**
|
|
3277
|
+
* The delivery region name.
|
|
3278
|
+
* @maxLength 100
|
|
3279
|
+
*/
|
|
3280
|
+
name?: string | null;
|
|
3281
|
+
}
|
|
3282
|
+
interface ApplicableLineItems {
|
|
3283
|
+
/**
|
|
3284
|
+
* Line items that the delivery solution is for.
|
|
3285
|
+
* @maxSize 300
|
|
3286
|
+
* @minLength 1
|
|
3287
|
+
* @maxLength 100
|
|
3288
|
+
*/
|
|
3289
|
+
lineItemIds?: string[];
|
|
3290
|
+
}
|
|
3291
|
+
interface CarrierServiceOption {
|
|
3292
|
+
/**
|
|
3293
|
+
* Carrier ID.
|
|
3294
|
+
* @format GUID
|
|
3295
|
+
*/
|
|
3296
|
+
carrierId?: string;
|
|
3297
|
+
/** Shipping options offered by this carrier for this request. */
|
|
3298
|
+
shippingOptions?: ShippingOption[];
|
|
3299
|
+
}
|
|
3300
|
+
interface ShippingOption {
|
|
3301
|
+
/**
|
|
3302
|
+
* Unique code of provided shipping option like "usps_std_overnight".
|
|
3303
|
+
* For legacy calculators this would be the UUID of the option.
|
|
3304
|
+
* @maxLength 100
|
|
3305
|
+
*/
|
|
3306
|
+
code?: string;
|
|
3307
|
+
/**
|
|
3308
|
+
* Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
|
|
3309
|
+
* For example, "Standard" or "First-Class Package International".
|
|
3310
|
+
* @maxLength 250
|
|
3311
|
+
*/
|
|
3312
|
+
title?: string;
|
|
3313
|
+
/** Delivery logistics. */
|
|
3314
|
+
logistics?: DeliveryLogistics;
|
|
3315
|
+
/** Sipping price information. */
|
|
3316
|
+
cost?: ShippingPrice;
|
|
3317
|
+
/**
|
|
3318
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
3319
|
+
* @maxSize 300
|
|
3320
|
+
*/
|
|
3321
|
+
deliveryAllocations?: DeliveryAllocation[];
|
|
3322
|
+
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
3323
|
+
partial?: boolean | null;
|
|
3324
|
+
}
|
|
3325
|
+
interface ShippingPrice {
|
|
3326
|
+
/** Shipping price. */
|
|
3327
|
+
price?: MultiCurrencyPrice;
|
|
3328
|
+
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
3329
|
+
otherCharges?: OtherCharge[];
|
|
3330
|
+
}
|
|
3331
|
+
interface OtherCharge {
|
|
3332
|
+
/** Type of additional cost. */
|
|
3333
|
+
type?: ChargeTypeWithLiterals;
|
|
3334
|
+
/** Price of added cost. */
|
|
3335
|
+
price?: MultiCurrencyPrice;
|
|
3336
|
+
/**
|
|
3337
|
+
* Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
|
|
3338
|
+
* @maxLength 250
|
|
3339
|
+
*/
|
|
3340
|
+
details?: string | null;
|
|
3341
|
+
}
|
|
3342
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
3343
|
+
/** Coupon details. */
|
|
3344
|
+
coupon?: Coupon;
|
|
3345
|
+
/** Merchant discount. */
|
|
3346
|
+
merchantDiscount?: MerchantDiscount;
|
|
3347
|
+
/** Discount rule */
|
|
3348
|
+
discountRule?: DiscountRule;
|
|
3349
|
+
/** Discount type. */
|
|
3350
|
+
discountType?: DiscountTypeWithLiterals;
|
|
3351
|
+
/**
|
|
3352
|
+
* IDs of line items the discount applies to.
|
|
3353
|
+
* @format GUID
|
|
3354
|
+
* @deprecated IDs of line items the discount applies to.
|
|
3355
|
+
* @replacedBy line_items_discounts
|
|
3356
|
+
* @targetRemovalDate 2025-12-31
|
|
3357
|
+
*/
|
|
3358
|
+
lineItemIds?: string[];
|
|
3359
|
+
}
|
|
3360
|
+
/** @oneof */
|
|
3361
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
3362
|
+
/** Coupon details. */
|
|
3363
|
+
coupon?: Coupon;
|
|
3364
|
+
/** Merchant discount. */
|
|
3365
|
+
merchantDiscount?: MerchantDiscount;
|
|
3366
|
+
/** Discount rule */
|
|
3367
|
+
discountRule?: DiscountRule;
|
|
3368
|
+
}
|
|
3369
|
+
declare enum DiscountType {
|
|
3370
|
+
GLOBAL = "GLOBAL",
|
|
3371
|
+
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
3372
|
+
SHIPPING = "SHIPPING"
|
|
3373
|
+
}
|
|
3374
|
+
/** @enumType */
|
|
3375
|
+
type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
3376
|
+
/** Coupon */
|
|
3377
|
+
interface Coupon {
|
|
3378
|
+
/** Coupon ID. */
|
|
3379
|
+
id?: string;
|
|
3380
|
+
/** Coupon code. */
|
|
3381
|
+
code?: string;
|
|
3382
|
+
/** Coupon value. */
|
|
3383
|
+
amount?: MultiCurrencyPrice;
|
|
3384
|
+
/** Coupon name. */
|
|
3385
|
+
name?: string;
|
|
3386
|
+
}
|
|
3387
|
+
interface MerchantDiscount {
|
|
3388
|
+
/** Discount value. */
|
|
3389
|
+
amount?: MultiCurrencyPrice;
|
|
3390
|
+
/**
|
|
3391
|
+
* Discount Percentage. Will be calculated from items price before other discounts.
|
|
3392
|
+
* @min 1
|
|
3393
|
+
* @max 100
|
|
3394
|
+
*/
|
|
3395
|
+
percentage?: number | null;
|
|
3396
|
+
}
|
|
3397
|
+
interface DiscountRule {
|
|
3398
|
+
/**
|
|
3399
|
+
* Discount rule ID
|
|
3400
|
+
* @format GUID
|
|
3401
|
+
*/
|
|
3402
|
+
id?: string;
|
|
3403
|
+
/** Discount rule name */
|
|
3404
|
+
name?: DiscountRuleName;
|
|
3405
|
+
/** Discount value. */
|
|
3406
|
+
amount?: MultiCurrencyPrice;
|
|
3407
|
+
}
|
|
3408
|
+
interface DiscountRuleName {
|
|
3409
|
+
/**
|
|
3410
|
+
* Original discount rule name (in site's default language).
|
|
3411
|
+
* @minLength 1
|
|
3412
|
+
* @maxLength 256
|
|
3413
|
+
*/
|
|
3414
|
+
original?: string;
|
|
3415
|
+
/**
|
|
3416
|
+
* Translated discount rule name according to buyer language. Defaults to `original` when not provided.
|
|
3417
|
+
* @minLength 1
|
|
3418
|
+
* @maxLength 500
|
|
3419
|
+
*/
|
|
3420
|
+
translated?: string | null;
|
|
3421
|
+
}
|
|
3422
|
+
interface LineItemDiscount {
|
|
3423
|
+
/**
|
|
3424
|
+
* ID of line item the discount applies to.
|
|
3425
|
+
* @format GUID
|
|
3426
|
+
*/
|
|
3427
|
+
id?: string;
|
|
3428
|
+
/** Discount value. */
|
|
3429
|
+
totalDiscountAmount?: MultiCurrencyPrice;
|
|
3430
|
+
}
|
|
3431
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
3432
|
+
/** General shipping calculation error. */
|
|
3433
|
+
generalShippingCalculationError?: Details;
|
|
3434
|
+
/** Carrier errors. */
|
|
3435
|
+
carrierErrors?: CarrierErrors;
|
|
3436
|
+
/** Tax calculation error. */
|
|
3437
|
+
taxCalculationError?: Details;
|
|
3438
|
+
/** Coupon calculation error. */
|
|
3439
|
+
couponCalculationError?: Details;
|
|
3440
|
+
/** Gift card calculation error. */
|
|
3441
|
+
giftCardCalculationError?: Details;
|
|
3442
|
+
/** Order validation errors. */
|
|
3443
|
+
orderValidationErrors?: ApplicationError[];
|
|
3444
|
+
/**
|
|
3445
|
+
* Membership payment methods calculation errors
|
|
3446
|
+
* For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
|
|
3447
|
+
*/
|
|
3448
|
+
membershipError?: Details;
|
|
3449
|
+
/** Discount Rule calculation error. */
|
|
3450
|
+
discountsCalculationError?: Details;
|
|
3451
|
+
}
|
|
3452
|
+
/** @oneof */
|
|
3453
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
3454
|
+
/** General shipping calculation error. */
|
|
3455
|
+
generalShippingCalculationError?: Details;
|
|
3456
|
+
/** Carrier errors. */
|
|
3457
|
+
carrierErrors?: CarrierErrors;
|
|
3458
|
+
}
|
|
3459
|
+
interface CarrierErrors {
|
|
3460
|
+
/** Carrier errors. */
|
|
3461
|
+
errors?: CarrierError[];
|
|
3462
|
+
}
|
|
3463
|
+
interface CarrierError {
|
|
3464
|
+
/** Carrier ID. */
|
|
3465
|
+
carrierId?: string;
|
|
3466
|
+
/** Error details. */
|
|
3467
|
+
error?: Details;
|
|
3468
|
+
}
|
|
3469
|
+
interface MembershipOptions {
|
|
3470
|
+
/**
|
|
3471
|
+
* List of payment options that can be used.
|
|
3472
|
+
* @maxSize 300
|
|
3473
|
+
*/
|
|
3474
|
+
eligibleMemberships?: Membership[];
|
|
3475
|
+
/**
|
|
3476
|
+
* List of payment options that are owned by the member, but cannot be used due to reason provided.
|
|
3477
|
+
* @maxSize 300
|
|
3478
|
+
*/
|
|
3479
|
+
invalidMemberships?: InvalidMembership[];
|
|
3480
|
+
/**
|
|
3481
|
+
* The selected membership payment options and which line items they apply to.
|
|
3482
|
+
* @maxSize 300
|
|
3483
|
+
*/
|
|
3484
|
+
selectedMemberships?: SelectedMembership[];
|
|
3485
|
+
}
|
|
3486
|
+
interface Membership {
|
|
3487
|
+
/**
|
|
3488
|
+
* Membership ID.
|
|
3489
|
+
* @minLength 1
|
|
3490
|
+
* @maxLength 100
|
|
3491
|
+
*/
|
|
3492
|
+
id?: string;
|
|
3493
|
+
/**
|
|
3494
|
+
* ID of the application providing this payment option.
|
|
3495
|
+
* @format GUID
|
|
3496
|
+
*/
|
|
3497
|
+
appId?: string;
|
|
3498
|
+
/** The name of this membership. */
|
|
3499
|
+
name?: MembershipName;
|
|
3500
|
+
/**
|
|
3501
|
+
* Line item IDs which are "paid" for by this membership.
|
|
3502
|
+
* @minSize 1
|
|
3503
|
+
* @maxSize 300
|
|
3504
|
+
* @minLength 1
|
|
3505
|
+
* @maxLength 100
|
|
3506
|
+
*/
|
|
3507
|
+
lineItemIds?: string[];
|
|
3508
|
+
/** Optional - For a membership that has limited credits, information about credit usage. */
|
|
3509
|
+
credits?: MembershipPaymentCredits;
|
|
3510
|
+
/** Optional - TMembership expiry date. */
|
|
3511
|
+
expirationDate?: Date | null;
|
|
3512
|
+
/** Additional data about this membership. */
|
|
3513
|
+
additionalData?: Record<string, any> | null;
|
|
3514
|
+
}
|
|
3515
|
+
interface MembershipName {
|
|
3516
|
+
/**
|
|
3517
|
+
* Membership name.
|
|
3518
|
+
* @maxLength 100
|
|
3519
|
+
*/
|
|
3520
|
+
original?: string;
|
|
3521
|
+
/**
|
|
3522
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
3523
|
+
* @maxLength 100
|
|
3524
|
+
*/
|
|
3525
|
+
translated?: string | null;
|
|
3526
|
+
}
|
|
3527
|
+
interface MembershipPaymentCredits {
|
|
3528
|
+
/**
|
|
3529
|
+
* Membership's total amount of credits.
|
|
3530
|
+
* @min 1
|
|
3531
|
+
*/
|
|
3532
|
+
total?: number;
|
|
3533
|
+
/** Membership's remaining amount of credits. */
|
|
3534
|
+
remaining?: number;
|
|
3535
|
+
}
|
|
3536
|
+
interface InvalidMembership {
|
|
3537
|
+
/** Membership details. */
|
|
3538
|
+
membership?: Membership;
|
|
3539
|
+
/**
|
|
3540
|
+
* Reason why this membership is invalid and cannot be used.
|
|
3541
|
+
* @minLength 1
|
|
3542
|
+
* @maxLength 100
|
|
3543
|
+
*/
|
|
3544
|
+
reason?: string;
|
|
3545
|
+
}
|
|
3546
|
+
interface SelectedMembership {
|
|
3547
|
+
/**
|
|
3548
|
+
* Membership ID.
|
|
3549
|
+
* @minLength 1
|
|
3550
|
+
* @maxLength 100
|
|
3551
|
+
*/
|
|
3552
|
+
id?: string;
|
|
3553
|
+
/**
|
|
3554
|
+
* ID of the app providing this payment option.
|
|
3555
|
+
* @format GUID
|
|
3556
|
+
*/
|
|
3557
|
+
appId?: string;
|
|
3558
|
+
/**
|
|
3559
|
+
* IDs of the line items this membership applies to.
|
|
3560
|
+
* @minSize 1
|
|
3561
|
+
* @maxSize 300
|
|
3562
|
+
* @minLength 1
|
|
3563
|
+
* @maxLength 100
|
|
3564
|
+
*/
|
|
3565
|
+
lineItemIds?: string[];
|
|
3566
|
+
}
|
|
3567
|
+
interface AdditionalFee {
|
|
3568
|
+
/**
|
|
3569
|
+
* Additional fee's unique code (or ID) for future processing.
|
|
3570
|
+
* @minLength 1
|
|
3571
|
+
* @maxLength 100
|
|
3572
|
+
*/
|
|
3573
|
+
code?: string | null;
|
|
3574
|
+
/**
|
|
3575
|
+
* Translated additional fee's name.
|
|
3576
|
+
* @minLength 1
|
|
3577
|
+
* @maxLength 50
|
|
3578
|
+
*/
|
|
3579
|
+
name?: string;
|
|
3580
|
+
/** Additional fee's price. */
|
|
3581
|
+
price?: MultiCurrencyPrice;
|
|
3582
|
+
/** Tax details. */
|
|
3583
|
+
taxDetails?: ItemTaxFullDetails;
|
|
3584
|
+
/**
|
|
3585
|
+
* Provider's app id.
|
|
3586
|
+
* @minLength 1
|
|
3587
|
+
* @maxLength 100
|
|
3588
|
+
*/
|
|
3589
|
+
providerAppId?: string | null;
|
|
3590
|
+
/** Additional fee's price before tax. */
|
|
3591
|
+
priceBeforeTax?: MultiCurrencyPrice;
|
|
3592
|
+
/** Additional fee's price after tax. */
|
|
3593
|
+
priceAfterTax?: MultiCurrencyPrice;
|
|
3594
|
+
/**
|
|
3595
|
+
* Optional - Line items associated with this additional fee.
|
|
3596
|
+
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
3597
|
+
* @format GUID
|
|
3598
|
+
*/
|
|
3599
|
+
lineItemIds?: string[];
|
|
3600
|
+
/** the source the additional fee was added from */
|
|
3601
|
+
source?: AdditionalFeeSourceWithLiterals;
|
|
3602
|
+
/**
|
|
3603
|
+
* 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).
|
|
3604
|
+
* @minLength 1
|
|
3605
|
+
* @maxLength 50
|
|
3606
|
+
*/
|
|
3607
|
+
translatedName?: string | null;
|
|
3608
|
+
}
|
|
3609
|
+
declare enum AdditionalFeeSource {
|
|
3610
|
+
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
3611
|
+
/** The additional fee was added by an additional fee service plugin */
|
|
3612
|
+
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
3613
|
+
/** The additional fee was added on the item either via the catalog or on custom line item */
|
|
3614
|
+
ITEM = "ITEM",
|
|
3615
|
+
/** The additional fee was added manually on the request */
|
|
3616
|
+
MANUAL = "MANUAL",
|
|
3617
|
+
/** The additional fee was added by the shipping provider */
|
|
3618
|
+
SHIPPING = "SHIPPING"
|
|
3619
|
+
}
|
|
3620
|
+
/** @enumType */
|
|
3621
|
+
type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
|
|
3622
|
+
interface GetCheckoutURLRequest {
|
|
3623
|
+
/**
|
|
3624
|
+
* ID of the Cart to calculate.
|
|
3625
|
+
* @format GUID
|
|
3626
|
+
*/
|
|
3627
|
+
cartId: string;
|
|
3628
|
+
/**
|
|
3629
|
+
* Checkout currency parameter to append as a query param
|
|
3630
|
+
* @format CURRENCY
|
|
3631
|
+
*/
|
|
3632
|
+
currencyCode?: string | null;
|
|
3633
|
+
}
|
|
3634
|
+
interface GetCheckoutURLResponse {
|
|
3635
|
+
/**
|
|
3636
|
+
* The checkout URL.
|
|
3637
|
+
* @format WEB_URL
|
|
3638
|
+
*/
|
|
3639
|
+
checkoutUrl?: string;
|
|
3640
|
+
}
|
|
3641
|
+
interface PlaceOrderRequest {
|
|
3642
|
+
/**
|
|
3643
|
+
* Cart ID.
|
|
3644
|
+
* @format GUID
|
|
3645
|
+
*/
|
|
3646
|
+
cartId: string;
|
|
3647
|
+
/**
|
|
3648
|
+
* The price verification token received from `CalculateCart`'s response.
|
|
3649
|
+
* Used to verify that the prices shown to the customer have not changed before completing checkout.
|
|
3650
|
+
* @maxLength 3000
|
|
3651
|
+
*/
|
|
3652
|
+
priceVerificationToken?: string | null;
|
|
3653
|
+
/**
|
|
3654
|
+
* Payment token.
|
|
3655
|
+
* @maxLength 100
|
|
3656
|
+
*/
|
|
3657
|
+
paymentToken?: string | null;
|
|
3658
|
+
/** Urls to redirect to after payment is made. */
|
|
3659
|
+
redirectUrls?: RedirectUrls;
|
|
3660
|
+
/** Indicates the payment method should be saved on the order */
|
|
3661
|
+
savePaymentMethod?: boolean;
|
|
3662
|
+
/** Indicates whether to authorize the payment and delay the capture */
|
|
3663
|
+
delayCapture?: boolean;
|
|
3664
|
+
}
|
|
3665
|
+
interface RedirectUrls {
|
|
3666
|
+
/**
|
|
3667
|
+
* URL to redirect to if payment is canceled (usually checkout url).
|
|
3668
|
+
* @format WEB_URL
|
|
3669
|
+
*/
|
|
3670
|
+
cancelUrl?: string;
|
|
3671
|
+
/**
|
|
3672
|
+
* URL to redirect to if an error occurred on payment (usually checkout url).
|
|
3673
|
+
* @format WEB_URL
|
|
3674
|
+
*/
|
|
3675
|
+
errorUrl?: string;
|
|
3676
|
+
/**
|
|
3677
|
+
* URL to redirect to after successful payment, excepts order place holder {orderId}.
|
|
3678
|
+
* @maxLength 2000
|
|
3679
|
+
*/
|
|
3680
|
+
successUrl?: string | null;
|
|
3681
|
+
/**
|
|
3682
|
+
* URL to redirect to if payment is pending, excepts order place holder {orderId}.
|
|
3683
|
+
* @maxLength 2000
|
|
3684
|
+
*/
|
|
3685
|
+
pendingUrl?: string | null;
|
|
3686
|
+
}
|
|
3687
|
+
interface PlaceOrderResponse {
|
|
3688
|
+
/**
|
|
3689
|
+
* The order ID of the created order.
|
|
3690
|
+
* @format GUID
|
|
3691
|
+
*/
|
|
3692
|
+
orderId?: string;
|
|
3693
|
+
/**
|
|
3694
|
+
* Payment response token.
|
|
3695
|
+
* @maxLength 1000
|
|
3696
|
+
*/
|
|
3697
|
+
paymentResponseToken?: string | null;
|
|
3698
|
+
/**
|
|
3699
|
+
* The payment gateway is Cashier.
|
|
3700
|
+
* payment_gateway_order_id will be returned given that money was charged.
|
|
3701
|
+
* In some cases, money will not be charged:
|
|
3702
|
+
* If the total price is 0 - For example, could be a free item or a an item with 100% discount
|
|
3703
|
+
* If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
|
|
3704
|
+
* @maxLength 50
|
|
3705
|
+
*/
|
|
3706
|
+
paymentGatewayOrderId?: string | null;
|
|
3707
|
+
/** Whether an order was successfully created from this cart and the payment transaction was completed. */
|
|
3708
|
+
completed?: boolean;
|
|
3709
|
+
}
|
|
3710
|
+
interface AddLineItemsRequest {
|
|
3711
|
+
/**
|
|
3712
|
+
* Cart ID.
|
|
3713
|
+
* @format GUID
|
|
3714
|
+
*/
|
|
3715
|
+
cartId: string;
|
|
3716
|
+
/**
|
|
3717
|
+
* A list of catalog items to add to the cart.
|
|
3718
|
+
* @maxSize 300
|
|
3719
|
+
*/
|
|
3720
|
+
catalogItems?: CatalogItemInput[];
|
|
3721
|
+
/**
|
|
3722
|
+
* A list of custom items to add to the cart.
|
|
3723
|
+
* @maxSize 300
|
|
3724
|
+
*/
|
|
3725
|
+
customItems?: CustomItemInput[];
|
|
3726
|
+
}
|
|
3727
|
+
interface AddLineItemsResponse {
|
|
3728
|
+
/** Updated Cart. */
|
|
3729
|
+
cart?: Cart;
|
|
3730
|
+
}
|
|
3731
|
+
interface RemoveLineItemsRequest {
|
|
3732
|
+
/**
|
|
3733
|
+
* Cart ID.
|
|
3734
|
+
* @format GUID
|
|
3735
|
+
*/
|
|
3736
|
+
cartId: string;
|
|
3737
|
+
/**
|
|
3738
|
+
* Line item IDs to remove from cart.
|
|
3739
|
+
* @format GUID
|
|
3740
|
+
* @minSize 1
|
|
3741
|
+
* @maxSize 100
|
|
3742
|
+
*/
|
|
3743
|
+
lineItemIds: string[];
|
|
3744
|
+
}
|
|
3745
|
+
interface RemoveLineItemsResponse {
|
|
3746
|
+
/** Updated Cart. */
|
|
3747
|
+
cart?: Cart;
|
|
3748
|
+
}
|
|
3749
|
+
interface UpdateLineItemsRequest {
|
|
3750
|
+
/**
|
|
3751
|
+
* Cart ID.
|
|
3752
|
+
* @format GUID
|
|
3753
|
+
*/
|
|
3754
|
+
cartId: string;
|
|
3755
|
+
/**
|
|
3756
|
+
* Line item updates to apply.
|
|
3757
|
+
* @minSize 1
|
|
3758
|
+
* @maxSize 300
|
|
3759
|
+
*/
|
|
3760
|
+
lineItems?: LineItemUpdate[];
|
|
3761
|
+
}
|
|
3762
|
+
interface UpdateLineItemsResponse {
|
|
3763
|
+
/** Updated Cart. */
|
|
3764
|
+
cart?: Cart;
|
|
3765
|
+
}
|
|
3766
|
+
interface AddCouponRequest {
|
|
3767
|
+
/**
|
|
3768
|
+
* Cart ID.
|
|
3769
|
+
* @format GUID
|
|
3770
|
+
*/
|
|
3771
|
+
cartId: string;
|
|
3772
|
+
/**
|
|
3773
|
+
* Coupon to apply.
|
|
3774
|
+
*
|
|
3775
|
+
* Currently only one is supported.
|
|
3776
|
+
* @minLength 1
|
|
3777
|
+
* @maxLength 50
|
|
3778
|
+
*/
|
|
3779
|
+
couponCode: string;
|
|
3780
|
+
}
|
|
3781
|
+
interface AddCouponResponse {
|
|
3782
|
+
/** Updated Cart. */
|
|
3783
|
+
cart?: Cart;
|
|
3784
|
+
}
|
|
3785
|
+
interface RemoveCouponRequest {
|
|
3786
|
+
/**
|
|
3787
|
+
* Cart ID.
|
|
3788
|
+
* @format GUID
|
|
3789
|
+
*/
|
|
3790
|
+
cartId: string;
|
|
3791
|
+
/**
|
|
3792
|
+
* Discount ID.
|
|
3793
|
+
* @format GUID
|
|
3794
|
+
*/
|
|
3795
|
+
couponId: string;
|
|
3796
|
+
}
|
|
3797
|
+
interface RemoveCouponResponse {
|
|
3798
|
+
/** Updated Cart. */
|
|
3799
|
+
cart?: Cart;
|
|
3800
|
+
}
|
|
3801
|
+
interface SetDeliveryMethodRequest {
|
|
3802
|
+
/**
|
|
3803
|
+
* Cart ID.
|
|
3804
|
+
* @format GUID
|
|
2889
3805
|
*/
|
|
2890
3806
|
cartId: string;
|
|
2891
3807
|
/** Delivery method. */
|
|
@@ -2964,6 +3880,12 @@ interface HeadersEntry {
|
|
|
2964
3880
|
key?: string;
|
|
2965
3881
|
value?: string;
|
|
2966
3882
|
}
|
|
3883
|
+
/** @docsIgnore */
|
|
3884
|
+
type GetCartApplicationErrors = {
|
|
3885
|
+
code?: 'DUMMY_ERROR_METHOD_CODE';
|
|
3886
|
+
description?: string;
|
|
3887
|
+
data?: DummyErrorDataMethodLevel;
|
|
3888
|
+
};
|
|
2967
3889
|
|
|
2968
3890
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2969
3891
|
getUrl: (context: any) => string;
|
|
@@ -3026,4 +3948,4 @@ declare function markCartAsCompleted(): __PublicMethodMetaInfo<'POST', {
|
|
|
3026
3948
|
}, MarkCartAsCompletedRequest$1, MarkCartAsCompletedRequest, MarkCartAsCompletedResponse$1, MarkCartAsCompletedResponse>;
|
|
3027
3949
|
declare function handleAsyncCheckoutCompletion(): __PublicMethodMetaInfo<'POST', {}, HandleAsyncCheckoutCompletionRequest$1, HandleAsyncCheckoutCompletionRequest, RawHttpResponse$1, RawHttpResponse>;
|
|
3028
3950
|
|
|
3029
|
-
export { type ActionEvent as ActionEventOriginal, type AddCouponRequest as AddCouponRequestOriginal, type AddCouponResponse as AddCouponResponseOriginal, type AddCouponToCurrentCartRequest as AddCouponToCurrentCartRequestOriginal, type AddCouponToCurrentCartResponse as AddCouponToCurrentCartResponseOriginal, type AddGiftCardRequest as AddGiftCardRequestOriginal, type AddGiftCardResponse as AddGiftCardResponseOriginal, type AddGiftCardToCurrentCartRequest as AddGiftCardToCurrentCartRequestOriginal, type AddGiftCardToCurrentCartResponse as AddGiftCardToCurrentCartResponseOriginal, type AddLineItemsRequest as AddLineItemsRequestOriginal, type AddLineItemsResponse as AddLineItemsResponseOriginal, type AddLineItemsToCurrentCartRequest as AddLineItemsToCurrentCartRequestOriginal, type AddLineItemsToCurrentCartResponse as AddLineItemsToCurrentCartResponseOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeTax as AdditionalFeeTaxOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type ApplicationError as ApplicationErrorOriginal, type BusinessInfo as BusinessInfoOriginal, type CalculateCartRequest as CalculateCartRequestOriginal, type CalculateCartResponse as CalculateCartResponseOriginal, type CalculateCurrentCartRequest as CalculateCurrentCartRequestOriginal, type CalculateCurrentCartResponse as CalculateCurrentCartResponseOriginal, type CalculationConfig as CalculationConfigOriginal, type CalculationErrors as CalculationErrorsOriginal, type CalculationErrorsShippingCalculationErrorOneOf as CalculationErrorsShippingCalculationErrorOneOfOriginal, type CarrierError as CarrierErrorOriginal, type CarrierErrors as CarrierErrorsOriginal, type Cart as CartOriginal, type CartSettings as CartSettingsOriginal, type CartSource as CartSourceOriginal, type CartSummary as CartSummaryOriginal, type CatalogItemInput as CatalogItemInputOriginal, type CatalogOverrideFields as CatalogOverrideFieldsOriginal, type CatalogReference as CatalogReferenceOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type Charge as ChargeOriginal, type Color as ColorOriginal, type ConvertedMoney as ConvertedMoneyOriginal, type Coupon as CouponOriginal, type CreateCartRequest as CreateCartRequestOriginal, type CreateCartResponse as CreateCartResponseOriginal, type CreateCurrentCartRequest as CreateCurrentCartRequestOriginal, type CreateCurrentCartResponse as CreateCurrentCartResponseOriginal, type CreatedByIdOneOf as CreatedByIdOneOfOriginal, type CreatedBy as CreatedByOriginal, type CustomContentReference as CustomContentReferenceOriginal, type CustomField as CustomFieldOriginal, type CustomItemAttributes as CustomItemAttributesOriginal, type CustomItemDeliveryConfig as CustomItemDeliveryConfigOriginal, type CustomItemInput as CustomItemInputOriginal, type CustomItemPaymentConfig as CustomItemPaymentConfigOriginal, type CustomItemPricingInfo as CustomItemPricingInfoOriginal, type CustomItemQuantityInfo as CustomItemQuantityInfoOriginal, type CustomItemSource as CustomItemSourceOriginal, type CustomItemTaxConfig as CustomItemTaxConfigOriginal, type CustomerInfoIdOneOf as CustomerInfoIdOneOfOriginal, type CustomerInfo as CustomerInfoOriginal, type DeleteCartRequest as DeleteCartRequestOriginal, type DeleteCartResponse as DeleteCartResponseOriginal, type DeleteCurrentCartRequest as DeleteCurrentCartRequestOriginal, type DeleteCurrentCartResponse as DeleteCurrentCartResponseOriginal, type DeliveryInfo as DeliveryInfoOriginal, type DeliveryMethodInput as DeliveryMethodInputOriginal, type DeliveryMethod as DeliveryMethodOriginal, type DeliverySummary as DeliverySummaryOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type Description as DescriptionOriginal, type DetailsKindOneOf as DetailsKindOneOfOriginal, type Details as DetailsOriginal, type DiscountBenefit as DiscountBenefitOriginal, type DiscountBenefitValueOneOf as DiscountBenefitValueOneOfOriginal, type Discount as DiscountOriginal, DiscountScope as DiscountScopeOriginal, type DiscountScopeWithLiterals as DiscountScopeWithLiteralsOriginal, type DiscountSource as DiscountSourceOriginal, DiscountSourceType as DiscountSourceTypeOriginal, type DiscountSourceTypeWithLiterals as DiscountSourceTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReference as ExternalReferenceOriginal, type FieldViolation as FieldViolationOriginal, FileType as FileTypeOriginal, type FileTypeWithLiterals as FileTypeWithLiteralsOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetCartRequest as GetCartRequestOriginal, type GetCartResponse as GetCartResponseOriginal, type GetCheckoutURLRequest as GetCheckoutURLRequestOriginal, type GetCheckoutURLResponse as GetCheckoutURLResponseOriginal, type GetCurrentCartRequest as GetCurrentCartRequestOriginal, type GetCurrentCartResponse as GetCurrentCartResponseOriginal, type GiftCard as GiftCardOriginal, type GiftCardSummary as GiftCardSummaryOriginal, type Group as GroupOriginal, type HandleAsyncCheckoutCompletionRequest as HandleAsyncCheckoutCompletionRequestOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ItemAttributes as ItemAttributesOriginal, type ItemDeliveryConfig as ItemDeliveryConfigOriginal, type ItemDiscount as ItemDiscountOriginal, type ItemModifier as ItemModifierOriginal, type ItemPaymentConfig as ItemPaymentConfigOriginal, type ItemPriceBreakdown as ItemPriceBreakdownOriginal, type ItemPricingInfo as ItemPricingInfoOriginal, type ItemQuantityInfo as ItemQuantityInfoOriginal, type ItemSource as ItemSourceOriginal, ItemStatus as ItemStatusOriginal, type ItemStatusWithLiterals as ItemStatusWithLiteralsOriginal, type ItemTaxConfig as ItemTaxConfigOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, ItemTypeItemType as ItemTypeItemTypeOriginal, type ItemTypeItemTypeWithLiterals as ItemTypeItemTypeWithLiteralsOriginal, type ItemType as ItemTypeOriginal, type LegacyFields as LegacyFieldsOriginal, type LineItem as LineItemOriginal, type LineItemSummary as LineItemSummaryOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type MarkCartAsCompletedRequest as MarkCartAsCompletedRequestOriginal, type MarkCartAsCompletedResponse as MarkCartAsCompletedResponseOriginal, type Membership as MembershipOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ModifierGroup as ModifierGroupOriginal, NameInLineItem as NameInLineItemOriginal, type NameInLineItemWithLiterals as NameInLineItemWithLiteralsOriginal, NameInOther as NameInOtherOriginal, type NameInOtherWithLiterals as NameInOtherWithLiteralsOriginal, type Other as OtherOriginal, type PageUrlV2 as PageUrlV2Original, type PaymentInfo as PaymentInfoOriginal, type PaymentOption as PaymentOptionOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type PaymentSummary as PaymentSummaryOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PlaceOrderRequest as PlaceOrderRequestOriginal, type PlaceOrderResponse as PlaceOrderResponseOriginal, type PlainTextValue as PlainTextValueOriginal, type Policy as PolicyOriginal, type PriceDescription as PriceDescriptionOriginal, type PriceSummary as PriceSummaryOriginal, type QuantityUpdate as QuantityUpdateOriginal, type RawHttpResponse as RawHttpResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefreshCartRequest as RefreshCartRequestOriginal, type RefreshCartResponse as RefreshCartResponseOriginal, type RefreshCurrentCartRequest as RefreshCurrentCartRequestOriginal, type RefreshCurrentCartResponse as RefreshCurrentCartResponseOriginal, type RemoveCouponFromCurrentCartRequest as RemoveCouponFromCurrentCartRequestOriginal, type RemoveCouponFromCurrentCartResponse as RemoveCouponFromCurrentCartResponseOriginal, type RemoveCouponRequest as RemoveCouponRequestOriginal, type RemoveCouponResponse as RemoveCouponResponseOriginal, type RemoveGiftCardFromCurrentCartRequest as RemoveGiftCardFromCurrentCartRequestOriginal, type RemoveGiftCardFromCurrentCartResponse as RemoveGiftCardFromCurrentCartResponseOriginal, type RemoveGiftCardRequest as RemoveGiftCardRequestOriginal, type RemoveGiftCardResponse as RemoveGiftCardResponseOriginal, type RemoveLineItemsFromCurrentCartRequest as RemoveLineItemsFromCurrentCartRequestOriginal, type RemoveLineItemsFromCurrentCartResponse as RemoveLineItemsFromCurrentCartResponseOriginal, type RemoveLineItemsRequest as RemoveLineItemsRequestOriginal, type RemoveLineItemsResponse as RemoveLineItemsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, RuleType as RuleTypeOriginal, type RuleTypeWithLiterals as RuleTypeWithLiteralsOriginal, type Scope as ScopeOriginal, type SecuredMedia as SecuredMediaOriginal, type SelectedMembership as SelectedMembershipOriginal, type SelectedMembershipUpdate as SelectedMembershipUpdateOriginal, type ServiceProperties as ServicePropertiesOriginal, type SetDeliveryMethodForCurrentCartRequest as SetDeliveryMethodForCurrentCartRequestOriginal, type SetDeliveryMethodForCurrentCartResponse as SetDeliveryMethodForCurrentCartResponseOriginal, type SetDeliveryMethodRequest as SetDeliveryMethodRequestOriginal, type SetDeliveryMethodResponse as SetDeliveryMethodResponseOriginal, Severity as SeverityOriginal, type SeverityWithLiterals as SeverityWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type SubscriptionCharges as SubscriptionChargesOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionOptionInfo as SubscriptionOptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, SuggestedFix as SuggestedFixOriginal, type SuggestedFixWithLiterals as SuggestedFixWithLiteralsOriginal, type SystemError as SystemErrorOriginal, type Target as TargetOriginal, type TargetTargetTypeOneOf as TargetTargetTypeOneOfOriginal, type TaxDetails as TaxDetailsOriginal, type TaxInfo as TaxInfoOriginal, type Tax as TaxOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type Title as TitleOriginal, type TranslatableString as TranslatableStringOriginal, type UnmarkAsCurrentCartRequest as UnmarkAsCurrentCartRequestOriginal, type UnmarkAsCurrentCartResponse as UnmarkAsCurrentCartResponseOriginal, type UpdateCartRequest as UpdateCartRequestOriginal, type UpdateCartResponse as UpdateCartResponseOriginal, type UpdateCurrentCartRequest as UpdateCurrentCartRequestOriginal, type UpdateCurrentCartResponse as UpdateCurrentCartResponseOriginal, type UpdateLineItemsInCurrentCartRequest as UpdateLineItemsInCurrentCartRequestOriginal, type UpdateLineItemsInCurrentCartResponse as UpdateLineItemsInCurrentCartResponseOriginal, type UpdateLineItemsRequest as UpdateLineItemsRequestOriginal, type UpdateLineItemsResponse as UpdateLineItemsResponseOriginal, type V2AdditionalFee as V2AdditionalFeeOriginal, type V2LineItem as V2LineItemOriginal, type ValidationError as ValidationErrorOriginal, ValidationsConfig as ValidationsConfigOriginal, type ValidationsConfigWithLiterals as ValidationsConfigWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type Violation as ViolationOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type __PublicMethodMetaInfo, addCoupon, addGiftCard, addLineItems, calculateCart, createCart, deleteCart, getCart, getCheckoutUrl, handleAsyncCheckoutCompletion, markCartAsCompleted, placeOrder, refreshCart, removeCoupon, removeGiftCard, removeLineItems, setDeliveryMethod, updateCart, updateLineItems };
|
|
3951
|
+
export { type ActionEvent as ActionEventOriginal, type AddCouponRequest as AddCouponRequestOriginal, type AddCouponResponse as AddCouponResponseOriginal, type AddCouponToCurrentCartRequest as AddCouponToCurrentCartRequestOriginal, type AddCouponToCurrentCartResponse as AddCouponToCurrentCartResponseOriginal, type AddGiftCardRequest as AddGiftCardRequestOriginal, type AddGiftCardResponse as AddGiftCardResponseOriginal, type AddGiftCardToCurrentCartRequest as AddGiftCardToCurrentCartRequestOriginal, type AddGiftCardToCurrentCartResponse as AddGiftCardToCurrentCartResponseOriginal, type AddLineItemsRequest as AddLineItemsRequestOriginal, type AddLineItemsResponse as AddLineItemsResponseOriginal, type AddLineItemsToCurrentCartRequest as AddLineItemsToCurrentCartRequestOriginal, type AddLineItemsToCurrentCartResponse as AddLineItemsToCurrentCartResponseOriginal, type AdditionalFee as AdditionalFeeOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AdditionalFeeTax as AdditionalFeeTaxOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AggregatedTaxBreakdown as AggregatedTaxBreakdownOriginal, type ApplicableLineItems as ApplicableLineItemsOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type AutoTaxFallbackCalculationDetails as AutoTaxFallbackCalculationDetailsOriginal, type BusinessInfo as BusinessInfoOriginal, type CalculateCartRequest as CalculateCartRequestOriginal, type CalculateCartResponse as CalculateCartResponseOriginal, type CalculateCartWithFullResponseResponse as CalculateCartWithFullResponseResponseOriginal, type CalculateCurrentCartRequest as CalculateCurrentCartRequestOriginal, type CalculateCurrentCartResponse as CalculateCurrentCartResponseOriginal, type CalculateTotalsResponse as CalculateTotalsResponseOriginal, type CalculatedItemModifier as CalculatedItemModifierOriginal, type CalculatedLineItem as CalculatedLineItemOriginal, type CalculationConfig as CalculationConfigOriginal, type CalculationErrors as CalculationErrorsOriginal, type CalculationErrorsShippingCalculationErrorOneOf as CalculationErrorsShippingCalculationErrorOneOfOriginal, type CarrierError as CarrierErrorOriginal, type CarrierErrors as CarrierErrorsOriginal, type Carrier as CarrierOriginal, type CarrierServiceOption as CarrierServiceOptionOriginal, type Cart as CartOriginal, type CartSettings as CartSettingsOriginal, type CartSource as CartSourceOriginal, type CartSummary as CartSummaryOriginal, type CatalogItemInput as CatalogItemInputOriginal, type CatalogOverrideFields as CatalogOverrideFieldsOriginal, type CatalogReference as CatalogReferenceOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type Charge as ChargeOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type Color as ColorOriginal, type ConvertedMoney as ConvertedMoneyOriginal, type Coupon as CouponOriginal, type CreateCartRequest as CreateCartRequestOriginal, type CreateCartResponse as CreateCartResponseOriginal, type CreateCurrentCartRequest as CreateCurrentCartRequestOriginal, type CreateCurrentCartResponse as CreateCurrentCartResponseOriginal, type CreatedByIdOneOf as CreatedByIdOneOfOriginal, type CreatedBy as CreatedByOriginal, type CustomContentReference as CustomContentReferenceOriginal, type CustomField as CustomFieldOriginal, type CustomItemAttributes as CustomItemAttributesOriginal, type CustomItemDeliveryConfig as CustomItemDeliveryConfigOriginal, type CustomItemInput as CustomItemInputOriginal, type CustomItemPaymentConfig as CustomItemPaymentConfigOriginal, type CustomItemPricingInfo as CustomItemPricingInfoOriginal, type CustomItemQuantityInfo as CustomItemQuantityInfoOriginal, type CustomItemSource as CustomItemSourceOriginal, type CustomItemTaxConfig as CustomItemTaxConfigOriginal, type CustomerInfoIdOneOf as CustomerInfoIdOneOfOriginal, type CustomerInfo as CustomerInfoOriginal, type DeleteCartRequest as DeleteCartRequestOriginal, type DeleteCartResponse as DeleteCartResponseOriginal, type DeleteCurrentCartRequest as DeleteCurrentCartRequestOriginal, type DeleteCurrentCartResponse as DeleteCurrentCartResponseOriginal, type DeliveryAllocation as DeliveryAllocationOriginal, type DeliveryInfo as DeliveryInfoOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryMethodInput as DeliveryMethodInputOriginal, type DeliveryMethod as DeliveryMethodOriginal, type DeliverySummary as DeliverySummaryOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type Description as DescriptionOriginal, type DetailsKindOneOf as DetailsKindOneOfOriginal, type Details as DetailsOriginal, type DiscountBenefit as DiscountBenefitOriginal, type DiscountBenefitValueOneOf as DiscountBenefitValueOneOfOriginal, type Discount as DiscountOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountScope as DiscountScopeOriginal, type DiscountScopeWithLiterals as DiscountScopeWithLiteralsOriginal, type DiscountSource as DiscountSourceOriginal, DiscountSourceType as DiscountSourceTypeOriginal, type DiscountSourceTypeWithLiterals as DiscountSourceTypeWithLiteralsOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DummyErrorDataMethodLevel as DummyErrorDataMethodLevelOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReference as ExternalReferenceOriginal, FallbackReason as FallbackReasonOriginal, type FallbackReasonWithLiterals as FallbackReasonWithLiteralsOriginal, type FieldViolation as FieldViolationOriginal, FileType as FileTypeOriginal, type FileTypeWithLiterals as FileTypeWithLiteralsOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetCartApplicationErrors as GetCartApplicationErrorsOriginal, type GetCartRequest as GetCartRequestOriginal, type GetCartResponse as GetCartResponseOriginal, type GetCheckoutURLRequest as GetCheckoutURLRequestOriginal, type GetCheckoutURLResponse as GetCheckoutURLResponseOriginal, type GetCurrentCartRequest as GetCurrentCartRequestOriginal, type GetCurrentCartResponse as GetCurrentCartResponseOriginal, type GiftCard as GiftCardOriginal, type GiftCardSummary as GiftCardSummaryOriginal, type Group as GroupOriginal, type HandleAsyncCheckoutCompletionRequest as HandleAsyncCheckoutCompletionRequestOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InvalidMembership as InvalidMembershipOriginal, type ItemAttributes as ItemAttributesOriginal, type ItemDeliveryConfig as ItemDeliveryConfigOriginal, type ItemDiscount as ItemDiscountOriginal, type ItemModifier as ItemModifierOriginal, type ItemPaymentConfig as ItemPaymentConfigOriginal, type ItemPriceBreakdown as ItemPriceBreakdownOriginal, type ItemPricingInfo as ItemPricingInfoOriginal, type ItemQuantityInfo as ItemQuantityInfoOriginal, type ItemSource as ItemSourceOriginal, ItemStatus as ItemStatusOriginal, type ItemStatusWithLiterals as ItemStatusWithLiteralsOriginal, type ItemTaxConfig as ItemTaxConfigOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, ItemTypeItemType as ItemTypeItemTypeOriginal, type ItemTypeItemTypeWithLiterals as ItemTypeItemTypeWithLiteralsOriginal, type ItemType as ItemTypeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LegacyFields as LegacyFieldsOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemIdentifierIdOneOf as LineItemIdentifierIdOneOfOriginal, type LineItemIdentifier as LineItemIdentifierOriginal, type LineItem as LineItemOriginal, type LineItemPricesData as LineItemPricesDataOriginal, type LineItemSummary as LineItemSummaryOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, ManualCalculationReason as ManualCalculationReasonOriginal, type ManualCalculationReasonWithLiterals as ManualCalculationReasonWithLiteralsOriginal, type MarkCartAsCompletedRequest as MarkCartAsCompletedRequestOriginal, type MarkCartAsCompletedResponse as MarkCartAsCompletedResponseOriginal, type MembershipName as MembershipNameOriginal, type MembershipOptions as MembershipOptionsOriginal, type Membership as MembershipOriginal, type MembershipPaymentCredits as MembershipPaymentCreditsOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ModifierGroup as ModifierGroupOriginal, type MultiCurrencyPrice as MultiCurrencyPriceOriginal, NameInLineItem as NameInLineItemOriginal, type NameInLineItemWithLiterals as NameInLineItemWithLiteralsOriginal, NameInOther as NameInOtherOriginal, type NameInOtherWithLiterals as NameInOtherWithLiteralsOriginal, type OtherCharge as OtherChargeOriginal, type Other as OtherOriginal, type PageUrlV2 as PageUrlV2Original, type PaymentInfo as PaymentInfoOriginal, type PaymentOption as PaymentOptionOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type PaymentSummary as PaymentSummaryOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PlaceOrderRequest as PlaceOrderRequestOriginal, type PlaceOrderResponse as PlaceOrderResponseOriginal, type PlainTextValue as PlainTextValueOriginal, type Policy as PolicyOriginal, type PriceDescription as PriceDescriptionOriginal, type PriceSummary as PriceSummaryOriginal, type QuantityUpdate as QuantityUpdateOriginal, RateType as RateTypeOriginal, type RateTypeWithLiterals as RateTypeWithLiteralsOriginal, type RawHttpResponse as RawHttpResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefreshCartRequest as RefreshCartRequestOriginal, type RefreshCartResponse as RefreshCartResponseOriginal, type RefreshCurrentCartRequest as RefreshCurrentCartRequestOriginal, type RefreshCurrentCartResponse as RefreshCurrentCartResponseOriginal, type Region as RegionOriginal, type RemoveCouponFromCurrentCartRequest as RemoveCouponFromCurrentCartRequestOriginal, type RemoveCouponFromCurrentCartResponse as RemoveCouponFromCurrentCartResponseOriginal, type RemoveCouponRequest as RemoveCouponRequestOriginal, type RemoveCouponResponse as RemoveCouponResponseOriginal, type RemoveGiftCardFromCurrentCartRequest as RemoveGiftCardFromCurrentCartRequestOriginal, type RemoveGiftCardFromCurrentCartResponse as RemoveGiftCardFromCurrentCartResponseOriginal, type RemoveGiftCardRequest as RemoveGiftCardRequestOriginal, type RemoveGiftCardResponse as RemoveGiftCardResponseOriginal, type RemoveLineItemsFromCurrentCartRequest as RemoveLineItemsFromCurrentCartRequestOriginal, type RemoveLineItemsFromCurrentCartResponse as RemoveLineItemsFromCurrentCartResponseOriginal, type RemoveLineItemsRequest as RemoveLineItemsRequestOriginal, type RemoveLineItemsResponse as RemoveLineItemsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, RuleType as RuleTypeOriginal, type RuleTypeWithLiterals as RuleTypeWithLiteralsOriginal, type Scope as ScopeOriginal, type SecuredMedia as SecuredMediaOriginal, type SelectedCarrierServiceOption as SelectedCarrierServiceOptionOriginal, type SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherChargeOriginal, type SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPricesOriginal, type SelectedMembership as SelectedMembershipOriginal, type SelectedMembershipUpdate as SelectedMembershipUpdateOriginal, type ServiceProperties as ServicePropertiesOriginal, type SetDeliveryMethodForCurrentCartRequest as SetDeliveryMethodForCurrentCartRequestOriginal, type SetDeliveryMethodForCurrentCartResponse as SetDeliveryMethodForCurrentCartResponseOriginal, type SetDeliveryMethodRequest as SetDeliveryMethodRequestOriginal, type SetDeliveryMethodResponse as SetDeliveryMethodResponseOriginal, Severity as SeverityOriginal, type SeverityWithLiterals as SeverityWithLiteralsOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingOption as ShippingOptionOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRegion as ShippingRegionOriginal, type StreetAddress as StreetAddressOriginal, type SubscriptionCharges as SubscriptionChargesOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionOptionInfo as SubscriptionOptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, SuggestedFix as SuggestedFixOriginal, type SuggestedFixWithLiterals as SuggestedFixWithLiteralsOriginal, type SystemError as SystemErrorOriginal, type Target as TargetOriginal, type TargetTargetTypeOneOf as TargetTargetTypeOneOfOriginal, type TaxBreakdown as TaxBreakdownOriginal, type TaxCalculationDetailsCalculationDetailsOneOf as TaxCalculationDetailsCalculationDetailsOneOfOriginal, type TaxCalculationDetails as TaxCalculationDetailsOriginal, type TaxDetails as TaxDetailsOriginal, type TaxInfo as TaxInfoOriginal, type Tax as TaxOriginal, type TaxRateBreakdown as TaxRateBreakdownOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type Title as TitleOriginal, type TranslatableString as TranslatableStringOriginal, type UnmarkAsCurrentCartRequest as UnmarkAsCurrentCartRequestOriginal, type UnmarkAsCurrentCartResponse as UnmarkAsCurrentCartResponseOriginal, type UpdateCartRequest as UpdateCartRequestOriginal, type UpdateCartResponse as UpdateCartResponseOriginal, type UpdateCurrentCartRequest as UpdateCurrentCartRequestOriginal, type UpdateCurrentCartResponse as UpdateCurrentCartResponseOriginal, type UpdateLineItemsInCurrentCartRequest as UpdateLineItemsInCurrentCartRequestOriginal, type UpdateLineItemsInCurrentCartResponse as UpdateLineItemsInCurrentCartResponseOriginal, type UpdateLineItemsRequest as UpdateLineItemsRequestOriginal, type UpdateLineItemsResponse as UpdateLineItemsResponseOriginal, type V1AdditionalFee as V1AdditionalFeeOriginal, type V2AdditionalFee as V2AdditionalFeeOriginal, type V2CalculationErrors as V2CalculationErrorsOriginal, type V2CalculationErrorsShippingCalculationErrorOneOf as V2CalculationErrorsShippingCalculationErrorOneOfOriginal, type V2CarrierError as V2CarrierErrorOriginal, type V2CarrierErrors as V2CarrierErrorsOriginal, type V2Coupon as V2CouponOriginal, type V2GiftCard as V2GiftCardOriginal, type V2LineItem as V2LineItemOriginal, type V2Membership as V2MembershipOriginal, type V2PriceSummary as V2PriceSummaryOriginal, type V2SelectedMembership as V2SelectedMembershipOriginal, type V2TaxSummary as V2TaxSummaryOriginal, type ValidationError as ValidationErrorOriginal, ValidationsConfig as ValidationsConfigOriginal, type ValidationsConfigWithLiterals as ValidationsConfigWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type Violation as ViolationOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type __PublicMethodMetaInfo, addCoupon, addGiftCard, addLineItems, calculateCart, createCart, deleteCart, getCart, getCheckoutUrl, handleAsyncCheckoutCompletion, markCartAsCompleted, placeOrder, refreshCart, removeCoupon, removeGiftCard, removeLineItems, setDeliveryMethod, updateCart, updateLineItems };
|