@wix/auto_sdk_ecom_current-cart-v-2 1.0.0

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.
Files changed (39) hide show
  1. package/build/cjs/index.d.ts +2823 -0
  2. package/build/cjs/index.js +1871 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +1764 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +2191 -0
  8. package/build/cjs/meta.js +1108 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/es/index.d.mts +2823 -0
  11. package/build/es/index.mjs +1812 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/es/index.typings.d.mts +1 -0
  14. package/build/es/index.typings.mjs +1705 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/es/meta.d.mts +2191 -0
  17. package/build/es/meta.mjs +1069 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/es/package.json +3 -0
  20. package/build/internal/cjs/index.d.ts +162 -0
  21. package/build/internal/cjs/index.js +1871 -0
  22. package/build/internal/cjs/index.js.map +1 -0
  23. package/build/internal/cjs/index.typings.d.ts +3008 -0
  24. package/build/internal/cjs/index.typings.js +1764 -0
  25. package/build/internal/cjs/index.typings.js.map +1 -0
  26. package/build/internal/cjs/meta.d.ts +2192 -0
  27. package/build/internal/cjs/meta.js +1108 -0
  28. package/build/internal/cjs/meta.js.map +1 -0
  29. package/build/internal/es/index.d.mts +162 -0
  30. package/build/internal/es/index.mjs +1812 -0
  31. package/build/internal/es/index.mjs.map +1 -0
  32. package/build/internal/es/index.typings.d.mts +3008 -0
  33. package/build/internal/es/index.typings.mjs +1705 -0
  34. package/build/internal/es/index.typings.mjs.map +1 -0
  35. package/build/internal/es/meta.d.mts +2192 -0
  36. package/build/internal/es/meta.mjs +1069 -0
  37. package/build/internal/es/meta.mjs.map +1 -0
  38. package/meta/package.json +3 -0
  39. package/package.json +54 -0
@@ -0,0 +1,2823 @@
1
+ interface Cart {
2
+ /**
3
+ * Cart ID.
4
+ * @format GUID
5
+ * @readonly
6
+ */
7
+ _id?: string;
8
+ /**
9
+ * Date and time the Cart was created.
10
+ * @readonly
11
+ */
12
+ _createdDate?: Date | null;
13
+ /**
14
+ * Date and time the Cart was last updated.
15
+ * @readonly
16
+ */
17
+ _updatedDate?: Date | null;
18
+ /**
19
+ * Revision number, which increments by 1 each time the Cart is updated.
20
+ * @readonly
21
+ */
22
+ revision?: string | null;
23
+ /**
24
+ * Custom fields.
25
+ * [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.
26
+ */
27
+ extendedFields?: ExtendedFields;
28
+ /**
29
+ * Line items added to the Cart by the customer.
30
+ * This list may include both valid items (in stock) and invalid ones (e.g., out of stock).
31
+ * When submitting an order, only valid items will be included in the order.
32
+ * @maxSize 300
33
+ * @readonly
34
+ */
35
+ lineItems?: V2LineItem[];
36
+ /**
37
+ * The discounts of the Cart.
38
+ * Automatic discounts are removed from the Cart entirely when they are no longer valid.
39
+ * Coupon discounts are not removed from the Cart, but are marked as invalid.
40
+ * @maxSize 100
41
+ * @readonly
42
+ */
43
+ discounts?: Discount[];
44
+ /** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
45
+ source?: CartSource;
46
+ /** Information about the site from which the Cart's line items were added. */
47
+ siteInfo?: SiteInfo;
48
+ /** Information about the customer that owns the Cart. */
49
+ customerInfo?: CustomerInfo;
50
+ /** Delivery-related information associated with the Cart. */
51
+ deliveryInfo?: DeliveryInfo;
52
+ /** Tax-related information associated with the Cart. */
53
+ taxInfo?: TaxInfo;
54
+ /** Payment-related information associated with the Cart. */
55
+ paymentInfo?: PaymentInfo;
56
+ /**
57
+ * The estimated costs that the customer will pay.
58
+ * @readonly
59
+ */
60
+ pricingInfo?: PricingInfo;
61
+ /**
62
+ * The current status of the Cart.
63
+ * @readonly
64
+ */
65
+ status?: CartStatusWithLiterals;
66
+ /**
67
+ * Additional Cart settings.
68
+ *
69
+ * > **Notes:**
70
+ * > * Custom settings can only be set when creating a Cart.
71
+ * > * 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).
72
+ * @immutable
73
+ */
74
+ customSettings?: CustomSettings;
75
+ /**
76
+ * Custom checkout URL to redirect the customer to a checkout page.
77
+ * By default, customers are redirected to the standard Wix checkout page.
78
+ * Clients can override this behavior by providing their own URL here.
79
+ * If the URL contains the placeholder `{checkout_id}`, it will be replaced with the actual Cart ID.
80
+ * @maxLength 2048
81
+ */
82
+ customCheckoutUrl?: string | null;
83
+ /**
84
+ * The ID of the Order created from the Cart.
85
+ * This field is empty until the checkout process is completed.
86
+ * @format GUID
87
+ * @readonly
88
+ */
89
+ orderId?: string | null;
90
+ /**
91
+ * Persistent ID that correlates between the Cart and the created Order (after the checkout is completed).
92
+ * @format GUID
93
+ * @readonly
94
+ */
95
+ purchaseFlowId?: string | null;
96
+ }
97
+ interface ExtendedFields {
98
+ /**
99
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
100
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
101
+ *
102
+ * You can only access fields for which you have the appropriate permissions.
103
+ *
104
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
105
+ */
106
+ namespaces?: Record<string, Record<string, any>>;
107
+ }
108
+ interface V2LineItem {
109
+ /**
110
+ * A unique identifier of the line item within the Cart.
111
+ * @format GUID
112
+ */
113
+ _id?: string;
114
+ /** The name of the line item. */
115
+ name?: TranslatableString;
116
+ /** Quantity-related information about the line item. */
117
+ quantityInfo?: ItemQuantityInfo;
118
+ /** Pricing-related information about the line item. */
119
+ pricing?: ItemPricingInfo;
120
+ /** Information about the origin of the line item. */
121
+ source?: ItemSource;
122
+ /** Details about the item for display purposes. */
123
+ attributes?: ItemAttributes;
124
+ /** Delivery-related information about the line item. */
125
+ deliveryConfig?: ItemDeliveryConfig;
126
+ /** Tax-related information about the line item. */
127
+ taxConfig?: ItemTaxConfig;
128
+ /** Payment-related information about the line item. */
129
+ paymentConfig?: ItemPaymentConfig;
130
+ /** The availability status of the line item according to the inventory. */
131
+ status?: ItemStatusWithLiterals;
132
+ /**
133
+ * Custom extended fields for the line item object.
134
+ *
135
+ * [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.
136
+ */
137
+ extendedFields?: ExtendedFields;
138
+ /**
139
+ * Additional Fees to be added to this item calculation.
140
+ * @maxSize 5
141
+ */
142
+ additionalFees?: AdditionalFee[];
143
+ /**
144
+ * Modifier groups that were added to the item.
145
+ * @maxSize 25
146
+ */
147
+ modifierGroups?: ModifierGroup[];
148
+ /**
149
+ * Whether the item can only be purchased by site members.
150
+ * Default: `false`
151
+ */
152
+ membersOnly?: boolean;
153
+ }
154
+ interface TranslatableString {
155
+ /**
156
+ * __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
157
+ *
158
+ * Min: 1 character.
159
+ * Max: 200 characters.
160
+ * @minLength 1
161
+ * @maxLength 200
162
+ */
163
+ original?: string;
164
+ /**
165
+ * String translated into the buyer's language.
166
+ *
167
+ * Min: 1 character.
168
+ * Max: 400 characters.
169
+ * Default: Same as `original`.
170
+ * @minLength 1
171
+ * @maxLength 400
172
+ */
173
+ translated?: string | null;
174
+ }
175
+ interface ItemQuantityInfo {
176
+ /**
177
+ * The final confirmed quantity of items to be purchased.
178
+ * This value is the minimum between the requested quantity and the available quantity.
179
+ * @min 1
180
+ * @max 100000
181
+ */
182
+ confirmedQuantity?: number;
183
+ /**
184
+ * The amount of items originally requested by the customer.
185
+ * @min 1
186
+ * @max 100000
187
+ */
188
+ requestedQuantity?: number;
189
+ /** The maximum quantity of items available for purchase. */
190
+ availableQuantity?: number | null;
191
+ /** Whether the line item quantity is fixed and cannot be changed. */
192
+ fixedQuantity?: boolean;
193
+ }
194
+ interface ItemPricingInfo {
195
+ /**
196
+ * Final unit price after applying automatic discounts.
197
+ * Includes tax if `tax_info.prices_include_tax` is true.
198
+ */
199
+ unitPrice?: MultiCurrencyPrice;
200
+ /**
201
+ * Final total price for this item (unit price × quantity).
202
+ * Includes tax if `tax_info.prices_include_tax` is true.
203
+ */
204
+ totalPrice?: MultiCurrencyPrice;
205
+ /**
206
+ * Additional description for the price.
207
+ * For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
208
+ */
209
+ priceDescription?: PriceDescription;
210
+ /** Indicates whether the price is not yet defined, and will be updated after the order is created. */
211
+ priceUndetermined?: boolean;
212
+ /** Detailed breakdown of price components. */
213
+ breakdown?: ItemPriceBreakdown;
214
+ }
215
+ interface MultiCurrencyPrice {
216
+ /**
217
+ * Amount.
218
+ * @decimalValue options { gte:0, lte:1000000000000000 }
219
+ */
220
+ amount?: string;
221
+ /**
222
+ * Converted amount.
223
+ * @readonly
224
+ * @decimalValue options { gte:0, lte:1000000000000000 }
225
+ */
226
+ convertedAmount?: string;
227
+ /**
228
+ * Amount formatted with currency symbol.
229
+ * @readonly
230
+ */
231
+ formattedAmount?: string;
232
+ /**
233
+ * Converted amount formatted with currency symbol.
234
+ * @readonly
235
+ */
236
+ formattedConvertedAmount?: string;
237
+ }
238
+ interface PriceDescription {
239
+ /**
240
+ * __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
241
+ * @minLength 1
242
+ * @maxLength 100
243
+ */
244
+ original?: string;
245
+ /**
246
+ * Price description translated into the buyer's language.
247
+ *
248
+ * Default: Same as `original`.
249
+ * @minLength 1
250
+ * @maxLength 100
251
+ */
252
+ translated?: string | null;
253
+ }
254
+ interface ItemPriceBreakdown {
255
+ /**
256
+ * Full catalog price of a single item before any discounts, including modifiers.
257
+ * Includes tax if `tax_info.prices_include_tax` is true.
258
+ */
259
+ fullPrice?: MultiCurrencyPrice;
260
+ /**
261
+ * Catalog sale price of a single item, including modifiers.
262
+ * Includes tax if `tax_info.prices_include_tax` is true.
263
+ */
264
+ salePrice?: MultiCurrencyPrice;
265
+ /**
266
+ * Total price of all item modifiers for the entire quantity of this item.
267
+ * Includes tax if `tax_info.prices_include_tax` is true.
268
+ */
269
+ totalModifiersPrice?: MultiCurrencyPrice;
270
+ /** Total automatic discount applied to the entire quantity of this item. */
271
+ totalDiscount?: MultiCurrencyPrice;
272
+ }
273
+ interface ItemSource {
274
+ /**
275
+ * Whether the line item is a custom line item.
276
+ * Custom line items don't trigger the Catalog service plugin.
277
+ */
278
+ customLineItem?: boolean;
279
+ /**
280
+ * Catalog and item reference.
281
+ * Holds IDs for the item and the catalog it came from, as well as further optional info.
282
+ * Optional for custom line items, which don't trigger the Catalog service plugin.
283
+ */
284
+ catalogReference?: CatalogReference;
285
+ /**
286
+ * Overriding values for catalog item properties.
287
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
288
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
289
+ */
290
+ catalogOverrideFields?: CatalogOverrideFields;
291
+ /**
292
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
293
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
294
+ * + in most cases, this field is the same as `catalogReference.catalogItemId`.
295
+ * + Used in membership validation.
296
+ * @minLength 1
297
+ * @maxLength 36
298
+ */
299
+ rootCatalogItemId?: string | null;
300
+ /**
301
+ * ID of the app managing the inventory.
302
+ * @format GUID
303
+ */
304
+ inventoryAppId?: string | null;
305
+ }
306
+ /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
307
+ interface CatalogReference {
308
+ /**
309
+ * ID of the item within the catalog it belongs to.
310
+ * @minLength 1
311
+ * @maxLength 36
312
+ */
313
+ catalogItemId?: string;
314
+ /**
315
+ * ID of the app providing the catalog.
316
+ *
317
+ * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
318
+ *
319
+ * For items from Wix catalogs, the following values always apply:
320
+ * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
321
+ * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
322
+ * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
323
+ * @minLength 1
324
+ */
325
+ appId?: string;
326
+ /**
327
+ * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
328
+ *
329
+ * For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
330
+ */
331
+ options?: Record<string, any> | null;
332
+ }
333
+ interface CatalogOverrideFields {
334
+ /** The name of the line item. */
335
+ name?: TranslatableString;
336
+ /**
337
+ * The sale price of a single item after modifiers but before automatic discount.
338
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
339
+ */
340
+ salePrice?: string | null;
341
+ /**
342
+ * The full price of a single item after modifiers but before automatic discount.
343
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
344
+ */
345
+ fullPrice?: string | null;
346
+ /**
347
+ * Item description lines.
348
+ * Used when displaying the line item to buyers.
349
+ * @maxSize 20
350
+ */
351
+ descriptionLines?: DescriptionLine[];
352
+ /** Physical properties of the item. */
353
+ physicalProperties?: PhysicalProperties;
354
+ /** Item image. */
355
+ image?: string;
356
+ /** Payment method selected for the item. */
357
+ paymentOption?: PaymentOption;
358
+ /**
359
+ * Partial payment to be paid upfront during the checkout.
360
+ * Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
361
+ * @format DECIMAL_VALUE
362
+ * @decimalValue options { gt:0, lte:999999999, maxScale:3 }
363
+ */
364
+ depositAmount?: string | null;
365
+ /**
366
+ * Whether to save the payment method on the order.
367
+ *
368
+ * Default: `false`
369
+ */
370
+ savePaymentMethod?: boolean | null;
371
+ }
372
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
373
+ /** Description line plain text value. */
374
+ plainText?: PlainTextValue;
375
+ /** Description line color value. */
376
+ colorInfo?: Color;
377
+ /** Description line name. */
378
+ name?: DescriptionLineName;
379
+ }
380
+ /** @oneof */
381
+ interface DescriptionLineValueOneOf {
382
+ /** Description line plain text value. */
383
+ plainText?: PlainTextValue;
384
+ /** Description line color value. */
385
+ colorInfo?: Color;
386
+ }
387
+ /** @oneof */
388
+ interface DescriptionLineDescriptionLineValueOneOf {
389
+ }
390
+ interface DescriptionLineName {
391
+ /**
392
+ * Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
393
+ * @maxLength 100
394
+ */
395
+ original?: string;
396
+ /**
397
+ * Description line name translated into the buyer's language.
398
+ *
399
+ * Default: Same as `original`.
400
+ * @maxLength 200
401
+ */
402
+ translated?: string | null;
403
+ }
404
+ interface PlainTextValue {
405
+ /**
406
+ * Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
407
+ * @maxLength 600
408
+ */
409
+ original?: string;
410
+ /**
411
+ * Description line plain text value translated into the buyer's language.
412
+ *
413
+ * Default: Same as `original`.
414
+ * @maxLength 600
415
+ */
416
+ translated?: string | null;
417
+ }
418
+ interface Color {
419
+ /**
420
+ * Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
421
+ * @maxLength 500
422
+ */
423
+ original?: string;
424
+ /**
425
+ * Description line color name translated into the buyer's language.
426
+ *
427
+ * Default: Same as `original`.
428
+ * @maxLength 500
429
+ */
430
+ translated?: string | null;
431
+ /** HEX or RGB color code for display. */
432
+ code?: string | null;
433
+ }
434
+ declare enum DescriptionLineType {
435
+ /** Unrecognized type. */
436
+ UNRECOGNISED = "UNRECOGNISED",
437
+ /** Plain text type. */
438
+ PLAIN_TEXT = "PLAIN_TEXT",
439
+ /** Color type. */
440
+ COLOR = "COLOR"
441
+ }
442
+ /** @enumType */
443
+ type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
444
+ interface PhysicalProperties {
445
+ /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
446
+ weight?: number | null;
447
+ /**
448
+ * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
449
+ * @maxLength 40
450
+ */
451
+ sku?: string | null;
452
+ /** Whether this line item is shippable. */
453
+ shippable?: boolean;
454
+ }
455
+ interface PaymentOption {
456
+ /**
457
+ * Type of selected payment option for current item.
458
+ *
459
+ * Default: `FULL_PAYMENT_ONLINE`
460
+ */
461
+ value?: PaymentOptionTypeWithLiterals;
462
+ }
463
+ /** Type of selected payment option for catalog item */
464
+ declare enum PaymentOptionType {
465
+ /** The entire payment for this item happens as part of the checkout. */
466
+ FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
467
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
468
+ FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
469
+ /** Payment for this item is done by charging a membership. Any remaining amount not covered by the membership, such as item modifiers, is paid online. */
470
+ MEMBERSHIP = "MEMBERSHIP",
471
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
472
+ DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
473
+ /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
474
+ MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE",
475
+ /**
476
+ * Item price is charged to online membership. Any remaining amount not covered by the membership, such as item modifiers, is paid offline.
477
+ * @documentationMaturity preview
478
+ */
479
+ MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER = "MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER"
480
+ }
481
+ /** @enumType */
482
+ type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE' | 'MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER';
483
+ interface ItemAttributes {
484
+ /**
485
+ * Description lines of the item.
486
+ * @maxSize 100
487
+ */
488
+ descriptionLines?: DescriptionLine[];
489
+ /** The image of the item. */
490
+ image?: string;
491
+ /** URL to the item's page on the site. */
492
+ url?: string;
493
+ /**
494
+ * Policies to be displayed to the buyer on the checkout page.
495
+ * @maxSize 5
496
+ */
497
+ policies?: Policy[];
498
+ /** Item type. Either a preset type or custom. */
499
+ itemType?: ItemType;
500
+ /**
501
+ * Physical properties of the item.
502
+ * When relevant, contains information such as SKU, item weight, and shippability.
503
+ */
504
+ physicalProperties?: PhysicalProperties;
505
+ /** Subscription option information. */
506
+ subscriptionInfo?: SubscriptionOptionInfo;
507
+ /** Service properties. When relevant, this contains information such as date and number of participants. */
508
+ serviceProperties?: ServiceProperties;
509
+ }
510
+ interface Policy {
511
+ /**
512
+ * Policy title - should be translated
513
+ * @minLength 1
514
+ * @maxLength 29
515
+ */
516
+ title?: string | null;
517
+ /**
518
+ * Policy content - should be translated
519
+ * @minLength 1
520
+ * @maxLength 3000
521
+ */
522
+ content?: string;
523
+ }
524
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
525
+ /** Preset item type. */
526
+ preset?: ItemTypeItemTypeWithLiterals;
527
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
528
+ custom?: string;
529
+ }
530
+ /** @oneof */
531
+ interface ItemTypeItemTypeDataOneOf {
532
+ /** Preset item type. */
533
+ preset?: ItemTypeItemTypeWithLiterals;
534
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
535
+ custom?: string;
536
+ }
537
+ declare enum ItemTypeItemType {
538
+ UNRECOGNISED = "UNRECOGNISED",
539
+ PHYSICAL = "PHYSICAL",
540
+ DIGITAL = "DIGITAL",
541
+ GIFT_CARD = "GIFT_CARD",
542
+ SERVICE = "SERVICE"
543
+ }
544
+ /** @enumType */
545
+ type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
546
+ interface SubscriptionOptionInfo {
547
+ /** Subscription option settings. */
548
+ subscriptionSettings?: SubscriptionSettings;
549
+ /** Subscription option title. */
550
+ title?: Title;
551
+ /** Subscription option description. */
552
+ description?: Description;
553
+ }
554
+ interface SubscriptionSettings {
555
+ /** Frequency of recurring payment. */
556
+ frequency?: SubscriptionFrequencyWithLiterals;
557
+ /**
558
+ * Interval of recurring payment.
559
+ *
560
+ * Default: `1`.
561
+ * If SubscriptionFrequency is Day the minimum interval is 7
562
+ * @min 1
563
+ * @max 3650
564
+ */
565
+ interval?: number | null;
566
+ /** Whether subscription is renewed automatically at the end of each period. */
567
+ autoRenewal?: boolean;
568
+ /**
569
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
570
+ * @min 1
571
+ */
572
+ billingCycles?: number | null;
573
+ /** Whether to allow the customer to cancel the subscription.. */
574
+ enableCustomerCancellation?: boolean;
575
+ /**
576
+ * Period until first cycle starts. If applied payNow will be 0
577
+ * If None => no free trial
578
+ */
579
+ freeTrialPeriod?: FreeTrialPeriod;
580
+ }
581
+ /** Frequency unit of recurring payment */
582
+ declare enum SubscriptionFrequency {
583
+ UNDEFINED = "UNDEFINED",
584
+ DAY = "DAY",
585
+ WEEK = "WEEK",
586
+ MONTH = "MONTH",
587
+ YEAR = "YEAR"
588
+ }
589
+ /** @enumType */
590
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
591
+ interface FreeTrialPeriod {
592
+ /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
593
+ frequency?: SubscriptionFrequencyWithLiterals;
594
+ /**
595
+ * interval of period
596
+ * @min 1
597
+ * @max 999
598
+ */
599
+ interval?: number;
600
+ }
601
+ interface Title {
602
+ /**
603
+ * Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
604
+ * @minLength 1
605
+ * @maxLength 150
606
+ */
607
+ original?: string;
608
+ /**
609
+ * Subscription option name translated into the buyer's language.
610
+ *
611
+ * Default: Same as `original`.
612
+ * @minLength 1
613
+ * @maxLength 150
614
+ */
615
+ translated?: string | null;
616
+ }
617
+ interface Description {
618
+ /**
619
+ * Subscription option description.
620
+ * @maxLength 500
621
+ */
622
+ original?: string;
623
+ /**
624
+ * Translated subscription option description.
625
+ * @maxLength 500
626
+ */
627
+ translated?: string | null;
628
+ }
629
+ interface SecuredMedia {
630
+ /**
631
+ * Media ID in Wix Media Manager.
632
+ * @minLength 1
633
+ * @maxLength 100
634
+ */
635
+ _id?: string;
636
+ /**
637
+ * Original filename.
638
+ * @minLength 1
639
+ * @maxLength 1000
640
+ */
641
+ fileName?: string;
642
+ /** File type. */
643
+ fileType?: FileTypeWithLiterals;
644
+ }
645
+ declare enum FileType {
646
+ UNSPECIFIED = "UNSPECIFIED",
647
+ SECURE_PICTURE = "SECURE_PICTURE",
648
+ SECURE_VIDEO = "SECURE_VIDEO",
649
+ SECURE_DOCUMENT = "SECURE_DOCUMENT",
650
+ SECURE_MUSIC = "SECURE_MUSIC",
651
+ SECURE_ARCHIVE = "SECURE_ARCHIVE"
652
+ }
653
+ /** @enumType */
654
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
655
+ interface ServiceProperties {
656
+ /**
657
+ * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
658
+ * For example, the start time of a class.
659
+ */
660
+ scheduledDate?: Date | null;
661
+ /**
662
+ * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
663
+ * @min 1
664
+ * @max 10000
665
+ */
666
+ numberOfParticipants?: number | null;
667
+ }
668
+ interface ItemDeliveryConfig {
669
+ /**
670
+ * Delivery profile ID.
671
+ * @format GUID
672
+ */
673
+ deliveryProfileId?: string | null;
674
+ /**
675
+ * An optional custom fulfiller's ID.
676
+ * @format GUID
677
+ */
678
+ fulfillerId?: string | null;
679
+ }
680
+ interface ItemTaxConfig {
681
+ /** Address to use for tax calculation purposes. */
682
+ taxableAddress?: TaxableAddress;
683
+ /**
684
+ * Tax group ID for this line item.
685
+ * @maxLength 50
686
+ */
687
+ taxGroupId?: string | null;
688
+ }
689
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
690
+ /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
691
+ addressType?: TaxableAddressTypeWithLiterals;
692
+ }
693
+ /** @oneof */
694
+ interface TaxableAddressTaxableAddressDataOneOf {
695
+ /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
696
+ addressType?: TaxableAddressTypeWithLiterals;
697
+ }
698
+ declare enum TaxableAddressType {
699
+ UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
700
+ BUSINESS = "BUSINESS",
701
+ BILLING = "BILLING",
702
+ SHIPPING = "SHIPPING"
703
+ }
704
+ /** @enumType */
705
+ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
706
+ interface ItemPaymentConfig {
707
+ /**
708
+ * Whether to save the payment method on the order.
709
+ * Default: `false`
710
+ */
711
+ savePaymentMethod?: boolean;
712
+ /**
713
+ * Item payment policy that requires buyer consent to complete purchase.
714
+ * The payment policy will be displayed on the checkout page.
715
+ * @minLength 1
716
+ * @maxLength 2500
717
+ */
718
+ consentRequiredPaymentPolicy?: string | null;
719
+ /**
720
+ * Partial payment to be paid upfront during the checkout.
721
+ * Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
722
+ */
723
+ depositAmount?: MultiCurrencyPrice;
724
+ /**
725
+ * Selected membership to be used as payment for this item.
726
+ * Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`.
727
+ * This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`.
728
+ */
729
+ selectedMembership?: V2SelectedMembership;
730
+ /**
731
+ * Type of selected payment option for current item.
732
+ *
733
+ * Default: `FULL_PAYMENT_ONLINE`
734
+ */
735
+ paymentOption?: PaymentOptionTypeWithLiterals;
736
+ }
737
+ interface V2SelectedMembership {
738
+ /**
739
+ * Membership ID.
740
+ * @minLength 1
741
+ * @maxLength 100
742
+ */
743
+ _id?: string;
744
+ /**
745
+ * ID of the app providing this payment option.
746
+ * @format GUID
747
+ */
748
+ appId?: string;
749
+ }
750
+ declare enum ItemStatus {
751
+ UNKNOWN_ITEM_STATUS = "UNKNOWN_ITEM_STATUS",
752
+ /** The item is available in the requested quantity. */
753
+ AVAILABLE = "AVAILABLE",
754
+ /** Only part of the requested quantity is available. */
755
+ PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE",
756
+ /** The item is out of stock. */
757
+ OUT_OF_STOCK = "OUT_OF_STOCK",
758
+ /** The item is no longer exists in the catalog. */
759
+ NOT_EXISTS = "NOT_EXISTS"
760
+ }
761
+ /** @enumType */
762
+ type ItemStatusWithLiterals = ItemStatus | 'UNKNOWN_ITEM_STATUS' | 'AVAILABLE' | 'PARTIALLY_AVAILABLE' | 'OUT_OF_STOCK' | 'NOT_EXISTS';
763
+ interface AdditionalFee {
764
+ /**
765
+ * Additional fee's unique code or ID.
766
+ * @minLength 1
767
+ * @maxLength 100
768
+ */
769
+ code?: string | null;
770
+ /**
771
+ * Additional fee's name.
772
+ *
773
+ * Max: 50 characters
774
+ * @minLength 1
775
+ * @maxLength 50
776
+ */
777
+ name?: string;
778
+ /**
779
+ * Total additional fees. This `price` does not include any taxes that may apply to these additional fees.
780
+ * @decimalValue options { gte:0, lte:1000000000000000, maxScale:2 }
781
+ */
782
+ price?: string;
783
+ /**
784
+ * Tax details.
785
+ *
786
+ * > **Note:** Tax is not calculated in the returned `price` even when `taxDetails.taxable` is `true`.
787
+ */
788
+ taxDetails?: TaxDetails;
789
+ }
790
+ /** Tax details. */
791
+ interface TaxDetails {
792
+ /** Whether additional fee is taxable. */
793
+ taxable?: boolean;
794
+ /**
795
+ * Reserved for internal use.
796
+ * @format GUID
797
+ */
798
+ taxGroupId?: string | null;
799
+ }
800
+ interface ModifierGroup {
801
+ /**
802
+ * Modifier group ID.
803
+ * @minLength 1
804
+ * @maxLength 36
805
+ * @readonly
806
+ */
807
+ _id?: string;
808
+ /** Modifier group name. */
809
+ name?: TranslatableString;
810
+ /**
811
+ * List of modifiers in this group.
812
+ * @minSize 1
813
+ * @maxSize 25
814
+ */
815
+ modifiers?: ItemModifier[];
816
+ }
817
+ interface ItemModifier {
818
+ /**
819
+ * Modifier ID.
820
+ * @minLength 1
821
+ * @maxLength 36
822
+ * @readonly
823
+ */
824
+ _id?: string;
825
+ /**
826
+ * The quantity of this modifier.
827
+ * @min 1
828
+ * @max 100000
829
+ */
830
+ quantity?: number;
831
+ /** Primary display label for the modifier. */
832
+ label?: TranslatableString;
833
+ /** Additional details. */
834
+ details?: TranslatableString;
835
+ /** The price of the modifier. */
836
+ price?: MultiCurrencyPrice;
837
+ }
838
+ interface Scope {
839
+ /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
840
+ namespace?: string;
841
+ /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
842
+ group?: Group;
843
+ }
844
+ interface Group {
845
+ /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
846
+ name?: string;
847
+ /** Item ID (when the coupon scope is limited to just one item). */
848
+ entityId?: string | null;
849
+ }
850
+ interface Discount {
851
+ /**
852
+ * A unique identifier of the discount within the Cart.
853
+ * @format GUID
854
+ */
855
+ _id?: string;
856
+ /** The display name of the discount. */
857
+ name?: TranslatableString;
858
+ /** The source of the discount, indicating how it was applied. */
859
+ source?: DiscountSource;
860
+ /** The component in the Cart that the discount applies to. */
861
+ scope?: DiscountScopeWithLiterals;
862
+ /**
863
+ * List of benefits provided by the discount.
864
+ * @minSize 1
865
+ * @maxSize 100
866
+ */
867
+ benefits?: DiscountBenefit[];
868
+ /**
869
+ * The current status of the discount.
870
+ * TODO: remodel.
871
+ */
872
+ status?: DiscountStatusWithLiterals;
873
+ /**
874
+ * Number of subscription cycles this discount applies to.
875
+ * If unset, the discount applies to all billing cycles.
876
+ * @min 1
877
+ * @max 1000
878
+ */
879
+ subscriptionCycles?: number | null;
880
+ }
881
+ interface DiscountSource {
882
+ /** The type of the discount source. */
883
+ sourceType?: DiscountSourceTypeWithLiterals;
884
+ /**
885
+ * Coupon code that triggered the discount.
886
+ * Relevant for coupon discounts only.
887
+ * @maxLength 50
888
+ */
889
+ couponCode?: string | null;
890
+ }
891
+ declare enum DiscountSourceType {
892
+ UNKNOWN_DISCOUNT_SOURCE_TYPE = "UNKNOWN_DISCOUNT_SOURCE_TYPE",
893
+ /** The discount was applied automatically by a rule. */
894
+ AUTOMATIC_RULE = "AUTOMATIC_RULE",
895
+ /** The discount was applied by a coupon code. */
896
+ COUPON = "COUPON"
897
+ }
898
+ /** @enumType */
899
+ type DiscountSourceTypeWithLiterals = DiscountSourceType | 'UNKNOWN_DISCOUNT_SOURCE_TYPE' | 'AUTOMATIC_RULE' | 'COUPON';
900
+ declare enum DiscountScope {
901
+ UNKNOWN_DISCOUNT_SCOPE = "UNKNOWN_DISCOUNT_SCOPE",
902
+ /** The discount applies to the cart's subtotal. */
903
+ CART_SUBTOTAL = "CART_SUBTOTAL",
904
+ /** The discount applies to a specific line item. */
905
+ LINE_ITEM = "LINE_ITEM",
906
+ /** The discount applies to the delivery price. */
907
+ DELIVERY = "DELIVERY"
908
+ }
909
+ /** @enumType */
910
+ type DiscountScopeWithLiterals = DiscountScope | 'UNKNOWN_DISCOUNT_SCOPE' | 'CART_SUBTOTAL' | 'LINE_ITEM' | 'DELIVERY';
911
+ interface DiscountBenefit extends DiscountBenefitValueOneOf {
912
+ /** A specific monetary value deducted from the total cost. */
913
+ amountOff?: MultiCurrencyPrice;
914
+ /**
915
+ * The ID of line item that the discount applies to.
916
+ * Relevant for item-level discounts only.
917
+ * @format GUID
918
+ */
919
+ lineItemId?: string | null;
920
+ }
921
+ /** @oneof */
922
+ interface DiscountBenefitValueOneOf {
923
+ /** A specific monetary value deducted from the total cost. */
924
+ amountOff?: MultiCurrencyPrice;
925
+ }
926
+ declare enum DiscountStatus {
927
+ UNKNOWN_DISCOUNT_STATUS = "UNKNOWN_DISCOUNT_STATUS",
928
+ /** The discount is active and valid. */
929
+ ACTIVE = "ACTIVE",
930
+ /** The discount has expired. */
931
+ EXPIRED = "EXPIRED",
932
+ /** The discount was deleted from the system. */
933
+ DELETED = "DELETED",
934
+ /** The discount reached the maximum number of uses. */
935
+ MAX_USAGE_REACHED = "MAX_USAGE_REACHED"
936
+ }
937
+ /** @enumType */
938
+ type DiscountStatusWithLiterals = DiscountStatus | 'UNKNOWN_DISCOUNT_STATUS' | 'ACTIVE' | 'EXPIRED' | 'DELETED' | 'MAX_USAGE_REACHED';
939
+ interface CartSource {
940
+ /**
941
+ * Sales channel that created the Cart.
942
+ * @immutable
943
+ */
944
+ channelType?: ChannelTypeWithLiterals;
945
+ /**
946
+ * References to an external app and resource associated with this Cart.
947
+ * Used for integration and tracking across different platforms.
948
+ * @maxSize 10
949
+ * @immutable
950
+ */
951
+ externalReferences?: ExternalReference[];
952
+ /**
953
+ * ID of the entity that created the Cart.
954
+ * @readonly
955
+ */
956
+ createdBy?: CreatedBy;
957
+ /**
958
+ * Reference IDs for the app and component providing custom checkout page content.
959
+ *
960
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
961
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
962
+ */
963
+ customContentReference?: CustomContentReference;
964
+ }
965
+ declare enum ChannelType {
966
+ /** Unspecified sales channel. This value is not supported. */
967
+ UNSPECIFIED = "UNSPECIFIED",
968
+ /** A web client. */
969
+ WEB = "WEB",
970
+ /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
971
+ POS = "POS",
972
+ /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
973
+ EBAY = "EBAY",
974
+ /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
975
+ AMAZON = "AMAZON",
976
+ /** Other sales platform. */
977
+ OTHER_PLATFORM = "OTHER_PLATFORM",
978
+ /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
979
+ WIX_APP_STORE = "WIX_APP_STORE",
980
+ /** Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) */
981
+ WIX_INVOICES = "WIX_INVOICES",
982
+ /** Wix merchant backoffice. */
983
+ BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
984
+ /** Wish sales channel. */
985
+ WISH = "WISH",
986
+ /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
987
+ CLASS_PASS = "CLASS_PASS",
988
+ /** Global-E sales channel. */
989
+ GLOBAL_E = "GLOBAL_E",
990
+ /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
991
+ FACEBOOK = "FACEBOOK",
992
+ /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
993
+ ETSY = "ETSY",
994
+ /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
995
+ TIKTOK = "TIKTOK",
996
+ /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
997
+ FAIRE_COM = "FAIRE_COM",
998
+ /** PayPal Agentic Checkout sales channel. */
999
+ PAYPAL_AGENTIC_CHECKOUT = "PAYPAL_AGENTIC_CHECKOUT"
1000
+ }
1001
+ /** @enumType */
1002
+ 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';
1003
+ interface ExternalReference {
1004
+ /**
1005
+ * ID of the app associated with the purchase flow.
1006
+ * For example, the Wix Pay Links app ID.
1007
+ * @format GUID
1008
+ * @immutable
1009
+ */
1010
+ appId?: string;
1011
+ /**
1012
+ * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
1013
+ * For example, a Wix Pay Link ID.
1014
+ * @minLength 1
1015
+ * @maxLength 100
1016
+ * @immutable
1017
+ */
1018
+ resourceId?: string | null;
1019
+ }
1020
+ interface CreatedBy extends CreatedByIdOneOf {
1021
+ /**
1022
+ * Site visitor ID (if site visitor is **not** a member).
1023
+ * @format GUID
1024
+ * @readonly
1025
+ */
1026
+ visitorId?: string;
1027
+ /**
1028
+ * Site member ID.
1029
+ * @format GUID
1030
+ * @readonly
1031
+ */
1032
+ memberId?: string;
1033
+ /**
1034
+ * Wix user ID - when the Cart was created by a Wix user on behalf of a buyer.
1035
+ * For example, via POS (point of service).
1036
+ * @format GUID
1037
+ */
1038
+ userId?: string;
1039
+ /**
1040
+ * App ID - when the Cart was created by an external application or Wix service.
1041
+ * @format GUID
1042
+ */
1043
+ appId?: string;
1044
+ }
1045
+ /** @oneof */
1046
+ interface CreatedByIdOneOf {
1047
+ /**
1048
+ * Site visitor ID (if site visitor is **not** a member).
1049
+ * @format GUID
1050
+ * @readonly
1051
+ */
1052
+ visitorId?: string;
1053
+ /**
1054
+ * Site member ID.
1055
+ * @format GUID
1056
+ * @readonly
1057
+ */
1058
+ memberId?: string;
1059
+ /**
1060
+ * Wix user ID - when the Cart was created by a Wix user on behalf of a buyer.
1061
+ * For example, via POS (point of service).
1062
+ * @format GUID
1063
+ */
1064
+ userId?: string;
1065
+ /**
1066
+ * App ID - when the Cart was created by an external application or Wix service.
1067
+ * @format GUID
1068
+ */
1069
+ appId?: string;
1070
+ }
1071
+ interface CustomContentReference {
1072
+ /**
1073
+ * ID of the app providing the content.
1074
+ *
1075
+ * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1076
+ * @format GUID
1077
+ */
1078
+ appId?: string;
1079
+ /**
1080
+ * ID of the component within the app it belongs to.
1081
+ *
1082
+ * You can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1083
+ * @format GUID
1084
+ */
1085
+ componentId?: string;
1086
+ }
1087
+ interface SiteInfo {
1088
+ /**
1089
+ * The ID of the business location associated with the cart.
1090
+ * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
1091
+ * @format GUID
1092
+ */
1093
+ businessLocationId?: string | null;
1094
+ /**
1095
+ * The business’s unit of weight measurement (e.g., KG, LB).
1096
+ * @readonly
1097
+ */
1098
+ weightUnit?: WeightUnitWithLiterals;
1099
+ /**
1100
+ * The business’s default language, represented as a two-letter ISO 639-1 code.
1101
+ * @format LANGUAGE
1102
+ * @readonly
1103
+ */
1104
+ languageCode?: string;
1105
+ /**
1106
+ * The business’s default currency, represented as a three-letter ISO 4217 code.
1107
+ * @format CURRENCY
1108
+ * @readonly
1109
+ */
1110
+ currencyCode?: string;
1111
+ }
1112
+ declare enum WeightUnit {
1113
+ /** Weight unit can't be classified due to an error. */
1114
+ UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1115
+ /** Kilograms. */
1116
+ KG = "KG",
1117
+ /** Pounds. */
1118
+ LB = "LB"
1119
+ }
1120
+ /** @enumType */
1121
+ type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
1122
+ interface CustomerInfo extends CustomerInfoIdOneOf {
1123
+ /**
1124
+ * Site visitor ID (if site visitor is **not** a member).
1125
+ * @format GUID
1126
+ * @readonly
1127
+ */
1128
+ visitorId?: string;
1129
+ /**
1130
+ * Site member ID.
1131
+ * @format GUID
1132
+ * @readonly
1133
+ */
1134
+ memberId?: string;
1135
+ /**
1136
+ * Wix user ID - when the Cart was created by a Wix user on behalf of a customer.
1137
+ * For example, via POS (point of service).
1138
+ * @format GUID
1139
+ * @readonly
1140
+ */
1141
+ userId?: string;
1142
+ /**
1143
+ * The Contact ID of the customer.
1144
+ * Created automatically if one does not yet exist.
1145
+ * For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
1146
+ * @format GUID
1147
+ * @readonly
1148
+ */
1149
+ contactId?: string | null;
1150
+ /**
1151
+ * The customer's email address.
1152
+ * @format EMAIL
1153
+ */
1154
+ email?: string | null;
1155
+ /**
1156
+ * The customer's language, represented as a two-letter ISO 639-1 code.
1157
+ * Resolved automatically from the request metadata ('x-wix-linguist' header).
1158
+ * @format LANGUAGE
1159
+ * @readonly
1160
+ */
1161
+ languageCode?: string;
1162
+ /**
1163
+ * The customer’s currency, represented as a three-letter ISO 4217 code.
1164
+ * Resolved automatically from the request metadata ('x-wix-currency' header).
1165
+ * @format CURRENCY
1166
+ * @readonly
1167
+ */
1168
+ currencyCode?: string;
1169
+ /**
1170
+ * The [buyer note](https://support.wix.com/en/article/wix-stores-viewing-customer-notes) left by the customer.
1171
+ * @maxLength 1000
1172
+ */
1173
+ buyerNote?: string | null;
1174
+ }
1175
+ /** @oneof */
1176
+ interface CustomerInfoIdOneOf {
1177
+ /**
1178
+ * Site visitor ID (if site visitor is **not** a member).
1179
+ * @format GUID
1180
+ * @readonly
1181
+ */
1182
+ visitorId?: string;
1183
+ /**
1184
+ * Site member ID.
1185
+ * @format GUID
1186
+ * @readonly
1187
+ */
1188
+ memberId?: string;
1189
+ /**
1190
+ * Wix user ID - when the Cart was created by a Wix user on behalf of a customer.
1191
+ * For example, via POS (point of service).
1192
+ * @format GUID
1193
+ * @readonly
1194
+ */
1195
+ userId?: string;
1196
+ }
1197
+ interface DeliveryInfo {
1198
+ /** The delivery address. */
1199
+ address?: Address;
1200
+ /** The delivery recipient. */
1201
+ recipient?: FullAddressContactDetails;
1202
+ /** The selected delivery method by the customer. */
1203
+ method?: DeliveryMethod;
1204
+ }
1205
+ /** Physical address */
1206
+ interface Address {
1207
+ /**
1208
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1209
+ * @format COUNTRY
1210
+ */
1211
+ country?: string | null;
1212
+ /**
1213
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
1214
+ * @maxLength 50
1215
+ */
1216
+ subdivision?: string | null;
1217
+ /**
1218
+ * City name.
1219
+ * @maxLength 50
1220
+ */
1221
+ city?: string | null;
1222
+ /**
1223
+ * Postal or zip code.
1224
+ * @maxLength 50
1225
+ */
1226
+ postalCode?: string | null;
1227
+ /** Street address. */
1228
+ streetAddress?: StreetAddress;
1229
+ /**
1230
+ * Main address line (usually street name and number).
1231
+ * @maxLength 150
1232
+ */
1233
+ addressLine1?: string | null;
1234
+ /**
1235
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
1236
+ * @maxLength 100
1237
+ */
1238
+ addressLine2?: string | null;
1239
+ /**
1240
+ * Country's full name.
1241
+ * @readonly
1242
+ */
1243
+ countryFullname?: string | null;
1244
+ /**
1245
+ * Subdivision full-name.
1246
+ * @readonly
1247
+ */
1248
+ subdivisionFullname?: string | null;
1249
+ }
1250
+ interface StreetAddress {
1251
+ /** Street number. */
1252
+ number?: string;
1253
+ /** Street name. */
1254
+ name?: string;
1255
+ }
1256
+ interface AddressLocation {
1257
+ /** Address latitude. */
1258
+ latitude?: number | null;
1259
+ /** Address longitude. */
1260
+ longitude?: number | null;
1261
+ }
1262
+ /** Full contact details for an address */
1263
+ interface FullAddressContactDetails {
1264
+ /**
1265
+ * First name.
1266
+ * @maxLength 100
1267
+ */
1268
+ firstName?: string | null;
1269
+ /**
1270
+ * Last name.
1271
+ * @maxLength 100
1272
+ */
1273
+ lastName?: string | null;
1274
+ /**
1275
+ * Phone number.
1276
+ * @format PHONE
1277
+ */
1278
+ phone?: string | null;
1279
+ /**
1280
+ * Company name.
1281
+ * @maxLength 1000
1282
+ */
1283
+ company?: string | null;
1284
+ /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1285
+ vatId?: VatId;
1286
+ }
1287
+ interface VatId {
1288
+ /** Customer's tax ID. */
1289
+ _id?: string;
1290
+ /**
1291
+ * Tax type.
1292
+ *
1293
+ * Supported values:
1294
+ * + `CPF`: for individual tax payers
1295
+ * + `CNPJ`: for corporations
1296
+ */
1297
+ type?: VatTypeWithLiterals;
1298
+ }
1299
+ /** tax info types */
1300
+ declare enum VatType {
1301
+ UNSPECIFIED = "UNSPECIFIED",
1302
+ /** CPF - for individual tax payers. */
1303
+ CPF = "CPF",
1304
+ /** CNPJ - for corporations */
1305
+ CNPJ = "CNPJ"
1306
+ }
1307
+ /** @enumType */
1308
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1309
+ interface DeliveryMethod {
1310
+ /**
1311
+ * The carrier app id
1312
+ * @format GUID
1313
+ */
1314
+ appId?: string;
1315
+ /**
1316
+ * Unique code that acts as an ID for a shipping rate.
1317
+ * For example, `"usps_std_overnight"`.
1318
+ * @maxLength 250
1319
+ */
1320
+ code?: string;
1321
+ /**
1322
+ * Delivery rate title.
1323
+ * For example, `"USPS Standard Overnight Delivery"`, `"Standard"`, or `"First-Class Package International"`.
1324
+ * @readonly
1325
+ */
1326
+ title?: TranslatableString;
1327
+ /**
1328
+ * Whether the delivery method is a pickup option.
1329
+ * @readonly
1330
+ */
1331
+ pickup?: boolean;
1332
+ }
1333
+ interface TaxInfo {
1334
+ /**
1335
+ * Indicates whether tax is already included in prices (line items, discounts, delivery, additional fess).
1336
+ * @readonly
1337
+ */
1338
+ pricesIncludeTax?: boolean;
1339
+ }
1340
+ interface PaymentInfo {
1341
+ /**
1342
+ * A list of gift cards to pay with.
1343
+ * Currently only one gift card is supported.
1344
+ * @readonly
1345
+ * @maxSize 1
1346
+ */
1347
+ giftCards?: GiftCard[];
1348
+ /**
1349
+ * The currency to pay with, represented as a three-letter ISO 4217 code.
1350
+ * @format CURRENCY
1351
+ * @readonly
1352
+ */
1353
+ currencyCode?: string;
1354
+ /** Billing address. */
1355
+ billingAddress?: Address;
1356
+ /** Full contact details for billing. */
1357
+ billingContact?: FullAddressContactDetails;
1358
+ }
1359
+ interface GiftCard {
1360
+ /**
1361
+ * A unique identifier of the gift card within the Cart.
1362
+ * @format GUID
1363
+ * @readonly
1364
+ */
1365
+ _id?: string;
1366
+ /**
1367
+ * A partially hidden version of the actual gift card code
1368
+ * @maxLength 50
1369
+ * @readonly
1370
+ */
1371
+ obfuscatedCode?: string;
1372
+ /**
1373
+ * App ID of the gift card provider.
1374
+ * @format GUID
1375
+ * @readonly
1376
+ */
1377
+ appId?: string;
1378
+ /**
1379
+ * External ID in the gift card provider's system.
1380
+ * Used for integration and tracking across different platforms.
1381
+ * @minLength 1
1382
+ * @maxLength 50
1383
+ */
1384
+ externalId?: string | null;
1385
+ }
1386
+ interface PricingInfo {
1387
+ /** The sum of all line items after applying automatic discounts. */
1388
+ subtotal?: MultiCurrencyPrice;
1389
+ /** The coupon discount amount. Automatic discounts are not included in this amount. */
1390
+ discount?: MultiCurrencyPrice;
1391
+ /** The sum of all line items after applying all discounts. */
1392
+ discountedSubtotal?: MultiCurrencyPrice;
1393
+ }
1394
+ declare enum CartStatus {
1395
+ /** A new Cart. */
1396
+ CREATED = "CREATED",
1397
+ /** The checkout process is completed. */
1398
+ CHECKOUT_COMPLETED = "CHECKOUT_COMPLETED"
1399
+ }
1400
+ /** @enumType */
1401
+ type CartStatusWithLiterals = CartStatus | 'CREATED' | 'CHECKOUT_COMPLETED';
1402
+ interface CustomSettings {
1403
+ /**
1404
+ * Whether to restrict the option to add or remove a gift card on the checkout page.
1405
+ * Default: `false`
1406
+ */
1407
+ lockGiftCard?: boolean;
1408
+ /**
1409
+ * Whether to restrict the option to add or remove a coupon code on the checkout page.
1410
+ * Default: `false`
1411
+ */
1412
+ lockCouponCode?: boolean;
1413
+ /**
1414
+ * Whether to disable policy agreement checkout in the checkout page.
1415
+ * Default: `false`
1416
+ */
1417
+ policyAgreementCheckboxDisabled?: boolean;
1418
+ /**
1419
+ * Whether to disable manual payment option for this checkout.
1420
+ * Default: `false`
1421
+ */
1422
+ manualPaymentDisabled?: boolean;
1423
+ }
1424
+ interface CartSummary {
1425
+ /**
1426
+ * The Cart ID.
1427
+ * @format GUID
1428
+ */
1429
+ cartId?: string;
1430
+ /**
1431
+ * Summarized details for each line item in the cart.
1432
+ * @maxSize 300
1433
+ */
1434
+ lineItems?: LineItemSummary[];
1435
+ /**
1436
+ * List of discounts applied to the cart.
1437
+ * @maxSize 100
1438
+ */
1439
+ discounts?: Discount[];
1440
+ /** Summary of the delivery costs. */
1441
+ deliverySummary?: DeliverySummary;
1442
+ /**
1443
+ * List of additional fees applied to the cart.
1444
+ * @maxSize 100
1445
+ */
1446
+ additionalFees?: V2AdditionalFee[];
1447
+ /** Summary of tax calculations applied to the cart. */
1448
+ taxSummary?: TaxSummary;
1449
+ /** Summary of all calculated price components in the cart. */
1450
+ priceSummary?: PriceSummary;
1451
+ /** Payment details summarizing how the customer will pay for the order. */
1452
+ paymentSummary?: PaymentSummary;
1453
+ /**
1454
+ * List of errors that occurred during the calculation process.
1455
+ * @maxSize 100
1456
+ */
1457
+ errors?: CalculationError[];
1458
+ /**
1459
+ * List of business violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
1460
+ * @maxSize 100
1461
+ */
1462
+ violations?: Violation[];
1463
+ /**
1464
+ * A token representing the Cart's calculated prices.
1465
+ *
1466
+ * The client can pass this token when completing the checkout to ensure that the
1467
+ * prices the customer saw match the final prices at checkout.
1468
+ *
1469
+ * The server will validate the token if provided by recalculating the cart and comparing the
1470
+ * resulting pricing token. If the validation fails, the checkout will be rejected.
1471
+ *
1472
+ * This mechanism protects against unexpected price changes or tampering between
1473
+ * cart calculation and order placement.
1474
+ *
1475
+ * The token is opaque and should not be parsed or modified by clients.
1476
+ * @maxLength 1024
1477
+ */
1478
+ priceVerificationToken?: string | null;
1479
+ }
1480
+ interface LineItemSummary {
1481
+ /**
1482
+ * Line item ID.
1483
+ * @format GUID
1484
+ */
1485
+ lineItemId?: string;
1486
+ /**
1487
+ * The quantity of the line item.
1488
+ * @min 1
1489
+ * @max 100000
1490
+ */
1491
+ quantity?: number;
1492
+ /**
1493
+ * Final unit price after applying automatic discounts.
1494
+ * Includes tax if `tax_summary.prices_include_tax` is true.
1495
+ */
1496
+ unitPrice?: MultiCurrencyPrice;
1497
+ /**
1498
+ * Total price for the line item (unit price × quantity).
1499
+ * Includes tax if `tax_summary.prices_include_tax` is true.
1500
+ */
1501
+ totalPrice?: MultiCurrencyPrice;
1502
+ }
1503
+ interface DeliverySummary {
1504
+ /** The calculated delivery method. */
1505
+ method?: DeliveryMethod;
1506
+ /**
1507
+ * Delivery price after discount.
1508
+ * Includes tax if `tax_summary.prices_include_tax` is true.
1509
+ */
1510
+ price?: MultiCurrencyPrice;
1511
+ }
1512
+ interface V2AdditionalFee {
1513
+ /**
1514
+ * Additional fee's code.
1515
+ * @minLength 1
1516
+ * @maxLength 100
1517
+ */
1518
+ code?: string | null;
1519
+ /** Additional fee's name. */
1520
+ name?: TranslatableString;
1521
+ /**
1522
+ * Provider's app id.
1523
+ * @minLength 1
1524
+ * @maxLength 100
1525
+ */
1526
+ providerAppId?: string | null;
1527
+ /**
1528
+ * The line items associated with this fee.
1529
+ * If the list is empty, the fee will be associated with the entire cart.
1530
+ * @format GUID
1531
+ * @maxSize 100
1532
+ */
1533
+ lineItemIds?: string[];
1534
+ /**
1535
+ * Additional fee's price.
1536
+ * Includes tax if `tax_summary.prices_include_tax` is true.
1537
+ */
1538
+ price?: MultiCurrencyPrice;
1539
+ /**
1540
+ * Number of subscription cycle this fee applies to.
1541
+ * If None and discount is linked to subscription line item, it applies to all cycles.
1542
+ * @min 1
1543
+ * @max 999
1544
+ */
1545
+ subscriptionCycles?: number | null;
1546
+ }
1547
+ interface TaxSummary {
1548
+ /**
1549
+ * List of taxes applied to the cart.
1550
+ * @maxSize 100
1551
+ */
1552
+ taxes?: Tax[];
1553
+ /**
1554
+ * Indicates whether tax is already included in prices (line items, discounts, delivery, additional fess).
1555
+ * @readonly
1556
+ */
1557
+ pricesIncludeTax?: boolean;
1558
+ /**
1559
+ * Taxes applied to line items.
1560
+ * @maxSize 300
1561
+ */
1562
+ lineItemTaxes?: LineItemTax[];
1563
+ /** Tax applied to the delivery method. */
1564
+ deliveryTax?: MultiCurrencyPrice;
1565
+ /**
1566
+ * Taxes applied to additional fees.
1567
+ * @maxSize 100
1568
+ */
1569
+ additionalFeeTaxes?: AdditionalFeeTax[];
1570
+ }
1571
+ interface Tax {
1572
+ /** The name of the tax. */
1573
+ name?: TranslatableString;
1574
+ /** Amount for which tax is calculated. */
1575
+ taxableAmount?: MultiCurrencyPrice;
1576
+ /**
1577
+ * Tax rate %, as a decimal point between 0 and 1.
1578
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
1579
+ */
1580
+ rate?: string;
1581
+ /** Calculated tax, based on `taxable_amount` and `rate`. */
1582
+ totalTax?: MultiCurrencyPrice;
1583
+ }
1584
+ interface LineItemTax {
1585
+ /**
1586
+ * Line item ID.
1587
+ * @format GUID
1588
+ */
1589
+ lineItemId?: string;
1590
+ /** Tax amount applied to the additional fee. */
1591
+ tax?: MultiCurrencyPrice;
1592
+ }
1593
+ interface AdditionalFeeTax {
1594
+ /**
1595
+ * Additional fee's code.
1596
+ * @minLength 1
1597
+ * @maxLength 100
1598
+ */
1599
+ additionalFeeCode?: string;
1600
+ /** Tax amount applied to the additional fee. */
1601
+ tax?: MultiCurrencyPrice;
1602
+ }
1603
+ interface PriceSummary {
1604
+ /**
1605
+ * Total price of all line items after applying item-level discounts.
1606
+ * FIXME: Currently we don't know if the subtotal includes tax or not.
1607
+ */
1608
+ subtotal?: MultiCurrencyPrice;
1609
+ /**
1610
+ * Total cart-level discount applied to the subtotal.
1611
+ * Line-item discounts are reflected in the subtotal and not included here.
1612
+ * Currently supports only a single coupon.
1613
+ */
1614
+ discount?: MultiCurrencyPrice;
1615
+ /**
1616
+ * Final delivery cost for the cart.
1617
+ * FIXME: Currently we don't know if the subtotal includes tax or not.
1618
+ */
1619
+ delivery?: MultiCurrencyPrice;
1620
+ /**
1621
+ * Total additional fees associated with the cart.
1622
+ * FIXME: Currently we don't know if the subtotal includes tax or not.
1623
+ */
1624
+ additionalFees?: MultiCurrencyPrice;
1625
+ /** Total tax amount calculated across all applicable components (items, discounts, delivery, and fees). */
1626
+ tax?: MultiCurrencyPrice;
1627
+ /**
1628
+ * Total amount to be paid.
1629
+ * Curenntly, total = subtotal - discount + delivery + additional_fees + tax.
1630
+ */
1631
+ total?: MultiCurrencyPrice;
1632
+ }
1633
+ interface PaymentSummary {
1634
+ /**
1635
+ * The amount that will be deducted from each gift card added to the cart.
1636
+ * Currently, only one gift card is supported.
1637
+ * @maxSize 1
1638
+ */
1639
+ giftCards?: GiftCardSummary[];
1640
+ /**
1641
+ * A list of valid memberships that will be charged as part of the order.
1642
+ * @maxSize 300
1643
+ */
1644
+ memberships?: SelectedMembership[];
1645
+ /** Indicates whether a remaining payment is required to create the order, after applying gift cards. */
1646
+ requiresPaymentAfterGiftCard?: boolean;
1647
+ /** The total amount due after applying all gift cards. */
1648
+ totalAfterGiftCards?: MultiCurrencyPrice;
1649
+ /** The upfront amount to be charged immediately when placing the order (after applying gift cards). */
1650
+ payNow?: MultiCurrencyPrice;
1651
+ /** The remaining amount to be collected later. */
1652
+ payLater?: MultiCurrencyPrice;
1653
+ /** The amount to be charged after a free trial period (typically for subscription-based products). */
1654
+ payAfterFreeTrial?: MultiCurrencyPrice;
1655
+ }
1656
+ interface GiftCardSummary {
1657
+ /**
1658
+ * The ID of the gift card assigned by the Cart.
1659
+ * @format GUID
1660
+ */
1661
+ giftCardId?: string;
1662
+ /** The amount to be reduced from the gift card's balance. */
1663
+ redeemAmount?: MultiCurrencyPrice;
1664
+ }
1665
+ interface SelectedMembership {
1666
+ /**
1667
+ * Membership ID.
1668
+ * @minLength 1
1669
+ * @maxLength 100
1670
+ */
1671
+ _id?: string;
1672
+ /**
1673
+ * ID of the app providing this payment option.
1674
+ * @format GUID
1675
+ */
1676
+ appId?: string;
1677
+ /**
1678
+ * IDs of the line items this membership applies to.
1679
+ * @minSize 1
1680
+ * @maxSize 300
1681
+ * @minLength 1
1682
+ * @maxLength 100
1683
+ */
1684
+ lineItemIds?: string[];
1685
+ }
1686
+ interface CalculationError {
1687
+ /** The calculation component that caused the error. */
1688
+ component?: CalculationComponentWithLiterals;
1689
+ /** Machine-readable error code. */
1690
+ code?: ErrorCodeWithLiterals;
1691
+ /**
1692
+ * Human-readable explanation.
1693
+ * @maxLength 100
1694
+ */
1695
+ description?: string | null;
1696
+ }
1697
+ declare enum CalculationComponent {
1698
+ UNKNOWN_CALCULATION_COMPONENT = "UNKNOWN_CALCULATION_COMPONENT",
1699
+ DISCOUNTS = "DISCOUNTS",
1700
+ DELIVERY = "DELIVERY",
1701
+ TAX = "TAX",
1702
+ MEMBERSHIPS = "MEMBERSHIPS",
1703
+ GIFT_CARDS = "GIFT_CARDS"
1704
+ }
1705
+ /** @enumType */
1706
+ type CalculationComponentWithLiterals = CalculationComponent | 'UNKNOWN_CALCULATION_COMPONENT' | 'DISCOUNTS' | 'DELIVERY' | 'TAX' | 'MEMBERSHIPS' | 'GIFT_CARDS';
1707
+ declare enum ErrorCode {
1708
+ UNKNOWN_ERROR_CODE = "UNKNOWN_ERROR_CODE"
1709
+ }
1710
+ /** @enumType */
1711
+ type ErrorCodeWithLiterals = ErrorCode | 'UNKNOWN_ERROR_CODE';
1712
+ interface Details extends DetailsKindOneOf {
1713
+ applicationError?: ApplicationError;
1714
+ validationError?: ValidationError;
1715
+ systemError?: SystemError;
1716
+ /**
1717
+ * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
1718
+ * @deprecated
1719
+ */
1720
+ tracing?: Record<string, string>;
1721
+ }
1722
+ /** @oneof */
1723
+ interface DetailsKindOneOf {
1724
+ applicationError?: ApplicationError;
1725
+ validationError?: ValidationError;
1726
+ systemError?: SystemError;
1727
+ }
1728
+ interface ApplicationError {
1729
+ /** Error code. */
1730
+ code?: string;
1731
+ /** Description of the error. */
1732
+ description?: string;
1733
+ /** Data related to the error. */
1734
+ data?: Record<string, any> | null;
1735
+ }
1736
+ /**
1737
+ * example result:
1738
+ * {
1739
+ * "fieldViolations": [
1740
+ * {
1741
+ * "field": "fieldA",
1742
+ * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
1743
+ * "violatedRule": "OTHER",
1744
+ * "ruleName": "INVALID_NOTE",
1745
+ * "data": {
1746
+ * "value": "FI"
1747
+ * }
1748
+ * },
1749
+ * {
1750
+ * "field": "fieldB",
1751
+ * "description": "field value out of range. supported range: [0-20]",
1752
+ * "violatedRule": "MAX",
1753
+ * "data": {
1754
+ * "threshold": 20
1755
+ * }
1756
+ * },
1757
+ * {
1758
+ * "field": "fieldC",
1759
+ * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
1760
+ * "violatedRule": "FORMAT",
1761
+ * "data": {
1762
+ * "type": "PHONE"
1763
+ * }
1764
+ * }
1765
+ * ]
1766
+ * }
1767
+ */
1768
+ interface ValidationError {
1769
+ fieldViolations?: FieldViolation[];
1770
+ }
1771
+ declare enum RuleType {
1772
+ VALIDATION = "VALIDATION",
1773
+ OTHER = "OTHER",
1774
+ MAX = "MAX",
1775
+ MIN = "MIN",
1776
+ MAX_LENGTH = "MAX_LENGTH",
1777
+ MIN_LENGTH = "MIN_LENGTH",
1778
+ MAX_SIZE = "MAX_SIZE",
1779
+ MIN_SIZE = "MIN_SIZE",
1780
+ FORMAT = "FORMAT",
1781
+ DECIMAL_LTE = "DECIMAL_LTE",
1782
+ DECIMAL_GTE = "DECIMAL_GTE",
1783
+ DECIMAL_LT = "DECIMAL_LT",
1784
+ DECIMAL_GT = "DECIMAL_GT",
1785
+ DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
1786
+ INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
1787
+ REQUIRED_FIELD = "REQUIRED_FIELD",
1788
+ FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
1789
+ ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT",
1790
+ EXACT_LENGTH = "EXACT_LENGTH",
1791
+ EXACT_SIZE = "EXACT_SIZE",
1792
+ REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1793
+ }
1794
+ /** @enumType */
1795
+ type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
1796
+ interface FieldViolation {
1797
+ field?: string;
1798
+ description?: string;
1799
+ violatedRule?: RuleTypeWithLiterals;
1800
+ /** applicable when violated_rule=OTHER */
1801
+ ruleName?: string | null;
1802
+ data?: Record<string, any> | null;
1803
+ }
1804
+ interface SystemError {
1805
+ /** Error code. */
1806
+ errorCode?: string | null;
1807
+ }
1808
+ interface Violation {
1809
+ /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
1810
+ severity?: SeverityWithLiterals;
1811
+ /** Target location on a checkout or cart page where the violation will be displayed. */
1812
+ target?: Target;
1813
+ /**
1814
+ * Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`.
1815
+ * @minLength 1
1816
+ * @maxLength 1000
1817
+ */
1818
+ description?: string | null;
1819
+ }
1820
+ declare enum Severity {
1821
+ /** The user is allowed to move forward in the flow. */
1822
+ WARNING = "WARNING",
1823
+ /**
1824
+ * The user is blocked from moving forward in the flow.
1825
+ * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
1826
+ */
1827
+ ERROR = "ERROR"
1828
+ }
1829
+ /** @enumType */
1830
+ type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
1831
+ interface Target extends TargetTargetTypeOneOf {
1832
+ /** General (other) violation. */
1833
+ other?: Other;
1834
+ /** Specific line item violation. */
1835
+ lineItem?: LineItem;
1836
+ }
1837
+ /** @oneof */
1838
+ interface TargetTargetTypeOneOf {
1839
+ /** General (other) violation. */
1840
+ other?: Other;
1841
+ /** Specific line item violation. */
1842
+ lineItem?: LineItem;
1843
+ }
1844
+ /** Available locations on the webpage */
1845
+ declare enum NameInOther {
1846
+ /** Default location, in case no specific location is specified. */
1847
+ OTHER_DEFAULT = "OTHER_DEFAULT"
1848
+ }
1849
+ /** @enumType */
1850
+ type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
1851
+ /** Available locations on the line item */
1852
+ declare enum NameInLineItem {
1853
+ /** Default location, in case no specific location is specified. */
1854
+ LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
1855
+ }
1856
+ /** @enumType */
1857
+ type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
1858
+ declare enum SuggestedFix {
1859
+ /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
1860
+ UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
1861
+ /** The line item should be removed from the cart or checkout to resolve the violation. */
1862
+ REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
1863
+ }
1864
+ /** @enumType */
1865
+ type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
1866
+ /** General (other) violation. */
1867
+ interface Other {
1868
+ /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
1869
+ name?: NameInOtherWithLiterals;
1870
+ }
1871
+ /** Specific line item violation. */
1872
+ interface LineItem {
1873
+ /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
1874
+ name?: NameInLineItemWithLiterals;
1875
+ /** ID of the line item containing the violation. */
1876
+ _id?: string | null;
1877
+ }
1878
+ interface CreateCurrentCartRequest {
1879
+ /** Cart to be created. */
1880
+ cart: Cart;
1881
+ /**
1882
+ * A list of catalog items to add to the cart.
1883
+ * @maxSize 300
1884
+ */
1885
+ catalogItems?: CatalogItemInput[];
1886
+ /**
1887
+ * A list of custom items to add to the cart.
1888
+ * Custom line items don't trigger the Catalog service plugin.
1889
+ *
1890
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1891
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1892
+ * @maxSize 300
1893
+ */
1894
+ customItems?: CustomItemInput[];
1895
+ /**
1896
+ * Coupons to apply.
1897
+ * Currently only one is supported.
1898
+ * If the coupon code is invalid, the cart will be created without it.
1899
+ * @maxSize 1
1900
+ * @minLength 1
1901
+ * @maxLength 50
1902
+ */
1903
+ couponCodes?: string[];
1904
+ /**
1905
+ * Gift cards to add.
1906
+ * Currently only one is support.
1907
+ * If the gift card code is invalid, the cart will be created without it.
1908
+ * @maxSize 1
1909
+ * @minLength 8
1910
+ * @maxLength 20
1911
+ */
1912
+ giftCardCodes?: string[];
1913
+ }
1914
+ interface CatalogItemInput {
1915
+ /** A reference to the catalog item. */
1916
+ catalogReference?: CatalogReference;
1917
+ /**
1918
+ * The amount of catalog items requested by the customer.
1919
+ * @min 1
1920
+ * @max 100000
1921
+ */
1922
+ quantity?: number;
1923
+ /** Selected membership to be used as payment for this item. */
1924
+ selectedMembership?: V2SelectedMembership;
1925
+ /**
1926
+ * Overriding values for catalog item properties.
1927
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1928
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1929
+ */
1930
+ catalogOverrideFields?: CatalogOverrideFields;
1931
+ /**
1932
+ * Custom extended fields for the line item object.
1933
+ *
1934
+ * [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.
1935
+ */
1936
+ extendedFields?: ExtendedFields;
1937
+ /**
1938
+ * ID of the app managing the inventory.
1939
+ * @format GUID
1940
+ */
1941
+ inventoryAppId?: string | null;
1942
+ }
1943
+ interface CustomItemInput {
1944
+ /** The name of the line item. */
1945
+ name?: TranslatableString;
1946
+ /** Quantity-related information about the line item. */
1947
+ quantityInfo?: CustomItemQuantityInfo;
1948
+ /** Pricing-related information about the line item. */
1949
+ pricing?: CustomItemPricingInfo;
1950
+ /** Information about the origin of the line item. */
1951
+ source?: CustomItemSource;
1952
+ /** Details about the item for display purposes. */
1953
+ attributes?: CustomItemAttributes;
1954
+ /** Delivery-related information about the line item. */
1955
+ deliveryConfig?: CustomItemDeliveryConfig;
1956
+ /** Tax-related information about the line item. */
1957
+ taxConfig?: CustomItemTaxConfig;
1958
+ /** Payment-related information about the line item. */
1959
+ paymentConfig?: CustomItemPaymentConfig;
1960
+ /**
1961
+ * Modifier groups that were added to the item.
1962
+ * @maxSize 25
1963
+ */
1964
+ modifierGroups?: ModifierGroup[];
1965
+ /**
1966
+ * Whether the item can only be purchased by site members.
1967
+ * Default: `false`
1968
+ */
1969
+ membersOnly?: boolean;
1970
+ }
1971
+ interface CustomItemQuantityInfo {
1972
+ /**
1973
+ * The amount of items originally requested by the customer.
1974
+ * @min 1
1975
+ * @max 100000
1976
+ */
1977
+ requestedQuantity?: number;
1978
+ /** The maximum quantity of items available for purchase. */
1979
+ availableQuantity?: number | null;
1980
+ /** Whether the line item quantity is fixed and cannot be changed. */
1981
+ fixedQuantity?: boolean;
1982
+ }
1983
+ interface CustomItemPricingInfo {
1984
+ /**
1985
+ * Sale price of a single item, without modifiers.
1986
+ * Includes tax if `tax_info.prices_include_tax` is true.
1987
+ * @format DECIMAL_VALUE
1988
+ * @decimalValue options { gte:0, lte:1000000000000000, maxScale:3 }
1989
+ */
1990
+ price?: string;
1991
+ /**
1992
+ * Full price of a single item before any discounts, without modifiers.
1993
+ * Defaults to `price` when not provided.
1994
+ * Includes tax if `tax_info.prices_include_tax` is true.
1995
+ * @format DECIMAL_VALUE
1996
+ * @decimalValue options { gte:0, lte:1000000000000000, maxScale:3 }
1997
+ */
1998
+ fullPrice?: string | null;
1999
+ /**
2000
+ * Additional description for the price.
2001
+ * For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
2002
+ */
2003
+ priceDescription?: PriceDescription;
2004
+ /** Indicates whether the price is not yet defined, and will be updated after the order is created. */
2005
+ priceUndetermined?: boolean;
2006
+ }
2007
+ interface CustomItemSource {
2008
+ /**
2009
+ * Catalog and item reference.
2010
+ * Holds IDs for the item and the catalog it came from, as well as further optional info.
2011
+ * Optional for custom line items, which don't trigger the Catalog service plugin.
2012
+ */
2013
+ catalogReference?: CatalogReference;
2014
+ /**
2015
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
2016
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
2017
+ * + in most cases, this field is the same as `catalogReference.catalogItemId`.
2018
+ * + Used in membership validation.
2019
+ * @minLength 1
2020
+ * @maxLength 36
2021
+ */
2022
+ rootCatalogItemId?: string | null;
2023
+ /**
2024
+ * ID of the app managing the inventory.
2025
+ * @format GUID
2026
+ */
2027
+ inventoryAppId?: string | null;
2028
+ }
2029
+ interface CustomItemAttributes {
2030
+ /**
2031
+ * Description lines of the item.
2032
+ * @maxSize 100
2033
+ */
2034
+ descriptionLines?: DescriptionLine[];
2035
+ /** The image of the item. */
2036
+ image?: string;
2037
+ /** URL to the item's page on the site. */
2038
+ url?: string;
2039
+ /** Item type. Either a preset type or custom. */
2040
+ itemType?: ItemType;
2041
+ /**
2042
+ * Physical properties of the item.
2043
+ * When relevant, contains information such as SKU, item weight, and shippability.
2044
+ */
2045
+ physicalProperties?: PhysicalProperties;
2046
+ /** Subscription option information. */
2047
+ subscriptionInfo?: SubscriptionOptionInfo;
2048
+ /** Service properties. When relevant, this contains information such as date and number of participants. */
2049
+ serviceProperties?: ServiceProperties;
2050
+ }
2051
+ interface CustomItemDeliveryConfig {
2052
+ /**
2053
+ * Delivery profile ID.
2054
+ * @format GUID
2055
+ */
2056
+ deliveryProfileId?: string | null;
2057
+ }
2058
+ interface CustomItemTaxConfig {
2059
+ /** Address to use for tax calculation purposes. */
2060
+ taxableAddress?: TaxableAddress;
2061
+ /**
2062
+ * Tax group ID for this line item.
2063
+ * @maxLength 50
2064
+ */
2065
+ taxGroupId?: string | null;
2066
+ }
2067
+ interface CustomItemPaymentConfig {
2068
+ /**
2069
+ * Partial payment to be paid upfront during the checkout.
2070
+ * Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
2071
+ */
2072
+ depositAmount?: MultiCurrencyPrice;
2073
+ /**
2074
+ * Type of selected payment option for current item.
2075
+ *
2076
+ * Default: `FULL_PAYMENT_ONLINE`
2077
+ */
2078
+ paymentOption?: PaymentOptionTypeWithLiterals;
2079
+ }
2080
+ interface CreateCurrentCartResponse {
2081
+ /** The created Cart. */
2082
+ cart?: Cart;
2083
+ }
2084
+ interface GetCurrentCartRequest {
2085
+ }
2086
+ interface GetCurrentCartResponse {
2087
+ /** The requested Cart. */
2088
+ cart?: Cart;
2089
+ }
2090
+ interface UpdateCurrentCartRequest {
2091
+ /** Cart to be updated, may be partial. */
2092
+ cart: Cart;
2093
+ }
2094
+ interface UpdateCurrentCartResponse {
2095
+ /** Updated Cart. */
2096
+ cart?: Cart;
2097
+ }
2098
+ interface DeleteCurrentCartRequest {
2099
+ }
2100
+ interface DeleteCurrentCartResponse {
2101
+ }
2102
+ interface RefreshCurrentCartRequest {
2103
+ }
2104
+ interface RefreshCurrentCartResponse {
2105
+ /** Synchronized Cart. */
2106
+ cart?: Cart;
2107
+ }
2108
+ interface CalculateCurrentCartRequest {
2109
+ /**
2110
+ * Specifies the level of **business validation** to perform during cart calculation,
2111
+ * by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
2112
+ */
2113
+ validationsConfig?: ValidationsConfigWithLiterals;
2114
+ /**
2115
+ * Optional custom configuration for the calculation.
2116
+ * If not provided, all price components are calculated by default.
2117
+ */
2118
+ customCalculationConfig?: CalculationConfig;
2119
+ }
2120
+ declare enum ValidationsConfig {
2121
+ UNKNOWN_VALIDATIONS_CONFIG = "UNKNOWN_VALIDATIONS_CONFIG",
2122
+ /** No business validations are performed. */
2123
+ SKIP_VALIDATIONS = "SKIP_VALIDATIONS",
2124
+ /** Perform cart-level business validations as defined by the service plugin implementer. */
2125
+ PRE_CHECKOUT_VALIDATIONS = "PRE_CHECKOUT_VALIDATIONS",
2126
+ /** Perform checkout-specific business validations as defined by the service plugin implementer. */
2127
+ CHECKOUT_VALIDATIONS = "CHECKOUT_VALIDATIONS"
2128
+ }
2129
+ /** @enumType */
2130
+ type ValidationsConfigWithLiterals = ValidationsConfig | 'UNKNOWN_VALIDATIONS_CONFIG' | 'SKIP_VALIDATIONS' | 'PRE_CHECKOUT_VALIDATIONS' | 'CHECKOUT_VALIDATIONS';
2131
+ interface CalculationConfig {
2132
+ /**
2133
+ * Whether to calculate delivery costs.
2134
+ * Default: false
2135
+ */
2136
+ calculateDelivery?: boolean;
2137
+ /**
2138
+ * Whether to calculate any additional fees.
2139
+ * Default: false
2140
+ */
2141
+ calculateAdditionalFees?: boolean;
2142
+ /**
2143
+ * Whether to include tax calculation.
2144
+ * Default: false
2145
+ */
2146
+ calculateTax?: boolean;
2147
+ /**
2148
+ * Whether to calculate the effect of gift card balances on the cart total.
2149
+ * Gift cards are not redeemed - only reflected for estimation purposes.
2150
+ * Default: false
2151
+ */
2152
+ calculateGiftCards?: boolean;
2153
+ }
2154
+ interface CalculateCurrentCartResponse {
2155
+ /** The Cart that was calculated. */
2156
+ cart?: Cart;
2157
+ /** The calculation summary. */
2158
+ summary?: CartSummary;
2159
+ }
2160
+ interface AddLineItemsToCurrentCartRequest {
2161
+ /**
2162
+ * A list of catalog items to add to the cart.
2163
+ * @maxSize 300
2164
+ */
2165
+ catalogItems?: CatalogItemInput[];
2166
+ /**
2167
+ * A list of custom items to add to the cart.
2168
+ * @maxSize 300
2169
+ */
2170
+ customItems?: CustomItemInput[];
2171
+ }
2172
+ interface AddLineItemsToCurrentCartResponse {
2173
+ /** Updated Cart. */
2174
+ cart?: Cart;
2175
+ }
2176
+ interface RemoveLineItemsFromCurrentCartRequest {
2177
+ /**
2178
+ * Line item IDs to remove from cart.
2179
+ * @format GUID
2180
+ * @minSize 1
2181
+ * @maxSize 100
2182
+ */
2183
+ lineItemIds: string[];
2184
+ }
2185
+ interface RemoveLineItemsFromCurrentCartResponse {
2186
+ /** Updated Cart. */
2187
+ cart?: Cart;
2188
+ }
2189
+ interface UpdateLineItemsInCurrentCartRequest {
2190
+ /**
2191
+ * Line item updates to apply.
2192
+ * @minSize 1
2193
+ * @maxSize 100
2194
+ */
2195
+ lineItemUpdates?: LineItemUpdate[];
2196
+ }
2197
+ interface LineItemUpdate {
2198
+ /**
2199
+ * Line item ID to update.
2200
+ * @format GUID
2201
+ */
2202
+ lineItemId?: string;
2203
+ /** Quantity update (optional - if not provided, quantity is not updated) */
2204
+ quantityUpdate?: QuantityUpdate;
2205
+ /** Selected membership update (optional - if not provided, membership is not updated) */
2206
+ selectedMembershipUpdate?: SelectedMembershipUpdate;
2207
+ }
2208
+ interface QuantityUpdate {
2209
+ /**
2210
+ * The new quantity of the line item.
2211
+ * @min 1
2212
+ * @max 100000
2213
+ */
2214
+ quantity?: number;
2215
+ }
2216
+ interface SelectedMembershipUpdate {
2217
+ /**
2218
+ * The new selectedMembership of the item.
2219
+ *
2220
+ * To just remove current selected membership, and not replace with a new one, pass an empty value here.
2221
+ */
2222
+ membership?: V2SelectedMembership;
2223
+ }
2224
+ interface UpdateLineItemsInCurrentCartResponse {
2225
+ /** Updated Cart. */
2226
+ cart?: Cart;
2227
+ }
2228
+ interface AddDiscountToCurrentCartRequest {
2229
+ /**
2230
+ * Coupon to apply.
2231
+ *
2232
+ * Currently only one is supported.
2233
+ * @minLength 1
2234
+ * @maxLength 50
2235
+ */
2236
+ couponCode: string;
2237
+ }
2238
+ interface AddDiscountToCurrentCartResponse {
2239
+ /** Updated Cart. */
2240
+ cart?: Cart;
2241
+ }
2242
+ interface RemoveDiscountFromCurrentCartRequest {
2243
+ /**
2244
+ * Discount ID.
2245
+ * @format GUID
2246
+ */
2247
+ discountId: string;
2248
+ }
2249
+ interface RemoveDiscountFromCurrentCartResponse {
2250
+ /** Updated Cart. */
2251
+ cart?: Cart;
2252
+ }
2253
+ interface AddGiftCardToCurrentCartRequest {
2254
+ /**
2255
+ * Gift card code.
2256
+ *
2257
+ * Currently only one is supported.
2258
+ * @maxLength 50
2259
+ */
2260
+ giftCardCode: string;
2261
+ }
2262
+ interface AddGiftCardToCurrentCartResponse {
2263
+ /** Updated Cart. */
2264
+ cart?: Cart;
2265
+ }
2266
+ interface RemoveGiftCardFromCurrentCartRequest {
2267
+ /**
2268
+ * Gift card ID.
2269
+ * @format GUID
2270
+ */
2271
+ giftCardId: string;
2272
+ }
2273
+ interface RemoveGiftCardFromCurrentCartResponse {
2274
+ /** Updated Cart. */
2275
+ cart?: Cart;
2276
+ }
2277
+ interface DomainEvent extends DomainEventBodyOneOf {
2278
+ createdEvent?: EntityCreatedEvent;
2279
+ updatedEvent?: EntityUpdatedEvent;
2280
+ deletedEvent?: EntityDeletedEvent;
2281
+ actionEvent?: ActionEvent;
2282
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2283
+ _id?: string;
2284
+ /**
2285
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2286
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2287
+ */
2288
+ entityFqdn?: string;
2289
+ /**
2290
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2291
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2292
+ */
2293
+ slug?: string;
2294
+ /** ID of the entity associated with the event. */
2295
+ entityId?: string;
2296
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2297
+ eventTime?: Date | null;
2298
+ /**
2299
+ * Whether the event was triggered as a result of a privacy regulation application
2300
+ * (for example, GDPR).
2301
+ */
2302
+ triggeredByAnonymizeRequest?: boolean | null;
2303
+ /** If present, indicates the action that triggered the event. */
2304
+ originatedFrom?: string | null;
2305
+ /**
2306
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2307
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2308
+ */
2309
+ entityEventSequence?: string | null;
2310
+ }
2311
+ /** @oneof */
2312
+ interface DomainEventBodyOneOf {
2313
+ createdEvent?: EntityCreatedEvent;
2314
+ updatedEvent?: EntityUpdatedEvent;
2315
+ deletedEvent?: EntityDeletedEvent;
2316
+ actionEvent?: ActionEvent;
2317
+ }
2318
+ interface EntityCreatedEvent {
2319
+ entity?: string;
2320
+ }
2321
+ interface RestoreInfo {
2322
+ deletedDate?: Date | null;
2323
+ }
2324
+ interface EntityUpdatedEvent {
2325
+ /**
2326
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2327
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2328
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2329
+ */
2330
+ currentEntity?: string;
2331
+ }
2332
+ interface EntityDeletedEvent {
2333
+ /** Entity that was deleted. */
2334
+ deletedEntity?: string | null;
2335
+ }
2336
+ interface ActionEvent {
2337
+ body?: string;
2338
+ }
2339
+ interface MessageEnvelope {
2340
+ /**
2341
+ * App instance ID.
2342
+ * @format GUID
2343
+ */
2344
+ instanceId?: string | null;
2345
+ /**
2346
+ * Event type.
2347
+ * @maxLength 150
2348
+ */
2349
+ eventType?: string;
2350
+ /** The identification type and identity data. */
2351
+ identity?: IdentificationData;
2352
+ /** Stringify payload. */
2353
+ data?: string;
2354
+ }
2355
+ interface IdentificationData extends IdentificationDataIdOneOf {
2356
+ /**
2357
+ * ID of a site visitor that has not logged in to the site.
2358
+ * @format GUID
2359
+ */
2360
+ anonymousVisitorId?: string;
2361
+ /**
2362
+ * ID of a site visitor that has logged in to the site.
2363
+ * @format GUID
2364
+ */
2365
+ memberId?: string;
2366
+ /**
2367
+ * ID of a Wix user (site owner, contributor, etc.).
2368
+ * @format GUID
2369
+ */
2370
+ wixUserId?: string;
2371
+ /**
2372
+ * ID of an app.
2373
+ * @format GUID
2374
+ */
2375
+ appId?: string;
2376
+ /** @readonly */
2377
+ identityType?: WebhookIdentityTypeWithLiterals;
2378
+ }
2379
+ /** @oneof */
2380
+ interface IdentificationDataIdOneOf {
2381
+ /**
2382
+ * ID of a site visitor that has not logged in to the site.
2383
+ * @format GUID
2384
+ */
2385
+ anonymousVisitorId?: string;
2386
+ /**
2387
+ * ID of a site visitor that has logged in to the site.
2388
+ * @format GUID
2389
+ */
2390
+ memberId?: string;
2391
+ /**
2392
+ * ID of a Wix user (site owner, contributor, etc.).
2393
+ * @format GUID
2394
+ */
2395
+ wixUserId?: string;
2396
+ /**
2397
+ * ID of an app.
2398
+ * @format GUID
2399
+ */
2400
+ appId?: string;
2401
+ }
2402
+ declare enum WebhookIdentityType {
2403
+ UNKNOWN = "UNKNOWN",
2404
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2405
+ MEMBER = "MEMBER",
2406
+ WIX_USER = "WIX_USER",
2407
+ APP = "APP"
2408
+ }
2409
+ /** @enumType */
2410
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2411
+ interface CreateCartRequest {
2412
+ /** Cart to be created. */
2413
+ cart?: Cart;
2414
+ /**
2415
+ * A list of catalog items to add to the cart.
2416
+ * @maxSize 300
2417
+ */
2418
+ catalogItems?: CatalogItemInput[];
2419
+ /**
2420
+ * A list of custom items to add to the cart.
2421
+ * Custom line items don't trigger the Catalog service plugin.
2422
+ *
2423
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2424
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2425
+ * @maxSize 300
2426
+ */
2427
+ customItems?: CustomItemInput[];
2428
+ /**
2429
+ * Coupons to apply.
2430
+ * Currently only one is supported.
2431
+ * If the coupon code is invalid, the cart will be created without it.
2432
+ * @maxSize 1
2433
+ * @minLength 1
2434
+ * @maxLength 50
2435
+ */
2436
+ couponCodes?: string[];
2437
+ /**
2438
+ * Gift cards to add.
2439
+ * Currently only one is support.
2440
+ * If the gift card code is invalid, the cart will be created without it.
2441
+ * @maxSize 1
2442
+ * @minLength 8
2443
+ * @maxLength 20
2444
+ */
2445
+ giftCardCodes?: string[];
2446
+ }
2447
+ interface CreateCartResponse {
2448
+ /** The created Cart. */
2449
+ cart?: Cart;
2450
+ }
2451
+ interface GetCartRequest {
2452
+ /**
2453
+ * ID of the Cart to retrieve.
2454
+ * @format GUID
2455
+ */
2456
+ cartId?: string;
2457
+ }
2458
+ interface GetCartResponse {
2459
+ /** The requested Cart. */
2460
+ cart?: Cart;
2461
+ }
2462
+ interface UpdateCartRequest {
2463
+ /** Cart to be updated, may be partial. */
2464
+ cart?: Cart;
2465
+ }
2466
+ interface UpdateCartResponse {
2467
+ /** Updated Cart. */
2468
+ cart?: Cart;
2469
+ }
2470
+ interface DeleteCartRequest {
2471
+ /**
2472
+ * ID of the Cart to delete.
2473
+ * @format GUID
2474
+ */
2475
+ cartId?: string;
2476
+ }
2477
+ interface DeleteCartResponse {
2478
+ }
2479
+ interface RefreshCartRequest {
2480
+ /**
2481
+ * ID of the Cart to refresh.
2482
+ * @format GUID
2483
+ */
2484
+ cartId?: string;
2485
+ }
2486
+ interface RefreshCartResponse {
2487
+ /** Synchronized Cart. */
2488
+ cart?: Cart;
2489
+ }
2490
+ interface CalculateCartRequest {
2491
+ /**
2492
+ * ID of the Cart to calculate.
2493
+ * @format GUID
2494
+ */
2495
+ cartId?: string;
2496
+ /**
2497
+ * Specifies the level of **business validation** to perform during cart calculation,
2498
+ * by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
2499
+ */
2500
+ validationsConfig?: ValidationsConfigWithLiterals;
2501
+ /**
2502
+ * Optional custom configuration for the calculation.
2503
+ * If not provided, all price components are calculated by default.
2504
+ */
2505
+ customCalculationConfig?: CalculationConfig;
2506
+ }
2507
+ interface CalculateCartResponse {
2508
+ /** The Cart that was calculated. */
2509
+ cart?: Cart;
2510
+ /** The calculation summary. */
2511
+ summary?: CartSummary;
2512
+ }
2513
+ interface GetCheckoutURLRequest {
2514
+ /**
2515
+ * ID of the Cart to calculate.
2516
+ * @format GUID
2517
+ */
2518
+ cartId?: string;
2519
+ /**
2520
+ * Checkout currency parameter to append as a query param
2521
+ * @format CURRENCY
2522
+ */
2523
+ currencyCode?: string | null;
2524
+ }
2525
+ interface GetCheckoutURLResponse {
2526
+ /**
2527
+ * The checkout URL.
2528
+ * @format WEB_URL
2529
+ */
2530
+ checkoutUrl?: string;
2531
+ }
2532
+ interface CompleteCheckoutRequest {
2533
+ /**
2534
+ * Cart ID.
2535
+ * @format GUID
2536
+ */
2537
+ cartId?: string;
2538
+ /**
2539
+ * The pricing token received from `CalculateCart`'s response.
2540
+ * Used to verify that the prices shown to the customer have not changed before completing checkout.
2541
+ * @maxLength 1024
2542
+ * @readonly
2543
+ */
2544
+ pricingToken?: string | null;
2545
+ /** Urls to redirect to after payment is made. */
2546
+ redirectUrls?: RedirectUrls;
2547
+ /** Indicates the payment method should be saved on the order */
2548
+ savePaymentMethod?: boolean;
2549
+ /** Indicates whether to authorize the payment and delay the capture */
2550
+ delayCapture?: boolean;
2551
+ }
2552
+ interface RedirectUrls {
2553
+ /**
2554
+ * URL to redirect to if payment is canceled (usually checkout url).
2555
+ * @format WEB_URL
2556
+ */
2557
+ cancelUrl?: string;
2558
+ /**
2559
+ * URL to redirect to if an error occurred on payment (usually checkout url).
2560
+ * @format WEB_URL
2561
+ */
2562
+ errorUrl?: string;
2563
+ /**
2564
+ * URL to redirect to after successful payment, excepts order place holder {orderId}.
2565
+ * @maxLength 2000
2566
+ */
2567
+ successUrl?: string | null;
2568
+ /**
2569
+ * URL to redirect to if payment is pending, excepts order place holder {orderId}.
2570
+ * @maxLength 2000
2571
+ */
2572
+ pendingUrl?: string | null;
2573
+ }
2574
+ interface CompleteCheckoutResponse {
2575
+ /**
2576
+ * The order ID of the created order.
2577
+ * @format GUID
2578
+ */
2579
+ orderId?: string;
2580
+ /**
2581
+ * Payment response token.
2582
+ * @maxLength 1000
2583
+ */
2584
+ paymentResponseToken?: string | null;
2585
+ /**
2586
+ * The payment gateway is Cashier.
2587
+ * payment_gateway_order_id will be returned given that money was charged.
2588
+ * In some cases, money will not be charged:
2589
+ * If the total price is 0 - For example, could be a free item or a an item with 100% discount
2590
+ * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
2591
+ * @maxLength 50
2592
+ */
2593
+ paymentGatewayOrderId?: string | null;
2594
+ /** Whether an order was successfully created from this cart and the payment transaction was completed. */
2595
+ cartCompleted?: boolean;
2596
+ }
2597
+ interface AddLineItemsRequest {
2598
+ /**
2599
+ * Cart ID.
2600
+ * @format GUID
2601
+ */
2602
+ cartId?: string;
2603
+ /**
2604
+ * A list of catalog items to add to the cart.
2605
+ * @maxSize 300
2606
+ */
2607
+ catalogItems?: CatalogItemInput[];
2608
+ /**
2609
+ * A list of custom items to add to the cart.
2610
+ * @maxSize 300
2611
+ */
2612
+ customItems?: CustomItemInput[];
2613
+ }
2614
+ interface AddLineItemsResponse {
2615
+ /** Updated Cart. */
2616
+ cart?: Cart;
2617
+ }
2618
+ interface RemoveLineItemsRequest {
2619
+ /**
2620
+ * Cart ID.
2621
+ * @format GUID
2622
+ */
2623
+ cartId?: string;
2624
+ /**
2625
+ * Line item IDs to remove from cart.
2626
+ * @format GUID
2627
+ * @minSize 1
2628
+ * @maxSize 100
2629
+ */
2630
+ lineItemIds?: string[];
2631
+ }
2632
+ interface RemoveLineItemsResponse {
2633
+ /** Updated Cart. */
2634
+ cart?: Cart;
2635
+ }
2636
+ interface AddDiscountRequest {
2637
+ /**
2638
+ * Cart ID.
2639
+ * @format GUID
2640
+ */
2641
+ cartId?: string;
2642
+ /**
2643
+ * Coupon to apply.
2644
+ *
2645
+ * Currently only one is supported.
2646
+ * @minLength 1
2647
+ * @maxLength 50
2648
+ */
2649
+ couponCode?: string;
2650
+ }
2651
+ interface AddDiscountResponse {
2652
+ /** Updated Cart. */
2653
+ cart?: Cart;
2654
+ }
2655
+ interface RemoveDiscountRequest {
2656
+ /**
2657
+ * Cart ID.
2658
+ * @format GUID
2659
+ */
2660
+ cartId?: string;
2661
+ /**
2662
+ * Discount ID.
2663
+ * @format GUID
2664
+ */
2665
+ discountId?: string;
2666
+ }
2667
+ interface RemoveDiscountResponse {
2668
+ /** Updated Cart. */
2669
+ cart?: Cart;
2670
+ }
2671
+ interface AddGiftCardRequest {
2672
+ /**
2673
+ * Cart ID.
2674
+ * @format GUID
2675
+ */
2676
+ cartId?: string;
2677
+ /**
2678
+ * Gift card code.
2679
+ *
2680
+ * Currently only one is supported.
2681
+ * @maxLength 50
2682
+ */
2683
+ giftCardCode?: string;
2684
+ }
2685
+ interface AddGiftCardResponse {
2686
+ /** Updated Cart. */
2687
+ cart?: Cart;
2688
+ }
2689
+ interface RemoveGiftCardRequest {
2690
+ /**
2691
+ * Cart ID.
2692
+ * @format GUID
2693
+ */
2694
+ cartId?: string;
2695
+ /**
2696
+ * Gift card ID.
2697
+ * @format GUID
2698
+ */
2699
+ giftCardId?: string;
2700
+ }
2701
+ interface RemoveGiftCardResponse {
2702
+ /** Updated Cart. */
2703
+ cart?: Cart;
2704
+ }
2705
+ interface UpdateLineItemsRequest {
2706
+ /**
2707
+ * Cart ID.
2708
+ * @format GUID
2709
+ */
2710
+ cartId?: string;
2711
+ /**
2712
+ * Line item updates to apply.
2713
+ * @minSize 1
2714
+ * @maxSize 100
2715
+ */
2716
+ lineItemUpdates?: LineItemUpdate[];
2717
+ }
2718
+ interface UpdateLineItemsResponse {
2719
+ /** Updated Cart. */
2720
+ cart?: Cart;
2721
+ }
2722
+ interface MarkCartAsCompletedRequest {
2723
+ /**
2724
+ * Cart ID.
2725
+ * @format GUID
2726
+ */
2727
+ cartId?: string;
2728
+ /**
2729
+ * Order ID.
2730
+ * @format GUID
2731
+ */
2732
+ orderId?: string | null;
2733
+ }
2734
+ interface MarkCartAsCompletedResponse {
2735
+ /** Updated Cart. */
2736
+ cart?: Cart;
2737
+ }
2738
+ interface Empty {
2739
+ }
2740
+ interface HandleAsyncCheckoutCompletionRequest {
2741
+ /**
2742
+ * Server-signed JWT token with required information to complete checkout
2743
+ * @maxLength 4096
2744
+ */
2745
+ token?: string;
2746
+ }
2747
+ interface RawHttpResponse {
2748
+ body?: Uint8Array;
2749
+ statusCode?: number | null;
2750
+ headers?: HeadersEntry[];
2751
+ }
2752
+ interface HeadersEntry {
2753
+ key?: string;
2754
+ value?: string;
2755
+ }
2756
+ interface CreateCurrentCartOptions {
2757
+ /**
2758
+ * A list of catalog items to add to the cart.
2759
+ * @maxSize 300
2760
+ */
2761
+ catalogItems?: CatalogItemInput[];
2762
+ /**
2763
+ * A list of custom items to add to the cart.
2764
+ * Custom line items don't trigger the Catalog service plugin.
2765
+ *
2766
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2767
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2768
+ * @maxSize 300
2769
+ */
2770
+ customItems?: CustomItemInput[];
2771
+ /**
2772
+ * Coupons to apply.
2773
+ * Currently only one is supported.
2774
+ * If the coupon code is invalid, the cart will be created without it.
2775
+ * @maxSize 1
2776
+ * @minLength 1
2777
+ * @maxLength 50
2778
+ */
2779
+ couponCodes?: string[];
2780
+ /**
2781
+ * Gift cards to add.
2782
+ * Currently only one is support.
2783
+ * If the gift card code is invalid, the cart will be created without it.
2784
+ * @maxSize 1
2785
+ * @minLength 8
2786
+ * @maxLength 20
2787
+ */
2788
+ giftCardCodes?: string[];
2789
+ }
2790
+ interface CalculateCurrentCartOptions {
2791
+ /**
2792
+ * Specifies the level of **business validation** to perform during cart calculation,
2793
+ * by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
2794
+ */
2795
+ validationsConfig?: ValidationsConfigWithLiterals;
2796
+ /**
2797
+ * Optional custom configuration for the calculation.
2798
+ * If not provided, all price components are calculated by default.
2799
+ */
2800
+ customCalculationConfig?: CalculationConfig;
2801
+ }
2802
+ interface AddLineItemsToCurrentCartOptions {
2803
+ /**
2804
+ * A list of catalog items to add to the cart.
2805
+ * @maxSize 300
2806
+ */
2807
+ catalogItems?: CatalogItemInput[];
2808
+ /**
2809
+ * A list of custom items to add to the cart.
2810
+ * @maxSize 300
2811
+ */
2812
+ customItems?: CustomItemInput[];
2813
+ }
2814
+ interface UpdateLineItemsInCurrentCartOptions {
2815
+ /**
2816
+ * Line item updates to apply.
2817
+ * @minSize 1
2818
+ * @maxSize 100
2819
+ */
2820
+ lineItemUpdates?: LineItemUpdate[];
2821
+ }
2822
+
2823
+ export { type ActionEvent, type AddDiscountRequest, type AddDiscountResponse, type AddDiscountToCurrentCartRequest, type AddDiscountToCurrentCartResponse, type AddGiftCardRequest, type AddGiftCardResponse, type AddGiftCardToCurrentCartRequest, type AddGiftCardToCurrentCartResponse, type AddLineItemsRequest, type AddLineItemsResponse, type AddLineItemsToCurrentCartOptions, type AddLineItemsToCurrentCartRequest, type AddLineItemsToCurrentCartResponse, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type ApplicationError, type CalculateCartRequest, type CalculateCartResponse, type CalculateCurrentCartOptions, type CalculateCurrentCartRequest, type CalculateCurrentCartResponse, CalculationComponent, type CalculationComponentWithLiterals, type CalculationConfig, type CalculationError, type Cart, type CartSource, CartStatus, type CartStatusWithLiterals, type CartSummary, type CatalogItemInput, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, type Color, type CompleteCheckoutRequest, type CompleteCheckoutResponse, type CreateCartRequest, type CreateCartResponse, type CreateCurrentCartOptions, 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 CustomSettings, 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 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 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 PlainTextValue, type Policy, type PriceDescription, type PriceSummary, type PricingInfo, 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 SiteInfo, 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 UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartRequest, type UpdateCurrentCartResponse, type UpdateLineItemsInCurrentCartOptions, type UpdateLineItemsInCurrentCartRequest, type UpdateLineItemsInCurrentCartResponse, 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 };