@wix/auto_sdk_ecom_cart-v-2 1.0.21 → 1.0.22
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 +46 -53
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -1
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +45 -52
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +46 -53
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1 -1
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +45 -52
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +14 -14
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +59 -66
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +45 -52
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +14 -14
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +59 -66
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +45 -52
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -31,7 +31,7 @@ interface Cart {
|
|
|
31
31
|
*/
|
|
32
32
|
lineItems?: V2LineItem[];
|
|
33
33
|
/** The sum of all line item final prices. */
|
|
34
|
-
subtotal?:
|
|
34
|
+
subtotal?: ConvertedMoney;
|
|
35
35
|
/**
|
|
36
36
|
* Optional message left by the customer.
|
|
37
37
|
* Usually intended for the merchant and contain special instructions, requests, or clarifications related to the order.
|
|
@@ -197,12 +197,12 @@ interface ItemPricingInfo {
|
|
|
197
197
|
* Final unit price after applying automatic discounts.
|
|
198
198
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
199
199
|
*/
|
|
200
|
-
unitPrice?:
|
|
200
|
+
unitPrice?: ConvertedMoney;
|
|
201
201
|
/**
|
|
202
202
|
* Final total price for this item (unit price × quantity).
|
|
203
203
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
204
204
|
*/
|
|
205
|
-
totalPrice?:
|
|
205
|
+
totalPrice?: ConvertedMoney;
|
|
206
206
|
/**
|
|
207
207
|
* Additional description for the price.
|
|
208
208
|
* For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
|
|
@@ -213,28 +213,21 @@ interface ItemPricingInfo {
|
|
|
213
213
|
/** Detailed breakdown of price components. */
|
|
214
214
|
breakdown?: ItemPriceBreakdown;
|
|
215
215
|
}
|
|
216
|
-
interface
|
|
216
|
+
interface ConvertedMoney {
|
|
217
217
|
/**
|
|
218
|
-
*
|
|
219
|
-
* @
|
|
218
|
+
* Monetary amount in the original currency, as specified in `business_info.currency_code`.
|
|
219
|
+
* @format DECIMAL_VALUE
|
|
220
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
220
221
|
*/
|
|
221
222
|
amount?: string;
|
|
222
223
|
/**
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
224
|
+
* Monetary amount in the converted currency, as specified in `customer_info.currency_code`.
|
|
225
|
+
*
|
|
226
|
+
* Default: `amount`.
|
|
227
|
+
* @format DECIMAL_VALUE
|
|
228
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
226
229
|
*/
|
|
227
230
|
convertedAmount?: string;
|
|
228
|
-
/**
|
|
229
|
-
* Amount formatted with currency symbol.
|
|
230
|
-
* @readonly
|
|
231
|
-
*/
|
|
232
|
-
formattedAmount?: string;
|
|
233
|
-
/**
|
|
234
|
-
* Converted amount formatted with currency symbol.
|
|
235
|
-
* @readonly
|
|
236
|
-
*/
|
|
237
|
-
formattedConvertedAmount?: string;
|
|
238
231
|
}
|
|
239
232
|
interface PriceDescription {
|
|
240
233
|
/**
|
|
@@ -257,17 +250,17 @@ interface ItemPriceBreakdown {
|
|
|
257
250
|
* Full catalog price of a single item before any discounts, including modifiers.
|
|
258
251
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
259
252
|
*/
|
|
260
|
-
fullPrice?:
|
|
253
|
+
fullPrice?: ConvertedMoney;
|
|
261
254
|
/**
|
|
262
255
|
* Catalog sale price of a single item, including modifiers.
|
|
263
256
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
264
257
|
*/
|
|
265
|
-
salePrice?:
|
|
258
|
+
salePrice?: ConvertedMoney;
|
|
266
259
|
/**
|
|
267
260
|
* Total price of all item modifiers for the entire quantity of this item.
|
|
268
261
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
269
262
|
*/
|
|
270
|
-
totalModifiersPrice?:
|
|
263
|
+
totalModifiersPrice?: ConvertedMoney;
|
|
271
264
|
}
|
|
272
265
|
interface ItemSource {
|
|
273
266
|
/**
|
|
@@ -732,7 +725,7 @@ interface ItemPaymentConfig {
|
|
|
732
725
|
* Partial payment to be paid upfront during the checkout.
|
|
733
726
|
* Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
734
727
|
*/
|
|
735
|
-
depositAmount?:
|
|
728
|
+
depositAmount?: ConvertedMoney;
|
|
736
729
|
/**
|
|
737
730
|
* Selected membership to be used as payment for this item.
|
|
738
731
|
* Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`.
|
|
@@ -869,7 +862,7 @@ interface ItemModifier {
|
|
|
869
862
|
/** Additional details. */
|
|
870
863
|
details?: TranslatableString;
|
|
871
864
|
/** The price of the modifier. */
|
|
872
|
-
price?:
|
|
865
|
+
price?: ConvertedMoney;
|
|
873
866
|
}
|
|
874
867
|
/**
|
|
875
868
|
* Currently, only automatic discounts are applied to line items.
|
|
@@ -879,7 +872,7 @@ interface ItemDiscount {
|
|
|
879
872
|
/** The display name of the discount. */
|
|
880
873
|
name?: TranslatableString;
|
|
881
874
|
/** The amount discounted from the item's sale price (per unit). */
|
|
882
|
-
amountOff?:
|
|
875
|
+
amountOff?: ConvertedMoney;
|
|
883
876
|
}
|
|
884
877
|
interface Scope {
|
|
885
878
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
@@ -1413,9 +1406,9 @@ interface LegacyFields {
|
|
|
1413
1406
|
*/
|
|
1414
1407
|
appliedDiscounts?: Discount[];
|
|
1415
1408
|
/** The coupon discount amount. */
|
|
1416
|
-
couponDiscount?:
|
|
1409
|
+
couponDiscount?: ConvertedMoney;
|
|
1417
1410
|
/** The sum of all line items after applying all discounts. */
|
|
1418
|
-
subtotalAfterCouponDiscount?:
|
|
1411
|
+
subtotalAfterCouponDiscount?: ConvertedMoney;
|
|
1419
1412
|
}
|
|
1420
1413
|
interface Discount {
|
|
1421
1414
|
/** The display name of the discount. */
|
|
@@ -1470,7 +1463,7 @@ declare enum DiscountScope {
|
|
|
1470
1463
|
type DiscountScopeWithLiterals = DiscountScope | 'UNKNOWN_DISCOUNT_SCOPE' | 'CART_SUBTOTAL' | 'LINE_ITEM' | 'DELIVERY';
|
|
1471
1464
|
interface DiscountBenefit extends DiscountBenefitValueOneOf {
|
|
1472
1465
|
/** A specific monetary value deducted from the total cost. */
|
|
1473
|
-
amountOff?:
|
|
1466
|
+
amountOff?: ConvertedMoney;
|
|
1474
1467
|
/**
|
|
1475
1468
|
* The ID of line item that the discount applies to.
|
|
1476
1469
|
* Relevant for item-level discounts only.
|
|
@@ -1481,7 +1474,7 @@ interface DiscountBenefit extends DiscountBenefitValueOneOf {
|
|
|
1481
1474
|
/** @oneof */
|
|
1482
1475
|
interface DiscountBenefitValueOneOf {
|
|
1483
1476
|
/** A specific monetary value deducted from the total cost. */
|
|
1484
|
-
amountOff?:
|
|
1477
|
+
amountOff?: ConvertedMoney;
|
|
1485
1478
|
}
|
|
1486
1479
|
interface CartSummary {
|
|
1487
1480
|
/**
|
|
@@ -1556,12 +1549,12 @@ interface LineItemSummary {
|
|
|
1556
1549
|
* Final unit price after applying automatic discounts.
|
|
1557
1550
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1558
1551
|
*/
|
|
1559
|
-
unitPrice?:
|
|
1552
|
+
unitPrice?: ConvertedMoney;
|
|
1560
1553
|
/**
|
|
1561
1554
|
* Total price for the line item (unit price × quantity).
|
|
1562
1555
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1563
1556
|
*/
|
|
1564
|
-
totalPrice?:
|
|
1557
|
+
totalPrice?: ConvertedMoney;
|
|
1565
1558
|
}
|
|
1566
1559
|
interface DeliverySummary {
|
|
1567
1560
|
/** The calculated delivery method. */
|
|
@@ -1570,7 +1563,7 @@ interface DeliverySummary {
|
|
|
1570
1563
|
* Delivery price after discount.
|
|
1571
1564
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1572
1565
|
*/
|
|
1573
|
-
price?:
|
|
1566
|
+
price?: ConvertedMoney;
|
|
1574
1567
|
}
|
|
1575
1568
|
interface V2AdditionalFee {
|
|
1576
1569
|
/**
|
|
@@ -1598,7 +1591,7 @@ interface V2AdditionalFee {
|
|
|
1598
1591
|
* Additional fee's price.
|
|
1599
1592
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1600
1593
|
*/
|
|
1601
|
-
price?:
|
|
1594
|
+
price?: ConvertedMoney;
|
|
1602
1595
|
/**
|
|
1603
1596
|
* Number of subscription cycle this fee applies to.
|
|
1604
1597
|
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
@@ -1627,7 +1620,7 @@ interface TaxSummary {
|
|
|
1627
1620
|
*/
|
|
1628
1621
|
lineItemTaxes?: LineItemTax[];
|
|
1629
1622
|
/** Tax applied to the delivery method. */
|
|
1630
|
-
deliveryTax?:
|
|
1623
|
+
deliveryTax?: ConvertedMoney;
|
|
1631
1624
|
/**
|
|
1632
1625
|
* Taxes applied to additional fees.
|
|
1633
1626
|
* @maxSize 100
|
|
@@ -1638,16 +1631,16 @@ interface Tax {
|
|
|
1638
1631
|
/** The name of the tax. */
|
|
1639
1632
|
name?: TranslatableString;
|
|
1640
1633
|
/** Amount for which tax is calculated. */
|
|
1641
|
-
taxableAmount?:
|
|
1634
|
+
taxableAmount?: ConvertedMoney;
|
|
1642
1635
|
/** Amount that is exempt from tax. */
|
|
1643
|
-
exemptAmount?:
|
|
1636
|
+
exemptAmount?: ConvertedMoney;
|
|
1644
1637
|
/**
|
|
1645
1638
|
* Tax rate %, as a decimal point between 0 and 1.
|
|
1646
1639
|
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
1647
1640
|
*/
|
|
1648
1641
|
rate?: string | null;
|
|
1649
1642
|
/** Calculated tax, based on `taxable_amount` and `rate`. */
|
|
1650
|
-
amount?:
|
|
1643
|
+
amount?: ConvertedMoney;
|
|
1651
1644
|
}
|
|
1652
1645
|
interface LineItemTax {
|
|
1653
1646
|
/**
|
|
@@ -1656,7 +1649,7 @@ interface LineItemTax {
|
|
|
1656
1649
|
*/
|
|
1657
1650
|
lineItemId?: string;
|
|
1658
1651
|
/** Tax amount applied to the additional fee. */
|
|
1659
|
-
tax?:
|
|
1652
|
+
tax?: ConvertedMoney;
|
|
1660
1653
|
}
|
|
1661
1654
|
interface AdditionalFeeTax {
|
|
1662
1655
|
/**
|
|
@@ -1666,34 +1659,34 @@ interface AdditionalFeeTax {
|
|
|
1666
1659
|
*/
|
|
1667
1660
|
additionalFeeCode?: string;
|
|
1668
1661
|
/** Tax amount applied to the additional fee. */
|
|
1669
|
-
tax?:
|
|
1662
|
+
tax?: ConvertedMoney;
|
|
1670
1663
|
}
|
|
1671
1664
|
interface PriceSummary {
|
|
1672
1665
|
/**
|
|
1673
1666
|
* Total price of all line items after applying item-level discounts.
|
|
1674
1667
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1675
1668
|
*/
|
|
1676
|
-
subtotal?:
|
|
1669
|
+
subtotal?: ConvertedMoney;
|
|
1677
1670
|
/**
|
|
1678
1671
|
* Total cart-level discount applied to the subtotal.
|
|
1679
1672
|
* Line-item discounts are reflected in the subtotal and not included here.
|
|
1680
1673
|
* Currently supports only a single coupon.
|
|
1681
1674
|
*/
|
|
1682
|
-
discount?:
|
|
1675
|
+
discount?: ConvertedMoney;
|
|
1683
1676
|
/**
|
|
1684
1677
|
* Final delivery cost for the cart.
|
|
1685
1678
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1686
1679
|
*/
|
|
1687
|
-
delivery?:
|
|
1680
|
+
delivery?: ConvertedMoney;
|
|
1688
1681
|
/**
|
|
1689
1682
|
* Total additional fees associated with the cart.
|
|
1690
1683
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1691
1684
|
*/
|
|
1692
|
-
additionalFees?:
|
|
1685
|
+
additionalFees?: ConvertedMoney;
|
|
1693
1686
|
/** Total tax amount calculated across all applicable components (items, discounts, delivery, and fees). */
|
|
1694
|
-
tax?:
|
|
1687
|
+
tax?: ConvertedMoney;
|
|
1695
1688
|
/** Total amount to be paid. */
|
|
1696
|
-
total?:
|
|
1689
|
+
total?: ConvertedMoney;
|
|
1697
1690
|
}
|
|
1698
1691
|
interface PaymentSummary {
|
|
1699
1692
|
/**
|
|
@@ -1715,13 +1708,13 @@ interface PaymentSummary {
|
|
|
1715
1708
|
/** Indicates whether a remaining payment is required to create the order, after applying gift cards. */
|
|
1716
1709
|
requiresPaymentAfterGiftCard?: boolean;
|
|
1717
1710
|
/** The total amount due after applying all gift cards. */
|
|
1718
|
-
totalAfterGiftCards?:
|
|
1711
|
+
totalAfterGiftCards?: ConvertedMoney;
|
|
1719
1712
|
/** The upfront amount to be charged immediately when placing the order (after applying gift cards). */
|
|
1720
|
-
payNow?:
|
|
1713
|
+
payNow?: ConvertedMoney;
|
|
1721
1714
|
/** The remaining amount to be collected later. */
|
|
1722
|
-
payLater?:
|
|
1715
|
+
payLater?: ConvertedMoney;
|
|
1723
1716
|
/** The amount to be charged after a free trial period (typically for subscription-based products). */
|
|
1724
|
-
payAfterFreeTrial?:
|
|
1717
|
+
payAfterFreeTrial?: ConvertedMoney;
|
|
1725
1718
|
}
|
|
1726
1719
|
interface GiftCardSummary {
|
|
1727
1720
|
/**
|
|
@@ -1730,7 +1723,7 @@ interface GiftCardSummary {
|
|
|
1730
1723
|
*/
|
|
1731
1724
|
giftCardId?: string;
|
|
1732
1725
|
/** The amount to be reduced from the gift card's balance. */
|
|
1733
|
-
redeemAmount?:
|
|
1726
|
+
redeemAmount?: ConvertedMoney;
|
|
1734
1727
|
}
|
|
1735
1728
|
interface Membership {
|
|
1736
1729
|
/**
|
|
@@ -2195,7 +2188,7 @@ interface CustomItemPaymentConfig {
|
|
|
2195
2188
|
* Partial payment to be paid upfront during the checkout.
|
|
2196
2189
|
* Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
2197
2190
|
*/
|
|
2198
|
-
depositAmount?:
|
|
2191
|
+
depositAmount?: ConvertedMoney;
|
|
2199
2192
|
/**
|
|
2200
2193
|
* Type of selected payment option for current item.
|
|
2201
2194
|
*
|
|
@@ -2901,7 +2894,7 @@ interface HeadersEntry {
|
|
|
2901
2894
|
* @returns The created Cart.
|
|
2902
2895
|
* @fqn wix.ecom.cart.v2.CartService.CreateCart
|
|
2903
2896
|
*/
|
|
2904
|
-
declare function createCart(options?: NonNullablePaths<CreateCartOptions, `catalogItems.${number}.catalogReference` | `catalogItems.${number}.quantity` | `catalogItems.${number}.selectedMembership._id` | `catalogItems.${number}.selectedMembership.appId` | `customItems.${number}.attributes.descriptionLines.${number}.name` | `customItems.${number}.name` | `customItems.${number}.pricing` | `customItems.${number}.pricing.price` | `customItems.${number}.quantityInfo` | `customItems.${number}.quantityInfo.requestedQuantity`, 7>): Promise<NonNullablePaths<Cart, `_id` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.name.original` | `lineItems.${number}.quantityInfo.confirmedQuantity` | `lineItems.${number}.quantityInfo.requestedQuantity` | `lineItems.${number}.quantityInfo.fixedQuantity` | `lineItems.${number}.pricing.unitPrice.amount` | `lineItems.${number}.pricing.unitPrice.convertedAmount` | `lineItems.${number}.pricing.
|
|
2897
|
+
declare function createCart(options?: NonNullablePaths<CreateCartOptions, `catalogItems.${number}.catalogReference` | `catalogItems.${number}.quantity` | `catalogItems.${number}.selectedMembership._id` | `catalogItems.${number}.selectedMembership.appId` | `customItems.${number}.attributes.descriptionLines.${number}.name` | `customItems.${number}.name` | `customItems.${number}.pricing` | `customItems.${number}.pricing.price` | `customItems.${number}.quantityInfo` | `customItems.${number}.quantityInfo.requestedQuantity`, 7>): Promise<NonNullablePaths<Cart, `_id` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.name.original` | `lineItems.${number}.quantityInfo.confirmedQuantity` | `lineItems.${number}.quantityInfo.requestedQuantity` | `lineItems.${number}.quantityInfo.fixedQuantity` | `lineItems.${number}.pricing.unitPrice.amount` | `lineItems.${number}.pricing.unitPrice.convertedAmount` | `lineItems.${number}.pricing.priceDescription.original` | `lineItems.${number}.pricing.priceUndetermined` | `lineItems.${number}.source.catalogReference.catalogItemId` | `lineItems.${number}.source.catalogReference.appId` | `lineItems.${number}.attributes.itemType.preset` | `lineItems.${number}.attributes.itemType.custom` | `lineItems.${number}.attributes.physicalProperties.shippable` | `lineItems.${number}.attributes.membersOnly` | `lineItems.${number}.taxConfig.taxableAddress.addressType` | `lineItems.${number}.paymentConfig.savePaymentMethod` | `lineItems.${number}.paymentConfig.selectedMembership._id` | `lineItems.${number}.paymentConfig.selectedMembership.appId` | `lineItems.${number}.paymentConfig.paymentOption` | `lineItems.${number}.status` | `lineItems.${number}.customLineItem` | `coupons` | `coupons.${number}._id` | `coupons.${number}.code` | `source.channelType` | `source.externalReferences` | `source.externalReferences.${number}.appId` | `source.createdBy.visitorId` | `source.createdBy.memberId` | `source.createdBy.userId` | `source.createdBy.appId` | `source.customContentReference.appId` | `source.customContentReference.componentId` | `businessInfo.languageCode` | `businessInfo.currencyCode` | `customerInfo.visitorId` | `customerInfo.memberId` | `customerInfo.userId` | `customerInfo.vatId._id` | `customerInfo.vatId.type` | `customerInfo.languageCode` | `customerInfo.currencyCode` | `deliveryInfo.address.streetAddress.number` | `deliveryInfo.address.streetAddress.name` | `deliveryInfo.method.code` | `deliveryInfo.method.pickup` | `deliveryInfo.weightUnit` | `taxInfo.pricesIncludeTax` | `paymentInfo.giftCards` | `paymentInfo.giftCards.${number}._id` | `paymentInfo.giftCards.${number}.obfuscatedCode` | `paymentInfo.giftCards.${number}.appId` | `paymentInfo.currencyCode` | `orderPlaced` | `settings.lockGiftCard` | `settings.lockCouponCode` | `settings.policyAgreementCheckboxDisabled` | `settings.manualPaymentDisabled`, 6>>;
|
|
2905
2898
|
interface CreateCartOptions {
|
|
2906
2899
|
/** Cart to be created. */
|
|
2907
2900
|
cart?: Cart;
|
|
@@ -2948,7 +2941,7 @@ interface CreateCartOptions {
|
|
|
2948
2941
|
* @returns The requested Cart.
|
|
2949
2942
|
* @fqn wix.ecom.cart.v2.CartService.GetCart
|
|
2950
2943
|
*/
|
|
2951
|
-
declare function getCart(cartId: string): Promise<NonNullablePaths<Cart, `_id` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.name.original` | `lineItems.${number}.quantityInfo.confirmedQuantity` | `lineItems.${number}.quantityInfo.requestedQuantity` | `lineItems.${number}.quantityInfo.fixedQuantity` | `lineItems.${number}.pricing.unitPrice.amount` | `lineItems.${number}.pricing.unitPrice.convertedAmount` | `lineItems.${number}.pricing.
|
|
2944
|
+
declare function getCart(cartId: string): Promise<NonNullablePaths<Cart, `_id` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.name.original` | `lineItems.${number}.quantityInfo.confirmedQuantity` | `lineItems.${number}.quantityInfo.requestedQuantity` | `lineItems.${number}.quantityInfo.fixedQuantity` | `lineItems.${number}.pricing.unitPrice.amount` | `lineItems.${number}.pricing.unitPrice.convertedAmount` | `lineItems.${number}.pricing.priceDescription.original` | `lineItems.${number}.pricing.priceUndetermined` | `lineItems.${number}.source.catalogReference.catalogItemId` | `lineItems.${number}.source.catalogReference.appId` | `lineItems.${number}.attributes.itemType.preset` | `lineItems.${number}.attributes.itemType.custom` | `lineItems.${number}.attributes.physicalProperties.shippable` | `lineItems.${number}.attributes.membersOnly` | `lineItems.${number}.taxConfig.taxableAddress.addressType` | `lineItems.${number}.paymentConfig.savePaymentMethod` | `lineItems.${number}.paymentConfig.selectedMembership._id` | `lineItems.${number}.paymentConfig.selectedMembership.appId` | `lineItems.${number}.paymentConfig.paymentOption` | `lineItems.${number}.status` | `lineItems.${number}.customLineItem` | `coupons` | `coupons.${number}._id` | `coupons.${number}.code` | `source.channelType` | `source.externalReferences` | `source.externalReferences.${number}.appId` | `source.createdBy.visitorId` | `source.createdBy.memberId` | `source.createdBy.userId` | `source.createdBy.appId` | `source.customContentReference.appId` | `source.customContentReference.componentId` | `businessInfo.languageCode` | `businessInfo.currencyCode` | `customerInfo.visitorId` | `customerInfo.memberId` | `customerInfo.userId` | `customerInfo.vatId._id` | `customerInfo.vatId.type` | `customerInfo.languageCode` | `customerInfo.currencyCode` | `deliveryInfo.address.streetAddress.number` | `deliveryInfo.address.streetAddress.name` | `deliveryInfo.method.code` | `deliveryInfo.method.pickup` | `deliveryInfo.weightUnit` | `taxInfo.pricesIncludeTax` | `paymentInfo.giftCards` | `paymentInfo.giftCards.${number}._id` | `paymentInfo.giftCards.${number}.obfuscatedCode` | `paymentInfo.giftCards.${number}.appId` | `paymentInfo.currencyCode` | `orderPlaced` | `settings.lockGiftCard` | `settings.lockCouponCode` | `settings.policyAgreementCheckboxDisabled` | `settings.manualPaymentDisabled`, 6>>;
|
|
2952
2945
|
/**
|
|
2953
2946
|
* Updates a Cart.
|
|
2954
2947
|
*
|
|
@@ -2965,7 +2958,7 @@ declare function getCart(cartId: string): Promise<NonNullablePaths<Cart, `_id` |
|
|
|
2965
2958
|
* @returns Updated Cart.
|
|
2966
2959
|
* @fqn wix.ecom.cart.v2.CartService.UpdateCart
|
|
2967
2960
|
*/
|
|
2968
|
-
declare function updateCart(_id: string, cart: UpdateCart): Promise<NonNullablePaths<Cart, `_id` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.name.original` | `lineItems.${number}.quantityInfo.confirmedQuantity` | `lineItems.${number}.quantityInfo.requestedQuantity` | `lineItems.${number}.quantityInfo.fixedQuantity` | `lineItems.${number}.pricing.unitPrice.amount` | `lineItems.${number}.pricing.unitPrice.convertedAmount` | `lineItems.${number}.pricing.
|
|
2961
|
+
declare function updateCart(_id: string, cart: UpdateCart): Promise<NonNullablePaths<Cart, `_id` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.name.original` | `lineItems.${number}.quantityInfo.confirmedQuantity` | `lineItems.${number}.quantityInfo.requestedQuantity` | `lineItems.${number}.quantityInfo.fixedQuantity` | `lineItems.${number}.pricing.unitPrice.amount` | `lineItems.${number}.pricing.unitPrice.convertedAmount` | `lineItems.${number}.pricing.priceDescription.original` | `lineItems.${number}.pricing.priceUndetermined` | `lineItems.${number}.source.catalogReference.catalogItemId` | `lineItems.${number}.source.catalogReference.appId` | `lineItems.${number}.attributes.itemType.preset` | `lineItems.${number}.attributes.itemType.custom` | `lineItems.${number}.attributes.physicalProperties.shippable` | `lineItems.${number}.attributes.membersOnly` | `lineItems.${number}.taxConfig.taxableAddress.addressType` | `lineItems.${number}.paymentConfig.savePaymentMethod` | `lineItems.${number}.paymentConfig.selectedMembership._id` | `lineItems.${number}.paymentConfig.selectedMembership.appId` | `lineItems.${number}.paymentConfig.paymentOption` | `lineItems.${number}.status` | `lineItems.${number}.customLineItem` | `coupons` | `coupons.${number}._id` | `coupons.${number}.code` | `source.channelType` | `source.externalReferences` | `source.externalReferences.${number}.appId` | `source.createdBy.visitorId` | `source.createdBy.memberId` | `source.createdBy.userId` | `source.createdBy.appId` | `source.customContentReference.appId` | `source.customContentReference.componentId` | `businessInfo.languageCode` | `businessInfo.currencyCode` | `customerInfo.visitorId` | `customerInfo.memberId` | `customerInfo.userId` | `customerInfo.vatId._id` | `customerInfo.vatId.type` | `customerInfo.languageCode` | `customerInfo.currencyCode` | `deliveryInfo.address.streetAddress.number` | `deliveryInfo.address.streetAddress.name` | `deliveryInfo.method.code` | `deliveryInfo.method.pickup` | `deliveryInfo.weightUnit` | `taxInfo.pricesIncludeTax` | `paymentInfo.giftCards` | `paymentInfo.giftCards.${number}._id` | `paymentInfo.giftCards.${number}.obfuscatedCode` | `paymentInfo.giftCards.${number}.appId` | `paymentInfo.currencyCode` | `orderPlaced` | `settings.lockGiftCard` | `settings.lockCouponCode` | `settings.policyAgreementCheckboxDisabled` | `settings.manualPaymentDisabled`, 6>>;
|
|
2969
2962
|
interface UpdateCart {
|
|
2970
2963
|
/**
|
|
2971
2964
|
* Cart ID.
|
|
@@ -2997,7 +2990,7 @@ interface UpdateCart {
|
|
|
2997
2990
|
*/
|
|
2998
2991
|
lineItems?: V2LineItem[];
|
|
2999
2992
|
/** The sum of all line item final prices. */
|
|
3000
|
-
subtotal?:
|
|
2993
|
+
subtotal?: ConvertedMoney;
|
|
3001
2994
|
/**
|
|
3002
2995
|
* Optional message left by the customer.
|
|
3003
2996
|
* Usually intended for the merchant and contain special instructions, requests, or clarifications related to the order.
|
|
@@ -3083,7 +3076,7 @@ declare function deleteCart(cartId: string): Promise<void>;
|
|
|
3083
3076
|
* @permissionId ecom:v2:cart:refresh_cart
|
|
3084
3077
|
* @fqn wix.ecom.cart.v2.CartService.RefreshCart
|
|
3085
3078
|
*/
|
|
3086
|
-
declare function refreshCart(cartId: string): Promise<NonNullablePaths<RefreshCartResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3079
|
+
declare function refreshCart(cartId: string): Promise<NonNullablePaths<RefreshCartResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled`, 7>>;
|
|
3087
3080
|
/**
|
|
3088
3081
|
* Calculates the cart based on its current state (line items, discounts, delivery method, etc.)
|
|
3089
3082
|
* and returns a detailed summary including subtotal, delivery costs, taxes, fees and the total price.
|
|
@@ -3097,7 +3090,7 @@ declare function refreshCart(cartId: string): Promise<NonNullablePaths<RefreshCa
|
|
|
3097
3090
|
* @permissionId ecom:v2:cart:calculate_cart
|
|
3098
3091
|
* @fqn wix.ecom.cart.v2.CartService.CalculateCart
|
|
3099
3092
|
*/
|
|
3100
|
-
declare function calculateCart(cartId: string, options?: CalculateCartOptions): Promise<NonNullablePaths<CalculateCartResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3093
|
+
declare function calculateCart(cartId: string, options?: CalculateCartOptions): Promise<NonNullablePaths<CalculateCartResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled` | `summary.cartId` | `summary.lineItems` | `summary.lineItems.${number}.lineItemId` | `summary.lineItems.${number}.quantity` | `summary.lineItems.${number}.unitPrice.amount` | `summary.lineItems.${number}.unitPrice.convertedAmount` | `summary.discounts` | `summary.discounts.${number}.name.original` | `summary.discounts.${number}.source.sourceType` | `summary.discounts.${number}.scope` | `summary.deliverySummary.method.code` | `summary.deliverySummary.method.pickup` | `summary.additionalFees` | `summary.taxSummary.taxes` | `summary.taxSummary.pricesIncludeTax` | `summary.taxSummary.lineItemTaxes` | `summary.taxSummary.lineItemTaxes.${number}.lineItemId` | `summary.taxSummary.additionalFeeTaxes` | `summary.taxSummary.additionalFeeTaxes.${number}.additionalFeeCode` | `summary.paymentSummary.giftCards` | `summary.paymentSummary.giftCards.${number}.giftCardId` | `summary.paymentSummary.memberships` | `summary.paymentSummary.memberships.${number}._id` | `summary.paymentSummary.memberships.${number}.appId` | `summary.paymentSummary.subscriptionCharges` | `summary.paymentSummary.requiresPaymentAfterGiftCard` | `summary.calculationErrors.generalShippingCalculationError.applicationError.code` | `summary.calculationErrors.generalShippingCalculationError.applicationError.description` | `summary.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `summary.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `summary.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `summary.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `summary.calculationErrors.carrierErrors.errors` | `summary.calculationErrors.carrierErrors.errors.${number}.carrierId` | `summary.calculationErrors.orderValidationErrors` | `summary.spiViolations` | `summary.spiViolations.${number}.severity` | `summary.spiViolations.${number}.target.other.name` | `summary.spiViolations.${number}.target.lineItem.name`, 8>>;
|
|
3101
3094
|
interface CalculateCartOptions {
|
|
3102
3095
|
/**
|
|
3103
3096
|
* Specifies the level of **business validation** to perform during cart calculation,
|
|
@@ -3181,7 +3174,7 @@ interface PlaceOrderOptions {
|
|
|
3181
3174
|
* @applicableIdentity APP
|
|
3182
3175
|
* @fqn wix.ecom.cart.v2.CartService.AddLineItems
|
|
3183
3176
|
*/
|
|
3184
|
-
declare function addLineItems(cartId: string, options?: NonNullablePaths<AddLineItemsOptions, `catalogItems.${number}.catalogReference` | `catalogItems.${number}.quantity` | `catalogItems.${number}.selectedMembership._id` | `catalogItems.${number}.selectedMembership.appId` | `customItems.${number}.attributes.descriptionLines.${number}.name` | `customItems.${number}.name` | `customItems.${number}.pricing` | `customItems.${number}.pricing.price` | `customItems.${number}.quantityInfo` | `customItems.${number}.quantityInfo.requestedQuantity`, 7>): Promise<NonNullablePaths<AddLineItemsResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3177
|
+
declare function addLineItems(cartId: string, options?: NonNullablePaths<AddLineItemsOptions, `catalogItems.${number}.catalogReference` | `catalogItems.${number}.quantity` | `catalogItems.${number}.selectedMembership._id` | `catalogItems.${number}.selectedMembership.appId` | `customItems.${number}.attributes.descriptionLines.${number}.name` | `customItems.${number}.name` | `customItems.${number}.pricing` | `customItems.${number}.pricing.price` | `customItems.${number}.quantityInfo` | `customItems.${number}.quantityInfo.requestedQuantity`, 7>): Promise<NonNullablePaths<AddLineItemsResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled`, 7>>;
|
|
3185
3178
|
interface AddLineItemsOptions {
|
|
3186
3179
|
/**
|
|
3187
3180
|
* A list of catalog items to add to the cart.
|
|
@@ -3205,7 +3198,7 @@ interface AddLineItemsOptions {
|
|
|
3205
3198
|
* @permissionId ecom:v2:cart:update_cart
|
|
3206
3199
|
* @fqn wix.ecom.cart.v2.CartService.RemoveLineItems
|
|
3207
3200
|
*/
|
|
3208
|
-
declare function removeLineItems(cartId: string, lineItemIds: string[]): Promise<NonNullablePaths<RemoveLineItemsResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3201
|
+
declare function removeLineItems(cartId: string, lineItemIds: string[]): Promise<NonNullablePaths<RemoveLineItemsResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled`, 7>>;
|
|
3209
3202
|
/**
|
|
3210
3203
|
* Updates line items in the Cart.
|
|
3211
3204
|
* Use this endpoint to update line items properties such as quantity and selected membership.
|
|
@@ -3218,7 +3211,7 @@ declare function removeLineItems(cartId: string, lineItemIds: string[]): Promise
|
|
|
3218
3211
|
* @permissionId ecom:v2:cart:update_cart
|
|
3219
3212
|
* @fqn wix.ecom.cart.v2.CartService.UpdateLineItems
|
|
3220
3213
|
*/
|
|
3221
|
-
declare function updateLineItems(cartId: string, options?: NonNullablePaths<UpdateLineItemsOptions, `lineItems.${number}.lineItemId` | `lineItems.${number}.quantity.newQuantity`, 5>): Promise<NonNullablePaths<UpdateLineItemsResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3214
|
+
declare function updateLineItems(cartId: string, options?: NonNullablePaths<UpdateLineItemsOptions, `lineItems.${number}.lineItemId` | `lineItems.${number}.quantity.newQuantity`, 5>): Promise<NonNullablePaths<UpdateLineItemsResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled`, 7>>;
|
|
3222
3215
|
interface UpdateLineItemsOptions {
|
|
3223
3216
|
/**
|
|
3224
3217
|
* Line item updates to apply.
|
|
@@ -3240,7 +3233,7 @@ interface UpdateLineItemsOptions {
|
|
|
3240
3233
|
* @permissionId ecom:v2:cart:update_cart
|
|
3241
3234
|
* @fqn wix.ecom.cart.v2.CartService.AddCoupon
|
|
3242
3235
|
*/
|
|
3243
|
-
declare function addCoupon(cartId: string, couponCode: string): Promise<NonNullablePaths<AddCouponResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3236
|
+
declare function addCoupon(cartId: string, couponCode: string): Promise<NonNullablePaths<AddCouponResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled`, 7>>;
|
|
3244
3237
|
/**
|
|
3245
3238
|
* Removes a coupon from the Cart.
|
|
3246
3239
|
* @param cartId - Cart ID.
|
|
@@ -3252,7 +3245,7 @@ declare function addCoupon(cartId: string, couponCode: string): Promise<NonNulla
|
|
|
3252
3245
|
* @permissionId ecom:v2:cart:update_cart
|
|
3253
3246
|
* @fqn wix.ecom.cart.v2.CartService.RemoveCoupon
|
|
3254
3247
|
*/
|
|
3255
|
-
declare function removeCoupon(cartId: string, couponId: string): Promise<NonNullablePaths<RemoveCouponResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3248
|
+
declare function removeCoupon(cartId: string, couponId: string): Promise<NonNullablePaths<RemoveCouponResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled`, 7>>;
|
|
3256
3249
|
/**
|
|
3257
3250
|
* Adds a gift card to the Cart.
|
|
3258
3251
|
* Once added, the gift card’s balance will be used as a payment method during checkout, either partially or fully covering the cart total.
|
|
@@ -3267,7 +3260,7 @@ declare function removeCoupon(cartId: string, couponId: string): Promise<NonNull
|
|
|
3267
3260
|
* @permissionId ecom:v2:cart:update_cart
|
|
3268
3261
|
* @fqn wix.ecom.cart.v2.CartService.AddGiftCard
|
|
3269
3262
|
*/
|
|
3270
|
-
declare function addGiftCard(cartId: string, giftCardCode: string): Promise<NonNullablePaths<AddGiftCardResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3263
|
+
declare function addGiftCard(cartId: string, giftCardCode: string): Promise<NonNullablePaths<AddGiftCardResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled`, 7>>;
|
|
3271
3264
|
/**
|
|
3272
3265
|
* Removes a gift card from the Cart.
|
|
3273
3266
|
* @param cartId - Cart ID.
|
|
@@ -3279,7 +3272,7 @@ declare function addGiftCard(cartId: string, giftCardCode: string): Promise<NonN
|
|
|
3279
3272
|
* @permissionId ecom:v2:cart:update_cart
|
|
3280
3273
|
* @fqn wix.ecom.cart.v2.CartService.RemoveGiftCard
|
|
3281
3274
|
*/
|
|
3282
|
-
declare function removeGiftCard(cartId: string, giftCardId: string): Promise<NonNullablePaths<RemoveGiftCardResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3275
|
+
declare function removeGiftCard(cartId: string, giftCardId: string): Promise<NonNullablePaths<RemoveGiftCardResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled`, 7>>;
|
|
3283
3276
|
/**
|
|
3284
3277
|
* Marks the cart as completed. This means an order was created from the cart.
|
|
3285
3278
|
*
|
|
@@ -3291,7 +3284,7 @@ declare function removeGiftCard(cartId: string, giftCardId: string): Promise<Non
|
|
|
3291
3284
|
* @permissionId ecom:v2:cart:update_cart
|
|
3292
3285
|
* @fqn wix.ecom.cart.v2.CartService.MarkCartAsCompleted
|
|
3293
3286
|
*/
|
|
3294
|
-
declare function markCartAsCompleted(cartId: string, options?: MarkCartAsCompletedOptions): Promise<NonNullablePaths<MarkCartAsCompletedResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.
|
|
3287
|
+
declare function markCartAsCompleted(cartId: string, options?: MarkCartAsCompletedOptions): Promise<NonNullablePaths<MarkCartAsCompletedResponse, `cart._id` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled`, 7>>;
|
|
3295
3288
|
interface MarkCartAsCompletedOptions {
|
|
3296
3289
|
/**
|
|
3297
3290
|
* Order ID.
|
|
@@ -3313,4 +3306,4 @@ interface MarkCartAsCompletedOptions {
|
|
|
3313
3306
|
*/
|
|
3314
3307
|
declare function handleAsyncCheckoutCompletion(token: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`, 4>>;
|
|
3315
3308
|
|
|
3316
|
-
export { type ActionEvent, type AddCouponRequest, type AddCouponResponse, type AddCouponToCurrentCartRequest, type AddCouponToCurrentCartResponse, type AddGiftCardRequest, type AddGiftCardResponse, type AddGiftCardToCurrentCartRequest, type AddGiftCardToCurrentCartResponse, type AddLineItemsOptions, type AddLineItemsRequest, type AddLineItemsResponse, type AddLineItemsToCurrentCartRequest, type AddLineItemsToCurrentCartResponse, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type ApplicationError, type BusinessInfo, type CalculateCartOptions, type CalculateCartRequest, type CalculateCartResponse, type CalculateCurrentCartRequest, type CalculateCurrentCartResponse, type CalculationConfig, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type CarrierError, type CarrierErrors, type Cart, type CartSettings, type CartSource, type CartSummary, type CatalogItemInput, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, type Charge, type Color, type Coupon, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCurrentCartRequest, type CreateCurrentCartResponse, type CreatedBy, type CreatedByIdOneOf, type CustomContentReference, type CustomField, type CustomItemAttributes, type CustomItemDeliveryConfig, type CustomItemInput, type CustomItemPaymentConfig, type CustomItemPricingInfo, type CustomItemQuantityInfo, type CustomItemSource, type CustomItemTaxConfig, type CustomerInfo, type CustomerInfoIdOneOf, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeleteCurrentCartResponse, type DeliveryInfo, type DeliveryMethod, type DeliverySummary, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Discount, type DiscountBenefit, type DiscountBenefitValueOneOf, DiscountScope, type DiscountScopeWithLiterals, type DiscountSource, DiscountSourceType, type DiscountSourceTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type ExternalReference, type FieldViolation, FileType, type FileTypeWithLiterals, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartRequest, type GetCartResponse, type GetCheckoutURLRequest, type GetCheckoutURLResponse, type GetCheckoutUrlOptions, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardSummary, type Group, type HandleAsyncCheckoutCompletionRequest, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ItemAttributes, type ItemDeliveryConfig, type ItemDiscount, type ItemModifier, type ItemPaymentConfig, type ItemPriceBreakdown, type ItemPricingInfo, type ItemQuantityInfo, type ItemSource, ItemStatus, type ItemStatusWithLiterals, type ItemTaxConfig, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, type LegacyFields, type LineItem, type LineItemSummary, type LineItemTax, type LineItemUpdate, type MarkCartAsCompletedOptions, type MarkCartAsCompletedRequest, type MarkCartAsCompletedResponse, type Membership, type MessageEnvelope, type ModifierGroup,
|
|
3309
|
+
export { type ActionEvent, type AddCouponRequest, type AddCouponResponse, type AddCouponToCurrentCartRequest, type AddCouponToCurrentCartResponse, type AddGiftCardRequest, type AddGiftCardResponse, type AddGiftCardToCurrentCartRequest, type AddGiftCardToCurrentCartResponse, type AddLineItemsOptions, type AddLineItemsRequest, type AddLineItemsResponse, type AddLineItemsToCurrentCartRequest, type AddLineItemsToCurrentCartResponse, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type ApplicationError, type BusinessInfo, type CalculateCartOptions, type CalculateCartRequest, type CalculateCartResponse, type CalculateCurrentCartRequest, type CalculateCurrentCartResponse, type CalculationConfig, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type CarrierError, type CarrierErrors, type Cart, type CartSettings, type CartSource, type CartSummary, type CatalogItemInput, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, type Charge, type Color, type ConvertedMoney, type Coupon, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCurrentCartRequest, type CreateCurrentCartResponse, type CreatedBy, type CreatedByIdOneOf, type CustomContentReference, type CustomField, type CustomItemAttributes, type CustomItemDeliveryConfig, type CustomItemInput, type CustomItemPaymentConfig, type CustomItemPricingInfo, type CustomItemQuantityInfo, type CustomItemSource, type CustomItemTaxConfig, type CustomerInfo, type CustomerInfoIdOneOf, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeleteCurrentCartResponse, type DeliveryInfo, type DeliveryMethod, type DeliverySummary, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Discount, type DiscountBenefit, type DiscountBenefitValueOneOf, DiscountScope, type DiscountScopeWithLiterals, type DiscountSource, DiscountSourceType, type DiscountSourceTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type ExternalReference, type FieldViolation, FileType, type FileTypeWithLiterals, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartRequest, type GetCartResponse, type GetCheckoutURLRequest, type GetCheckoutURLResponse, type GetCheckoutUrlOptions, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardSummary, type Group, type HandleAsyncCheckoutCompletionRequest, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ItemAttributes, type ItemDeliveryConfig, type ItemDiscount, type ItemModifier, type ItemPaymentConfig, type ItemPriceBreakdown, type ItemPricingInfo, type ItemQuantityInfo, type ItemSource, ItemStatus, type ItemStatusWithLiterals, type ItemTaxConfig, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, type LegacyFields, type LineItem, type LineItemSummary, type LineItemTax, type LineItemUpdate, type MarkCartAsCompletedOptions, type MarkCartAsCompletedRequest, type MarkCartAsCompletedResponse, type Membership, type MessageEnvelope, type ModifierGroup, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type PaymentInfo, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PaymentSummary, type PhysicalProperties, type PlaceOrderOptions, type PlaceOrderRequest, type PlaceOrderResponse, type PlainTextValue, type Policy, type PriceDescription, type PriceSummary, type QuantityUpdate, type RawHttpResponse, type RedirectUrls, type RefreshCartRequest, type RefreshCartResponse, type RefreshCurrentCartRequest, type RefreshCurrentCartResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponFromCurrentCartResponse, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveGiftCardFromCurrentCartRequest, type RemoveGiftCardFromCurrentCartResponse, type RemoveGiftCardRequest, type RemoveGiftCardResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsFromCurrentCartResponse, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedMembership, type SelectedMembershipUpdate, type ServiceProperties, Severity, type SeverityWithLiterals, type StreetAddress, type SubscriptionCharges, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetTargetTypeOneOf, type Tax, type TaxDetails, type TaxInfo, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UpdateCart, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartRequest, type UpdateCurrentCartResponse, type UpdateLineItemsInCurrentCartRequest, type UpdateLineItemsInCurrentCartResponse, type UpdateLineItemsOptions, type UpdateLineItemsRequest, type UpdateLineItemsResponse, type V2AdditionalFee, type V2LineItem, type ValidationError, ValidationsConfig, type ValidationsConfigWithLiterals, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addCoupon, addGiftCard, addLineItems, calculateCart, createCart, deleteCart, getCart, getCheckoutUrl, handleAsyncCheckoutCompletion, markCartAsCompleted, placeOrder, refreshCart, removeCoupon, removeGiftCard, removeLineItems, updateCart, updateLineItems };
|