@wix/auto_sdk_ecom_checkout 1.0.2 → 1.0.4

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 (45) 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.http.js +12 -0
  3. package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  4. package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  5. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +5 -0
  6. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  7. package/build/cjs/src/ecom-v1-checkout-checkout.types.d.ts +999 -228
  8. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  9. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1065 -248
  10. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +9 -4
  11. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  12. package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  13. package/build/es/src/ecom-v1-checkout-checkout.http.js +12 -0
  14. package/build/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  15. package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  16. package/build/es/src/ecom-v1-checkout-checkout.public.js +5 -0
  17. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  18. package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +999 -228
  19. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  20. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +1065 -248
  21. package/build/es/src/ecom-v1-checkout-checkout.universal.js +9 -4
  22. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  23. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  24. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +12 -0
  25. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  26. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  27. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +5 -0
  28. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  29. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +1009 -228
  30. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  31. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1089 -255
  32. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +9 -4
  33. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  34. package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  35. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +12 -0
  36. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  37. package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  38. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +5 -0
  39. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  40. package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +1009 -228
  41. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  42. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +1089 -255
  43. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +9 -4
  44. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  45. 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
  /**
@@ -150,10 +166,17 @@ export interface Checkout {
150
166
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
151
167
  */
152
168
  customContentReference?: CustomContentReference;
169
+ /**
170
+ * The business location ID associated with the checkout.
171
+ * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
172
+ * @format GUID
173
+ */
174
+ businessLocationId?: string | null;
153
175
  }
154
176
  export interface LineItem {
155
177
  /**
156
178
  * Line item ID.
179
+ * @format GUID
157
180
  * @readonly
158
181
  */
159
182
  _id?: string | null;
@@ -162,6 +185,8 @@ export interface LineItem {
162
185
  *
163
186
  * Min: `"1"`
164
187
  * Max: `"100000"`
188
+ * @min 1
189
+ * @max 100000
165
190
  */
166
191
  quantity?: number;
167
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. */
@@ -268,6 +293,8 @@ export interface LineItem {
268
293
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
269
294
  * + In most cases, this field has the same value as `catalogReference.catalogItemId`.
270
295
  * + Used in membership validation.
296
+ * @minLength 1
297
+ * @maxLength 36
271
298
  * @readonly
272
299
  */
273
300
  rootCatalogItemId?: string | null;
@@ -281,6 +308,12 @@ export interface LineItem {
281
308
  * @readonly
282
309
  */
283
310
  depositAmount?: MultiCurrencyPrice;
311
+ /**
312
+ * Delivery profile ID.
313
+ * @format GUID
314
+ * @readonly
315
+ */
316
+ deliveryProfileId?: string | null;
284
317
  /**
285
318
  * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
286
319
  * @readonly
@@ -288,6 +321,8 @@ export interface LineItem {
288
321
  customLineItem?: boolean;
289
322
  /**
290
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
291
326
  * @readonly
292
327
  */
293
328
  consentRequiredPaymentPolicy?: string | null;
@@ -308,7 +343,11 @@ export interface LineItem {
308
343
  }
309
344
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
310
345
  export interface CatalogReference {
311
- /** 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
+ */
312
351
  catalogItemId?: string;
313
352
  /**
314
353
  * ID of the app providing the catalog.
@@ -319,6 +358,7 @@ export interface CatalogReference {
319
358
  * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
320
359
  * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
321
360
  * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
361
+ * @minLength 1
322
362
  */
323
363
  appId?: string;
324
364
  /**
@@ -336,6 +376,8 @@ export interface ProductName {
336
376
  *
337
377
  * Min: 1 character.
338
378
  * Max: 200 characters.
379
+ * @minLength 1
380
+ * @maxLength 200
339
381
  */
340
382
  original?: string;
341
383
  /**
@@ -344,15 +386,21 @@ export interface ProductName {
344
386
  * Min: 1 character.
345
387
  * Max: 400 characters.
346
388
  * Default: Same as `original`.
389
+ * @minLength 1
390
+ * @maxLength 400
347
391
  */
348
392
  translated?: string | null;
349
393
  }
350
394
  export interface MultiCurrencyPrice {
351
- /** Amount. */
395
+ /**
396
+ * Amount.
397
+ * @decimalValue options { gte:0, lte:1000000000000000 }
398
+ */
352
399
  amount?: string;
353
400
  /**
354
401
  * Converted amount.
355
402
  * @readonly
403
+ * @decimalValue options { gte:0, lte:1000000000000000 }
356
404
  */
357
405
  convertedAmount?: string;
358
406
  /**
@@ -369,7 +417,10 @@ export interface MultiCurrencyPrice {
369
417
  export interface ItemTaxFullDetails {
370
418
  /** Amount for which tax is calculated. */
371
419
  taxableAmount?: MultiCurrencyPrice;
372
- /** 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
+ */
373
424
  taxRate?: string;
374
425
  /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
375
426
  totalTax?: MultiCurrencyPrice;
@@ -381,9 +432,15 @@ export interface ItemTaxFullDetails {
381
432
  rateBreakdown?: TaxRateBreakdown[];
382
433
  }
383
434
  export interface TaxRateBreakdown {
384
- /** Name of tax against which the calculation was performed. */
435
+ /**
436
+ * Name of tax against which the calculation was performed.
437
+ * @maxLength 100
438
+ */
385
439
  name?: string;
386
- /** 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
+ */
387
444
  rate?: string;
388
445
  /** Amount of tax for this tax detail. */
389
446
  tax?: MultiCurrencyPrice;
@@ -393,21 +450,31 @@ export interface TaxRateBreakdown {
393
450
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
394
451
  */
395
452
  export interface TaxBreakdown {
396
- /** 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
+ */
397
457
  jurisdiction?: string | null;
398
458
  /** The amount of this line item price that was considered nontaxable. (Decimal value) */
399
459
  nonTaxableAmount?: MultiCurrencyPrice;
400
- /** 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
+ */
401
464
  rate?: string | null;
402
465
  /** The amount of tax estimated for this line item. (Decimal value) */
403
466
  taxAmount?: MultiCurrencyPrice;
404
467
  /** The taxable amount of this line item. */
405
468
  taxableAmount?: MultiCurrencyPrice;
406
- /** 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
+ */
407
473
  taxType?: string | null;
408
474
  /**
409
475
  * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
410
476
  * This name should be explicit enough to allow the merchant to understand what tax was calculated.
477
+ * @maxLength 200
411
478
  */
412
479
  taxName?: string | null;
413
480
  /** The type of the jurisdiction in which this tax detail applies. */
@@ -441,32 +508,44 @@ export interface DescriptionLineValueOneOf {
441
508
  export interface DescriptionLineDescriptionLineValueOneOf {
442
509
  }
443
510
  export interface DescriptionLineName {
444
- /** 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
+ */
445
515
  original?: string;
446
516
  /**
447
517
  * Description line name translated into the buyer's language.
448
518
  *
449
519
  * Default: Same as `original`.
520
+ * @maxLength 200
450
521
  */
451
522
  translated?: string | null;
452
523
  }
453
524
  export interface PlainTextValue {
454
- /** 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
+ */
455
529
  original?: string;
456
530
  /**
457
531
  * Description line plain text value translated into the buyer's language.
458
532
  *
459
533
  * Default: Same as `original`.
534
+ * @maxLength 600
460
535
  */
461
536
  translated?: string | null;
462
537
  }
463
538
  export interface Color {
464
- /** 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
+ */
465
543
  original?: string;
466
544
  /**
467
545
  * Description line color name translated into the buyer's language.
468
546
  *
469
547
  * Default: Same as `original`.
548
+ * @maxLength 500
470
549
  */
471
550
  translated?: string | null;
472
551
  /** HEX or RGB color code for display. */
@@ -508,7 +587,10 @@ export declare enum ItemAvailabilityStatus {
508
587
  export interface PhysicalProperties {
509
588
  /** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
510
589
  weight?: number | null;
511
- /** 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
+ */
512
594
  sku?: string | null;
513
595
  /** Whether this line item is shippable. */
514
596
  shippable?: boolean;
@@ -561,11 +643,16 @@ export interface SubscriptionSettings {
561
643
  *
562
644
  * Default: `1`.
563
645
  * If SubscriptionFrequency is Day the minimum interval is 7
646
+ * @min 1
647
+ * @max 50
564
648
  */
565
649
  interval?: number | null;
566
650
  /** Whether subscription is renewed automatically at the end of each period. */
567
651
  autoRenewal?: boolean;
568
- /** 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
+ */
569
656
  billingCycles?: number | null;
570
657
  }
571
658
  /** Frequency unit of recurring payment */
@@ -579,29 +666,53 @@ export declare enum SubscriptionFrequency {
579
666
  export interface FreeTrialPeriod {
580
667
  /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
581
668
  frequency?: SubscriptionFrequency;
582
- /** interval of period */
669
+ /**
670
+ * interval of period
671
+ * @min 1
672
+ * @max 50
673
+ */
583
674
  interval?: number;
584
675
  }
585
676
  export interface Title {
586
- /** 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
+ */
587
682
  original?: string;
588
683
  /**
589
684
  * Subscription option name translated into the buyer's language.
590
685
  *
591
686
  * Default: Same as `original`.
687
+ * @minLength 1
688
+ * @maxLength 150
592
689
  */
593
690
  translated?: string | null;
594
691
  }
595
692
  export interface Description {
596
- /** Subscription option description. */
693
+ /**
694
+ * Subscription option description.
695
+ * @maxLength 500
696
+ */
597
697
  original?: string;
598
- /** Translated subscription option description. */
698
+ /**
699
+ * Translated subscription option description.
700
+ * @maxLength 500
701
+ */
599
702
  translated?: string | null;
600
703
  }
601
704
  export interface SecuredMedia {
602
- /** Media ID in Wix Media Manager. */
705
+ /**
706
+ * Media ID in Wix Media Manager.
707
+ * @minLength 1
708
+ * @maxLength 100
709
+ */
603
710
  _id?: string;
604
- /** Original filename. */
711
+ /**
712
+ * Original filename.
713
+ * @minLength 1
714
+ * @maxLength 1000
715
+ */
605
716
  fileName?: string;
606
717
  /** File type. */
607
718
  fileType?: FileType;
@@ -633,27 +744,46 @@ export interface ServiceProperties {
633
744
  * For example, the start time of a class.
634
745
  */
635
746
  scheduledDate?: Date | null;
636
- /** 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
+ */
637
752
  numberOfParticipants?: number | null;
638
753
  }
639
754
  export interface PriceDescription {
640
- /** __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
+ */
641
760
  original?: string;
642
761
  /**
643
762
  * Price description translated into the buyer's language.
644
763
  *
645
764
  * Default: Same as `original`.
765
+ * @minLength 1
766
+ * @maxLength 100
646
767
  */
647
768
  translated?: string | null;
648
769
  }
649
770
  export interface CatalogOverrideFields {
650
771
  /** Item name. */
651
772
  productName?: ProductName;
652
- /** Item price **after** discounts. */
773
+ /**
774
+ * Item price **after** discounts.
775
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
776
+ */
653
777
  price?: string | null;
654
- /** Item price **before** discounts. */
778
+ /**
779
+ * Item price **before** discounts.
780
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
781
+ */
655
782
  fullPrice?: string | null;
656
- /** 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
+ */
657
787
  descriptionLines?: DescriptionLine[];
658
788
  /** Physical properties of the item. */
659
789
  physicalProperties?: PhysicalProperties;
@@ -661,7 +791,11 @@ export interface CatalogOverrideFields {
661
791
  image?: string;
662
792
  /** Payment method selected for the item. */
663
793
  paymentOption?: PaymentOption;
664
- /** 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
+ */
665
799
  depositAmount?: string | null;
666
800
  /**
667
801
  * Whether to save the payment method on the order.
@@ -672,11 +806,9 @@ export interface CatalogOverrideFields {
672
806
  }
673
807
  export interface PaymentOption {
674
808
  /**
675
- * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
676
- * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
677
- * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When selected, `price` is `0`.
678
- * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
679
- * + `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`
680
812
  */
681
813
  value?: PaymentOptionType;
682
814
  }
@@ -707,9 +839,17 @@ export interface ExtendedFields {
707
839
  namespaces?: Record<string, Record<string, any>>;
708
840
  }
709
841
  export interface Policy {
710
- /** Policy title - should be translated */
842
+ /**
843
+ * Policy title - should be translated
844
+ * @minLength 1
845
+ * @maxLength 29
846
+ */
711
847
  title?: string | null;
712
- /** Policy content - should be translated */
848
+ /**
849
+ * Policy content - should be translated
850
+ * @minLength 1
851
+ * @maxLength 3000
852
+ */
713
853
  content?: string;
714
854
  }
715
855
  /** Billing Info and shipping details */
@@ -721,19 +861,37 @@ export interface AddressWithContact {
721
861
  }
722
862
  /** Physical address */
723
863
  export interface ApiAddress {
724
- /** 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
+ */
725
868
  country?: string | null;
726
- /** 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
+ */
727
873
  subdivision?: string | null;
728
- /** City name. */
874
+ /**
875
+ * City name.
876
+ * @maxLength 50
877
+ */
729
878
  city?: string | null;
730
- /** Postal or zip code. */
879
+ /**
880
+ * Postal or zip code.
881
+ * @maxLength 50
882
+ */
731
883
  postalCode?: string | null;
732
884
  /** Street address. */
733
885
  streetAddress?: StreetAddress;
734
- /** Main address line (usually street name and number). */
886
+ /**
887
+ * Main address line (usually street name and number).
888
+ * @maxLength 150
889
+ */
735
890
  addressLine1?: string | null;
736
- /** 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
+ */
737
895
  addressLine2?: string | null;
738
896
  /**
739
897
  * Country's full name.
@@ -760,13 +918,25 @@ export interface AddressLocation {
760
918
  }
761
919
  /** Full contact details for an address */
762
920
  export interface FullAddressContactDetails {
763
- /** First name. */
921
+ /**
922
+ * First name.
923
+ * @maxLength 100
924
+ */
764
925
  firstName?: string | null;
765
- /** Last name. */
926
+ /**
927
+ * Last name.
928
+ * @maxLength 100
929
+ */
766
930
  lastName?: string | null;
767
- /** Phone number. */
931
+ /**
932
+ * Phone number.
933
+ * @format PHONE
934
+ */
768
935
  phone?: string | null;
769
- /** Company name. */
936
+ /**
937
+ * Company name.
938
+ * @maxLength 1000
939
+ */
770
940
  company?: string | null;
771
941
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
772
942
  vatId?: CommonVatId;
@@ -808,11 +978,15 @@ export interface ShippingInfo {
808
978
  carrierServiceOptions?: CarrierServiceOption[];
809
979
  }
810
980
  export interface SelectedCarrierServiceOption {
811
- /** 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
+ */
812
985
  code?: string;
813
986
  /**
814
987
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
815
988
  * For example, "Standard" or "First-Class Package International".
989
+ * @maxLength 250
816
990
  * @readonly
817
991
  */
818
992
  title?: string;
@@ -833,17 +1007,29 @@ export interface SelectedCarrierServiceOption {
833
1007
  requestedShippingOption?: boolean;
834
1008
  /** Other charges */
835
1009
  otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
836
- /** This carrier's unique ID */
1010
+ /**
1011
+ * This carrier's unique ID
1012
+ * @format GUID
1013
+ */
837
1014
  carrierId?: string | null;
838
- /** 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
+ */
839
1019
  deliveryAllocations?: DeliveryAllocation[];
840
1020
  /** If the delivery solution is a partial and doesn't apply to all items. */
841
1021
  partial?: boolean | null;
842
1022
  }
843
1023
  export interface DeliveryLogistics {
844
- /** 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
+ */
845
1028
  deliveryTime?: string | null;
846
- /** 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
+ */
847
1033
  instructions?: string | null;
848
1034
  /** Pickup details. */
849
1035
  pickupDetails?: PickupDetails;
@@ -885,7 +1071,10 @@ export interface SelectedCarrierServiceOptionPrices {
885
1071
  export interface SelectedCarrierServiceOptionOtherCharge {
886
1072
  /** Type of additional cost. */
887
1073
  type?: ChargeType;
888
- /** 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
+ */
889
1078
  details?: string | null;
890
1079
  /** Price of added charge. */
891
1080
  cost?: SelectedCarrierServiceOptionPrices;
@@ -903,32 +1092,56 @@ export interface DeliveryAllocation {
903
1092
  applicableLineItems?: ApplicableLineItems;
904
1093
  }
905
1094
  export interface Carrier {
906
- /** The carrier app id */
1095
+ /**
1096
+ * The carrier app id
1097
+ * @format GUID
1098
+ */
907
1099
  appId?: string | null;
908
- /** 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
+ */
909
1104
  code?: string;
910
1105
  }
911
1106
  export interface Region {
912
- /** The delivery region id. */
1107
+ /**
1108
+ * The delivery region id.
1109
+ * @format GUID
1110
+ */
913
1111
  _id?: string | null;
914
- /** The delivery region name. */
1112
+ /**
1113
+ * The delivery region name.
1114
+ * @maxLength 100
1115
+ */
915
1116
  name?: string | null;
916
1117
  }
917
1118
  export interface ApplicableLineItems {
918
- /** 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
+ */
919
1125
  lineItemIds?: string[];
920
1126
  }
921
1127
  export interface ShippingRegion {
922
1128
  /**
923
1129
  * Shipping region ID.
1130
+ * @format GUID
924
1131
  * @readonly
925
1132
  */
926
1133
  _id?: string;
927
- /** Shipping region name. */
1134
+ /**
1135
+ * Shipping region name.
1136
+ * @maxLength 100
1137
+ */
928
1138
  name?: string;
929
1139
  }
930
1140
  export interface CarrierServiceOption {
931
- /** Carrier ID. */
1141
+ /**
1142
+ * Carrier ID.
1143
+ * @format GUID
1144
+ */
932
1145
  carrierId?: string;
933
1146
  /** Shipping options offered by this carrier for this request. */
934
1147
  shippingOptions?: ShippingOption[];
@@ -937,18 +1150,23 @@ export interface ShippingOption {
937
1150
  /**
938
1151
  * Unique code of provided shipping option like "usps_std_overnight".
939
1152
  * For legacy calculators this would be the UUID of the option.
1153
+ * @maxLength 100
940
1154
  */
941
1155
  code?: string;
942
1156
  /**
943
1157
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
944
1158
  * For example, "Standard" or "First-Class Package International".
1159
+ * @maxLength 250
945
1160
  */
946
1161
  title?: string;
947
1162
  /** Delivery logistics. */
948
1163
  logistics?: DeliveryLogistics;
949
1164
  /** Sipping price information. */
950
1165
  cost?: ShippingPrice;
951
- /** 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
+ */
952
1170
  deliveryAllocations?: DeliveryAllocation[];
953
1171
  /** If the delivery solution is a partial and doesn't apply to all items. */
954
1172
  partial?: boolean | null;
@@ -968,31 +1186,39 @@ export interface OtherCharge {
968
1186
  export interface BuyerInfo extends BuyerInfoIdOneOf {
969
1187
  /**
970
1188
  * Visitor ID - if the buyer is **not** a site member.
1189
+ * @format GUID
971
1190
  * @readonly
972
1191
  */
973
1192
  visitorId?: string;
974
1193
  /**
975
1194
  * Member ID - If the buyer is a site member.
1195
+ * @format GUID
976
1196
  * @readonly
977
1197
  */
978
1198
  memberId?: string;
979
1199
  /**
980
1200
  * Contact ID. For more information, see the Contacts API.
1201
+ * @format GUID
981
1202
  * @readonly
982
1203
  */
983
1204
  contactId?: string | null;
984
- /** Buyer email address. */
1205
+ /**
1206
+ * Buyer email address.
1207
+ * @format EMAIL
1208
+ */
985
1209
  email?: string | null;
986
1210
  }
987
1211
  /** @oneof */
988
1212
  export interface BuyerInfoIdOneOf {
989
1213
  /**
990
1214
  * Visitor ID - if the buyer is **not** a site member.
1215
+ * @format GUID
991
1216
  * @readonly
992
1217
  */
993
1218
  visitorId?: string;
994
1219
  /**
995
1220
  * Member ID - If the buyer is a site member.
1221
+ * @format GUID
996
1222
  * @readonly
997
1223
  */
998
1224
  memberId?: string;
@@ -1153,11 +1379,16 @@ export interface GiftCard {
1153
1379
  obfuscatedCode?: string;
1154
1380
  /** Gift card value. */
1155
1381
  amount?: MultiCurrencyPrice;
1156
- /** App ID of the gift card provider. */
1382
+ /**
1383
+ * App ID of the gift card provider.
1384
+ * @format GUID
1385
+ */
1157
1386
  appId?: string;
1158
1387
  /**
1159
1388
  * External ID in the gift card provider's system.
1160
1389
  * Used for integration and tracking across different platforms.
1390
+ * @minLength 1
1391
+ * @maxLength 50
1161
1392
  */
1162
1393
  externalId?: string | null;
1163
1394
  }
@@ -1172,6 +1403,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1172
1403
  discountType?: DiscountType;
1173
1404
  /**
1174
1405
  * IDs of the line items the discount applies to.
1406
+ * @format GUID
1175
1407
  * @deprecated IDs of line items the discount applies to.
1176
1408
  * @replacedBy line_items_discounts
1177
1409
  * @targetRemovalDate 2024-06-01
@@ -1206,11 +1438,18 @@ export interface Coupon {
1206
1438
  export interface MerchantDiscount {
1207
1439
  /** Discount value. */
1208
1440
  amount?: MultiCurrencyPrice;
1209
- /** 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
+ */
1210
1446
  percentage?: number | null;
1211
1447
  }
1212
1448
  export interface DiscountRule {
1213
- /** Discount rule ID */
1449
+ /**
1450
+ * Discount rule ID
1451
+ * @format GUID
1452
+ */
1214
1453
  _id?: string;
1215
1454
  /** Discount rule name */
1216
1455
  name?: DiscountRuleName;
@@ -1218,13 +1457,24 @@ export interface DiscountRule {
1218
1457
  amount?: MultiCurrencyPrice;
1219
1458
  }
1220
1459
  export interface DiscountRuleName {
1221
- /** 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
+ */
1222
1465
  original?: string;
1223
- /** 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
+ */
1224
1471
  translated?: string | null;
1225
1472
  }
1226
1473
  export interface LineItemDiscount {
1227
- /** ID of line item the discount applies to. */
1474
+ /**
1475
+ * ID of line item the discount applies to.
1476
+ * @format GUID
1477
+ */
1228
1478
  _id?: string;
1229
1479
  /** Discount value. */
1230
1480
  totalDiscountAmount?: MultiCurrencyPrice;
@@ -1232,9 +1482,17 @@ export interface LineItemDiscount {
1232
1482
  export interface CustomField {
1233
1483
  /** Custom field value. */
1234
1484
  value?: any;
1235
- /** Custom field title. */
1485
+ /**
1486
+ * Custom field title.
1487
+ * @minLength 1
1488
+ * @maxLength 500
1489
+ */
1236
1490
  title?: string;
1237
- /** Translated custom field title. */
1491
+ /**
1492
+ * Translated custom field title.
1493
+ * @minLength 1
1494
+ * @maxLength 500
1495
+ */
1238
1496
  translatedTitle?: string | null;
1239
1497
  }
1240
1498
  export declare enum WeightUnit {
@@ -1310,15 +1568,27 @@ export declare enum FallbackReason {
1310
1568
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1311
1569
  */
1312
1570
  export interface AggregatedTaxBreakdown {
1313
- /** 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
+ */
1314
1575
  taxName?: string;
1315
- /** 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
+ */
1316
1580
  taxType?: string;
1317
- /** 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
+ */
1318
1585
  jurisdiction?: string;
1319
1586
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1320
1587
  jurisdictionTypeEnum?: JurisdictionType;
1321
- /** 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
+ */
1322
1592
  rate?: string;
1323
1593
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1324
1594
  aggregatedTaxAmount?: MultiCurrencyPrice;
@@ -1361,13 +1631,23 @@ export interface CreatedBy extends CreatedByIdOneOf {
1361
1631
  /**
1362
1632
  * User ID - when the order was created by a Wix user on behalf of a buyer.
1363
1633
  * For example, via POS (point of service).
1634
+ * @format GUID
1364
1635
  */
1365
1636
  userId?: string;
1366
- /** 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
+ */
1367
1641
  memberId?: string;
1368
- /** 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
+ */
1369
1646
  visitorId?: string;
1370
- /** 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
+ */
1371
1651
  appId?: string;
1372
1652
  }
1373
1653
  /** @oneof */
@@ -1375,13 +1655,23 @@ export interface CreatedByIdOneOf {
1375
1655
  /**
1376
1656
  * User ID - when the order was created by a Wix user on behalf of a buyer.
1377
1657
  * For example, via POS (point of service).
1658
+ * @format GUID
1378
1659
  */
1379
1660
  userId?: string;
1380
- /** 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
+ */
1381
1665
  memberId?: string;
1382
- /** 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
+ */
1383
1670
  visitorId?: string;
1384
- /** 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
+ */
1385
1675
  appId?: string;
1386
1676
  }
1387
1677
  /** Reserved for internal use. */
@@ -1389,24 +1679,39 @@ export interface MembershipOptions {
1389
1679
  /**
1390
1680
  * Reserved for internal use.
1391
1681
  * @readonly
1682
+ * @maxSize 300
1392
1683
  */
1393
1684
  eligibleMemberships?: Membership[];
1394
1685
  /**
1395
1686
  * Reserved for internal use.
1396
1687
  * @readonly
1688
+ * @maxSize 300
1397
1689
  */
1398
1690
  invalidMemberships?: InvalidMembership[];
1399
1691
  /** Selected membership to apply to this checkout. */
1400
1692
  selectedMemberships?: SelectedMemberships;
1401
1693
  }
1402
1694
  export interface Membership {
1403
- /** Membership ID. */
1695
+ /**
1696
+ * Membership ID.
1697
+ * @minLength 1
1698
+ * @maxLength 100
1699
+ */
1404
1700
  _id?: string;
1405
- /** ID of the application providing this payment option. */
1701
+ /**
1702
+ * ID of the application providing this payment option.
1703
+ * @format GUID
1704
+ */
1406
1705
  appId?: string;
1407
1706
  /** The name of this membership. */
1408
1707
  name?: MembershipName;
1409
- /** 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
+ */
1410
1715
  lineItemIds?: string[];
1411
1716
  /** Optional - For a membership that has limited credits, information about credit usage. */
1412
1717
  credits?: MembershipPaymentCredits;
@@ -1416,13 +1721,22 @@ export interface Membership {
1416
1721
  additionalData?: Record<string, any> | null;
1417
1722
  }
1418
1723
  export interface MembershipName {
1419
- /** Membership name. */
1724
+ /**
1725
+ * Membership name.
1726
+ * @maxLength 100
1727
+ */
1420
1728
  original?: string;
1421
- /** Translated membership name. Defaults to `original` when not provided. */
1729
+ /**
1730
+ * Translated membership name. Defaults to `original` when not provided.
1731
+ * @maxLength 100
1732
+ */
1422
1733
  translated?: string | null;
1423
1734
  }
1424
1735
  export interface MembershipPaymentCredits {
1425
- /** Membership's total amount of credits. */
1736
+ /**
1737
+ * Membership's total amount of credits.
1738
+ * @min 1
1739
+ */
1426
1740
  total?: number;
1427
1741
  /** Membership's remaining amount of credits. */
1428
1742
  remaining?: number;
@@ -1430,31 +1744,63 @@ export interface MembershipPaymentCredits {
1430
1744
  export interface InvalidMembership {
1431
1745
  /** Membership details. */
1432
1746
  membership?: Membership;
1433
- /** 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
+ */
1434
1752
  reason?: string;
1435
1753
  }
1436
1754
  export interface SelectedMemberships {
1437
- /** Selected memberships. */
1755
+ /**
1756
+ * Selected memberships.
1757
+ * @maxSize 300
1758
+ */
1438
1759
  memberships?: SelectedMembership[];
1439
1760
  }
1440
1761
  export interface SelectedMembership {
1441
- /** Membership ID. */
1762
+ /**
1763
+ * Membership ID.
1764
+ * @minLength 1
1765
+ * @maxLength 100
1766
+ */
1442
1767
  _id?: string;
1443
- /** ID of the app providing this payment option. */
1768
+ /**
1769
+ * ID of the app providing this payment option.
1770
+ * @format GUID
1771
+ */
1444
1772
  appId?: string;
1445
- /** 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
+ */
1446
1780
  lineItemIds?: string[];
1447
1781
  }
1448
1782
  export interface AdditionalFee {
1449
- /** 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
+ */
1450
1788
  code?: string | null;
1451
- /** Translated additional fee's name. */
1789
+ /**
1790
+ * Translated additional fee's name.
1791
+ * @minLength 1
1792
+ * @maxLength 50
1793
+ */
1452
1794
  name?: string;
1453
1795
  /** Additional fee's price. */
1454
1796
  price?: MultiCurrencyPrice;
1455
1797
  /** Tax details. */
1456
1798
  taxDetails?: ItemTaxFullDetails;
1457
- /** Provider's app id. */
1799
+ /**
1800
+ * Provider's app id.
1801
+ * @minLength 1
1802
+ * @maxLength 100
1803
+ */
1458
1804
  providerAppId?: string | null;
1459
1805
  /** Additional fee's price before tax. */
1460
1806
  priceBeforeTax?: MultiCurrencyPrice;
@@ -1463,6 +1809,7 @@ export interface AdditionalFee {
1463
1809
  /**
1464
1810
  * Optional - Line items associated with this additional fee.
1465
1811
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1812
+ * @format GUID
1466
1813
  */
1467
1814
  lineItemIds?: string[];
1468
1815
  /** the source the additional fee was added from */
@@ -1481,11 +1828,13 @@ export interface ConversionInfo {
1481
1828
  /**
1482
1829
  * The site currency.
1483
1830
  * @readonly
1831
+ * @format CURRENCY
1484
1832
  */
1485
1833
  siteCurrency?: string;
1486
1834
  /**
1487
1835
  * The rate used when converting from the site currency to the checkout currency.
1488
1836
  * @readonly
1837
+ * @decimalValue options { gt:0, lte:1000000000000000 }
1489
1838
  */
1490
1839
  conversionRate?: string;
1491
1840
  }
@@ -1494,7 +1843,11 @@ export interface Violation {
1494
1843
  severity?: Severity;
1495
1844
  /** Target location on a checkout or cart page where the violation will be displayed. */
1496
1845
  target?: Target;
1497
- /** 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
+ */
1498
1851
  description?: string | null;
1499
1852
  }
1500
1853
  export declare enum Severity {
@@ -1578,12 +1931,14 @@ export interface CustomContentReference {
1578
1931
  * ID of the app providing the content.
1579
1932
  *
1580
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
1581
1935
  */
1582
1936
  appId?: string;
1583
1937
  /**
1584
1938
  * ID of the component within the app it belongs to.
1585
1939
  *
1586
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
1587
1942
  */
1588
1943
  componentId?: string;
1589
1944
  }
@@ -1591,14 +1946,49 @@ export interface ExternalReference {
1591
1946
  /**
1592
1947
  * ID of the app associated with the purchase flow.
1593
1948
  * For example, the Wix Pay Links app ID.
1949
+ * @format GUID
1950
+ * @immutable
1594
1951
  */
1595
1952
  appId?: string;
1596
1953
  /**
1597
1954
  * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
1598
1955
  * For example, a Wix Pay Link ID.
1956
+ * @minLength 1
1957
+ * @maxLength 100
1958
+ * @immutable
1599
1959
  */
1600
1960
  resourceId?: string | null;
1601
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
+ }
1602
1992
  export interface UpdatedCheckoutMessage {
1603
1993
  /** Previous checkout. */
1604
1994
  oldCheckout?: Checkout;
@@ -1610,28 +2000,20 @@ export interface CreateCheckoutRequest {
1610
2000
  checkoutInfo?: Checkout;
1611
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). */
1612
2002
  couponCode?: string | null;
1613
- /** Catalog line items to add to the checkout. */
2003
+ /**
2004
+ * Catalog line items to add to the checkout.
2005
+ * @maxSize 300
2006
+ */
1614
2007
  lineItems?: LineItem[];
1615
2008
  /**
1616
2009
  * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
1617
2010
  *
1618
2011
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1619
2012
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2013
+ * @maxSize 300
1620
2014
  */
1621
2015
  customLineItems?: CustomLineItem[];
1622
- /**
1623
- * Sales channel that submitted the order.
1624
- * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
1625
- * + `"WEB"`: A web client.
1626
- * + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
1627
- * + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
1628
- * + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
1629
- * + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
1630
- * + `"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)
1631
- * + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
1632
- * + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
1633
- * + `"OTHER_PLATFORM"`: Other sales platform.
1634
- */
2016
+ /** Sales channel that submitted the order. */
1635
2017
  channelType: ChannelType;
1636
2018
  /**
1637
2019
  * Gift card code.
@@ -1645,6 +2027,7 @@ export interface CreateCheckoutRequest {
1645
2027
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
1646
2028
  *
1647
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
1648
2031
  */
1649
2032
  overrideCheckoutUrl?: string | null;
1650
2033
  }
@@ -1654,13 +2037,22 @@ export interface CustomLineItem {
1654
2037
  *
1655
2038
  * Min: `1`
1656
2039
  * Max: `100000`
2040
+ * @min 1
2041
+ * @max 100000
1657
2042
  */
1658
2043
  quantity?: number;
1659
- /** 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
+ */
1660
2049
  price?: string;
1661
2050
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1662
2051
  priceDescription?: PriceDescription;
1663
- /** 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
+ */
1664
2056
  descriptionLines?: DescriptionLine[];
1665
2057
  /**
1666
2058
  * Custom line item media.
@@ -1672,9 +2064,13 @@ export interface CustomLineItem {
1672
2064
  * Custom line item ID. If passed, `id` must be unique.
1673
2065
  *
1674
2066
  * Default: auto-generated ID
2067
+ * @format GUID
1675
2068
  */
1676
2069
  _id?: string | null;
1677
- /** Tax group ID for this custom line item. */
2070
+ /**
2071
+ * Tax group ID for this custom line item.
2072
+ * @format GUID
2073
+ */
1678
2074
  taxGroupId?: string | null;
1679
2075
  /** Name of the item or product. */
1680
2076
  productName?: ProductName;
@@ -1682,11 +2078,15 @@ export interface CustomLineItem {
1682
2078
  url?: string;
1683
2079
  /** Item type. Either a preset type or custom. */
1684
2080
  itemType?: ItemType;
1685
- /** 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
+ */
1686
2085
  fullPrice?: string | null;
1687
2086
  /**
1688
2087
  * Item quantity available for purchase. Only return this if inventory is managed.
1689
2088
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
2089
+ * @max 100000
1690
2090
  */
1691
2091
  quantityAvailable?: number | null;
1692
2092
  /** Physical properties of the item. */
@@ -1711,6 +2111,8 @@ export interface CustomLineItem {
1711
2111
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
1712
2112
  * + In most cases, this field is the same as `catalogReference.catalogItemId`.
1713
2113
  * + Used in membership validation.
2114
+ * @minLength 1
2115
+ * @maxLength 36
1714
2116
  */
1715
2117
  rootCatalogItemId?: string | null;
1716
2118
  /**
@@ -1718,12 +2120,20 @@ export interface CustomLineItem {
1718
2120
  *
1719
2121
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
1720
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
1721
2124
  */
1722
2125
  depositAmount?: string | null;
2126
+ /**
2127
+ * Delivery profile ID.
2128
+ * @format GUID
2129
+ */
2130
+ deliveryProfileId?: string | null;
1723
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. */
1724
2132
  catalogReference?: CatalogReference;
1725
2133
  /**
1726
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
1727
2137
  * @readonly
1728
2138
  */
1729
2139
  consentRequiredPaymentPolicy?: string | null;
@@ -1736,9 +2146,16 @@ export interface CustomLineItem {
1736
2146
  savePaymentMethod?: boolean;
1737
2147
  }
1738
2148
  export interface MerchantDiscountInput {
1739
- /** Discount amount. */
2149
+ /**
2150
+ * Discount amount.
2151
+ * @decimalValue options { gte:0 }
2152
+ */
1740
2153
  amount?: string;
1741
- /** 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
+ */
1742
2159
  lineItemIds?: string[];
1743
2160
  }
1744
2161
  export interface CreateCheckoutResponse {
@@ -1755,7 +2172,10 @@ export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
1755
2172
  carrierErrors?: CarrierErrors;
1756
2173
  }
1757
2174
  export interface GetCheckoutRequest {
1758
- /** Checkout ID. */
2175
+ /**
2176
+ * Checkout ID.
2177
+ * @format GUID
2178
+ */
1759
2179
  _id: string;
1760
2180
  }
1761
2181
  export interface GetCheckoutResponse {
@@ -1763,7 +2183,10 @@ export interface GetCheckoutResponse {
1763
2183
  checkout?: Checkout;
1764
2184
  }
1765
2185
  export interface GetCheckoutWithAllExtendedFieldsRequest {
1766
- /** Checkout ID. */
2186
+ /**
2187
+ * Checkout ID.
2188
+ * @format GUID
2189
+ */
1767
2190
  _id?: string;
1768
2191
  }
1769
2192
  export interface GetCheckoutWithAllExtendedFieldsResponse {
@@ -1771,7 +2194,10 @@ export interface GetCheckoutWithAllExtendedFieldsResponse {
1771
2194
  checkout?: Checkout;
1772
2195
  }
1773
2196
  export interface GetCheckoutByCartIdRequest {
1774
- /** Cart ID. */
2197
+ /**
2198
+ * Cart ID.
2199
+ * @format GUID
2200
+ */
1775
2201
  _id: string;
1776
2202
  }
1777
2203
  export interface GetCheckoutByCartIdResponse {
@@ -1779,7 +2205,10 @@ export interface GetCheckoutByCartIdResponse {
1779
2205
  checkout?: Checkout;
1780
2206
  }
1781
2207
  export interface GetWixCheckoutURLRequest {
1782
- /** Checkout ID. */
2208
+ /**
2209
+ * Checkout ID.
2210
+ * @format GUID
2211
+ */
1783
2212
  _id: string;
1784
2213
  }
1785
2214
  export interface GetWixCheckoutURLResponse {
@@ -1787,7 +2216,10 @@ export interface GetWixCheckoutURLResponse {
1787
2216
  checkoutUrl?: string;
1788
2217
  }
1789
2218
  export interface GetCheckoutURLRequest {
1790
- /** Checkout ID. */
2219
+ /**
2220
+ * Checkout ID.
2221
+ * @format GUID
2222
+ */
1791
2223
  _id: string;
1792
2224
  }
1793
2225
  export interface GetCheckoutURLResponse {
@@ -1805,15 +2237,20 @@ export interface UpdateCheckoutRequest {
1805
2237
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
1806
2238
  *
1807
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
1808
2241
  */
1809
2242
  overrideCheckoutUrl?: string | null;
1810
- /** Catalog line items. */
2243
+ /**
2244
+ * Catalog line items.
2245
+ * @maxSize 300
2246
+ */
1811
2247
  lineItems?: LineItem[];
1812
2248
  /**
1813
2249
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1814
2250
  *
1815
2251
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1816
2252
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2253
+ * @maxSize 300
1817
2254
  */
1818
2255
  customLineItems?: CustomLineItem[];
1819
2256
  }
@@ -1822,7 +2259,10 @@ export interface UpdateCheckoutResponse {
1822
2259
  checkout?: Checkout;
1823
2260
  }
1824
2261
  export interface RemoveCouponRequest {
1825
- /** ID of the checkout to remove the coupon from. */
2262
+ /**
2263
+ * ID of the checkout to remove the coupon from.
2264
+ * @format GUID
2265
+ */
1826
2266
  _id: string;
1827
2267
  }
1828
2268
  export interface RemoveCouponResponse {
@@ -1830,7 +2270,10 @@ export interface RemoveCouponResponse {
1830
2270
  checkout?: Checkout;
1831
2271
  }
1832
2272
  export interface RemoveGiftCardRequest {
1833
- /** 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
+ */
1834
2277
  _id: string;
1835
2278
  }
1836
2279
  export interface RemoveGiftCardResponse {
@@ -1838,7 +2281,10 @@ export interface RemoveGiftCardResponse {
1838
2281
  checkout?: Checkout;
1839
2282
  }
1840
2283
  export interface RemoveOverrideCheckoutUrlRequest {
1841
- /** 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
+ */
1842
2288
  _id: string;
1843
2289
  }
1844
2290
  export interface RemoveOverrideCheckoutUrlResponse {
@@ -1846,15 +2292,22 @@ export interface RemoveOverrideCheckoutUrlResponse {
1846
2292
  checkout?: Checkout;
1847
2293
  }
1848
2294
  export interface AddToCheckoutRequest {
1849
- /** Checkout ID. */
2295
+ /**
2296
+ * Checkout ID.
2297
+ * @format GUID
2298
+ */
1850
2299
  _id: string;
1851
- /** Catalog line items. */
2300
+ /**
2301
+ * Catalog line items.
2302
+ * @maxSize 100
2303
+ */
1852
2304
  lineItems?: LineItem[];
1853
2305
  /**
1854
2306
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1855
2307
  *
1856
2308
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1857
2309
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2310
+ * @maxSize 100
1858
2311
  */
1859
2312
  customLineItems?: CustomLineItem[];
1860
2313
  }
@@ -1863,9 +2316,17 @@ export interface AddToCheckoutResponse {
1863
2316
  checkout?: Checkout;
1864
2317
  }
1865
2318
  export interface RemoveLineItemsRequest {
1866
- /** ID of the checkout to remove line items from. */
2319
+ /**
2320
+ * ID of the checkout to remove line items from.
2321
+ * @format GUID
2322
+ */
1867
2323
  _id: string;
1868
- /** 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
+ */
1869
2330
  lineItemIds: string[];
1870
2331
  }
1871
2332
  export interface RemoveLineItemsResponse {
@@ -1873,7 +2334,10 @@ export interface RemoveLineItemsResponse {
1873
2334
  checkout?: Checkout;
1874
2335
  }
1875
2336
  export interface CreateOrderRequest {
1876
- /** Checkout ID. */
2337
+ /**
2338
+ * Checkout ID.
2339
+ * @format GUID
2340
+ */
1877
2341
  _id: string;
1878
2342
  /** Indicates the payment method should be saved on the order */
1879
2343
  savePaymentMethod?: boolean;
@@ -1881,9 +2345,15 @@ export interface CreateOrderRequest {
1881
2345
  delayCapture?: boolean;
1882
2346
  }
1883
2347
  export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
1884
- /** ID of the newly created order. */
2348
+ /**
2349
+ * ID of the newly created order.
2350
+ * @format GUID
2351
+ */
1885
2352
  orderId?: string;
1886
- /** 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
+ */
1887
2357
  subscriptionId?: string;
1888
2358
  /**
1889
2359
  * Payment gateway order ID.
@@ -1898,9 +2368,15 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
1898
2368
  }
1899
2369
  /** @oneof */
1900
2370
  export interface CreateOrderResponseIdOneOf {
1901
- /** ID of newly created order. */
2371
+ /**
2372
+ * ID of newly created order.
2373
+ * @format GUID
2374
+ */
1902
2375
  orderId?: string;
1903
- /** 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
+ */
1904
2380
  subscriptionId?: string;
1905
2381
  }
1906
2382
  export interface PaymentErrorResponseData {
@@ -1909,12 +2385,16 @@ export interface PaymentErrorResponseData {
1909
2385
  failureDetails?: string | null;
1910
2386
  }
1911
2387
  export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2388
+ /** @format GUID */
1912
2389
  orderId?: string;
2390
+ /** @format GUID */
1913
2391
  subscriptionId?: string;
1914
2392
  }
1915
2393
  /** @oneof */
1916
2394
  export interface DoublePaymentErrorDataIdOneOf {
2395
+ /** @format GUID */
1917
2396
  orderId?: string;
2397
+ /** @format GUID */
1918
2398
  subscriptionId?: string;
1919
2399
  }
1920
2400
  export interface RedeemErrorData {
@@ -1925,7 +2405,10 @@ export interface ViolationsList {
1925
2405
  violations?: Violation[];
1926
2406
  }
1927
2407
  export interface CreateOrderAndChargeRequest {
1928
- /** Checkout ID. */
2408
+ /**
2409
+ * Checkout ID.
2410
+ * @format GUID
2411
+ */
1929
2412
  _id: string;
1930
2413
  /** Payment token. */
1931
2414
  paymentToken?: string | null;
@@ -1935,9 +2418,15 @@ export interface CreateOrderAndChargeRequest {
1935
2418
  delayCapture?: boolean;
1936
2419
  }
1937
2420
  export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
1938
- /** ID of newly created order. */
2421
+ /**
2422
+ * ID of newly created order.
2423
+ * @format GUID
2424
+ */
1939
2425
  orderId?: string;
1940
- /** ID of newly created subscription. */
2426
+ /**
2427
+ * ID of newly created subscription.
2428
+ * @format GUID
2429
+ */
1941
2430
  subscriptionId?: string;
1942
2431
  /** Payment response token. */
1943
2432
  paymentResponseToken?: string | null;
@@ -1953,13 +2442,22 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
1953
2442
  }
1954
2443
  /** @oneof */
1955
2444
  export interface CreateOrderAndChargeResponseIdOneOf {
1956
- /** ID of newly created order. */
2445
+ /**
2446
+ * ID of newly created order.
2447
+ * @format GUID
2448
+ */
1957
2449
  orderId?: string;
1958
- /** ID of newly created subscription. */
2450
+ /**
2451
+ * ID of newly created subscription.
2452
+ * @format GUID
2453
+ */
1959
2454
  subscriptionId?: string;
1960
2455
  }
1961
2456
  export interface MarkCheckoutAsCompletedRequest {
1962
- /** Checkout ID. */
2457
+ /**
2458
+ * Checkout ID.
2459
+ * @format GUID
2460
+ */
1963
2461
  _id: string;
1964
2462
  }
1965
2463
  export interface MarkCheckoutAsCompletedResponse {
@@ -1969,13 +2467,23 @@ export interface CheckoutMarkedAsCompleted {
1969
2467
  checkout?: Checkout;
1970
2468
  }
1971
2469
  export interface UpdateLineItemsQuantityRequest {
1972
- /** Checkout ID. */
2470
+ /**
2471
+ * Checkout ID.
2472
+ * @format GUID
2473
+ */
1973
2474
  _id: string;
1974
- /** Line item info to update. */
2475
+ /**
2476
+ * Line item info to update.
2477
+ * @minSize 1
2478
+ * @maxSize 100
2479
+ */
1975
2480
  lineItems: LineItemQuantityUpdate[];
1976
2481
  }
1977
2482
  export interface LineItemQuantityUpdate {
1978
- /** ID of the line item to update. */
2483
+ /**
2484
+ * ID of the line item to update.
2485
+ * @format GUID
2486
+ */
1979
2487
  _id?: string;
1980
2488
  /**
1981
2489
  * New total amount of the line item,
@@ -1984,6 +2492,8 @@ export interface LineItemQuantityUpdate {
1984
2492
  * Min: `1`
1985
2493
  *
1986
2494
  * Max: `100000`
2495
+ * @min 1
2496
+ * @max 100000
1987
2497
  */
1988
2498
  quantity?: number;
1989
2499
  }
@@ -1992,7 +2502,10 @@ export interface UpdateLineItemsQuantityResponse {
1992
2502
  checkout?: Checkout;
1993
2503
  }
1994
2504
  export interface GetCheckoutPaymentSettingsRequest {
1995
- /** Checkout ID. */
2505
+ /**
2506
+ * Checkout ID.
2507
+ * @format GUID
2508
+ */
1996
2509
  _id: string;
1997
2510
  }
1998
2511
  export interface GetCheckoutPaymentSettingsResponse {
@@ -2003,7 +2516,10 @@ export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2003
2516
  MANUAL = "MANUAL"
2004
2517
  }
2005
2518
  export interface DeleteCheckoutRequest {
2006
- /** ID of the checkout to delete. */
2519
+ /**
2520
+ * ID of the checkout to delete.
2521
+ * @format GUID
2522
+ */
2007
2523
  _id?: string;
2008
2524
  }
2009
2525
  export interface DeleteCheckoutResponse {
@@ -2017,20 +2533,33 @@ export interface Subscription {
2017
2533
  * @readonly
2018
2534
  */
2019
2535
  _id?: string;
2020
- /** id of subscription in external system */
2536
+ /**
2537
+ * id of subscription in external system
2538
+ * @format GUID
2539
+ */
2021
2540
  externalId?: string | null;
2022
2541
  /**
2023
2542
  * Subscription creation date
2024
2543
  * @readonly
2025
2544
  */
2026
2545
  dateCreated?: Date | null;
2027
- /** The id of the cart this order was created from */
2546
+ /**
2547
+ * The id of the cart this order was created from
2548
+ * @format GUID
2549
+ */
2028
2550
  cartId?: string | null;
2029
- /** The id of the checkout this subscriptions was created from */
2551
+ /**
2552
+ * The id of the checkout this subscriptions was created from
2553
+ * @format GUID
2554
+ */
2030
2555
  checkoutId?: string | null;
2031
2556
  /** member or contact */
2032
2557
  buyerInfo?: V1BuyerInfo;
2033
- /** Line items ordered */
2558
+ /**
2559
+ * Line items ordered
2560
+ * @minSize 1
2561
+ * @maxSize 1
2562
+ */
2034
2563
  lineItems?: V1LineItem[];
2035
2564
  /** Totals for subscription's line items */
2036
2565
  totals?: Totals;
@@ -2042,7 +2571,10 @@ export interface Subscription {
2042
2571
  shippingInfo?: V1ShippingInfo;
2043
2572
  /** Coupon that was applied to subscription */
2044
2573
  appliedCoupon?: AppliedCoupon;
2045
- /** Message from the customer (e.g., customization request) */
2574
+ /**
2575
+ * Message from the customer (e.g., customization request)
2576
+ * @maxLength 1000
2577
+ */
2046
2578
  buyerNote?: string | null;
2047
2579
  /** Custom field */
2048
2580
  customField?: V1CustomField;
@@ -2060,7 +2592,10 @@ export interface Subscription {
2060
2592
  }
2061
2593
  /** Buyer Info */
2062
2594
  export interface V1BuyerInfo {
2063
- /** Wix customer ID */
2595
+ /**
2596
+ * Wix customer ID
2597
+ * @format GUID
2598
+ */
2064
2599
  _id?: string;
2065
2600
  /** Customer type */
2066
2601
  identityType?: IdentityType;
@@ -2075,13 +2610,26 @@ export declare enum IdentityType {
2075
2610
  export interface V1LineItem {
2076
2611
  /** Line item ID (auto-generated) */
2077
2612
  index?: number;
2078
- /** Line item quantity */
2613
+ /**
2614
+ * Line item quantity
2615
+ * @min 1
2616
+ * @max 100000
2617
+ */
2079
2618
  quantity?: number;
2080
- /** Line item variantId (from Stores Catalog) */
2619
+ /**
2620
+ * Line item variantId (from Stores Catalog)
2621
+ * @format GUID
2622
+ */
2081
2623
  variantId?: string | null;
2082
- /** Line item options ordered */
2624
+ /**
2625
+ * Line item options ordered
2626
+ * @maxSize 6
2627
+ */
2083
2628
  options?: OptionSelection[];
2084
- /** Line item custom text field selections */
2629
+ /**
2630
+ * Line item custom text field selections
2631
+ * @maxSize 20
2632
+ */
2085
2633
  customTextFields?: CustomTextFieldSelection[];
2086
2634
  /** Charges details */
2087
2635
  chargeDetails?: ChargeDetails;
@@ -2089,53 +2637,109 @@ export interface V1LineItem {
2089
2637
  productDetails?: ProductDetails;
2090
2638
  }
2091
2639
  export interface OptionSelection {
2092
- /** Option name */
2640
+ /**
2641
+ * Option name
2642
+ * @maxLength 200
2643
+ */
2093
2644
  option?: string;
2094
- /** Selected choice for this option */
2645
+ /**
2646
+ * Selected choice for this option
2647
+ * @maxLength 500
2648
+ */
2095
2649
  selection?: string;
2096
2650
  }
2097
2651
  export interface CustomTextFieldSelection {
2098
- /** Custom text field name */
2652
+ /**
2653
+ * Custom text field name
2654
+ * @maxLength 100
2655
+ */
2099
2656
  title?: string;
2100
- /** Custom text field value */
2657
+ /**
2658
+ * Custom text field value
2659
+ * @maxLength 500
2660
+ */
2101
2661
  value?: string;
2102
2662
  }
2103
2663
  export interface ChargeDetails {
2104
- /** price of line item (depends on subscription option) */
2664
+ /**
2665
+ * price of line item (depends on subscription option)
2666
+ * @max 999999999.99
2667
+ */
2105
2668
  price?: number;
2106
- /** Total price charged to the customer (for this line items) after computation of quantity and discount */
2669
+ /**
2670
+ * Total price charged to the customer (for this line items) after computation of quantity and discount
2671
+ * @max 999999999.99
2672
+ */
2107
2673
  totalPrice?: number | null;
2108
- /** Discount applied for this line item */
2674
+ /**
2675
+ * Discount applied for this line item
2676
+ * @max 999999999.99
2677
+ */
2109
2678
  discount?: number | null;
2110
- /** Tax applied for this line item */
2679
+ /**
2680
+ * Tax applied for this line item
2681
+ * @max 999999999.99
2682
+ */
2111
2683
  tax?: number | null;
2112
2684
  /** Is tax applied for this line item */
2113
2685
  taxIncludedInPrice?: boolean;
2114
- /** Tax rate %, as a decimal point >= 0 */
2686
+ /**
2687
+ * Tax rate %, as a decimal point >= 0
2688
+ * @decimalValue options { maxScale:6, gte:0 }
2689
+ */
2115
2690
  taxRate?: string | null;
2116
2691
  }
2117
2692
  export interface ProductDetails {
2118
- /** Line item product ID (optional for POS orders) */
2693
+ /**
2694
+ * Line item product ID (optional for POS orders)
2695
+ * @minLength 1
2696
+ */
2119
2697
  productId?: string | null;
2120
- /** Line item name */
2698
+ /**
2699
+ * Line item name
2700
+ * @minLength 1
2701
+ * @maxLength 100
2702
+ */
2121
2703
  name?: string;
2122
- /** Line item name translated to buyer's language */
2704
+ /**
2705
+ * Line item name translated to buyer's language
2706
+ * @minLength 1
2707
+ * @maxLength 100
2708
+ */
2123
2709
  translatedName?: string | null;
2124
2710
  /** Line item type (may be extended) */
2125
2711
  lineItemType?: LineItemType;
2126
2712
  /** Line item primary media for preview */
2127
2713
  mediaItem?: MediaItem;
2128
- /** Line item SKU */
2714
+ /**
2715
+ * Line item SKU
2716
+ * @maxLength 40
2717
+ */
2129
2718
  sku?: string | null;
2130
- /** Line item weight */
2719
+ /**
2720
+ * Line item weight
2721
+ * @max 999999999.99
2722
+ */
2131
2723
  weight?: number | null;
2132
- /** Line item notes */
2724
+ /**
2725
+ * Line item notes
2726
+ * @maxLength 1000
2727
+ */
2133
2728
  notes?: string | null;
2134
- /** Line item fulfillerId from stores fulfillers. No value means self fulfilled */
2729
+ /**
2730
+ * Line item fulfillerId from stores fulfillers. No value means self fulfilled
2731
+ * @format GUID
2732
+ */
2135
2733
  fulfillerId?: string | null;
2136
- /** Tax group id */
2734
+ /**
2735
+ * Tax group id
2736
+ * @format GUID
2737
+ */
2137
2738
  taxGroupId?: string | null;
2138
- /** App id from the catalog reference */
2739
+ /**
2740
+ * App id from the catalog reference
2741
+ * @format GUID
2742
+ */
2139
2743
  appId?: string | null;
2140
2744
  }
2141
2745
  export declare enum LineItemType {
@@ -2156,16 +2760,19 @@ export interface MediaItem {
2156
2760
  mediaType?: MediaItemType;
2157
2761
  /**
2158
2762
  * Media URL
2763
+ * @format WEB_URL
2159
2764
  * @readonly
2160
2765
  */
2161
2766
  url?: string;
2162
2767
  /**
2163
2768
  * Media item width
2769
+ * @max 5000
2164
2770
  * @readonly
2165
2771
  */
2166
2772
  width?: number;
2167
2773
  /**
2168
2774
  * Media item height
2775
+ * @max 5000
2169
2776
  * @readonly
2170
2777
  */
2171
2778
  height?: number;
@@ -2173,7 +2780,10 @@ export interface MediaItem {
2173
2780
  _id?: string | null;
2174
2781
  /** Media external URL */
2175
2782
  externalImageUrl?: string | null;
2176
- /** Alternative text for presentation when media cannot be displayed */
2783
+ /**
2784
+ * Alternative text for presentation when media cannot be displayed
2785
+ * @maxLength 256
2786
+ */
2177
2787
  altText?: string | null;
2178
2788
  }
2179
2789
  export declare enum MediaItemType {
@@ -2183,17 +2793,35 @@ export declare enum MediaItemType {
2183
2793
  IMAGE = "IMAGE"
2184
2794
  }
2185
2795
  export interface Totals {
2186
- /** Subtotal of all line items, before tax */
2796
+ /**
2797
+ * Subtotal of all line items, before tax
2798
+ * @max 999999999.99
2799
+ */
2187
2800
  subtotal?: number;
2188
- /** Total shipping price, including tax */
2801
+ /**
2802
+ * Total shipping price, including tax
2803
+ * @max 999999999.99
2804
+ */
2189
2805
  shipping?: number;
2190
- /** Total tax */
2806
+ /**
2807
+ * Total tax
2808
+ * @max 999999999.99
2809
+ */
2191
2810
  tax?: number;
2192
- /** Total calculated discount value */
2811
+ /**
2812
+ * Total calculated discount value
2813
+ * @max 999999999.99
2814
+ */
2193
2815
  discount?: number;
2194
- /** Total price */
2816
+ /**
2817
+ * Total price
2818
+ * @max 999999999.99
2819
+ */
2195
2820
  total?: number;
2196
- /** Total weight */
2821
+ /**
2822
+ * Total weight
2823
+ * @max 999999999.99
2824
+ */
2197
2825
  weight?: number | null;
2198
2826
  /**
2199
2827
  * Total line items quantity
@@ -2202,7 +2830,11 @@ export interface Totals {
2202
2830
  quantity?: number;
2203
2831
  }
2204
2832
  export interface StoreSettings {
2205
- /** Currency used for pricing in this store */
2833
+ /**
2834
+ * Currency used for pricing in this store
2835
+ * @maxLength 3
2836
+ * @format CURRENCY
2837
+ */
2206
2838
  currency?: string | null;
2207
2839
  /** Weight unit used in this store */
2208
2840
  weightUnit?: WeightUnit;
@@ -2210,56 +2842,103 @@ export interface StoreSettings {
2210
2842
  * The language to be used when communicating with the buyer
2211
2843
  * For a site that support multiple languages, this would be the language the buyer selected
2212
2844
  * Otherwise this would be the site language
2845
+ * @minLength 2
2846
+ * @maxLength 2
2213
2847
  */
2214
2848
  buyerLanguage?: string | null;
2215
2849
  }
2216
2850
  export interface Address extends AddressAddressLine1OptionsOneOf {
2217
- /** Address line 1 (free text) */
2851
+ /**
2852
+ * Address line 1 (free text)
2853
+ * @maxLength 1000
2854
+ */
2218
2855
  addressLine1?: string;
2219
2856
  /** Address line 1 (street) */
2220
2857
  street?: Street;
2221
2858
  /** Addressee name */
2222
2859
  fullName?: FullName;
2223
- /** Country code (2 letters) */
2860
+ /**
2861
+ * Country code (2 letters)
2862
+ * @format COUNTRY
2863
+ */
2224
2864
  country?: string | null;
2225
- /** State or district */
2865
+ /**
2866
+ * State or district
2867
+ * @maxLength 50
2868
+ */
2226
2869
  subdivision?: string | null;
2227
- /** City name */
2870
+ /**
2871
+ * City name
2872
+ * @maxLength 150
2873
+ */
2228
2874
  city?: string | null;
2229
- /** ZIP/postal code */
2875
+ /**
2876
+ * ZIP/postal code
2877
+ * @maxLength 200
2878
+ */
2230
2879
  zipCode?: string | null;
2231
- /** Phone number */
2880
+ /**
2881
+ * Phone number
2882
+ * @maxLength 200
2883
+ */
2232
2884
  phone?: string | null;
2233
- /** Company name */
2885
+ /**
2886
+ * Company name
2887
+ * @maxLength 500
2888
+ */
2234
2889
  company?: string | null;
2235
- /** Email address */
2890
+ /**
2891
+ * Email address
2892
+ * @maxLength 500
2893
+ */
2236
2894
  email?: string | null;
2237
- /** address line */
2895
+ /**
2896
+ * address line
2897
+ * @maxLength 250
2898
+ */
2238
2899
  addressLine2?: string | null;
2239
2900
  /** Tax information (for Brazil only) */
2240
2901
  vatId?: VatId;
2241
2902
  }
2242
2903
  /** @oneof */
2243
2904
  export interface AddressAddressLine1OptionsOneOf {
2244
- /** Address line 1 (free text) */
2905
+ /**
2906
+ * Address line 1 (free text)
2907
+ * @maxLength 1000
2908
+ */
2245
2909
  addressLine1?: string;
2246
2910
  /** Address line 1 (street) */
2247
2911
  street?: Street;
2248
2912
  }
2249
2913
  export interface FullName {
2250
- /** Customer's first name */
2914
+ /**
2915
+ * Customer's first name
2916
+ * @maxLength 1000
2917
+ */
2251
2918
  firstName?: string;
2252
- /** Customer's last name */
2919
+ /**
2920
+ * Customer's last name
2921
+ * @maxLength 1000
2922
+ */
2253
2923
  lastName?: string;
2254
2924
  }
2255
2925
  export interface Street {
2256
- /** Street number */
2926
+ /**
2927
+ * Street number
2928
+ * @maxLength 500
2929
+ */
2257
2930
  number?: string;
2258
- /** Street name */
2931
+ /**
2932
+ * Street name
2933
+ * @maxLength 1000
2934
+ */
2259
2935
  name?: string;
2260
2936
  }
2261
2937
  export interface VatId {
2262
- /** Customer's tax ID. */
2938
+ /**
2939
+ * Customer's tax ID.
2940
+ * @maxLength 50
2941
+ */
2263
2942
  number?: string;
2264
2943
  /**
2265
2944
  * Tax type.
@@ -2282,9 +2961,15 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
2282
2961
  shipmentDetails?: ShipmentDetails;
2283
2962
  /** Pickup details (when this object describes pickup) */
2284
2963
  pickupDetails?: V1PickupDetails;
2285
- /** Delivery option name */
2964
+ /**
2965
+ * Delivery option name
2966
+ * @maxLength 250
2967
+ */
2286
2968
  deliveryOption?: string;
2287
- /** Delivery option delivery time */
2969
+ /**
2970
+ * Delivery option delivery time
2971
+ * @maxLength 500
2972
+ */
2288
2973
  estimatedDeliveryTime?: string | null;
2289
2974
  }
2290
2975
  /** @oneof */
@@ -2297,53 +2982,101 @@ export interface V1ShippingInfoDetailsOneOf {
2297
2982
  export interface ShipmentDetails {
2298
2983
  /** Shipping destination address */
2299
2984
  address?: Address;
2300
- /** Discount applied for shipping */
2985
+ /**
2986
+ * Discount applied for shipping
2987
+ * @max 999999999.99
2988
+ */
2301
2989
  discount?: number | null;
2302
- /** Tax applied for shipping */
2990
+ /**
2991
+ * Tax applied for shipping
2992
+ * @max 999999999.99
2993
+ */
2303
2994
  tax?: number | null;
2304
2995
  /** Whether tax is included in the price */
2305
2996
  taxIncludedInPrice?: boolean;
2306
- /** Tax rate % for shipping, as a decimal point >= 0 */
2997
+ /**
2998
+ * Tax rate % for shipping, as a decimal point >= 0
2999
+ * @decimalValue options { maxScale:6, gte:0 }
3000
+ */
2307
3001
  taxRate?: string | null;
2308
3002
  }
2309
3003
  export interface V1PickupDetails {
2310
3004
  /** Pickup address */
2311
3005
  address?: PickupAddress;
2312
- /** Store owner's pickup instructions */
3006
+ /**
3007
+ * Store owner's pickup instructions
3008
+ * @maxLength 1000
3009
+ */
2313
3010
  pickupInstructions?: string | null;
2314
3011
  }
2315
3012
  export interface PickupAddress {
2316
- /** Country code (2 letters) */
3013
+ /**
3014
+ * Country code (2 letters)
3015
+ * @format COUNTRY
3016
+ */
2317
3017
  country?: string;
2318
- /** State/District */
3018
+ /**
3019
+ * State/District
3020
+ * @maxLength 50
3021
+ */
2319
3022
  subdivision?: string | null;
2320
- /** Address */
3023
+ /**
3024
+ * Address
3025
+ * @maxLength 200
3026
+ */
2321
3027
  addressLine?: string;
2322
- /** City */
3028
+ /**
3029
+ * City
3030
+ * @maxLength 85
3031
+ */
2323
3032
  city?: string;
2324
- /** ZIP/postal code */
3033
+ /**
3034
+ * ZIP/postal code
3035
+ * @maxLength 50
3036
+ */
2325
3037
  zipCode?: string;
2326
3038
  }
2327
3039
  export interface AppliedCoupon {
2328
3040
  /** Coupon ID */
2329
3041
  couponId?: string;
2330
- /** Coupon name */
3042
+ /**
3043
+ * Coupon name
3044
+ * @maxLength 100
3045
+ */
2331
3046
  name?: string;
2332
- /** Coupon code */
3047
+ /**
3048
+ * Coupon code
3049
+ * @maxLength 100
3050
+ */
2333
3051
  code?: string;
2334
3052
  }
2335
3053
  /** Custom field */
2336
3054
  export interface V1CustomField {
2337
- /** Free text that the customer entered in the custom field during the checkout process */
3055
+ /**
3056
+ * Free text that the customer entered in the custom field during the checkout process
3057
+ * @maxLength 250
3058
+ */
2338
3059
  value?: string;
2339
- /** Title for the custom field */
3060
+ /**
3061
+ * Title for the custom field
3062
+ * @maxLength 200
3063
+ */
2340
3064
  title?: string;
2341
- /** The title translated according to the buyer language */
3065
+ /**
3066
+ * The title translated according to the buyer language
3067
+ * @maxLength 200
3068
+ */
2342
3069
  translatedTitle?: string;
2343
3070
  }
2344
3071
  export interface V1SubscriptionOptionInfo {
3072
+ /** @format GUID */
2345
3073
  _id?: string | null;
3074
+ /**
3075
+ * @minLength 1
3076
+ * @maxLength 20
3077
+ */
2346
3078
  title?: string;
3079
+ /** @maxLength 60 */
2347
3080
  description?: string | null;
2348
3081
  discount?: Discount;
2349
3082
  }
@@ -2374,15 +3107,28 @@ export interface V1SubscriptionSettings {
2374
3107
  frequency?: SubscriptionFrequency;
2375
3108
  /** Whether subscription is renewed automatically at the end of each period. */
2376
3109
  autoRenewal?: boolean;
2377
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
3110
+ /**
3111
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
3112
+ * @min 2
3113
+ * @max 999
3114
+ */
2378
3115
  billingCycles?: number | null;
2379
3116
  }
2380
3117
  export interface BillingInfo {
2381
- /** Payment method used for this order */
3118
+ /**
3119
+ * Payment method used for this order
3120
+ * @maxLength 50
3121
+ */
2382
3122
  paymentMethod?: string | null;
2383
- /** Transaction ID from payment gateway (e.g., Wix Payments) */
3123
+ /**
3124
+ * Transaction ID from payment gateway (e.g., Wix Payments)
3125
+ * @maxLength 100
3126
+ */
2384
3127
  paymentGatewayTransactionId?: string | null;
2385
- /** Order ID from payment gateway (e.g., Wix Payments) */
3128
+ /**
3129
+ * Order ID from payment gateway (e.g., Wix Payments)
3130
+ * @maxLength 100
3131
+ */
2386
3132
  paymentGatewayOrderId?: string | null;
2387
3133
  }
2388
3134
  export interface Empty {
@@ -2458,9 +3204,15 @@ export interface ActionEvent {
2458
3204
  body?: string;
2459
3205
  }
2460
3206
  export interface MessageEnvelope {
2461
- /** App instance ID. */
3207
+ /**
3208
+ * App instance ID.
3209
+ * @format GUID
3210
+ */
2462
3211
  instanceId?: string | null;
2463
- /** Event type. */
3212
+ /**
3213
+ * Event type.
3214
+ * @maxLength 150
3215
+ */
2464
3216
  eventType?: string;
2465
3217
  /** The identification type and identity data. */
2466
3218
  identity?: IdentificationData;
@@ -2468,26 +3220,50 @@ export interface MessageEnvelope {
2468
3220
  data?: string;
2469
3221
  }
2470
3222
  export interface IdentificationData extends IdentificationDataIdOneOf {
2471
- /** ID of a site visitor that has not logged in to the site. */
3223
+ /**
3224
+ * ID of a site visitor that has not logged in to the site.
3225
+ * @format GUID
3226
+ */
2472
3227
  anonymousVisitorId?: string;
2473
- /** ID of a site visitor that has logged in to the site. */
3228
+ /**
3229
+ * ID of a site visitor that has logged in to the site.
3230
+ * @format GUID
3231
+ */
2474
3232
  memberId?: string;
2475
- /** ID of a Wix user (site owner, contributor, etc.). */
3233
+ /**
3234
+ * ID of a Wix user (site owner, contributor, etc.).
3235
+ * @format GUID
3236
+ */
2476
3237
  wixUserId?: string;
2477
- /** ID of an app. */
3238
+ /**
3239
+ * ID of an app.
3240
+ * @format GUID
3241
+ */
2478
3242
  appId?: string;
2479
3243
  /** @readonly */
2480
3244
  identityType?: WebhookIdentityType;
2481
3245
  }
2482
3246
  /** @oneof */
2483
3247
  export interface IdentificationDataIdOneOf {
2484
- /** ID of a site visitor that has not logged in to the site. */
3248
+ /**
3249
+ * ID of a site visitor that has not logged in to the site.
3250
+ * @format GUID
3251
+ */
2485
3252
  anonymousVisitorId?: string;
2486
- /** ID of a site visitor that has logged in to the site. */
3253
+ /**
3254
+ * ID of a site visitor that has logged in to the site.
3255
+ * @format GUID
3256
+ */
2487
3257
  memberId?: string;
2488
- /** ID of a Wix user (site owner, contributor, etc.). */
3258
+ /**
3259
+ * ID of a Wix user (site owner, contributor, etc.).
3260
+ * @format GUID
3261
+ */
2489
3262
  wixUserId?: string;
2490
- /** ID of an app. */
3263
+ /**
3264
+ * ID of an app.
3265
+ * @format GUID
3266
+ */
2491
3267
  appId?: string;
2492
3268
  }
2493
3269
  export declare enum WebhookIdentityType {
@@ -2973,9 +3749,15 @@ export interface GetCheckoutPaymentSettingsResponseNonNullableFields {
2973
3749
  blockedPaymentOptions: GetCheckoutPaymentSettingsResponsePaymentOption[];
2974
3750
  }
2975
3751
  export interface BaseEventMetadata {
2976
- /** App instance ID. */
3752
+ /**
3753
+ * App instance ID.
3754
+ * @format GUID
3755
+ */
2977
3756
  instanceId?: string | null;
2978
- /** Event type. */
3757
+ /**
3758
+ * Event type.
3759
+ * @maxLength 150
3760
+ */
2979
3761
  eventType?: string;
2980
3762
  /** The identification type and identity data. */
2981
3763
  identity?: IdentificationData;
@@ -3042,6 +3824,8 @@ export interface CheckoutCompletedEnvelope {
3042
3824
  * @permissionId ECOM.READ_CHECKOUTS
3043
3825
  * @webhook
3044
3826
  * @eventType wix.ecom.v1.checkout_completed
3827
+ * @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
3828
+ * @slug completed
3045
3829
  */
3046
3830
  export declare function onCheckoutCompleted(handler: (event: CheckoutCompletedEnvelope) => void | Promise<void>): void;
3047
3831
  export interface CheckoutCreatedEnvelope {
@@ -3067,6 +3851,8 @@ export interface CheckoutCreatedEnvelope {
3067
3851
  * @permissionId ECOM.READ_CHECKOUTS
3068
3852
  * @webhook
3069
3853
  * @eventType wix.ecom.v1.checkout_created
3854
+ * @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
3855
+ * @slug created
3070
3856
  */
3071
3857
  export declare function onCheckoutCreated(handler: (event: CheckoutCreatedEnvelope) => void | Promise<void>): void;
3072
3858
  export interface CheckoutUpdatedEnvelope {
@@ -3092,6 +3878,8 @@ export interface CheckoutUpdatedEnvelope {
3092
3878
  * @permissionId ECOM.READ_CHECKOUTS
3093
3879
  * @webhook
3094
3880
  * @eventType wix.ecom.v1.checkout_updated
3881
+ * @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
3882
+ * @slug updated
3095
3883
  */
3096
3884
  export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelope) => void | Promise<void>): void;
3097
3885
  /**
@@ -3111,8 +3899,8 @@ export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelo
3111
3899
  * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id
3112
3900
  * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId
3113
3901
  * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds
3114
- * @requiredField options.customLineItems.descriptionLines
3115
3902
  * @requiredField options.customLineItems.descriptionLines.name
3903
+ * @requiredField options.customLineItems.descriptionLines.value
3116
3904
  * @requiredField options.customLineItems.itemType
3117
3905
  * @requiredField options.customLineItems.price
3118
3906
  * @requiredField options.customLineItems.productName
@@ -3136,6 +3924,8 @@ export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelo
3136
3924
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3137
3925
  * @permissionScope Manage eCommerce - Admin Permissions
3138
3926
  * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
3927
+ * @permissionScope Manage Restaurants - all permissions
3928
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3139
3929
  * @permissionScope Manage eCommerce - all permissions
3140
3930
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3141
3931
  * @applicableIdentity APP
@@ -3149,28 +3939,20 @@ export interface CreateCheckoutOptions {
3149
3939
  checkoutInfo?: Checkout;
3150
3940
  /** 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). */
3151
3941
  couponCode?: string | null;
3152
- /** Catalog line items to add to the checkout. */
3942
+ /**
3943
+ * Catalog line items to add to the checkout.
3944
+ * @maxSize 300
3945
+ */
3153
3946
  lineItems?: LineItem[];
3154
3947
  /**
3155
3948
  * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
3156
3949
  *
3157
3950
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3158
3951
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3952
+ * @maxSize 300
3159
3953
  */
3160
3954
  customLineItems?: CustomLineItem[];
3161
- /**
3162
- * Sales channel that submitted the order.
3163
- * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
3164
- * + `"WEB"`: A web client.
3165
- * + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
3166
- * + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
3167
- * + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
3168
- * + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
3169
- * + `"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)
3170
- * + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
3171
- * + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
3172
- * + `"OTHER_PLATFORM"`: Other sales platform.
3173
- */
3955
+ /** Sales channel that submitted the order. */
3174
3956
  channelType: ChannelType;
3175
3957
  /**
3176
3958
  * Gift card code.
@@ -3184,6 +3966,7 @@ export interface CreateCheckoutOptions {
3184
3966
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3185
3967
  *
3186
3968
  * 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`.
3969
+ * @maxLength 1000
3187
3970
  */
3188
3971
  overrideCheckoutUrl?: string | null;
3189
3972
  }
@@ -3220,7 +4003,6 @@ export declare function getCheckout(_id: string): Promise<Checkout & CheckoutNon
3220
4003
  * Retrieves the checkout associated with a specified cart.
3221
4004
  * @param _id - Cart ID.
3222
4005
  * @public
3223
- * @documentationMaturity preview
3224
4006
  * @requiredField _id
3225
4007
  * @permissionId ECOM.READ_CHECKOUTS
3226
4008
  * @permissionScope Manage Stores - all permissions
@@ -3287,8 +4069,8 @@ export declare function getCheckoutUrl(_id: string): Promise<GetCheckoutURLRespo
3287
4069
  * @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
3288
4070
  * @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
3289
4071
  * @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
3290
- * @requiredField options.customLineItems.descriptionLines
3291
4072
  * @requiredField options.customLineItems.descriptionLines.name
4073
+ * @requiredField options.customLineItems.descriptionLines.value
3292
4074
  * @requiredField options.customLineItems.itemType
3293
4075
  * @requiredField options.customLineItems.productName
3294
4076
  * @requiredField options.customLineItems.quantity
@@ -3311,6 +4093,8 @@ export declare function getCheckoutUrl(_id: string): Promise<GetCheckoutURLRespo
3311
4093
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3312
4094
  * @permissionScope Manage eCommerce - Admin Permissions
3313
4095
  * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
4096
+ * @permissionScope Manage Restaurants - all permissions
4097
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3314
4098
  * @permissionScope Manage eCommerce - all permissions
3315
4099
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3316
4100
  * @applicableIdentity APP
@@ -3322,6 +4106,7 @@ export declare function updateCheckout(_id: string | null, checkout: UpdateCheck
3322
4106
  export interface UpdateCheckout {
3323
4107
  /**
3324
4108
  * Checkout ID.
4109
+ * @format GUID
3325
4110
  * @readonly
3326
4111
  */
3327
4112
  _id?: string | null;
@@ -3329,6 +4114,8 @@ export interface UpdateCheckout {
3329
4114
  * Line items.
3330
4115
  *
3331
4116
  * Max: 300 items
4117
+ * @minSize 1
4118
+ * @maxSize 300
3332
4119
  * @readonly
3333
4120
  */
3334
4121
  lineItems?: LineItem[];
@@ -3336,13 +4123,17 @@ export interface UpdateCheckout {
3336
4123
  billingInfo?: AddressWithContact;
3337
4124
  /** Shipping information. */
3338
4125
  shippingInfo?: ShippingInfo;
3339
- /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
4126
+ /**
4127
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
4128
+ * @maxLength 1000
4129
+ */
3340
4130
  buyerNote?: string | null;
3341
4131
  /** Buyer information. */
3342
4132
  buyerInfo?: BuyerInfo;
3343
4133
  /**
3344
4134
  * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3345
4135
  * @readonly
4136
+ * @format CURRENCY
3346
4137
  */
3347
4138
  conversionCurrency?: string;
3348
4139
  /**
@@ -3381,6 +4172,7 @@ export interface UpdateCheckout {
3381
4172
  taxSummary?: TaxSummary;
3382
4173
  /**
3383
4174
  * The currency used when submitting the order.
4175
+ * @format CURRENCY
3384
4176
  * @readonly
3385
4177
  */
3386
4178
  currency?: string;
@@ -3438,9 +4230,15 @@ export interface UpdateCheckout {
3438
4230
  payLater?: PriceSummary;
3439
4231
  /** Memberships to apply when creating the order. */
3440
4232
  membershipOptions?: MembershipOptions;
3441
- /** Additional Fees. */
4233
+ /**
4234
+ * Additional Fees.
4235
+ * @maxSize 100
4236
+ */
3442
4237
  additionalFees?: AdditionalFee[];
3443
- /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */
4238
+ /**
4239
+ * Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
4240
+ * @format GUID
4241
+ */
3444
4242
  cartId?: string | null;
3445
4243
  /**
3446
4244
  * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
@@ -3455,6 +4253,7 @@ export interface UpdateCheckout {
3455
4253
  extendedFields?: ExtendedFields;
3456
4254
  /**
3457
4255
  * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
4256
+ * @format GUID
3458
4257
  * @readonly
3459
4258
  */
3460
4259
  purchaseFlowId?: string | null;
@@ -3462,6 +4261,7 @@ export interface UpdateCheckout {
3462
4261
  * Additional settings for customization of the checkout process.
3463
4262
  *
3464
4263
  * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
4264
+ * @immutable
3465
4265
  */
3466
4266
  customSettings?: CustomSettings;
3467
4267
  /**
@@ -3471,6 +4271,12 @@ export interface UpdateCheckout {
3471
4271
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3472
4272
  */
3473
4273
  customContentReference?: CustomContentReference;
4274
+ /**
4275
+ * The business location ID associated with the checkout.
4276
+ * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
4277
+ * @format GUID
4278
+ */
4279
+ businessLocationId?: string | null;
3474
4280
  }
3475
4281
  export interface UpdateCheckoutOptions {
3476
4282
  /** 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). */
@@ -3481,15 +4287,20 @@ export interface UpdateCheckoutOptions {
3481
4287
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3482
4288
  *
3483
4289
  * 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`.
4290
+ * @maxLength 1000
3484
4291
  */
3485
4292
  overrideCheckoutUrl?: string | null;
3486
- /** Catalog line items. */
4293
+ /**
4294
+ * Catalog line items.
4295
+ * @maxSize 300
4296
+ */
3487
4297
  lineItems?: LineItem[];
3488
4298
  /**
3489
4299
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
3490
4300
  *
3491
4301
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3492
4302
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4303
+ * @maxSize 300
3493
4304
  */
3494
4305
  customLineItems?: CustomLineItem[];
3495
4306
  }
@@ -3572,8 +4383,8 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOv
3572
4383
  * @param _id - Checkout ID.
3573
4384
  * @public
3574
4385
  * @requiredField _id
3575
- * @requiredField options.customLineItems.descriptionLines
3576
4386
  * @requiredField options.customLineItems.descriptionLines.name
4387
+ * @requiredField options.customLineItems.descriptionLines.value
3577
4388
  * @requiredField options.customLineItems.itemType
3578
4389
  * @requiredField options.customLineItems.productName
3579
4390
  * @requiredField options.customLineItems.quantity
@@ -3596,6 +4407,8 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOv
3596
4407
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3597
4408
  * @permissionScope Manage eCommerce - Admin Permissions
3598
4409
  * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
4410
+ * @permissionScope Manage Restaurants - all permissions
4411
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3599
4412
  * @permissionScope Manage eCommerce - all permissions
3600
4413
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3601
4414
  * @applicableIdentity APP
@@ -3604,13 +4417,17 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOv
3604
4417
  */
3605
4418
  export declare function addToCheckout(_id: string, options?: AddToCheckoutOptions): Promise<AddToCheckoutResponse & AddToCheckoutResponseNonNullableFields>;
3606
4419
  export interface AddToCheckoutOptions {
3607
- /** Catalog line items. */
4420
+ /**
4421
+ * Catalog line items.
4422
+ * @maxSize 100
4423
+ */
3608
4424
  lineItems?: LineItem[];
3609
4425
  /**
3610
4426
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
3611
4427
  *
3612
4428
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3613
4429
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4430
+ * @maxSize 100
3614
4431
  */
3615
4432
  customLineItems?: CustomLineItem[];
3616
4433
  }