@wix/auto_sdk_ecom_cart 1.0.170 → 1.0.172
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +11 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +37 -15
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +5 -15
- package/build/cjs/meta.js +2 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +2 -2
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +11 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +37 -15
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +5 -15
- package/build/es/meta.mjs +2 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +2 -2
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +12 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +314 -16
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +531 -16
- package/build/internal/cjs/meta.js +2 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.js +2 -2
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +12 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +314 -16
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +531 -16
- package/build/internal/es/meta.mjs +2 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.mjs +2 -2
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -60,6 +60,26 @@ interface Cart {
|
|
|
60
60
|
* @readonly
|
|
61
61
|
*/
|
|
62
62
|
weightUnit?: WeightUnitWithLiterals;
|
|
63
|
+
/**
|
|
64
|
+
* Combined price of all line items before discounts. Subtotal includes tax if `cart.tax_included_in_prices` is set to `true`.
|
|
65
|
+
* @internal
|
|
66
|
+
* @readonly
|
|
67
|
+
*/
|
|
68
|
+
subtotal?: MultiCurrencyPrice;
|
|
69
|
+
/**
|
|
70
|
+
* Combined price of all line items after discounts.
|
|
71
|
+
* @internal
|
|
72
|
+
* @readonly
|
|
73
|
+
*/
|
|
74
|
+
subtotalAfterDiscounts?: MultiCurrencyPrice;
|
|
75
|
+
/**
|
|
76
|
+
* Total amount discounted from the cart.
|
|
77
|
+
*
|
|
78
|
+
* This includes coupon and merchant discounts.
|
|
79
|
+
* @internal
|
|
80
|
+
* @readonly
|
|
81
|
+
*/
|
|
82
|
+
discount?: MultiCurrencyPrice;
|
|
63
83
|
/**
|
|
64
84
|
* ID of the checkout that originated from this cart.
|
|
65
85
|
* @readonly
|
|
@@ -118,6 +138,12 @@ interface Cart {
|
|
|
118
138
|
* @format CURRENCY
|
|
119
139
|
*/
|
|
120
140
|
paymentCurrency?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Indicates whether this cart is managed by Cart V2.
|
|
143
|
+
* @internal
|
|
144
|
+
* @readonly
|
|
145
|
+
*/
|
|
146
|
+
managedByV2?: boolean;
|
|
121
147
|
/**
|
|
122
148
|
* Revision number, which increments by 1 each time the Cart is updated.
|
|
123
149
|
* @readonly
|
|
@@ -157,6 +183,22 @@ interface LineItem {
|
|
|
157
183
|
* @readonly
|
|
158
184
|
*/
|
|
159
185
|
price?: MultiCurrencyPrice;
|
|
186
|
+
/**
|
|
187
|
+
* Original item price.
|
|
188
|
+
* @internal
|
|
189
|
+
* @format DECIMAL_VALUE
|
|
190
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
191
|
+
* @readonly
|
|
192
|
+
*/
|
|
193
|
+
originalPrice?: string | null;
|
|
194
|
+
/**
|
|
195
|
+
* Original item full price.
|
|
196
|
+
* @internal
|
|
197
|
+
* @format DECIMAL_VALUE
|
|
198
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
199
|
+
* @readonly
|
|
200
|
+
*/
|
|
201
|
+
originalFullPrice?: string | null;
|
|
160
202
|
/**
|
|
161
203
|
* Item price **before** catalog-defined discount. Defaults to `price` when not provided.
|
|
162
204
|
* @readonly
|
|
@@ -192,6 +234,13 @@ interface LineItem {
|
|
|
192
234
|
* @readonly
|
|
193
235
|
*/
|
|
194
236
|
physicalProperties?: PhysicalProperties;
|
|
237
|
+
/**
|
|
238
|
+
* Coupon scopes - which app and items a coupon applies to.
|
|
239
|
+
* This field is internal to Wix, and should be used by Bookings, Stores and Events as used by the current Coupons API.
|
|
240
|
+
* @internal
|
|
241
|
+
* @readonly
|
|
242
|
+
*/
|
|
243
|
+
couponScopes?: Scope[];
|
|
195
244
|
/**
|
|
196
245
|
* Item type. Either a preset type or custom.
|
|
197
246
|
* @readonly
|
|
@@ -202,6 +251,12 @@ interface LineItem {
|
|
|
202
251
|
* @readonly
|
|
203
252
|
*/
|
|
204
253
|
subscriptionOptionInfo?: SubscriptionOptionInfo;
|
|
254
|
+
/**
|
|
255
|
+
* Digital file identifier, relevant only for items with type DIGITAL.
|
|
256
|
+
* @internal
|
|
257
|
+
* @readonly
|
|
258
|
+
*/
|
|
259
|
+
digitalFile?: SecuredMedia;
|
|
205
260
|
/**
|
|
206
261
|
* Type of selected payment option for current item.
|
|
207
262
|
*
|
|
@@ -260,6 +315,17 @@ interface LineItem {
|
|
|
260
315
|
* @readonly
|
|
261
316
|
*/
|
|
262
317
|
consentRequiredPaymentPolicy?: string | null;
|
|
318
|
+
/**
|
|
319
|
+
* Deprecated. Use the `deliveryProfileId` instead.
|
|
320
|
+
* Shipping group ID.
|
|
321
|
+
* @internal
|
|
322
|
+
* @format GUID
|
|
323
|
+
* @readonly
|
|
324
|
+
* @deprecated Deprecated. Use the `deliveryProfileId` instead.
|
|
325
|
+
* Shipping group ID.
|
|
326
|
+
* @targetRemovalDate 2025-02-13
|
|
327
|
+
*/
|
|
328
|
+
shippingGroupId?: string | null;
|
|
263
329
|
/**
|
|
264
330
|
* Whether the price is not yet defined, and will be updated after the order is created.
|
|
265
331
|
* @readonly
|
|
@@ -298,6 +364,12 @@ interface LineItem {
|
|
|
298
364
|
* @maxSize 5
|
|
299
365
|
*/
|
|
300
366
|
policies?: Policy[];
|
|
367
|
+
/**
|
|
368
|
+
* ID of the app managing the inventory.
|
|
369
|
+
* @internal
|
|
370
|
+
* @format GUID
|
|
371
|
+
*/
|
|
372
|
+
inventoryAppId?: string | null;
|
|
301
373
|
/**
|
|
302
374
|
* Whether the item can only be purchased by site members.
|
|
303
375
|
*
|
|
@@ -316,6 +388,12 @@ interface LineItem {
|
|
|
316
388
|
* @readonly
|
|
317
389
|
*/
|
|
318
390
|
modifiersTotalPrice?: MultiCurrencyPrice;
|
|
391
|
+
/**
|
|
392
|
+
* Platform Fee associated with this line item.
|
|
393
|
+
* @internal
|
|
394
|
+
* @readonly
|
|
395
|
+
*/
|
|
396
|
+
platformFee?: PlatformFee;
|
|
319
397
|
}
|
|
320
398
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
321
399
|
interface CatalogReference {
|
|
@@ -402,8 +480,26 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
402
480
|
plainText?: PlainTextValue;
|
|
403
481
|
/** Description line color value. */
|
|
404
482
|
colorInfo?: Color;
|
|
483
|
+
/**
|
|
484
|
+
* Description line plain text value.
|
|
485
|
+
* @internal
|
|
486
|
+
* @deprecated
|
|
487
|
+
*/
|
|
488
|
+
plainTextValue?: PlainTextValue;
|
|
489
|
+
/**
|
|
490
|
+
* Description line color.
|
|
491
|
+
* @internal
|
|
492
|
+
* @deprecated
|
|
493
|
+
*/
|
|
494
|
+
color?: string;
|
|
405
495
|
/** Description line name. */
|
|
406
496
|
name?: DescriptionLineName;
|
|
497
|
+
/**
|
|
498
|
+
* Description line type.
|
|
499
|
+
* @internal
|
|
500
|
+
* @deprecated
|
|
501
|
+
*/
|
|
502
|
+
lineType?: DescriptionLineTypeWithLiterals;
|
|
407
503
|
}
|
|
408
504
|
/** @oneof */
|
|
409
505
|
interface DescriptionLineValueOneOf {
|
|
@@ -414,6 +510,18 @@ interface DescriptionLineValueOneOf {
|
|
|
414
510
|
}
|
|
415
511
|
/** @oneof */
|
|
416
512
|
interface DescriptionLineDescriptionLineValueOneOf {
|
|
513
|
+
/**
|
|
514
|
+
* Description line plain text value.
|
|
515
|
+
* @internal
|
|
516
|
+
* @deprecated
|
|
517
|
+
*/
|
|
518
|
+
plainTextValue?: PlainTextValue;
|
|
519
|
+
/**
|
|
520
|
+
* Description line color.
|
|
521
|
+
* @internal
|
|
522
|
+
* @deprecated
|
|
523
|
+
*/
|
|
524
|
+
color?: string;
|
|
417
525
|
}
|
|
418
526
|
interface DescriptionLineName {
|
|
419
527
|
/**
|
|
@@ -486,11 +594,29 @@ interface CommonImage {
|
|
|
486
594
|
width?: number;
|
|
487
595
|
/** Image alt text. */
|
|
488
596
|
altText?: string | null;
|
|
597
|
+
/**
|
|
598
|
+
* Image URL expiration date (when relevant).
|
|
599
|
+
* @internal
|
|
600
|
+
* @readonly
|
|
601
|
+
*/
|
|
602
|
+
urlExpirationDate?: Date | null;
|
|
489
603
|
/**
|
|
490
604
|
* Image filename.
|
|
491
605
|
* @readonly
|
|
492
606
|
*/
|
|
493
607
|
filename?: string | null;
|
|
608
|
+
/**
|
|
609
|
+
* Image size in bytes.
|
|
610
|
+
* @internal
|
|
611
|
+
* @readonly
|
|
612
|
+
* @format DECIMAL_VALUE
|
|
613
|
+
*/
|
|
614
|
+
sizeInBytes?: string | null;
|
|
615
|
+
/**
|
|
616
|
+
* Focal point of the image.
|
|
617
|
+
* @internal
|
|
618
|
+
*/
|
|
619
|
+
focalPoint?: FocalPoint;
|
|
494
620
|
}
|
|
495
621
|
interface FocalPoint {
|
|
496
622
|
/** X-coordinate of the focal point. */
|
|
@@ -529,6 +655,16 @@ interface PhysicalProperties {
|
|
|
529
655
|
sku?: string | null;
|
|
530
656
|
/** Whether this line item is shippable. */
|
|
531
657
|
shippable?: boolean;
|
|
658
|
+
/**
|
|
659
|
+
* Product dimensions (length, width, height of the physical product).
|
|
660
|
+
* @internal
|
|
661
|
+
*/
|
|
662
|
+
productDimensions?: Dimensions;
|
|
663
|
+
/**
|
|
664
|
+
* Package dimensions (length, width, height of the shipping package).
|
|
665
|
+
* @internal
|
|
666
|
+
*/
|
|
667
|
+
packageDimensions?: Dimensions;
|
|
532
668
|
}
|
|
533
669
|
interface Dimensions {
|
|
534
670
|
/**
|
|
@@ -634,6 +770,21 @@ interface SubscriptionSettings {
|
|
|
634
770
|
* If None => no free trial
|
|
635
771
|
*/
|
|
636
772
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
773
|
+
/**
|
|
774
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
775
|
+
* @internal
|
|
776
|
+
*/
|
|
777
|
+
startDate?: Date | null;
|
|
778
|
+
/**
|
|
779
|
+
* Billing configuration for recurring charges.
|
|
780
|
+
* @internal
|
|
781
|
+
*/
|
|
782
|
+
billingSettings?: BillingSettings;
|
|
783
|
+
/**
|
|
784
|
+
* Whether the product/service/subscription access period is aligned with the billing period.
|
|
785
|
+
* @internal
|
|
786
|
+
*/
|
|
787
|
+
productPeriodAlignment?: ProductPeriodAlignmentWithLiterals;
|
|
637
788
|
}
|
|
638
789
|
/** Frequency unit of recurring payment */
|
|
639
790
|
declare enum SubscriptionFrequency {
|
|
@@ -758,6 +909,12 @@ interface ServiceProperties {
|
|
|
758
909
|
* @max 10000
|
|
759
910
|
*/
|
|
760
911
|
numberOfParticipants?: number | null;
|
|
912
|
+
/**
|
|
913
|
+
* Date and time the service is to be ended, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
914
|
+
* For example, the date and time a class will end.
|
|
915
|
+
* @internal
|
|
916
|
+
*/
|
|
917
|
+
endDate?: Date | null;
|
|
761
918
|
}
|
|
762
919
|
interface PriceDescription {
|
|
763
920
|
/**
|
|
@@ -830,6 +987,12 @@ interface CatalogOverrideFields {
|
|
|
830
987
|
* @format GUID
|
|
831
988
|
*/
|
|
832
989
|
inventoryAppId?: string | null;
|
|
990
|
+
/**
|
|
991
|
+
* Whether the line item quantity is fixed and can't be changed.
|
|
992
|
+
* When not set, falls back to the value from the catalog.
|
|
993
|
+
* @internal
|
|
994
|
+
*/
|
|
995
|
+
fixedQuantity?: boolean | null;
|
|
833
996
|
}
|
|
834
997
|
interface Image {
|
|
835
998
|
/** WixMedia image ID. */
|
|
@@ -1038,6 +1201,23 @@ interface CartDiscount extends CartDiscountDiscountSourceOneOf {
|
|
|
1038
1201
|
coupon?: Coupon;
|
|
1039
1202
|
/** Merchant discount. */
|
|
1040
1203
|
merchantDiscount?: MerchantDiscount;
|
|
1204
|
+
/**
|
|
1205
|
+
* Discount rule
|
|
1206
|
+
* @internal
|
|
1207
|
+
*/
|
|
1208
|
+
discountRule?: DiscountRule;
|
|
1209
|
+
/**
|
|
1210
|
+
* IDs of line items the discount applies to.
|
|
1211
|
+
* @internal
|
|
1212
|
+
* @format GUID
|
|
1213
|
+
* @maxSize 300
|
|
1214
|
+
*/
|
|
1215
|
+
lineItemIds?: string[];
|
|
1216
|
+
/**
|
|
1217
|
+
* Discount type.
|
|
1218
|
+
* @internal
|
|
1219
|
+
*/
|
|
1220
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1041
1221
|
}
|
|
1042
1222
|
/** @oneof */
|
|
1043
1223
|
interface CartDiscountDiscountSourceOneOf {
|
|
@@ -1045,12 +1225,22 @@ interface CartDiscountDiscountSourceOneOf {
|
|
|
1045
1225
|
coupon?: Coupon;
|
|
1046
1226
|
/** Merchant discount. */
|
|
1047
1227
|
merchantDiscount?: MerchantDiscount;
|
|
1228
|
+
/**
|
|
1229
|
+
* Discount rule
|
|
1230
|
+
* @internal
|
|
1231
|
+
*/
|
|
1232
|
+
discountRule?: DiscountRule;
|
|
1048
1233
|
}
|
|
1049
1234
|
interface Coupon {
|
|
1050
1235
|
/** Coupon ID. */
|
|
1051
1236
|
id?: string;
|
|
1052
1237
|
/** Coupon code. */
|
|
1053
1238
|
code?: string;
|
|
1239
|
+
/**
|
|
1240
|
+
* Coupon value.
|
|
1241
|
+
* @internal
|
|
1242
|
+
*/
|
|
1243
|
+
amount?: MultiCurrencyPrice;
|
|
1054
1244
|
}
|
|
1055
1245
|
interface MerchantDiscount {
|
|
1056
1246
|
/** Discount value. */
|
|
@@ -1150,6 +1340,16 @@ interface StreetAddress {
|
|
|
1150
1340
|
number?: string;
|
|
1151
1341
|
/** Street name. */
|
|
1152
1342
|
name?: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* Apartment number.
|
|
1345
|
+
* @internal
|
|
1346
|
+
*/
|
|
1347
|
+
apt?: string;
|
|
1348
|
+
/**
|
|
1349
|
+
* Optional address line 1
|
|
1350
|
+
* @internal
|
|
1351
|
+
*/
|
|
1352
|
+
formattedAddressLine?: string | null;
|
|
1153
1353
|
}
|
|
1154
1354
|
interface AddressLocation {
|
|
1155
1355
|
/** Address latitude. */
|
|
@@ -1263,6 +1463,11 @@ interface UpdateCartRequest {
|
|
|
1263
1463
|
* @maxSize 300
|
|
1264
1464
|
*/
|
|
1265
1465
|
customLineItems?: CustomLineItem[];
|
|
1466
|
+
/**
|
|
1467
|
+
* List of field names to determine which of cartInfo's fields will be updated
|
|
1468
|
+
* @internal
|
|
1469
|
+
*/
|
|
1470
|
+
cartFieldmask?: string[];
|
|
1266
1471
|
}
|
|
1267
1472
|
interface CustomLineItem {
|
|
1268
1473
|
/**
|
|
@@ -1329,6 +1534,16 @@ interface CustomLineItem {
|
|
|
1329
1534
|
quantityAvailable?: number | null;
|
|
1330
1535
|
/** Physical properties of the item. */
|
|
1331
1536
|
physicalProperties?: PhysicalProperties;
|
|
1537
|
+
/**
|
|
1538
|
+
* Subscription option info. This field is internal and only used by Stores.
|
|
1539
|
+
* @internal
|
|
1540
|
+
*/
|
|
1541
|
+
subscriptionOptionInfo?: SubscriptionOptionInfo;
|
|
1542
|
+
/**
|
|
1543
|
+
* Digital file ID and name. Required if `itemType: DIGITAL`.
|
|
1544
|
+
* @internal
|
|
1545
|
+
*/
|
|
1546
|
+
digitalFile?: SecuredMedia;
|
|
1332
1547
|
/**
|
|
1333
1548
|
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
1334
1549
|
*
|
|
@@ -1399,6 +1614,12 @@ interface CustomLineItem {
|
|
|
1399
1614
|
* @maxSize 5
|
|
1400
1615
|
*/
|
|
1401
1616
|
policies?: Policy[];
|
|
1617
|
+
/**
|
|
1618
|
+
* ID of the app managing the inventory.
|
|
1619
|
+
* @internal
|
|
1620
|
+
* @format GUID
|
|
1621
|
+
*/
|
|
1622
|
+
inventoryAppId?: string | null;
|
|
1402
1623
|
/**
|
|
1403
1624
|
* Whether the item can only be purchased by site members.
|
|
1404
1625
|
*
|
|
@@ -1601,6 +1822,12 @@ interface EstimateTotalsResponse {
|
|
|
1601
1822
|
* @readonly
|
|
1602
1823
|
*/
|
|
1603
1824
|
violations?: Violation[];
|
|
1825
|
+
/**
|
|
1826
|
+
* Payment for subscriptions after free trial period.
|
|
1827
|
+
* @internal
|
|
1828
|
+
* @readonly
|
|
1829
|
+
*/
|
|
1830
|
+
payAfterFreeTrial?: PriceSummary;
|
|
1604
1831
|
}
|
|
1605
1832
|
interface CalculatedLineItem {
|
|
1606
1833
|
/** Line item ID. */
|
|
@@ -1617,6 +1844,12 @@ interface CalculatedLineItem {
|
|
|
1617
1844
|
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
1618
1845
|
/** tax calculation address. */
|
|
1619
1846
|
taxableAddress?: TaxableAddress;
|
|
1847
|
+
/**
|
|
1848
|
+
* Calculated modifiers.
|
|
1849
|
+
* @internal
|
|
1850
|
+
* @maxSize 625
|
|
1851
|
+
*/
|
|
1852
|
+
modifiers?: CalculatedItemModifier[];
|
|
1620
1853
|
}
|
|
1621
1854
|
interface LineItemPricesData {
|
|
1622
1855
|
/** Total price after discounts, tax, and modifiers. */
|
|
@@ -1640,6 +1873,11 @@ interface LineItemPricesData {
|
|
|
1640
1873
|
fullPrice?: MultiCurrencyPrice;
|
|
1641
1874
|
/** Sum of all modifiers for a single unit of the item. */
|
|
1642
1875
|
modifiers?: MultiCurrencyPrice;
|
|
1876
|
+
/**
|
|
1877
|
+
* Item price before tax, automatic discounts, coupons, and global discounts; after catalog-defined discounts and modifiers.
|
|
1878
|
+
* @internal
|
|
1879
|
+
*/
|
|
1880
|
+
priceBeforeDiscountsAndTax?: MultiCurrencyPrice;
|
|
1643
1881
|
/**
|
|
1644
1882
|
* Partial payment out of `price` to be paid upfront during the checkout.
|
|
1645
1883
|
* Applies to catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
@@ -1649,6 +1887,12 @@ interface LineItemPricesData {
|
|
|
1649
1887
|
interface ItemTaxFullDetails {
|
|
1650
1888
|
/** Amount for which tax is calculated. */
|
|
1651
1889
|
taxableAmount?: MultiCurrencyPrice;
|
|
1890
|
+
/**
|
|
1891
|
+
* Tax group ID, if specified.
|
|
1892
|
+
* @internal
|
|
1893
|
+
* @format GUID
|
|
1894
|
+
*/
|
|
1895
|
+
taxGroupId?: string | null;
|
|
1652
1896
|
/**
|
|
1653
1897
|
* Tax rate %, as a decimal point between 0 and 1.
|
|
1654
1898
|
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
@@ -1662,6 +1906,27 @@ interface ItemTaxFullDetails {
|
|
|
1662
1906
|
* @deprecated
|
|
1663
1907
|
*/
|
|
1664
1908
|
rateBreakdown?: TaxRateBreakdown[];
|
|
1909
|
+
/**
|
|
1910
|
+
* The amount of this line item that was exempt.
|
|
1911
|
+
* @internal
|
|
1912
|
+
*/
|
|
1913
|
+
exemptAmount?: MultiCurrencyPrice;
|
|
1914
|
+
/**
|
|
1915
|
+
* True for items we have a tax applied on them
|
|
1916
|
+
* @internal
|
|
1917
|
+
*/
|
|
1918
|
+
isItemTaxable?: boolean | null;
|
|
1919
|
+
/**
|
|
1920
|
+
* True if the lineAmount include tax in it.
|
|
1921
|
+
* @internal
|
|
1922
|
+
*/
|
|
1923
|
+
isTaxIncluded?: boolean | null;
|
|
1924
|
+
/**
|
|
1925
|
+
* The calculator that calculated this line tax
|
|
1926
|
+
* @internal
|
|
1927
|
+
* @maxLength 25
|
|
1928
|
+
*/
|
|
1929
|
+
calculatorName?: string | null;
|
|
1665
1930
|
/**
|
|
1666
1931
|
* tax information for a line item.
|
|
1667
1932
|
* @maxSize 1000
|
|
@@ -1682,6 +1947,42 @@ interface TaxRateBreakdown {
|
|
|
1682
1947
|
rate?: string;
|
|
1683
1948
|
/** Amount of tax for this tax detail. */
|
|
1684
1949
|
tax?: MultiCurrencyPrice;
|
|
1950
|
+
/**
|
|
1951
|
+
* The type of tax that was calculated
|
|
1952
|
+
* @internal
|
|
1953
|
+
*/
|
|
1954
|
+
taxType?: string | null;
|
|
1955
|
+
/**
|
|
1956
|
+
* The name of the jurisdiction in which this tax detail applies
|
|
1957
|
+
* @internal
|
|
1958
|
+
*/
|
|
1959
|
+
jurisdiction?: string | null;
|
|
1960
|
+
/**
|
|
1961
|
+
* The type of the jurisdiction in which this tax detail applies(Country,State,County,City,Special).
|
|
1962
|
+
* @internal
|
|
1963
|
+
*/
|
|
1964
|
+
jurisdictionType?: string | null;
|
|
1965
|
+
/**
|
|
1966
|
+
* The amount of this line item that was exempt from this authority.
|
|
1967
|
+
* @internal
|
|
1968
|
+
*/
|
|
1969
|
+
exemptAmount?: MultiCurrencyPrice;
|
|
1970
|
+
/**
|
|
1971
|
+
* ids of the used exemptions from the TaxEstimate exemptions array.
|
|
1972
|
+
* @internal
|
|
1973
|
+
* @maxSize 1000
|
|
1974
|
+
*/
|
|
1975
|
+
exemptionIds?: number[];
|
|
1976
|
+
/**
|
|
1977
|
+
* The taxable amount of this tax detail
|
|
1978
|
+
* @internal
|
|
1979
|
+
*/
|
|
1980
|
+
taxableAmount?: MultiCurrencyPrice;
|
|
1981
|
+
/**
|
|
1982
|
+
* The Taxes/Fee component. True if the fee is applied.
|
|
1983
|
+
* @internal
|
|
1984
|
+
*/
|
|
1985
|
+
isFee?: boolean | null;
|
|
1685
1986
|
}
|
|
1686
1987
|
/**
|
|
1687
1988
|
* TaxBreakdown represents tax information for a line item.
|
|
@@ -1717,6 +2018,11 @@ interface TaxBreakdown {
|
|
|
1717
2018
|
taxName?: string | null;
|
|
1718
2019
|
/** The type of the jurisdiction in which this tax detail applies. */
|
|
1719
2020
|
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
2021
|
+
/**
|
|
2022
|
+
* The amount of this line item that was exempt from this authority.
|
|
2023
|
+
* @internal
|
|
2024
|
+
*/
|
|
2025
|
+
exemptAmount?: MultiCurrencyPrice;
|
|
1720
2026
|
}
|
|
1721
2027
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1722
2028
|
declare enum JurisdictionType {
|
|
@@ -1786,6 +2092,13 @@ interface GiftCard {
|
|
|
1786
2092
|
externalId?: string | null;
|
|
1787
2093
|
/** Requested amount to redeem from the gift card. */
|
|
1788
2094
|
requestedAmount?: MultiCurrencyPrice;
|
|
2095
|
+
/**
|
|
2096
|
+
* Full gift card code. Echoed from the request input for correlation.
|
|
2097
|
+
* @internal
|
|
2098
|
+
* @minLength 8
|
|
2099
|
+
* @maxLength 20
|
|
2100
|
+
*/
|
|
2101
|
+
code?: string;
|
|
1789
2102
|
}
|
|
1790
2103
|
interface TaxSummary {
|
|
1791
2104
|
/**
|
|
@@ -1798,11 +2111,51 @@ interface TaxSummary {
|
|
|
1798
2111
|
* @readonly
|
|
1799
2112
|
*/
|
|
1800
2113
|
totalTax?: MultiCurrencyPrice;
|
|
2114
|
+
/**
|
|
2115
|
+
* Manual tax rate
|
|
2116
|
+
* @internal
|
|
2117
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
2118
|
+
* @readonly
|
|
2119
|
+
* @deprecated
|
|
2120
|
+
*/
|
|
2121
|
+
manualTaxRate?: string;
|
|
1801
2122
|
/**
|
|
1802
2123
|
* Tax calculator that was active when the order was created.
|
|
1803
2124
|
* @deprecated
|
|
1804
2125
|
*/
|
|
1805
2126
|
calculationDetails?: TaxCalculationDetails;
|
|
2127
|
+
/**
|
|
2128
|
+
* Tax estimation id in tax service
|
|
2129
|
+
* @internal
|
|
2130
|
+
* @readonly
|
|
2131
|
+
*/
|
|
2132
|
+
taxEstimationId?: string | null;
|
|
2133
|
+
/**
|
|
2134
|
+
* Average Tax Rate
|
|
2135
|
+
* @internal
|
|
2136
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
2137
|
+
* @readonly
|
|
2138
|
+
*/
|
|
2139
|
+
averageTaxRate?: string | null;
|
|
2140
|
+
/**
|
|
2141
|
+
* The amount of this estimate that was exempt (for all line items).
|
|
2142
|
+
* @internal
|
|
2143
|
+
* @readonly
|
|
2144
|
+
*/
|
|
2145
|
+
totalExempt?: MultiCurrencyPrice;
|
|
2146
|
+
/**
|
|
2147
|
+
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
2148
|
+
* @internal
|
|
2149
|
+
* @readonly
|
|
2150
|
+
* @maxSize 50
|
|
2151
|
+
*/
|
|
2152
|
+
aggregatedTaxBreakdown?: AggregatedTaxBreakdown[];
|
|
2153
|
+
/**
|
|
2154
|
+
* Default name of the tax that was calculated.
|
|
2155
|
+
* @internal
|
|
2156
|
+
* @maxLength 200
|
|
2157
|
+
*/
|
|
2158
|
+
taxName?: string | null;
|
|
1806
2159
|
}
|
|
1807
2160
|
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1808
2161
|
/** Reason the manual calculation was used. */
|
|
@@ -1892,6 +2245,11 @@ interface AggregatedTaxBreakdown {
|
|
|
1892
2245
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
1893
2246
|
/** The sum of all the taxable amount from line items for tax identifiers. */
|
|
1894
2247
|
aggregatedTaxableAmount?: MultiCurrencyPrice;
|
|
2248
|
+
/**
|
|
2249
|
+
* The aggregated exempt amount from all line items for tax identifiers.
|
|
2250
|
+
* @internal
|
|
2251
|
+
*/
|
|
2252
|
+
aggregatedExemptAmount?: MultiCurrencyPrice;
|
|
1895
2253
|
}
|
|
1896
2254
|
interface ShippingInformation {
|
|
1897
2255
|
/** Shipping region. */
|
|
@@ -1975,6 +2333,11 @@ interface DeliveryLogistics {
|
|
|
1975
2333
|
instructions?: string | null;
|
|
1976
2334
|
/** Pickup details. */
|
|
1977
2335
|
pickupDetails?: PickupDetails;
|
|
2336
|
+
/**
|
|
2337
|
+
* Expected delivery time slot (from and to time stamps representation)
|
|
2338
|
+
* @internal
|
|
2339
|
+
*/
|
|
2340
|
+
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1978
2341
|
}
|
|
1979
2342
|
interface PickupDetails {
|
|
1980
2343
|
/** Pickup address. */
|
|
@@ -2134,6 +2497,39 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
2134
2497
|
* @format GUID
|
|
2135
2498
|
*/
|
|
2136
2499
|
lineItemIds?: string[];
|
|
2500
|
+
/**
|
|
2501
|
+
* Discount ID.
|
|
2502
|
+
* @internal
|
|
2503
|
+
* @format GUID
|
|
2504
|
+
*/
|
|
2505
|
+
id?: string | null;
|
|
2506
|
+
/**
|
|
2507
|
+
* Discount distribution.
|
|
2508
|
+
* Each entry contains the discount amount allocated to a specific line item.
|
|
2509
|
+
* Returned only when `apply_item_discounts_to_prices` is enabled.
|
|
2510
|
+
* @internal
|
|
2511
|
+
* @maxSize 300
|
|
2512
|
+
* @readonly
|
|
2513
|
+
*/
|
|
2514
|
+
lineItemDiscounts?: LineItemDiscount[];
|
|
2515
|
+
/**
|
|
2516
|
+
* Number of subscription cycle this discount applies to
|
|
2517
|
+
* default None - all billing cycle
|
|
2518
|
+
* @internal
|
|
2519
|
+
* @min 1
|
|
2520
|
+
* @max 999
|
|
2521
|
+
*/
|
|
2522
|
+
subscriptionCycles?: number | null;
|
|
2523
|
+
/**
|
|
2524
|
+
* A list of item combinations for this applied discount.
|
|
2525
|
+
* Each entry represents a unique combination of line items that triggered
|
|
2526
|
+
* or received this discount, along with how many times that combination was applied together.
|
|
2527
|
+
* Relevant ONLY for BXGY and Quantity-based promotions.
|
|
2528
|
+
* In BXGY the combination will contain the "X" items with discount amount of 0.
|
|
2529
|
+
* @internal
|
|
2530
|
+
* @maxSize 1000
|
|
2531
|
+
*/
|
|
2532
|
+
itemCombinations?: ItemCombination[];
|
|
2137
2533
|
}
|
|
2138
2534
|
/** @oneof */
|
|
2139
2535
|
interface AppliedDiscountDiscountSourceOneOf {
|
|
@@ -2161,6 +2557,12 @@ interface V1Coupon {
|
|
|
2161
2557
|
amount?: MultiCurrencyPrice;
|
|
2162
2558
|
/** Coupon name. */
|
|
2163
2559
|
name?: string;
|
|
2560
|
+
/**
|
|
2561
|
+
* Coupon type: We want it to be an enum and not a string but currently we have no time to do it so we leave it as is to be aligned with cart summary.
|
|
2562
|
+
* @internal
|
|
2563
|
+
* @deprecated
|
|
2564
|
+
*/
|
|
2565
|
+
couponType?: string;
|
|
2164
2566
|
}
|
|
2165
2567
|
interface V1MerchantDiscount {
|
|
2166
2568
|
/** Discount value. */
|
|
@@ -2262,6 +2664,11 @@ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOne
|
|
|
2262
2664
|
membershipError?: Details;
|
|
2263
2665
|
/** Discount Rule calculation error. */
|
|
2264
2666
|
discountsCalculationError?: Details;
|
|
2667
|
+
/**
|
|
2668
|
+
* Gift card calculation errors, one per failed card.
|
|
2669
|
+
* @internal
|
|
2670
|
+
*/
|
|
2671
|
+
giftCardCalculationErrors?: GiftCardCalculationError[];
|
|
2265
2672
|
}
|
|
2266
2673
|
/** @oneof */
|
|
2267
2674
|
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
@@ -2375,6 +2782,13 @@ interface GiftCardCalculationError {
|
|
|
2375
2782
|
obfuscatedCode?: string;
|
|
2376
2783
|
/** Error details. */
|
|
2377
2784
|
error?: Details;
|
|
2785
|
+
/**
|
|
2786
|
+
* Full gift card code. Echoed from the request input for correlation.
|
|
2787
|
+
* @internal
|
|
2788
|
+
* @minLength 8
|
|
2789
|
+
* @maxLength 20
|
|
2790
|
+
*/
|
|
2791
|
+
code?: string;
|
|
2378
2792
|
}
|
|
2379
2793
|
interface MembershipOptions {
|
|
2380
2794
|
/**
|
|
@@ -2407,6 +2821,18 @@ interface MembershipOptions {
|
|
|
2407
2821
|
* @targetRemovalDate 2026-10-01
|
|
2408
2822
|
*/
|
|
2409
2823
|
selectedMemberships?: HostSelectedMembership[];
|
|
2824
|
+
/**
|
|
2825
|
+
* Validated existing memberships selected for redemption, each with the line items it can cover.
|
|
2826
|
+
* Populated by the EnhanceAndValidateSelection flow.
|
|
2827
|
+
* @internal
|
|
2828
|
+
*/
|
|
2829
|
+
validatedExistingMemberships?: ValidatedExistingMemberships;
|
|
2830
|
+
/**
|
|
2831
|
+
* Validated future plans (purchasable during this checkout) and how their benefits cover the line items.
|
|
2832
|
+
* Populated by the EnhanceAndValidateSelection flow.
|
|
2833
|
+
* @internal
|
|
2834
|
+
*/
|
|
2835
|
+
validatedPurchasablePlans?: ValidatedPurchasablePlans;
|
|
2410
2836
|
}
|
|
2411
2837
|
interface Membership {
|
|
2412
2838
|
/**
|
|
@@ -2432,20 +2858,21 @@ interface Membership {
|
|
|
2432
2858
|
lineItemIds?: string[];
|
|
2433
2859
|
/** Membership's payment credits (balance information). */
|
|
2434
2860
|
credits?: MembershipPaymentCredits;
|
|
2435
|
-
/**
|
|
2436
|
-
* Deprecated. Use `offering_description`.
|
|
2437
|
-
* @deprecated
|
|
2438
|
-
* @replacedBy offering_description
|
|
2439
|
-
* @targetRemovalDate 2026-07-30
|
|
2440
|
-
*/
|
|
2861
|
+
/** Membership expiration date. */
|
|
2441
2862
|
expirationDate?: Date | null;
|
|
2442
2863
|
/**
|
|
2443
2864
|
* Deprecated. Use `offering_description`.
|
|
2444
2865
|
* @deprecated
|
|
2445
2866
|
* @replacedBy offering_description
|
|
2446
|
-
* @targetRemovalDate 2026-
|
|
2867
|
+
* @targetRemovalDate 2026-08-30
|
|
2447
2868
|
*/
|
|
2448
2869
|
additionalData?: Record<string, any> | null;
|
|
2870
|
+
/**
|
|
2871
|
+
* Human-readable offering summary for display. Provider-supplied.
|
|
2872
|
+
* @internal
|
|
2873
|
+
* @maxLength 500
|
|
2874
|
+
*/
|
|
2875
|
+
offeringDescription?: string | null;
|
|
2449
2876
|
}
|
|
2450
2877
|
interface MembershipName {
|
|
2451
2878
|
/**
|
|
@@ -2467,6 +2894,20 @@ interface MembershipPaymentCredits {
|
|
|
2467
2894
|
total?: number;
|
|
2468
2895
|
/** Membership's remaining value. */
|
|
2469
2896
|
remaining?: number;
|
|
2897
|
+
/**
|
|
2898
|
+
* Deprecated. The new flow no longer exposes a per-item redemption cost on a membership's credits;
|
|
2899
|
+
* what a membership can pay for is conveyed by `ExistingMembership.covered_line_items` (per-item redemption cost).
|
|
2900
|
+
* @internal
|
|
2901
|
+
* @deprecated
|
|
2902
|
+
* @replacedBy ExistingMembership.covered_line_items.redemption_cost
|
|
2903
|
+
* @targetRemovalDate 2026-08-30
|
|
2904
|
+
*/
|
|
2905
|
+
redemptionCost?: number;
|
|
2906
|
+
/**
|
|
2907
|
+
* Membership's balance type.
|
|
2908
|
+
* @internal
|
|
2909
|
+
*/
|
|
2910
|
+
balanceType?: BalanceTypeWithLiterals;
|
|
2470
2911
|
}
|
|
2471
2912
|
declare enum BalanceType {
|
|
2472
2913
|
/** Balance is measured in discrete uses (e.g., sessions, visits). */
|
|
@@ -2526,25 +2967,26 @@ interface V1Membership {
|
|
|
2526
2967
|
* @maxLength 100
|
|
2527
2968
|
* @deprecated
|
|
2528
2969
|
* @replacedBy ExistingMembership.covered_line_items.line_item_id
|
|
2529
|
-
* @targetRemovalDate 2026-
|
|
2970
|
+
* @targetRemovalDate 2026-08-30
|
|
2530
2971
|
*/
|
|
2531
2972
|
lineItemIds?: string[];
|
|
2532
2973
|
/** Membership's payment credits (balance information). */
|
|
2533
2974
|
credits?: MembershipPaymentCredits;
|
|
2534
|
-
/**
|
|
2535
|
-
* Membership expiration date.
|
|
2536
|
-
* @deprecated
|
|
2537
|
-
* @replacedBy offering_description
|
|
2538
|
-
* @targetRemovalDate 2026-07-30
|
|
2539
|
-
*/
|
|
2975
|
+
/** Membership expiration date. */
|
|
2540
2976
|
expirationDate?: Date | null;
|
|
2541
2977
|
/**
|
|
2542
2978
|
* Deprecated. Use `offering_description` for human-readable provider data.
|
|
2543
2979
|
* @deprecated
|
|
2544
2980
|
* @replacedBy offering_description
|
|
2545
|
-
* @targetRemovalDate 2026-
|
|
2981
|
+
* @targetRemovalDate 2026-08-30
|
|
2546
2982
|
*/
|
|
2547
2983
|
additionalData?: Record<string, any> | null;
|
|
2984
|
+
/**
|
|
2985
|
+
* Human-readable offering summary for display (for example price and validity text). Provider-supplied.
|
|
2986
|
+
* @internal
|
|
2987
|
+
* @maxLength 500
|
|
2988
|
+
*/
|
|
2989
|
+
offeringDescription?: string | null;
|
|
2548
2990
|
}
|
|
2549
2991
|
/** A line item a membership can pay for, and the cost to redeem it. */
|
|
2550
2992
|
interface CoveredLineItem {
|
|
@@ -2722,6 +3164,14 @@ interface AdditionalFee {
|
|
|
2722
3164
|
* @format GUID
|
|
2723
3165
|
*/
|
|
2724
3166
|
lineItemIds?: string[];
|
|
3167
|
+
/**
|
|
3168
|
+
* Number of subscription cycle this fee applies to
|
|
3169
|
+
* default None - all billing cycle
|
|
3170
|
+
* @internal
|
|
3171
|
+
* @min 1
|
|
3172
|
+
* @max 999
|
|
3173
|
+
*/
|
|
3174
|
+
subscriptionCycles?: number | null;
|
|
2725
3175
|
/** the source the additional fee was added from */
|
|
2726
3176
|
source?: AdditionalFeeSourceWithLiterals;
|
|
2727
3177
|
/**
|
|
@@ -2817,6 +3267,11 @@ interface TargetLineItem {
|
|
|
2817
3267
|
name?: NameInLineItemWithLiterals;
|
|
2818
3268
|
/** ID of the line item containing the violation. */
|
|
2819
3269
|
id?: string | null;
|
|
3270
|
+
/**
|
|
3271
|
+
* Suggested fix for resolving the line item violation.
|
|
3272
|
+
* @internal
|
|
3273
|
+
*/
|
|
3274
|
+
suggestedFix?: SuggestedFixWithLiterals;
|
|
2820
3275
|
}
|
|
2821
3276
|
interface RemoveLineItemsFromCurrentCartRequest {
|
|
2822
3277
|
/**
|
|
@@ -2886,7 +3341,19 @@ declare enum ChannelType {
|
|
|
2886
3341
|
/** PayPal Agentic Checkout sales channel. */
|
|
2887
3342
|
PAYPAL_AGENTIC_CHECKOUT = "PAYPAL_AGENTIC_CHECKOUT",
|
|
2888
3343
|
/** Stripe Agentic Checkout sales channel. */
|
|
2889
|
-
STRIPE_AGENTIC_CHECKOUT = "STRIPE_AGENTIC_CHECKOUT"
|
|
3344
|
+
STRIPE_AGENTIC_CHECKOUT = "STRIPE_AGENTIC_CHECKOUT",
|
|
3345
|
+
/**
|
|
3346
|
+
* Wix Invoices platform app
|
|
3347
|
+
* @documentationMaturity preview
|
|
3348
|
+
* @internal
|
|
3349
|
+
*/
|
|
3350
|
+
WIX_INVOICES_PLATFORM = "WIX_INVOICES_PLATFORM",
|
|
3351
|
+
/**
|
|
3352
|
+
* UCP (Universal Checkout Protocol) Agentic Checkout sales channel.
|
|
3353
|
+
* @documentationMaturity preview
|
|
3354
|
+
* @internal
|
|
3355
|
+
*/
|
|
3356
|
+
UCP_AGENTIC_CHECKOUT = "UCP_AGENTIC_CHECKOUT"
|
|
2890
3357
|
}
|
|
2891
3358
|
/** @enumType */
|
|
2892
3359
|
type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM' | 'PAYPAL_AGENTIC_CHECKOUT' | 'STRIPE_AGENTIC_CHECKOUT';
|
|
@@ -3004,8 +3471,18 @@ interface DomainEventBodyOneOf {
|
|
|
3004
3471
|
}
|
|
3005
3472
|
interface EntityCreatedEvent {
|
|
3006
3473
|
entityAsJson?: string;
|
|
3474
|
+
/**
|
|
3475
|
+
* Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
|
|
3476
|
+
* @internal
|
|
3477
|
+
*/
|
|
3478
|
+
triggeredByUndelete?: boolean | null;
|
|
3007
3479
|
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3008
3480
|
restoreInfo?: RestoreInfo;
|
|
3481
|
+
/**
|
|
3482
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
3483
|
+
* @internal
|
|
3484
|
+
*/
|
|
3485
|
+
additionalMetadataAsJson?: string | null;
|
|
3009
3486
|
}
|
|
3010
3487
|
interface RestoreInfo {
|
|
3011
3488
|
deletedDate?: Date | null;
|
|
@@ -3017,10 +3494,42 @@ interface EntityUpdatedEvent {
|
|
|
3017
3494
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3018
3495
|
*/
|
|
3019
3496
|
currentEntityAsJson?: string;
|
|
3497
|
+
/**
|
|
3498
|
+
* This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
|
|
3499
|
+
* wont populate it / have any reference to it in the API.
|
|
3500
|
+
* The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
|
|
3501
|
+
* the developer should send only the new (current) entity.
|
|
3502
|
+
* An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
|
|
3503
|
+
* Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
|
|
3504
|
+
* @internal
|
|
3505
|
+
* @deprecated
|
|
3506
|
+
*/
|
|
3507
|
+
previousEntityAsJson?: string | null;
|
|
3508
|
+
/**
|
|
3509
|
+
* Map of fully qualified field paths to their previous values for fields that changed.
|
|
3510
|
+
* For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
|
|
3511
|
+
* @internal
|
|
3512
|
+
*/
|
|
3513
|
+
modifiedFields?: Record<string, any>;
|
|
3514
|
+
/**
|
|
3515
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
3516
|
+
* @internal
|
|
3517
|
+
*/
|
|
3518
|
+
additionalMetadataAsJson?: string | null;
|
|
3020
3519
|
}
|
|
3021
3520
|
interface EntityDeletedEvent {
|
|
3521
|
+
/**
|
|
3522
|
+
* Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
|
|
3523
|
+
* @internal
|
|
3524
|
+
*/
|
|
3525
|
+
movedToTrash?: boolean | null;
|
|
3022
3526
|
/** Entity that was deleted. */
|
|
3023
3527
|
deletedEntityAsJson?: string | null;
|
|
3528
|
+
/**
|
|
3529
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
3530
|
+
* @internal
|
|
3531
|
+
*/
|
|
3532
|
+
additionalMetadataAsJson?: string | null;
|
|
3024
3533
|
}
|
|
3025
3534
|
interface ActionEvent {
|
|
3026
3535
|
bodyAsJson?: string;
|
|
@@ -3145,6 +3654,12 @@ interface GetCartRequest {
|
|
|
3145
3654
|
* @format GUID
|
|
3146
3655
|
*/
|
|
3147
3656
|
id: string;
|
|
3657
|
+
/**
|
|
3658
|
+
* Whether to override default cart refresh behavior.
|
|
3659
|
+
* If `true`, always refreshes the cart; if `false`, never refreshes; if unset, uses the default refresh logic.
|
|
3660
|
+
* @internal
|
|
3661
|
+
*/
|
|
3662
|
+
refreshOverride?: boolean | null;
|
|
3148
3663
|
}
|
|
3149
3664
|
interface GetCartResponse {
|
|
3150
3665
|
/** Retrieved cart. */
|