@wix/auto_sdk_ecom_cart-v-2 1.0.21 → 1.0.23
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 +76 -55
- package/build/cjs/index.js +2 -68
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -1
- package/build/cjs/index.typings.js +2 -68
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +64 -58
- package/build/cjs/meta.js +0 -68
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +76 -55
- package/build/es/index.mjs +2 -68
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1 -1
- package/build/es/index.typings.mjs +2 -68
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +64 -58
- package/build/es/meta.mjs +0 -68
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +14 -14
- package/build/internal/cjs/index.js +2 -68
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +89 -68
- package/build/internal/cjs/index.typings.js +2 -68
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +64 -58
- package/build/internal/cjs/meta.js +0 -68
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +14 -14
- package/build/internal/es/index.mjs +2 -68
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +89 -68
- package/build/internal/es/index.typings.mjs +2 -68
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +64 -58
- package/build/internal/es/meta.mjs +0 -68
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -30,8 +30,11 @@ interface Cart {
|
|
|
30
30
|
* @readonly
|
|
31
31
|
*/
|
|
32
32
|
lineItems?: V2LineItem[];
|
|
33
|
-
/**
|
|
34
|
-
|
|
33
|
+
/**
|
|
34
|
+
* The sum of all line item final prices.
|
|
35
|
+
* @readonly
|
|
36
|
+
*/
|
|
37
|
+
subtotal?: ConvertedMoney;
|
|
35
38
|
/**
|
|
36
39
|
* Optional message left by the customer.
|
|
37
40
|
* Usually intended for the merchant and contain special instructions, requests, or clarifications related to the order.
|
|
@@ -42,6 +45,7 @@ interface Cart {
|
|
|
42
45
|
* List of coupons added to the Cart.
|
|
43
46
|
* Currently, only one coupon code is supported.
|
|
44
47
|
* @maxSize 1
|
|
48
|
+
* @readonly
|
|
45
49
|
*/
|
|
46
50
|
coupons?: Coupon[];
|
|
47
51
|
/** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
|
|
@@ -197,12 +201,12 @@ interface ItemPricingInfo {
|
|
|
197
201
|
* Final unit price after applying automatic discounts.
|
|
198
202
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
199
203
|
*/
|
|
200
|
-
unitPrice?:
|
|
204
|
+
unitPrice?: ConvertedMoney;
|
|
201
205
|
/**
|
|
202
206
|
* Final total price for this item (unit price × quantity).
|
|
203
207
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
204
208
|
*/
|
|
205
|
-
totalPrice?:
|
|
209
|
+
totalPrice?: ConvertedMoney;
|
|
206
210
|
/**
|
|
207
211
|
* Additional description for the price.
|
|
208
212
|
* For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
|
|
@@ -213,28 +217,21 @@ interface ItemPricingInfo {
|
|
|
213
217
|
/** Detailed breakdown of price components. */
|
|
214
218
|
breakdown?: ItemPriceBreakdown;
|
|
215
219
|
}
|
|
216
|
-
interface
|
|
220
|
+
interface ConvertedMoney {
|
|
217
221
|
/**
|
|
218
|
-
*
|
|
219
|
-
* @
|
|
222
|
+
* Monetary amount in the original currency, as specified in `business_info.currency_code`.
|
|
223
|
+
* @format DECIMAL_VALUE
|
|
224
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
220
225
|
*/
|
|
221
226
|
amount?: string;
|
|
222
227
|
/**
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
228
|
+
* Monetary amount in the converted currency, as specified in `customer_info.currency_code`.
|
|
229
|
+
*
|
|
230
|
+
* Default: `amount`.
|
|
231
|
+
* @format DECIMAL_VALUE
|
|
232
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
226
233
|
*/
|
|
227
234
|
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
235
|
}
|
|
239
236
|
interface PriceDescription {
|
|
240
237
|
/**
|
|
@@ -257,17 +254,17 @@ interface ItemPriceBreakdown {
|
|
|
257
254
|
* Full catalog price of a single item before any discounts, including modifiers.
|
|
258
255
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
259
256
|
*/
|
|
260
|
-
fullPrice?:
|
|
257
|
+
fullPrice?: ConvertedMoney;
|
|
261
258
|
/**
|
|
262
259
|
* Catalog sale price of a single item, including modifiers.
|
|
263
260
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
264
261
|
*/
|
|
265
|
-
salePrice?:
|
|
262
|
+
salePrice?: ConvertedMoney;
|
|
266
263
|
/**
|
|
267
264
|
* Total price of all item modifiers for the entire quantity of this item.
|
|
268
265
|
* Includes tax if `tax_info.prices_include_tax` is true.
|
|
269
266
|
*/
|
|
270
|
-
totalModifiersPrice?:
|
|
267
|
+
totalModifiersPrice?: ConvertedMoney;
|
|
271
268
|
}
|
|
272
269
|
interface ItemSource {
|
|
273
270
|
/**
|
|
@@ -732,7 +729,7 @@ interface ItemPaymentConfig {
|
|
|
732
729
|
* Partial payment to be paid upfront during the checkout.
|
|
733
730
|
* Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
734
731
|
*/
|
|
735
|
-
depositAmount?:
|
|
732
|
+
depositAmount?: ConvertedMoney;
|
|
736
733
|
/**
|
|
737
734
|
* Selected membership to be used as payment for this item.
|
|
738
735
|
* Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`.
|
|
@@ -869,7 +866,7 @@ interface ItemModifier {
|
|
|
869
866
|
/** Additional details. */
|
|
870
867
|
details?: TranslatableString;
|
|
871
868
|
/** The price of the modifier. */
|
|
872
|
-
price?:
|
|
869
|
+
price?: ConvertedMoney;
|
|
873
870
|
}
|
|
874
871
|
/**
|
|
875
872
|
* Currently, only automatic discounts are applied to line items.
|
|
@@ -879,7 +876,7 @@ interface ItemDiscount {
|
|
|
879
876
|
/** The display name of the discount. */
|
|
880
877
|
name?: TranslatableString;
|
|
881
878
|
/** The amount discounted from the item's sale price (per unit). */
|
|
882
|
-
amountOff?:
|
|
879
|
+
amountOff?: ConvertedMoney;
|
|
883
880
|
}
|
|
884
881
|
interface Scope {
|
|
885
882
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
@@ -1413,9 +1410,9 @@ interface LegacyFields {
|
|
|
1413
1410
|
*/
|
|
1414
1411
|
appliedDiscounts?: Discount[];
|
|
1415
1412
|
/** The coupon discount amount. */
|
|
1416
|
-
couponDiscount?:
|
|
1413
|
+
couponDiscount?: ConvertedMoney;
|
|
1417
1414
|
/** The sum of all line items after applying all discounts. */
|
|
1418
|
-
subtotalAfterCouponDiscount?:
|
|
1415
|
+
subtotalAfterCouponDiscount?: ConvertedMoney;
|
|
1419
1416
|
}
|
|
1420
1417
|
interface Discount {
|
|
1421
1418
|
/** The display name of the discount. */
|
|
@@ -1470,7 +1467,7 @@ declare enum DiscountScope {
|
|
|
1470
1467
|
type DiscountScopeWithLiterals = DiscountScope | 'UNKNOWN_DISCOUNT_SCOPE' | 'CART_SUBTOTAL' | 'LINE_ITEM' | 'DELIVERY';
|
|
1471
1468
|
interface DiscountBenefit extends DiscountBenefitValueOneOf {
|
|
1472
1469
|
/** A specific monetary value deducted from the total cost. */
|
|
1473
|
-
amountOff?:
|
|
1470
|
+
amountOff?: ConvertedMoney;
|
|
1474
1471
|
/**
|
|
1475
1472
|
* The ID of line item that the discount applies to.
|
|
1476
1473
|
* Relevant for item-level discounts only.
|
|
@@ -1481,7 +1478,7 @@ interface DiscountBenefit extends DiscountBenefitValueOneOf {
|
|
|
1481
1478
|
/** @oneof */
|
|
1482
1479
|
interface DiscountBenefitValueOneOf {
|
|
1483
1480
|
/** A specific monetary value deducted from the total cost. */
|
|
1484
|
-
amountOff?:
|
|
1481
|
+
amountOff?: ConvertedMoney;
|
|
1485
1482
|
}
|
|
1486
1483
|
interface CartSummary {
|
|
1487
1484
|
/**
|
|
@@ -1556,12 +1553,12 @@ interface LineItemSummary {
|
|
|
1556
1553
|
* Final unit price after applying automatic discounts.
|
|
1557
1554
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1558
1555
|
*/
|
|
1559
|
-
unitPrice?:
|
|
1556
|
+
unitPrice?: ConvertedMoney;
|
|
1560
1557
|
/**
|
|
1561
1558
|
* Total price for the line item (unit price × quantity).
|
|
1562
1559
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1563
1560
|
*/
|
|
1564
|
-
totalPrice?:
|
|
1561
|
+
totalPrice?: ConvertedMoney;
|
|
1565
1562
|
}
|
|
1566
1563
|
interface DeliverySummary {
|
|
1567
1564
|
/** The calculated delivery method. */
|
|
@@ -1570,7 +1567,7 @@ interface DeliverySummary {
|
|
|
1570
1567
|
* Delivery price after discount.
|
|
1571
1568
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1572
1569
|
*/
|
|
1573
|
-
price?:
|
|
1570
|
+
price?: ConvertedMoney;
|
|
1574
1571
|
}
|
|
1575
1572
|
interface V2AdditionalFee {
|
|
1576
1573
|
/**
|
|
@@ -1598,7 +1595,7 @@ interface V2AdditionalFee {
|
|
|
1598
1595
|
* Additional fee's price.
|
|
1599
1596
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1600
1597
|
*/
|
|
1601
|
-
price?:
|
|
1598
|
+
price?: ConvertedMoney;
|
|
1602
1599
|
/**
|
|
1603
1600
|
* Number of subscription cycle this fee applies to.
|
|
1604
1601
|
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
@@ -1627,7 +1624,7 @@ interface TaxSummary {
|
|
|
1627
1624
|
*/
|
|
1628
1625
|
lineItemTaxes?: LineItemTax[];
|
|
1629
1626
|
/** Tax applied to the delivery method. */
|
|
1630
|
-
deliveryTax?:
|
|
1627
|
+
deliveryTax?: ConvertedMoney;
|
|
1631
1628
|
/**
|
|
1632
1629
|
* Taxes applied to additional fees.
|
|
1633
1630
|
* @maxSize 100
|
|
@@ -1638,16 +1635,16 @@ interface Tax {
|
|
|
1638
1635
|
/** The name of the tax. */
|
|
1639
1636
|
name?: TranslatableString;
|
|
1640
1637
|
/** Amount for which tax is calculated. */
|
|
1641
|
-
taxableAmount?:
|
|
1638
|
+
taxableAmount?: ConvertedMoney;
|
|
1642
1639
|
/** Amount that is exempt from tax. */
|
|
1643
|
-
exemptAmount?:
|
|
1640
|
+
exemptAmount?: ConvertedMoney;
|
|
1644
1641
|
/**
|
|
1645
1642
|
* Tax rate %, as a decimal point between 0 and 1.
|
|
1646
1643
|
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
1647
1644
|
*/
|
|
1648
1645
|
rate?: string | null;
|
|
1649
1646
|
/** Calculated tax, based on `taxable_amount` and `rate`. */
|
|
1650
|
-
amount?:
|
|
1647
|
+
amount?: ConvertedMoney;
|
|
1651
1648
|
}
|
|
1652
1649
|
interface LineItemTax {
|
|
1653
1650
|
/**
|
|
@@ -1656,7 +1653,7 @@ interface LineItemTax {
|
|
|
1656
1653
|
*/
|
|
1657
1654
|
lineItemId?: string;
|
|
1658
1655
|
/** Tax amount applied to the additional fee. */
|
|
1659
|
-
tax?:
|
|
1656
|
+
tax?: ConvertedMoney;
|
|
1660
1657
|
}
|
|
1661
1658
|
interface AdditionalFeeTax {
|
|
1662
1659
|
/**
|
|
@@ -1666,34 +1663,34 @@ interface AdditionalFeeTax {
|
|
|
1666
1663
|
*/
|
|
1667
1664
|
additionalFeeCode?: string;
|
|
1668
1665
|
/** Tax amount applied to the additional fee. */
|
|
1669
|
-
tax?:
|
|
1666
|
+
tax?: ConvertedMoney;
|
|
1670
1667
|
}
|
|
1671
1668
|
interface PriceSummary {
|
|
1672
1669
|
/**
|
|
1673
1670
|
* Total price of all line items after applying item-level discounts.
|
|
1674
1671
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1675
1672
|
*/
|
|
1676
|
-
subtotal?:
|
|
1673
|
+
subtotal?: ConvertedMoney;
|
|
1677
1674
|
/**
|
|
1678
1675
|
* Total cart-level discount applied to the subtotal.
|
|
1679
1676
|
* Line-item discounts are reflected in the subtotal and not included here.
|
|
1680
1677
|
* Currently supports only a single coupon.
|
|
1681
1678
|
*/
|
|
1682
|
-
discount?:
|
|
1679
|
+
discount?: ConvertedMoney;
|
|
1683
1680
|
/**
|
|
1684
1681
|
* Final delivery cost for the cart.
|
|
1685
1682
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1686
1683
|
*/
|
|
1687
|
-
delivery?:
|
|
1684
|
+
delivery?: ConvertedMoney;
|
|
1688
1685
|
/**
|
|
1689
1686
|
* Total additional fees associated with the cart.
|
|
1690
1687
|
* Includes tax if `tax_summary.prices_include_tax` is true.
|
|
1691
1688
|
*/
|
|
1692
|
-
additionalFees?:
|
|
1689
|
+
additionalFees?: ConvertedMoney;
|
|
1693
1690
|
/** Total tax amount calculated across all applicable components (items, discounts, delivery, and fees). */
|
|
1694
|
-
tax?:
|
|
1691
|
+
tax?: ConvertedMoney;
|
|
1695
1692
|
/** Total amount to be paid. */
|
|
1696
|
-
total?:
|
|
1693
|
+
total?: ConvertedMoney;
|
|
1697
1694
|
}
|
|
1698
1695
|
interface PaymentSummary {
|
|
1699
1696
|
/**
|
|
@@ -1715,13 +1712,13 @@ interface PaymentSummary {
|
|
|
1715
1712
|
/** Indicates whether a remaining payment is required to create the order, after applying gift cards. */
|
|
1716
1713
|
requiresPaymentAfterGiftCard?: boolean;
|
|
1717
1714
|
/** The total amount due after applying all gift cards. */
|
|
1718
|
-
totalAfterGiftCards?:
|
|
1715
|
+
totalAfterGiftCards?: ConvertedMoney;
|
|
1719
1716
|
/** The upfront amount to be charged immediately when placing the order (after applying gift cards). */
|
|
1720
|
-
payNow?:
|
|
1717
|
+
payNow?: ConvertedMoney;
|
|
1721
1718
|
/** The remaining amount to be collected later. */
|
|
1722
|
-
payLater?:
|
|
1719
|
+
payLater?: ConvertedMoney;
|
|
1723
1720
|
/** The amount to be charged after a free trial period (typically for subscription-based products). */
|
|
1724
|
-
payAfterFreeTrial?:
|
|
1721
|
+
payAfterFreeTrial?: ConvertedMoney;
|
|
1725
1722
|
}
|
|
1726
1723
|
interface GiftCardSummary {
|
|
1727
1724
|
/**
|
|
@@ -1730,7 +1727,7 @@ interface GiftCardSummary {
|
|
|
1730
1727
|
*/
|
|
1731
1728
|
giftCardId?: string;
|
|
1732
1729
|
/** The amount to be reduced from the gift card's balance. */
|
|
1733
|
-
redeemAmount?:
|
|
1730
|
+
redeemAmount?: ConvertedMoney;
|
|
1734
1731
|
}
|
|
1735
1732
|
interface Membership {
|
|
1736
1733
|
/**
|
|
@@ -2194,8 +2191,10 @@ interface CustomItemPaymentConfig {
|
|
|
2194
2191
|
/**
|
|
2195
2192
|
* Partial payment to be paid upfront during the checkout.
|
|
2196
2193
|
* Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
2194
|
+
* @format DECIMAL_VALUE
|
|
2195
|
+
* @decimalValue options { gte:0, lte:1000000000000000, maxScale:3 }
|
|
2197
2196
|
*/
|
|
2198
|
-
depositAmount?:
|
|
2197
|
+
depositAmount?: string | null;
|
|
2199
2198
|
/**
|
|
2200
2199
|
* Type of selected payment option for current item.
|
|
2201
2200
|
*
|
|
@@ -2232,6 +2231,12 @@ interface RefreshCurrentCartResponse {
|
|
|
2232
2231
|
cart?: Cart;
|
|
2233
2232
|
}
|
|
2234
2233
|
interface CalculateCurrentCartRequest {
|
|
2234
|
+
/**
|
|
2235
|
+
* Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before calculating the cart.
|
|
2236
|
+
*
|
|
2237
|
+
* Default: `false`
|
|
2238
|
+
*/
|
|
2239
|
+
refreshCart?: boolean;
|
|
2235
2240
|
/**
|
|
2236
2241
|
* Specifies the level of **business validation** to perform during cart calculation,
|
|
2237
2242
|
* by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
|
|
@@ -2619,6 +2624,12 @@ interface CalculateCartRequest {
|
|
|
2619
2624
|
* @format GUID
|
|
2620
2625
|
*/
|
|
2621
2626
|
cartId: string;
|
|
2627
|
+
/**
|
|
2628
|
+
* Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before calculating the cart.
|
|
2629
|
+
*
|
|
2630
|
+
* Default: `false`
|
|
2631
|
+
*/
|
|
2632
|
+
refreshCart?: boolean;
|
|
2622
2633
|
/**
|
|
2623
2634
|
* Specifies the level of **business validation** to perform during cart calculation,
|
|
2624
2635
|
* by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
|
|
@@ -2901,7 +2912,7 @@ interface HeadersEntry {
|
|
|
2901
2912
|
* @returns The created Cart.
|
|
2902
2913
|
* @fqn wix.ecom.cart.v2.CartService.CreateCart
|
|
2903
2914
|
*/
|
|
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.
|
|
2915
|
+
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
2916
|
interface CreateCartOptions {
|
|
2906
2917
|
/** Cart to be created. */
|
|
2907
2918
|
cart?: Cart;
|
|
@@ -2948,7 +2959,7 @@ interface CreateCartOptions {
|
|
|
2948
2959
|
* @returns The requested Cart.
|
|
2949
2960
|
* @fqn wix.ecom.cart.v2.CartService.GetCart
|
|
2950
2961
|
*/
|
|
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.
|
|
2962
|
+
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
2963
|
/**
|
|
2953
2964
|
* Updates a Cart.
|
|
2954
2965
|
*
|
|
@@ -2965,7 +2976,7 @@ declare function getCart(cartId: string): Promise<NonNullablePaths<Cart, `_id` |
|
|
|
2965
2976
|
* @returns Updated Cart.
|
|
2966
2977
|
* @fqn wix.ecom.cart.v2.CartService.UpdateCart
|
|
2967
2978
|
*/
|
|
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.
|
|
2979
|
+
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
2980
|
interface UpdateCart {
|
|
2970
2981
|
/**
|
|
2971
2982
|
* Cart ID.
|
|
@@ -2996,8 +3007,11 @@ interface UpdateCart {
|
|
|
2996
3007
|
* @readonly
|
|
2997
3008
|
*/
|
|
2998
3009
|
lineItems?: V2LineItem[];
|
|
2999
|
-
/**
|
|
3000
|
-
|
|
3010
|
+
/**
|
|
3011
|
+
* The sum of all line item final prices.
|
|
3012
|
+
* @readonly
|
|
3013
|
+
*/
|
|
3014
|
+
subtotal?: ConvertedMoney;
|
|
3001
3015
|
/**
|
|
3002
3016
|
* Optional message left by the customer.
|
|
3003
3017
|
* Usually intended for the merchant and contain special instructions, requests, or clarifications related to the order.
|
|
@@ -3008,6 +3022,7 @@ interface UpdateCart {
|
|
|
3008
3022
|
* List of coupons added to the Cart.
|
|
3009
3023
|
* Currently, only one coupon code is supported.
|
|
3010
3024
|
* @maxSize 1
|
|
3025
|
+
* @readonly
|
|
3011
3026
|
*/
|
|
3012
3027
|
coupons?: Coupon[];
|
|
3013
3028
|
/** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
|
|
@@ -3083,7 +3098,7 @@ declare function deleteCart(cartId: string): Promise<void>;
|
|
|
3083
3098
|
* @permissionId ecom:v2:cart:refresh_cart
|
|
3084
3099
|
* @fqn wix.ecom.cart.v2.CartService.RefreshCart
|
|
3085
3100
|
*/
|
|
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.
|
|
3101
|
+
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
3102
|
/**
|
|
3088
3103
|
* Calculates the cart based on its current state (line items, discounts, delivery method, etc.)
|
|
3089
3104
|
* and returns a detailed summary including subtotal, delivery costs, taxes, fees and the total price.
|
|
@@ -3097,8 +3112,14 @@ declare function refreshCart(cartId: string): Promise<NonNullablePaths<RefreshCa
|
|
|
3097
3112
|
* @permissionId ecom:v2:cart:calculate_cart
|
|
3098
3113
|
* @fqn wix.ecom.cart.v2.CartService.CalculateCart
|
|
3099
3114
|
*/
|
|
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.
|
|
3115
|
+
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
3116
|
interface CalculateCartOptions {
|
|
3117
|
+
/**
|
|
3118
|
+
* Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before calculating the cart.
|
|
3119
|
+
*
|
|
3120
|
+
* Default: `false`
|
|
3121
|
+
*/
|
|
3122
|
+
refreshCart?: boolean;
|
|
3102
3123
|
/**
|
|
3103
3124
|
* Specifies the level of **business validation** to perform during cart calculation,
|
|
3104
3125
|
* by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
|
|
@@ -3181,7 +3202,7 @@ interface PlaceOrderOptions {
|
|
|
3181
3202
|
* @applicableIdentity APP
|
|
3182
3203
|
* @fqn wix.ecom.cart.v2.CartService.AddLineItems
|
|
3183
3204
|
*/
|
|
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.
|
|
3205
|
+
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
3206
|
interface AddLineItemsOptions {
|
|
3186
3207
|
/**
|
|
3187
3208
|
* A list of catalog items to add to the cart.
|
|
@@ -3205,7 +3226,7 @@ interface AddLineItemsOptions {
|
|
|
3205
3226
|
* @permissionId ecom:v2:cart:update_cart
|
|
3206
3227
|
* @fqn wix.ecom.cart.v2.CartService.RemoveLineItems
|
|
3207
3228
|
*/
|
|
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.
|
|
3229
|
+
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
3230
|
/**
|
|
3210
3231
|
* Updates line items in the Cart.
|
|
3211
3232
|
* Use this endpoint to update line items properties such as quantity and selected membership.
|
|
@@ -3218,7 +3239,7 @@ declare function removeLineItems(cartId: string, lineItemIds: string[]): Promise
|
|
|
3218
3239
|
* @permissionId ecom:v2:cart:update_cart
|
|
3219
3240
|
* @fqn wix.ecom.cart.v2.CartService.UpdateLineItems
|
|
3220
3241
|
*/
|
|
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.
|
|
3242
|
+
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
3243
|
interface UpdateLineItemsOptions {
|
|
3223
3244
|
/**
|
|
3224
3245
|
* Line item updates to apply.
|
|
@@ -3240,7 +3261,7 @@ interface UpdateLineItemsOptions {
|
|
|
3240
3261
|
* @permissionId ecom:v2:cart:update_cart
|
|
3241
3262
|
* @fqn wix.ecom.cart.v2.CartService.AddCoupon
|
|
3242
3263
|
*/
|
|
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.
|
|
3264
|
+
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
3265
|
/**
|
|
3245
3266
|
* Removes a coupon from the Cart.
|
|
3246
3267
|
* @param cartId - Cart ID.
|
|
@@ -3252,7 +3273,7 @@ declare function addCoupon(cartId: string, couponCode: string): Promise<NonNulla
|
|
|
3252
3273
|
* @permissionId ecom:v2:cart:update_cart
|
|
3253
3274
|
* @fqn wix.ecom.cart.v2.CartService.RemoveCoupon
|
|
3254
3275
|
*/
|
|
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.
|
|
3276
|
+
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
3277
|
/**
|
|
3257
3278
|
* Adds a gift card to the Cart.
|
|
3258
3279
|
* 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 +3288,7 @@ declare function removeCoupon(cartId: string, couponId: string): Promise<NonNull
|
|
|
3267
3288
|
* @permissionId ecom:v2:cart:update_cart
|
|
3268
3289
|
* @fqn wix.ecom.cart.v2.CartService.AddGiftCard
|
|
3269
3290
|
*/
|
|
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.
|
|
3291
|
+
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
3292
|
/**
|
|
3272
3293
|
* Removes a gift card from the Cart.
|
|
3273
3294
|
* @param cartId - Cart ID.
|
|
@@ -3279,7 +3300,7 @@ declare function addGiftCard(cartId: string, giftCardCode: string): Promise<NonN
|
|
|
3279
3300
|
* @permissionId ecom:v2:cart:update_cart
|
|
3280
3301
|
* @fqn wix.ecom.cart.v2.CartService.RemoveGiftCard
|
|
3281
3302
|
*/
|
|
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.
|
|
3303
|
+
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
3304
|
/**
|
|
3284
3305
|
* Marks the cart as completed. This means an order was created from the cart.
|
|
3285
3306
|
*
|
|
@@ -3291,7 +3312,7 @@ declare function removeGiftCard(cartId: string, giftCardId: string): Promise<Non
|
|
|
3291
3312
|
* @permissionId ecom:v2:cart:update_cart
|
|
3292
3313
|
* @fqn wix.ecom.cart.v2.CartService.MarkCartAsCompleted
|
|
3293
3314
|
*/
|
|
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.
|
|
3315
|
+
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
3316
|
interface MarkCartAsCompletedOptions {
|
|
3296
3317
|
/**
|
|
3297
3318
|
* Order ID.
|
|
@@ -3313,4 +3334,4 @@ interface MarkCartAsCompletedOptions {
|
|
|
3313
3334
|
*/
|
|
3314
3335
|
declare function handleAsyncCheckoutCompletion(token: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`, 4>>;
|
|
3315
3336
|
|
|
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,
|
|
3337
|
+
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 };
|