@wix/auto_sdk_ecom_cart 1.0.171 → 1.0.172
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 +11 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +34 -12
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +2 -12
- package/build/cjs/meta.js +2 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +2 -2
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +11 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +34 -12
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +2 -12
- package/build/es/meta.mjs +2 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +2 -2
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +12 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +310 -12
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +528 -13
- package/build/internal/cjs/meta.js +2 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.js +2 -2
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +12 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +310 -12
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +528 -13
- package/build/internal/es/meta.mjs +2 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.mjs +2 -2
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -59,6 +59,26 @@ interface Cart {
|
|
|
59
59
|
* @readonly
|
|
60
60
|
*/
|
|
61
61
|
weightUnit?: WeightUnitWithLiterals;
|
|
62
|
+
/**
|
|
63
|
+
* Combined price of all line items before discounts. Subtotal includes tax if `cart.tax_included_in_prices` is set to `true`.
|
|
64
|
+
* @internal
|
|
65
|
+
* @readonly
|
|
66
|
+
*/
|
|
67
|
+
subtotal?: MultiCurrencyPrice;
|
|
68
|
+
/**
|
|
69
|
+
* Combined price of all line items after discounts.
|
|
70
|
+
* @internal
|
|
71
|
+
* @readonly
|
|
72
|
+
*/
|
|
73
|
+
subtotalAfterDiscounts?: MultiCurrencyPrice;
|
|
74
|
+
/**
|
|
75
|
+
* Total amount discounted from the cart.
|
|
76
|
+
*
|
|
77
|
+
* This includes coupon and merchant discounts.
|
|
78
|
+
* @internal
|
|
79
|
+
* @readonly
|
|
80
|
+
*/
|
|
81
|
+
discount?: MultiCurrencyPrice;
|
|
62
82
|
/**
|
|
63
83
|
* ID of the checkout that originated from this cart.
|
|
64
84
|
* @readonly
|
|
@@ -117,6 +137,12 @@ interface Cart {
|
|
|
117
137
|
* @format CURRENCY
|
|
118
138
|
*/
|
|
119
139
|
paymentCurrency?: string;
|
|
140
|
+
/**
|
|
141
|
+
* Indicates whether this cart is managed by Cart V2.
|
|
142
|
+
* @internal
|
|
143
|
+
* @readonly
|
|
144
|
+
*/
|
|
145
|
+
managedByV2?: boolean;
|
|
120
146
|
/**
|
|
121
147
|
* Revision number, which increments by 1 each time the Cart is updated.
|
|
122
148
|
* @readonly
|
|
@@ -156,6 +182,22 @@ interface LineItem {
|
|
|
156
182
|
* @readonly
|
|
157
183
|
*/
|
|
158
184
|
price?: MultiCurrencyPrice;
|
|
185
|
+
/**
|
|
186
|
+
* Original item price.
|
|
187
|
+
* @internal
|
|
188
|
+
* @format DECIMAL_VALUE
|
|
189
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
190
|
+
* @readonly
|
|
191
|
+
*/
|
|
192
|
+
originalPrice?: string | null;
|
|
193
|
+
/**
|
|
194
|
+
* Original item full price.
|
|
195
|
+
* @internal
|
|
196
|
+
* @format DECIMAL_VALUE
|
|
197
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
198
|
+
* @readonly
|
|
199
|
+
*/
|
|
200
|
+
originalFullPrice?: string | null;
|
|
159
201
|
/**
|
|
160
202
|
* Item price **before** catalog-defined discount. Defaults to `price` when not provided.
|
|
161
203
|
* @readonly
|
|
@@ -191,6 +233,13 @@ interface LineItem {
|
|
|
191
233
|
* @readonly
|
|
192
234
|
*/
|
|
193
235
|
physicalProperties?: PhysicalProperties;
|
|
236
|
+
/**
|
|
237
|
+
* Coupon scopes - which app and items a coupon applies to.
|
|
238
|
+
* This field is internal to Wix, and should be used by Bookings, Stores and Events as used by the current Coupons API.
|
|
239
|
+
* @internal
|
|
240
|
+
* @readonly
|
|
241
|
+
*/
|
|
242
|
+
couponScopes?: Scope[];
|
|
194
243
|
/**
|
|
195
244
|
* Item type. Either a preset type or custom.
|
|
196
245
|
* @readonly
|
|
@@ -201,6 +250,12 @@ interface LineItem {
|
|
|
201
250
|
* @readonly
|
|
202
251
|
*/
|
|
203
252
|
subscriptionOptionInfo?: SubscriptionOptionInfo;
|
|
253
|
+
/**
|
|
254
|
+
* Digital file identifier, relevant only for items with type DIGITAL.
|
|
255
|
+
* @internal
|
|
256
|
+
* @readonly
|
|
257
|
+
*/
|
|
258
|
+
digitalFile?: SecuredMedia;
|
|
204
259
|
/**
|
|
205
260
|
* Type of selected payment option for current item.
|
|
206
261
|
*
|
|
@@ -259,6 +314,17 @@ interface LineItem {
|
|
|
259
314
|
* @readonly
|
|
260
315
|
*/
|
|
261
316
|
consentRequiredPaymentPolicy?: string | null;
|
|
317
|
+
/**
|
|
318
|
+
* Deprecated. Use the `deliveryProfileId` instead.
|
|
319
|
+
* Shipping group ID.
|
|
320
|
+
* @internal
|
|
321
|
+
* @format GUID
|
|
322
|
+
* @readonly
|
|
323
|
+
* @deprecated Deprecated. Use the `deliveryProfileId` instead.
|
|
324
|
+
* Shipping group ID.
|
|
325
|
+
* @targetRemovalDate 2025-02-13
|
|
326
|
+
*/
|
|
327
|
+
shippingGroupId?: string | null;
|
|
262
328
|
/**
|
|
263
329
|
* Whether the price is not yet defined, and will be updated after the order is created.
|
|
264
330
|
* @readonly
|
|
@@ -321,6 +387,12 @@ interface LineItem {
|
|
|
321
387
|
* @readonly
|
|
322
388
|
*/
|
|
323
389
|
modifiersTotalPrice?: MultiCurrencyPrice;
|
|
390
|
+
/**
|
|
391
|
+
* Platform Fee associated with this line item.
|
|
392
|
+
* @internal
|
|
393
|
+
* @readonly
|
|
394
|
+
*/
|
|
395
|
+
platformFee?: PlatformFee;
|
|
324
396
|
}
|
|
325
397
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
326
398
|
interface CatalogReference {
|
|
@@ -401,8 +473,26 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
401
473
|
plainText?: PlainTextValue;
|
|
402
474
|
/** Description line color value. */
|
|
403
475
|
colorInfo?: Color;
|
|
476
|
+
/**
|
|
477
|
+
* Description line plain text value.
|
|
478
|
+
* @internal
|
|
479
|
+
* @deprecated
|
|
480
|
+
*/
|
|
481
|
+
plainTextValue?: PlainTextValue;
|
|
482
|
+
/**
|
|
483
|
+
* Description line color.
|
|
484
|
+
* @internal
|
|
485
|
+
* @deprecated
|
|
486
|
+
*/
|
|
487
|
+
color?: string;
|
|
404
488
|
/** Description line name. */
|
|
405
489
|
name?: DescriptionLineName;
|
|
490
|
+
/**
|
|
491
|
+
* Description line type.
|
|
492
|
+
* @internal
|
|
493
|
+
* @deprecated
|
|
494
|
+
*/
|
|
495
|
+
lineType?: DescriptionLineTypeWithLiterals;
|
|
406
496
|
}
|
|
407
497
|
/** @oneof */
|
|
408
498
|
interface DescriptionLineValueOneOf {
|
|
@@ -413,6 +503,18 @@ interface DescriptionLineValueOneOf {
|
|
|
413
503
|
}
|
|
414
504
|
/** @oneof */
|
|
415
505
|
interface DescriptionLineDescriptionLineValueOneOf {
|
|
506
|
+
/**
|
|
507
|
+
* Description line plain text value.
|
|
508
|
+
* @internal
|
|
509
|
+
* @deprecated
|
|
510
|
+
*/
|
|
511
|
+
plainTextValue?: PlainTextValue;
|
|
512
|
+
/**
|
|
513
|
+
* Description line color.
|
|
514
|
+
* @internal
|
|
515
|
+
* @deprecated
|
|
516
|
+
*/
|
|
517
|
+
color?: string;
|
|
416
518
|
}
|
|
417
519
|
interface DescriptionLineName {
|
|
418
520
|
/**
|
|
@@ -1044,6 +1146,13 @@ interface CartDiscount extends CartDiscountDiscountSourceOneOf {
|
|
|
1044
1146
|
* @internal
|
|
1045
1147
|
*/
|
|
1046
1148
|
discountRule?: DiscountRule;
|
|
1149
|
+
/**
|
|
1150
|
+
* IDs of line items the discount applies to.
|
|
1151
|
+
* @internal
|
|
1152
|
+
* @format GUID
|
|
1153
|
+
* @maxSize 300
|
|
1154
|
+
*/
|
|
1155
|
+
lineItemIds?: string[];
|
|
1047
1156
|
/**
|
|
1048
1157
|
* Discount type.
|
|
1049
1158
|
* @internal
|
|
@@ -1171,6 +1280,16 @@ interface StreetAddress {
|
|
|
1171
1280
|
number?: string;
|
|
1172
1281
|
/** Street name. */
|
|
1173
1282
|
name?: string;
|
|
1283
|
+
/**
|
|
1284
|
+
* Apartment number.
|
|
1285
|
+
* @internal
|
|
1286
|
+
*/
|
|
1287
|
+
apt?: string;
|
|
1288
|
+
/**
|
|
1289
|
+
* Optional address line 1
|
|
1290
|
+
* @internal
|
|
1291
|
+
*/
|
|
1292
|
+
formattedAddressLine?: string | null;
|
|
1174
1293
|
}
|
|
1175
1294
|
interface AddressLocation {
|
|
1176
1295
|
/** Address latitude. */
|
|
@@ -1284,6 +1403,11 @@ interface UpdateCartRequest {
|
|
|
1284
1403
|
* @maxSize 300
|
|
1285
1404
|
*/
|
|
1286
1405
|
customLineItems?: CustomLineItem[];
|
|
1406
|
+
/**
|
|
1407
|
+
* List of field names to determine which of cartInfo's fields will be updated
|
|
1408
|
+
* @internal
|
|
1409
|
+
*/
|
|
1410
|
+
cartFieldmask?: string[];
|
|
1287
1411
|
}
|
|
1288
1412
|
interface CustomLineItem {
|
|
1289
1413
|
/**
|
|
@@ -1353,6 +1477,16 @@ interface CustomLineItem {
|
|
|
1353
1477
|
quantityAvailable?: number | null;
|
|
1354
1478
|
/** Physical properties of the item. */
|
|
1355
1479
|
physicalProperties?: PhysicalProperties;
|
|
1480
|
+
/**
|
|
1481
|
+
* Subscription option info. This field is internal and only used by Stores.
|
|
1482
|
+
* @internal
|
|
1483
|
+
*/
|
|
1484
|
+
subscriptionOptionInfo?: SubscriptionOptionInfo;
|
|
1485
|
+
/**
|
|
1486
|
+
* Digital file ID and name. Required if `itemType: DIGITAL`.
|
|
1487
|
+
* @internal
|
|
1488
|
+
*/
|
|
1489
|
+
digitalFile?: SecuredMedia;
|
|
1356
1490
|
/**
|
|
1357
1491
|
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
1358
1492
|
*
|
|
@@ -1696,6 +1830,12 @@ interface LineItemPricesData {
|
|
|
1696
1830
|
interface ItemTaxFullDetails {
|
|
1697
1831
|
/** Amount for which tax is calculated. */
|
|
1698
1832
|
taxableAmount?: MultiCurrencyPrice;
|
|
1833
|
+
/**
|
|
1834
|
+
* Tax group ID, if specified.
|
|
1835
|
+
* @internal
|
|
1836
|
+
* @format GUID
|
|
1837
|
+
*/
|
|
1838
|
+
taxGroupId?: string | null;
|
|
1699
1839
|
/**
|
|
1700
1840
|
* Tax rate %, as a decimal point between 0 and 1.
|
|
1701
1841
|
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
@@ -1714,6 +1854,22 @@ interface ItemTaxFullDetails {
|
|
|
1714
1854
|
* @internal
|
|
1715
1855
|
*/
|
|
1716
1856
|
exemptAmount?: MultiCurrencyPrice;
|
|
1857
|
+
/**
|
|
1858
|
+
* True for items we have a tax applied on them
|
|
1859
|
+
* @internal
|
|
1860
|
+
*/
|
|
1861
|
+
isItemTaxable?: boolean | null;
|
|
1862
|
+
/**
|
|
1863
|
+
* True if the lineAmount include tax in it.
|
|
1864
|
+
* @internal
|
|
1865
|
+
*/
|
|
1866
|
+
isTaxIncluded?: boolean | null;
|
|
1867
|
+
/**
|
|
1868
|
+
* The calculator that calculated this line tax
|
|
1869
|
+
* @internal
|
|
1870
|
+
* @maxLength 25
|
|
1871
|
+
*/
|
|
1872
|
+
calculatorName?: string | null;
|
|
1717
1873
|
/**
|
|
1718
1874
|
* tax information for a line item.
|
|
1719
1875
|
* @maxSize 1000
|
|
@@ -1734,11 +1890,42 @@ interface TaxRateBreakdown {
|
|
|
1734
1890
|
rate?: string;
|
|
1735
1891
|
/** Amount of tax for this tax detail. */
|
|
1736
1892
|
tax?: MultiCurrencyPrice;
|
|
1893
|
+
/**
|
|
1894
|
+
* The type of tax that was calculated
|
|
1895
|
+
* @internal
|
|
1896
|
+
*/
|
|
1897
|
+
taxType?: string | null;
|
|
1898
|
+
/**
|
|
1899
|
+
* The name of the jurisdiction in which this tax detail applies
|
|
1900
|
+
* @internal
|
|
1901
|
+
*/
|
|
1902
|
+
jurisdiction?: string | null;
|
|
1903
|
+
/**
|
|
1904
|
+
* The type of the jurisdiction in which this tax detail applies(Country,State,County,City,Special).
|
|
1905
|
+
* @internal
|
|
1906
|
+
*/
|
|
1907
|
+
jurisdictionType?: string | null;
|
|
1737
1908
|
/**
|
|
1738
1909
|
* The amount of this line item that was exempt from this authority.
|
|
1739
1910
|
* @internal
|
|
1740
1911
|
*/
|
|
1741
1912
|
exemptAmount?: MultiCurrencyPrice;
|
|
1913
|
+
/**
|
|
1914
|
+
* ids of the used exemptions from the TaxEstimate exemptions array.
|
|
1915
|
+
* @internal
|
|
1916
|
+
* @maxSize 1000
|
|
1917
|
+
*/
|
|
1918
|
+
exemptionIds?: number[];
|
|
1919
|
+
/**
|
|
1920
|
+
* The taxable amount of this tax detail
|
|
1921
|
+
* @internal
|
|
1922
|
+
*/
|
|
1923
|
+
taxableAmount?: MultiCurrencyPrice;
|
|
1924
|
+
/**
|
|
1925
|
+
* The Taxes/Fee component. True if the fee is applied.
|
|
1926
|
+
* @internal
|
|
1927
|
+
*/
|
|
1928
|
+
isFee?: boolean | null;
|
|
1742
1929
|
}
|
|
1743
1930
|
/**
|
|
1744
1931
|
* TaxBreakdown represents tax information for a line item.
|
|
@@ -1867,17 +2054,45 @@ interface TaxSummary {
|
|
|
1867
2054
|
* @readonly
|
|
1868
2055
|
*/
|
|
1869
2056
|
totalTax?: MultiCurrencyPrice;
|
|
2057
|
+
/**
|
|
2058
|
+
* Manual tax rate
|
|
2059
|
+
* @internal
|
|
2060
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
2061
|
+
* @readonly
|
|
2062
|
+
* @deprecated
|
|
2063
|
+
*/
|
|
2064
|
+
manualTaxRate?: string;
|
|
1870
2065
|
/**
|
|
1871
2066
|
* Tax calculator that was active when the order was created.
|
|
1872
2067
|
* @deprecated
|
|
1873
2068
|
*/
|
|
1874
2069
|
calculationDetails?: TaxCalculationDetails;
|
|
2070
|
+
/**
|
|
2071
|
+
* Tax estimation id in tax service
|
|
2072
|
+
* @internal
|
|
2073
|
+
* @readonly
|
|
2074
|
+
*/
|
|
2075
|
+
taxEstimationId?: string | null;
|
|
2076
|
+
/**
|
|
2077
|
+
* Average Tax Rate
|
|
2078
|
+
* @internal
|
|
2079
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
2080
|
+
* @readonly
|
|
2081
|
+
*/
|
|
2082
|
+
averageTaxRate?: string | null;
|
|
1875
2083
|
/**
|
|
1876
2084
|
* The amount of this estimate that was exempt (for all line items).
|
|
1877
2085
|
* @internal
|
|
1878
2086
|
* @readonly
|
|
1879
2087
|
*/
|
|
1880
2088
|
totalExempt?: MultiCurrencyPrice;
|
|
2089
|
+
/**
|
|
2090
|
+
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
2091
|
+
* @internal
|
|
2092
|
+
* @readonly
|
|
2093
|
+
* @maxSize 50
|
|
2094
|
+
*/
|
|
2095
|
+
aggregatedTaxBreakdown?: AggregatedTaxBreakdown[];
|
|
1881
2096
|
/**
|
|
1882
2097
|
* Default name of the tax that was calculated.
|
|
1883
2098
|
* @internal
|
|
@@ -2061,6 +2276,11 @@ interface DeliveryLogistics {
|
|
|
2061
2276
|
instructions?: string | null;
|
|
2062
2277
|
/** Pickup details. */
|
|
2063
2278
|
pickupDetails?: PickupDetails;
|
|
2279
|
+
/**
|
|
2280
|
+
* Expected delivery time slot (from and to time stamps representation)
|
|
2281
|
+
* @internal
|
|
2282
|
+
*/
|
|
2283
|
+
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
2064
2284
|
}
|
|
2065
2285
|
interface PickupDetails {
|
|
2066
2286
|
/** Pickup address. */
|
|
@@ -2220,6 +2440,21 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
2220
2440
|
* @format GUID
|
|
2221
2441
|
*/
|
|
2222
2442
|
lineItemIds?: string[];
|
|
2443
|
+
/**
|
|
2444
|
+
* Discount ID.
|
|
2445
|
+
* @internal
|
|
2446
|
+
* @format GUID
|
|
2447
|
+
*/
|
|
2448
|
+
_id?: string | null;
|
|
2449
|
+
/**
|
|
2450
|
+
* Discount distribution.
|
|
2451
|
+
* Each entry contains the discount amount allocated to a specific line item.
|
|
2452
|
+
* Returned only when `apply_item_discounts_to_prices` is enabled.
|
|
2453
|
+
* @internal
|
|
2454
|
+
* @maxSize 300
|
|
2455
|
+
* @readonly
|
|
2456
|
+
*/
|
|
2457
|
+
lineItemDiscounts?: LineItemDiscount[];
|
|
2223
2458
|
/**
|
|
2224
2459
|
* Number of subscription cycle this discount applies to
|
|
2225
2460
|
* default None - all billing cycle
|
|
@@ -2265,6 +2500,12 @@ interface V1Coupon {
|
|
|
2265
2500
|
amount?: MultiCurrencyPrice;
|
|
2266
2501
|
/** Coupon name. */
|
|
2267
2502
|
name?: string;
|
|
2503
|
+
/**
|
|
2504
|
+
* Coupon type: We want it to be an enum and not a string but currently we have no time to do it so we leave it as is to be aligned with cart summary.
|
|
2505
|
+
* @internal
|
|
2506
|
+
* @deprecated
|
|
2507
|
+
*/
|
|
2508
|
+
couponType?: string;
|
|
2268
2509
|
}
|
|
2269
2510
|
interface V1MerchantDiscount {
|
|
2270
2511
|
/** Discount value. */
|
|
@@ -2560,12 +2801,7 @@ interface Membership {
|
|
|
2560
2801
|
lineItemIds?: string[];
|
|
2561
2802
|
/** Membership's payment credits (balance information). */
|
|
2562
2803
|
credits?: MembershipPaymentCredits;
|
|
2563
|
-
/**
|
|
2564
|
-
* Deprecated. Use `offering_description`.
|
|
2565
|
-
* @deprecated
|
|
2566
|
-
* @replacedBy offering_description
|
|
2567
|
-
* @targetRemovalDate 2026-08-30
|
|
2568
|
-
*/
|
|
2804
|
+
/** Membership expiration date. */
|
|
2569
2805
|
expirationDate?: Date | null;
|
|
2570
2806
|
/**
|
|
2571
2807
|
* Deprecated. Use `offering_description`.
|
|
@@ -2679,12 +2915,7 @@ interface V1Membership {
|
|
|
2679
2915
|
lineItemIds?: string[];
|
|
2680
2916
|
/** Membership's payment credits (balance information). */
|
|
2681
2917
|
credits?: MembershipPaymentCredits;
|
|
2682
|
-
/**
|
|
2683
|
-
* Membership expiration date.
|
|
2684
|
-
* @deprecated
|
|
2685
|
-
* @replacedBy offering_description
|
|
2686
|
-
* @targetRemovalDate 2026-08-30
|
|
2687
|
-
*/
|
|
2918
|
+
/** Membership expiration date. */
|
|
2688
2919
|
expirationDate?: Date | null;
|
|
2689
2920
|
/**
|
|
2690
2921
|
* Deprecated. Use `offering_description` for human-readable provider data.
|
|
@@ -3322,6 +3553,12 @@ interface GetCartRequest {
|
|
|
3322
3553
|
* @format GUID
|
|
3323
3554
|
*/
|
|
3324
3555
|
_id: string;
|
|
3556
|
+
/**
|
|
3557
|
+
* Whether to override default cart refresh behavior.
|
|
3558
|
+
* If `true`, always refreshes the cart; if `false`, never refreshes; if unset, uses the default refresh logic.
|
|
3559
|
+
* @internal
|
|
3560
|
+
*/
|
|
3561
|
+
refreshOverride?: boolean | null;
|
|
3325
3562
|
}
|
|
3326
3563
|
interface GetCartResponse {
|
|
3327
3564
|
/** Retrieved cart. */
|
|
@@ -3674,6 +3911,9 @@ declare function onCartCreated(handler: (event: CartCreatedEnvelope) => void | P
|
|
|
3674
3911
|
* @applicableIdentity APP
|
|
3675
3912
|
* @returns Cart.
|
|
3676
3913
|
* @fqn com.wix.ecom.cart.api.v1.CartService.CreateCart
|
|
3914
|
+
* @deprecated Replaced by Cart V2 Create Cart.
|
|
3915
|
+
* @replacedBy wix.ecom.cart.v2.CartService.CreateCart
|
|
3916
|
+
* @targetRemovalDate 2027-02-01
|
|
3677
3917
|
*/
|
|
3678
3918
|
declare function createCart(options?: NonNullablePaths<CreateCartOptions, `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.modifierGroups.${number}.modifiers.${number}.label` | `customLineItems.${number}.price` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.quantity` | `lineItems.${number}.selectedMembership._id` | `lineItems.${number}.selectedMembership.appId`, 8>): Promise<NonNullablePaths<Cart, `lineItems` | `lineItems.${number}.quantity` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.productName.original` | `lineItems.${number}.price.amount` | `lineItems.${number}.price.convertedAmount` | `lineItems.${number}.price.formattedAmount` | `lineItems.${number}.price.formattedConvertedAmount` | `lineItems.${number}.availability.status` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionOptionInfo.title.original` | `lineItems.${number}.subscriptionOptionInfo.description.original` | `lineItems.${number}.paymentOption` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.selectedMembership._id` | `lineItems.${number}.selectedMembership.appId` | `lineItems.${number}.customLineItem` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.catalogOverrideFields.paymentOption.value` | `lineItems.${number}.savePaymentMethod` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.membersOnly` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `buyerInfo.userId` | `currency` | `conversionCurrency` | `weightUnit` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `contactInfo.address.streetAddress.number` | `contactInfo.address.streetAddress.name` | `contactInfo.contactDetails.vatId._id` | `contactInfo.contactDetails.vatId.type` | `selectedShippingOption.code` | `paymentCurrency`, 6> & {
|
|
3679
3919
|
__applicationErrorsType?: CreateCartApplicationErrors;
|
|
@@ -3714,6 +3954,9 @@ interface CreateCartOptions {
|
|
|
3714
3954
|
* @applicableIdentity APP
|
|
3715
3955
|
* @returns Updated Cart.
|
|
3716
3956
|
* @fqn com.wix.ecom.cart.api.v1.CartService.UpdateCart
|
|
3957
|
+
* @deprecated Replaced by Cart V2 Update Cart.
|
|
3958
|
+
* @replacedBy wix.ecom.cart.v2.CartService.UpdateCart
|
|
3959
|
+
* @targetRemovalDate 2027-02-01
|
|
3717
3960
|
*/
|
|
3718
3961
|
declare function updateCart(_id: string, options?: NonNullablePaths<UpdateCartOptions, `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.modifierGroups.${number}.modifiers.${number}.label` | `customLineItems.${number}.productName` | `lineItems.${number}.catalogReference`, 8>): Promise<NonNullablePaths<Cart, `lineItems` | `lineItems.${number}.quantity` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.productName.original` | `lineItems.${number}.price.amount` | `lineItems.${number}.price.convertedAmount` | `lineItems.${number}.price.formattedAmount` | `lineItems.${number}.price.formattedConvertedAmount` | `lineItems.${number}.availability.status` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionOptionInfo.title.original` | `lineItems.${number}.subscriptionOptionInfo.description.original` | `lineItems.${number}.paymentOption` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.selectedMembership._id` | `lineItems.${number}.selectedMembership.appId` | `lineItems.${number}.customLineItem` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.catalogOverrideFields.paymentOption.value` | `lineItems.${number}.savePaymentMethod` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.membersOnly` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `buyerInfo.userId` | `currency` | `conversionCurrency` | `weightUnit` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `contactInfo.address.streetAddress.number` | `contactInfo.address.streetAddress.name` | `contactInfo.contactDetails.vatId._id` | `contactInfo.contactDetails.vatId.type` | `selectedShippingOption.code` | `paymentCurrency`, 6> & {
|
|
3719
3962
|
__applicationErrorsType?: UpdateCartApplicationErrors;
|
|
@@ -3778,6 +4021,26 @@ interface UpdateCartOptions {
|
|
|
3778
4021
|
* @readonly
|
|
3779
4022
|
*/
|
|
3780
4023
|
weightUnit?: WeightUnitWithLiterals;
|
|
4024
|
+
/**
|
|
4025
|
+
* Combined price of all line items before discounts. Subtotal includes tax if `cart.tax_included_in_prices` is set to `true`.
|
|
4026
|
+
* @internal
|
|
4027
|
+
* @readonly
|
|
4028
|
+
*/
|
|
4029
|
+
subtotal?: MultiCurrencyPrice;
|
|
4030
|
+
/**
|
|
4031
|
+
* Combined price of all line items after discounts.
|
|
4032
|
+
* @internal
|
|
4033
|
+
* @readonly
|
|
4034
|
+
*/
|
|
4035
|
+
subtotalAfterDiscounts?: MultiCurrencyPrice;
|
|
4036
|
+
/**
|
|
4037
|
+
* Total amount discounted from the cart.
|
|
4038
|
+
*
|
|
4039
|
+
* This includes coupon and merchant discounts.
|
|
4040
|
+
* @internal
|
|
4041
|
+
* @readonly
|
|
4042
|
+
*/
|
|
4043
|
+
discount?: MultiCurrencyPrice;
|
|
3781
4044
|
/**
|
|
3782
4045
|
* ID of the checkout that originated from this cart.
|
|
3783
4046
|
* @readonly
|
|
@@ -3836,6 +4099,12 @@ interface UpdateCartOptions {
|
|
|
3836
4099
|
* @format CURRENCY
|
|
3837
4100
|
*/
|
|
3838
4101
|
paymentCurrency?: string;
|
|
4102
|
+
/**
|
|
4103
|
+
* Indicates whether this cart is managed by Cart V2.
|
|
4104
|
+
* @internal
|
|
4105
|
+
* @readonly
|
|
4106
|
+
*/
|
|
4107
|
+
managedByV2?: boolean;
|
|
3839
4108
|
/**
|
|
3840
4109
|
* Revision number, which increments by 1 each time the Cart is updated.
|
|
3841
4110
|
* @readonly
|
|
@@ -3867,6 +4136,9 @@ interface UpdateCartOptions {
|
|
|
3867
4136
|
* @applicableIdentity APP
|
|
3868
4137
|
* @returns Retrieved cart.
|
|
3869
4138
|
* @fqn com.wix.ecom.cart.api.v1.CartService.GetCart
|
|
4139
|
+
* @deprecated Replaced by Cart V2 Get Cart.
|
|
4140
|
+
* @replacedBy wix.ecom.cart.v2.CartService.GetCart
|
|
4141
|
+
* @targetRemovalDate 2027-02-01
|
|
3870
4142
|
*/
|
|
3871
4143
|
declare function getCart(_id: string): Promise<NonNullablePaths<Cart, `lineItems` | `lineItems.${number}.quantity` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.productName.original` | `lineItems.${number}.price.amount` | `lineItems.${number}.price.convertedAmount` | `lineItems.${number}.price.formattedAmount` | `lineItems.${number}.price.formattedConvertedAmount` | `lineItems.${number}.availability.status` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionOptionInfo.title.original` | `lineItems.${number}.subscriptionOptionInfo.description.original` | `lineItems.${number}.paymentOption` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.selectedMembership._id` | `lineItems.${number}.selectedMembership.appId` | `lineItems.${number}.customLineItem` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.catalogOverrideFields.paymentOption.value` | `lineItems.${number}.savePaymentMethod` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.membersOnly` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `buyerInfo.userId` | `currency` | `conversionCurrency` | `weightUnit` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `contactInfo.address.streetAddress.number` | `contactInfo.address.streetAddress.name` | `contactInfo.contactDetails.vatId._id` | `contactInfo.contactDetails.vatId.type` | `selectedShippingOption.code` | `paymentCurrency`, 6>>;
|
|
3872
4144
|
/**
|
|
@@ -3878,6 +4150,9 @@ declare function getCart(_id: string): Promise<NonNullablePaths<Cart, `lineItems
|
|
|
3878
4150
|
* @permissionId ECOM.READ_CARTS
|
|
3879
4151
|
* @applicableIdentity APP
|
|
3880
4152
|
* @fqn com.wix.ecom.cart.api.v1.CartService.GetCartByCheckoutId
|
|
4153
|
+
* @deprecated Replaced by Cart V2 Get Cart. In Cart V2 the cart ID is the checkout ID, so no separate lookup is needed.
|
|
4154
|
+
* @replacedBy wix.ecom.cart.v2.CartService.GetCart
|
|
4155
|
+
* @targetRemovalDate 2027-02-01
|
|
3881
4156
|
*/
|
|
3882
4157
|
declare function getCartByCheckoutId(_id: string): Promise<NonNullablePaths<GetCartByCheckoutIdResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `cart.lineItems.${number}.subscriptionOptionInfo.title.original` | `cart.lineItems.${number}.subscriptionOptionInfo.description.original` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency`, 7>>;
|
|
3883
4158
|
/**
|
|
@@ -3899,6 +4174,9 @@ declare function getCartByCheckoutId(_id: string): Promise<NonNullablePaths<GetC
|
|
|
3899
4174
|
* @permissionId ECOM.ADMIN_MODIFY_CARTS
|
|
3900
4175
|
* @applicableIdentity APP
|
|
3901
4176
|
* @fqn com.wix.ecom.cart.api.v1.CartService.AddToCart
|
|
4177
|
+
* @deprecated Replaced by Cart V2 Add Line Items.
|
|
4178
|
+
* @replacedBy wix.ecom.cart.v2.CartService.AddLineItems
|
|
4179
|
+
* @targetRemovalDate 2027-02-01
|
|
3902
4180
|
*/
|
|
3903
4181
|
declare function addToCart(_id: string, options?: NonNullablePaths<AddToCartOptions, `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.modifierGroups.${number}.modifiers.${number}.label` | `customLineItems.${number}.price` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.selectedMembership._id` | `lineItems.${number}.selectedMembership.appId`, 8>): Promise<NonNullablePaths<AddToCartResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `cart.lineItems.${number}.subscriptionOptionInfo.title.original` | `cart.lineItems.${number}.subscriptionOptionInfo.description.original` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency`, 7> & {
|
|
3904
4182
|
__applicationErrorsType?: AddToCartApplicationErrors;
|
|
@@ -3938,6 +4216,9 @@ interface AddToCartOptions {
|
|
|
3938
4216
|
* @permissionId ECOM.MODIFY_CARTS
|
|
3939
4217
|
* @applicableIdentity APP
|
|
3940
4218
|
* @fqn com.wix.ecom.cart.api.v1.CartService.RemoveLineItems
|
|
4219
|
+
* @deprecated Replaced by Cart V2 Remove Line Items.
|
|
4220
|
+
* @replacedBy wix.ecom.cart.v2.CartService.RemoveLineItems
|
|
4221
|
+
* @targetRemovalDate 2027-02-01
|
|
3941
4222
|
*/
|
|
3942
4223
|
declare function removeLineItems(_id: string, lineItemIds: string[]): Promise<NonNullablePaths<RemoveLineItemsResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `cart.lineItems.${number}.subscriptionOptionInfo.title.original` | `cart.lineItems.${number}.subscriptionOptionInfo.description.original` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency`, 7>>;
|
|
3943
4224
|
/**
|
|
@@ -3954,6 +4235,8 @@ declare function removeLineItems(_id: string, lineItemIds: string[]): Promise<No
|
|
|
3954
4235
|
* @permissionId ECOM.CREATE_CHECKOUT_FROM_CART
|
|
3955
4236
|
* @applicableIdentity APP
|
|
3956
4237
|
* @fqn com.wix.ecom.cart.api.v1.CartService.CreateCheckout
|
|
4238
|
+
* @deprecated Cart V2 has no equivalent method. Cart V2 has no separate checkout step: prepare the cart, then call Place Order directly.
|
|
4239
|
+
* @targetRemovalDate 2027-02-01
|
|
3957
4240
|
*/
|
|
3958
4241
|
declare function createCheckout(_id: string, options?: CreateCheckoutOptions): Promise<NonNullablePaths<CreateCheckoutResponse, `checkoutId`, 2> & {
|
|
3959
4242
|
__applicationErrorsType?: CreateCheckoutApplicationErrors;
|
|
@@ -3987,6 +4270,9 @@ interface CreateCheckoutOptions {
|
|
|
3987
4270
|
* @permissionId ECOM.MODIFY_CARTS
|
|
3988
4271
|
* @applicableIdentity APP
|
|
3989
4272
|
* @fqn com.wix.ecom.cart.api.v1.CartService.RemoveCoupon
|
|
4273
|
+
* @deprecated Replaced by Cart V2 Remove Coupon.
|
|
4274
|
+
* @replacedBy wix.ecom.cart.v2.CartService.RemoveCoupon
|
|
4275
|
+
* @targetRemovalDate 2027-02-01
|
|
3990
4276
|
*/
|
|
3991
4277
|
declare function removeCoupon(_id: string): Promise<NonNullablePaths<RemoveCouponResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `cart.lineItems.${number}.subscriptionOptionInfo.title.original` | `cart.lineItems.${number}.subscriptionOptionInfo.description.original` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency`, 7>>;
|
|
3992
4278
|
/**
|
|
@@ -4009,6 +4295,9 @@ declare function removeCoupon(_id: string): Promise<NonNullablePaths<RemoveCoupo
|
|
|
4009
4295
|
* @permissionId ECOM.MODIFY_CARTS
|
|
4010
4296
|
* @applicableIdentity APP
|
|
4011
4297
|
* @fqn com.wix.ecom.cart.api.v1.CartService.UpdateLineItemsQuantity
|
|
4298
|
+
* @deprecated Replaced by Cart V2 Update Line Items.
|
|
4299
|
+
* @replacedBy wix.ecom.cart.v2.CartService.UpdateLineItems
|
|
4300
|
+
* @targetRemovalDate 2027-02-01
|
|
4012
4301
|
*/
|
|
4013
4302
|
declare function updateLineItemsQuantity(_id: string, lineItems: LineItemQuantityUpdate[]): Promise<NonNullablePaths<UpdateLineItemsQuantityResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `cart.lineItems.${number}.subscriptionOptionInfo.title.original` | `cart.lineItems.${number}.subscriptionOptionInfo.description.original` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency`, 7>>;
|
|
4014
4303
|
/**
|
|
@@ -4024,6 +4313,9 @@ declare function updateLineItemsQuantity(_id: string, lineItems: LineItemQuantit
|
|
|
4024
4313
|
* @permissionId ECOM.READ_CARTS
|
|
4025
4314
|
* @applicableIdentity APP
|
|
4026
4315
|
* @fqn com.wix.ecom.cart.api.v1.CartService.EstimateTotals
|
|
4316
|
+
* @deprecated Replaced by Cart V2 Estimate Cart.
|
|
4317
|
+
* @replacedBy wix.ecom.cart.v2.CartService.EstimateCart
|
|
4318
|
+
* @targetRemovalDate 2027-02-01
|
|
4027
4319
|
*/
|
|
4028
4320
|
declare function estimateTotals(_id: string, options?: EstimateTotalsOptions): Promise<NonNullablePaths<EstimateTotalsResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `cart.lineItems.${number}.subscriptionOptionInfo.title.original` | `cart.lineItems.${number}.subscriptionOptionInfo.description.original` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency` | `calculatedLineItems` | `calculatedLineItems.${number}.lineItemId` | `calculatedLineItems.${number}.pricesBreakdown.totalPriceAfterTax.amount` | `calculatedLineItems.${number}.pricesBreakdown.totalPriceAfterTax.convertedAmount` | `calculatedLineItems.${number}.pricesBreakdown.totalPriceAfterTax.formattedAmount` | `calculatedLineItems.${number}.pricesBreakdown.totalPriceAfterTax.formattedConvertedAmount` | `calculatedLineItems.${number}.pricesBreakdown.taxDetails.taxRate` | `calculatedLineItems.${number}.paymentOption` | `calculatedLineItems.${number}.taxableAddress.addressType` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.convertedAmount` | `priceSummary.subtotal.formattedAmount` | `priceSummary.subtotal.formattedConvertedAmount` | `giftCard._id` | `giftCard.obfuscatedCode` | `giftCard.amount.amount` | `giftCard.amount.convertedAmount` | `giftCard.amount.formattedAmount` | `giftCard.amount.formattedConvertedAmount` | `giftCard.appId` | `taxSummary.taxableAmount.amount` | `taxSummary.taxableAmount.convertedAmount` | `taxSummary.taxableAmount.formattedAmount` | `taxSummary.taxableAmount.formattedConvertedAmount` | `taxSummary.calculationDetails.manualRateReason` | `taxSummary.calculationDetails.autoTaxFallbackDetails.fallbackReason` | `taxSummary.calculationDetails.autoTaxFallbackDetails.error.code` | `taxSummary.calculationDetails.autoTaxFallbackDetails.error.description` | `taxSummary.calculationDetails.rateType` | `shippingInfo.region._id` | `shippingInfo.region.name` | `shippingInfo.selectedCarrierServiceOption.code` | `shippingInfo.selectedCarrierServiceOption.title` | `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address.streetAddress.number` | `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address.streetAddress.name` | `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.businessLocation` | `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.pickupMethod` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.amount` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.convertedAmount` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.formattedAmount` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.formattedConvertedAmount` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.taxRate` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.rateBreakdown` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.rateBreakdown.${number}.name` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.rateBreakdown.${number}.rate` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.taxBreakdown` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.taxBreakdown.${number}.jurisdictionType` | `shippingInfo.selectedCarrierServiceOption.requestedShippingOption` | `shippingInfo.selectedCarrierServiceOption.otherCharges` | `shippingInfo.selectedCarrierServiceOption.otherCharges.${number}.type` | `shippingInfo.selectedCarrierServiceOption.deliveryAllocations` | `shippingInfo.selectedCarrierServiceOption.deliveryAllocations.${number}.deliveryCarrier.code` | `shippingInfo.carrierServiceOptions` | `shippingInfo.carrierServiceOptions.${number}.carrierId` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.convertedAmount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.coupon.amount.formattedConvertedAmount` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `calculationErrors.generalShippingCalculationError.applicationError.code` | `calculationErrors.generalShippingCalculationError.applicationError.description` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculationErrors.carrierErrors.errors` | `calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculationErrors.orderValidationErrors` | `weightUnit` | `currency` | `payNow.subtotal.amount` | `payNow.subtotal.convertedAmount` | `payNow.subtotal.formattedAmount` | `payNow.subtotal.formattedConvertedAmount` | `payLater.subtotal.amount` | `payLater.subtotal.convertedAmount` | `payLater.subtotal.formattedAmount` | `payLater.subtotal.formattedConvertedAmount` | `membershipOptions.eligibleMemberships` | `membershipOptions.eligibleMemberships.${number}._id` | `membershipOptions.eligibleMemberships.${number}.appId` | `membershipOptions.eligibleMemberships.${number}.name.original` | `membershipOptions.eligibleMemberships.${number}.credits.total` | `membershipOptions.eligibleMemberships.${number}.credits.remaining` | `membershipOptions.invalidMemberships` | `membershipOptions.invalidMemberships.${number}.reason` | `membershipOptions.selectedMemberships` | `membershipOptions.selectedMemberships.${number}._id` | `membershipOptions.selectedMemberships.${number}.appId` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.convertedAmount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.price.formattedConvertedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}.source` | `additionalFees.${number}.taxableAddress.addressType` | `violations` | `violations.${number}.severity` | `violations.${number}.target.other.name` | `violations.${number}.target.lineItem.name`, 8>>;
|
|
4029
4321
|
interface EstimateTotalsOptions {
|
|
@@ -4066,6 +4358,9 @@ interface EstimateTotalsOptions {
|
|
|
4066
4358
|
* @permissionId ECOM.MODIFY_CARTS
|
|
4067
4359
|
* @applicableIdentity APP
|
|
4068
4360
|
* @fqn com.wix.ecom.cart.api.v1.CartService.DeleteCart
|
|
4361
|
+
* @deprecated Replaced by Cart V2 Delete Cart.
|
|
4362
|
+
* @replacedBy wix.ecom.cart.v2.CartService.DeleteCart
|
|
4363
|
+
* @targetRemovalDate 2027-02-01
|
|
4069
4364
|
*/
|
|
4070
4365
|
declare function deleteCart(_id: string): Promise<void>;
|
|
4071
4366
|
/**
|
|
@@ -4076,6 +4371,9 @@ declare function deleteCart(_id: string): Promise<void>;
|
|
|
4076
4371
|
* @permissionId ECOM.MODIFY_CARTS
|
|
4077
4372
|
* @applicableIdentity APP
|
|
4078
4373
|
* @fqn com.wix.ecom.cart.api.v1.CartService.RemoveBusinessLocation
|
|
4374
|
+
* @deprecated Replaced by Cart V2 Update Cart. In Cart V2 the business location is `businessInfo.locationId` on the cart entity.
|
|
4375
|
+
* @replacedBy wix.ecom.cart.v2.CartService.UpdateCart
|
|
4376
|
+
* @targetRemovalDate 2027-02-01
|
|
4079
4377
|
*/
|
|
4080
4378
|
declare function removeBusinessLocation(_id: string): Promise<NonNullablePaths<RemoveBusinessLocationResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `cart.lineItems.${number}.subscriptionOptionInfo.title.original` | `cart.lineItems.${number}.subscriptionOptionInfo.description.original` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency`, 7>>;
|
|
4081
4379
|
|