@wix/auto_sdk_ecom_cart 1.0.3 → 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 (41) hide show
  1. package/build/cjs/src/ecom-v1-cart-cart.http.d.ts +7 -12
  2. package/build/cjs/src/ecom-v1-cart-cart.http.js +13 -12
  3. package/build/cjs/src/ecom-v1-cart-cart.http.js.map +1 -1
  4. package/build/cjs/src/ecom-v1-cart-cart.public.d.ts +7 -12
  5. package/build/cjs/src/ecom-v1-cart-cart.public.js.map +1 -1
  6. package/build/cjs/src/ecom-v1-cart-cart.types.d.ts +652 -144
  7. package/build/cjs/src/ecom-v1-cart-cart.types.js.map +1 -1
  8. package/build/cjs/src/ecom-v1-cart-cart.universal.d.ts +753 -168
  9. package/build/cjs/src/ecom-v1-cart-cart.universal.js +32 -15
  10. package/build/cjs/src/ecom-v1-cart-cart.universal.js.map +1 -1
  11. package/build/es/src/ecom-v1-cart-cart.http.d.ts +7 -12
  12. package/build/es/src/ecom-v1-cart-cart.http.js +13 -12
  13. package/build/es/src/ecom-v1-cart-cart.http.js.map +1 -1
  14. package/build/es/src/ecom-v1-cart-cart.public.d.ts +7 -12
  15. package/build/es/src/ecom-v1-cart-cart.public.js.map +1 -1
  16. package/build/es/src/ecom-v1-cart-cart.types.d.ts +652 -144
  17. package/build/es/src/ecom-v1-cart-cart.types.js.map +1 -1
  18. package/build/es/src/ecom-v1-cart-cart.universal.d.ts +753 -168
  19. package/build/es/src/ecom-v1-cart-cart.universal.js +32 -15
  20. package/build/es/src/ecom-v1-cart-cart.universal.js.map +1 -1
  21. package/build/internal/cjs/src/ecom-v1-cart-cart.http.d.ts +7 -12
  22. package/build/internal/cjs/src/ecom-v1-cart-cart.http.js +13 -12
  23. package/build/internal/cjs/src/ecom-v1-cart-cart.http.js.map +1 -1
  24. package/build/internal/cjs/src/ecom-v1-cart-cart.public.d.ts +7 -12
  25. package/build/internal/cjs/src/ecom-v1-cart-cart.public.js.map +1 -1
  26. package/build/internal/cjs/src/ecom-v1-cart-cart.types.d.ts +652 -144
  27. package/build/internal/cjs/src/ecom-v1-cart-cart.types.js.map +1 -1
  28. package/build/internal/cjs/src/ecom-v1-cart-cart.universal.d.ts +760 -173
  29. package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js +32 -15
  30. package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js.map +1 -1
  31. package/build/internal/es/src/ecom-v1-cart-cart.http.d.ts +7 -12
  32. package/build/internal/es/src/ecom-v1-cart-cart.http.js +13 -12
  33. package/build/internal/es/src/ecom-v1-cart-cart.http.js.map +1 -1
  34. package/build/internal/es/src/ecom-v1-cart-cart.public.d.ts +7 -12
  35. package/build/internal/es/src/ecom-v1-cart-cart.public.js.map +1 -1
  36. package/build/internal/es/src/ecom-v1-cart-cart.types.d.ts +652 -144
  37. package/build/internal/es/src/ecom-v1-cart-cart.types.js.map +1 -1
  38. package/build/internal/es/src/ecom-v1-cart-cart.universal.d.ts +760 -173
  39. package/build/internal/es/src/ecom-v1-cart-cart.universal.js +32 -15
  40. package/build/internal/es/src/ecom-v1-cart-cart.universal.js.map +1 -1
  41. package/package.json +2 -2
@@ -1,17 +1,26 @@
1
1
  export interface Cart {
2
- /** Cart ID. */
2
+ /**
3
+ * Cart ID.
4
+ * @format GUID
5
+ */
3
6
  id?: string | null;
4
7
  /**
5
8
  * Line items.
9
+ * @minSize 1
10
+ * @maxSize 300
6
11
  * @readonly
7
12
  */
8
13
  lineItems?: LineItem[];
9
- /** Note left by the buyer/customer. */
14
+ /**
15
+ * Note left by the buyer/customer.
16
+ * @maxLength 1000
17
+ */
10
18
  buyerNote?: string | null;
11
19
  /** Buyer information. */
12
20
  buyerInfo?: BuyerInfo;
13
21
  /**
14
22
  * Currency used for pricing.
23
+ * @format CURRENCY
15
24
  * @readonly
16
25
  */
17
26
  currency?: string;
@@ -19,6 +28,7 @@ export interface Cart {
19
28
  * Currency code used for all the converted prices that are returned.
20
29
  * For a site that supports multiple currencies, this is the currency the buyer selected.
21
30
  * @readonly
31
+ * @format CURRENCY
22
32
  */
23
33
  conversionCurrency?: string;
24
34
  /**
@@ -45,6 +55,7 @@ export interface Cart {
45
55
  /**
46
56
  * ID of the checkout that originated from this cart.
47
57
  * @readonly
58
+ * @format GUID
48
59
  */
49
60
  checkoutId?: string | null;
50
61
  /**
@@ -70,10 +81,12 @@ export interface Cart {
70
81
  * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the [Abandoned Checkout API](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/abandoned-checkout/introduction)
71
82
  * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
72
83
  * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
84
+ * @maxLength 1000
73
85
  */
74
86
  overrideCheckoutUrl?: string | null;
75
87
  /**
76
88
  * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
89
+ * @format GUID
77
90
  * @readonly
78
91
  */
79
92
  purchaseFlowId?: string | null;
@@ -82,16 +95,22 @@ export interface Cart {
82
95
  /**
83
96
  * The business location ID associated with the cart.
84
97
  * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
98
+ * @format GUID
85
99
  */
86
100
  businessLocationId?: string | null;
87
101
  }
88
102
  export interface LineItem {
89
103
  /**
90
104
  * Line item ID.
105
+ * @format GUID
91
106
  * @readonly
92
107
  */
93
108
  id?: string | null;
94
- /** Item quantity. */
109
+ /**
110
+ * Item quantity.
111
+ * @min 1
112
+ * @max 100000
113
+ */
95
114
  quantity?: number;
96
115
  /** 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. */
97
116
  catalogReference?: CatalogReference;
@@ -149,12 +168,9 @@ export interface LineItem {
149
168
  */
150
169
  itemType?: ItemType;
151
170
  /**
152
- * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
153
- * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
154
- * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
155
- * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
156
- * + `DEPOSIT_ONLINE` - Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is defined by `lineItem.deposit`.
157
- * + `MEMBERSHIP_OFFLINE` - Payment for this item can only be performed by using a membership and must be manually redeemed in the dashboard by the site owner. When this option is used, `lineItem.price.amount` is 0.
171
+ * Type of selected payment option for current item.
172
+ *
173
+ * Default: `FULL_PAYMENT_ONLINE`
158
174
  * @readonly
159
175
  */
160
176
  paymentOption?: PaymentOptionType;
@@ -168,6 +184,8 @@ export interface LineItem {
168
184
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
169
185
  * + in most cases, this field is the same as `catalogReference.catalogItemId`.
170
186
  * + Used in membership validation.
187
+ * @minLength 1
188
+ * @maxLength 36
171
189
  * @readonly
172
190
  */
173
191
  rootCatalogItemId?: string | null;
@@ -183,8 +201,15 @@ export interface LineItem {
183
201
  depositAmount?: MultiCurrencyPrice;
184
202
  /** Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`. */
185
203
  selectedMembership?: SelectedMembership;
204
+ /**
205
+ * Delivery profile ID.
206
+ * @format GUID
207
+ * @readonly
208
+ */
209
+ deliveryProfileId?: string | null;
186
210
  /**
187
211
  * Tax group ID for this line item.
212
+ * @format GUID
188
213
  * @readonly
189
214
  */
190
215
  taxGroupId?: string | null;
@@ -195,6 +220,8 @@ export interface LineItem {
195
220
  customLineItem?: boolean;
196
221
  /**
197
222
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
223
+ * @minLength 1
224
+ * @maxLength 2500
198
225
  * @readonly
199
226
  */
200
227
  consentRequiredPaymentPolicy?: string | null;
@@ -215,7 +242,11 @@ export interface LineItem {
215
242
  }
216
243
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
217
244
  export interface CatalogReference {
218
- /** ID of the item within the catalog it belongs to. */
245
+ /**
246
+ * ID of the item within the catalog it belongs to.
247
+ * @minLength 1
248
+ * @maxLength 36
249
+ */
219
250
  catalogItemId?: string;
220
251
  /**
221
252
  * ID of the app providing the catalog.
@@ -226,6 +257,7 @@ export interface CatalogReference {
226
257
  * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
227
258
  * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
228
259
  * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
260
+ * @minLength 1
229
261
  */
230
262
  appId?: string;
231
263
  /**
@@ -241,6 +273,8 @@ export interface ProductName {
241
273
  *
242
274
  * Min: 1 character.
243
275
  * Max: 200 characters.
276
+ * @minLength 1
277
+ * @maxLength 200
244
278
  */
245
279
  original?: string;
246
280
  /**
@@ -249,6 +283,8 @@ export interface ProductName {
249
283
  * Min: 1 character.
250
284
  * Max: 400 characters.
251
285
  * Default: Same as `original`.
286
+ * @minLength 1
287
+ * @maxLength 400
252
288
  */
253
289
  translated?: string | null;
254
290
  }
@@ -259,11 +295,15 @@ export interface PageUrlV2 {
259
295
  url?: string | null;
260
296
  }
261
297
  export interface MultiCurrencyPrice {
262
- /** Amount. */
298
+ /**
299
+ * Amount.
300
+ * @decimalValue options { gte:0, lte:1000000000000000 }
301
+ */
263
302
  amount?: string;
264
303
  /**
265
304
  * Converted amount.
266
305
  * @readonly
306
+ * @decimalValue options { gte:0, lte:1000000000000000 }
267
307
  */
268
308
  convertedAmount?: string;
269
309
  /**
@@ -296,32 +336,44 @@ export interface DescriptionLineValueOneOf {
296
336
  export interface DescriptionLineDescriptionLineValueOneOf {
297
337
  }
298
338
  export interface DescriptionLineName {
299
- /** 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). */
339
+ /**
340
+ * 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).
341
+ * @maxLength 100
342
+ */
300
343
  original?: string;
301
344
  /**
302
345
  * Description line name translated into the buyer's language.
303
346
  *
304
347
  * Default: Same as `original`.
348
+ * @maxLength 200
305
349
  */
306
350
  translated?: string | null;
307
351
  }
308
352
  export interface PlainTextValue {
309
- /** 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). */
353
+ /**
354
+ * 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).
355
+ * @maxLength 600
356
+ */
310
357
  original?: string;
311
358
  /**
312
359
  * Description line plain text value translated into the buyer's language.
313
360
  *
314
361
  * Default: Same as `original`.
362
+ * @maxLength 600
315
363
  */
316
364
  translated?: string | null;
317
365
  }
318
366
  export interface Color {
319
- /** 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). */
367
+ /**
368
+ * 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).
369
+ * @maxLength 500
370
+ */
320
371
  original?: string;
321
372
  /**
322
373
  * Description line color name translated into the buyer's language.
323
374
  *
324
375
  * Default: Same as `original`.
376
+ * @maxLength 500
325
377
  */
326
378
  translated?: string | null;
327
379
  /** HEX or RGB color code for display. */
@@ -386,7 +438,10 @@ export declare enum ItemAvailabilityStatus {
386
438
  export interface PhysicalProperties {
387
439
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
388
440
  weight?: number | null;
389
- /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
441
+ /**
442
+ * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
443
+ * @maxLength 40
444
+ */
390
445
  sku?: string | null;
391
446
  /** Whether this line item is shippable. */
392
447
  shippable?: boolean;
@@ -439,11 +494,16 @@ export interface SubscriptionSettings {
439
494
  *
440
495
  * Default: `1`.
441
496
  * If SubscriptionFrequency is Day the minimum interval is 7
497
+ * @min 1
498
+ * @max 50
442
499
  */
443
500
  interval?: number | null;
444
501
  /** Whether subscription is renewed automatically at the end of each period. */
445
502
  autoRenewal?: boolean;
446
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */
503
+ /**
504
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
505
+ * @min 1
506
+ */
447
507
  billingCycles?: number | null;
448
508
  }
449
509
  /** Frequency unit of recurring payment */
@@ -457,29 +517,53 @@ export declare enum SubscriptionFrequency {
457
517
  export interface FreeTrialPeriod {
458
518
  /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
459
519
  frequency?: SubscriptionFrequency;
460
- /** interval of period */
520
+ /**
521
+ * interval of period
522
+ * @min 1
523
+ * @max 50
524
+ */
461
525
  interval?: number;
462
526
  }
463
527
  export interface Title {
464
- /** 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). */
528
+ /**
529
+ * 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).
530
+ * @minLength 1
531
+ * @maxLength 150
532
+ */
465
533
  original?: string;
466
534
  /**
467
535
  * Subscription option name translated into the buyer's language.
468
536
  *
469
537
  * Default: Same as `original`.
538
+ * @minLength 1
539
+ * @maxLength 150
470
540
  */
471
541
  translated?: string | null;
472
542
  }
473
543
  export interface Description {
474
- /** Subscription option description. */
544
+ /**
545
+ * Subscription option description.
546
+ * @maxLength 500
547
+ */
475
548
  original?: string;
476
- /** Translated subscription option description. */
549
+ /**
550
+ * Translated subscription option description.
551
+ * @maxLength 500
552
+ */
477
553
  translated?: string | null;
478
554
  }
479
555
  export interface SecuredMedia {
480
- /** Media ID in Wix Media Manager. */
556
+ /**
557
+ * Media ID in Wix Media Manager.
558
+ * @minLength 1
559
+ * @maxLength 100
560
+ */
481
561
  id?: string;
482
- /** Original filename. */
562
+ /**
563
+ * Original filename.
564
+ * @minLength 1
565
+ * @maxLength 1000
566
+ */
483
567
  fileName?: string;
484
568
  /** File type. */
485
569
  fileType?: FileType;
@@ -511,34 +595,60 @@ export interface ServiceProperties {
511
595
  * For example, the start time of a class.
512
596
  */
513
597
  scheduledDate?: Date | null;
514
- /** 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. */
598
+ /**
599
+ * 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.
600
+ * @min 1
601
+ * @max 10000
602
+ */
515
603
  numberOfParticipants?: number | null;
516
604
  }
517
605
  export interface PriceDescription {
518
- /** __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). */
606
+ /**
607
+ * __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).
608
+ * @minLength 1
609
+ * @maxLength 100
610
+ */
519
611
  original?: string;
520
612
  /**
521
613
  * Price description translated into the buyer's language.
522
614
  *
523
615
  * Default: Same as `original`.
616
+ * @minLength 1
617
+ * @maxLength 100
524
618
  */
525
619
  translated?: string | null;
526
620
  }
527
621
  /** Selected Membership */
528
622
  export interface SelectedMembership {
529
- /** Membership ID. */
623
+ /**
624
+ * Membership ID.
625
+ * @minLength 1
626
+ * @maxLength 100
627
+ */
530
628
  id?: string;
531
- /** ID of the app providing this payment option. */
629
+ /**
630
+ * ID of the app providing this payment option.
631
+ * @format GUID
632
+ */
532
633
  appId?: string;
533
634
  }
534
635
  export interface CatalogOverrideFields {
535
636
  /** Item name. */
536
637
  productName?: ProductName;
537
- /** Item price **after** discounts. */
638
+ /**
639
+ * Item price **after** discounts.
640
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
641
+ */
538
642
  price?: string | null;
539
- /** Item price **before** discounts. */
643
+ /**
644
+ * Item price **before** discounts.
645
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
646
+ */
540
647
  fullPrice?: string | null;
541
- /** Item description lines. Used when displaying the line item to customers. */
648
+ /**
649
+ * Item description lines. Used when displaying the line item to customers.
650
+ * @maxSize 20
651
+ */
542
652
  descriptionLines?: DescriptionLine[];
543
653
  /** Physical properties of the item. */
544
654
  physicalProperties?: PhysicalProperties;
@@ -546,7 +656,11 @@ export interface CatalogOverrideFields {
546
656
  image?: Image;
547
657
  /** Payment method selected for the item. */
548
658
  paymentOption?: PaymentOption;
549
- /** Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. */
659
+ /**
660
+ * Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
661
+ * @format DECIMAL_VALUE
662
+ * @decimalValue options { gt:0, lte:999999999, maxScale:3 }
663
+ */
550
664
  depositAmount?: string | null;
551
665
  /**
552
666
  * Whether to save the payment method on the order.
@@ -569,11 +683,9 @@ export interface Image {
569
683
  }
570
684
  export interface PaymentOption {
571
685
  /**
572
- * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
573
- * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
574
- * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When selected, `price` is `0`.
575
- * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
576
- * + `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`.
686
+ * Type of selected payment option for current item.
687
+ *
688
+ * Default: `FULL_PAYMENT_ONLINE`
577
689
  */
578
690
  value?: PaymentOptionType;
579
691
  }
@@ -604,47 +716,67 @@ export interface ExtendedFields {
604
716
  namespaces?: Record<string, Record<string, any>>;
605
717
  }
606
718
  export interface Policy {
607
- /** Policy title - should be translated */
719
+ /**
720
+ * Policy title - should be translated
721
+ * @minLength 1
722
+ * @maxLength 29
723
+ */
608
724
  title?: string | null;
609
- /** Policy content - should be translated */
725
+ /**
726
+ * Policy content - should be translated
727
+ * @minLength 1
728
+ * @maxLength 3000
729
+ */
610
730
  content?: string;
611
731
  }
612
732
  /** Buyer Info */
613
733
  export interface BuyerInfo extends BuyerInfoIdOneOf {
614
734
  /**
615
735
  * Visitor ID - if the buyer is **not** a site member.
736
+ * @format GUID
616
737
  * @readonly
617
738
  */
618
739
  visitorId?: string;
619
740
  /**
620
741
  * Member ID - if the buyer is a site member.
742
+ * @format GUID
621
743
  * @readonly
622
744
  */
623
745
  memberId?: string;
624
746
  /**
625
747
  * User ID - if the buyer (or cart owner) is a Wix user.
748
+ * @format GUID
626
749
  * @readonly
627
750
  */
628
751
  userId?: string;
629
- /** Contact ID. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction). */
752
+ /**
753
+ * Contact ID. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
754
+ * @format GUID
755
+ */
630
756
  contactId?: string | null;
631
- /** Buyer email address. */
757
+ /**
758
+ * Buyer email address.
759
+ * @format EMAIL
760
+ */
632
761
  email?: string | null;
633
762
  }
634
763
  /** @oneof */
635
764
  export interface BuyerInfoIdOneOf {
636
765
  /**
637
766
  * Visitor ID - if the buyer is **not** a site member.
767
+ * @format GUID
638
768
  * @readonly
639
769
  */
640
770
  visitorId?: string;
641
771
  /**
642
772
  * Member ID - if the buyer is a site member.
773
+ * @format GUID
643
774
  * @readonly
644
775
  */
645
776
  memberId?: string;
646
777
  /**
647
778
  * User ID - if the buyer (or cart owner) is a Wix user.
779
+ * @format GUID
648
780
  * @readonly
649
781
  */
650
782
  userId?: string;
@@ -681,7 +813,10 @@ export interface MerchantDiscount {
681
813
  amount?: MultiCurrencyPrice;
682
814
  }
683
815
  export interface DiscountRule {
684
- /** Discount rule ID */
816
+ /**
817
+ * Discount rule ID
818
+ * @format GUID
819
+ */
685
820
  id?: string;
686
821
  /** Discount rule name */
687
822
  name?: DiscountRuleName;
@@ -689,9 +824,17 @@ export interface DiscountRule {
689
824
  amount?: MultiCurrencyPrice;
690
825
  }
691
826
  export interface DiscountRuleName {
692
- /** Original discount rule name (in site's default language). */
827
+ /**
828
+ * Original discount rule name (in site's default language).
829
+ * @minLength 1
830
+ * @maxLength 256
831
+ */
693
832
  original?: string;
694
- /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
833
+ /**
834
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
835
+ * @minLength 1
836
+ * @maxLength 500
837
+ */
695
838
  translated?: string | null;
696
839
  }
697
840
  export declare enum DiscountType {
@@ -711,19 +854,37 @@ export interface AddressWithContact {
711
854
  }
712
855
  /** Physical address */
713
856
  export interface Address {
714
- /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
857
+ /**
858
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
859
+ * @format COUNTRY
860
+ */
715
861
  country?: string | null;
716
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
862
+ /**
863
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
864
+ * @maxLength 50
865
+ */
717
866
  subdivision?: string | null;
718
- /** City name. */
867
+ /**
868
+ * City name.
869
+ * @maxLength 50
870
+ */
719
871
  city?: string | null;
720
- /** Postal or zip code. */
872
+ /**
873
+ * Postal or zip code.
874
+ * @maxLength 50
875
+ */
721
876
  postalCode?: string | null;
722
877
  /** Street address. */
723
878
  streetAddress?: StreetAddress;
724
- /** Main address line (usually street name and number). */
879
+ /**
880
+ * Main address line (usually street name and number).
881
+ * @maxLength 150
882
+ */
725
883
  addressLine?: string | null;
726
- /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
884
+ /**
885
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
886
+ * @maxLength 100
887
+ */
727
888
  addressLine2?: string | null;
728
889
  /**
729
890
  * Country's full name.
@@ -750,13 +911,25 @@ export interface AddressLocation {
750
911
  }
751
912
  /** Full contact details for an address */
752
913
  export interface FullAddressContactDetails {
753
- /** First name. */
914
+ /**
915
+ * First name.
916
+ * @maxLength 100
917
+ */
754
918
  firstName?: string | null;
755
- /** Last name. */
919
+ /**
920
+ * Last name.
921
+ * @maxLength 100
922
+ */
756
923
  lastName?: string | null;
757
- /** Phone number. */
924
+ /**
925
+ * Phone number.
926
+ * @format PHONE
927
+ */
758
928
  phone?: string | null;
759
- /** Company name. */
929
+ /**
930
+ * Company name.
931
+ * @maxLength 1000
932
+ */
760
933
  company?: string | null;
761
934
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
762
935
  vatId?: VatId;
@@ -782,9 +955,16 @@ export declare enum VatType {
782
955
  CNPJ = "CNPJ"
783
956
  }
784
957
  export interface SelectedShippingOption {
785
- /** Carrier ID. */
958
+ /**
959
+ * Carrier ID.
960
+ * @format GUID
961
+ */
786
962
  carrierId?: string | null;
787
- /** Selected shipping option code. For example, "usps_std_overnight". */
963
+ /**
964
+ * Selected shipping option code. For example, "usps_std_overnight".
965
+ * @minLength 1
966
+ * @maxLength 100
967
+ */
788
968
  code?: string;
789
969
  }
790
970
  export interface GetCurrentCartRequest {
@@ -798,22 +978,36 @@ export interface UpdateCartRequest {
798
978
  cartInfo?: Cart;
799
979
  /** Coupon code. For more information, see [Coupons API](https://dev.wix.com/api/rest/wix-coupons/coupons/introduction). */
800
980
  couponCode?: string | null;
801
- /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart. */
981
+ /**
982
+ * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
983
+ * @maxSize 100
984
+ */
802
985
  merchantDiscounts?: MerchantDiscountInput[];
803
- /** Catalog line items. */
986
+ /**
987
+ * Catalog line items.
988
+ * @maxSize 300
989
+ */
804
990
  lineItems?: LineItem[];
805
991
  /**
806
992
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
807
993
  *
808
994
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
809
995
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
996
+ * @maxSize 300
810
997
  */
811
998
  customLineItems?: CustomLineItem[];
812
999
  }
813
1000
  export interface MerchantDiscountInput {
814
- /** Discount amount. */
1001
+ /**
1002
+ * Discount amount.
1003
+ * @decimalValue options { gte:0 }
1004
+ */
815
1005
  amount?: string;
816
- /** IDs of line items the discount applies to. */
1006
+ /**
1007
+ * IDs of line items the discount applies to.
1008
+ * @format GUID
1009
+ * @maxSize 300
1010
+ */
817
1011
  lineItemIds?: string[];
818
1012
  }
819
1013
  export interface CustomLineItem {
@@ -822,17 +1016,24 @@ export interface CustomLineItem {
822
1016
  *
823
1017
  * Min: `1`
824
1018
  * Max: `100000`
1019
+ * @min 1
1020
+ * @max 100000
825
1021
  */
826
1022
  quantity?: number;
827
1023
  /**
828
1024
  * Custom line item price.
829
1025
  *
830
1026
  * Must be a number or a decimal without symbols.
1027
+ * @format DECIMAL_VALUE
1028
+ * @decimalValue options { gte:0, lte:1000000000000000 }
831
1029
  */
832
1030
  price?: string;
833
1031
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
834
1032
  priceDescription?: PriceDescription;
835
- /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
1033
+ /**
1034
+ * Custom line item description lines. Used for display purposes for the cart, checkout and order.
1035
+ * @maxSize 10
1036
+ */
836
1037
  descriptionLines?: DescriptionLine[];
837
1038
  /** Custom line item's media. */
838
1039
  media?: Image;
@@ -840,9 +1041,13 @@ export interface CustomLineItem {
840
1041
  * Custom line item ID. If passed, `id` must be unique.
841
1042
  *
842
1043
  * Default: auto-generated ID
1044
+ * @format GUID
843
1045
  */
844
1046
  id?: string | null;
845
- /** Tax group ID for this custom line item. */
1047
+ /**
1048
+ * Tax group ID for this custom line item.
1049
+ * @format GUID
1050
+ */
846
1051
  taxGroupId?: string | null;
847
1052
  /** Name of the item or product. */
848
1053
  productName?: ProductName;
@@ -850,11 +1055,15 @@ export interface CustomLineItem {
850
1055
  url?: PageUrlV2;
851
1056
  /** Item type. Either a preset type or custom. */
852
1057
  itemType?: ItemType;
853
- /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
1058
+ /**
1059
+ * Item price **before** catalog-defined discount. Defaults to `price` when not provided.
1060
+ * @format DECIMAL_VALUE
1061
+ */
854
1062
  fullPrice?: string | null;
855
1063
  /**
856
1064
  * Item quantity available for purchase. Only return this if inventory is managed.
857
1065
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
1066
+ * @max 100000
858
1067
  */
859
1068
  quantityAvailable?: number | null;
860
1069
  /** Physical properties of the item. */
@@ -879,6 +1088,8 @@ export interface CustomLineItem {
879
1088
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
880
1089
  * + In most cases, this field is the same as `catalogReference.catalogItemId`.
881
1090
  * + Used in membership validation.
1091
+ * @minLength 1
1092
+ * @maxLength 36
882
1093
  */
883
1094
  rootCatalogItemId?: string | null;
884
1095
  /**
@@ -886,12 +1097,20 @@ export interface CustomLineItem {
886
1097
  *
887
1098
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
888
1099
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
1100
+ * @format DECIMAL_VALUE
889
1101
  */
890
1102
  depositAmount?: string | null;
1103
+ /**
1104
+ * Delivery profile ID.
1105
+ * @format GUID
1106
+ */
1107
+ deliveryProfileId?: string | null;
891
1108
  /** 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. */
892
1109
  catalogReference?: CatalogReference;
893
1110
  /**
894
1111
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
1112
+ * @minLength 1
1113
+ * @maxLength 1000
895
1114
  * @readonly
896
1115
  */
897
1116
  consentRequiredPaymentPolicy?: string | null;
@@ -908,19 +1127,24 @@ export interface UpdateCartResponse {
908
1127
  cart?: Cart;
909
1128
  }
910
1129
  export interface AddToCurrentCartRequest {
911
- /** Catalog line items. */
1130
+ /**
1131
+ * Catalog line items.
1132
+ * @maxSize 100
1133
+ */
912
1134
  lineItems?: LineItem[];
913
1135
  /**
914
1136
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
915
1137
  *
916
1138
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
917
1139
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1140
+ * @maxSize 100
918
1141
  */
919
1142
  customLineItems?: CustomLineItem[];
920
1143
  /**
921
1144
  * Business location ID.
922
1145
  * To update a cart's business location ID, use the UpdateCart method.
923
1146
  * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
1147
+ * @format GUID
924
1148
  */
925
1149
  businessLocationId?: string | null;
926
1150
  }
@@ -929,13 +1153,17 @@ export interface AddToCartResponse {
929
1153
  cart?: Cart;
930
1154
  }
931
1155
  export interface AddToCurrentCartAndEstimateTotalsRequest {
932
- /** Catalog line items. */
1156
+ /**
1157
+ * Catalog line items.
1158
+ * @maxSize 100
1159
+ */
933
1160
  lineItems?: LineItem[];
934
1161
  /**
935
1162
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
936
1163
  *
937
1164
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
938
1165
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1166
+ * @maxSize 100
939
1167
  */
940
1168
  customLineItems?: CustomLineItem[];
941
1169
  /** Selected shipping option. */
@@ -960,15 +1188,31 @@ export interface AddToCurrentCartAndEstimateTotalsRequest {
960
1188
  calculateShipping?: boolean | null;
961
1189
  }
962
1190
  export interface SelectedMemberships {
963
- /** Selected memberships. */
1191
+ /**
1192
+ * Selected memberships.
1193
+ * @maxSize 300
1194
+ */
964
1195
  memberships?: HostSelectedMembership[];
965
1196
  }
966
1197
  export interface HostSelectedMembership {
967
- /** Membership ID. */
1198
+ /**
1199
+ * Membership ID.
1200
+ * @minLength 1
1201
+ * @maxLength 100
1202
+ */
968
1203
  id?: string;
969
- /** ID of the app providing this payment option. */
1204
+ /**
1205
+ * ID of the app providing this payment option.
1206
+ * @format GUID
1207
+ */
970
1208
  appId?: string;
971
- /** IDs of the line items this membership applies to. */
1209
+ /**
1210
+ * IDs of the line items this membership applies to.
1211
+ * @minSize 1
1212
+ * @maxSize 300
1213
+ * @minLength 1
1214
+ * @maxLength 100
1215
+ */
972
1216
  lineItemIds?: string[];
973
1217
  }
974
1218
  export interface EstimateTotalsResponse {
@@ -990,7 +1234,10 @@ export interface EstimateTotalsResponse {
990
1234
  calculationErrors?: CalculationErrors;
991
1235
  /** Weight measurement unit - defaults to site's weight unit. */
992
1236
  weightUnit?: WeightUnit;
993
- /** Currency used for pricing in this store. */
1237
+ /**
1238
+ * Currency used for pricing in this store.
1239
+ * @format CURRENCY
1240
+ */
994
1241
  currency?: string;
995
1242
  /**
996
1243
  * Minimal amount to pay in order to place the order.
@@ -1004,7 +1251,10 @@ export interface EstimateTotalsResponse {
1004
1251
  payLater?: PriceSummary;
1005
1252
  /** Information about valid and invalid memberships, and which ones are selected for usage. */
1006
1253
  membershipOptions?: MembershipOptions;
1007
- /** Additional fees */
1254
+ /**
1255
+ * Additional fees
1256
+ * @maxSize 100
1257
+ */
1008
1258
  additionalFees?: AdditionalFee[];
1009
1259
  /**
1010
1260
  * List of validation violations raised by the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
@@ -1047,7 +1297,10 @@ export interface LineItemPricesData {
1047
1297
  export interface ItemTaxFullDetails {
1048
1298
  /** Amount for which tax is calculated. */
1049
1299
  taxableAmount?: MultiCurrencyPrice;
1050
- /** Tax rate %, as a decimal point between 0 and 1. */
1300
+ /**
1301
+ * Tax rate %, as a decimal point between 0 and 1.
1302
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
1303
+ */
1051
1304
  taxRate?: string;
1052
1305
  /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
1053
1306
  totalTax?: MultiCurrencyPrice;
@@ -1059,9 +1312,15 @@ export interface ItemTaxFullDetails {
1059
1312
  rateBreakdown?: TaxRateBreakdown[];
1060
1313
  }
1061
1314
  export interface TaxRateBreakdown {
1062
- /** Name of tax against which the calculation was performed. */
1315
+ /**
1316
+ * Name of tax against which the calculation was performed.
1317
+ * @maxLength 100
1318
+ */
1063
1319
  name?: string;
1064
- /** Rate at which this tax detail was calculated. */
1320
+ /**
1321
+ * Rate at which this tax detail was calculated.
1322
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
1323
+ */
1065
1324
  rate?: string;
1066
1325
  /** Amount of tax for this tax detail. */
1067
1326
  tax?: MultiCurrencyPrice;
@@ -1071,21 +1330,31 @@ export interface TaxRateBreakdown {
1071
1330
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1072
1331
  */
1073
1332
  export interface TaxBreakdown {
1074
- /** The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec". */
1333
+ /**
1334
+ * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
1335
+ * @maxLength 200
1336
+ */
1075
1337
  jurisdiction?: string | null;
1076
1338
  /** The amount of this line item price that was considered nontaxable. (Decimal value) */
1077
1339
  nonTaxableAmount?: MultiCurrencyPrice;
1078
- /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */
1340
+ /**
1341
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
1342
+ * @decimalValue options { gte:0, maxScale:6 }
1343
+ */
1079
1344
  rate?: string | null;
1080
1345
  /** The amount of tax estimated for this line item. (Decimal value) */
1081
1346
  taxAmount?: MultiCurrencyPrice;
1082
1347
  /** The taxable amount of this line item. */
1083
1348
  taxableAmount?: MultiCurrencyPrice;
1084
- /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
1349
+ /**
1350
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
1351
+ * @maxLength 200
1352
+ */
1085
1353
  taxType?: string | null;
1086
1354
  /**
1087
1355
  * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
1088
1356
  * This name should be explicit enough to allow the merchant to understand what tax was calculated.
1357
+ * @maxLength 200
1089
1358
  */
1090
1359
  taxName?: string | null;
1091
1360
  /** The type of the jurisdiction in which this tax detail applies. */
@@ -1124,11 +1393,16 @@ export interface GiftCard {
1124
1393
  obfuscatedCode?: string;
1125
1394
  /** Gift card value. */
1126
1395
  amount?: MultiCurrencyPrice;
1127
- /** App ID of the gift card provider. */
1396
+ /**
1397
+ * App ID of the gift card provider.
1398
+ * @format GUID
1399
+ */
1128
1400
  appId?: string;
1129
1401
  /**
1130
1402
  * External ID in the gift card provider's system.
1131
1403
  * Used for integration and tracking across different platforms.
1404
+ * @minLength 1
1405
+ * @maxLength 50
1132
1406
  */
1133
1407
  externalId?: string | null;
1134
1408
  }
@@ -1205,15 +1479,27 @@ export interface ApplicationError {
1205
1479
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1206
1480
  */
1207
1481
  export interface AggregatedTaxBreakdown {
1208
- /** The name of the tax against which this tax amount was calculated. */
1482
+ /**
1483
+ * The name of the tax against which this tax amount was calculated.
1484
+ * @maxLength 200
1485
+ */
1209
1486
  taxName?: string;
1210
- /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
1487
+ /**
1488
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
1489
+ * @maxLength 200
1490
+ */
1211
1491
  taxType?: string;
1212
- /** The name of the jurisdiction in which this tax detail applies. */
1492
+ /**
1493
+ * The name of the jurisdiction in which this tax detail applies.
1494
+ * @maxLength 200
1495
+ */
1213
1496
  jurisdiction?: string;
1214
1497
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1215
1498
  jurisdictionTypeEnum?: JurisdictionType;
1216
- /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */
1499
+ /**
1500
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
1501
+ * @decimalValue options { gte:0, maxScale:6 }
1502
+ */
1217
1503
  rate?: string;
1218
1504
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1219
1505
  aggregatedTaxAmount?: MultiCurrencyPrice;
@@ -1229,18 +1515,26 @@ export interface ShippingInformation {
1229
1515
  export interface ShippingRegion {
1230
1516
  /**
1231
1517
  * Shipping region ID.
1518
+ * @format GUID
1232
1519
  * @readonly
1233
1520
  */
1234
1521
  id?: string;
1235
- /** Shipping region name. */
1522
+ /**
1523
+ * Shipping region name.
1524
+ * @maxLength 100
1525
+ */
1236
1526
  name?: string;
1237
1527
  }
1238
1528
  export interface SelectedCarrierServiceOption {
1239
- /** Unique identifier of selected option. For example, "usps_std_overnight". */
1529
+ /**
1530
+ * Unique identifier of selected option. For example, "usps_std_overnight".
1531
+ * @maxLength 100
1532
+ */
1240
1533
  code?: string;
1241
1534
  /**
1242
1535
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
1243
1536
  * For example, "Standard" or "First-Class Package International".
1537
+ * @maxLength 250
1244
1538
  * @readonly
1245
1539
  */
1246
1540
  title?: string;
@@ -1261,17 +1555,29 @@ export interface SelectedCarrierServiceOption {
1261
1555
  requestedShippingOption?: boolean;
1262
1556
  /** Other charges */
1263
1557
  otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
1264
- /** This carrier's unique ID */
1558
+ /**
1559
+ * This carrier's unique ID
1560
+ * @format GUID
1561
+ */
1265
1562
  carrierId?: string | null;
1266
- /** Delivery solution allocations to different delivery carriers and delivery regions */
1563
+ /**
1564
+ * Delivery solution allocations to different delivery carriers and delivery regions
1565
+ * @maxSize 300
1566
+ */
1267
1567
  deliveryAllocations?: DeliveryAllocation[];
1268
1568
  /** If the delivery solution is a partial and doesn't apply to all items. */
1269
1569
  partial?: boolean | null;
1270
1570
  }
1271
1571
  export interface DeliveryLogistics {
1272
- /** Expected delivery time, in free text. For example, "3-5 business days". */
1572
+ /**
1573
+ * Expected delivery time, in free text. For example, "3-5 business days".
1574
+ * @maxLength 500
1575
+ */
1273
1576
  deliveryTime?: string | null;
1274
- /** Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot". */
1577
+ /**
1578
+ * Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
1579
+ * @maxLength 1000
1580
+ */
1275
1581
  instructions?: string | null;
1276
1582
  /** Pickup details. */
1277
1583
  pickupDetails?: PickupDetails;
@@ -1313,7 +1619,10 @@ export interface SelectedCarrierServiceOptionPrices {
1313
1619
  export interface SelectedCarrierServiceOptionOtherCharge {
1314
1620
  /** Type of additional cost. */
1315
1621
  type?: ChargeType;
1316
- /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */
1622
+ /**
1623
+ * Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
1624
+ * @maxLength 200
1625
+ */
1317
1626
  details?: string | null;
1318
1627
  /** Price of added charge. */
1319
1628
  cost?: SelectedCarrierServiceOptionPrices;
@@ -1331,23 +1640,43 @@ export interface DeliveryAllocation {
1331
1640
  applicableLineItems?: ApplicableLineItems;
1332
1641
  }
1333
1642
  export interface Carrier {
1334
- /** The carrier app id */
1643
+ /**
1644
+ * The carrier app id
1645
+ * @format GUID
1646
+ */
1335
1647
  appId?: string | null;
1336
- /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
1648
+ /**
1649
+ * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
1650
+ * @maxLength 250
1651
+ */
1337
1652
  code?: string;
1338
1653
  }
1339
1654
  export interface Region {
1340
- /** The delivery region id. */
1655
+ /**
1656
+ * The delivery region id.
1657
+ * @format GUID
1658
+ */
1341
1659
  id?: string | null;
1342
- /** The delivery region name. */
1660
+ /**
1661
+ * The delivery region name.
1662
+ * @maxLength 100
1663
+ */
1343
1664
  name?: string | null;
1344
1665
  }
1345
1666
  export interface ApplicableLineItems {
1346
- /** Line items that the delivery solution is for. */
1667
+ /**
1668
+ * Line items that the delivery solution is for.
1669
+ * @maxSize 300
1670
+ * @minLength 1
1671
+ * @maxLength 100
1672
+ */
1347
1673
  lineItemIds?: string[];
1348
1674
  }
1349
1675
  export interface CarrierServiceOption {
1350
- /** Carrier ID. */
1676
+ /**
1677
+ * Carrier ID.
1678
+ * @format GUID
1679
+ */
1351
1680
  carrierId?: string;
1352
1681
  /** Shipping options offered by this carrier for this request. */
1353
1682
  shippingOptions?: ShippingOption[];
@@ -1356,18 +1685,23 @@ export interface ShippingOption {
1356
1685
  /**
1357
1686
  * Unique code of provided shipping option like "usps_std_overnight".
1358
1687
  * For legacy calculators this would be the UUID of the option.
1688
+ * @maxLength 100
1359
1689
  */
1360
1690
  code?: string;
1361
1691
  /**
1362
1692
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
1363
1693
  * For example, "Standard" or "First-Class Package International".
1694
+ * @maxLength 250
1364
1695
  */
1365
1696
  title?: string;
1366
1697
  /** Delivery logistics. */
1367
1698
  logistics?: DeliveryLogistics;
1368
1699
  /** Sipping price information. */
1369
1700
  cost?: ShippingPrice;
1370
- /** Delivery solution allocations to different delivery carriers and delivery regions */
1701
+ /**
1702
+ * Delivery solution allocations to different delivery carriers and delivery regions
1703
+ * @maxSize 300
1704
+ */
1371
1705
  deliveryAllocations?: DeliveryAllocation[];
1372
1706
  /** If the delivery solution is a partial and doesn't apply to all items. */
1373
1707
  partial?: boolean | null;
@@ -1395,6 +1729,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1395
1729
  discountType?: AppliedDiscountDiscountType;
1396
1730
  /**
1397
1731
  * IDs of line items the discount applies to.
1732
+ * @format GUID
1398
1733
  * @deprecated IDs of line items the discount applies to.
1399
1734
  * @replacedBy line_items_discounts
1400
1735
  * @targetRemovalDate 2024-06-01
@@ -1429,11 +1764,18 @@ export interface V1Coupon {
1429
1764
  export interface V1MerchantDiscount {
1430
1765
  /** Discount value. */
1431
1766
  amount?: MultiCurrencyPrice;
1432
- /** Discount Percentage. Will be calculated from items price before other discounts. */
1767
+ /**
1768
+ * Discount Percentage. Will be calculated from items price before other discounts.
1769
+ * @min 1
1770
+ * @max 100
1771
+ */
1433
1772
  percentage?: number | null;
1434
1773
  }
1435
1774
  export interface V1DiscountRule {
1436
- /** Discount rule ID */
1775
+ /**
1776
+ * Discount rule ID
1777
+ * @format GUID
1778
+ */
1437
1779
  id?: string;
1438
1780
  /** Discount rule name */
1439
1781
  name?: V1DiscountRuleName;
@@ -1441,13 +1783,24 @@ export interface V1DiscountRule {
1441
1783
  amount?: MultiCurrencyPrice;
1442
1784
  }
1443
1785
  export interface V1DiscountRuleName {
1444
- /** Original discount rule name (in site's default language). */
1786
+ /**
1787
+ * Original discount rule name (in site's default language).
1788
+ * @minLength 1
1789
+ * @maxLength 256
1790
+ */
1445
1791
  original?: string;
1446
- /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
1792
+ /**
1793
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1794
+ * @minLength 1
1795
+ * @maxLength 500
1796
+ */
1447
1797
  translated?: string | null;
1448
1798
  }
1449
1799
  export interface LineItemDiscount {
1450
- /** ID of line item the discount applies to. */
1800
+ /**
1801
+ * ID of line item the discount applies to.
1802
+ * @format GUID
1803
+ */
1451
1804
  id?: string;
1452
1805
  /** Discount value. */
1453
1806
  totalDiscountAmount?: MultiCurrencyPrice;
@@ -1577,21 +1930,43 @@ export interface CarrierError {
1577
1930
  error?: Details;
1578
1931
  }
1579
1932
  export interface MembershipOptions {
1580
- /** List of payment options that can be used. */
1933
+ /**
1934
+ * List of payment options that can be used.
1935
+ * @maxSize 300
1936
+ */
1581
1937
  eligibleMemberships?: Membership[];
1582
- /** List of payment options that are owned by the member, but cannot be used due to reason provided. */
1938
+ /**
1939
+ * List of payment options that are owned by the member, but cannot be used due to reason provided.
1940
+ * @maxSize 300
1941
+ */
1583
1942
  invalidMemberships?: InvalidMembership[];
1584
- /** The selected membership payment options and which line items they apply to. */
1943
+ /**
1944
+ * The selected membership payment options and which line items they apply to.
1945
+ * @maxSize 300
1946
+ */
1585
1947
  selectedMemberships?: HostSelectedMembership[];
1586
1948
  }
1587
1949
  export interface Membership {
1588
- /** Membership ID. */
1950
+ /**
1951
+ * Membership ID.
1952
+ * @minLength 1
1953
+ * @maxLength 100
1954
+ */
1589
1955
  id?: string;
1590
- /** ID of the application providing this payment option. */
1956
+ /**
1957
+ * ID of the application providing this payment option.
1958
+ * @format GUID
1959
+ */
1591
1960
  appId?: string;
1592
1961
  /** The name of this membership. */
1593
1962
  name?: MembershipName;
1594
- /** Line item IDs which are "paid" for by this membership. */
1963
+ /**
1964
+ * Line item IDs which are "paid" for by this membership.
1965
+ * @minSize 1
1966
+ * @maxSize 300
1967
+ * @minLength 1
1968
+ * @maxLength 100
1969
+ */
1595
1970
  lineItemIds?: string[];
1596
1971
  /** Optional - For a membership that has limited credits, information about credit usage. */
1597
1972
  credits?: MembershipPaymentCredits;
@@ -1601,13 +1976,22 @@ export interface Membership {
1601
1976
  additionalData?: Record<string, any> | null;
1602
1977
  }
1603
1978
  export interface MembershipName {
1604
- /** Membership name. */
1979
+ /**
1980
+ * Membership name.
1981
+ * @maxLength 100
1982
+ */
1605
1983
  original?: string;
1606
- /** Translated membership name. Defaults to `original` when not provided. */
1984
+ /**
1985
+ * Translated membership name. Defaults to `original` when not provided.
1986
+ * @maxLength 100
1987
+ */
1607
1988
  translated?: string | null;
1608
1989
  }
1609
1990
  export interface MembershipPaymentCredits {
1610
- /** Membership's total amount of credits. */
1991
+ /**
1992
+ * Membership's total amount of credits.
1993
+ * @min 1
1994
+ */
1611
1995
  total?: number;
1612
1996
  /** Membership's remaining amount of credits. */
1613
1997
  remaining?: number;
@@ -1615,19 +1999,35 @@ export interface MembershipPaymentCredits {
1615
1999
  export interface InvalidMembership {
1616
2000
  /** Membership details. */
1617
2001
  membership?: Membership;
1618
- /** Reason why this membership is invalid and cannot be used. */
2002
+ /**
2003
+ * Reason why this membership is invalid and cannot be used.
2004
+ * @minLength 1
2005
+ * @maxLength 100
2006
+ */
1619
2007
  reason?: string;
1620
2008
  }
1621
2009
  export interface AdditionalFee {
1622
- /** Additional fee's unique code (or ID) for future processing. */
2010
+ /**
2011
+ * Additional fee's unique code (or ID) for future processing.
2012
+ * @minLength 1
2013
+ * @maxLength 100
2014
+ */
1623
2015
  code?: string | null;
1624
- /** Translated additional fee's name. */
2016
+ /**
2017
+ * Translated additional fee's name.
2018
+ * @minLength 1
2019
+ * @maxLength 50
2020
+ */
1625
2021
  name?: string;
1626
2022
  /** Additional fee's price. */
1627
2023
  price?: MultiCurrencyPrice;
1628
2024
  /** Tax details. */
1629
2025
  taxDetails?: ItemTaxFullDetails;
1630
- /** Provider's app id. */
2026
+ /**
2027
+ * Provider's app id.
2028
+ * @minLength 1
2029
+ * @maxLength 100
2030
+ */
1631
2031
  providerAppId?: string | null;
1632
2032
  /** Additional fee's price before tax. */
1633
2033
  priceBeforeTax?: MultiCurrencyPrice;
@@ -1636,6 +2036,7 @@ export interface AdditionalFee {
1636
2036
  /**
1637
2037
  * Optional - Line items associated with this additional fee.
1638
2038
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
2039
+ * @format GUID
1639
2040
  */
1640
2041
  lineItemIds?: string[];
1641
2042
  /** the source the additional fee was added from */
@@ -1655,7 +2056,11 @@ export interface Violation {
1655
2056
  severity?: Severity;
1656
2057
  /** Target location on a checkout or cart page where the violation will be displayed. */
1657
2058
  target?: Target;
1658
- /** 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>`. */
2059
+ /**
2060
+ * 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>`.
2061
+ * @minLength 1
2062
+ * @maxLength 1000
2063
+ */
1659
2064
  description?: string | null;
1660
2065
  }
1661
2066
  export declare enum Severity {
@@ -1709,7 +2114,12 @@ export interface TargetLineItem {
1709
2114
  id?: string | null;
1710
2115
  }
1711
2116
  export interface RemoveLineItemsFromCurrentCartRequest {
1712
- /** Line item IDs to remove from cart. */
2117
+ /**
2118
+ * Line item IDs to remove from cart.
2119
+ * @format GUID
2120
+ * @minSize 1
2121
+ * @maxSize 100
2122
+ */
1713
2123
  lineItemIds?: string[];
1714
2124
  }
1715
2125
  export interface RemoveLineItemsResponse {
@@ -1725,7 +2135,10 @@ export interface CreateCheckoutFromCurrentCartRequest {
1725
2135
  billingAddress?: Address;
1726
2136
  /** Selected shipping option. */
1727
2137
  selectedShippingOption?: SelectedShippingOption;
1728
- /** Mandatory when setting billing or shipping address and user is not logged in. */
2138
+ /**
2139
+ * Mandatory when setting billing or shipping address and user is not logged in.
2140
+ * @format EMAIL
2141
+ */
1729
2142
  email?: string | null;
1730
2143
  }
1731
2144
  export declare enum ChannelType {
@@ -1773,13 +2186,24 @@ export interface RemoveCouponResponse {
1773
2186
  cart?: Cart;
1774
2187
  }
1775
2188
  export interface UpdateCurrentCartLineItemQuantityRequest {
1776
- /** Line item IDs and their new quantity. */
2189
+ /**
2190
+ * Line item IDs and their new quantity.
2191
+ * @minSize 1
2192
+ * @maxSize 100
2193
+ */
1777
2194
  lineItems?: LineItemQuantityUpdate[];
1778
2195
  }
1779
2196
  export interface LineItemQuantityUpdate {
1780
- /** Line item ID. Required. */
2197
+ /**
2198
+ * Line item ID. Required.
2199
+ * @format GUID
2200
+ */
1781
2201
  id?: string;
1782
- /** New quantity. Number must be 1 or higher. Required. */
2202
+ /**
2203
+ * New quantity. Number must be 1 or higher. Required.
2204
+ * @min 1
2205
+ * @max 100000
2206
+ */
1783
2207
  quantity?: number;
1784
2208
  }
1785
2209
  export interface UpdateLineItemsQuantityResponse {
@@ -1885,9 +2309,15 @@ export interface ActionEvent {
1885
2309
  bodyAsJson?: string;
1886
2310
  }
1887
2311
  export interface MessageEnvelope {
1888
- /** App instance ID. */
2312
+ /**
2313
+ * App instance ID.
2314
+ * @format GUID
2315
+ */
1889
2316
  instanceId?: string | null;
1890
- /** Event type. */
2317
+ /**
2318
+ * Event type.
2319
+ * @maxLength 150
2320
+ */
1891
2321
  eventType?: string;
1892
2322
  /** The identification type and identity data. */
1893
2323
  identity?: IdentificationData;
@@ -1895,26 +2325,50 @@ export interface MessageEnvelope {
1895
2325
  data?: string;
1896
2326
  }
1897
2327
  export interface IdentificationData extends IdentificationDataIdOneOf {
1898
- /** ID of a site visitor that has not logged in to the site. */
2328
+ /**
2329
+ * ID of a site visitor that has not logged in to the site.
2330
+ * @format GUID
2331
+ */
1899
2332
  anonymousVisitorId?: string;
1900
- /** ID of a site visitor that has logged in to the site. */
2333
+ /**
2334
+ * ID of a site visitor that has logged in to the site.
2335
+ * @format GUID
2336
+ */
1901
2337
  memberId?: string;
1902
- /** ID of a Wix user (site owner, contributor, etc.). */
2338
+ /**
2339
+ * ID of a Wix user (site owner, contributor, etc.).
2340
+ * @format GUID
2341
+ */
1903
2342
  wixUserId?: string;
1904
- /** ID of an app. */
2343
+ /**
2344
+ * ID of an app.
2345
+ * @format GUID
2346
+ */
1905
2347
  appId?: string;
1906
2348
  /** @readonly */
1907
2349
  identityType?: WebhookIdentityType;
1908
2350
  }
1909
2351
  /** @oneof */
1910
2352
  export interface IdentificationDataIdOneOf {
1911
- /** ID of a site visitor that has not logged in to the site. */
2353
+ /**
2354
+ * ID of a site visitor that has not logged in to the site.
2355
+ * @format GUID
2356
+ */
1912
2357
  anonymousVisitorId?: string;
1913
- /** ID of a site visitor that has logged in to the site. */
2358
+ /**
2359
+ * ID of a site visitor that has logged in to the site.
2360
+ * @format GUID
2361
+ */
1914
2362
  memberId?: string;
1915
- /** ID of a Wix user (site owner, contributor, etc.). */
2363
+ /**
2364
+ * ID of a Wix user (site owner, contributor, etc.).
2365
+ * @format GUID
2366
+ */
1916
2367
  wixUserId?: string;
1917
- /** ID of an app. */
2368
+ /**
2369
+ * ID of an app.
2370
+ * @format GUID
2371
+ */
1918
2372
  appId?: string;
1919
2373
  }
1920
2374
  export declare enum WebhookIdentityType {
@@ -1929,15 +2383,22 @@ export interface CreateCartRequest {
1929
2383
  cartInfo?: Cart;
1930
2384
  /** Code of an existing coupon to apply to cart. For more information, see the [Coupons API](https://dev.wix.com/api/rest/coupons/coupons/introduction). */
1931
2385
  couponCode?: string | null;
1932
- /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart. */
2386
+ /**
2387
+ * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
2388
+ * @maxSize 100
2389
+ */
1933
2390
  merchantDiscounts?: MerchantDiscountInput[];
1934
- /** Catalog line items. */
2391
+ /**
2392
+ * Catalog line items.
2393
+ * @maxSize 300
2394
+ */
1935
2395
  lineItems?: LineItem[];
1936
2396
  /**
1937
2397
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1938
2398
  *
1939
2399
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1940
2400
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2401
+ * @maxSize 300
1941
2402
  */
1942
2403
  customLineItems?: CustomLineItem[];
1943
2404
  }
@@ -1946,7 +2407,10 @@ export interface CreateCartResponse {
1946
2407
  cart?: Cart;
1947
2408
  }
1948
2409
  export interface GetCartRequest {
1949
- /** Cart ID. */
2410
+ /**
2411
+ * Cart ID.
2412
+ * @format GUID
2413
+ */
1950
2414
  id: string;
1951
2415
  }
1952
2416
  export interface GetCartResponse {
@@ -1954,7 +2418,10 @@ export interface GetCartResponse {
1954
2418
  cart?: Cart;
1955
2419
  }
1956
2420
  export interface GetCartByCheckoutIdRequest {
1957
- /** Checkout ID. */
2421
+ /**
2422
+ * Checkout ID.
2423
+ * @format GUID
2424
+ */
1958
2425
  id: string;
1959
2426
  }
1960
2427
  export interface GetCartByCheckoutIdResponse {
@@ -1962,32 +2429,51 @@ export interface GetCartByCheckoutIdResponse {
1962
2429
  cart?: Cart;
1963
2430
  }
1964
2431
  export interface AddToCartRequest {
1965
- /** Cart ID. */
2432
+ /**
2433
+ * Cart ID.
2434
+ * @format GUID
2435
+ */
1966
2436
  id: string;
1967
- /** Catalog line items. */
2437
+ /**
2438
+ * Catalog line items.
2439
+ * @maxSize 100
2440
+ */
1968
2441
  lineItems?: LineItem[];
1969
2442
  /**
1970
2443
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1971
2444
  *
1972
2445
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1973
2446
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2447
+ * @maxSize 100
1974
2448
  */
1975
2449
  customLineItems?: CustomLineItem[];
1976
2450
  /**
1977
2451
  * The business location ID associated with the cart.
1978
2452
  * The `businessLocationId` field cannot be passed if one already exists on the cart. To update a cart's business location ID, use the UpdateCart method.
1979
2453
  * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
2454
+ * @format GUID
1980
2455
  */
1981
2456
  businessLocationId?: string | null;
1982
2457
  }
1983
2458
  export interface RemoveLineItemsRequest {
1984
- /** Cart ID. */
2459
+ /**
2460
+ * Cart ID.
2461
+ * @format GUID
2462
+ */
1985
2463
  id: string;
1986
- /** Line item IDs to remove from cart. */
2464
+ /**
2465
+ * Line item IDs to remove from cart.
2466
+ * @format GUID
2467
+ * @minSize 1
2468
+ * @maxSize 100
2469
+ */
1987
2470
  lineItemIds: string[];
1988
2471
  }
1989
2472
  export interface CreateCheckoutRequest {
1990
- /** Cart ID. */
2473
+ /**
2474
+ * Cart ID.
2475
+ * @format GUID
2476
+ */
1991
2477
  id: string;
1992
2478
  /** __Required.__ Sales channel type. */
1993
2479
  channelType?: ChannelType;
@@ -1997,21 +2483,37 @@ export interface CreateCheckoutRequest {
1997
2483
  billingAddress?: Address;
1998
2484
  /** Selected shipping option. */
1999
2485
  selectedShippingOption?: SelectedShippingOption;
2000
- /** Required when setting a billing or shipping address if the site visitor isn't logged in. */
2486
+ /**
2487
+ * Required when setting a billing or shipping address if the site visitor isn't logged in.
2488
+ * @format EMAIL
2489
+ */
2001
2490
  email?: string | null;
2002
2491
  }
2003
2492
  export interface RemoveCouponRequest {
2004
- /** Cart ID. */
2493
+ /**
2494
+ * Cart ID.
2495
+ * @format GUID
2496
+ */
2005
2497
  id: string;
2006
2498
  }
2007
2499
  export interface UpdateLineItemsQuantityRequest {
2008
- /** Cart ID. */
2500
+ /**
2501
+ * Cart ID.
2502
+ * @format GUID
2503
+ */
2009
2504
  id: string;
2010
- /** Line item IDs and their new quantity. */
2505
+ /**
2506
+ * Line item IDs and their new quantity.
2507
+ * @minSize 1
2508
+ * @maxSize 100
2509
+ */
2011
2510
  lineItems: LineItemQuantityUpdate[];
2012
2511
  }
2013
2512
  export interface EstimateTotalsRequest {
2014
- /** Cart ID. */
2513
+ /**
2514
+ * Cart ID.
2515
+ * @format GUID
2516
+ */
2015
2517
  id: string;
2016
2518
  /** Selected shipping option. */
2017
2519
  selectedShippingOption?: SelectedShippingOption;
@@ -2035,13 +2537,19 @@ export interface EstimateTotalsRequest {
2035
2537
  calculateShipping?: boolean | null;
2036
2538
  }
2037
2539
  export interface DeleteCartRequest {
2038
- /** ID of the cart to delete. */
2540
+ /**
2541
+ * ID of the cart to delete.
2542
+ * @format GUID
2543
+ */
2039
2544
  id: string;
2040
2545
  }
2041
2546
  export interface Empty {
2042
2547
  }
2043
2548
  export interface RemoveBusinessLocationRequest {
2044
- /** Cart ID. */
2549
+ /**
2550
+ * Cart ID.
2551
+ * @format GUID
2552
+ */
2045
2553
  id: string;
2046
2554
  }
2047
2555
  export interface RemoveBusinessLocationResponse {