@wix/auto_sdk_ecom_checkout 1.0.15 → 1.0.17

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 (134) hide show
  1. package/build/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-BV8QOlPP.d.mts} +670 -376
  2. package/build/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-BV8QOlPP.d.ts} +670 -376
  3. package/build/index.d.mts +211 -0
  4. package/build/index.d.ts +211 -0
  5. package/build/index.js +2781 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +2707 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-DGEClxWR.d.mts} +879 -376
  10. package/build/internal/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-DGEClxWR.d.ts} +879 -376
  11. package/build/internal/index.d.mts +252 -0
  12. package/build/internal/index.d.ts +252 -0
  13. package/build/internal/index.js +2781 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +2707 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2345 -0
  18. package/build/internal/meta.d.ts +2345 -0
  19. package/build/internal/meta.js +1587 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +1544 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +2345 -0
  24. package/build/meta.d.ts +2345 -0
  25. package/build/meta.js +1587 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +1544 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -34
  40. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +0 -77
  41. package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  43. package/build/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1338
  44. package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  46. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
  47. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -186
  49. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +0 -358
  50. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-checkout-checkout.types.js +0 -301
  52. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4211
  54. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1597
  55. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +0 -34
  67. package/build/es/src/ecom-v1-checkout-checkout.context.js +0 -42
  68. package/build/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  70. package/build/es/src/ecom-v1-checkout-checkout.http.js +0 -1318
  71. package/build/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  73. package/build/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
  74. package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -186
  76. package/build/es/src/ecom-v1-checkout-checkout.public.js +0 -306
  77. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-checkout-checkout.types.js +0 -298
  79. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  80. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4211
  81. package/build/es/src/ecom-v1-checkout-checkout.universal.js +0 -1554
  82. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -42
  93. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +0 -77
  94. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  95. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  96. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1338
  97. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  98. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  99. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
  100. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  101. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -219
  102. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +0 -358
  103. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +0 -301
  105. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  106. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4500
  107. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1597
  108. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +0 -42
  119. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +0 -42
  120. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  122. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +0 -1318
  123. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  125. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
  126. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -219
  128. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +0 -306
  129. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +0 -298
  131. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4500
  133. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +0 -1554
  134. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
@@ -1,10 +1,10 @@
1
- export interface Checkout {
1
+ interface Checkout {
2
2
  /**
3
3
  * Checkout ID.
4
4
  * @format GUID
5
5
  * @readonly
6
6
  */
7
- id?: string | null;
7
+ _id?: string | null;
8
8
  /**
9
9
  * Line items.
10
10
  *
@@ -19,7 +19,7 @@ export interface Checkout {
19
19
  /** Shipping information. */
20
20
  shippingInfo?: ShippingInfo;
21
21
  /**
22
- * [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
22
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
23
23
  * @maxLength 1000
24
24
  */
25
25
  buyerNote?: string | null;
@@ -107,12 +107,12 @@ export interface Checkout {
107
107
  * Date and time the checkout was created.
108
108
  * @readonly
109
109
  */
110
- createdDate?: Date | null;
110
+ _createdDate?: Date | null;
111
111
  /**
112
112
  * Date and time the checkout was updated.
113
113
  * @readonly
114
114
  */
115
- updatedDate?: Date | null;
115
+ _updatedDate?: Date | null;
116
116
  /**
117
117
  * Minimal amount to pay in order to place the order.
118
118
  * @readonly
@@ -136,7 +136,7 @@ export interface Checkout {
136
136
  */
137
137
  cartId?: string | null;
138
138
  /**
139
- * List of validation 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)).
139
+ * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
140
140
  * @readonly
141
141
  */
142
142
  violations?: Violation[];
@@ -155,9 +155,7 @@ export interface Checkout {
155
155
  /**
156
156
  * Additional settings for customization of the checkout process.
157
157
  *
158
- * > **Notes:**
159
- * > * Custom settings can only be set when creating a checkout.
160
- * > * 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).
158
+ * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
161
159
  * @immutable
162
160
  */
163
161
  customSettings?: CustomSettings;
@@ -168,6 +166,12 @@ export interface Checkout {
168
166
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
169
167
  */
170
168
  customContentReference?: CustomContentReference;
169
+ /**
170
+ * References to an external app and resource associated with this checkout.
171
+ * Used for integration and tracking across different platforms.
172
+ * @immutable
173
+ */
174
+ externalReference?: ExternalReference;
171
175
  /**
172
176
  * The business location ID associated with the checkout.
173
177
  *
@@ -176,13 +180,13 @@ export interface Checkout {
176
180
  */
177
181
  businessLocationId?: string | null;
178
182
  }
179
- export interface LineItem {
183
+ interface LineItem {
180
184
  /**
181
185
  * Line item ID.
182
186
  * @format GUID
183
187
  * @readonly
184
188
  */
185
- id?: string | null;
189
+ _id?: string | null;
186
190
  /**
187
191
  * Item quantity.
188
192
  *
@@ -192,7 +196,7 @@ export interface LineItem {
192
196
  * @max 100000
193
197
  */
194
198
  quantity?: number;
195
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
199
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
196
200
  catalogReference?: CatalogReference;
197
201
  /**
198
202
  * Item name.
@@ -206,7 +210,7 @@ export interface LineItem {
206
210
  * URL to the item's page on the site.
207
211
  * @readonly
208
212
  */
209
- url?: PageUrlV2;
213
+ url?: string;
210
214
  /**
211
215
  * Item price **after** catalog-defined discount and line item discounts.
212
216
  * @readonly
@@ -248,7 +252,7 @@ export interface LineItem {
248
252
  */
249
253
  discount?: MultiCurrencyPrice;
250
254
  /**
251
- * Line item description lines. Used for display purposes for the cart, checkout and order.
255
+ * Line item description lines. Used for displaying the cart, checkout and order.
252
256
  * @readonly
253
257
  */
254
258
  descriptionLines?: DescriptionLine[];
@@ -256,7 +260,7 @@ export interface LineItem {
256
260
  * Line item image details.
257
261
  * @readonly
258
262
  */
259
- media?: CommonImage;
263
+ media?: string;
260
264
  /**
261
265
  * Item availability details.
262
266
  * @readonly
@@ -278,9 +282,11 @@ export interface LineItem {
278
282
  */
279
283
  subscriptionOptionInfo?: SubscriptionOptionInfo;
280
284
  /**
281
- * Type of selected payment option for current item.
282
- *
283
- * Default: `FULL_PAYMENT_ONLINE`
285
+ * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
286
+ * + `"FULL_PAYMENT_ONLINE"`: The entire payment for this item happens as part of the checkout.
287
+ * + `"FULL_PAYMENT_OFFLINE"`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
288
+ * + `"MEMBERSHIP"`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
289
+ * + `"DEPOSIT_ONLINE"`: Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
284
290
  * @readonly
285
291
  */
286
292
  paymentOption?: PaymentOptionType;
@@ -343,7 +349,7 @@ export interface LineItem {
343
349
  savePaymentMethod?: boolean;
344
350
  }
345
351
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
346
- export interface CatalogReference {
352
+ interface CatalogReference {
347
353
  /**
348
354
  * ID of the item within the catalog it belongs to.
349
355
  * @minLength 1
@@ -363,13 +369,15 @@ export interface CatalogReference {
363
369
  */
364
370
  appId?: string;
365
371
  /**
366
- * 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.
372
+ * Additional item details in key:value pairs.
367
373
  *
368
- * 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)).
374
+ * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
375
+ *
376
+ * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).
369
377
  */
370
378
  options?: Record<string, any> | null;
371
379
  }
372
- export interface ProductName {
380
+ interface ProductName {
373
381
  /**
374
382
  * __Required.__ Item 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).
375
383
  *
@@ -390,13 +398,7 @@ export interface ProductName {
390
398
  */
391
399
  translated?: string | null;
392
400
  }
393
- export interface PageUrlV2 {
394
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
395
- relativePath?: string;
396
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
397
- url?: string | null;
398
- }
399
- export interface MultiCurrencyPrice {
401
+ interface MultiCurrencyPrice {
400
402
  /**
401
403
  * Amount.
402
404
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -419,7 +421,7 @@ export interface MultiCurrencyPrice {
419
421
  */
420
422
  formattedConvertedAmount?: string;
421
423
  }
422
- export interface ItemTaxFullDetails {
424
+ interface ItemTaxFullDetails {
423
425
  /** Amount for which tax is calculated. */
424
426
  taxableAmount?: MultiCurrencyPrice;
425
427
  /**
@@ -436,7 +438,7 @@ export interface ItemTaxFullDetails {
436
438
  */
437
439
  rateBreakdown?: TaxRateBreakdown[];
438
440
  }
439
- export interface TaxRateBreakdown {
441
+ interface TaxRateBreakdown {
440
442
  /**
441
443
  * Name of tax against which the calculation was performed.
442
444
  * @maxLength 100
@@ -454,7 +456,7 @@ export interface TaxRateBreakdown {
454
456
  * TaxBreakdown represents tax information for a line item.
455
457
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
456
458
  */
457
- export interface TaxBreakdown {
459
+ interface TaxBreakdown {
458
460
  /**
459
461
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
460
462
  * @maxLength 200
@@ -486,7 +488,7 @@ export interface TaxBreakdown {
486
488
  jurisdictionType?: JurisdictionType;
487
489
  }
488
490
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
489
- export declare enum JurisdictionType {
491
+ declare enum JurisdictionType {
490
492
  UNDEFINED = "UNDEFINED",
491
493
  COUNTRY = "COUNTRY",
492
494
  STATE = "STATE",
@@ -494,7 +496,7 @@ export declare enum JurisdictionType {
494
496
  CITY = "CITY",
495
497
  SPECIAL = "SPECIAL"
496
498
  }
497
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
499
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
498
500
  /** Description line plain text value. */
499
501
  plainText?: PlainTextValue;
500
502
  /** Description line color value. */
@@ -503,16 +505,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
503
505
  name?: DescriptionLineName;
504
506
  }
505
507
  /** @oneof */
506
- export interface DescriptionLineValueOneOf {
508
+ interface DescriptionLineValueOneOf {
507
509
  /** Description line plain text value. */
508
510
  plainText?: PlainTextValue;
509
511
  /** Description line color value. */
510
512
  colorInfo?: Color;
511
513
  }
512
514
  /** @oneof */
513
- export interface DescriptionLineDescriptionLineValueOneOf {
515
+ interface DescriptionLineDescriptionLineValueOneOf {
514
516
  }
515
- export interface DescriptionLineName {
517
+ interface DescriptionLineName {
516
518
  /**
517
519
  * 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).
518
520
  * @maxLength 100
@@ -526,7 +528,7 @@ export interface DescriptionLineName {
526
528
  */
527
529
  translated?: string | null;
528
530
  }
529
- export interface PlainTextValue {
531
+ interface PlainTextValue {
530
532
  /**
531
533
  * 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).
532
534
  * @maxLength 600
@@ -540,7 +542,7 @@ export interface PlainTextValue {
540
542
  */
541
543
  translated?: string | null;
542
544
  }
543
- export interface Color {
545
+ interface Color {
544
546
  /**
545
547
  * 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).
546
548
  * @maxLength 500
@@ -556,7 +558,7 @@ export interface Color {
556
558
  /** HEX or RGB color code for display. */
557
559
  code?: string | null;
558
560
  }
559
- export declare enum DescriptionLineType {
561
+ declare enum DescriptionLineType {
560
562
  /** Unrecognized type. */
561
563
  UNRECOGNISED = "UNRECOGNISED",
562
564
  /** Plain text type. */
@@ -564,30 +566,7 @@ export declare enum DescriptionLineType {
564
566
  /** Color type. */
565
567
  COLOR = "COLOR"
566
568
  }
567
- export interface CommonImage {
568
- /** WixMedia image ID. */
569
- id?: string;
570
- /** Image URL. */
571
- url?: string;
572
- /**
573
- * Original image height.
574
- * @readonly
575
- */
576
- height?: number;
577
- /**
578
- * Original image width.
579
- * @readonly
580
- */
581
- width?: number;
582
- /** Image alt text. */
583
- altText?: string | null;
584
- /**
585
- * Image filename.
586
- * @readonly
587
- */
588
- filename?: string | null;
589
- }
590
- export interface FocalPoint {
569
+ interface FocalPoint {
591
570
  /** X-coordinate of the focal point. */
592
571
  x?: number;
593
572
  /** Y-coordinate of the focal point. */
@@ -597,13 +576,13 @@ export interface FocalPoint {
597
576
  /** crop by width */
598
577
  width?: number | null;
599
578
  }
600
- export interface ItemAvailabilityInfo {
579
+ interface ItemAvailabilityInfo {
601
580
  /** Item availability status. */
602
581
  status?: ItemAvailabilityStatus;
603
582
  /** Quantity available. */
604
583
  quantityAvailable?: number | null;
605
584
  }
606
- export declare enum ItemAvailabilityStatus {
585
+ declare enum ItemAvailabilityStatus {
607
586
  AVAILABLE = "AVAILABLE",
608
587
  /** Item does not exist. */
609
588
  NOT_FOUND = "NOT_FOUND",
@@ -612,8 +591,8 @@ export declare enum ItemAvailabilityStatus {
612
591
  /** Available quantity is less than requested. */
613
592
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
614
593
  }
615
- export interface PhysicalProperties {
616
- /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
594
+ interface PhysicalProperties {
595
+ /** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
617
596
  weight?: number | null;
618
597
  /**
619
598
  * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
@@ -623,39 +602,39 @@ export interface PhysicalProperties {
623
602
  /** Whether this line item is shippable. */
624
603
  shippable?: boolean;
625
604
  }
626
- export interface Scope {
605
+ interface Scope {
627
606
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
628
607
  namespace?: string;
629
608
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
630
609
  group?: Group;
631
610
  }
632
- export interface Group {
611
+ interface Group {
633
612
  /** 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). */
634
613
  name?: string;
635
614
  /** Item ID (when the coupon scope is limited to just one item). */
636
615
  entityId?: string | null;
637
616
  }
638
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
617
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
639
618
  /** Preset item type. */
640
619
  preset?: ItemTypeItemType;
641
620
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
642
621
  custom?: string;
643
622
  }
644
623
  /** @oneof */
645
- export interface ItemTypeItemTypeDataOneOf {
624
+ interface ItemTypeItemTypeDataOneOf {
646
625
  /** Preset item type. */
647
626
  preset?: ItemTypeItemType;
648
627
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
649
628
  custom?: string;
650
629
  }
651
- export declare enum ItemTypeItemType {
630
+ declare enum ItemTypeItemType {
652
631
  UNRECOGNISED = "UNRECOGNISED",
653
632
  PHYSICAL = "PHYSICAL",
654
633
  DIGITAL = "DIGITAL",
655
634
  GIFT_CARD = "GIFT_CARD",
656
635
  SERVICE = "SERVICE"
657
636
  }
658
- export interface SubscriptionOptionInfo {
637
+ interface SubscriptionOptionInfo {
659
638
  /** Subscription option settings. */
660
639
  subscriptionSettings?: SubscriptionSettings;
661
640
  /** Subscription option title. */
@@ -663,7 +642,7 @@ export interface SubscriptionOptionInfo {
663
642
  /** Subscription option description. */
664
643
  description?: Description;
665
644
  }
666
- export interface SubscriptionSettings {
645
+ interface SubscriptionSettings {
667
646
  /** Frequency of recurring payment. */
668
647
  frequency?: SubscriptionFrequency;
669
648
  /**
@@ -684,14 +663,14 @@ export interface SubscriptionSettings {
684
663
  billingCycles?: number | null;
685
664
  }
686
665
  /** Frequency unit of recurring payment */
687
- export declare enum SubscriptionFrequency {
666
+ declare enum SubscriptionFrequency {
688
667
  UNDEFINED = "UNDEFINED",
689
668
  DAY = "DAY",
690
669
  WEEK = "WEEK",
691
670
  MONTH = "MONTH",
692
671
  YEAR = "YEAR"
693
672
  }
694
- export interface FreeTrialPeriod {
673
+ interface FreeTrialPeriod {
695
674
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
696
675
  frequency?: SubscriptionFrequency;
697
676
  /**
@@ -701,7 +680,7 @@ export interface FreeTrialPeriod {
701
680
  */
702
681
  interval?: number;
703
682
  }
704
- export interface Title {
683
+ interface Title {
705
684
  /**
706
685
  * 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).
707
686
  * @minLength 1
@@ -717,7 +696,7 @@ export interface Title {
717
696
  */
718
697
  translated?: string | null;
719
698
  }
720
- export interface Description {
699
+ interface Description {
721
700
  /**
722
701
  * Subscription option description.
723
702
  * @maxLength 500
@@ -729,13 +708,13 @@ export interface Description {
729
708
  */
730
709
  translated?: string | null;
731
710
  }
732
- export interface SecuredMedia {
711
+ interface SecuredMedia {
733
712
  /**
734
713
  * Media ID in Wix Media Manager.
735
714
  * @minLength 1
736
715
  * @maxLength 100
737
716
  */
738
- id?: string;
717
+ _id?: string;
739
718
  /**
740
719
  * Original filename.
741
720
  * @minLength 1
@@ -745,7 +724,7 @@ export interface SecuredMedia {
745
724
  /** File type. */
746
725
  fileType?: FileType;
747
726
  }
748
- export declare enum FileType {
727
+ declare enum FileType {
749
728
  UNSPECIFIED = "UNSPECIFIED",
750
729
  SECURE_PICTURE = "SECURE_PICTURE",
751
730
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -754,7 +733,7 @@ export declare enum FileType {
754
733
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
755
734
  }
756
735
  /** Type of selected payment option for catalog item */
757
- export declare enum PaymentOptionType {
736
+ declare enum PaymentOptionType {
758
737
  /** The entire payment for this item happens as part of the checkout. */
759
738
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
760
739
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -766,7 +745,7 @@ export declare enum PaymentOptionType {
766
745
  /** 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`. */
767
746
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
768
747
  }
769
- export interface ServiceProperties {
748
+ interface ServiceProperties {
770
749
  /**
771
750
  * 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.
772
751
  * For example, the start time of a class.
@@ -779,7 +758,7 @@ export interface ServiceProperties {
779
758
  */
780
759
  numberOfParticipants?: number | null;
781
760
  }
782
- export interface PriceDescription {
761
+ interface PriceDescription {
783
762
  /**
784
763
  * __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).
785
764
  * @minLength 1
@@ -795,7 +774,7 @@ export interface PriceDescription {
795
774
  */
796
775
  translated?: string | null;
797
776
  }
798
- export interface CatalogOverrideFields {
777
+ interface CatalogOverrideFields {
799
778
  /** Item name. */
800
779
  productName?: ProductName;
801
780
  /**
@@ -816,7 +795,7 @@ export interface CatalogOverrideFields {
816
795
  /** Physical properties of the item. */
817
796
  physicalProperties?: PhysicalProperties;
818
797
  /** Item image. */
819
- image?: Image;
798
+ image?: string;
820
799
  /** Payment method selected for the item. */
821
800
  paymentOption?: PaymentOption;
822
801
  /**
@@ -832,19 +811,7 @@ export interface CatalogOverrideFields {
832
811
  */
833
812
  savePaymentMethod?: boolean | null;
834
813
  }
835
- export interface Image {
836
- /** WixMedia image ID. */
837
- id?: string;
838
- /** Original image height. */
839
- height?: number;
840
- /** Original image width. */
841
- width?: number;
842
- /** Image alt text. Optional. */
843
- altText?: string | null;
844
- /** Image filename. Optional. */
845
- filename?: string | null;
846
- }
847
- export interface PaymentOption {
814
+ interface PaymentOption {
848
815
  /**
849
816
  * Type of selected payment option for current item.
850
817
  *
@@ -852,22 +819,22 @@ export interface PaymentOption {
852
819
  */
853
820
  value?: PaymentOptionType;
854
821
  }
855
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
822
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
856
823
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
857
824
  addressType?: TaxableAddressType;
858
825
  }
859
826
  /** @oneof */
860
- export interface TaxableAddressTaxableAddressDataOneOf {
827
+ interface TaxableAddressTaxableAddressDataOneOf {
861
828
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
862
829
  addressType?: TaxableAddressType;
863
830
  }
864
- export declare enum TaxableAddressType {
831
+ declare enum TaxableAddressType {
865
832
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
866
833
  BUSINESS = "BUSINESS",
867
834
  BILLING = "BILLING",
868
835
  SHIPPING = "SHIPPING"
869
836
  }
870
- export interface ExtendedFields {
837
+ interface ExtendedFields {
871
838
  /**
872
839
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
873
840
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -878,7 +845,7 @@ export interface ExtendedFields {
878
845
  */
879
846
  namespaces?: Record<string, Record<string, any>>;
880
847
  }
881
- export interface Policy {
848
+ interface Policy {
882
849
  /**
883
850
  * Policy title - should be translated
884
851
  * @minLength 1
@@ -892,13 +859,13 @@ export interface Policy {
892
859
  */
893
860
  content?: string;
894
861
  }
895
- export interface ModifierGroup {
862
+ interface ModifierGroup {
896
863
  /**
897
864
  * Modifier group id.
898
865
  * @minLength 1
899
866
  * @maxLength 36
900
867
  */
901
- id?: string;
868
+ _id?: string;
902
869
  /** Modifier group name. */
903
870
  name?: TranslatableString;
904
871
  /**
@@ -908,7 +875,7 @@ export interface ModifierGroup {
908
875
  */
909
876
  modifiers?: ItemModifier[];
910
877
  }
911
- export interface TranslatableString {
878
+ interface TranslatableString {
912
879
  /**
913
880
  * __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).
914
881
  *
@@ -929,13 +896,13 @@ export interface TranslatableString {
929
896
  */
930
897
  translated?: string | null;
931
898
  }
932
- export interface ItemModifier {
899
+ interface ItemModifier {
933
900
  /**
934
901
  * Modifier ID.
935
902
  * @minLength 1
936
903
  * @maxLength 36
937
904
  */
938
- id?: string;
905
+ _id?: string;
939
906
  /**
940
907
  * The quantity of this modifier.
941
908
  * @min 1
@@ -950,14 +917,14 @@ export interface ItemModifier {
950
917
  price?: MultiCurrencyPrice;
951
918
  }
952
919
  /** Billing Info and shipping details */
953
- export interface AddressWithContact {
920
+ interface AddressWithContact {
954
921
  /** Address. */
955
922
  address?: ApiAddress;
956
923
  /** Contact details. */
957
924
  contactDetails?: FullAddressContactDetails;
958
925
  }
959
926
  /** Physical address */
960
- export interface ApiAddress {
927
+ interface ApiAddress {
961
928
  /**
962
929
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
963
930
  * @format COUNTRY
@@ -984,7 +951,7 @@ export interface ApiAddress {
984
951
  * Main address line (usually street name and number).
985
952
  * @maxLength 150
986
953
  */
987
- addressLine?: string | null;
954
+ addressLine1?: string | null;
988
955
  /**
989
956
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
990
957
  * @maxLength 100
@@ -1001,20 +968,20 @@ export interface ApiAddress {
1001
968
  */
1002
969
  subdivisionFullname?: string | null;
1003
970
  }
1004
- export interface StreetAddress {
971
+ interface StreetAddress {
1005
972
  /** Street number. */
1006
973
  number?: string;
1007
974
  /** Street name. */
1008
975
  name?: string;
1009
976
  }
1010
- export interface AddressLocation {
977
+ interface AddressLocation {
1011
978
  /** Address latitude. */
1012
979
  latitude?: number | null;
1013
980
  /** Address longitude. */
1014
981
  longitude?: number | null;
1015
982
  }
1016
983
  /** Full contact details for an address */
1017
- export interface FullAddressContactDetails {
984
+ interface FullAddressContactDetails {
1018
985
  /**
1019
986
  * First name.
1020
987
  * @maxLength 100
@@ -1038,9 +1005,9 @@ export interface FullAddressContactDetails {
1038
1005
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1039
1006
  vatId?: CommonVatId;
1040
1007
  }
1041
- export interface CommonVatId {
1008
+ interface CommonVatId {
1042
1009
  /** Customer's tax ID. */
1043
- id?: string;
1010
+ _id?: string;
1044
1011
  /**
1045
1012
  * Tax type.
1046
1013
  *
@@ -1051,14 +1018,14 @@ export interface CommonVatId {
1051
1018
  type?: CommonVatType;
1052
1019
  }
1053
1020
  /** tax info types */
1054
- export declare enum CommonVatType {
1021
+ declare enum CommonVatType {
1055
1022
  UNSPECIFIED = "UNSPECIFIED",
1056
1023
  /** CPF - for individual tax payers. */
1057
1024
  CPF = "CPF",
1058
1025
  /** CNPJ - for corporations */
1059
1026
  CNPJ = "CNPJ"
1060
1027
  }
1061
- export interface ShippingInfo {
1028
+ interface ShippingInfo {
1062
1029
  /** Shipping address and contact details. */
1063
1030
  shippingDestination?: AddressWithContact;
1064
1031
  /** Selected option out of the options allowed for the `region`. */
@@ -1074,7 +1041,7 @@ export interface ShippingInfo {
1074
1041
  */
1075
1042
  carrierServiceOptions?: CarrierServiceOption[];
1076
1043
  }
1077
- export interface SelectedCarrierServiceOption {
1044
+ interface SelectedCarrierServiceOption {
1078
1045
  /**
1079
1046
  * Unique identifier of selected option. For example, "usps_std_overnight".
1080
1047
  * @maxLength 100
@@ -1117,7 +1084,7 @@ export interface SelectedCarrierServiceOption {
1117
1084
  /** If the delivery solution is a partial and doesn't apply to all items. */
1118
1085
  partial?: boolean | null;
1119
1086
  }
1120
- export interface DeliveryLogistics {
1087
+ interface DeliveryLogistics {
1121
1088
  /**
1122
1089
  * Expected delivery time, in free text. For example, "3-5 business days".
1123
1090
  * @maxLength 500
@@ -1131,7 +1098,7 @@ export interface DeliveryLogistics {
1131
1098
  /** Pickup details. */
1132
1099
  pickupDetails?: PickupDetails;
1133
1100
  }
1134
- export interface PickupDetails {
1101
+ interface PickupDetails {
1135
1102
  /** Pickup address. */
1136
1103
  address?: ApiAddress;
1137
1104
  /**
@@ -1142,18 +1109,18 @@ export interface PickupDetails {
1142
1109
  /** Pickup method */
1143
1110
  pickupMethod?: PickupMethod;
1144
1111
  }
1145
- export declare enum PickupMethod {
1112
+ declare enum PickupMethod {
1146
1113
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1147
1114
  STORE_PICKUP = "STORE_PICKUP",
1148
1115
  PICKUP_POINT = "PICKUP_POINT"
1149
1116
  }
1150
- export interface DeliveryTimeSlot {
1117
+ interface DeliveryTimeSlot {
1151
1118
  /** starting time of the delivery time slot */
1152
1119
  from?: Date | null;
1153
1120
  /** ending time of the delivery time slot */
1154
1121
  to?: Date | null;
1155
1122
  }
1156
- export interface SelectedCarrierServiceOptionPrices {
1123
+ interface SelectedCarrierServiceOptionPrices {
1157
1124
  /** Total shipping price, after discount and after tax. */
1158
1125
  totalPriceAfterTax?: MultiCurrencyPrice;
1159
1126
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -1165,7 +1132,7 @@ export interface SelectedCarrierServiceOptionPrices {
1165
1132
  /** Shipping price before discount and before tax. */
1166
1133
  price?: MultiCurrencyPrice;
1167
1134
  }
1168
- export interface SelectedCarrierServiceOptionOtherCharge {
1135
+ interface SelectedCarrierServiceOptionOtherCharge {
1169
1136
  /** Type of additional cost. */
1170
1137
  type?: ChargeType;
1171
1138
  /**
@@ -1176,11 +1143,11 @@ export interface SelectedCarrierServiceOptionOtherCharge {
1176
1143
  /** Price of added charge. */
1177
1144
  cost?: SelectedCarrierServiceOptionPrices;
1178
1145
  }
1179
- export declare enum ChargeType {
1146
+ declare enum ChargeType {
1180
1147
  HANDLING_FEE = "HANDLING_FEE",
1181
1148
  INSURANCE = "INSURANCE"
1182
1149
  }
1183
- export interface DeliveryAllocation {
1150
+ interface DeliveryAllocation {
1184
1151
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1185
1152
  deliveryCarrier?: Carrier;
1186
1153
  /** The delivery region that are relevant for this delivery solution. */
@@ -1188,7 +1155,7 @@ export interface DeliveryAllocation {
1188
1155
  /** Populated if the delivery solution is a partially supplied by this carrier. */
1189
1156
  applicableLineItems?: ApplicableLineItems;
1190
1157
  }
1191
- export interface Carrier {
1158
+ interface Carrier {
1192
1159
  /**
1193
1160
  * The carrier app id
1194
1161
  * @format GUID
@@ -1200,19 +1167,19 @@ export interface Carrier {
1200
1167
  */
1201
1168
  code?: string;
1202
1169
  }
1203
- export interface Region {
1170
+ interface Region {
1204
1171
  /**
1205
1172
  * The delivery region id.
1206
1173
  * @format GUID
1207
1174
  */
1208
- id?: string | null;
1175
+ _id?: string | null;
1209
1176
  /**
1210
1177
  * The delivery region name.
1211
1178
  * @maxLength 100
1212
1179
  */
1213
1180
  name?: string | null;
1214
1181
  }
1215
- export interface ApplicableLineItems {
1182
+ interface ApplicableLineItems {
1216
1183
  /**
1217
1184
  * Line items that the delivery solution is for.
1218
1185
  * @maxSize 300
@@ -1221,20 +1188,20 @@ export interface ApplicableLineItems {
1221
1188
  */
1222
1189
  lineItemIds?: string[];
1223
1190
  }
1224
- export interface ShippingRegion {
1191
+ interface ShippingRegion {
1225
1192
  /**
1226
1193
  * Shipping region ID.
1227
1194
  * @format GUID
1228
1195
  * @readonly
1229
1196
  */
1230
- id?: string;
1197
+ _id?: string;
1231
1198
  /**
1232
1199
  * Shipping region name.
1233
1200
  * @maxLength 100
1234
1201
  */
1235
1202
  name?: string;
1236
1203
  }
1237
- export interface CarrierServiceOption {
1204
+ interface CarrierServiceOption {
1238
1205
  /**
1239
1206
  * Carrier ID.
1240
1207
  * @format GUID
@@ -1243,7 +1210,7 @@ export interface CarrierServiceOption {
1243
1210
  /** Shipping options offered by this carrier for this request. */
1244
1211
  shippingOptions?: ShippingOption[];
1245
1212
  }
1246
- export interface ShippingOption {
1213
+ interface ShippingOption {
1247
1214
  /**
1248
1215
  * Unique code of provided shipping option like "usps_std_overnight".
1249
1216
  * For legacy calculators this would be the UUID of the option.
@@ -1268,33 +1235,33 @@ export interface ShippingOption {
1268
1235
  /** If the delivery solution is a partial and doesn't apply to all items. */
1269
1236
  partial?: boolean | null;
1270
1237
  }
1271
- export interface ShippingPrice {
1238
+ interface ShippingPrice {
1272
1239
  /** Shipping price. */
1273
1240
  price?: MultiCurrencyPrice;
1274
1241
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1275
1242
  otherCharges?: OtherCharge[];
1276
1243
  }
1277
- export interface OtherCharge {
1244
+ interface OtherCharge {
1278
1245
  /** Type of additional cost. */
1279
1246
  type?: ChargeType;
1280
1247
  /** Price of added cost. */
1281
1248
  price?: MultiCurrencyPrice;
1282
1249
  }
1283
- export interface BuyerInfo extends BuyerInfoIdOneOf {
1250
+ interface BuyerInfo extends BuyerInfoIdOneOf {
1284
1251
  /**
1285
- * Visitor ID (if site visitor is **not** a member).
1252
+ * Visitor ID - if the buyer is **not** a site member.
1286
1253
  * @format GUID
1287
1254
  * @readonly
1288
1255
  */
1289
1256
  visitorId?: string;
1290
1257
  /**
1291
- * Member ID (if site visitor is a site member).
1258
+ * Member ID - If the buyer is a site member.
1292
1259
  * @format GUID
1293
1260
  * @readonly
1294
1261
  */
1295
1262
  memberId?: string;
1296
1263
  /**
1297
- * Contact ID. Auto-created if one does not yet exist. For more information, see the Contacts API.
1264
+ * Contact ID. For more information, see the Contacts API.
1298
1265
  * @format GUID
1299
1266
  * @readonly
1300
1267
  */
@@ -1306,21 +1273,21 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
1306
1273
  email?: string | null;
1307
1274
  }
1308
1275
  /** @oneof */
1309
- export interface BuyerInfoIdOneOf {
1276
+ interface BuyerInfoIdOneOf {
1310
1277
  /**
1311
- * Visitor ID (if site visitor is **not** a member).
1278
+ * Visitor ID - if the buyer is **not** a site member.
1312
1279
  * @format GUID
1313
1280
  * @readonly
1314
1281
  */
1315
1282
  visitorId?: string;
1316
1283
  /**
1317
- * Member ID (if site visitor is a site member).
1284
+ * Member ID - If the buyer is a site member.
1318
1285
  * @format GUID
1319
1286
  * @readonly
1320
1287
  */
1321
1288
  memberId?: string;
1322
1289
  }
1323
- export interface PriceSummary {
1290
+ interface PriceSummary {
1324
1291
  /** Subtotal of all line items, before discounts and before tax. */
1325
1292
  subtotal?: MultiCurrencyPrice;
1326
1293
  /** Total shipping price, before discounts and before tax. */
@@ -1334,7 +1301,7 @@ export interface PriceSummary {
1334
1301
  /** Total additional fees price before tax. */
1335
1302
  additionalFees?: MultiCurrencyPrice;
1336
1303
  }
1337
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1304
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1338
1305
  /** General shipping calculation error. */
1339
1306
  generalShippingCalculationError?: Details;
1340
1307
  /** Carrier errors. */
@@ -1356,13 +1323,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
1356
1323
  discountsCalculationError?: Details;
1357
1324
  }
1358
1325
  /** @oneof */
1359
- export interface CalculationErrorsShippingCalculationErrorOneOf {
1326
+ interface CalculationErrorsShippingCalculationErrorOneOf {
1360
1327
  /** General shipping calculation error. */
1361
1328
  generalShippingCalculationError?: Details;
1362
1329
  /** Carrier errors. */
1363
1330
  carrierErrors?: CarrierErrors;
1364
1331
  }
1365
- export interface Details extends DetailsKindOneOf {
1332
+ interface Details extends DetailsKindOneOf {
1366
1333
  applicationError?: ApplicationError;
1367
1334
  validationError?: ValidationError;
1368
1335
  systemError?: SystemError;
@@ -1373,12 +1340,12 @@ export interface Details extends DetailsKindOneOf {
1373
1340
  tracing?: Record<string, string>;
1374
1341
  }
1375
1342
  /** @oneof */
1376
- export interface DetailsKindOneOf {
1343
+ interface DetailsKindOneOf {
1377
1344
  applicationError?: ApplicationError;
1378
1345
  validationError?: ValidationError;
1379
1346
  systemError?: SystemError;
1380
1347
  }
1381
- export interface ApplicationError {
1348
+ interface ApplicationError {
1382
1349
  /** Error code. */
1383
1350
  code?: string;
1384
1351
  /** Description of the error. */
@@ -1418,10 +1385,10 @@ export interface ApplicationError {
1418
1385
  * ]
1419
1386
  * }
1420
1387
  */
1421
- export interface ValidationError {
1388
+ interface ValidationError {
1422
1389
  fieldViolations?: FieldViolation[];
1423
1390
  }
1424
- export declare enum RuleType {
1391
+ declare enum RuleType {
1425
1392
  VALIDATION = "VALIDATION",
1426
1393
  OTHER = "OTHER",
1427
1394
  MAX = "MAX",
@@ -1444,7 +1411,7 @@ export declare enum RuleType {
1444
1411
  EXACT_SIZE = "EXACT_SIZE",
1445
1412
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1446
1413
  }
1447
- export interface FieldViolation {
1414
+ interface FieldViolation {
1448
1415
  field?: string;
1449
1416
  description?: string;
1450
1417
  violatedRule?: RuleType;
@@ -1452,26 +1419,26 @@ export interface FieldViolation {
1452
1419
  ruleName?: string | null;
1453
1420
  data?: Record<string, any> | null;
1454
1421
  }
1455
- export interface SystemError {
1422
+ interface SystemError {
1456
1423
  /** Error code. */
1457
1424
  errorCode?: string | null;
1458
1425
  }
1459
- export interface CarrierErrors {
1426
+ interface CarrierErrors {
1460
1427
  /** Carrier errors. */
1461
1428
  errors?: CarrierError[];
1462
1429
  }
1463
- export interface CarrierError {
1430
+ interface CarrierError {
1464
1431
  /** Carrier ID. */
1465
1432
  carrierId?: string;
1466
1433
  /** Error details. */
1467
1434
  error?: Details;
1468
1435
  }
1469
- export interface GiftCard {
1436
+ interface GiftCard {
1470
1437
  /**
1471
1438
  * Gift Card ID.
1472
1439
  * @deprecated
1473
1440
  */
1474
- id?: string;
1441
+ _id?: string;
1475
1442
  /** Gift card obfuscated code. */
1476
1443
  obfuscatedCode?: string;
1477
1444
  /** Gift card value. */
@@ -1489,7 +1456,7 @@ export interface GiftCard {
1489
1456
  */
1490
1457
  externalId?: string | null;
1491
1458
  }
1492
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1459
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1493
1460
  /** Coupon details. */
1494
1461
  coupon?: Coupon;
1495
1462
  /** Merchant discount. */
@@ -1499,7 +1466,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1499
1466
  /** Discount type. */
1500
1467
  discountType?: DiscountType;
1501
1468
  /**
1502
- * IDs of line items the discount applies to.
1469
+ * IDs of the line items the discount applies to.
1503
1470
  * @format GUID
1504
1471
  * @deprecated IDs of line items the discount applies to.
1505
1472
  * @replacedBy line_items_discounts
@@ -1508,7 +1475,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1508
1475
  lineItemIds?: string[];
1509
1476
  }
1510
1477
  /** @oneof */
1511
- export interface AppliedDiscountDiscountSourceOneOf {
1478
+ interface AppliedDiscountDiscountSourceOneOf {
1512
1479
  /** Coupon details. */
1513
1480
  coupon?: Coupon;
1514
1481
  /** Merchant discount. */
@@ -1516,15 +1483,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
1516
1483
  /** Discount rule */
1517
1484
  discountRule?: DiscountRule;
1518
1485
  }
1519
- export declare enum DiscountType {
1486
+ declare enum DiscountType {
1520
1487
  GLOBAL = "GLOBAL",
1521
1488
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1522
1489
  SHIPPING = "SHIPPING"
1523
1490
  }
1524
1491
  /** Coupon */
1525
- export interface Coupon {
1492
+ interface Coupon {
1526
1493
  /** Coupon ID. */
1527
- id?: string;
1494
+ _id?: string;
1528
1495
  /** Coupon code. */
1529
1496
  code?: string;
1530
1497
  /** Coupon value. */
@@ -1532,7 +1499,7 @@ export interface Coupon {
1532
1499
  /** Coupon name. */
1533
1500
  name?: string;
1534
1501
  }
1535
- export interface MerchantDiscount {
1502
+ interface MerchantDiscount {
1536
1503
  /** Discount value. */
1537
1504
  amount?: MultiCurrencyPrice;
1538
1505
  /**
@@ -1542,18 +1509,18 @@ export interface MerchantDiscount {
1542
1509
  */
1543
1510
  percentage?: number | null;
1544
1511
  }
1545
- export interface DiscountRule {
1512
+ interface DiscountRule {
1546
1513
  /**
1547
1514
  * Discount rule ID
1548
1515
  * @format GUID
1549
1516
  */
1550
- id?: string;
1517
+ _id?: string;
1551
1518
  /** Discount rule name */
1552
1519
  name?: DiscountRuleName;
1553
1520
  /** Discount value. */
1554
1521
  amount?: MultiCurrencyPrice;
1555
1522
  }
1556
- export interface DiscountRuleName {
1523
+ interface DiscountRuleName {
1557
1524
  /**
1558
1525
  * Original discount rule name (in site's default language).
1559
1526
  * @minLength 1
@@ -1567,16 +1534,16 @@ export interface DiscountRuleName {
1567
1534
  */
1568
1535
  translated?: string | null;
1569
1536
  }
1570
- export interface LineItemDiscount {
1537
+ interface LineItemDiscount {
1571
1538
  /**
1572
1539
  * ID of line item the discount applies to.
1573
1540
  * @format GUID
1574
1541
  */
1575
- id?: string;
1542
+ _id?: string;
1576
1543
  /** Discount value. */
1577
1544
  totalDiscountAmount?: MultiCurrencyPrice;
1578
1545
  }
1579
- export interface CustomField {
1546
+ interface CustomField {
1580
1547
  /** Custom field value. */
1581
1548
  value?: any;
1582
1549
  /**
@@ -1592,7 +1559,7 @@ export interface CustomField {
1592
1559
  */
1593
1560
  translatedTitle?: string | null;
1594
1561
  }
1595
- export declare enum WeightUnit {
1562
+ declare enum WeightUnit {
1596
1563
  /** Weight unit can't be classified due to an error. */
1597
1564
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1598
1565
  /** Kilograms. */
@@ -1600,7 +1567,7 @@ export declare enum WeightUnit {
1600
1567
  /** Pounds. */
1601
1568
  LB = "LB"
1602
1569
  }
1603
- export interface TaxSummary {
1570
+ interface TaxSummary {
1604
1571
  /**
1605
1572
  * Amount for which tax is calculated, added from line items.
1606
1573
  * @readonly
@@ -1617,7 +1584,7 @@ export interface TaxSummary {
1617
1584
  */
1618
1585
  calculationDetails?: TaxCalculationDetails;
1619
1586
  }
1620
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1587
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1621
1588
  /** Reason the manual calculation was used. */
1622
1589
  manualRateReason?: ManualCalculationReason;
1623
1590
  /** Details of the fallback rate calculation. */
@@ -1626,13 +1593,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
1626
1593
  rateType?: RateType;
1627
1594
  }
1628
1595
  /** @oneof */
1629
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
1596
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
1630
1597
  /** Reason the manual calculation was used. */
1631
1598
  manualRateReason?: ManualCalculationReason;
1632
1599
  /** Details of the fallback rate calculation. */
1633
1600
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1634
1601
  }
1635
- export declare enum RateType {
1602
+ declare enum RateType {
1636
1603
  /** no tax being collected for this request due to location of purchase */
1637
1604
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
1638
1605
  /** manual rate used for calculation */
@@ -1642,19 +1609,19 @@ export declare enum RateType {
1642
1609
  /** fallback rate used for calculation */
1643
1610
  FALLBACK_RATE = "FALLBACK_RATE"
1644
1611
  }
1645
- export declare enum ManualCalculationReason {
1612
+ declare enum ManualCalculationReason {
1646
1613
  /** user set calculator in Business Manager to be Manual */
1647
1614
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
1648
1615
  /** specific region is on manual even though Global setting is Auto-tax */
1649
1616
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
1650
1617
  }
1651
- export interface AutoTaxFallbackCalculationDetails {
1618
+ interface AutoTaxFallbackCalculationDetails {
1652
1619
  /** reason for fallback */
1653
1620
  fallbackReason?: FallbackReason;
1654
1621
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
1655
1622
  error?: ApplicationError;
1656
1623
  }
1657
- export declare enum FallbackReason {
1624
+ declare enum FallbackReason {
1658
1625
  /** auto-tax failed to be calculated */
1659
1626
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
1660
1627
  /** auto-tax was temporarily deactivated on a system-level */
@@ -1664,7 +1631,7 @@ export declare enum FallbackReason {
1664
1631
  * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
1665
1632
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1666
1633
  */
1667
- export interface AggregatedTaxBreakdown {
1634
+ interface AggregatedTaxBreakdown {
1668
1635
  /**
1669
1636
  * The name of the tax against which this tax amount was calculated.
1670
1637
  * @maxLength 200
@@ -1690,7 +1657,7 @@ export interface AggregatedTaxBreakdown {
1690
1657
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1691
1658
  aggregatedTaxAmount?: MultiCurrencyPrice;
1692
1659
  }
1693
- export declare enum ChannelType {
1660
+ declare enum ChannelType {
1694
1661
  /** Unspecified sales channel. This value is not supported. */
1695
1662
  UNSPECIFIED = "UNSPECIFIED",
1696
1663
  /** A web client. */
@@ -1724,7 +1691,7 @@ export declare enum ChannelType {
1724
1691
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
1725
1692
  FAIRE_COM = "FAIRE_COM"
1726
1693
  }
1727
- export interface CreatedBy extends CreatedByIdOneOf {
1694
+ interface CreatedBy extends CreatedByIdOneOf {
1728
1695
  /**
1729
1696
  * User ID. When the order was created by a Wix user on behalf of a buyer.
1730
1697
  * For example, via POS (point of service).
@@ -1748,7 +1715,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
1748
1715
  appId?: string;
1749
1716
  }
1750
1717
  /** @oneof */
1751
- export interface CreatedByIdOneOf {
1718
+ interface CreatedByIdOneOf {
1752
1719
  /**
1753
1720
  * User ID. When the order was created by a Wix user on behalf of a buyer.
1754
1721
  * For example, via POS (point of service).
@@ -1772,7 +1739,7 @@ export interface CreatedByIdOneOf {
1772
1739
  appId?: string;
1773
1740
  }
1774
1741
  /** Reserved for internal use. */
1775
- export interface MembershipOptions {
1742
+ interface MembershipOptions {
1776
1743
  /**
1777
1744
  * Reserved for internal use.
1778
1745
  * @readonly
@@ -1788,13 +1755,13 @@ export interface MembershipOptions {
1788
1755
  /** Selected membership to apply to this checkout. */
1789
1756
  selectedMemberships?: SelectedMemberships;
1790
1757
  }
1791
- export interface Membership {
1758
+ interface Membership {
1792
1759
  /**
1793
1760
  * Membership ID.
1794
1761
  * @minLength 1
1795
1762
  * @maxLength 100
1796
1763
  */
1797
- id?: string;
1764
+ _id?: string;
1798
1765
  /**
1799
1766
  * ID of the application providing this payment option.
1800
1767
  * @format GUID
@@ -1803,7 +1770,7 @@ export interface Membership {
1803
1770
  /** The name of this membership. */
1804
1771
  name?: MembershipName;
1805
1772
  /**
1806
- * Line item IDs which are "paid" for by this membership.
1773
+ * Line item IDs which are "paid for" by this membership.
1807
1774
  * @minSize 1
1808
1775
  * @maxSize 300
1809
1776
  * @minLength 1
@@ -1817,7 +1784,7 @@ export interface Membership {
1817
1784
  /** Additional data about this membership. */
1818
1785
  additionalData?: Record<string, any> | null;
1819
1786
  }
1820
- export interface MembershipName {
1787
+ interface MembershipName {
1821
1788
  /**
1822
1789
  * Membership name.
1823
1790
  * @maxLength 100
@@ -1829,7 +1796,7 @@ export interface MembershipName {
1829
1796
  */
1830
1797
  translated?: string | null;
1831
1798
  }
1832
- export interface MembershipPaymentCredits {
1799
+ interface MembershipPaymentCredits {
1833
1800
  /**
1834
1801
  * Membership's total amount of credits.
1835
1802
  * @min 1
@@ -1838,7 +1805,7 @@ export interface MembershipPaymentCredits {
1838
1805
  /** Membership's remaining amount of credits. */
1839
1806
  remaining?: number;
1840
1807
  }
1841
- export interface InvalidMembership {
1808
+ interface InvalidMembership {
1842
1809
  /** Membership details. */
1843
1810
  membership?: Membership;
1844
1811
  /**
@@ -1848,20 +1815,20 @@ export interface InvalidMembership {
1848
1815
  */
1849
1816
  reason?: string;
1850
1817
  }
1851
- export interface SelectedMemberships {
1818
+ interface SelectedMemberships {
1852
1819
  /**
1853
1820
  * Selected memberships.
1854
1821
  * @maxSize 300
1855
1822
  */
1856
1823
  memberships?: SelectedMembership[];
1857
1824
  }
1858
- export interface SelectedMembership {
1825
+ interface SelectedMembership {
1859
1826
  /**
1860
1827
  * Membership ID.
1861
1828
  * @minLength 1
1862
1829
  * @maxLength 100
1863
1830
  */
1864
- id?: string;
1831
+ _id?: string;
1865
1832
  /**
1866
1833
  * ID of the app providing this payment option.
1867
1834
  * @format GUID
@@ -1876,7 +1843,7 @@ export interface SelectedMembership {
1876
1843
  */
1877
1844
  lineItemIds?: string[];
1878
1845
  }
1879
- export interface AdditionalFee {
1846
+ interface AdditionalFee {
1880
1847
  /**
1881
1848
  * Additional fee's unique code (or ID) for future processing.
1882
1849
  * @minLength 1
@@ -1912,7 +1879,7 @@ export interface AdditionalFee {
1912
1879
  /** the source the additional fee was added from */
1913
1880
  source?: AdditionalFeeSource;
1914
1881
  }
1915
- export declare enum AdditionalFeeSource {
1882
+ declare enum AdditionalFeeSource {
1916
1883
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
1917
1884
  /** The additional fee was added by an additional fee service plugin */
1918
1885
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -1921,7 +1888,7 @@ export declare enum AdditionalFeeSource {
1921
1888
  /** The additional fee was added manually on the request */
1922
1889
  MANUAL = "MANUAL"
1923
1890
  }
1924
- export interface ConversionInfo {
1891
+ interface ConversionInfo {
1925
1892
  /**
1926
1893
  * The site currency.
1927
1894
  * @readonly
@@ -1935,7 +1902,7 @@ export interface ConversionInfo {
1935
1902
  */
1936
1903
  conversionRate?: string;
1937
1904
  }
1938
- export interface Violation {
1905
+ interface Violation {
1939
1906
  /** 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. */
1940
1907
  severity?: Severity;
1941
1908
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -1947,7 +1914,7 @@ export interface Violation {
1947
1914
  */
1948
1915
  description?: string | null;
1949
1916
  }
1950
- export declare enum Severity {
1917
+ declare enum Severity {
1951
1918
  /** The user is allowed to move forward in the flow. */
1952
1919
  WARNING = "WARNING",
1953
1920
  /**
@@ -1956,48 +1923,48 @@ export declare enum Severity {
1956
1923
  */
1957
1924
  ERROR = "ERROR"
1958
1925
  }
1959
- export interface Target extends TargetTargetTypeOneOf {
1926
+ interface Target extends TargetTargetTypeOneOf {
1960
1927
  /** General (other) violation. */
1961
1928
  other?: Other;
1962
1929
  /** Specific line item violation. */
1963
1930
  lineItem?: TargetLineItem;
1964
1931
  }
1965
1932
  /** @oneof */
1966
- export interface TargetTargetTypeOneOf {
1933
+ interface TargetTargetTypeOneOf {
1967
1934
  /** General (other) violation. */
1968
1935
  other?: Other;
1969
1936
  /** Specific line item violation. */
1970
1937
  lineItem?: TargetLineItem;
1971
1938
  }
1972
1939
  /** Available locations on the webpage */
1973
- export declare enum NameInOther {
1940
+ declare enum NameInOther {
1974
1941
  /** Default location, in case no specific location is specified. */
1975
1942
  OTHER_DEFAULT = "OTHER_DEFAULT"
1976
1943
  }
1977
1944
  /** Available locations on the line item */
1978
- export declare enum NameInLineItem {
1945
+ declare enum NameInLineItem {
1979
1946
  /** Default location, in case no specific location is specified. */
1980
1947
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
1981
1948
  }
1982
- export declare enum SuggestedFix {
1949
+ declare enum SuggestedFix {
1983
1950
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
1984
1951
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
1985
1952
  /** The line item should be removed from the cart or checkout to resolve the violation. */
1986
1953
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
1987
1954
  }
1988
1955
  /** General (other) violation. */
1989
- export interface Other {
1956
+ interface Other {
1990
1957
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
1991
1958
  name?: NameInOther;
1992
1959
  }
1993
1960
  /** Specific line item violation. */
1994
- export interface TargetLineItem {
1961
+ interface TargetLineItem {
1995
1962
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
1996
1963
  name?: NameInLineItem;
1997
1964
  /** ID of the line item containing the violation. */
1998
- id?: string | null;
1965
+ _id?: string | null;
1999
1966
  }
2000
- export interface CustomSettings {
1967
+ interface CustomSettings {
2001
1968
  /**
2002
1969
  * Whether to restrict the option to add or remove a gift card on the checkout page.
2003
1970
  *
@@ -2023,7 +1990,7 @@ export interface CustomSettings {
2023
1990
  */
2024
1991
  disabledManualPayment?: boolean;
2025
1992
  }
2026
- export interface CustomContentReference {
1993
+ interface CustomContentReference {
2027
1994
  /**
2028
1995
  * ID of the app providing the content.
2029
1996
  *
@@ -2039,7 +2006,7 @@ export interface CustomContentReference {
2039
2006
  */
2040
2007
  componentId?: string;
2041
2008
  }
2042
- export interface ExternalReference {
2009
+ interface ExternalReference {
2043
2010
  /**
2044
2011
  * ID of the app associated with the purchase flow.
2045
2012
  * For example, the Wix Pay Links app ID.
@@ -2056,7 +2023,7 @@ export interface ExternalReference {
2056
2023
  */
2057
2024
  resourceId?: string | null;
2058
2025
  }
2059
- export interface SubscriptionCharges {
2026
+ interface SubscriptionCharges {
2060
2027
  /**
2061
2028
  * ids of the items the subscription is defined on
2062
2029
  * @format GUID
@@ -2076,7 +2043,7 @@ export interface SubscriptionCharges {
2076
2043
  */
2077
2044
  charges?: Charge[];
2078
2045
  }
2079
- export interface Charge {
2046
+ interface Charge {
2080
2047
  /** The cycle number from which the charge starts. */
2081
2048
  cycleFrom?: number;
2082
2049
  /** The number of cycles for which the charge is applicable. */
@@ -2086,16 +2053,16 @@ export interface Charge {
2086
2053
  /** The billing date from which the charge starts. */
2087
2054
  cycleBillingDate?: Date | null;
2088
2055
  }
2089
- export interface UpdatedCheckoutMessage {
2056
+ interface UpdatedCheckoutMessage {
2090
2057
  /** Previous checkout. */
2091
2058
  oldCheckout?: Checkout;
2092
2059
  /** Updated checkout. */
2093
2060
  updatedCheckout?: Checkout;
2094
2061
  }
2095
- export interface CreateCheckoutRequest {
2062
+ interface CreateCheckoutRequest {
2096
2063
  /** Checkout information. */
2097
2064
  checkoutInfo?: Checkout;
2098
- /** Coupon code. */
2065
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
2099
2066
  couponCode?: string | null;
2100
2067
  /**
2101
2068
  * Catalog line items to add to the checkout.
@@ -2123,14 +2090,12 @@ export interface CreateCheckoutRequest {
2123
2090
  /**
2124
2091
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
2125
2092
  *
2126
- * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
2127
- * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
2128
- * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2093
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2129
2094
  * @maxLength 1000
2130
2095
  */
2131
2096
  overrideCheckoutUrl?: string | null;
2132
2097
  }
2133
- export interface CustomLineItem {
2098
+ interface CustomLineItem {
2134
2099
  /**
2135
2100
  * Custom line item quantity.
2136
2101
  *
@@ -2141,9 +2106,7 @@ export interface CustomLineItem {
2141
2106
  */
2142
2107
  quantity?: number;
2143
2108
  /**
2144
- * Custom line item price.
2145
- *
2146
- * Must be a number or a decimal without symbols.
2109
+ * Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend.
2147
2110
  * @format DECIMAL_VALUE
2148
2111
  * @decimalValue options { gte:0, lte:1000000000000000 }
2149
2112
  */
@@ -2151,19 +2114,23 @@ export interface CustomLineItem {
2151
2114
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
2152
2115
  priceDescription?: PriceDescription;
2153
2116
  /**
2154
- * Custom line item description lines. Used for display purposes for the cart, checkout and order.
2117
+ * Custom line item description lines. Used for displaying the cart, checkout and order.
2155
2118
  * @maxSize 10
2156
2119
  */
2157
2120
  descriptionLines?: DescriptionLine[];
2158
- /** Custom line item's media. */
2159
- media?: Image;
2121
+ /**
2122
+ * Custom line item media.
2123
+ * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
2124
+ * + An image from the web - `"http(s)://<image url>"`.
2125
+ */
2126
+ media?: string;
2160
2127
  /**
2161
2128
  * Custom line item ID. If passed, `id` must be unique.
2162
2129
  *
2163
2130
  * Default: auto-generated ID
2164
2131
  * @format GUID
2165
2132
  */
2166
- id?: string | null;
2133
+ _id?: string | null;
2167
2134
  /**
2168
2135
  * Tax group ID for this custom line item.
2169
2136
  * @format GUID
@@ -2172,7 +2139,7 @@ export interface CustomLineItem {
2172
2139
  /** Name of the item or product. */
2173
2140
  productName?: ProductName;
2174
2141
  /** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
2175
- url?: PageUrlV2;
2142
+ url?: string;
2176
2143
  /** Item type. Either a preset type or custom. */
2177
2144
  itemType?: ItemType;
2178
2145
  /**
@@ -2242,104 +2209,98 @@ export interface CustomLineItem {
2242
2209
  */
2243
2210
  savePaymentMethod?: boolean;
2244
2211
  }
2245
- export interface MerchantDiscountInput {
2212
+ interface MerchantDiscountInput {
2246
2213
  /**
2247
2214
  * Discount amount.
2248
2215
  * @decimalValue options { gte:0 }
2249
2216
  */
2250
2217
  amount?: string;
2251
2218
  /**
2252
- * IDs of line items the discount applies to.
2219
+ * IDs of the line items the discount applies to.
2253
2220
  * @format GUID
2254
2221
  * @maxSize 300
2255
2222
  */
2256
2223
  lineItemIds?: string[];
2257
2224
  }
2258
- export interface CreateCheckoutResponse {
2225
+ interface CreateCheckoutResponse {
2259
2226
  /** Newly created checkout. */
2260
2227
  checkout?: Checkout;
2261
2228
  }
2262
- export interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2229
+ interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2263
2230
  generalShippingCalculationError?: Details;
2264
2231
  carrierErrors?: CarrierErrors;
2265
2232
  }
2266
2233
  /** @oneof */
2267
- export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2234
+ interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2268
2235
  generalShippingCalculationError?: Details;
2269
2236
  carrierErrors?: CarrierErrors;
2270
2237
  }
2271
- export interface GetCheckoutRequest {
2238
+ interface GetCheckoutRequest {
2272
2239
  /**
2273
2240
  * Checkout ID.
2274
2241
  * @format GUID
2275
2242
  */
2276
- id: string;
2243
+ _id: string;
2277
2244
  }
2278
- export interface GetCheckoutResponse {
2245
+ interface GetCheckoutResponse {
2279
2246
  /** Retrieved checkout. */
2280
2247
  checkout?: Checkout;
2281
2248
  }
2282
- export interface GetCheckoutWithAllExtendedFieldsRequest {
2249
+ interface GetCheckoutWithAllExtendedFieldsRequest {
2283
2250
  /**
2284
2251
  * Checkout ID.
2285
2252
  * @format GUID
2286
2253
  */
2287
- id?: string;
2254
+ _id?: string;
2288
2255
  }
2289
- export interface GetCheckoutWithAllExtendedFieldsResponse {
2256
+ interface GetCheckoutWithAllExtendedFieldsResponse {
2290
2257
  /** Retrieved checkout. */
2291
2258
  checkout?: Checkout;
2292
2259
  }
2293
- export interface GetCheckoutByCartIdRequest {
2260
+ interface GetCheckoutByCartIdRequest {
2294
2261
  /**
2295
2262
  * Cart ID.
2296
2263
  * @format GUID
2297
2264
  */
2298
- id: string;
2265
+ _id: string;
2299
2266
  }
2300
- export interface GetCheckoutByCartIdResponse {
2267
+ interface GetCheckoutByCartIdResponse {
2301
2268
  /** Retrieved checkout. */
2302
2269
  checkout?: Checkout;
2303
2270
  }
2304
- export interface GetWixCheckoutURLRequest {
2271
+ interface GetWixCheckoutURLRequest {
2305
2272
  /**
2306
2273
  * Checkout ID.
2307
2274
  * @format GUID
2308
2275
  */
2309
- id: string;
2276
+ _id: string;
2310
2277
  }
2311
- export interface GetWixCheckoutURLResponse {
2278
+ interface GetWixCheckoutURLResponse {
2312
2279
  /** Checkout URL. */
2313
2280
  checkoutUrl?: string;
2314
2281
  }
2315
- export interface GetCheckoutURLRequest {
2282
+ interface GetCheckoutURLRequest {
2316
2283
  /**
2317
2284
  * Checkout ID.
2318
2285
  * @format GUID
2319
2286
  */
2320
- id: string;
2287
+ _id: string;
2321
2288
  }
2322
- export interface GetCheckoutURLResponse {
2289
+ interface GetCheckoutURLResponse {
2323
2290
  /** Checkout URL. */
2324
2291
  checkoutUrl?: string;
2325
2292
  }
2326
- export interface UpdateCheckoutRequest {
2293
+ interface UpdateCheckoutRequest {
2327
2294
  /** Checkout information. */
2328
2295
  checkout: Checkout;
2329
- /**
2330
- * Coupon code.
2331
- *
2332
- * The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
2333
- */
2296
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
2334
2297
  couponCode?: string | null;
2335
2298
  /** Gift card code. */
2336
2299
  giftCardCode?: string | null;
2337
2300
  /**
2338
2301
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
2339
2302
  *
2340
- * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
2341
- * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
2342
- * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2303
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2343
2304
  * @maxLength 1000
2344
2305
  */
2345
2306
  overrideCheckoutUrl?: string | null;
@@ -2357,49 +2318,49 @@ export interface UpdateCheckoutRequest {
2357
2318
  */
2358
2319
  customLineItems?: CustomLineItem[];
2359
2320
  }
2360
- export interface UpdateCheckoutResponse {
2321
+ interface UpdateCheckoutResponse {
2361
2322
  /** Updated checkout. */
2362
2323
  checkout?: Checkout;
2363
2324
  }
2364
- export interface RemoveCouponRequest {
2325
+ interface RemoveCouponRequest {
2365
2326
  /**
2366
2327
  * ID of the checkout to remove the coupon from.
2367
2328
  * @format GUID
2368
2329
  */
2369
- id: string;
2330
+ _id: string;
2370
2331
  }
2371
- export interface RemoveCouponResponse {
2332
+ interface RemoveCouponResponse {
2372
2333
  /** Updated checkout after removal of coupon. */
2373
2334
  checkout?: Checkout;
2374
2335
  }
2375
- export interface RemoveGiftCardRequest {
2336
+ interface RemoveGiftCardRequest {
2376
2337
  /**
2377
2338
  * ID of the checkout to remove the gift card from.
2378
2339
  * @format GUID
2379
2340
  */
2380
- id: string;
2341
+ _id: string;
2381
2342
  }
2382
- export interface RemoveGiftCardResponse {
2343
+ interface RemoveGiftCardResponse {
2383
2344
  /** Updated checkout after removal of gift card. */
2384
2345
  checkout?: Checkout;
2385
2346
  }
2386
- export interface RemoveOverrideCheckoutUrlRequest {
2347
+ interface RemoveOverrideCheckoutUrlRequest {
2387
2348
  /**
2388
2349
  * ID of the checkout to remove the override checkout url from.
2389
2350
  * @format GUID
2390
2351
  */
2391
- id: string;
2352
+ _id: string;
2392
2353
  }
2393
- export interface RemoveOverrideCheckoutUrlResponse {
2354
+ interface RemoveOverrideCheckoutUrlResponse {
2394
2355
  /** Updated checkout after removal of override checkout url. */
2395
2356
  checkout?: Checkout;
2396
2357
  }
2397
- export interface AddToCheckoutRequest {
2358
+ interface AddToCheckoutRequest {
2398
2359
  /**
2399
2360
  * Checkout ID.
2400
2361
  * @format GUID
2401
2362
  */
2402
- id: string;
2363
+ _id: string;
2403
2364
  /**
2404
2365
  * Catalog line items.
2405
2366
  * @maxSize 100
@@ -2414,46 +2375,42 @@ export interface AddToCheckoutRequest {
2414
2375
  */
2415
2376
  customLineItems?: CustomLineItem[];
2416
2377
  }
2417
- export interface AddToCheckoutResponse {
2378
+ interface AddToCheckoutResponse {
2418
2379
  /** Updated checkout. */
2419
2380
  checkout?: Checkout;
2420
2381
  }
2421
- export interface RemoveLineItemsRequest {
2382
+ interface RemoveLineItemsRequest {
2422
2383
  /**
2423
2384
  * ID of the checkout to remove line items from.
2424
2385
  * @format GUID
2425
2386
  */
2426
- id: string;
2387
+ _id: string;
2427
2388
  /**
2428
2389
  * IDs of the line items to remove from the checkout.
2429
- *
2430
- * To find the IDs of the checkout line items you'd like to remove,
2431
- * pass the checkout ID to Get Checkout and look for the IDs under
2432
- * `lineItems`.
2433
2390
  * @format GUID
2434
2391
  * @minSize 1
2435
2392
  * @maxSize 300
2436
2393
  */
2437
2394
  lineItemIds: string[];
2438
2395
  }
2439
- export interface RemoveLineItemsResponse {
2396
+ interface RemoveLineItemsResponse {
2440
2397
  /** Updated checkout after removal of line items. */
2441
2398
  checkout?: Checkout;
2442
2399
  }
2443
- export interface CreateOrderRequest {
2400
+ interface CreateOrderRequest {
2444
2401
  /**
2445
2402
  * Checkout ID.
2446
2403
  * @format GUID
2447
2404
  */
2448
- id: string;
2405
+ _id: string;
2449
2406
  /** Whether the payment method should be saved on the order. */
2450
2407
  savePaymentMethod?: boolean;
2451
2408
  /** Whether to authorize the payment and delay the capture. */
2452
2409
  delayCapture?: boolean;
2453
2410
  }
2454
- export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2411
+ interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2455
2412
  /**
2456
- * ID of newly created order.
2413
+ * ID of the newly created order.
2457
2414
  * @format GUID
2458
2415
  */
2459
2416
  orderId?: string;
@@ -2466,16 +2423,15 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2466
2423
  * Payment gateway order ID.
2467
2424
  *
2468
2425
  * For online orders, pass this value as the `paymentId` parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function so your customer can pay for the order.
2469
- * `paymentGatewayOrderId` will be returned if money needs to be charged.
2470
2426
  *
2471
- * In some cases, money cannot be charged:
2472
- * + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is `0`. For example, in the case of a free item or an item with a 100% discount.
2473
- * + If the total price is not `0`, but the payment is covered by alternative payment methods, such as a gift card.
2427
+ * This field will be returned if money needs to be charged. In some cases, money cannot be charged:
2428
+ * + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is 0. For example, in the case of a free item or an item with a 100% discount.
2429
+ * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
2474
2430
  */
2475
2431
  paymentGatewayOrderId?: string | null;
2476
2432
  }
2477
2433
  /** @oneof */
2478
- export interface CreateOrderResponseIdOneOf {
2434
+ interface CreateOrderResponseIdOneOf {
2479
2435
  /**
2480
2436
  * ID of newly created order.
2481
2437
  * @format GUID
@@ -2487,37 +2443,37 @@ export interface CreateOrderResponseIdOneOf {
2487
2443
  */
2488
2444
  subscriptionId?: string;
2489
2445
  }
2490
- export interface PaymentErrorResponseData {
2446
+ interface PaymentErrorResponseData {
2491
2447
  paymentResponseToken?: string | null;
2492
2448
  transactionStatus?: string;
2493
2449
  failureDetails?: string | null;
2494
2450
  }
2495
- export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2451
+ interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2496
2452
  /** @format GUID */
2497
2453
  orderId?: string;
2498
2454
  /** @format GUID */
2499
2455
  subscriptionId?: string;
2500
2456
  }
2501
2457
  /** @oneof */
2502
- export interface DoublePaymentErrorDataIdOneOf {
2458
+ interface DoublePaymentErrorDataIdOneOf {
2503
2459
  /** @format GUID */
2504
2460
  orderId?: string;
2505
2461
  /** @format GUID */
2506
2462
  subscriptionId?: string;
2507
2463
  }
2508
- export interface RedeemErrorData {
2464
+ interface RedeemErrorData {
2509
2465
  reason?: string;
2510
2466
  }
2511
- export interface ViolationsList {
2467
+ interface ViolationsList {
2512
2468
  /** Violations risen by ValidationsSPI implementers. */
2513
2469
  violations?: Violation[];
2514
2470
  }
2515
- export interface CreateOrderAndChargeRequest {
2471
+ interface CreateOrderAndChargeRequest {
2516
2472
  /**
2517
2473
  * Checkout ID.
2518
2474
  * @format GUID
2519
2475
  */
2520
- id: string;
2476
+ _id: string;
2521
2477
  /** Payment token. */
2522
2478
  paymentToken?: string | null;
2523
2479
  /** Whether the payment method should be saved on the order. */
@@ -2525,7 +2481,7 @@ export interface CreateOrderAndChargeRequest {
2525
2481
  /** Whether to authorize the payment and delay the capture. */
2526
2482
  delayCapture?: boolean;
2527
2483
  }
2528
- export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
2484
+ interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
2529
2485
  /**
2530
2486
  * ID of newly created order.
2531
2487
  * @format GUID
@@ -2539,16 +2495,17 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
2539
2495
  /** Payment response token. */
2540
2496
  paymentResponseToken?: string | null;
2541
2497
  /**
2542
- * The payment gateway is cashier.
2543
- * payment_gateway_order_id will be returned given that money was charged.
2544
- * In some cases, money will not be charged:
2545
- * If the total price is 0 - For example, could be a free item or a an item with 100% discount
2546
- * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
2498
+ * For online orders, send this value as a parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay/startpayment) function to enable your buyer to pay for the order.
2499
+ * `paymentGatewayOrderId` will be returned if money needs to be charged.
2500
+ *
2501
+ * In some cases, money should not be charged:
2502
+ * + If the total price is 0. For example, in the case of a free item or an item with 100% discount.
2503
+ * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
2547
2504
  */
2548
2505
  paymentGatewayOrderId?: string | null;
2549
2506
  }
2550
2507
  /** @oneof */
2551
- export interface CreateOrderAndChargeResponseIdOneOf {
2508
+ interface CreateOrderAndChargeResponseIdOneOf {
2552
2509
  /**
2553
2510
  * ID of newly created order.
2554
2511
  * @format GUID
@@ -2560,41 +2517,41 @@ export interface CreateOrderAndChargeResponseIdOneOf {
2560
2517
  */
2561
2518
  subscriptionId?: string;
2562
2519
  }
2563
- export interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
2520
+ interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
2564
2521
  /**
2565
2522
  * Server-signed JWT token with required information to complete checkout
2566
2523
  * @maxLength 4096
2567
2524
  */
2568
2525
  token: string;
2569
2526
  }
2570
- export interface RawHttpResponse {
2527
+ interface RawHttpResponse {
2571
2528
  body?: Uint8Array;
2572
2529
  statusCode?: number | null;
2573
2530
  headers?: HeadersEntry[];
2574
2531
  }
2575
- export interface HeadersEntry {
2532
+ interface HeadersEntry {
2576
2533
  key?: string;
2577
2534
  value?: string;
2578
2535
  }
2579
- export interface MarkCheckoutAsCompletedRequest {
2536
+ interface MarkCheckoutAsCompletedRequest {
2580
2537
  /**
2581
2538
  * Checkout ID.
2582
2539
  * @format GUID
2583
2540
  */
2584
- id: string;
2541
+ _id: string;
2585
2542
  }
2586
- export interface MarkCheckoutAsCompletedResponse {
2543
+ interface MarkCheckoutAsCompletedResponse {
2587
2544
  }
2588
2545
  /** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
2589
- export interface CheckoutMarkedAsCompleted {
2546
+ interface CheckoutMarkedAsCompleted {
2590
2547
  checkout?: Checkout;
2591
2548
  }
2592
- export interface UpdateLineItemsQuantityRequest {
2549
+ interface UpdateLineItemsQuantityRequest {
2593
2550
  /**
2594
2551
  * Checkout ID.
2595
2552
  * @format GUID
2596
2553
  */
2597
- id: string;
2554
+ _id: string;
2598
2555
  /**
2599
2556
  * Line item info to update.
2600
2557
  * @minSize 1
@@ -2602,12 +2559,12 @@ export interface UpdateLineItemsQuantityRequest {
2602
2559
  */
2603
2560
  lineItems: LineItemQuantityUpdate[];
2604
2561
  }
2605
- export interface LineItemQuantityUpdate {
2562
+ interface LineItemQuantityUpdate {
2606
2563
  /**
2607
2564
  * ID of the line item to update.
2608
2565
  * @format GUID
2609
2566
  */
2610
- id?: string;
2567
+ _id?: string;
2611
2568
  /**
2612
2569
  * New total amount of the line item,
2613
2570
  * not the amount to add to the current `quantity`.
@@ -2620,42 +2577,42 @@ export interface LineItemQuantityUpdate {
2620
2577
  */
2621
2578
  quantity?: number;
2622
2579
  }
2623
- export interface UpdateLineItemsQuantityResponse {
2580
+ interface UpdateLineItemsQuantityResponse {
2624
2581
  /** Updated checkout. */
2625
2582
  checkout?: Checkout;
2626
2583
  }
2627
- export interface GetCheckoutPaymentSettingsRequest {
2584
+ interface GetCheckoutPaymentSettingsRequest {
2628
2585
  /**
2629
2586
  * Checkout ID.
2630
2587
  * @format GUID
2631
2588
  */
2632
- id: string;
2589
+ _id: string;
2633
2590
  }
2634
- export interface GetCheckoutPaymentSettingsResponse {
2591
+ interface GetCheckoutPaymentSettingsResponse {
2635
2592
  blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOption[];
2636
2593
  }
2637
- export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2594
+ declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2638
2595
  UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
2639
2596
  MANUAL = "MANUAL"
2640
2597
  }
2641
- export interface DeleteCheckoutRequest {
2598
+ interface DeleteCheckoutRequest {
2642
2599
  /**
2643
2600
  * ID of the checkout to delete.
2644
2601
  * @format GUID
2645
2602
  */
2646
- id?: string;
2603
+ _id?: string;
2647
2604
  }
2648
- export interface DeleteCheckoutResponse {
2605
+ interface DeleteCheckoutResponse {
2649
2606
  }
2650
- export interface SubscriptionCreated {
2607
+ interface SubscriptionCreated {
2651
2608
  subscription?: Subscription;
2652
2609
  }
2653
- export interface Subscription {
2610
+ interface Subscription {
2654
2611
  /**
2655
2612
  * Subscription id (auto-generated upon subscription creation)
2656
2613
  * @readonly
2657
2614
  */
2658
- id?: string;
2615
+ _id?: string;
2659
2616
  /**
2660
2617
  * id of subscription in external system
2661
2618
  * @format GUID
@@ -2714,23 +2671,23 @@ export interface Subscription {
2714
2671
  billingInfo?: BillingInfo;
2715
2672
  }
2716
2673
  /** Buyer Info */
2717
- export interface V1BuyerInfo {
2674
+ interface V1BuyerInfo {
2718
2675
  /**
2719
2676
  * Wix customer ID
2720
2677
  * @format GUID
2721
2678
  */
2722
- id?: string;
2679
+ _id?: string;
2723
2680
  /** Customer type */
2724
2681
  identityType?: IdentityType;
2725
2682
  }
2726
- export declare enum IdentityType {
2683
+ declare enum IdentityType {
2727
2684
  UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
2728
2685
  /** Site member */
2729
2686
  MEMBER = "MEMBER",
2730
2687
  /** Contact */
2731
2688
  CONTACT = "CONTACT"
2732
2689
  }
2733
- export interface V1LineItem {
2690
+ interface V1LineItem {
2734
2691
  /** Line item ID (auto-generated) */
2735
2692
  index?: number;
2736
2693
  /**
@@ -2759,7 +2716,7 @@ export interface V1LineItem {
2759
2716
  /** Product details */
2760
2717
  productDetails?: ProductDetails;
2761
2718
  }
2762
- export interface OptionSelection {
2719
+ interface OptionSelection {
2763
2720
  /**
2764
2721
  * Option name
2765
2722
  * @maxLength 200
@@ -2771,7 +2728,7 @@ export interface OptionSelection {
2771
2728
  */
2772
2729
  selection?: string;
2773
2730
  }
2774
- export interface CustomTextFieldSelection {
2731
+ interface CustomTextFieldSelection {
2775
2732
  /**
2776
2733
  * Custom text field name
2777
2734
  * @maxLength 100
@@ -2783,7 +2740,7 @@ export interface CustomTextFieldSelection {
2783
2740
  */
2784
2741
  value?: string;
2785
2742
  }
2786
- export interface ChargeDetails {
2743
+ interface ChargeDetails {
2787
2744
  /**
2788
2745
  * price of line item (depends on subscription option)
2789
2746
  * @max 999999999.99
@@ -2812,7 +2769,7 @@ export interface ChargeDetails {
2812
2769
  */
2813
2770
  taxRate?: string | null;
2814
2771
  }
2815
- export interface ProductDetails {
2772
+ interface ProductDetails {
2816
2773
  /**
2817
2774
  * Line item product ID (optional for POS orders)
2818
2775
  * @minLength 1
@@ -2865,7 +2822,7 @@ export interface ProductDetails {
2865
2822
  */
2866
2823
  appId?: string | null;
2867
2824
  }
2868
- export declare enum LineItemType {
2825
+ declare enum LineItemType {
2869
2826
  /** Line item type can't be classified, due to an error */
2870
2827
  UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
2871
2828
  /** Physical item type */
@@ -2875,7 +2832,7 @@ export declare enum LineItemType {
2875
2832
  /** Custom item price */
2876
2833
  CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
2877
2834
  }
2878
- export interface MediaItem {
2835
+ interface MediaItem {
2879
2836
  /**
2880
2837
  * Media type
2881
2838
  * @readonly
@@ -2900,7 +2857,7 @@ export interface MediaItem {
2900
2857
  */
2901
2858
  height?: number;
2902
2859
  /** Media ID (for media items previously saved in Wix Media) */
2903
- id?: string | null;
2860
+ _id?: string | null;
2904
2861
  /** Media external URL */
2905
2862
  externalImageUrl?: string | null;
2906
2863
  /**
@@ -2909,13 +2866,13 @@ export interface MediaItem {
2909
2866
  */
2910
2867
  altText?: string | null;
2911
2868
  }
2912
- export declare enum MediaItemType {
2869
+ declare enum MediaItemType {
2913
2870
  /** Media item type can't be classified, due to an error */
2914
2871
  UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
2915
2872
  /** Image item type */
2916
2873
  IMAGE = "IMAGE"
2917
2874
  }
2918
- export interface Totals {
2875
+ interface Totals {
2919
2876
  /**
2920
2877
  * Subtotal of all line items, before tax
2921
2878
  * @max 999999999.99
@@ -2952,7 +2909,7 @@ export interface Totals {
2952
2909
  */
2953
2910
  quantity?: number;
2954
2911
  }
2955
- export interface StoreSettings {
2912
+ interface StoreSettings {
2956
2913
  /**
2957
2914
  * Currency used for pricing in this store
2958
2915
  * @maxLength 3
@@ -2970,7 +2927,7 @@ export interface StoreSettings {
2970
2927
  */
2971
2928
  buyerLanguage?: string | null;
2972
2929
  }
2973
- export interface Address extends AddressAddressLine1OptionsOneOf {
2930
+ interface Address extends AddressAddressLine1OptionsOneOf {
2974
2931
  /**
2975
2932
  * Address line 1 (free text)
2976
2933
  * @maxLength 1000
@@ -3024,7 +2981,7 @@ export interface Address extends AddressAddressLine1OptionsOneOf {
3024
2981
  vatId?: VatId;
3025
2982
  }
3026
2983
  /** @oneof */
3027
- export interface AddressAddressLine1OptionsOneOf {
2984
+ interface AddressAddressLine1OptionsOneOf {
3028
2985
  /**
3029
2986
  * Address line 1 (free text)
3030
2987
  * @maxLength 1000
@@ -3033,7 +2990,7 @@ export interface AddressAddressLine1OptionsOneOf {
3033
2990
  /** Address line 1 (street) */
3034
2991
  street?: Street;
3035
2992
  }
3036
- export interface FullName {
2993
+ interface FullName {
3037
2994
  /**
3038
2995
  * Customer's first name
3039
2996
  * @maxLength 1000
@@ -3045,7 +3002,7 @@ export interface FullName {
3045
3002
  */
3046
3003
  lastName?: string;
3047
3004
  }
3048
- export interface Street {
3005
+ interface Street {
3049
3006
  /**
3050
3007
  * Street number
3051
3008
  * @maxLength 500
@@ -3057,7 +3014,7 @@ export interface Street {
3057
3014
  */
3058
3015
  name?: string;
3059
3016
  }
3060
- export interface VatId {
3017
+ interface VatId {
3061
3018
  /**
3062
3019
  * Customer's tax ID.
3063
3020
  * @maxLength 50
@@ -3071,7 +3028,7 @@ export interface VatId {
3071
3028
  type?: VatType;
3072
3029
  }
3073
3030
  /** Brazilian tax info types */
3074
- export declare enum VatType {
3031
+ declare enum VatType {
3075
3032
  /** When the tax info type can't be classified, due to an error */
3076
3033
  UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
3077
3034
  /** CPF - for individual tax payers */
@@ -3079,7 +3036,7 @@ export declare enum VatType {
3079
3036
  /** CNPJ - for corporations */
3080
3037
  CNPJ = "CNPJ"
3081
3038
  }
3082
- export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
3039
+ interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
3083
3040
  /** Shipment details (when this object describes shipment) */
3084
3041
  shipmentDetails?: ShipmentDetails;
3085
3042
  /** Pickup details (when this object describes pickup) */
@@ -3096,13 +3053,13 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
3096
3053
  estimatedDeliveryTime?: string | null;
3097
3054
  }
3098
3055
  /** @oneof */
3099
- export interface V1ShippingInfoDetailsOneOf {
3056
+ interface V1ShippingInfoDetailsOneOf {
3100
3057
  /** Shipment details (when this object describes shipment) */
3101
3058
  shipmentDetails?: ShipmentDetails;
3102
3059
  /** Pickup details (when this object describes pickup) */
3103
3060
  pickupDetails?: V1PickupDetails;
3104
3061
  }
3105
- export interface ShipmentDetails {
3062
+ interface ShipmentDetails {
3106
3063
  /** Shipping destination address */
3107
3064
  address?: Address;
3108
3065
  /**
@@ -3123,7 +3080,7 @@ export interface ShipmentDetails {
3123
3080
  */
3124
3081
  taxRate?: string | null;
3125
3082
  }
3126
- export interface V1PickupDetails {
3083
+ interface V1PickupDetails {
3127
3084
  /** Pickup address */
3128
3085
  address?: PickupAddress;
3129
3086
  /**
@@ -3132,7 +3089,7 @@ export interface V1PickupDetails {
3132
3089
  */
3133
3090
  pickupInstructions?: string | null;
3134
3091
  }
3135
- export interface PickupAddress {
3092
+ interface PickupAddress {
3136
3093
  /**
3137
3094
  * Country code (2 letters)
3138
3095
  * @format COUNTRY
@@ -3159,7 +3116,7 @@ export interface PickupAddress {
3159
3116
  */
3160
3117
  zipCode?: string;
3161
3118
  }
3162
- export interface AppliedCoupon {
3119
+ interface AppliedCoupon {
3163
3120
  /** Coupon ID */
3164
3121
  couponId?: string;
3165
3122
  /**
@@ -3174,7 +3131,7 @@ export interface AppliedCoupon {
3174
3131
  code?: string;
3175
3132
  }
3176
3133
  /** Custom field */
3177
- export interface V1CustomField {
3134
+ interface V1CustomField {
3178
3135
  /**
3179
3136
  * Free text that the customer entered in the custom field during the checkout process
3180
3137
  * @maxLength 250
@@ -3191,9 +3148,9 @@ export interface V1CustomField {
3191
3148
  */
3192
3149
  translatedTitle?: string;
3193
3150
  }
3194
- export interface V1SubscriptionOptionInfo {
3151
+ interface V1SubscriptionOptionInfo {
3195
3152
  /** @format GUID */
3196
- id?: string | null;
3153
+ _id?: string | null;
3197
3154
  /**
3198
3155
  * @minLength 1
3199
3156
  * @maxLength 20
@@ -3203,29 +3160,29 @@ export interface V1SubscriptionOptionInfo {
3203
3160
  description?: string | null;
3204
3161
  discount?: Discount;
3205
3162
  }
3206
- export interface Discount {
3163
+ interface Discount {
3207
3164
  /** Discount type. */
3208
3165
  type?: DiscountDiscountType;
3209
3166
  /** Discount value. */
3210
3167
  value?: number;
3211
3168
  }
3212
- export declare enum DiscountDiscountType {
3169
+ declare enum DiscountDiscountType {
3213
3170
  UNDEFINED = "UNDEFINED",
3214
3171
  /** No discount */
3215
3172
  AMOUNT = "AMOUNT",
3216
3173
  PERCENT = "PERCENT"
3217
3174
  }
3218
- export interface ChannelInfo {
3175
+ interface ChannelInfo {
3219
3176
  /** Sales channel that submitted the subscription */
3220
3177
  type?: ChannelInfoChannelType;
3221
3178
  }
3222
- export declare enum ChannelInfoChannelType {
3179
+ declare enum ChannelInfoChannelType {
3223
3180
  UNSPECIFIED = "UNSPECIFIED",
3224
3181
  WEB = "WEB",
3225
3182
  OTHER_PLATFORM = "OTHER_PLATFORM",
3226
3183
  WIX_APP_STORE = "WIX_APP_STORE"
3227
3184
  }
3228
- export interface V1SubscriptionSettings {
3185
+ interface V1SubscriptionSettings {
3229
3186
  /** Frequency of recurring payment. */
3230
3187
  frequency?: SubscriptionFrequency;
3231
3188
  /** Whether subscription is renewed automatically at the end of each period. */
@@ -3237,7 +3194,7 @@ export interface V1SubscriptionSettings {
3237
3194
  */
3238
3195
  billingCycles?: number | null;
3239
3196
  }
3240
- export interface BillingInfo {
3197
+ interface BillingInfo {
3241
3198
  /**
3242
3199
  * Payment method used for this order
3243
3200
  * @maxLength 50
@@ -3254,9 +3211,9 @@ export interface BillingInfo {
3254
3211
  */
3255
3212
  paymentGatewayOrderId?: string | null;
3256
3213
  }
3257
- export interface Empty {
3214
+ interface Empty {
3258
3215
  }
3259
- export interface DomainEvent extends DomainEventBodyOneOf {
3216
+ interface DomainEvent extends DomainEventBodyOneOf {
3260
3217
  createdEvent?: EntityCreatedEvent;
3261
3218
  updatedEvent?: EntityUpdatedEvent;
3262
3219
  deletedEvent?: EntityDeletedEvent;
@@ -3265,7 +3222,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
3265
3222
  * Unique event ID.
3266
3223
  * Allows clients to ignore duplicate webhooks.
3267
3224
  */
3268
- id?: string;
3225
+ _id?: string;
3269
3226
  /**
3270
3227
  * Assumes actions are also always typed to an entity_type
3271
3228
  * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
@@ -3299,36 +3256,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
3299
3256
  entityEventSequence?: string | null;
3300
3257
  }
3301
3258
  /** @oneof */
3302
- export interface DomainEventBodyOneOf {
3259
+ interface DomainEventBodyOneOf {
3303
3260
  createdEvent?: EntityCreatedEvent;
3304
3261
  updatedEvent?: EntityUpdatedEvent;
3305
3262
  deletedEvent?: EntityDeletedEvent;
3306
3263
  actionEvent?: ActionEvent;
3307
3264
  }
3308
- export interface EntityCreatedEvent {
3309
- entityAsJson?: string;
3310
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
3311
- restoreInfo?: RestoreInfo;
3265
+ interface EntityCreatedEvent {
3266
+ entity?: string;
3312
3267
  }
3313
- export interface RestoreInfo {
3268
+ interface RestoreInfo {
3314
3269
  deletedDate?: Date | null;
3315
3270
  }
3316
- export interface EntityUpdatedEvent {
3271
+ interface EntityUpdatedEvent {
3317
3272
  /**
3318
3273
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3319
3274
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3320
3275
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3321
3276
  */
3322
- currentEntityAsJson?: string;
3277
+ currentEntity?: string;
3323
3278
  }
3324
- export interface EntityDeletedEvent {
3279
+ interface EntityDeletedEvent {
3325
3280
  /** Entity that was deleted */
3326
- deletedEntityAsJson?: string | null;
3281
+ deletedEntity?: string | null;
3327
3282
  }
3328
- export interface ActionEvent {
3329
- bodyAsJson?: string;
3283
+ interface ActionEvent {
3284
+ body?: string;
3330
3285
  }
3331
- export interface MessageEnvelope {
3286
+ interface MessageEnvelope {
3332
3287
  /**
3333
3288
  * App instance ID.
3334
3289
  * @format GUID
@@ -3344,7 +3299,7 @@ export interface MessageEnvelope {
3344
3299
  /** Stringify payload. */
3345
3300
  data?: string;
3346
3301
  }
3347
- export interface IdentificationData extends IdentificationDataIdOneOf {
3302
+ interface IdentificationData extends IdentificationDataIdOneOf {
3348
3303
  /**
3349
3304
  * ID of a site visitor that has not logged in to the site.
3350
3305
  * @format GUID
@@ -3369,7 +3324,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
3369
3324
  identityType?: WebhookIdentityType;
3370
3325
  }
3371
3326
  /** @oneof */
3372
- export interface IdentificationDataIdOneOf {
3327
+ interface IdentificationDataIdOneOf {
3373
3328
  /**
3374
3329
  * ID of a site visitor that has not logged in to the site.
3375
3330
  * @format GUID
@@ -3391,10 +3346,349 @@ export interface IdentificationDataIdOneOf {
3391
3346
  */
3392
3347
  appId?: string;
3393
3348
  }
3394
- export declare enum WebhookIdentityType {
3349
+ declare enum WebhookIdentityType {
3395
3350
  UNKNOWN = "UNKNOWN",
3396
3351
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3397
3352
  MEMBER = "MEMBER",
3398
3353
  WIX_USER = "WIX_USER",
3399
3354
  APP = "APP"
3400
3355
  }
3356
+ interface BaseEventMetadata {
3357
+ /**
3358
+ * App instance ID.
3359
+ * @format GUID
3360
+ */
3361
+ instanceId?: string | null;
3362
+ /**
3363
+ * Event type.
3364
+ * @maxLength 150
3365
+ */
3366
+ eventType?: string;
3367
+ /** The identification type and identity data. */
3368
+ identity?: IdentificationData;
3369
+ }
3370
+ interface EventMetadata extends BaseEventMetadata {
3371
+ /**
3372
+ * Unique event ID.
3373
+ * Allows clients to ignore duplicate webhooks.
3374
+ */
3375
+ _id?: string;
3376
+ /**
3377
+ * Assumes actions are also always typed to an entity_type
3378
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3379
+ */
3380
+ entityFqdn?: string;
3381
+ /**
3382
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3383
+ * This is although the created/updated/deleted notion is duplication of the oneof types
3384
+ * Example: created/updated/deleted/started/completed/email_opened
3385
+ */
3386
+ slug?: string;
3387
+ /** ID of the entity associated with the event. */
3388
+ entityId?: string;
3389
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3390
+ eventTime?: Date | null;
3391
+ /**
3392
+ * Whether the event was triggered as a result of a privacy regulation application
3393
+ * (for example, GDPR).
3394
+ */
3395
+ triggeredByAnonymizeRequest?: boolean | null;
3396
+ /** If present, indicates the action that triggered the event. */
3397
+ originatedFrom?: string | null;
3398
+ /**
3399
+ * A sequence number defining the order of updates to the underlying entity.
3400
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
3401
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3402
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3403
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
3404
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3405
+ */
3406
+ entityEventSequence?: string | null;
3407
+ }
3408
+ interface CheckoutCompletedEnvelope {
3409
+ data: CheckoutMarkedAsCompleted;
3410
+ metadata: EventMetadata;
3411
+ }
3412
+ interface CheckoutCreatedEnvelope {
3413
+ entity: Checkout;
3414
+ metadata: EventMetadata;
3415
+ }
3416
+ interface CheckoutUpdatedEnvelope {
3417
+ entity: Checkout;
3418
+ metadata: EventMetadata;
3419
+ }
3420
+ interface CreateCheckoutOptions {
3421
+ /** Checkout information. */
3422
+ checkoutInfo?: Checkout;
3423
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
3424
+ couponCode?: string | null;
3425
+ /**
3426
+ * Catalog line items to add to the checkout.
3427
+ * @maxSize 300
3428
+ */
3429
+ lineItems?: LineItem[];
3430
+ /**
3431
+ * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
3432
+ *
3433
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3434
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3435
+ * @maxSize 300
3436
+ */
3437
+ customLineItems?: CustomLineItem[];
3438
+ /** Sales channel that submitted the order. */
3439
+ channelType: ChannelType;
3440
+ /**
3441
+ * Gift card code.
3442
+ *
3443
+ * The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
3444
+ *
3445
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
3446
+ */
3447
+ giftCardCode?: string | null;
3448
+ /**
3449
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3450
+ *
3451
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
3452
+ * @maxLength 1000
3453
+ */
3454
+ overrideCheckoutUrl?: string | null;
3455
+ }
3456
+ interface UpdateCheckout {
3457
+ /**
3458
+ * Checkout ID.
3459
+ * @format GUID
3460
+ * @readonly
3461
+ */
3462
+ _id?: string | null;
3463
+ /**
3464
+ * Line items.
3465
+ *
3466
+ * Max: 300 items
3467
+ * @minSize 1
3468
+ * @maxSize 300
3469
+ * @readonly
3470
+ */
3471
+ lineItems?: LineItem[];
3472
+ /** Billing information. */
3473
+ billingInfo?: AddressWithContact;
3474
+ /** Shipping information. */
3475
+ shippingInfo?: ShippingInfo;
3476
+ /**
3477
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
3478
+ * @maxLength 1000
3479
+ */
3480
+ buyerNote?: string | null;
3481
+ /** Buyer information. */
3482
+ buyerInfo?: BuyerInfo;
3483
+ /**
3484
+ * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3485
+ * @readonly
3486
+ * @format CURRENCY
3487
+ */
3488
+ conversionCurrency?: string;
3489
+ /**
3490
+ * Calculated price summary for the checkout.
3491
+ * @readonly
3492
+ */
3493
+ priceSummary?: PriceSummary;
3494
+ /**
3495
+ * Errors when calculating totals.
3496
+ * @readonly
3497
+ */
3498
+ calculationErrors?: CalculationErrors;
3499
+ /**
3500
+ * Applied gift card details.
3501
+ *
3502
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
3503
+ * @readonly
3504
+ */
3505
+ giftCard?: GiftCard;
3506
+ /**
3507
+ * Applied discounts.
3508
+ * @readonly
3509
+ */
3510
+ appliedDiscounts?: AppliedDiscount[];
3511
+ /** Custom fields. */
3512
+ customFields?: CustomField[];
3513
+ /**
3514
+ * Weight measurement unit. Defaults to a site's weight unit.
3515
+ * @readonly
3516
+ */
3517
+ weightUnit?: WeightUnit;
3518
+ /**
3519
+ * Tax summary.
3520
+ * @readonly
3521
+ */
3522
+ taxSummary?: TaxSummary;
3523
+ /**
3524
+ * The currency used when submitting the order.
3525
+ * @format CURRENCY
3526
+ * @readonly
3527
+ */
3528
+ currency?: string;
3529
+ /**
3530
+ * Sales channel that submitted the order.
3531
+ * @readonly
3532
+ */
3533
+ channelType?: ChannelType;
3534
+ /**
3535
+ * Site language in which original values are shown.
3536
+ * @readonly
3537
+ */
3538
+ siteLanguage?: string;
3539
+ /**
3540
+ * Language for communication with the buyer. Defaults to the site language.
3541
+ * For a site that supports multiple languages, this is the language the buyer selected.
3542
+ * @readonly
3543
+ */
3544
+ buyerLanguage?: string;
3545
+ /**
3546
+ * Whether an order was successfully created from this checkout.
3547
+ * For an order to be successful, it must be successfully paid for (unless the total is 0).
3548
+ * @readonly
3549
+ */
3550
+ completed?: boolean;
3551
+ /**
3552
+ * Whether tax is included in line item prices.
3553
+ * @readonly
3554
+ */
3555
+ taxIncludedInPrice?: boolean;
3556
+ /**
3557
+ * ID of the checkout's initiator.
3558
+ * @readonly
3559
+ */
3560
+ createdBy?: CreatedBy;
3561
+ /**
3562
+ * Date and time the checkout was created.
3563
+ * @readonly
3564
+ */
3565
+ _createdDate?: Date | null;
3566
+ /**
3567
+ * Date and time the checkout was updated.
3568
+ * @readonly
3569
+ */
3570
+ _updatedDate?: Date | null;
3571
+ /**
3572
+ * Minimal amount to pay in order to place the order.
3573
+ * @readonly
3574
+ */
3575
+ payNow?: PriceSummary;
3576
+ /**
3577
+ * Remaining amount for the order to be fully paid.
3578
+ * @readonly
3579
+ */
3580
+ payLater?: PriceSummary;
3581
+ /** Memberships to apply when creating the order. */
3582
+ membershipOptions?: MembershipOptions;
3583
+ /**
3584
+ * Additional Fees.
3585
+ * @maxSize 100
3586
+ */
3587
+ additionalFees?: AdditionalFee[];
3588
+ /**
3589
+ * Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
3590
+ * @format GUID
3591
+ */
3592
+ cartId?: string | null;
3593
+ /**
3594
+ * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
3595
+ * @readonly
3596
+ */
3597
+ violations?: Violation[];
3598
+ /**
3599
+ * Custom field data for the checkout object.
3600
+ *
3601
+ * [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.
3602
+ */
3603
+ extendedFields?: ExtendedFields;
3604
+ /**
3605
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
3606
+ * @format GUID
3607
+ * @readonly
3608
+ */
3609
+ purchaseFlowId?: string | null;
3610
+ /**
3611
+ * Additional settings for customization of the checkout process.
3612
+ *
3613
+ * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
3614
+ * @immutable
3615
+ */
3616
+ customSettings?: CustomSettings;
3617
+ /**
3618
+ * Reference IDs for the app and component providing custom checkout page content.
3619
+ *
3620
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3621
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3622
+ */
3623
+ customContentReference?: CustomContentReference;
3624
+ /**
3625
+ * References to an external app and resource associated with this checkout.
3626
+ * Used for integration and tracking across different platforms.
3627
+ * @immutable
3628
+ */
3629
+ externalReference?: ExternalReference;
3630
+ /**
3631
+ * The business location ID associated with the checkout.
3632
+ *
3633
+ * To learn more, see the Locations API.
3634
+ * @format GUID
3635
+ */
3636
+ businessLocationId?: string | null;
3637
+ }
3638
+ interface UpdateCheckoutOptions {
3639
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
3640
+ couponCode?: string | null;
3641
+ /** Gift card code. */
3642
+ giftCardCode?: string | null;
3643
+ /**
3644
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3645
+ *
3646
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
3647
+ * @maxLength 1000
3648
+ */
3649
+ overrideCheckoutUrl?: string | null;
3650
+ /**
3651
+ * Catalog line items.
3652
+ * @maxSize 300
3653
+ */
3654
+ lineItems?: LineItem[];
3655
+ /**
3656
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
3657
+ *
3658
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3659
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3660
+ * @maxSize 300
3661
+ */
3662
+ customLineItems?: CustomLineItem[];
3663
+ }
3664
+ interface AddToCheckoutOptions {
3665
+ /**
3666
+ * Catalog line items.
3667
+ * @maxSize 100
3668
+ */
3669
+ lineItems?: LineItem[];
3670
+ /**
3671
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
3672
+ *
3673
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3674
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3675
+ * @maxSize 100
3676
+ */
3677
+ customLineItems?: CustomLineItem[];
3678
+ }
3679
+ interface CreateOrderOptions {
3680
+ /** Whether the payment method should be saved on the order. */
3681
+ savePaymentMethod?: boolean;
3682
+ /** Whether to authorize the payment and delay the capture. */
3683
+ delayCapture?: boolean;
3684
+ }
3685
+ interface CreateOrderAndChargeOptions {
3686
+ /** Payment token. */
3687
+ paymentToken?: string | null;
3688
+ /** Whether the payment method should be saved on the order. */
3689
+ savePaymentMethod?: boolean;
3690
+ /** Whether to authorize the payment and delay the capture. */
3691
+ delayCapture?: boolean;
3692
+ }
3693
+
3694
+ export { type TaxBreakdown as $, type AddToCheckoutOptions as A, MediaItemType as B, type CreateCheckoutOptions as C, DescriptionLineType as D, DiscountDiscountType as E, FileType as F, type GetCheckoutByCartIdResponse as G, ChannelInfoChannelType as H, ItemAvailabilityStatus as I, JurisdictionType as J, WebhookIdentityType as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, type LineItem as O, PaymentOptionType as P, type CatalogReference as Q, type RemoveCouponResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCheckout as U, VatType as V, WeightUnit as W, type ProductName as X, type MultiCurrencyPrice as Y, type ItemTaxFullDetails as Z, type TaxRateBreakdown as _, type Checkout as a, type CarrierErrors as a$, type DescriptionLine as a0, type DescriptionLineValueOneOf as a1, type DescriptionLineDescriptionLineValueOneOf as a2, type DescriptionLineName as a3, type PlainTextValue as a4, type Color as a5, type FocalPoint as a6, type ItemAvailabilityInfo as a7, type PhysicalProperties as a8, type Scope as a9, type ShippingInfo as aA, type SelectedCarrierServiceOption as aB, type DeliveryLogistics as aC, type PickupDetails as aD, type DeliveryTimeSlot as aE, type SelectedCarrierServiceOptionPrices as aF, type SelectedCarrierServiceOptionOtherCharge as aG, type DeliveryAllocation as aH, type Carrier as aI, type Region as aJ, type ApplicableLineItems as aK, type ShippingRegion as aL, type CarrierServiceOption as aM, type ShippingOption as aN, type ShippingPrice as aO, type OtherCharge as aP, type BuyerInfo as aQ, type BuyerInfoIdOneOf as aR, type PriceSummary as aS, type CalculationErrors as aT, type CalculationErrorsShippingCalculationErrorOneOf as aU, type Details as aV, type DetailsKindOneOf as aW, type ApplicationError as aX, type ValidationError as aY, type FieldViolation as aZ, type SystemError as a_, type Group as aa, type ItemType as ab, type ItemTypeItemTypeDataOneOf as ac, type SubscriptionOptionInfo as ad, type SubscriptionSettings as ae, type FreeTrialPeriod as af, type Title as ag, type Description as ah, type SecuredMedia as ai, type ServiceProperties as aj, type PriceDescription as ak, type CatalogOverrideFields as al, type PaymentOption as am, type TaxableAddress as an, type TaxableAddressTaxableAddressDataOneOf as ao, type ExtendedFields as ap, type Policy as aq, type ModifierGroup as ar, type TranslatableString as as, type ItemModifier as at, type AddressWithContact as au, type ApiAddress as av, type StreetAddress as aw, type AddressLocation as ax, type FullAddressContactDetails as ay, type CommonVatId as az, type GetCheckoutURLResponse as b, type RedeemErrorData as b$, type CarrierError as b0, type GiftCard as b1, type AppliedDiscount as b2, type AppliedDiscountDiscountSourceOneOf as b3, type Coupon as b4, type MerchantDiscount as b5, type DiscountRule as b6, type DiscountRuleName as b7, type LineItemDiscount as b8, type CustomField as b9, type UpdatedCheckoutMessage as bA, type CreateCheckoutRequest as bB, type CustomLineItem as bC, type MerchantDiscountInput as bD, type CreateCheckoutResponse as bE, type ShippingCalculationErrorData as bF, type ShippingCalculationErrorDataShippingCalculationErrorOneOf as bG, type GetCheckoutRequest as bH, type GetCheckoutResponse as bI, type GetCheckoutWithAllExtendedFieldsRequest as bJ, type GetCheckoutWithAllExtendedFieldsResponse as bK, type GetCheckoutByCartIdRequest as bL, type GetWixCheckoutURLRequest as bM, type GetWixCheckoutURLResponse as bN, type GetCheckoutURLRequest as bO, type UpdateCheckoutRequest as bP, type UpdateCheckoutResponse as bQ, type RemoveCouponRequest as bR, type RemoveGiftCardRequest as bS, type RemoveOverrideCheckoutUrlRequest as bT, type AddToCheckoutRequest as bU, type RemoveLineItemsRequest as bV, type CreateOrderRequest as bW, type CreateOrderResponseIdOneOf as bX, type PaymentErrorResponseData as bY, type DoublePaymentErrorData as bZ, type DoublePaymentErrorDataIdOneOf as b_, type TaxSummary as ba, type TaxCalculationDetails as bb, type TaxCalculationDetailsCalculationDetailsOneOf as bc, type AutoTaxFallbackCalculationDetails as bd, type AggregatedTaxBreakdown as be, type CreatedBy as bf, type CreatedByIdOneOf as bg, type MembershipOptions as bh, type Membership as bi, type MembershipName as bj, type MembershipPaymentCredits as bk, type InvalidMembership as bl, type SelectedMemberships as bm, type SelectedMembership as bn, type AdditionalFee as bo, type ConversionInfo as bp, type Violation as bq, type Target as br, type TargetTargetTypeOneOf as bs, type Other as bt, type TargetLineItem as bu, type CustomSettings as bv, type CustomContentReference as bw, type ExternalReference as bx, type SubscriptionCharges as by, type Charge as bz, type UpdateCheckoutOptions as c, type ViolationsList as c0, type CreateOrderAndChargeRequest as c1, type CreateOrderAndChargeResponse as c2, type CreateOrderAndChargeResponseIdOneOf as c3, type MarkCheckoutAsCompletedAndRedirectToUrlRequest as c4, type RawHttpResponse as c5, type HeadersEntry as c6, type MarkCheckoutAsCompletedRequest as c7, type MarkCheckoutAsCompletedResponse as c8, type CheckoutMarkedAsCompleted as c9, type AppliedCoupon as cA, type V1CustomField as cB, type V1SubscriptionOptionInfo as cC, type Discount as cD, type ChannelInfo as cE, type V1SubscriptionSettings as cF, type BillingInfo as cG, type Empty as cH, type DomainEvent as cI, type DomainEventBodyOneOf as cJ, type EntityCreatedEvent as cK, type RestoreInfo as cL, type EntityUpdatedEvent as cM, type EntityDeletedEvent as cN, type ActionEvent as cO, type MessageEnvelope as cP, type IdentificationData as cQ, type IdentificationDataIdOneOf as cR, type BaseEventMetadata as cS, type EventMetadata as cT, type CheckoutCompletedEnvelope as cU, type CheckoutCreatedEnvelope as cV, type CheckoutUpdatedEnvelope as cW, type CreateOrderAndChargeOptions as cX, type UpdateLineItemsQuantityRequest as ca, type GetCheckoutPaymentSettingsRequest as cb, type GetCheckoutPaymentSettingsResponse as cc, type DeleteCheckoutRequest as cd, type DeleteCheckoutResponse as ce, type SubscriptionCreated as cf, type Subscription as cg, type V1BuyerInfo as ch, type V1LineItem as ci, type OptionSelection as cj, type CustomTextFieldSelection as ck, type ChargeDetails as cl, type ProductDetails as cm, type MediaItem as cn, type Totals as co, type StoreSettings as cp, type Address as cq, type AddressAddressLine1OptionsOneOf as cr, type FullName as cs, type Street as ct, type VatId as cu, type V1ShippingInfo as cv, type V1ShippingInfoDetailsOneOf as cw, type ShipmentDetails as cx, type V1PickupDetails as cy, type PickupAddress as cz, type RemoveGiftCardResponse as d, type RemoveOverrideCheckoutUrlResponse as e, type AddToCheckoutResponse as f, type RemoveLineItemsResponse as g, type CreateOrderOptions as h, type CreateOrderResponse as i, type UpdateLineItemsQuantityResponse as j, ItemTypeItemType as k, CommonVatType as l, PickupMethod as m, ChargeType as n, RuleType as o, DiscountType as p, RateType as q, FallbackReason as r, ChannelType as s, AdditionalFeeSource as t, Severity as u, NameInLineItem as v, SuggestedFix as w, GetCheckoutPaymentSettingsResponsePaymentOption as x, IdentityType as y, LineItemType as z };