@wix/auto_sdk_ecom_checkout 1.0.3 → 1.0.5

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 (69) hide show
  1. package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  2. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +4 -1
  3. package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -1
  4. package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +2 -0
  5. package/build/cjs/src/ecom-v1-checkout-checkout.http.js +40 -1
  6. package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  7. package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +1 -0
  8. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +20 -1
  9. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -1
  10. package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  11. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +14 -2
  12. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  13. package/build/cjs/src/ecom-v1-checkout-checkout.types.d.ts +1018 -228
  14. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  15. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1079 -248
  16. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +51 -5
  17. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  18. package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  19. package/build/es/src/ecom-v1-checkout-checkout.context.js +3 -1
  20. package/build/es/src/ecom-v1-checkout-checkout.context.js.map +1 -1
  21. package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +2 -0
  22. package/build/es/src/ecom-v1-checkout-checkout.http.js +38 -0
  23. package/build/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  24. package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +1 -0
  25. package/build/es/src/ecom-v1-checkout-checkout.meta.js +18 -0
  26. package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -1
  27. package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  28. package/build/es/src/ecom-v1-checkout-checkout.public.js +12 -1
  29. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  30. package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +1018 -228
  31. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  32. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +1079 -248
  33. package/build/es/src/ecom-v1-checkout-checkout.universal.js +49 -4
  34. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  35. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +4 -2
  36. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +4 -1
  37. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -1
  38. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +2 -0
  39. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +40 -1
  40. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  41. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +1 -0
  42. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +20 -1
  43. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -1
  44. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +11 -2
  45. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +14 -2
  46. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  47. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +1028 -228
  48. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  49. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1133 -253
  50. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +51 -5
  51. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  52. package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +4 -2
  53. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +3 -1
  54. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +1 -1
  55. package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +2 -0
  56. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +38 -0
  57. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  58. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +1 -0
  59. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +18 -0
  60. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -1
  61. package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +11 -2
  62. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +12 -1
  63. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  64. package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +1028 -228
  65. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  66. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +1133 -253
  67. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +49 -4
  68. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  69. package/package.json +2 -2
@@ -1,6 +1,7 @@
1
1
  export interface Checkout {
2
2
  /**
3
3
  * Checkout ID.
4
+ * @format GUID
4
5
  * @readonly
5
6
  */
6
7
  _id?: string | null;
@@ -8,6 +9,8 @@ export interface Checkout {
8
9
  * Line items.
9
10
  *
10
11
  * Max: 300 items
12
+ * @minSize 1
13
+ * @maxSize 300
11
14
  * @readonly
12
15
  */
13
16
  lineItems?: LineItem[];
@@ -15,13 +18,17 @@ export interface Checkout {
15
18
  billingInfo?: AddressWithContact;
16
19
  /** Shipping information. */
17
20
  shippingInfo?: ShippingInfo;
18
- /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
21
+ /**
22
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
23
+ * @maxLength 1000
24
+ */
19
25
  buyerNote?: string | null;
20
26
  /** Buyer information. */
21
27
  buyerInfo?: BuyerInfo;
22
28
  /**
23
29
  * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
24
30
  * @readonly
31
+ * @format CURRENCY
25
32
  */
26
33
  conversionCurrency?: string;
27
34
  /**
@@ -60,6 +67,7 @@ export interface Checkout {
60
67
  taxSummary?: TaxSummary;
61
68
  /**
62
69
  * The currency used when submitting the order.
70
+ * @format CURRENCY
63
71
  * @readonly
64
72
  */
65
73
  currency?: string;
@@ -117,9 +125,15 @@ export interface Checkout {
117
125
  payLater?: PriceSummary;
118
126
  /** Memberships to apply when creating the order. */
119
127
  membershipOptions?: MembershipOptions;
120
- /** Additional Fees. */
128
+ /**
129
+ * Additional Fees.
130
+ * @maxSize 100
131
+ */
121
132
  additionalFees?: AdditionalFee[];
122
- /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */
133
+ /**
134
+ * Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
135
+ * @format GUID
136
+ */
123
137
  cartId?: string | null;
124
138
  /**
125
139
  * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
@@ -134,6 +148,7 @@ export interface Checkout {
134
148
  extendedFields?: ExtendedFields;
135
149
  /**
136
150
  * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
151
+ * @format GUID
137
152
  * @readonly
138
153
  */
139
154
  purchaseFlowId?: string | null;
@@ -141,6 +156,7 @@ export interface Checkout {
141
156
  * Additional settings for customization of the checkout process.
142
157
  *
143
158
  * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
159
+ * @immutable
144
160
  */
145
161
  customSettings?: CustomSettings;
146
162
  /**
@@ -153,12 +169,14 @@ export interface Checkout {
153
169
  /**
154
170
  * The business location ID associated with the checkout.
155
171
  * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
172
+ * @format GUID
156
173
  */
157
174
  businessLocationId?: string | null;
158
175
  }
159
176
  export interface LineItem {
160
177
  /**
161
178
  * Line item ID.
179
+ * @format GUID
162
180
  * @readonly
163
181
  */
164
182
  _id?: string | null;
@@ -167,6 +185,8 @@ export interface LineItem {
167
185
  *
168
186
  * Min: `"1"`
169
187
  * Max: `"100000"`
188
+ * @min 1
189
+ * @max 100000
170
190
  */
171
191
  quantity?: number;
172
192
  /** 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. */
@@ -273,6 +293,8 @@ export interface LineItem {
273
293
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
274
294
  * + In most cases, this field has the same value as `catalogReference.catalogItemId`.
275
295
  * + Used in membership validation.
296
+ * @minLength 1
297
+ * @maxLength 36
276
298
  * @readonly
277
299
  */
278
300
  rootCatalogItemId?: string | null;
@@ -286,6 +308,12 @@ export interface LineItem {
286
308
  * @readonly
287
309
  */
288
310
  depositAmount?: MultiCurrencyPrice;
311
+ /**
312
+ * Delivery profile ID.
313
+ * @format GUID
314
+ * @readonly
315
+ */
316
+ deliveryProfileId?: string | null;
289
317
  /**
290
318
  * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
291
319
  * @readonly
@@ -293,6 +321,8 @@ export interface LineItem {
293
321
  customLineItem?: boolean;
294
322
  /**
295
323
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
324
+ * @minLength 1
325
+ * @maxLength 2500
296
326
  * @readonly
297
327
  */
298
328
  consentRequiredPaymentPolicy?: string | null;
@@ -313,7 +343,11 @@ export interface LineItem {
313
343
  }
314
344
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
315
345
  export interface CatalogReference {
316
- /** ID of the item within the catalog it belongs to. */
346
+ /**
347
+ * ID of the item within the catalog it belongs to.
348
+ * @minLength 1
349
+ * @maxLength 36
350
+ */
317
351
  catalogItemId?: string;
318
352
  /**
319
353
  * ID of the app providing the catalog.
@@ -324,6 +358,7 @@ export interface CatalogReference {
324
358
  * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
325
359
  * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
326
360
  * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
361
+ * @minLength 1
327
362
  */
328
363
  appId?: string;
329
364
  /**
@@ -341,6 +376,8 @@ export interface ProductName {
341
376
  *
342
377
  * Min: 1 character.
343
378
  * Max: 200 characters.
379
+ * @minLength 1
380
+ * @maxLength 200
344
381
  */
345
382
  original?: string;
346
383
  /**
@@ -349,15 +386,21 @@ export interface ProductName {
349
386
  * Min: 1 character.
350
387
  * Max: 400 characters.
351
388
  * Default: Same as `original`.
389
+ * @minLength 1
390
+ * @maxLength 400
352
391
  */
353
392
  translated?: string | null;
354
393
  }
355
394
  export interface MultiCurrencyPrice {
356
- /** Amount. */
395
+ /**
396
+ * Amount.
397
+ * @decimalValue options { gte:0, lte:1000000000000000 }
398
+ */
357
399
  amount?: string;
358
400
  /**
359
401
  * Converted amount.
360
402
  * @readonly
403
+ * @decimalValue options { gte:0, lte:1000000000000000 }
361
404
  */
362
405
  convertedAmount?: string;
363
406
  /**
@@ -374,7 +417,10 @@ export interface MultiCurrencyPrice {
374
417
  export interface ItemTaxFullDetails {
375
418
  /** Amount for which tax is calculated. */
376
419
  taxableAmount?: MultiCurrencyPrice;
377
- /** Tax rate %, as a decimal point between 0 and 1. */
420
+ /**
421
+ * Tax rate %, as a decimal point between 0 and 1.
422
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
423
+ */
378
424
  taxRate?: string;
379
425
  /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
380
426
  totalTax?: MultiCurrencyPrice;
@@ -386,9 +432,15 @@ export interface ItemTaxFullDetails {
386
432
  rateBreakdown?: TaxRateBreakdown[];
387
433
  }
388
434
  export interface TaxRateBreakdown {
389
- /** Name of tax against which the calculation was performed. */
435
+ /**
436
+ * Name of tax against which the calculation was performed.
437
+ * @maxLength 100
438
+ */
390
439
  name?: string;
391
- /** Rate at which this tax detail was calculated. */
440
+ /**
441
+ * Rate at which this tax detail was calculated.
442
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
443
+ */
392
444
  rate?: string;
393
445
  /** Amount of tax for this tax detail. */
394
446
  tax?: MultiCurrencyPrice;
@@ -398,21 +450,31 @@ export interface TaxRateBreakdown {
398
450
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
399
451
  */
400
452
  export interface TaxBreakdown {
401
- /** The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec". */
453
+ /**
454
+ * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
455
+ * @maxLength 200
456
+ */
402
457
  jurisdiction?: string | null;
403
458
  /** The amount of this line item price that was considered nontaxable. (Decimal value) */
404
459
  nonTaxableAmount?: MultiCurrencyPrice;
405
- /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */
460
+ /**
461
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
462
+ * @decimalValue options { gte:0, maxScale:6 }
463
+ */
406
464
  rate?: string | null;
407
465
  /** The amount of tax estimated for this line item. (Decimal value) */
408
466
  taxAmount?: MultiCurrencyPrice;
409
467
  /** The taxable amount of this line item. */
410
468
  taxableAmount?: MultiCurrencyPrice;
411
- /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
469
+ /**
470
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
471
+ * @maxLength 200
472
+ */
412
473
  taxType?: string | null;
413
474
  /**
414
475
  * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
415
476
  * This name should be explicit enough to allow the merchant to understand what tax was calculated.
477
+ * @maxLength 200
416
478
  */
417
479
  taxName?: string | null;
418
480
  /** The type of the jurisdiction in which this tax detail applies. */
@@ -446,32 +508,44 @@ export interface DescriptionLineValueOneOf {
446
508
  export interface DescriptionLineDescriptionLineValueOneOf {
447
509
  }
448
510
  export interface DescriptionLineName {
449
- /** 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). */
511
+ /**
512
+ * 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).
513
+ * @maxLength 100
514
+ */
450
515
  original?: string;
451
516
  /**
452
517
  * Description line name translated into the buyer's language.
453
518
  *
454
519
  * Default: Same as `original`.
520
+ * @maxLength 200
455
521
  */
456
522
  translated?: string | null;
457
523
  }
458
524
  export interface PlainTextValue {
459
- /** 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). */
525
+ /**
526
+ * 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).
527
+ * @maxLength 600
528
+ */
460
529
  original?: string;
461
530
  /**
462
531
  * Description line plain text value translated into the buyer's language.
463
532
  *
464
533
  * Default: Same as `original`.
534
+ * @maxLength 600
465
535
  */
466
536
  translated?: string | null;
467
537
  }
468
538
  export interface Color {
469
- /** 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). */
539
+ /**
540
+ * 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).
541
+ * @maxLength 500
542
+ */
470
543
  original?: string;
471
544
  /**
472
545
  * Description line color name translated into the buyer's language.
473
546
  *
474
547
  * Default: Same as `original`.
548
+ * @maxLength 500
475
549
  */
476
550
  translated?: string | null;
477
551
  /** HEX or RGB color code for display. */
@@ -513,7 +587,10 @@ export declare enum ItemAvailabilityStatus {
513
587
  export interface PhysicalProperties {
514
588
  /** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
515
589
  weight?: number | null;
516
- /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
590
+ /**
591
+ * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
592
+ * @maxLength 40
593
+ */
517
594
  sku?: string | null;
518
595
  /** Whether this line item is shippable. */
519
596
  shippable?: boolean;
@@ -566,11 +643,16 @@ export interface SubscriptionSettings {
566
643
  *
567
644
  * Default: `1`.
568
645
  * If SubscriptionFrequency is Day the minimum interval is 7
646
+ * @min 1
647
+ * @max 50
569
648
  */
570
649
  interval?: number | null;
571
650
  /** Whether subscription is renewed automatically at the end of each period. */
572
651
  autoRenewal?: boolean;
573
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */
652
+ /**
653
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
654
+ * @min 1
655
+ */
574
656
  billingCycles?: number | null;
575
657
  }
576
658
  /** Frequency unit of recurring payment */
@@ -584,29 +666,53 @@ export declare enum SubscriptionFrequency {
584
666
  export interface FreeTrialPeriod {
585
667
  /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
586
668
  frequency?: SubscriptionFrequency;
587
- /** interval of period */
669
+ /**
670
+ * interval of period
671
+ * @min 1
672
+ * @max 50
673
+ */
588
674
  interval?: number;
589
675
  }
590
676
  export interface Title {
591
- /** 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). */
677
+ /**
678
+ * 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).
679
+ * @minLength 1
680
+ * @maxLength 150
681
+ */
592
682
  original?: string;
593
683
  /**
594
684
  * Subscription option name translated into the buyer's language.
595
685
  *
596
686
  * Default: Same as `original`.
687
+ * @minLength 1
688
+ * @maxLength 150
597
689
  */
598
690
  translated?: string | null;
599
691
  }
600
692
  export interface Description {
601
- /** Subscription option description. */
693
+ /**
694
+ * Subscription option description.
695
+ * @maxLength 500
696
+ */
602
697
  original?: string;
603
- /** Translated subscription option description. */
698
+ /**
699
+ * Translated subscription option description.
700
+ * @maxLength 500
701
+ */
604
702
  translated?: string | null;
605
703
  }
606
704
  export interface SecuredMedia {
607
- /** Media ID in Wix Media Manager. */
705
+ /**
706
+ * Media ID in Wix Media Manager.
707
+ * @minLength 1
708
+ * @maxLength 100
709
+ */
608
710
  _id?: string;
609
- /** Original filename. */
711
+ /**
712
+ * Original filename.
713
+ * @minLength 1
714
+ * @maxLength 1000
715
+ */
610
716
  fileName?: string;
611
717
  /** File type. */
612
718
  fileType?: FileType;
@@ -638,27 +744,46 @@ export interface ServiceProperties {
638
744
  * For example, the start time of a class.
639
745
  */
640
746
  scheduledDate?: Date | null;
641
- /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
747
+ /**
748
+ * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
749
+ * @min 1
750
+ * @max 10000
751
+ */
642
752
  numberOfParticipants?: number | null;
643
753
  }
644
754
  export interface PriceDescription {
645
- /** __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). */
755
+ /**
756
+ * __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).
757
+ * @minLength 1
758
+ * @maxLength 100
759
+ */
646
760
  original?: string;
647
761
  /**
648
762
  * Price description translated into the buyer's language.
649
763
  *
650
764
  * Default: Same as `original`.
765
+ * @minLength 1
766
+ * @maxLength 100
651
767
  */
652
768
  translated?: string | null;
653
769
  }
654
770
  export interface CatalogOverrideFields {
655
771
  /** Item name. */
656
772
  productName?: ProductName;
657
- /** Item price **after** discounts. */
773
+ /**
774
+ * Item price **after** discounts.
775
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
776
+ */
658
777
  price?: string | null;
659
- /** Item price **before** discounts. */
778
+ /**
779
+ * Item price **before** discounts.
780
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
781
+ */
660
782
  fullPrice?: string | null;
661
- /** Item description lines. Used when displaying the line item to customers. */
783
+ /**
784
+ * Item description lines. Used when displaying the line item to customers.
785
+ * @maxSize 20
786
+ */
662
787
  descriptionLines?: DescriptionLine[];
663
788
  /** Physical properties of the item. */
664
789
  physicalProperties?: PhysicalProperties;
@@ -666,7 +791,11 @@ export interface CatalogOverrideFields {
666
791
  image?: string;
667
792
  /** Payment method selected for the item. */
668
793
  paymentOption?: PaymentOption;
669
- /** Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. */
794
+ /**
795
+ * Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
796
+ * @format DECIMAL_VALUE
797
+ * @decimalValue options { gt:0, lte:999999999, maxScale:3 }
798
+ */
670
799
  depositAmount?: string | null;
671
800
  /**
672
801
  * Whether to save the payment method on the order.
@@ -677,11 +806,9 @@ export interface CatalogOverrideFields {
677
806
  }
678
807
  export interface PaymentOption {
679
808
  /**
680
- * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
681
- * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
682
- * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When selected, `price` is `0`.
683
- * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
684
- * + `MEMBERSHIP_OFFLINE`: 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`.
809
+ * Type of selected payment option for current item.
810
+ *
811
+ * Default: `FULL_PAYMENT_ONLINE`
685
812
  */
686
813
  value?: PaymentOptionType;
687
814
  }
@@ -712,9 +839,17 @@ export interface ExtendedFields {
712
839
  namespaces?: Record<string, Record<string, any>>;
713
840
  }
714
841
  export interface Policy {
715
- /** Policy title - should be translated */
842
+ /**
843
+ * Policy title - should be translated
844
+ * @minLength 1
845
+ * @maxLength 29
846
+ */
716
847
  title?: string | null;
717
- /** Policy content - should be translated */
848
+ /**
849
+ * Policy content - should be translated
850
+ * @minLength 1
851
+ * @maxLength 3000
852
+ */
718
853
  content?: string;
719
854
  }
720
855
  /** Billing Info and shipping details */
@@ -726,19 +861,37 @@ export interface AddressWithContact {
726
861
  }
727
862
  /** Physical address */
728
863
  export interface ApiAddress {
729
- /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
864
+ /**
865
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
866
+ * @format COUNTRY
867
+ */
730
868
  country?: string | null;
731
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
869
+ /**
870
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
871
+ * @maxLength 50
872
+ */
732
873
  subdivision?: string | null;
733
- /** City name. */
874
+ /**
875
+ * City name.
876
+ * @maxLength 50
877
+ */
734
878
  city?: string | null;
735
- /** Postal or zip code. */
879
+ /**
880
+ * Postal or zip code.
881
+ * @maxLength 50
882
+ */
736
883
  postalCode?: string | null;
737
884
  /** Street address. */
738
885
  streetAddress?: StreetAddress;
739
- /** Main address line (usually street name and number). */
886
+ /**
887
+ * Main address line (usually street name and number).
888
+ * @maxLength 150
889
+ */
740
890
  addressLine1?: string | null;
741
- /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
891
+ /**
892
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
893
+ * @maxLength 100
894
+ */
742
895
  addressLine2?: string | null;
743
896
  /**
744
897
  * Country's full name.
@@ -765,13 +918,25 @@ export interface AddressLocation {
765
918
  }
766
919
  /** Full contact details for an address */
767
920
  export interface FullAddressContactDetails {
768
- /** First name. */
921
+ /**
922
+ * First name.
923
+ * @maxLength 100
924
+ */
769
925
  firstName?: string | null;
770
- /** Last name. */
926
+ /**
927
+ * Last name.
928
+ * @maxLength 100
929
+ */
771
930
  lastName?: string | null;
772
- /** Phone number. */
931
+ /**
932
+ * Phone number.
933
+ * @format PHONE
934
+ */
773
935
  phone?: string | null;
774
- /** Company name. */
936
+ /**
937
+ * Company name.
938
+ * @maxLength 1000
939
+ */
775
940
  company?: string | null;
776
941
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
777
942
  vatId?: CommonVatId;
@@ -813,11 +978,15 @@ export interface ShippingInfo {
813
978
  carrierServiceOptions?: CarrierServiceOption[];
814
979
  }
815
980
  export interface SelectedCarrierServiceOption {
816
- /** Unique identifier of selected option. For example, "usps_std_overnight". */
981
+ /**
982
+ * Unique identifier of selected option. For example, "usps_std_overnight".
983
+ * @maxLength 100
984
+ */
817
985
  code?: string;
818
986
  /**
819
987
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
820
988
  * For example, "Standard" or "First-Class Package International".
989
+ * @maxLength 250
821
990
  * @readonly
822
991
  */
823
992
  title?: string;
@@ -838,17 +1007,29 @@ export interface SelectedCarrierServiceOption {
838
1007
  requestedShippingOption?: boolean;
839
1008
  /** Other charges */
840
1009
  otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
841
- /** This carrier's unique ID */
1010
+ /**
1011
+ * This carrier's unique ID
1012
+ * @format GUID
1013
+ */
842
1014
  carrierId?: string | null;
843
- /** Delivery solution allocations to different delivery carriers and delivery regions */
1015
+ /**
1016
+ * Delivery solution allocations to different delivery carriers and delivery regions
1017
+ * @maxSize 300
1018
+ */
844
1019
  deliveryAllocations?: DeliveryAllocation[];
845
1020
  /** If the delivery solution is a partial and doesn't apply to all items. */
846
1021
  partial?: boolean | null;
847
1022
  }
848
1023
  export interface DeliveryLogistics {
849
- /** Expected delivery time, in free text. For example, "3-5 business days". */
1024
+ /**
1025
+ * Expected delivery time, in free text. For example, "3-5 business days".
1026
+ * @maxLength 500
1027
+ */
850
1028
  deliveryTime?: string | null;
851
- /** Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot". */
1029
+ /**
1030
+ * Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
1031
+ * @maxLength 1000
1032
+ */
852
1033
  instructions?: string | null;
853
1034
  /** Pickup details. */
854
1035
  pickupDetails?: PickupDetails;
@@ -890,7 +1071,10 @@ export interface SelectedCarrierServiceOptionPrices {
890
1071
  export interface SelectedCarrierServiceOptionOtherCharge {
891
1072
  /** Type of additional cost. */
892
1073
  type?: ChargeType;
893
- /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */
1074
+ /**
1075
+ * Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
1076
+ * @maxLength 200
1077
+ */
894
1078
  details?: string | null;
895
1079
  /** Price of added charge. */
896
1080
  cost?: SelectedCarrierServiceOptionPrices;
@@ -908,32 +1092,56 @@ export interface DeliveryAllocation {
908
1092
  applicableLineItems?: ApplicableLineItems;
909
1093
  }
910
1094
  export interface Carrier {
911
- /** The carrier app id */
1095
+ /**
1096
+ * The carrier app id
1097
+ * @format GUID
1098
+ */
912
1099
  appId?: string | null;
913
- /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
1100
+ /**
1101
+ * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
1102
+ * @maxLength 250
1103
+ */
914
1104
  code?: string;
915
1105
  }
916
1106
  export interface Region {
917
- /** The delivery region id. */
1107
+ /**
1108
+ * The delivery region id.
1109
+ * @format GUID
1110
+ */
918
1111
  _id?: string | null;
919
- /** The delivery region name. */
1112
+ /**
1113
+ * The delivery region name.
1114
+ * @maxLength 100
1115
+ */
920
1116
  name?: string | null;
921
1117
  }
922
1118
  export interface ApplicableLineItems {
923
- /** Line items that the delivery solution is for. */
1119
+ /**
1120
+ * Line items that the delivery solution is for.
1121
+ * @maxSize 300
1122
+ * @minLength 1
1123
+ * @maxLength 100
1124
+ */
924
1125
  lineItemIds?: string[];
925
1126
  }
926
1127
  export interface ShippingRegion {
927
1128
  /**
928
1129
  * Shipping region ID.
1130
+ * @format GUID
929
1131
  * @readonly
930
1132
  */
931
1133
  _id?: string;
932
- /** Shipping region name. */
1134
+ /**
1135
+ * Shipping region name.
1136
+ * @maxLength 100
1137
+ */
933
1138
  name?: string;
934
1139
  }
935
1140
  export interface CarrierServiceOption {
936
- /** Carrier ID. */
1141
+ /**
1142
+ * Carrier ID.
1143
+ * @format GUID
1144
+ */
937
1145
  carrierId?: string;
938
1146
  /** Shipping options offered by this carrier for this request. */
939
1147
  shippingOptions?: ShippingOption[];
@@ -942,18 +1150,23 @@ export interface ShippingOption {
942
1150
  /**
943
1151
  * Unique code of provided shipping option like "usps_std_overnight".
944
1152
  * For legacy calculators this would be the UUID of the option.
1153
+ * @maxLength 100
945
1154
  */
946
1155
  code?: string;
947
1156
  /**
948
1157
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
949
1158
  * For example, "Standard" or "First-Class Package International".
1159
+ * @maxLength 250
950
1160
  */
951
1161
  title?: string;
952
1162
  /** Delivery logistics. */
953
1163
  logistics?: DeliveryLogistics;
954
1164
  /** Sipping price information. */
955
1165
  cost?: ShippingPrice;
956
- /** Delivery solution allocations to different delivery carriers and delivery regions */
1166
+ /**
1167
+ * Delivery solution allocations to different delivery carriers and delivery regions
1168
+ * @maxSize 300
1169
+ */
957
1170
  deliveryAllocations?: DeliveryAllocation[];
958
1171
  /** If the delivery solution is a partial and doesn't apply to all items. */
959
1172
  partial?: boolean | null;
@@ -973,31 +1186,39 @@ export interface OtherCharge {
973
1186
  export interface BuyerInfo extends BuyerInfoIdOneOf {
974
1187
  /**
975
1188
  * Visitor ID - if the buyer is **not** a site member.
1189
+ * @format GUID
976
1190
  * @readonly
977
1191
  */
978
1192
  visitorId?: string;
979
1193
  /**
980
1194
  * Member ID - If the buyer is a site member.
1195
+ * @format GUID
981
1196
  * @readonly
982
1197
  */
983
1198
  memberId?: string;
984
1199
  /**
985
1200
  * Contact ID. For more information, see the Contacts API.
1201
+ * @format GUID
986
1202
  * @readonly
987
1203
  */
988
1204
  contactId?: string | null;
989
- /** Buyer email address. */
1205
+ /**
1206
+ * Buyer email address.
1207
+ * @format EMAIL
1208
+ */
990
1209
  email?: string | null;
991
1210
  }
992
1211
  /** @oneof */
993
1212
  export interface BuyerInfoIdOneOf {
994
1213
  /**
995
1214
  * Visitor ID - if the buyer is **not** a site member.
1215
+ * @format GUID
996
1216
  * @readonly
997
1217
  */
998
1218
  visitorId?: string;
999
1219
  /**
1000
1220
  * Member ID - If the buyer is a site member.
1221
+ * @format GUID
1001
1222
  * @readonly
1002
1223
  */
1003
1224
  memberId?: string;
@@ -1158,11 +1379,16 @@ export interface GiftCard {
1158
1379
  obfuscatedCode?: string;
1159
1380
  /** Gift card value. */
1160
1381
  amount?: MultiCurrencyPrice;
1161
- /** App ID of the gift card provider. */
1382
+ /**
1383
+ * App ID of the gift card provider.
1384
+ * @format GUID
1385
+ */
1162
1386
  appId?: string;
1163
1387
  /**
1164
1388
  * External ID in the gift card provider's system.
1165
1389
  * Used for integration and tracking across different platforms.
1390
+ * @minLength 1
1391
+ * @maxLength 50
1166
1392
  */
1167
1393
  externalId?: string | null;
1168
1394
  }
@@ -1177,6 +1403,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1177
1403
  discountType?: DiscountType;
1178
1404
  /**
1179
1405
  * IDs of the line items the discount applies to.
1406
+ * @format GUID
1180
1407
  * @deprecated IDs of line items the discount applies to.
1181
1408
  * @replacedBy line_items_discounts
1182
1409
  * @targetRemovalDate 2024-06-01
@@ -1211,11 +1438,18 @@ export interface Coupon {
1211
1438
  export interface MerchantDiscount {
1212
1439
  /** Discount value. */
1213
1440
  amount?: MultiCurrencyPrice;
1214
- /** Discount Percentage. Will be calculated from items price before other discounts. */
1441
+ /**
1442
+ * Discount Percentage. Will be calculated from items price before other discounts.
1443
+ * @min 1
1444
+ * @max 100
1445
+ */
1215
1446
  percentage?: number | null;
1216
1447
  }
1217
1448
  export interface DiscountRule {
1218
- /** Discount rule ID */
1449
+ /**
1450
+ * Discount rule ID
1451
+ * @format GUID
1452
+ */
1219
1453
  _id?: string;
1220
1454
  /** Discount rule name */
1221
1455
  name?: DiscountRuleName;
@@ -1223,13 +1457,24 @@ export interface DiscountRule {
1223
1457
  amount?: MultiCurrencyPrice;
1224
1458
  }
1225
1459
  export interface DiscountRuleName {
1226
- /** Original discount rule name (in site's default language). */
1460
+ /**
1461
+ * Original discount rule name (in site's default language).
1462
+ * @minLength 1
1463
+ * @maxLength 256
1464
+ */
1227
1465
  original?: string;
1228
- /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
1466
+ /**
1467
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1468
+ * @minLength 1
1469
+ * @maxLength 500
1470
+ */
1229
1471
  translated?: string | null;
1230
1472
  }
1231
1473
  export interface LineItemDiscount {
1232
- /** ID of line item the discount applies to. */
1474
+ /**
1475
+ * ID of line item the discount applies to.
1476
+ * @format GUID
1477
+ */
1233
1478
  _id?: string;
1234
1479
  /** Discount value. */
1235
1480
  totalDiscountAmount?: MultiCurrencyPrice;
@@ -1237,9 +1482,17 @@ export interface LineItemDiscount {
1237
1482
  export interface CustomField {
1238
1483
  /** Custom field value. */
1239
1484
  value?: any;
1240
- /** Custom field title. */
1485
+ /**
1486
+ * Custom field title.
1487
+ * @minLength 1
1488
+ * @maxLength 500
1489
+ */
1241
1490
  title?: string;
1242
- /** Translated custom field title. */
1491
+ /**
1492
+ * Translated custom field title.
1493
+ * @minLength 1
1494
+ * @maxLength 500
1495
+ */
1243
1496
  translatedTitle?: string | null;
1244
1497
  }
1245
1498
  export declare enum WeightUnit {
@@ -1315,15 +1568,27 @@ export declare enum FallbackReason {
1315
1568
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1316
1569
  */
1317
1570
  export interface AggregatedTaxBreakdown {
1318
- /** The name of the tax against which this tax amount was calculated. */
1571
+ /**
1572
+ * The name of the tax against which this tax amount was calculated.
1573
+ * @maxLength 200
1574
+ */
1319
1575
  taxName?: string;
1320
- /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
1576
+ /**
1577
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
1578
+ * @maxLength 200
1579
+ */
1321
1580
  taxType?: string;
1322
- /** The name of the jurisdiction in which this tax detail applies. */
1581
+ /**
1582
+ * The name of the jurisdiction in which this tax detail applies.
1583
+ * @maxLength 200
1584
+ */
1323
1585
  jurisdiction?: string;
1324
1586
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1325
1587
  jurisdictionTypeEnum?: JurisdictionType;
1326
- /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */
1588
+ /**
1589
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
1590
+ * @decimalValue options { gte:0, maxScale:6 }
1591
+ */
1327
1592
  rate?: string;
1328
1593
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1329
1594
  aggregatedTaxAmount?: MultiCurrencyPrice;
@@ -1366,13 +1631,23 @@ export interface CreatedBy extends CreatedByIdOneOf {
1366
1631
  /**
1367
1632
  * User ID - when the order was created by a Wix user on behalf of a buyer.
1368
1633
  * For example, via POS (point of service).
1634
+ * @format GUID
1369
1635
  */
1370
1636
  userId?: string;
1371
- /** Member ID - when the order was created by a **logged in** site visitor. */
1637
+ /**
1638
+ * Member ID - when the order was created by a **logged in** site visitor.
1639
+ * @format GUID
1640
+ */
1372
1641
  memberId?: string;
1373
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
1642
+ /**
1643
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
1644
+ * @format GUID
1645
+ */
1374
1646
  visitorId?: string;
1375
- /** App ID - when the order was created by an external application or Wix service. */
1647
+ /**
1648
+ * App ID - when the order was created by an external application or Wix service.
1649
+ * @format GUID
1650
+ */
1376
1651
  appId?: string;
1377
1652
  }
1378
1653
  /** @oneof */
@@ -1380,13 +1655,23 @@ export interface CreatedByIdOneOf {
1380
1655
  /**
1381
1656
  * User ID - when the order was created by a Wix user on behalf of a buyer.
1382
1657
  * For example, via POS (point of service).
1658
+ * @format GUID
1383
1659
  */
1384
1660
  userId?: string;
1385
- /** Member ID - when the order was created by a **logged in** site visitor. */
1661
+ /**
1662
+ * Member ID - when the order was created by a **logged in** site visitor.
1663
+ * @format GUID
1664
+ */
1386
1665
  memberId?: string;
1387
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
1666
+ /**
1667
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
1668
+ * @format GUID
1669
+ */
1388
1670
  visitorId?: string;
1389
- /** App ID - when the order was created by an external application or Wix service. */
1671
+ /**
1672
+ * App ID - when the order was created by an external application or Wix service.
1673
+ * @format GUID
1674
+ */
1390
1675
  appId?: string;
1391
1676
  }
1392
1677
  /** Reserved for internal use. */
@@ -1394,24 +1679,39 @@ export interface MembershipOptions {
1394
1679
  /**
1395
1680
  * Reserved for internal use.
1396
1681
  * @readonly
1682
+ * @maxSize 300
1397
1683
  */
1398
1684
  eligibleMemberships?: Membership[];
1399
1685
  /**
1400
1686
  * Reserved for internal use.
1401
1687
  * @readonly
1688
+ * @maxSize 300
1402
1689
  */
1403
1690
  invalidMemberships?: InvalidMembership[];
1404
1691
  /** Selected membership to apply to this checkout. */
1405
1692
  selectedMemberships?: SelectedMemberships;
1406
1693
  }
1407
1694
  export interface Membership {
1408
- /** Membership ID. */
1695
+ /**
1696
+ * Membership ID.
1697
+ * @minLength 1
1698
+ * @maxLength 100
1699
+ */
1409
1700
  _id?: string;
1410
- /** ID of the application providing this payment option. */
1701
+ /**
1702
+ * ID of the application providing this payment option.
1703
+ * @format GUID
1704
+ */
1411
1705
  appId?: string;
1412
1706
  /** The name of this membership. */
1413
1707
  name?: MembershipName;
1414
- /** Line item IDs which are "paid for" by this membership. */
1708
+ /**
1709
+ * Line item IDs which are "paid for" by this membership.
1710
+ * @minSize 1
1711
+ * @maxSize 300
1712
+ * @minLength 1
1713
+ * @maxLength 100
1714
+ */
1415
1715
  lineItemIds?: string[];
1416
1716
  /** Optional - For a membership that has limited credits, information about credit usage. */
1417
1717
  credits?: MembershipPaymentCredits;
@@ -1421,13 +1721,22 @@ export interface Membership {
1421
1721
  additionalData?: Record<string, any> | null;
1422
1722
  }
1423
1723
  export interface MembershipName {
1424
- /** Membership name. */
1724
+ /**
1725
+ * Membership name.
1726
+ * @maxLength 100
1727
+ */
1425
1728
  original?: string;
1426
- /** Translated membership name. Defaults to `original` when not provided. */
1729
+ /**
1730
+ * Translated membership name. Defaults to `original` when not provided.
1731
+ * @maxLength 100
1732
+ */
1427
1733
  translated?: string | null;
1428
1734
  }
1429
1735
  export interface MembershipPaymentCredits {
1430
- /** Membership's total amount of credits. */
1736
+ /**
1737
+ * Membership's total amount of credits.
1738
+ * @min 1
1739
+ */
1431
1740
  total?: number;
1432
1741
  /** Membership's remaining amount of credits. */
1433
1742
  remaining?: number;
@@ -1435,31 +1744,63 @@ export interface MembershipPaymentCredits {
1435
1744
  export interface InvalidMembership {
1436
1745
  /** Membership details. */
1437
1746
  membership?: Membership;
1438
- /** Reason why this membership is invalid and cannot be used. */
1747
+ /**
1748
+ * Reason why this membership is invalid and cannot be used.
1749
+ * @minLength 1
1750
+ * @maxLength 100
1751
+ */
1439
1752
  reason?: string;
1440
1753
  }
1441
1754
  export interface SelectedMemberships {
1442
- /** Selected memberships. */
1755
+ /**
1756
+ * Selected memberships.
1757
+ * @maxSize 300
1758
+ */
1443
1759
  memberships?: SelectedMembership[];
1444
1760
  }
1445
1761
  export interface SelectedMembership {
1446
- /** Membership ID. */
1762
+ /**
1763
+ * Membership ID.
1764
+ * @minLength 1
1765
+ * @maxLength 100
1766
+ */
1447
1767
  _id?: string;
1448
- /** ID of the app providing this payment option. */
1768
+ /**
1769
+ * ID of the app providing this payment option.
1770
+ * @format GUID
1771
+ */
1449
1772
  appId?: string;
1450
- /** IDs of the line items this membership applies to. */
1773
+ /**
1774
+ * IDs of the line items this membership applies to.
1775
+ * @minSize 1
1776
+ * @maxSize 300
1777
+ * @minLength 1
1778
+ * @maxLength 100
1779
+ */
1451
1780
  lineItemIds?: string[];
1452
1781
  }
1453
1782
  export interface AdditionalFee {
1454
- /** Additional fee's unique code (or ID) for future processing. */
1783
+ /**
1784
+ * Additional fee's unique code (or ID) for future processing.
1785
+ * @minLength 1
1786
+ * @maxLength 100
1787
+ */
1455
1788
  code?: string | null;
1456
- /** Translated additional fee's name. */
1789
+ /**
1790
+ * Translated additional fee's name.
1791
+ * @minLength 1
1792
+ * @maxLength 50
1793
+ */
1457
1794
  name?: string;
1458
1795
  /** Additional fee's price. */
1459
1796
  price?: MultiCurrencyPrice;
1460
1797
  /** Tax details. */
1461
1798
  taxDetails?: ItemTaxFullDetails;
1462
- /** Provider's app id. */
1799
+ /**
1800
+ * Provider's app id.
1801
+ * @minLength 1
1802
+ * @maxLength 100
1803
+ */
1463
1804
  providerAppId?: string | null;
1464
1805
  /** Additional fee's price before tax. */
1465
1806
  priceBeforeTax?: MultiCurrencyPrice;
@@ -1468,6 +1809,7 @@ export interface AdditionalFee {
1468
1809
  /**
1469
1810
  * Optional - Line items associated with this additional fee.
1470
1811
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1812
+ * @format GUID
1471
1813
  */
1472
1814
  lineItemIds?: string[];
1473
1815
  /** the source the additional fee was added from */
@@ -1486,11 +1828,13 @@ export interface ConversionInfo {
1486
1828
  /**
1487
1829
  * The site currency.
1488
1830
  * @readonly
1831
+ * @format CURRENCY
1489
1832
  */
1490
1833
  siteCurrency?: string;
1491
1834
  /**
1492
1835
  * The rate used when converting from the site currency to the checkout currency.
1493
1836
  * @readonly
1837
+ * @decimalValue options { gt:0, lte:1000000000000000 }
1494
1838
  */
1495
1839
  conversionRate?: string;
1496
1840
  }
@@ -1499,7 +1843,11 @@ export interface Violation {
1499
1843
  severity?: Severity;
1500
1844
  /** Target location on a checkout or cart page where the violation will be displayed. */
1501
1845
  target?: Target;
1502
- /** Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`. */
1846
+ /**
1847
+ * Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`.
1848
+ * @minLength 1
1849
+ * @maxLength 1000
1850
+ */
1503
1851
  description?: string | null;
1504
1852
  }
1505
1853
  export declare enum Severity {
@@ -1583,12 +1931,14 @@ export interface CustomContentReference {
1583
1931
  * ID of the app providing the content.
1584
1932
  *
1585
1933
  * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1934
+ * @format GUID
1586
1935
  */
1587
1936
  appId?: string;
1588
1937
  /**
1589
1938
  * ID of the component within the app it belongs to.
1590
1939
  *
1591
1940
  * You can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1941
+ * @format GUID
1592
1942
  */
1593
1943
  componentId?: string;
1594
1944
  }
@@ -1596,14 +1946,49 @@ export interface ExternalReference {
1596
1946
  /**
1597
1947
  * ID of the app associated with the purchase flow.
1598
1948
  * For example, the Wix Pay Links app ID.
1949
+ * @format GUID
1950
+ * @immutable
1599
1951
  */
1600
1952
  appId?: string;
1601
1953
  /**
1602
1954
  * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
1603
1955
  * For example, a Wix Pay Link ID.
1956
+ * @minLength 1
1957
+ * @maxLength 100
1958
+ * @immutable
1604
1959
  */
1605
1960
  resourceId?: string | null;
1606
1961
  }
1962
+ export interface SubscriptionCharges {
1963
+ /**
1964
+ * ids of the items the subscription is defined on
1965
+ * @format GUID
1966
+ * @minSize 1
1967
+ * @maxSize 300
1968
+ */
1969
+ lineItemIds?: string[];
1970
+ /**
1971
+ * Generated description explaining future charges amount and schedule.
1972
+ * Translated to subscription order buyer language, or to site language if was not provided.
1973
+ * @maxLength 1000
1974
+ */
1975
+ description?: string | null;
1976
+ /**
1977
+ * Charges for subscription.
1978
+ * @maxSize 50
1979
+ */
1980
+ charges?: Charge[];
1981
+ }
1982
+ export interface Charge {
1983
+ /** The cycle number from which the charge starts. */
1984
+ cycleFrom?: number;
1985
+ /** The number of cycles for which the charge is applicable. */
1986
+ cycleCount?: number | null;
1987
+ /** Charge summary. */
1988
+ priceSummary?: PriceSummary;
1989
+ /** The billing date from which the charge starts. */
1990
+ cycleBillingDate?: Date | null;
1991
+ }
1607
1992
  export interface UpdatedCheckoutMessage {
1608
1993
  /** Previous checkout. */
1609
1994
  oldCheckout?: Checkout;
@@ -1615,28 +2000,20 @@ export interface CreateCheckoutRequest {
1615
2000
  checkoutInfo?: Checkout;
1616
2001
  /** 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). */
1617
2002
  couponCode?: string | null;
1618
- /** Catalog line items to add to the checkout. */
2003
+ /**
2004
+ * Catalog line items to add to the checkout.
2005
+ * @maxSize 300
2006
+ */
1619
2007
  lineItems?: LineItem[];
1620
2008
  /**
1621
2009
  * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
1622
2010
  *
1623
2011
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1624
2012
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2013
+ * @maxSize 300
1625
2014
  */
1626
2015
  customLineItems?: CustomLineItem[];
1627
- /**
1628
- * Sales channel that submitted the order.
1629
- * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
1630
- * + `"WEB"`: A web client.
1631
- * + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
1632
- * + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
1633
- * + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
1634
- * + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
1635
- * + `"WIX_INVOICES"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
1636
- * + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
1637
- * + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
1638
- * + `"OTHER_PLATFORM"`: Other sales platform.
1639
- */
2016
+ /** Sales channel that submitted the order. */
1640
2017
  channelType: ChannelType;
1641
2018
  /**
1642
2019
  * Gift card code.
@@ -1650,6 +2027,7 @@ export interface CreateCheckoutRequest {
1650
2027
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
1651
2028
  *
1652
2029
  * 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`.
2030
+ * @maxLength 1000
1653
2031
  */
1654
2032
  overrideCheckoutUrl?: string | null;
1655
2033
  }
@@ -1659,13 +2037,22 @@ export interface CustomLineItem {
1659
2037
  *
1660
2038
  * Min: `1`
1661
2039
  * Max: `100000`
2040
+ * @min 1
2041
+ * @max 100000
1662
2042
  */
1663
2043
  quantity?: number;
1664
- /** Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend. */
2044
+ /**
2045
+ * Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend.
2046
+ * @format DECIMAL_VALUE
2047
+ * @decimalValue options { gte:0, lte:1000000000000000 }
2048
+ */
1665
2049
  price?: string;
1666
2050
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1667
2051
  priceDescription?: PriceDescription;
1668
- /** Custom line item description lines. Used for displaying the cart, checkout and order. */
2052
+ /**
2053
+ * Custom line item description lines. Used for displaying the cart, checkout and order.
2054
+ * @maxSize 10
2055
+ */
1669
2056
  descriptionLines?: DescriptionLine[];
1670
2057
  /**
1671
2058
  * Custom line item media.
@@ -1677,9 +2064,13 @@ export interface CustomLineItem {
1677
2064
  * Custom line item ID. If passed, `id` must be unique.
1678
2065
  *
1679
2066
  * Default: auto-generated ID
2067
+ * @format GUID
1680
2068
  */
1681
2069
  _id?: string | null;
1682
- /** Tax group ID for this custom line item. */
2070
+ /**
2071
+ * Tax group ID for this custom line item.
2072
+ * @format GUID
2073
+ */
1683
2074
  taxGroupId?: string | null;
1684
2075
  /** Name of the item or product. */
1685
2076
  productName?: ProductName;
@@ -1687,11 +2078,15 @@ export interface CustomLineItem {
1687
2078
  url?: string;
1688
2079
  /** Item type. Either a preset type or custom. */
1689
2080
  itemType?: ItemType;
1690
- /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
2081
+ /**
2082
+ * Item price **before** catalog-defined discount. Defaults to `price` when not provided.
2083
+ * @format DECIMAL_VALUE
2084
+ */
1691
2085
  fullPrice?: string | null;
1692
2086
  /**
1693
2087
  * Item quantity available for purchase. Only return this if inventory is managed.
1694
2088
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
2089
+ * @max 100000
1695
2090
  */
1696
2091
  quantityAvailable?: number | null;
1697
2092
  /** Physical properties of the item. */
@@ -1716,6 +2111,8 @@ export interface CustomLineItem {
1716
2111
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
1717
2112
  * + In most cases, this field is the same as `catalogReference.catalogItemId`.
1718
2113
  * + Used in membership validation.
2114
+ * @minLength 1
2115
+ * @maxLength 36
1719
2116
  */
1720
2117
  rootCatalogItemId?: string | null;
1721
2118
  /**
@@ -1723,12 +2120,20 @@ export interface CustomLineItem {
1723
2120
  *
1724
2121
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
1725
2122
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
2123
+ * @format DECIMAL_VALUE
1726
2124
  */
1727
2125
  depositAmount?: string | null;
2126
+ /**
2127
+ * Delivery profile ID.
2128
+ * @format GUID
2129
+ */
2130
+ deliveryProfileId?: string | null;
1728
2131
  /** 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. */
1729
2132
  catalogReference?: CatalogReference;
1730
2133
  /**
1731
2134
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
2135
+ * @minLength 1
2136
+ * @maxLength 1000
1732
2137
  * @readonly
1733
2138
  */
1734
2139
  consentRequiredPaymentPolicy?: string | null;
@@ -1741,9 +2146,16 @@ export interface CustomLineItem {
1741
2146
  savePaymentMethod?: boolean;
1742
2147
  }
1743
2148
  export interface MerchantDiscountInput {
1744
- /** Discount amount. */
2149
+ /**
2150
+ * Discount amount.
2151
+ * @decimalValue options { gte:0 }
2152
+ */
1745
2153
  amount?: string;
1746
- /** IDs of the line items the discount applies to. */
2154
+ /**
2155
+ * IDs of the line items the discount applies to.
2156
+ * @format GUID
2157
+ * @maxSize 300
2158
+ */
1747
2159
  lineItemIds?: string[];
1748
2160
  }
1749
2161
  export interface CreateCheckoutResponse {
@@ -1760,7 +2172,10 @@ export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
1760
2172
  carrierErrors?: CarrierErrors;
1761
2173
  }
1762
2174
  export interface GetCheckoutRequest {
1763
- /** Checkout ID. */
2175
+ /**
2176
+ * Checkout ID.
2177
+ * @format GUID
2178
+ */
1764
2179
  _id: string;
1765
2180
  }
1766
2181
  export interface GetCheckoutResponse {
@@ -1768,7 +2183,10 @@ export interface GetCheckoutResponse {
1768
2183
  checkout?: Checkout;
1769
2184
  }
1770
2185
  export interface GetCheckoutWithAllExtendedFieldsRequest {
1771
- /** Checkout ID. */
2186
+ /**
2187
+ * Checkout ID.
2188
+ * @format GUID
2189
+ */
1772
2190
  _id?: string;
1773
2191
  }
1774
2192
  export interface GetCheckoutWithAllExtendedFieldsResponse {
@@ -1776,7 +2194,10 @@ export interface GetCheckoutWithAllExtendedFieldsResponse {
1776
2194
  checkout?: Checkout;
1777
2195
  }
1778
2196
  export interface GetCheckoutByCartIdRequest {
1779
- /** Cart ID. */
2197
+ /**
2198
+ * Cart ID.
2199
+ * @format GUID
2200
+ */
1780
2201
  _id: string;
1781
2202
  }
1782
2203
  export interface GetCheckoutByCartIdResponse {
@@ -1784,7 +2205,10 @@ export interface GetCheckoutByCartIdResponse {
1784
2205
  checkout?: Checkout;
1785
2206
  }
1786
2207
  export interface GetWixCheckoutURLRequest {
1787
- /** Checkout ID. */
2208
+ /**
2209
+ * Checkout ID.
2210
+ * @format GUID
2211
+ */
1788
2212
  _id: string;
1789
2213
  }
1790
2214
  export interface GetWixCheckoutURLResponse {
@@ -1792,7 +2216,10 @@ export interface GetWixCheckoutURLResponse {
1792
2216
  checkoutUrl?: string;
1793
2217
  }
1794
2218
  export interface GetCheckoutURLRequest {
1795
- /** Checkout ID. */
2219
+ /**
2220
+ * Checkout ID.
2221
+ * @format GUID
2222
+ */
1796
2223
  _id: string;
1797
2224
  }
1798
2225
  export interface GetCheckoutURLResponse {
@@ -1810,15 +2237,20 @@ export interface UpdateCheckoutRequest {
1810
2237
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
1811
2238
  *
1812
2239
  * 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`.
2240
+ * @maxLength 1000
1813
2241
  */
1814
2242
  overrideCheckoutUrl?: string | null;
1815
- /** Catalog line items. */
2243
+ /**
2244
+ * Catalog line items.
2245
+ * @maxSize 300
2246
+ */
1816
2247
  lineItems?: LineItem[];
1817
2248
  /**
1818
2249
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1819
2250
  *
1820
2251
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1821
2252
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2253
+ * @maxSize 300
1822
2254
  */
1823
2255
  customLineItems?: CustomLineItem[];
1824
2256
  }
@@ -1827,7 +2259,10 @@ export interface UpdateCheckoutResponse {
1827
2259
  checkout?: Checkout;
1828
2260
  }
1829
2261
  export interface RemoveCouponRequest {
1830
- /** ID of the checkout to remove the coupon from. */
2262
+ /**
2263
+ * ID of the checkout to remove the coupon from.
2264
+ * @format GUID
2265
+ */
1831
2266
  _id: string;
1832
2267
  }
1833
2268
  export interface RemoveCouponResponse {
@@ -1835,7 +2270,10 @@ export interface RemoveCouponResponse {
1835
2270
  checkout?: Checkout;
1836
2271
  }
1837
2272
  export interface RemoveGiftCardRequest {
1838
- /** ID of the checkout to remove the gift card from. */
2273
+ /**
2274
+ * ID of the checkout to remove the gift card from.
2275
+ * @format GUID
2276
+ */
1839
2277
  _id: string;
1840
2278
  }
1841
2279
  export interface RemoveGiftCardResponse {
@@ -1843,7 +2281,10 @@ export interface RemoveGiftCardResponse {
1843
2281
  checkout?: Checkout;
1844
2282
  }
1845
2283
  export interface RemoveOverrideCheckoutUrlRequest {
1846
- /** ID of the checkout to remove the override checkout url from. */
2284
+ /**
2285
+ * ID of the checkout to remove the override checkout url from.
2286
+ * @format GUID
2287
+ */
1847
2288
  _id: string;
1848
2289
  }
1849
2290
  export interface RemoveOverrideCheckoutUrlResponse {
@@ -1851,15 +2292,22 @@ export interface RemoveOverrideCheckoutUrlResponse {
1851
2292
  checkout?: Checkout;
1852
2293
  }
1853
2294
  export interface AddToCheckoutRequest {
1854
- /** Checkout ID. */
2295
+ /**
2296
+ * Checkout ID.
2297
+ * @format GUID
2298
+ */
1855
2299
  _id: string;
1856
- /** Catalog line items. */
2300
+ /**
2301
+ * Catalog line items.
2302
+ * @maxSize 100
2303
+ */
1857
2304
  lineItems?: LineItem[];
1858
2305
  /**
1859
2306
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1860
2307
  *
1861
2308
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1862
2309
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2310
+ * @maxSize 100
1863
2311
  */
1864
2312
  customLineItems?: CustomLineItem[];
1865
2313
  }
@@ -1868,9 +2316,17 @@ export interface AddToCheckoutResponse {
1868
2316
  checkout?: Checkout;
1869
2317
  }
1870
2318
  export interface RemoveLineItemsRequest {
1871
- /** ID of the checkout to remove line items from. */
2319
+ /**
2320
+ * ID of the checkout to remove line items from.
2321
+ * @format GUID
2322
+ */
1872
2323
  _id: string;
1873
- /** IDs of the line items to remove from the checkout. */
2324
+ /**
2325
+ * IDs of the line items to remove from the checkout.
2326
+ * @format GUID
2327
+ * @minSize 1
2328
+ * @maxSize 300
2329
+ */
1874
2330
  lineItemIds: string[];
1875
2331
  }
1876
2332
  export interface RemoveLineItemsResponse {
@@ -1878,7 +2334,10 @@ export interface RemoveLineItemsResponse {
1878
2334
  checkout?: Checkout;
1879
2335
  }
1880
2336
  export interface CreateOrderRequest {
1881
- /** Checkout ID. */
2337
+ /**
2338
+ * Checkout ID.
2339
+ * @format GUID
2340
+ */
1882
2341
  _id: string;
1883
2342
  /** Indicates the payment method should be saved on the order */
1884
2343
  savePaymentMethod?: boolean;
@@ -1886,9 +2345,15 @@ export interface CreateOrderRequest {
1886
2345
  delayCapture?: boolean;
1887
2346
  }
1888
2347
  export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
1889
- /** ID of the newly created order. */
2348
+ /**
2349
+ * ID of the newly created order.
2350
+ * @format GUID
2351
+ */
1890
2352
  orderId?: string;
1891
- /** ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions). */
2353
+ /**
2354
+ * ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions).
2355
+ * @format GUID
2356
+ */
1892
2357
  subscriptionId?: string;
1893
2358
  /**
1894
2359
  * Payment gateway order ID.
@@ -1903,9 +2368,15 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
1903
2368
  }
1904
2369
  /** @oneof */
1905
2370
  export interface CreateOrderResponseIdOneOf {
1906
- /** ID of newly created order. */
2371
+ /**
2372
+ * ID of newly created order.
2373
+ * @format GUID
2374
+ */
1907
2375
  orderId?: string;
1908
- /** ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions). */
2376
+ /**
2377
+ * ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions).
2378
+ * @format GUID
2379
+ */
1909
2380
  subscriptionId?: string;
1910
2381
  }
1911
2382
  export interface PaymentErrorResponseData {
@@ -1914,12 +2385,16 @@ export interface PaymentErrorResponseData {
1914
2385
  failureDetails?: string | null;
1915
2386
  }
1916
2387
  export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2388
+ /** @format GUID */
1917
2389
  orderId?: string;
2390
+ /** @format GUID */
1918
2391
  subscriptionId?: string;
1919
2392
  }
1920
2393
  /** @oneof */
1921
2394
  export interface DoublePaymentErrorDataIdOneOf {
2395
+ /** @format GUID */
1922
2396
  orderId?: string;
2397
+ /** @format GUID */
1923
2398
  subscriptionId?: string;
1924
2399
  }
1925
2400
  export interface RedeemErrorData {
@@ -1930,7 +2405,10 @@ export interface ViolationsList {
1930
2405
  violations?: Violation[];
1931
2406
  }
1932
2407
  export interface CreateOrderAndChargeRequest {
1933
- /** Checkout ID. */
2408
+ /**
2409
+ * Checkout ID.
2410
+ * @format GUID
2411
+ */
1934
2412
  _id: string;
1935
2413
  /** Payment token. */
1936
2414
  paymentToken?: string | null;
@@ -1940,9 +2418,15 @@ export interface CreateOrderAndChargeRequest {
1940
2418
  delayCapture?: boolean;
1941
2419
  }
1942
2420
  export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
1943
- /** ID of newly created order. */
2421
+ /**
2422
+ * ID of newly created order.
2423
+ * @format GUID
2424
+ */
1944
2425
  orderId?: string;
1945
- /** ID of newly created subscription. */
2426
+ /**
2427
+ * ID of newly created subscription.
2428
+ * @format GUID
2429
+ */
1946
2430
  subscriptionId?: string;
1947
2431
  /** Payment response token. */
1948
2432
  paymentResponseToken?: string | null;
@@ -1958,13 +2442,38 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
1958
2442
  }
1959
2443
  /** @oneof */
1960
2444
  export interface CreateOrderAndChargeResponseIdOneOf {
1961
- /** ID of newly created order. */
2445
+ /**
2446
+ * ID of newly created order.
2447
+ * @format GUID
2448
+ */
1962
2449
  orderId?: string;
1963
- /** ID of newly created subscription. */
2450
+ /**
2451
+ * ID of newly created subscription.
2452
+ * @format GUID
2453
+ */
1964
2454
  subscriptionId?: string;
1965
2455
  }
2456
+ export interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
2457
+ /**
2458
+ * Server-signed JWT token with required information to complete checkout
2459
+ * @maxLength 4096
2460
+ */
2461
+ token: string;
2462
+ }
2463
+ export interface RawHttpResponse {
2464
+ body?: Uint8Array;
2465
+ statusCode?: number | null;
2466
+ headers?: HeadersEntry[];
2467
+ }
2468
+ export interface HeadersEntry {
2469
+ key?: string;
2470
+ value?: string;
2471
+ }
1966
2472
  export interface MarkCheckoutAsCompletedRequest {
1967
- /** Checkout ID. */
2473
+ /**
2474
+ * Checkout ID.
2475
+ * @format GUID
2476
+ */
1968
2477
  _id: string;
1969
2478
  }
1970
2479
  export interface MarkCheckoutAsCompletedResponse {
@@ -1974,13 +2483,23 @@ export interface CheckoutMarkedAsCompleted {
1974
2483
  checkout?: Checkout;
1975
2484
  }
1976
2485
  export interface UpdateLineItemsQuantityRequest {
1977
- /** Checkout ID. */
2486
+ /**
2487
+ * Checkout ID.
2488
+ * @format GUID
2489
+ */
1978
2490
  _id: string;
1979
- /** Line item info to update. */
2491
+ /**
2492
+ * Line item info to update.
2493
+ * @minSize 1
2494
+ * @maxSize 100
2495
+ */
1980
2496
  lineItems: LineItemQuantityUpdate[];
1981
2497
  }
1982
2498
  export interface LineItemQuantityUpdate {
1983
- /** ID of the line item to update. */
2499
+ /**
2500
+ * ID of the line item to update.
2501
+ * @format GUID
2502
+ */
1984
2503
  _id?: string;
1985
2504
  /**
1986
2505
  * New total amount of the line item,
@@ -1989,6 +2508,8 @@ export interface LineItemQuantityUpdate {
1989
2508
  * Min: `1`
1990
2509
  *
1991
2510
  * Max: `100000`
2511
+ * @min 1
2512
+ * @max 100000
1992
2513
  */
1993
2514
  quantity?: number;
1994
2515
  }
@@ -1997,7 +2518,10 @@ export interface UpdateLineItemsQuantityResponse {
1997
2518
  checkout?: Checkout;
1998
2519
  }
1999
2520
  export interface GetCheckoutPaymentSettingsRequest {
2000
- /** Checkout ID. */
2521
+ /**
2522
+ * Checkout ID.
2523
+ * @format GUID
2524
+ */
2001
2525
  _id: string;
2002
2526
  }
2003
2527
  export interface GetCheckoutPaymentSettingsResponse {
@@ -2008,7 +2532,10 @@ export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2008
2532
  MANUAL = "MANUAL"
2009
2533
  }
2010
2534
  export interface DeleteCheckoutRequest {
2011
- /** ID of the checkout to delete. */
2535
+ /**
2536
+ * ID of the checkout to delete.
2537
+ * @format GUID
2538
+ */
2012
2539
  _id?: string;
2013
2540
  }
2014
2541
  export interface DeleteCheckoutResponse {
@@ -2022,20 +2549,33 @@ export interface Subscription {
2022
2549
  * @readonly
2023
2550
  */
2024
2551
  _id?: string;
2025
- /** id of subscription in external system */
2552
+ /**
2553
+ * id of subscription in external system
2554
+ * @format GUID
2555
+ */
2026
2556
  externalId?: string | null;
2027
2557
  /**
2028
2558
  * Subscription creation date
2029
2559
  * @readonly
2030
2560
  */
2031
2561
  dateCreated?: Date | null;
2032
- /** The id of the cart this order was created from */
2562
+ /**
2563
+ * The id of the cart this order was created from
2564
+ * @format GUID
2565
+ */
2033
2566
  cartId?: string | null;
2034
- /** The id of the checkout this subscriptions was created from */
2567
+ /**
2568
+ * The id of the checkout this subscriptions was created from
2569
+ * @format GUID
2570
+ */
2035
2571
  checkoutId?: string | null;
2036
2572
  /** member or contact */
2037
2573
  buyerInfo?: V1BuyerInfo;
2038
- /** Line items ordered */
2574
+ /**
2575
+ * Line items ordered
2576
+ * @minSize 1
2577
+ * @maxSize 1
2578
+ */
2039
2579
  lineItems?: V1LineItem[];
2040
2580
  /** Totals for subscription's line items */
2041
2581
  totals?: Totals;
@@ -2047,7 +2587,10 @@ export interface Subscription {
2047
2587
  shippingInfo?: V1ShippingInfo;
2048
2588
  /** Coupon that was applied to subscription */
2049
2589
  appliedCoupon?: AppliedCoupon;
2050
- /** Message from the customer (e.g., customization request) */
2590
+ /**
2591
+ * Message from the customer (e.g., customization request)
2592
+ * @maxLength 1000
2593
+ */
2051
2594
  buyerNote?: string | null;
2052
2595
  /** Custom field */
2053
2596
  customField?: V1CustomField;
@@ -2065,7 +2608,10 @@ export interface Subscription {
2065
2608
  }
2066
2609
  /** Buyer Info */
2067
2610
  export interface V1BuyerInfo {
2068
- /** Wix customer ID */
2611
+ /**
2612
+ * Wix customer ID
2613
+ * @format GUID
2614
+ */
2069
2615
  _id?: string;
2070
2616
  /** Customer type */
2071
2617
  identityType?: IdentityType;
@@ -2080,13 +2626,26 @@ export declare enum IdentityType {
2080
2626
  export interface V1LineItem {
2081
2627
  /** Line item ID (auto-generated) */
2082
2628
  index?: number;
2083
- /** Line item quantity */
2629
+ /**
2630
+ * Line item quantity
2631
+ * @min 1
2632
+ * @max 100000
2633
+ */
2084
2634
  quantity?: number;
2085
- /** Line item variantId (from Stores Catalog) */
2635
+ /**
2636
+ * Line item variantId (from Stores Catalog)
2637
+ * @format GUID
2638
+ */
2086
2639
  variantId?: string | null;
2087
- /** Line item options ordered */
2640
+ /**
2641
+ * Line item options ordered
2642
+ * @maxSize 6
2643
+ */
2088
2644
  options?: OptionSelection[];
2089
- /** Line item custom text field selections */
2645
+ /**
2646
+ * Line item custom text field selections
2647
+ * @maxSize 20
2648
+ */
2090
2649
  customTextFields?: CustomTextFieldSelection[];
2091
2650
  /** Charges details */
2092
2651
  chargeDetails?: ChargeDetails;
@@ -2094,53 +2653,109 @@ export interface V1LineItem {
2094
2653
  productDetails?: ProductDetails;
2095
2654
  }
2096
2655
  export interface OptionSelection {
2097
- /** Option name */
2656
+ /**
2657
+ * Option name
2658
+ * @maxLength 200
2659
+ */
2098
2660
  option?: string;
2099
- /** Selected choice for this option */
2661
+ /**
2662
+ * Selected choice for this option
2663
+ * @maxLength 500
2664
+ */
2100
2665
  selection?: string;
2101
2666
  }
2102
2667
  export interface CustomTextFieldSelection {
2103
- /** Custom text field name */
2668
+ /**
2669
+ * Custom text field name
2670
+ * @maxLength 100
2671
+ */
2104
2672
  title?: string;
2105
- /** Custom text field value */
2673
+ /**
2674
+ * Custom text field value
2675
+ * @maxLength 500
2676
+ */
2106
2677
  value?: string;
2107
2678
  }
2108
2679
  export interface ChargeDetails {
2109
- /** price of line item (depends on subscription option) */
2680
+ /**
2681
+ * price of line item (depends on subscription option)
2682
+ * @max 999999999.99
2683
+ */
2110
2684
  price?: number;
2111
- /** Total price charged to the customer (for this line items) after computation of quantity and discount */
2685
+ /**
2686
+ * Total price charged to the customer (for this line items) after computation of quantity and discount
2687
+ * @max 999999999.99
2688
+ */
2112
2689
  totalPrice?: number | null;
2113
- /** Discount applied for this line item */
2690
+ /**
2691
+ * Discount applied for this line item
2692
+ * @max 999999999.99
2693
+ */
2114
2694
  discount?: number | null;
2115
- /** Tax applied for this line item */
2695
+ /**
2696
+ * Tax applied for this line item
2697
+ * @max 999999999.99
2698
+ */
2116
2699
  tax?: number | null;
2117
2700
  /** Is tax applied for this line item */
2118
2701
  taxIncludedInPrice?: boolean;
2119
- /** Tax rate %, as a decimal point >= 0 */
2702
+ /**
2703
+ * Tax rate %, as a decimal point >= 0
2704
+ * @decimalValue options { maxScale:6, gte:0 }
2705
+ */
2120
2706
  taxRate?: string | null;
2121
2707
  }
2122
2708
  export interface ProductDetails {
2123
- /** Line item product ID (optional for POS orders) */
2709
+ /**
2710
+ * Line item product ID (optional for POS orders)
2711
+ * @minLength 1
2712
+ */
2124
2713
  productId?: string | null;
2125
- /** Line item name */
2714
+ /**
2715
+ * Line item name
2716
+ * @minLength 1
2717
+ * @maxLength 100
2718
+ */
2126
2719
  name?: string;
2127
- /** Line item name translated to buyer's language */
2720
+ /**
2721
+ * Line item name translated to buyer's language
2722
+ * @minLength 1
2723
+ * @maxLength 100
2724
+ */
2128
2725
  translatedName?: string | null;
2129
2726
  /** Line item type (may be extended) */
2130
2727
  lineItemType?: LineItemType;
2131
2728
  /** Line item primary media for preview */
2132
2729
  mediaItem?: MediaItem;
2133
- /** Line item SKU */
2730
+ /**
2731
+ * Line item SKU
2732
+ * @maxLength 40
2733
+ */
2134
2734
  sku?: string | null;
2135
- /** Line item weight */
2735
+ /**
2736
+ * Line item weight
2737
+ * @max 999999999.99
2738
+ */
2136
2739
  weight?: number | null;
2137
- /** Line item notes */
2740
+ /**
2741
+ * Line item notes
2742
+ * @maxLength 1000
2743
+ */
2138
2744
  notes?: string | null;
2139
- /** Line item fulfillerId from stores fulfillers. No value means self fulfilled */
2745
+ /**
2746
+ * Line item fulfillerId from stores fulfillers. No value means self fulfilled
2747
+ * @format GUID
2748
+ */
2140
2749
  fulfillerId?: string | null;
2141
- /** Tax group id */
2750
+ /**
2751
+ * Tax group id
2752
+ * @format GUID
2753
+ */
2142
2754
  taxGroupId?: string | null;
2143
- /** App id from the catalog reference */
2755
+ /**
2756
+ * App id from the catalog reference
2757
+ * @format GUID
2758
+ */
2144
2759
  appId?: string | null;
2145
2760
  }
2146
2761
  export declare enum LineItemType {
@@ -2161,16 +2776,19 @@ export interface MediaItem {
2161
2776
  mediaType?: MediaItemType;
2162
2777
  /**
2163
2778
  * Media URL
2779
+ * @format WEB_URL
2164
2780
  * @readonly
2165
2781
  */
2166
2782
  url?: string;
2167
2783
  /**
2168
2784
  * Media item width
2785
+ * @max 5000
2169
2786
  * @readonly
2170
2787
  */
2171
2788
  width?: number;
2172
2789
  /**
2173
2790
  * Media item height
2791
+ * @max 5000
2174
2792
  * @readonly
2175
2793
  */
2176
2794
  height?: number;
@@ -2178,7 +2796,10 @@ export interface MediaItem {
2178
2796
  _id?: string | null;
2179
2797
  /** Media external URL */
2180
2798
  externalImageUrl?: string | null;
2181
- /** Alternative text for presentation when media cannot be displayed */
2799
+ /**
2800
+ * Alternative text for presentation when media cannot be displayed
2801
+ * @maxLength 256
2802
+ */
2182
2803
  altText?: string | null;
2183
2804
  }
2184
2805
  export declare enum MediaItemType {
@@ -2188,17 +2809,35 @@ export declare enum MediaItemType {
2188
2809
  IMAGE = "IMAGE"
2189
2810
  }
2190
2811
  export interface Totals {
2191
- /** Subtotal of all line items, before tax */
2812
+ /**
2813
+ * Subtotal of all line items, before tax
2814
+ * @max 999999999.99
2815
+ */
2192
2816
  subtotal?: number;
2193
- /** Total shipping price, including tax */
2817
+ /**
2818
+ * Total shipping price, including tax
2819
+ * @max 999999999.99
2820
+ */
2194
2821
  shipping?: number;
2195
- /** Total tax */
2822
+ /**
2823
+ * Total tax
2824
+ * @max 999999999.99
2825
+ */
2196
2826
  tax?: number;
2197
- /** Total calculated discount value */
2827
+ /**
2828
+ * Total calculated discount value
2829
+ * @max 999999999.99
2830
+ */
2198
2831
  discount?: number;
2199
- /** Total price */
2832
+ /**
2833
+ * Total price
2834
+ * @max 999999999.99
2835
+ */
2200
2836
  total?: number;
2201
- /** Total weight */
2837
+ /**
2838
+ * Total weight
2839
+ * @max 999999999.99
2840
+ */
2202
2841
  weight?: number | null;
2203
2842
  /**
2204
2843
  * Total line items quantity
@@ -2207,7 +2846,11 @@ export interface Totals {
2207
2846
  quantity?: number;
2208
2847
  }
2209
2848
  export interface StoreSettings {
2210
- /** Currency used for pricing in this store */
2849
+ /**
2850
+ * Currency used for pricing in this store
2851
+ * @maxLength 3
2852
+ * @format CURRENCY
2853
+ */
2211
2854
  currency?: string | null;
2212
2855
  /** Weight unit used in this store */
2213
2856
  weightUnit?: WeightUnit;
@@ -2215,56 +2858,103 @@ export interface StoreSettings {
2215
2858
  * The language to be used when communicating with the buyer
2216
2859
  * For a site that support multiple languages, this would be the language the buyer selected
2217
2860
  * Otherwise this would be the site language
2861
+ * @minLength 2
2862
+ * @maxLength 2
2218
2863
  */
2219
2864
  buyerLanguage?: string | null;
2220
2865
  }
2221
2866
  export interface Address extends AddressAddressLine1OptionsOneOf {
2222
- /** Address line 1 (free text) */
2867
+ /**
2868
+ * Address line 1 (free text)
2869
+ * @maxLength 1000
2870
+ */
2223
2871
  addressLine1?: string;
2224
2872
  /** Address line 1 (street) */
2225
2873
  street?: Street;
2226
2874
  /** Addressee name */
2227
2875
  fullName?: FullName;
2228
- /** Country code (2 letters) */
2876
+ /**
2877
+ * Country code (2 letters)
2878
+ * @format COUNTRY
2879
+ */
2229
2880
  country?: string | null;
2230
- /** State or district */
2881
+ /**
2882
+ * State or district
2883
+ * @maxLength 50
2884
+ */
2231
2885
  subdivision?: string | null;
2232
- /** City name */
2886
+ /**
2887
+ * City name
2888
+ * @maxLength 150
2889
+ */
2233
2890
  city?: string | null;
2234
- /** ZIP/postal code */
2891
+ /**
2892
+ * ZIP/postal code
2893
+ * @maxLength 200
2894
+ */
2235
2895
  zipCode?: string | null;
2236
- /** Phone number */
2896
+ /**
2897
+ * Phone number
2898
+ * @maxLength 200
2899
+ */
2237
2900
  phone?: string | null;
2238
- /** Company name */
2901
+ /**
2902
+ * Company name
2903
+ * @maxLength 500
2904
+ */
2239
2905
  company?: string | null;
2240
- /** Email address */
2906
+ /**
2907
+ * Email address
2908
+ * @maxLength 500
2909
+ */
2241
2910
  email?: string | null;
2242
- /** address line */
2911
+ /**
2912
+ * address line
2913
+ * @maxLength 250
2914
+ */
2243
2915
  addressLine2?: string | null;
2244
2916
  /** Tax information (for Brazil only) */
2245
2917
  vatId?: VatId;
2246
2918
  }
2247
2919
  /** @oneof */
2248
2920
  export interface AddressAddressLine1OptionsOneOf {
2249
- /** Address line 1 (free text) */
2921
+ /**
2922
+ * Address line 1 (free text)
2923
+ * @maxLength 1000
2924
+ */
2250
2925
  addressLine1?: string;
2251
2926
  /** Address line 1 (street) */
2252
2927
  street?: Street;
2253
2928
  }
2254
2929
  export interface FullName {
2255
- /** Customer's first name */
2930
+ /**
2931
+ * Customer's first name
2932
+ * @maxLength 1000
2933
+ */
2256
2934
  firstName?: string;
2257
- /** Customer's last name */
2935
+ /**
2936
+ * Customer's last name
2937
+ * @maxLength 1000
2938
+ */
2258
2939
  lastName?: string;
2259
2940
  }
2260
2941
  export interface Street {
2261
- /** Street number */
2942
+ /**
2943
+ * Street number
2944
+ * @maxLength 500
2945
+ */
2262
2946
  number?: string;
2263
- /** Street name */
2947
+ /**
2948
+ * Street name
2949
+ * @maxLength 1000
2950
+ */
2264
2951
  name?: string;
2265
2952
  }
2266
2953
  export interface VatId {
2267
- /** Customer's tax ID. */
2954
+ /**
2955
+ * Customer's tax ID.
2956
+ * @maxLength 50
2957
+ */
2268
2958
  number?: string;
2269
2959
  /**
2270
2960
  * Tax type.
@@ -2287,9 +2977,15 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
2287
2977
  shipmentDetails?: ShipmentDetails;
2288
2978
  /** Pickup details (when this object describes pickup) */
2289
2979
  pickupDetails?: V1PickupDetails;
2290
- /** Delivery option name */
2980
+ /**
2981
+ * Delivery option name
2982
+ * @maxLength 250
2983
+ */
2291
2984
  deliveryOption?: string;
2292
- /** Delivery option delivery time */
2985
+ /**
2986
+ * Delivery option delivery time
2987
+ * @maxLength 500
2988
+ */
2293
2989
  estimatedDeliveryTime?: string | null;
2294
2990
  }
2295
2991
  /** @oneof */
@@ -2302,53 +2998,101 @@ export interface V1ShippingInfoDetailsOneOf {
2302
2998
  export interface ShipmentDetails {
2303
2999
  /** Shipping destination address */
2304
3000
  address?: Address;
2305
- /** Discount applied for shipping */
3001
+ /**
3002
+ * Discount applied for shipping
3003
+ * @max 999999999.99
3004
+ */
2306
3005
  discount?: number | null;
2307
- /** Tax applied for shipping */
3006
+ /**
3007
+ * Tax applied for shipping
3008
+ * @max 999999999.99
3009
+ */
2308
3010
  tax?: number | null;
2309
3011
  /** Whether tax is included in the price */
2310
3012
  taxIncludedInPrice?: boolean;
2311
- /** Tax rate % for shipping, as a decimal point >= 0 */
3013
+ /**
3014
+ * Tax rate % for shipping, as a decimal point >= 0
3015
+ * @decimalValue options { maxScale:6, gte:0 }
3016
+ */
2312
3017
  taxRate?: string | null;
2313
3018
  }
2314
3019
  export interface V1PickupDetails {
2315
3020
  /** Pickup address */
2316
3021
  address?: PickupAddress;
2317
- /** Store owner's pickup instructions */
3022
+ /**
3023
+ * Store owner's pickup instructions
3024
+ * @maxLength 1000
3025
+ */
2318
3026
  pickupInstructions?: string | null;
2319
3027
  }
2320
3028
  export interface PickupAddress {
2321
- /** Country code (2 letters) */
3029
+ /**
3030
+ * Country code (2 letters)
3031
+ * @format COUNTRY
3032
+ */
2322
3033
  country?: string;
2323
- /** State/District */
3034
+ /**
3035
+ * State/District
3036
+ * @maxLength 50
3037
+ */
2324
3038
  subdivision?: string | null;
2325
- /** Address */
3039
+ /**
3040
+ * Address
3041
+ * @maxLength 200
3042
+ */
2326
3043
  addressLine?: string;
2327
- /** City */
3044
+ /**
3045
+ * City
3046
+ * @maxLength 85
3047
+ */
2328
3048
  city?: string;
2329
- /** ZIP/postal code */
3049
+ /**
3050
+ * ZIP/postal code
3051
+ * @maxLength 50
3052
+ */
2330
3053
  zipCode?: string;
2331
3054
  }
2332
3055
  export interface AppliedCoupon {
2333
3056
  /** Coupon ID */
2334
3057
  couponId?: string;
2335
- /** Coupon name */
3058
+ /**
3059
+ * Coupon name
3060
+ * @maxLength 100
3061
+ */
2336
3062
  name?: string;
2337
- /** Coupon code */
3063
+ /**
3064
+ * Coupon code
3065
+ * @maxLength 100
3066
+ */
2338
3067
  code?: string;
2339
3068
  }
2340
3069
  /** Custom field */
2341
3070
  export interface V1CustomField {
2342
- /** Free text that the customer entered in the custom field during the checkout process */
3071
+ /**
3072
+ * Free text that the customer entered in the custom field during the checkout process
3073
+ * @maxLength 250
3074
+ */
2343
3075
  value?: string;
2344
- /** Title for the custom field */
3076
+ /**
3077
+ * Title for the custom field
3078
+ * @maxLength 200
3079
+ */
2345
3080
  title?: string;
2346
- /** The title translated according to the buyer language */
3081
+ /**
3082
+ * The title translated according to the buyer language
3083
+ * @maxLength 200
3084
+ */
2347
3085
  translatedTitle?: string;
2348
3086
  }
2349
3087
  export interface V1SubscriptionOptionInfo {
3088
+ /** @format GUID */
2350
3089
  _id?: string | null;
3090
+ /**
3091
+ * @minLength 1
3092
+ * @maxLength 20
3093
+ */
2351
3094
  title?: string;
3095
+ /** @maxLength 60 */
2352
3096
  description?: string | null;
2353
3097
  discount?: Discount;
2354
3098
  }
@@ -2379,15 +3123,28 @@ export interface V1SubscriptionSettings {
2379
3123
  frequency?: SubscriptionFrequency;
2380
3124
  /** Whether subscription is renewed automatically at the end of each period. */
2381
3125
  autoRenewal?: boolean;
2382
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
3126
+ /**
3127
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
3128
+ * @min 2
3129
+ * @max 999
3130
+ */
2383
3131
  billingCycles?: number | null;
2384
3132
  }
2385
3133
  export interface BillingInfo {
2386
- /** Payment method used for this order */
3134
+ /**
3135
+ * Payment method used for this order
3136
+ * @maxLength 50
3137
+ */
2387
3138
  paymentMethod?: string | null;
2388
- /** Transaction ID from payment gateway (e.g., Wix Payments) */
3139
+ /**
3140
+ * Transaction ID from payment gateway (e.g., Wix Payments)
3141
+ * @maxLength 100
3142
+ */
2389
3143
  paymentGatewayTransactionId?: string | null;
2390
- /** Order ID from payment gateway (e.g., Wix Payments) */
3144
+ /**
3145
+ * Order ID from payment gateway (e.g., Wix Payments)
3146
+ * @maxLength 100
3147
+ */
2391
3148
  paymentGatewayOrderId?: string | null;
2392
3149
  }
2393
3150
  export interface Empty {
@@ -2463,9 +3220,15 @@ export interface ActionEvent {
2463
3220
  body?: string;
2464
3221
  }
2465
3222
  export interface MessageEnvelope {
2466
- /** App instance ID. */
3223
+ /**
3224
+ * App instance ID.
3225
+ * @format GUID
3226
+ */
2467
3227
  instanceId?: string | null;
2468
- /** Event type. */
3228
+ /**
3229
+ * Event type.
3230
+ * @maxLength 150
3231
+ */
2469
3232
  eventType?: string;
2470
3233
  /** The identification type and identity data. */
2471
3234
  identity?: IdentificationData;
@@ -2473,26 +3236,50 @@ export interface MessageEnvelope {
2473
3236
  data?: string;
2474
3237
  }
2475
3238
  export interface IdentificationData extends IdentificationDataIdOneOf {
2476
- /** ID of a site visitor that has not logged in to the site. */
3239
+ /**
3240
+ * ID of a site visitor that has not logged in to the site.
3241
+ * @format GUID
3242
+ */
2477
3243
  anonymousVisitorId?: string;
2478
- /** ID of a site visitor that has logged in to the site. */
3244
+ /**
3245
+ * ID of a site visitor that has logged in to the site.
3246
+ * @format GUID
3247
+ */
2479
3248
  memberId?: string;
2480
- /** ID of a Wix user (site owner, contributor, etc.). */
3249
+ /**
3250
+ * ID of a Wix user (site owner, contributor, etc.).
3251
+ * @format GUID
3252
+ */
2481
3253
  wixUserId?: string;
2482
- /** ID of an app. */
3254
+ /**
3255
+ * ID of an app.
3256
+ * @format GUID
3257
+ */
2483
3258
  appId?: string;
2484
3259
  /** @readonly */
2485
3260
  identityType?: WebhookIdentityType;
2486
3261
  }
2487
3262
  /** @oneof */
2488
3263
  export interface IdentificationDataIdOneOf {
2489
- /** ID of a site visitor that has not logged in to the site. */
3264
+ /**
3265
+ * ID of a site visitor that has not logged in to the site.
3266
+ * @format GUID
3267
+ */
2490
3268
  anonymousVisitorId?: string;
2491
- /** ID of a site visitor that has logged in to the site. */
3269
+ /**
3270
+ * ID of a site visitor that has logged in to the site.
3271
+ * @format GUID
3272
+ */
2492
3273
  memberId?: string;
2493
- /** ID of a Wix user (site owner, contributor, etc.). */
3274
+ /**
3275
+ * ID of a Wix user (site owner, contributor, etc.).
3276
+ * @format GUID
3277
+ */
2494
3278
  wixUserId?: string;
2495
- /** ID of an app. */
3279
+ /**
3280
+ * ID of an app.
3281
+ * @format GUID
3282
+ */
2496
3283
  appId?: string;
2497
3284
  }
2498
3285
  export declare enum WebhookIdentityType {
@@ -2971,6 +3758,14 @@ export interface CreateOrderAndChargeResponseNonNullableFields {
2971
3758
  orderId: string;
2972
3759
  subscriptionId: string;
2973
3760
  }
3761
+ interface HeadersEntryNonNullableFields {
3762
+ key: string;
3763
+ value: string;
3764
+ }
3765
+ export interface RawHttpResponseNonNullableFields {
3766
+ body: Uint8Array;
3767
+ headers: HeadersEntryNonNullableFields[];
3768
+ }
2974
3769
  export interface UpdateLineItemsQuantityResponseNonNullableFields {
2975
3770
  checkout?: CheckoutNonNullableFields;
2976
3771
  }
@@ -2978,9 +3773,15 @@ export interface GetCheckoutPaymentSettingsResponseNonNullableFields {
2978
3773
  blockedPaymentOptions: GetCheckoutPaymentSettingsResponsePaymentOption[];
2979
3774
  }
2980
3775
  export interface BaseEventMetadata {
2981
- /** App instance ID. */
3776
+ /**
3777
+ * App instance ID.
3778
+ * @format GUID
3779
+ */
2982
3780
  instanceId?: string | null;
2983
- /** Event type. */
3781
+ /**
3782
+ * Event type.
3783
+ * @maxLength 150
3784
+ */
2984
3785
  eventType?: string;
2985
3786
  /** The identification type and identity data. */
2986
3787
  identity?: IdentificationData;
@@ -3047,6 +3848,8 @@ export interface CheckoutCompletedEnvelope {
3047
3848
  * @permissionId ECOM.READ_CHECKOUTS
3048
3849
  * @webhook
3049
3850
  * @eventType wix.ecom.v1.checkout_completed
3851
+ * @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
3852
+ * @slug completed
3050
3853
  */
3051
3854
  export declare function onCheckoutCompleted(handler: (event: CheckoutCompletedEnvelope) => void | Promise<void>): void;
3052
3855
  export interface CheckoutCreatedEnvelope {
@@ -3072,6 +3875,8 @@ export interface CheckoutCreatedEnvelope {
3072
3875
  * @permissionId ECOM.READ_CHECKOUTS
3073
3876
  * @webhook
3074
3877
  * @eventType wix.ecom.v1.checkout_created
3878
+ * @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
3879
+ * @slug created
3075
3880
  */
3076
3881
  export declare function onCheckoutCreated(handler: (event: CheckoutCreatedEnvelope) => void | Promise<void>): void;
3077
3882
  export interface CheckoutUpdatedEnvelope {
@@ -3097,6 +3902,8 @@ export interface CheckoutUpdatedEnvelope {
3097
3902
  * @permissionId ECOM.READ_CHECKOUTS
3098
3903
  * @webhook
3099
3904
  * @eventType wix.ecom.v1.checkout_updated
3905
+ * @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
3906
+ * @slug updated
3100
3907
  */
3101
3908
  export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelope) => void | Promise<void>): void;
3102
3909
  /**
@@ -3116,8 +3923,8 @@ export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelo
3116
3923
  * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id
3117
3924
  * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId
3118
3925
  * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds
3119
- * @requiredField options.customLineItems.descriptionLines
3120
3926
  * @requiredField options.customLineItems.descriptionLines.name
3927
+ * @requiredField options.customLineItems.descriptionLines.value
3121
3928
  * @requiredField options.customLineItems.itemType
3122
3929
  * @requiredField options.customLineItems.price
3123
3930
  * @requiredField options.customLineItems.productName
@@ -3141,6 +3948,8 @@ export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelo
3141
3948
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3142
3949
  * @permissionScope Manage eCommerce - Admin Permissions
3143
3950
  * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
3951
+ * @permissionScope Manage Restaurants - all permissions
3952
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3144
3953
  * @permissionScope Manage eCommerce - all permissions
3145
3954
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3146
3955
  * @applicableIdentity APP
@@ -3154,28 +3963,20 @@ export interface CreateCheckoutOptions {
3154
3963
  checkoutInfo?: Checkout;
3155
3964
  /** 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). */
3156
3965
  couponCode?: string | null;
3157
- /** Catalog line items to add to the checkout. */
3966
+ /**
3967
+ * Catalog line items to add to the checkout.
3968
+ * @maxSize 300
3969
+ */
3158
3970
  lineItems?: LineItem[];
3159
3971
  /**
3160
3972
  * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
3161
3973
  *
3162
3974
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3163
3975
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3976
+ * @maxSize 300
3164
3977
  */
3165
3978
  customLineItems?: CustomLineItem[];
3166
- /**
3167
- * Sales channel that submitted the order.
3168
- * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
3169
- * + `"WEB"`: A web client.
3170
- * + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
3171
- * + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
3172
- * + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
3173
- * + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
3174
- * + `"WIX_INVOICES"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
3175
- * + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
3176
- * + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
3177
- * + `"OTHER_PLATFORM"`: Other sales platform.
3178
- */
3979
+ /** Sales channel that submitted the order. */
3179
3980
  channelType: ChannelType;
3180
3981
  /**
3181
3982
  * Gift card code.
@@ -3189,6 +3990,7 @@ export interface CreateCheckoutOptions {
3189
3990
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3190
3991
  *
3191
3992
  * 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`.
3993
+ * @maxLength 1000
3192
3994
  */
3193
3995
  overrideCheckoutUrl?: string | null;
3194
3996
  }
@@ -3225,7 +4027,6 @@ export declare function getCheckout(_id: string): Promise<Checkout & CheckoutNon
3225
4027
  * Retrieves the checkout associated with a specified cart.
3226
4028
  * @param _id - Cart ID.
3227
4029
  * @public
3228
- * @documentationMaturity preview
3229
4030
  * @requiredField _id
3230
4031
  * @permissionId ECOM.READ_CHECKOUTS
3231
4032
  * @permissionScope Manage Stores - all permissions
@@ -3292,8 +4093,8 @@ export declare function getCheckoutUrl(_id: string): Promise<GetCheckoutURLRespo
3292
4093
  * @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
3293
4094
  * @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
3294
4095
  * @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
3295
- * @requiredField options.customLineItems.descriptionLines
3296
4096
  * @requiredField options.customLineItems.descriptionLines.name
4097
+ * @requiredField options.customLineItems.descriptionLines.value
3297
4098
  * @requiredField options.customLineItems.itemType
3298
4099
  * @requiredField options.customLineItems.productName
3299
4100
  * @requiredField options.customLineItems.quantity
@@ -3316,6 +4117,8 @@ export declare function getCheckoutUrl(_id: string): Promise<GetCheckoutURLRespo
3316
4117
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3317
4118
  * @permissionScope Manage eCommerce - Admin Permissions
3318
4119
  * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
4120
+ * @permissionScope Manage Restaurants - all permissions
4121
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3319
4122
  * @permissionScope Manage eCommerce - all permissions
3320
4123
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3321
4124
  * @applicableIdentity APP
@@ -3327,6 +4130,7 @@ export declare function updateCheckout(_id: string | null, checkout: UpdateCheck
3327
4130
  export interface UpdateCheckout {
3328
4131
  /**
3329
4132
  * Checkout ID.
4133
+ * @format GUID
3330
4134
  * @readonly
3331
4135
  */
3332
4136
  _id?: string | null;
@@ -3334,6 +4138,8 @@ export interface UpdateCheckout {
3334
4138
  * Line items.
3335
4139
  *
3336
4140
  * Max: 300 items
4141
+ * @minSize 1
4142
+ * @maxSize 300
3337
4143
  * @readonly
3338
4144
  */
3339
4145
  lineItems?: LineItem[];
@@ -3341,13 +4147,17 @@ export interface UpdateCheckout {
3341
4147
  billingInfo?: AddressWithContact;
3342
4148
  /** Shipping information. */
3343
4149
  shippingInfo?: ShippingInfo;
3344
- /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
4150
+ /**
4151
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
4152
+ * @maxLength 1000
4153
+ */
3345
4154
  buyerNote?: string | null;
3346
4155
  /** Buyer information. */
3347
4156
  buyerInfo?: BuyerInfo;
3348
4157
  /**
3349
4158
  * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3350
4159
  * @readonly
4160
+ * @format CURRENCY
3351
4161
  */
3352
4162
  conversionCurrency?: string;
3353
4163
  /**
@@ -3386,6 +4196,7 @@ export interface UpdateCheckout {
3386
4196
  taxSummary?: TaxSummary;
3387
4197
  /**
3388
4198
  * The currency used when submitting the order.
4199
+ * @format CURRENCY
3389
4200
  * @readonly
3390
4201
  */
3391
4202
  currency?: string;
@@ -3443,9 +4254,15 @@ export interface UpdateCheckout {
3443
4254
  payLater?: PriceSummary;
3444
4255
  /** Memberships to apply when creating the order. */
3445
4256
  membershipOptions?: MembershipOptions;
3446
- /** Additional Fees. */
4257
+ /**
4258
+ * Additional Fees.
4259
+ * @maxSize 100
4260
+ */
3447
4261
  additionalFees?: AdditionalFee[];
3448
- /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */
4262
+ /**
4263
+ * Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
4264
+ * @format GUID
4265
+ */
3449
4266
  cartId?: string | null;
3450
4267
  /**
3451
4268
  * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
@@ -3460,6 +4277,7 @@ export interface UpdateCheckout {
3460
4277
  extendedFields?: ExtendedFields;
3461
4278
  /**
3462
4279
  * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
4280
+ * @format GUID
3463
4281
  * @readonly
3464
4282
  */
3465
4283
  purchaseFlowId?: string | null;
@@ -3467,6 +4285,7 @@ export interface UpdateCheckout {
3467
4285
  * Additional settings for customization of the checkout process.
3468
4286
  *
3469
4287
  * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
4288
+ * @immutable
3470
4289
  */
3471
4290
  customSettings?: CustomSettings;
3472
4291
  /**
@@ -3479,6 +4298,7 @@ export interface UpdateCheckout {
3479
4298
  /**
3480
4299
  * The business location ID associated with the checkout.
3481
4300
  * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
4301
+ * @format GUID
3482
4302
  */
3483
4303
  businessLocationId?: string | null;
3484
4304
  }
@@ -3491,15 +4311,20 @@ export interface UpdateCheckoutOptions {
3491
4311
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3492
4312
  *
3493
4313
  * 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`.
4314
+ * @maxLength 1000
3494
4315
  */
3495
4316
  overrideCheckoutUrl?: string | null;
3496
- /** Catalog line items. */
4317
+ /**
4318
+ * Catalog line items.
4319
+ * @maxSize 300
4320
+ */
3497
4321
  lineItems?: LineItem[];
3498
4322
  /**
3499
4323
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
3500
4324
  *
3501
4325
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3502
4326
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4327
+ * @maxSize 300
3503
4328
  */
3504
4329
  customLineItems?: CustomLineItem[];
3505
4330
  }
@@ -3582,8 +4407,8 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOv
3582
4407
  * @param _id - Checkout ID.
3583
4408
  * @public
3584
4409
  * @requiredField _id
3585
- * @requiredField options.customLineItems.descriptionLines
3586
4410
  * @requiredField options.customLineItems.descriptionLines.name
4411
+ * @requiredField options.customLineItems.descriptionLines.value
3587
4412
  * @requiredField options.customLineItems.itemType
3588
4413
  * @requiredField options.customLineItems.productName
3589
4414
  * @requiredField options.customLineItems.quantity
@@ -3606,6 +4431,8 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOv
3606
4431
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3607
4432
  * @permissionScope Manage eCommerce - Admin Permissions
3608
4433
  * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
4434
+ * @permissionScope Manage Restaurants - all permissions
4435
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3609
4436
  * @permissionScope Manage eCommerce - all permissions
3610
4437
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3611
4438
  * @applicableIdentity APP
@@ -3614,13 +4441,17 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOv
3614
4441
  */
3615
4442
  export declare function addToCheckout(_id: string, options?: AddToCheckoutOptions): Promise<AddToCheckoutResponse & AddToCheckoutResponseNonNullableFields>;
3616
4443
  export interface AddToCheckoutOptions {
3617
- /** Catalog line items. */
4444
+ /**
4445
+ * Catalog line items.
4446
+ * @maxSize 100
4447
+ */
3618
4448
  lineItems?: LineItem[];
3619
4449
  /**
3620
4450
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
3621
4451
  *
3622
4452
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3623
4453
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4454
+ * @maxSize 100
3624
4455
  */
3625
4456
  customLineItems?: CustomLineItem[];
3626
4457
  }