@wix/auto_sdk_ecom_cart-v-2 1.0.0 → 1.0.1
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 +134 -147
- package/build/cjs/index.js +83 -90
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -1
- package/build/cjs/index.typings.js +71 -78
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +110 -127
- package/build/cjs/meta.js +50 -50
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +134 -147
- package/build/es/index.mjs +82 -88
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1 -1
- package/build/es/index.typings.mjs +70 -76
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +110 -127
- package/build/es/meta.mjs +49 -49
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +34 -32
- package/build/internal/cjs/index.js +83 -90
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +171 -182
- package/build/internal/cjs/index.typings.js +71 -78
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +110 -127
- package/build/internal/cjs/meta.js +50 -50
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +34 -32
- package/build/internal/es/index.mjs +82 -88
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +171 -182
- package/build/internal/es/index.typings.mjs +70 -76
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +110 -127
- package/build/internal/es/meta.mjs +49 -49
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -22,11 +22,6 @@ interface Cart {
|
|
|
22
22
|
* @readonly
|
|
23
23
|
*/
|
|
24
24
|
revision?: string | null;
|
|
25
|
-
/**
|
|
26
|
-
* Custom fields.
|
|
27
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
28
|
-
*/
|
|
29
|
-
extendedFields?: ExtendedFields;
|
|
30
25
|
/**
|
|
31
26
|
* Line items added to the Cart by the customer.
|
|
32
27
|
* This list may include both valid items (in stock) and invalid ones (e.g., out of stock).
|
|
@@ -35,6 +30,14 @@ interface Cart {
|
|
|
35
30
|
* @readonly
|
|
36
31
|
*/
|
|
37
32
|
lineItems?: V2LineItem[];
|
|
33
|
+
/** The sum of all line item final prices. */
|
|
34
|
+
subtotal?: MultiCurrencyPrice;
|
|
35
|
+
/**
|
|
36
|
+
* Optional message left by the customer.
|
|
37
|
+
* Usually intended for the merchant and contain special instructions, requests, or clarifications related to the order.
|
|
38
|
+
* @maxLength 1000
|
|
39
|
+
*/
|
|
40
|
+
note?: string | null;
|
|
38
41
|
/**
|
|
39
42
|
* The discounts of the Cart.
|
|
40
43
|
* Automatic discounts are removed from the Cart entirely when they are no longer valid.
|
|
@@ -46,7 +49,7 @@ interface Cart {
|
|
|
46
49
|
/** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
|
|
47
50
|
source?: CartSource;
|
|
48
51
|
/** Information about the site from which the Cart's line items were added. */
|
|
49
|
-
|
|
52
|
+
businessInfo?: BusinessInfo;
|
|
50
53
|
/** Information about the customer that owns the Cart. */
|
|
51
54
|
customerInfo?: CustomerInfo;
|
|
52
55
|
/** Delivery-related information associated with the Cart. */
|
|
@@ -56,15 +59,24 @@ interface Cart {
|
|
|
56
59
|
/** Payment-related information associated with the Cart. */
|
|
57
60
|
paymentInfo?: PaymentInfo;
|
|
58
61
|
/**
|
|
59
|
-
*
|
|
62
|
+
* Whether the Cart has been placed as an Order.
|
|
63
|
+
* Defaults to `false`.
|
|
64
|
+
* @readonly
|
|
65
|
+
*/
|
|
66
|
+
orderPlaced?: boolean;
|
|
67
|
+
/**
|
|
68
|
+
* The ID of the Order created from the Cart.
|
|
69
|
+
* This field is empty until the checkout process is completed.
|
|
70
|
+
* @format GUID
|
|
60
71
|
* @readonly
|
|
61
72
|
*/
|
|
62
|
-
|
|
73
|
+
orderId?: string | null;
|
|
63
74
|
/**
|
|
64
|
-
*
|
|
75
|
+
* Persistent ID that correlates between the Cart and the created Order (after the checkout is completed).
|
|
76
|
+
* @format GUID
|
|
65
77
|
* @readonly
|
|
66
78
|
*/
|
|
67
|
-
|
|
79
|
+
purchaseFlowId?: string | null;
|
|
68
80
|
/**
|
|
69
81
|
* Additional Cart settings.
|
|
70
82
|
*
|
|
@@ -73,7 +85,7 @@ interface Cart {
|
|
|
73
85
|
* > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
74
86
|
* @immutable
|
|
75
87
|
*/
|
|
76
|
-
|
|
88
|
+
settings?: CartSettings;
|
|
77
89
|
/**
|
|
78
90
|
* Custom checkout URL to redirect the customer to a checkout page.
|
|
79
91
|
* By default, customers are redirected to the standard Wix checkout page.
|
|
@@ -83,29 +95,10 @@ interface Cart {
|
|
|
83
95
|
*/
|
|
84
96
|
customCheckoutUrl?: string | null;
|
|
85
97
|
/**
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
* @format GUID
|
|
89
|
-
* @readonly
|
|
90
|
-
*/
|
|
91
|
-
orderId?: string | null;
|
|
92
|
-
/**
|
|
93
|
-
* Persistent ID that correlates between the Cart and the created Order (after the checkout is completed).
|
|
94
|
-
* @format GUID
|
|
95
|
-
* @readonly
|
|
96
|
-
*/
|
|
97
|
-
purchaseFlowId?: string | null;
|
|
98
|
-
}
|
|
99
|
-
interface ExtendedFields {
|
|
100
|
-
/**
|
|
101
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
102
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
103
|
-
*
|
|
104
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
105
|
-
*
|
|
106
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
98
|
+
* Custom fields.
|
|
99
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
107
100
|
*/
|
|
108
|
-
|
|
101
|
+
extendedFields?: ExtendedFields;
|
|
109
102
|
}
|
|
110
103
|
interface V2LineItem {
|
|
111
104
|
/**
|
|
@@ -148,10 +141,10 @@ interface V2LineItem {
|
|
|
148
141
|
*/
|
|
149
142
|
modifierGroups?: ModifierGroup[];
|
|
150
143
|
/**
|
|
151
|
-
* Whether the item
|
|
152
|
-
*
|
|
144
|
+
* Whether the line item is a custom line item.
|
|
145
|
+
* Custom line items don't trigger the Catalog service plugin.
|
|
153
146
|
*/
|
|
154
|
-
|
|
147
|
+
customLineItem?: boolean;
|
|
155
148
|
}
|
|
156
149
|
interface TranslatableString {
|
|
157
150
|
/**
|
|
@@ -190,7 +183,10 @@ interface ItemQuantityInfo {
|
|
|
190
183
|
requestedQuantity?: number;
|
|
191
184
|
/** The maximum quantity of items available for purchase. */
|
|
192
185
|
availableQuantity?: number | null;
|
|
193
|
-
/**
|
|
186
|
+
/**
|
|
187
|
+
* Whether the line item quantity is fixed and cannot be changed.
|
|
188
|
+
* Default: `false`.
|
|
189
|
+
*/
|
|
194
190
|
fixedQuantity?: boolean;
|
|
195
191
|
}
|
|
196
192
|
interface ItemPricingInfo {
|
|
@@ -273,11 +269,6 @@ interface ItemPriceBreakdown {
|
|
|
273
269
|
totalDiscount?: MultiCurrencyPrice;
|
|
274
270
|
}
|
|
275
271
|
interface ItemSource {
|
|
276
|
-
/**
|
|
277
|
-
* Whether the line item is a custom line item.
|
|
278
|
-
* Custom line items don't trigger the Catalog service plugin.
|
|
279
|
-
*/
|
|
280
|
-
customLineItem?: boolean;
|
|
281
272
|
/**
|
|
282
273
|
* Catalog and item reference.
|
|
283
274
|
* Holds IDs for the item and the catalog it came from, as well as further optional info.
|
|
@@ -513,6 +504,11 @@ interface ItemAttributes {
|
|
|
513
504
|
subscriptionInfo?: SubscriptionOptionInfo;
|
|
514
505
|
/** Service properties. When relevant, this contains information such as date and number of participants. */
|
|
515
506
|
serviceProperties?: ServiceProperties;
|
|
507
|
+
/**
|
|
508
|
+
* Whether the item can only be purchased by site members.
|
|
509
|
+
* Default: `false`
|
|
510
|
+
*/
|
|
511
|
+
membersOnly?: boolean;
|
|
516
512
|
}
|
|
517
513
|
interface Policy {
|
|
518
514
|
/**
|
|
@@ -762,16 +758,27 @@ interface V2SelectedMembership {
|
|
|
762
758
|
declare enum ItemStatus {
|
|
763
759
|
UNKNOWN_ITEM_STATUS = "UNKNOWN_ITEM_STATUS",
|
|
764
760
|
/** The item is available in the requested quantity. */
|
|
765
|
-
|
|
761
|
+
IN_STOCK = "IN_STOCK",
|
|
766
762
|
/** Only part of the requested quantity is available. */
|
|
767
|
-
|
|
763
|
+
PARTIALLY_IN_STOCK = "PARTIALLY_IN_STOCK",
|
|
768
764
|
/** The item is out of stock. */
|
|
769
765
|
OUT_OF_STOCK = "OUT_OF_STOCK",
|
|
770
766
|
/** The item is no longer exists in the catalog. */
|
|
771
|
-
|
|
767
|
+
REMOVED_FROM_CATALOG = "REMOVED_FROM_CATALOG"
|
|
772
768
|
}
|
|
773
769
|
/** @enumType */
|
|
774
|
-
type ItemStatusWithLiterals = ItemStatus | 'UNKNOWN_ITEM_STATUS' | '
|
|
770
|
+
type ItemStatusWithLiterals = ItemStatus | 'UNKNOWN_ITEM_STATUS' | 'IN_STOCK' | 'PARTIALLY_IN_STOCK' | 'OUT_OF_STOCK' | 'REMOVED_FROM_CATALOG';
|
|
771
|
+
interface ExtendedFields {
|
|
772
|
+
/**
|
|
773
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
774
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
775
|
+
*
|
|
776
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
777
|
+
*
|
|
778
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
779
|
+
*/
|
|
780
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
781
|
+
}
|
|
775
782
|
interface AdditionalFee {
|
|
776
783
|
/**
|
|
777
784
|
* Additional fee's unique code or ID.
|
|
@@ -1104,18 +1111,13 @@ interface CustomContentReference {
|
|
|
1104
1111
|
*/
|
|
1105
1112
|
componentId?: string;
|
|
1106
1113
|
}
|
|
1107
|
-
interface
|
|
1114
|
+
interface BusinessInfo {
|
|
1108
1115
|
/**
|
|
1109
1116
|
* The ID of the business location associated with the cart.
|
|
1110
1117
|
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1111
1118
|
* @format GUID
|
|
1112
1119
|
*/
|
|
1113
|
-
|
|
1114
|
-
/**
|
|
1115
|
-
* The business’s unit of weight measurement (e.g., KG, LB).
|
|
1116
|
-
* @readonly
|
|
1117
|
-
*/
|
|
1118
|
-
weightUnit?: WeightUnitWithLiterals;
|
|
1120
|
+
locationId?: string | null;
|
|
1119
1121
|
/**
|
|
1120
1122
|
* The business’s default language, represented as a two-letter ISO 639-1 code.
|
|
1121
1123
|
* @format LANGUAGE
|
|
@@ -1129,16 +1131,6 @@ interface SiteInfo {
|
|
|
1129
1131
|
*/
|
|
1130
1132
|
currencyCode?: string;
|
|
1131
1133
|
}
|
|
1132
|
-
declare enum WeightUnit {
|
|
1133
|
-
/** Weight unit can't be classified due to an error. */
|
|
1134
|
-
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1135
|
-
/** Kilograms. */
|
|
1136
|
-
KG = "KG",
|
|
1137
|
-
/** Pounds. */
|
|
1138
|
-
LB = "LB"
|
|
1139
|
-
}
|
|
1140
|
-
/** @enumType */
|
|
1141
|
-
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1142
1134
|
interface CustomerInfo extends CustomerInfoIdOneOf {
|
|
1143
1135
|
/**
|
|
1144
1136
|
* Site visitor ID (if site visitor is **not** a member).
|
|
@@ -1186,11 +1178,6 @@ interface CustomerInfo extends CustomerInfoIdOneOf {
|
|
|
1186
1178
|
* @readonly
|
|
1187
1179
|
*/
|
|
1188
1180
|
currencyCode?: string;
|
|
1189
|
-
/**
|
|
1190
|
-
* The [buyer note](https://support.wix.com/en/article/wix-stores-viewing-customer-notes) left by the customer.
|
|
1191
|
-
* @maxLength 1000
|
|
1192
|
-
*/
|
|
1193
|
-
buyerNote?: string | null;
|
|
1194
1181
|
}
|
|
1195
1182
|
/** @oneof */
|
|
1196
1183
|
interface CustomerInfoIdOneOf {
|
|
@@ -1221,6 +1208,11 @@ interface DeliveryInfo {
|
|
|
1221
1208
|
recipient?: FullAddressContactDetails;
|
|
1222
1209
|
/** The selected delivery method by the customer. */
|
|
1223
1210
|
method?: DeliveryMethod;
|
|
1211
|
+
/**
|
|
1212
|
+
* The unit of weight measurement when shipping items (e.g., KG, LB).
|
|
1213
|
+
* @readonly
|
|
1214
|
+
*/
|
|
1215
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
1224
1216
|
}
|
|
1225
1217
|
/** Physical address */
|
|
1226
1218
|
interface Address {
|
|
@@ -1350,6 +1342,16 @@ interface DeliveryMethod {
|
|
|
1350
1342
|
*/
|
|
1351
1343
|
pickup?: boolean;
|
|
1352
1344
|
}
|
|
1345
|
+
declare enum WeightUnit {
|
|
1346
|
+
/** Weight unit can't be classified due to an error. */
|
|
1347
|
+
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1348
|
+
/** Kilograms. */
|
|
1349
|
+
KG = "KG",
|
|
1350
|
+
/** Pounds. */
|
|
1351
|
+
LB = "LB"
|
|
1352
|
+
}
|
|
1353
|
+
/** @enumType */
|
|
1354
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1353
1355
|
interface TaxInfo {
|
|
1354
1356
|
/**
|
|
1355
1357
|
* Indicates whether tax is already included in prices (line items, discounts, delivery, additional fess).
|
|
@@ -1403,23 +1405,7 @@ interface GiftCard {
|
|
|
1403
1405
|
*/
|
|
1404
1406
|
externalId?: string | null;
|
|
1405
1407
|
}
|
|
1406
|
-
interface
|
|
1407
|
-
/** The sum of all line items after applying automatic discounts. */
|
|
1408
|
-
subtotal?: MultiCurrencyPrice;
|
|
1409
|
-
/** The coupon discount amount. Automatic discounts are not included in this amount. */
|
|
1410
|
-
discount?: MultiCurrencyPrice;
|
|
1411
|
-
/** The sum of all line items after applying all discounts. */
|
|
1412
|
-
discountedSubtotal?: MultiCurrencyPrice;
|
|
1413
|
-
}
|
|
1414
|
-
declare enum CartStatus {
|
|
1415
|
-
/** A new Cart. */
|
|
1416
|
-
CREATED = "CREATED",
|
|
1417
|
-
/** The checkout process is completed. */
|
|
1418
|
-
CHECKOUT_COMPLETED = "CHECKOUT_COMPLETED"
|
|
1419
|
-
}
|
|
1420
|
-
/** @enumType */
|
|
1421
|
-
type CartStatusWithLiterals = CartStatus | 'CREATED' | 'CHECKOUT_COMPLETED';
|
|
1422
|
-
interface CustomSettings {
|
|
1408
|
+
interface CartSettings {
|
|
1423
1409
|
/**
|
|
1424
1410
|
* Whether to restrict the option to add or remove a gift card on the checkout page.
|
|
1425
1411
|
* Default: `false`
|
|
@@ -1623,7 +1609,7 @@ interface AdditionalFeeTax {
|
|
|
1623
1609
|
interface PriceSummary {
|
|
1624
1610
|
/**
|
|
1625
1611
|
* Total price of all line items after applying item-level discounts.
|
|
1626
|
-
*
|
|
1612
|
+
* Before tax TODO: Change it to include tax if the 'prices_include_tax' flag is true.
|
|
1627
1613
|
*/
|
|
1628
1614
|
subtotal?: MultiCurrencyPrice;
|
|
1629
1615
|
/**
|
|
@@ -1634,20 +1620,17 @@ interface PriceSummary {
|
|
|
1634
1620
|
discount?: MultiCurrencyPrice;
|
|
1635
1621
|
/**
|
|
1636
1622
|
* Final delivery cost for the cart.
|
|
1637
|
-
*
|
|
1623
|
+
* Before tax TODO: Change it to include tax if the 'prices_include_tax' flag is true.
|
|
1638
1624
|
*/
|
|
1639
1625
|
delivery?: MultiCurrencyPrice;
|
|
1640
1626
|
/**
|
|
1641
1627
|
* Total additional fees associated with the cart.
|
|
1642
|
-
*
|
|
1628
|
+
* Before tax TODO: Change it to include tax if the 'prices_include_tax' flag is true.
|
|
1643
1629
|
*/
|
|
1644
1630
|
additionalFees?: MultiCurrencyPrice;
|
|
1645
1631
|
/** Total tax amount calculated across all applicable components (items, discounts, delivery, and fees). */
|
|
1646
1632
|
tax?: MultiCurrencyPrice;
|
|
1647
|
-
/**
|
|
1648
|
-
* Total amount to be paid.
|
|
1649
|
-
* Curenntly, total = subtotal - discount + delivery + additional_fees + tax.
|
|
1650
|
-
*/
|
|
1633
|
+
/** Total amount to be paid. */
|
|
1651
1634
|
total?: MultiCurrencyPrice;
|
|
1652
1635
|
}
|
|
1653
1636
|
interface PaymentSummary {
|
|
@@ -1987,11 +1970,6 @@ interface CustomItemInput {
|
|
|
1987
1970
|
* @maxSize 25
|
|
1988
1971
|
*/
|
|
1989
1972
|
modifierGroups?: ModifierGroup[];
|
|
1990
|
-
/**
|
|
1991
|
-
* Whether the item can only be purchased by site members.
|
|
1992
|
-
* Default: `false`
|
|
1993
|
-
*/
|
|
1994
|
-
membersOnly?: boolean;
|
|
1995
1973
|
}
|
|
1996
1974
|
interface CustomItemQuantityInfo {
|
|
1997
1975
|
/**
|
|
@@ -2072,6 +2050,11 @@ interface CustomItemAttributes {
|
|
|
2072
2050
|
subscriptionInfo?: SubscriptionOptionInfo;
|
|
2073
2051
|
/** Service properties. When relevant, this contains information such as date and number of participants. */
|
|
2074
2052
|
serviceProperties?: ServiceProperties;
|
|
2053
|
+
/**
|
|
2054
|
+
* Whether the item can only be purchased by site members.
|
|
2055
|
+
* Default: `false`
|
|
2056
|
+
*/
|
|
2057
|
+
membersOnly?: boolean;
|
|
2075
2058
|
}
|
|
2076
2059
|
interface CustomItemDeliveryConfig {
|
|
2077
2060
|
/**
|
|
@@ -2217,7 +2200,7 @@ interface UpdateLineItemsInCurrentCartRequest {
|
|
|
2217
2200
|
* @minSize 1
|
|
2218
2201
|
* @maxSize 100
|
|
2219
2202
|
*/
|
|
2220
|
-
|
|
2203
|
+
lineItems?: LineItemUpdate[];
|
|
2221
2204
|
}
|
|
2222
2205
|
interface LineItemUpdate {
|
|
2223
2206
|
/**
|
|
@@ -2226,9 +2209,9 @@ interface LineItemUpdate {
|
|
|
2226
2209
|
*/
|
|
2227
2210
|
lineItemId?: string;
|
|
2228
2211
|
/** Quantity update (optional - if not provided, quantity is not updated) */
|
|
2229
|
-
|
|
2212
|
+
quantity?: QuantityUpdate;
|
|
2230
2213
|
/** Selected membership update (optional - if not provided, membership is not updated) */
|
|
2231
|
-
|
|
2214
|
+
selectedMembership?: SelectedMembershipUpdate;
|
|
2232
2215
|
}
|
|
2233
2216
|
interface QuantityUpdate {
|
|
2234
2217
|
/**
|
|
@@ -2236,7 +2219,7 @@ interface QuantityUpdate {
|
|
|
2236
2219
|
* @min 1
|
|
2237
2220
|
* @max 100000
|
|
2238
2221
|
*/
|
|
2239
|
-
|
|
2222
|
+
newQuantity?: number;
|
|
2240
2223
|
}
|
|
2241
2224
|
interface SelectedMembershipUpdate {
|
|
2242
2225
|
/**
|
|
@@ -2244,7 +2227,7 @@ interface SelectedMembershipUpdate {
|
|
|
2244
2227
|
*
|
|
2245
2228
|
* To just remove current selected membership, and not replace with a new one, pass an empty value here.
|
|
2246
2229
|
*/
|
|
2247
|
-
|
|
2230
|
+
newMembership?: V2SelectedMembership;
|
|
2248
2231
|
}
|
|
2249
2232
|
interface UpdateLineItemsInCurrentCartResponse {
|
|
2250
2233
|
/** Updated Cart. */
|
|
@@ -2554,7 +2537,7 @@ interface GetCheckoutURLResponse {
|
|
|
2554
2537
|
*/
|
|
2555
2538
|
checkoutUrl?: string;
|
|
2556
2539
|
}
|
|
2557
|
-
interface
|
|
2540
|
+
interface PlaceOrderRequest {
|
|
2558
2541
|
/**
|
|
2559
2542
|
* Cart ID.
|
|
2560
2543
|
* @format GUID
|
|
@@ -2596,7 +2579,7 @@ interface RedirectUrls {
|
|
|
2596
2579
|
*/
|
|
2597
2580
|
pendingUrl?: string | null;
|
|
2598
2581
|
}
|
|
2599
|
-
interface
|
|
2582
|
+
interface PlaceOrderResponse {
|
|
2600
2583
|
/**
|
|
2601
2584
|
* The order ID of the created order.
|
|
2602
2585
|
* @format GUID
|
|
@@ -2658,6 +2641,23 @@ interface RemoveLineItemsResponse {
|
|
|
2658
2641
|
/** Updated Cart. */
|
|
2659
2642
|
cart?: Cart;
|
|
2660
2643
|
}
|
|
2644
|
+
interface UpdateLineItemsRequest {
|
|
2645
|
+
/**
|
|
2646
|
+
* Cart ID.
|
|
2647
|
+
* @format GUID
|
|
2648
|
+
*/
|
|
2649
|
+
cartId: string;
|
|
2650
|
+
/**
|
|
2651
|
+
* Line item updates to apply.
|
|
2652
|
+
* @minSize 1
|
|
2653
|
+
* @maxSize 300
|
|
2654
|
+
*/
|
|
2655
|
+
lineItems?: LineItemUpdate[];
|
|
2656
|
+
}
|
|
2657
|
+
interface UpdateLineItemsResponse {
|
|
2658
|
+
/** Updated Cart. */
|
|
2659
|
+
cart?: Cart;
|
|
2660
|
+
}
|
|
2661
2661
|
interface AddDiscountRequest {
|
|
2662
2662
|
/**
|
|
2663
2663
|
* Cart ID.
|
|
@@ -2727,23 +2727,6 @@ interface RemoveGiftCardResponse {
|
|
|
2727
2727
|
/** Updated Cart. */
|
|
2728
2728
|
cart?: Cart;
|
|
2729
2729
|
}
|
|
2730
|
-
interface UpdateLineItemsRequest {
|
|
2731
|
-
/**
|
|
2732
|
-
* Cart ID.
|
|
2733
|
-
* @format GUID
|
|
2734
|
-
*/
|
|
2735
|
-
cartId: string;
|
|
2736
|
-
/**
|
|
2737
|
-
* Line item updates to apply.
|
|
2738
|
-
* @minSize 1
|
|
2739
|
-
* @maxSize 100
|
|
2740
|
-
*/
|
|
2741
|
-
lineItemUpdates?: LineItemUpdate[];
|
|
2742
|
-
}
|
|
2743
|
-
interface UpdateLineItemsResponse {
|
|
2744
|
-
/** Updated Cart. */
|
|
2745
|
-
cart?: Cart;
|
|
2746
|
-
}
|
|
2747
2730
|
interface MarkCartAsCompletedRequest {
|
|
2748
2731
|
/**
|
|
2749
2732
|
* Cart ID.
|
|
@@ -2796,7 +2779,7 @@ interface HeadersEntry {
|
|
|
2796
2779
|
* @returns The created Cart.
|
|
2797
2780
|
* @fqn wix.ecom.cart.v2.CartService.CreateCart
|
|
2798
2781
|
*/
|
|
2799
|
-
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.unitPrice.formattedAmount` | `lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `lineItems.${number}.pricing.priceDescription.original` | `lineItems.${number}.pricing.priceUndetermined` | `lineItems.${number}.source.
|
|
2782
|
+
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.unitPrice.formattedAmount` | `lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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` | `discounts` | `discounts.${number}._id` | `discounts.${number}.source.sourceType` | `discounts.${number}.scope` | `discounts.${number}.status` | `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.languageCode` | `customerInfo.currencyCode` | `deliveryInfo.address.streetAddress.number` | `deliveryInfo.address.streetAddress.name` | `deliveryInfo.recipient.vatId._id` | `deliveryInfo.recipient.vatId.type` | `deliveryInfo.method.appId` | `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>>;
|
|
2800
2783
|
interface CreateCartOptions {
|
|
2801
2784
|
/** Cart to be created. */
|
|
2802
2785
|
cart?: Cart;
|
|
@@ -2843,7 +2826,7 @@ interface CreateCartOptions {
|
|
|
2843
2826
|
* @returns The requested Cart.
|
|
2844
2827
|
* @fqn wix.ecom.cart.v2.CartService.GetCart
|
|
2845
2828
|
*/
|
|
2846
|
-
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.unitPrice.formattedAmount` | `lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `lineItems.${number}.pricing.priceDescription.original` | `lineItems.${number}.pricing.priceUndetermined` | `lineItems.${number}.source.
|
|
2829
|
+
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.unitPrice.formattedAmount` | `lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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` | `discounts` | `discounts.${number}._id` | `discounts.${number}.source.sourceType` | `discounts.${number}.scope` | `discounts.${number}.status` | `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.languageCode` | `customerInfo.currencyCode` | `deliveryInfo.address.streetAddress.number` | `deliveryInfo.address.streetAddress.name` | `deliveryInfo.recipient.vatId._id` | `deliveryInfo.recipient.vatId.type` | `deliveryInfo.method.appId` | `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>>;
|
|
2847
2830
|
/**
|
|
2848
2831
|
* Updates a Cart.
|
|
2849
2832
|
*
|
|
@@ -2860,7 +2843,7 @@ declare function getCart(cartId: string): Promise<NonNullablePaths<Cart, `_id` |
|
|
|
2860
2843
|
* @returns Updated Cart.
|
|
2861
2844
|
* @fqn wix.ecom.cart.v2.CartService.UpdateCart
|
|
2862
2845
|
*/
|
|
2863
|
-
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.unitPrice.formattedAmount` | `lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `lineItems.${number}.pricing.priceDescription.original` | `lineItems.${number}.pricing.priceUndetermined` | `lineItems.${number}.source.
|
|
2846
|
+
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.unitPrice.formattedAmount` | `lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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` | `discounts` | `discounts.${number}._id` | `discounts.${number}.source.sourceType` | `discounts.${number}.scope` | `discounts.${number}.status` | `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.languageCode` | `customerInfo.currencyCode` | `deliveryInfo.address.streetAddress.number` | `deliveryInfo.address.streetAddress.name` | `deliveryInfo.recipient.vatId._id` | `deliveryInfo.recipient.vatId.type` | `deliveryInfo.method.appId` | `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>>;
|
|
2864
2847
|
interface UpdateCart {
|
|
2865
2848
|
/**
|
|
2866
2849
|
* Cart ID.
|
|
@@ -2883,11 +2866,6 @@ interface UpdateCart {
|
|
|
2883
2866
|
* @readonly
|
|
2884
2867
|
*/
|
|
2885
2868
|
revision?: string | null;
|
|
2886
|
-
/**
|
|
2887
|
-
* Custom fields.
|
|
2888
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
2889
|
-
*/
|
|
2890
|
-
extendedFields?: ExtendedFields;
|
|
2891
2869
|
/**
|
|
2892
2870
|
* Line items added to the Cart by the customer.
|
|
2893
2871
|
* This list may include both valid items (in stock) and invalid ones (e.g., out of stock).
|
|
@@ -2896,6 +2874,14 @@ interface UpdateCart {
|
|
|
2896
2874
|
* @readonly
|
|
2897
2875
|
*/
|
|
2898
2876
|
lineItems?: V2LineItem[];
|
|
2877
|
+
/** The sum of all line item final prices. */
|
|
2878
|
+
subtotal?: MultiCurrencyPrice;
|
|
2879
|
+
/**
|
|
2880
|
+
* Optional message left by the customer.
|
|
2881
|
+
* Usually intended for the merchant and contain special instructions, requests, or clarifications related to the order.
|
|
2882
|
+
* @maxLength 1000
|
|
2883
|
+
*/
|
|
2884
|
+
note?: string | null;
|
|
2899
2885
|
/**
|
|
2900
2886
|
* The discounts of the Cart.
|
|
2901
2887
|
* Automatic discounts are removed from the Cart entirely when they are no longer valid.
|
|
@@ -2907,7 +2893,7 @@ interface UpdateCart {
|
|
|
2907
2893
|
/** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
|
|
2908
2894
|
source?: CartSource;
|
|
2909
2895
|
/** Information about the site from which the Cart's line items were added. */
|
|
2910
|
-
|
|
2896
|
+
businessInfo?: BusinessInfo;
|
|
2911
2897
|
/** Information about the customer that owns the Cart. */
|
|
2912
2898
|
customerInfo?: CustomerInfo;
|
|
2913
2899
|
/** Delivery-related information associated with the Cart. */
|
|
@@ -2917,15 +2903,24 @@ interface UpdateCart {
|
|
|
2917
2903
|
/** Payment-related information associated with the Cart. */
|
|
2918
2904
|
paymentInfo?: PaymentInfo;
|
|
2919
2905
|
/**
|
|
2920
|
-
*
|
|
2906
|
+
* Whether the Cart has been placed as an Order.
|
|
2907
|
+
* Defaults to `false`.
|
|
2921
2908
|
* @readonly
|
|
2922
2909
|
*/
|
|
2923
|
-
|
|
2910
|
+
orderPlaced?: boolean;
|
|
2924
2911
|
/**
|
|
2925
|
-
* The
|
|
2912
|
+
* The ID of the Order created from the Cart.
|
|
2913
|
+
* This field is empty until the checkout process is completed.
|
|
2914
|
+
* @format GUID
|
|
2926
2915
|
* @readonly
|
|
2927
2916
|
*/
|
|
2928
|
-
|
|
2917
|
+
orderId?: string | null;
|
|
2918
|
+
/**
|
|
2919
|
+
* Persistent ID that correlates between the Cart and the created Order (after the checkout is completed).
|
|
2920
|
+
* @format GUID
|
|
2921
|
+
* @readonly
|
|
2922
|
+
*/
|
|
2923
|
+
purchaseFlowId?: string | null;
|
|
2929
2924
|
/**
|
|
2930
2925
|
* Additional Cart settings.
|
|
2931
2926
|
*
|
|
@@ -2934,7 +2929,7 @@ interface UpdateCart {
|
|
|
2934
2929
|
* > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2935
2930
|
* @immutable
|
|
2936
2931
|
*/
|
|
2937
|
-
|
|
2932
|
+
settings?: CartSettings;
|
|
2938
2933
|
/**
|
|
2939
2934
|
* Custom checkout URL to redirect the customer to a checkout page.
|
|
2940
2935
|
* By default, customers are redirected to the standard Wix checkout page.
|
|
@@ -2944,18 +2939,10 @@ interface UpdateCart {
|
|
|
2944
2939
|
*/
|
|
2945
2940
|
customCheckoutUrl?: string | null;
|
|
2946
2941
|
/**
|
|
2947
|
-
*
|
|
2948
|
-
*
|
|
2949
|
-
* @format GUID
|
|
2950
|
-
* @readonly
|
|
2951
|
-
*/
|
|
2952
|
-
orderId?: string | null;
|
|
2953
|
-
/**
|
|
2954
|
-
* Persistent ID that correlates between the Cart and the created Order (after the checkout is completed).
|
|
2955
|
-
* @format GUID
|
|
2956
|
-
* @readonly
|
|
2942
|
+
* Custom fields.
|
|
2943
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
2957
2944
|
*/
|
|
2958
|
-
|
|
2945
|
+
extendedFields?: ExtendedFields;
|
|
2959
2946
|
}
|
|
2960
2947
|
/**
|
|
2961
2948
|
* Deletes a Cart.
|
|
@@ -2976,7 +2963,7 @@ declare function deleteCart(cartId: string): Promise<void>;
|
|
|
2976
2963
|
* @permissionId ecom:v2:cart:refresh_cart
|
|
2977
2964
|
* @fqn wix.ecom.cart.v2.CartService.RefreshCart
|
|
2978
2965
|
*/
|
|
2979
|
-
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.
|
|
2966
|
+
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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>>;
|
|
2980
2967
|
/**
|
|
2981
2968
|
* Calculates the cart based on its current state (line items, discounts, delivery method, etc.)
|
|
2982
2969
|
* and returns a detailed summary including subtotal, delivery costs, taxes, fees and the total price.
|
|
@@ -2990,7 +2977,7 @@ declare function refreshCart(cartId: string): Promise<NonNullablePaths<RefreshCa
|
|
|
2990
2977
|
* @permissionId ecom:v2:cart:calculate_cart
|
|
2991
2978
|
* @fqn wix.ecom.cart.v2.CartService.CalculateCart
|
|
2992
2979
|
*/
|
|
2993
|
-
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.
|
|
2980
|
+
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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.lineItems.${number}.unitPrice.formattedAmount` | `summary.lineItems.${number}.unitPrice.formattedConvertedAmount` | `summary.discounts` | `summary.discounts.${number}._id` | `summary.discounts.${number}.name.original` | `summary.discounts.${number}.source.sourceType` | `summary.discounts.${number}.scope` | `summary.discounts.${number}.status` | `summary.deliverySummary.method.appId` | `summary.deliverySummary.method.code` | `summary.deliverySummary.method.pickup` | `summary.additionalFees` | `summary.taxSummary.taxes` | `summary.taxSummary.taxes.${number}.rate` | `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.requiresPaymentAfterGiftCard` | `summary.errors` | `summary.errors.${number}.component` | `summary.errors.${number}.code` | `summary.violations` | `summary.violations.${number}.severity` | `summary.violations.${number}.target.other.name` | `summary.violations.${number}.target.lineItem.name`, 7>>;
|
|
2994
2981
|
interface CalculateCartOptions {
|
|
2995
2982
|
/**
|
|
2996
2983
|
* Specifies the level of **business validation** to perform during cart calculation,
|
|
@@ -3032,11 +3019,11 @@ interface GetCheckoutUrlOptions {
|
|
|
3032
3019
|
* @internal
|
|
3033
3020
|
* @documentationMaturity preview
|
|
3034
3021
|
* @requiredField cartId
|
|
3035
|
-
* @permissionId ecom:v2:cart:
|
|
3036
|
-
* @fqn wix.ecom.cart.v2.CartService.
|
|
3022
|
+
* @permissionId ecom:v2:cart:place_order
|
|
3023
|
+
* @fqn wix.ecom.cart.v2.CartService.PlaceOrder
|
|
3037
3024
|
*/
|
|
3038
|
-
declare function
|
|
3039
|
-
interface
|
|
3025
|
+
declare function placeOrder(cartId: string, options?: PlaceOrderOptions): Promise<NonNullablePaths<PlaceOrderResponse, `orderId` | `cartCompleted`, 2>>;
|
|
3026
|
+
interface PlaceOrderOptions {
|
|
3040
3027
|
/**
|
|
3041
3028
|
* The pricing token received from `CalculateCart`'s response.
|
|
3042
3029
|
* Used to verify that the prices shown to the customer have not changed before completing checkout.
|
|
@@ -3070,7 +3057,7 @@ interface CompleteCheckoutOptions {
|
|
|
3070
3057
|
* @applicableIdentity APP
|
|
3071
3058
|
* @fqn wix.ecom.cart.v2.CartService.AddLineItems
|
|
3072
3059
|
*/
|
|
3073
|
-
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.
|
|
3060
|
+
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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>>;
|
|
3074
3061
|
interface AddLineItemsOptions {
|
|
3075
3062
|
/**
|
|
3076
3063
|
* A list of catalog items to add to the cart.
|
|
@@ -3094,7 +3081,28 @@ interface AddLineItemsOptions {
|
|
|
3094
3081
|
* @permissionId ecom:v2:cart:update_cart
|
|
3095
3082
|
* @fqn wix.ecom.cart.v2.CartService.RemoveLineItems
|
|
3096
3083
|
*/
|
|
3097
|
-
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.
|
|
3084
|
+
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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>>;
|
|
3085
|
+
/**
|
|
3086
|
+
* Updates line items in the Cart.
|
|
3087
|
+
* Use this endpoint to update line items properties such as quantity and selected membership.
|
|
3088
|
+
* @param cartId - Cart ID.
|
|
3089
|
+
* @internal
|
|
3090
|
+
* @documentationMaturity preview
|
|
3091
|
+
* @requiredField cartId
|
|
3092
|
+
* @requiredField options.lineItems.lineItemId
|
|
3093
|
+
* @requiredField options.lineItems.quantity.newQuantity
|
|
3094
|
+
* @permissionId ecom:v2:cart:update_cart
|
|
3095
|
+
* @fqn wix.ecom.cart.v2.CartService.UpdateLineItems
|
|
3096
|
+
*/
|
|
3097
|
+
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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>>;
|
|
3098
|
+
interface UpdateLineItemsOptions {
|
|
3099
|
+
/**
|
|
3100
|
+
* Line item updates to apply.
|
|
3101
|
+
* @minSize 1
|
|
3102
|
+
* @maxSize 300
|
|
3103
|
+
*/
|
|
3104
|
+
lineItems?: LineItemUpdate[];
|
|
3105
|
+
}
|
|
3098
3106
|
/**
|
|
3099
3107
|
* Applies a discount to the Cart.
|
|
3100
3108
|
*
|
|
@@ -3110,7 +3118,7 @@ declare function removeLineItems(cartId: string, lineItemIds: string[]): Promise
|
|
|
3110
3118
|
* @permissionId ecom:v2:cart:update_cart
|
|
3111
3119
|
* @fqn wix.ecom.cart.v2.CartService.AddDiscount
|
|
3112
3120
|
*/
|
|
3113
|
-
declare function addDiscount(cartId: string, couponCode: string): Promise<NonNullablePaths<AddDiscountResponse, `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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.
|
|
3121
|
+
declare function addDiscount(cartId: string, couponCode: string): Promise<NonNullablePaths<AddDiscountResponse, `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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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>>;
|
|
3114
3122
|
/**
|
|
3115
3123
|
* Removes a discount from the Cart.
|
|
3116
3124
|
*
|
|
@@ -3124,7 +3132,7 @@ declare function addDiscount(cartId: string, couponCode: string): Promise<NonNul
|
|
|
3124
3132
|
* @permissionId ecom:v2:cart:update_cart
|
|
3125
3133
|
* @fqn wix.ecom.cart.v2.CartService.RemoveDiscount
|
|
3126
3134
|
*/
|
|
3127
|
-
declare function removeDiscount(cartId: string, discountId: string): Promise<NonNullablePaths<RemoveDiscountResponse, `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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.
|
|
3135
|
+
declare function removeDiscount(cartId: string, discountId: string): Promise<NonNullablePaths<RemoveDiscountResponse, `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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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>>;
|
|
3128
3136
|
/**
|
|
3129
3137
|
* Adds a gift card to the Cart.
|
|
3130
3138
|
* Once added, the gift card’s balance will be used as a payment method during checkout, either partially or fully covering the cart total.
|
|
@@ -3139,7 +3147,7 @@ declare function removeDiscount(cartId: string, discountId: string): Promise<Non
|
|
|
3139
3147
|
* @permissionId ecom:v2:cart:update_cart
|
|
3140
3148
|
* @fqn wix.ecom.cart.v2.CartService.AddGiftCard
|
|
3141
3149
|
*/
|
|
3142
|
-
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.
|
|
3150
|
+
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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>>;
|
|
3143
3151
|
/**
|
|
3144
3152
|
* Removes a gift card from the Cart.
|
|
3145
3153
|
* @param cartId - Cart ID.
|
|
@@ -3151,30 +3159,11 @@ declare function addGiftCard(cartId: string, giftCardCode: string): Promise<NonN
|
|
|
3151
3159
|
* @permissionId ecom:v2:cart:update_cart
|
|
3152
3160
|
* @fqn wix.ecom.cart.v2.CartService.RemoveGiftCard
|
|
3153
3161
|
*/
|
|
3154
|
-
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.
|
|
3162
|
+
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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>>;
|
|
3155
3163
|
/**
|
|
3156
|
-
*
|
|
3157
|
-
*
|
|
3158
|
-
*
|
|
3159
|
-
* @internal
|
|
3160
|
-
* @documentationMaturity preview
|
|
3161
|
-
* @requiredField cartId
|
|
3162
|
-
* @requiredField options.lineItemUpdates.lineItemId
|
|
3163
|
-
* @requiredField options.lineItemUpdates.quantityUpdate.quantity
|
|
3164
|
-
* @permissionId ecom:v2:cart:update_cart
|
|
3165
|
-
* @fqn wix.ecom.cart.v2.CartService.UpdateLineItems
|
|
3166
|
-
*/
|
|
3167
|
-
declare function updateLineItems(cartId: string, options?: NonNullablePaths<UpdateLineItemsOptions, `lineItemUpdates.${number}.lineItemId` | `lineItemUpdates.${number}.quantityUpdate.quantity`, 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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.customLineItem` | `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}.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}.membersOnly` | `cart.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.siteInfo.weightUnit` | `cart.siteInfo.languageCode` | `cart.siteInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `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.status` | `cart.customSettings.lockGiftCard` | `cart.customSettings.lockCouponCode` | `cart.customSettings.policyAgreementCheckboxDisabled` | `cart.customSettings.manualPaymentDisabled`, 7>>;
|
|
3168
|
-
interface UpdateLineItemsOptions {
|
|
3169
|
-
/**
|
|
3170
|
-
* Line item updates to apply.
|
|
3171
|
-
* @minSize 1
|
|
3172
|
-
* @maxSize 100
|
|
3173
|
-
*/
|
|
3174
|
-
lineItemUpdates?: LineItemUpdate[];
|
|
3175
|
-
}
|
|
3176
|
-
/**
|
|
3177
|
-
* Updates the Cart status to be completed.
|
|
3164
|
+
* Marks the cart as completed. This means an order was created from the cart.
|
|
3165
|
+
*
|
|
3166
|
+
* Sets the `orderPlaced` field to `true`.
|
|
3178
3167
|
* @param cartId - Cart ID.
|
|
3179
3168
|
* @internal
|
|
3180
3169
|
* @documentationMaturity preview
|
|
@@ -3182,7 +3171,7 @@ interface UpdateLineItemsOptions {
|
|
|
3182
3171
|
* @permissionId ecom:v2:cart:update_cart
|
|
3183
3172
|
* @fqn wix.ecom.cart.v2.CartService.MarkCartAsCompleted
|
|
3184
3173
|
*/
|
|
3185
|
-
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.
|
|
3174
|
+
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.unitPrice.formattedAmount` | `cart.lineItems.${number}.pricing.unitPrice.formattedConvertedAmount` | `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.discounts` | `cart.discounts.${number}._id` | `cart.discounts.${number}.source.sourceType` | `cart.discounts.${number}.scope` | `cart.discounts.${number}.status` | `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.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.recipient.vatId._id` | `cart.deliveryInfo.recipient.vatId.type` | `cart.deliveryInfo.method.appId` | `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>>;
|
|
3186
3175
|
interface MarkCartAsCompletedOptions {
|
|
3187
3176
|
/**
|
|
3188
3177
|
* Order ID.
|
|
@@ -3204,4 +3193,4 @@ interface MarkCartAsCompletedOptions {
|
|
|
3204
3193
|
*/
|
|
3205
3194
|
declare function handleAsyncCheckoutCompletion(token: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`, 4>>;
|
|
3206
3195
|
|
|
3207
|
-
export { type ActionEvent, type AddDiscountRequest, type AddDiscountResponse, type AddDiscountToCurrentCartRequest, type AddDiscountToCurrentCartResponse, 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 CalculateCartOptions, type CalculateCartRequest, type CalculateCartResponse, type CalculateCurrentCartRequest, type CalculateCurrentCartResponse, CalculationComponent, type CalculationComponentWithLiterals, type CalculationConfig, type CalculationError, type Cart, type
|
|
3196
|
+
export { type ActionEvent, type AddDiscountRequest, type AddDiscountResponse, type AddDiscountToCurrentCartRequest, type AddDiscountToCurrentCartResponse, 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, CalculationComponent, type CalculationComponentWithLiterals, type CalculationConfig, type CalculationError, type Cart, type CartSettings, type CartSource, type CartSummary, type CatalogItemInput, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, type Color, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCurrentCartRequest, type CreateCurrentCartResponse, type CreatedBy, type CreatedByIdOneOf, type CustomContentReference, 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, DiscountStatus, type DiscountStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ErrorCode, type ErrorCodeWithLiterals, 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 ItemModifier, type ItemPaymentConfig, type ItemPriceBreakdown, type ItemPricingInfo, type ItemQuantityInfo, type ItemSource, ItemStatus, type ItemStatusWithLiterals, type ItemTaxConfig, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, type LineItem, type LineItemSummary, type LineItemTax, type LineItemUpdate, type MarkCartAsCompletedOptions, type MarkCartAsCompletedRequest, type MarkCartAsCompletedResponse, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, 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 RemoveDiscountFromCurrentCartRequest, type RemoveDiscountFromCurrentCartResponse, type RemoveDiscountRequest, type RemoveDiscountResponse, 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, 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 V2SelectedMembership, type ValidationError, ValidationsConfig, type ValidationsConfigWithLiterals, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addDiscount, addGiftCard, addLineItems, calculateCart, createCart, deleteCart, getCart, getCheckoutUrl, handleAsyncCheckoutCompletion, markCartAsCompleted, placeOrder, refreshCart, removeDiscount, removeGiftCard, removeLineItems, updateCart, updateLineItems };
|