@wix/auto_sdk_ecom_draft-orders 1.0.1 → 1.0.2

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 (21) hide show
  1. package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +985 -217
  2. package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
  3. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1054 -223
  4. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
  5. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
  6. package/build/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +985 -217
  7. package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
  8. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1054 -223
  9. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
  10. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
  11. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +970 -224
  12. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
  13. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1054 -262
  14. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
  15. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
  16. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +970 -224
  17. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
  18. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1054 -262
  19. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
  20. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
  21. package/package.json +2 -2
@@ -2,14 +2,20 @@
2
2
  export interface DraftOrder {
3
3
  /**
4
4
  * Draft order ID.
5
+ * @format GUID
5
6
  * @readonly
6
7
  */
7
8
  id?: string | null;
8
- /** ID of the order this draft commits to. */
9
+ /**
10
+ * ID of the order this draft commits to.
11
+ * @format GUID
12
+ */
9
13
  orderId?: string | null;
10
14
  /**
11
15
  * Line items.
12
16
  * Includes details about changes when relevant.
17
+ * @minSize 1
18
+ * @maxSize 300
13
19
  */
14
20
  lineItems?: ItemDetails[];
15
21
  /**
@@ -34,11 +40,13 @@ export interface DraftOrder {
34
40
  /**
35
41
  * Additional fees.
36
42
  * Includes details about the source, and whether the additional fee is applied to the order.
43
+ * @maxSize 100
37
44
  */
38
45
  additionalFees?: AdditionalFeeDetails[];
39
46
  /**
40
47
  * Discounts.
41
48
  * Includes details about the source, and whether the discount is applied to the order.
49
+ * @maxSize 320
42
50
  */
43
51
  discounts?: DiscountDetails[];
44
52
  /**
@@ -63,7 +71,10 @@ export interface DraftOrder {
63
71
  status?: EditingStatus;
64
72
  /** Weight measurement unit. Defaults to the site's weight unit. */
65
73
  weightUnit?: WeightUnit;
66
- /** Currency used for pricing. */
74
+ /**
75
+ * Currency used for pricing.
76
+ * @format CURRENCY
77
+ */
67
78
  currency?: string | null;
68
79
  /**
69
80
  * Price summary.
@@ -89,9 +100,15 @@ export interface DraftOrder {
89
100
  balanceSummary?: BalanceSummary;
90
101
  /** Side effects to perform on commit. */
91
102
  commitSettings?: DraftOrderCommitSettings;
92
- /** Member ID (if order created by a member). */
103
+ /**
104
+ * Member ID (if order created by a member).
105
+ * @format GUID
106
+ */
93
107
  memberId?: string | null;
94
- /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
108
+ /**
109
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
110
+ * @format GUID
111
+ */
95
112
  purchaseFlowId?: string | null;
96
113
  recipientInfo?: RecipientInfoDetails;
97
114
  /**
@@ -99,6 +116,11 @@ export interface DraftOrder {
99
116
  * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
100
117
  */
101
118
  extendedFields?: ExtendedFields;
119
+ /**
120
+ * Order business location
121
+ * Includes details about changes when relevant.
122
+ */
123
+ businessLocationDetails?: BusinessLocationDetails;
102
124
  }
103
125
  export interface ItemDetails extends ItemDetailsChangeTypeOneOf {
104
126
  /** Whether the line item was added as part of the draft. */
@@ -120,7 +142,10 @@ export interface ItemDetailsChangeTypeOneOf {
120
142
  removed?: boolean;
121
143
  }
122
144
  export interface Price {
123
- /** Amount. */
145
+ /**
146
+ * Amount.
147
+ * @decimalValue options { gte:0, lte:1000000000000000 }
148
+ */
124
149
  amount?: string;
125
150
  /**
126
151
  * Amount formatted with currency symbol.
@@ -129,17 +154,26 @@ export interface Price {
129
154
  formattedAmount?: string;
130
155
  }
131
156
  export interface PriceDescription {
132
- /** __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). */
157
+ /**
158
+ * __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).
159
+ * @minLength 1
160
+ * @maxLength 100
161
+ */
133
162
  original?: string;
134
163
  /**
135
164
  * Price description translated into the buyer's language.
136
165
  *
137
166
  * Default: Same as `original`.
167
+ * @minLength 1
168
+ * @maxLength 100
138
169
  */
139
170
  translated?: string | null;
140
171
  }
141
172
  export interface OrderLineItem {
142
- /** Line item ID. */
173
+ /**
174
+ * Line item ID.
175
+ * @immutable
176
+ */
143
177
  id?: string;
144
178
  /**
145
179
  * Item name.
@@ -153,14 +187,21 @@ export interface OrderLineItem {
153
187
  * This field may be empty in the case of a custom line item.
154
188
  */
155
189
  catalogReference?: CatalogReference;
156
- /** Line item quantity. */
190
+ /**
191
+ * Line item quantity.
192
+ * @min 1
193
+ * @max 100000
194
+ */
157
195
  quantity?: number;
158
196
  /**
159
197
  * Total discount for this line item's entire quantity.
160
198
  * @readonly
161
199
  */
162
200
  totalDiscount?: Price;
163
- /** Line item description lines. Used for display purposes for the cart, checkout and order. */
201
+ /**
202
+ * Line item description lines. Used for display purposes for the cart, checkout and order.
203
+ * @maxSize 20
204
+ */
164
205
  descriptionLines?: DescriptionLine[];
165
206
  /** Line item image. */
166
207
  image?: Image;
@@ -171,11 +212,18 @@ export interface OrderLineItem {
171
212
  /**
172
213
  * Fulfiller ID. Field is empty when the line item is self-fulfilled.
173
214
  * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
215
+ * @format GUID
174
216
  */
175
217
  fulfillerId?: string | null;
176
- /** Number of items that were refunded. */
218
+ /**
219
+ * Number of items that were refunded.
220
+ * @max 100000
221
+ */
177
222
  refundQuantity?: number | null;
178
- /** Number of items restocked. */
223
+ /**
224
+ * Number of items restocked.
225
+ * @max 100000
226
+ */
179
227
  restockQuantity?: number | null;
180
228
  /** Line item price after line item discounts for display purposes. */
181
229
  price?: Price;
@@ -195,11 +243,9 @@ export interface OrderLineItem {
195
243
  */
196
244
  totalPriceAfterTax?: Price;
197
245
  /**
198
- * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
199
- * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
200
- * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
201
- * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
202
- * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.
246
+ * Type of selected payment option for current item.
247
+ *
248
+ * Default: `FULL_PAYMENT_ONLINE`
203
249
  */
204
250
  paymentOption?: PaymentOptionType;
205
251
  /**
@@ -239,6 +285,8 @@ export interface ProductName {
239
285
  *
240
286
  * Min: 1 character.
241
287
  * Max: 200 characters.
288
+ * @minLength 1
289
+ * @maxLength 200
242
290
  */
243
291
  original?: string;
244
292
  /**
@@ -247,12 +295,18 @@ export interface ProductName {
247
295
  * Min: 1 character.
248
296
  * Max: 400 characters.
249
297
  * Default: Same as `original`.
298
+ * @minLength 1
299
+ * @maxLength 400
250
300
  */
251
301
  translated?: string | null;
252
302
  }
253
303
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
254
304
  export interface CatalogReference {
255
- /** ID of the item within the catalog it belongs to. */
305
+ /**
306
+ * ID of the item within the catalog it belongs to.
307
+ * @minLength 1
308
+ * @maxLength 36
309
+ */
256
310
  catalogItemId?: string;
257
311
  /**
258
312
  * ID of the app providing the catalog.
@@ -263,6 +317,7 @@ export interface CatalogReference {
263
317
  * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
264
318
  * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
265
319
  * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
320
+ * @minLength 1
266
321
  */
267
322
  appId?: string;
268
323
  /**
@@ -291,32 +346,44 @@ export interface DescriptionLineValueOneOf {
291
346
  export interface DescriptionLineDescriptionLineValueOneOf {
292
347
  }
293
348
  export interface DescriptionLineName {
294
- /** 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). */
349
+ /**
350
+ * 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).
351
+ * @maxLength 100
352
+ */
295
353
  original?: string;
296
354
  /**
297
355
  * Description line name translated into the buyer's language.
298
356
  *
299
357
  * Default: Same as `original`.
358
+ * @maxLength 200
300
359
  */
301
360
  translated?: string | null;
302
361
  }
303
362
  export interface PlainTextValue {
304
- /** 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). */
363
+ /**
364
+ * 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).
365
+ * @maxLength 600
366
+ */
305
367
  original?: string;
306
368
  /**
307
369
  * Description line plain text value translated into the buyer's language.
308
370
  *
309
371
  * Default: Same as `original`.
372
+ * @maxLength 600
310
373
  */
311
374
  translated?: string | null;
312
375
  }
313
376
  export interface Color {
314
- /** 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). */
377
+ /**
378
+ * 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).
379
+ * @maxLength 500
380
+ */
315
381
  original?: string;
316
382
  /**
317
383
  * Description line color name translated into the buyer's language.
318
384
  *
319
385
  * Default: Same as `original`.
386
+ * @maxLength 500
320
387
  */
321
388
  translated?: string | null;
322
389
  /** HEX or RGB color code for display. */
@@ -366,7 +433,10 @@ export interface FocalPoint {
366
433
  export interface PhysicalProperties {
367
434
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
368
435
  weight?: number | null;
369
- /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
436
+ /**
437
+ * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
438
+ * @maxLength 40
439
+ */
370
440
  sku?: string | null;
371
441
  /** Whether this line item is shippable. */
372
442
  shippable?: boolean;
@@ -407,7 +477,10 @@ export declare enum PaymentOptionType {
407
477
  export interface ItemTaxFullDetails {
408
478
  /** Taxable amount of this line item. */
409
479
  taxableAmount?: Price;
410
- /** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`. */
480
+ /**
481
+ * Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
482
+ * @decimalValue options { gte:0, maxScale:6 }
483
+ */
411
484
  taxRate?: string;
412
485
  /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
413
486
  totalTax?: Price;
@@ -417,16 +490,24 @@ export interface LineItemTaxInfo {
417
490
  taxAmount?: Price;
418
491
  /** Amount for which tax is calculated. */
419
492
  taxableAmount?: Price;
420
- /** Tax rate %, as a decimal point. */
493
+ /**
494
+ * Tax rate %, as a decimal point.
495
+ * @format DECIMAL_VALUE
496
+ * @decimalValue options { gte:0, maxScale:6 }
497
+ */
421
498
  taxRate?: string | null;
422
499
  /**
423
500
  * Tax group ID.
424
501
  * Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
502
+ * @format GUID
425
503
  */
426
504
  taxGroupId?: string | null;
427
505
  /** Indicates whether the price already includes tax. */
428
506
  taxIncludedInPrice?: boolean;
429
- /** Tax information for a line item. */
507
+ /**
508
+ * Tax information for a line item.
509
+ * @maxSize 7
510
+ */
430
511
  taxBreakdown?: LineItemTaxBreakdown[];
431
512
  }
432
513
  /**
@@ -434,17 +515,28 @@ export interface LineItemTaxInfo {
434
515
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
435
516
  */
436
517
  export interface LineItemTaxBreakdown {
437
- /** Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". */
518
+ /**
519
+ * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
520
+ * @maxLength 200
521
+ */
438
522
  jurisdiction?: string | null;
439
- /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. */
523
+ /**
524
+ * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
525
+ * @format DECIMAL_VALUE
526
+ * @decimalValue options { gte:0, maxScale:6 }
527
+ */
440
528
  rate?: string | null;
441
529
  /** Amount of tax calculated for this line item. */
442
530
  taxAmount?: Price;
443
- /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
531
+ /**
532
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
533
+ * @maxLength 200
534
+ */
444
535
  taxType?: string | null;
445
536
  /**
446
537
  * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
447
538
  * This name should be explicit enough to allow the merchant to understand what tax was calculated.
539
+ * @maxLength 200
448
540
  */
449
541
  taxName?: string | null;
450
542
  /** Type of jurisdiction that taxes were calculated for. */
@@ -464,9 +556,18 @@ export declare enum JurisdictionType {
464
556
  SPECIAL = "SPECIAL"
465
557
  }
466
558
  export interface DigitalFile {
467
- /** ID of the secure file in media. */
559
+ /**
560
+ * ID of the secure file in media.
561
+ * @minLength 1
562
+ * @maxLength 100
563
+ */
468
564
  fileId?: string;
469
- /** Link will exist after the digital links have been generated on the order. */
565
+ /**
566
+ * Link will exist after the digital links have been generated on the order.
567
+ * @format WEB_URL
568
+ * @minLength 1
569
+ * @maxLength 2000
570
+ */
470
571
  link?: string | null;
471
572
  /**
472
573
  * Link expiration time and date.
@@ -475,25 +576,48 @@ export interface DigitalFile {
475
576
  expirationDate?: Date | null;
476
577
  }
477
578
  export interface SubscriptionInfo {
478
- /** Subscription ID. */
579
+ /**
580
+ * Subscription ID.
581
+ * @format GUID
582
+ */
479
583
  id?: string | null;
480
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
584
+ /**
585
+ * Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
586
+ * @min 1
587
+ */
481
588
  cycleNumber?: number;
482
- /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
589
+ /**
590
+ * Subscription option title. For example, `"Monthly coffee Subscription"`.
591
+ * @minLength 1
592
+ * @maxLength 20
593
+ */
483
594
  subscriptionOptionTitle?: string;
484
- /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
595
+ /**
596
+ * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
597
+ * @maxLength 60
598
+ */
485
599
  subscriptionOptionDescription?: string | null;
486
- /** Subscription detailed information. */
600
+ /**
601
+ * Subscription detailed information.
602
+ * @immutable
603
+ */
487
604
  subscriptionSettings?: SubscriptionSettings;
488
605
  }
489
606
  export interface SubscriptionSettings {
490
607
  /** Frequency of recurring payment. */
491
608
  frequency?: SubscriptionFrequency;
492
- /** Interval of recurring payment. */
609
+ /**
610
+ * Interval of recurring payment.
611
+ * @min 1
612
+ * @max 50
613
+ */
493
614
  interval?: number | null;
494
615
  /** Whether subscription is renewed automatically at the end of each period. */
495
616
  autoRenewal?: boolean;
496
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
617
+ /**
618
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
619
+ * @min 1
620
+ */
497
621
  billingCycles?: number | null;
498
622
  }
499
623
  /** Frequency unit of recurring payment */
@@ -507,19 +631,31 @@ export declare enum SubscriptionFrequency {
507
631
  export interface FreeTrialPeriod {
508
632
  /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
509
633
  frequency?: SubscriptionFrequency;
510
- /** interval of period */
634
+ /**
635
+ * interval of period
636
+ * @min 1
637
+ * @max 50
638
+ */
511
639
  interval?: number;
512
640
  }
513
641
  export interface LocationAndQuantity {
514
- /** Location id in the associated owner app. */
642
+ /**
643
+ * Location id in the associated owner app.
644
+ * @format GUID
645
+ */
515
646
  id?: string;
516
647
  /**
517
648
  * Location owner app, if not provided then the site business info locations will be used.
649
+ * @format GUID
518
650
  * @deprecated Location owner app, if not provided then the site business info locations will be used.
519
651
  * @targetRemovalDate 2025-03-01
520
652
  */
521
653
  appId?: string | null;
522
- /** Quantity for specific location. */
654
+ /**
655
+ * Quantity for specific location.
656
+ * @min 1
657
+ * @max 100000
658
+ */
523
659
  quantity?: number;
524
660
  }
525
661
  export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
@@ -549,7 +685,11 @@ export interface ExtendedFields {
549
685
  namespaces?: Record<string, Record<string, any>>;
550
686
  }
551
687
  export interface ItemChangedDetails {
552
- /** Line item quantity before change. */
688
+ /**
689
+ * Line item quantity before change.
690
+ * @min 1
691
+ * @max 1000000
692
+ */
553
693
  quantityBeforeChange?: number | null;
554
694
  /** Line item price before change. */
555
695
  priceBeforeChange?: Price;
@@ -576,13 +716,22 @@ export interface ShippingDetailsChangeTypeOneOf {
576
716
  removed?: boolean;
577
717
  }
578
718
  export interface V1ShippingInformation {
579
- /** App Def Id of external provider which was a source of shipping info */
719
+ /**
720
+ * App Def Id of external provider which was a source of shipping info
721
+ * @minLength 1
722
+ * @maxLength 100
723
+ */
580
724
  carrierId?: string | null;
581
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
725
+ /**
726
+ * Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
727
+ * @minLength 1
728
+ * @maxLength 100
729
+ */
582
730
  code?: string | null;
583
731
  /**
584
732
  * Shipping option title.
585
733
  * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
734
+ * @maxLength 250
586
735
  */
587
736
  title?: string;
588
737
  /** Shipping logistics. */
@@ -597,9 +746,15 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
597
746
  shippingDestination?: AddressWithContact;
598
747
  /** Pickup details. */
599
748
  pickupDetails?: V1PickupDetails;
600
- /** Expected delivery time in free text. For example, `"3-5 business days"`. */
749
+ /**
750
+ * Expected delivery time in free text. For example, `"3-5 business days"`.
751
+ * @maxLength 500
752
+ */
601
753
  deliveryTime?: string | null;
602
- /** Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. */
754
+ /**
755
+ * Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
756
+ * @maxLength 1000
757
+ */
603
758
  instructions?: string | null;
604
759
  /**
605
760
  * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
@@ -625,19 +780,37 @@ export interface AddressWithContact {
625
780
  }
626
781
  /** Physical address */
627
782
  export interface Address {
628
- /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
783
+ /**
784
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
785
+ * @format COUNTRY
786
+ */
629
787
  country?: string | null;
630
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
788
+ /**
789
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
790
+ * @maxLength 50
791
+ */
631
792
  subdivision?: string | null;
632
- /** City name. */
793
+ /**
794
+ * City name.
795
+ * @maxLength 50
796
+ */
633
797
  city?: string | null;
634
- /** Postal or zip code. */
798
+ /**
799
+ * Postal or zip code.
800
+ * @maxLength 50
801
+ */
635
802
  postalCode?: string | null;
636
803
  /** Street address. */
637
804
  streetAddress?: StreetAddress;
638
- /** Main address line (usually street name and number). */
805
+ /**
806
+ * Main address line (usually street name and number).
807
+ * @maxLength 150
808
+ */
639
809
  addressLine?: string | null;
640
- /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
810
+ /**
811
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
812
+ * @maxLength 100
813
+ */
641
814
  addressLine2?: string | null;
642
815
  /**
643
816
  * Country's full name.
@@ -664,13 +837,25 @@ export interface AddressLocation {
664
837
  }
665
838
  /** Full contact details for an address */
666
839
  export interface FullAddressContactDetails {
667
- /** First name. */
840
+ /**
841
+ * First name.
842
+ * @maxLength 100
843
+ */
668
844
  firstName?: string | null;
669
- /** Last name. */
845
+ /**
846
+ * Last name.
847
+ * @maxLength 100
848
+ */
670
849
  lastName?: string | null;
671
- /** Phone number. */
850
+ /**
851
+ * Phone number.
852
+ * @format PHONE
853
+ */
672
854
  phone?: string | null;
673
- /** Company name. */
855
+ /**
856
+ * Company name.
857
+ * @maxLength 1000
858
+ */
674
859
  company?: string | null;
675
860
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
676
861
  vatId?: VatId;
@@ -703,19 +888,37 @@ export interface V1PickupDetails {
703
888
  }
704
889
  /** Physical address */
705
890
  export interface PickupAddress {
706
- /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
891
+ /**
892
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
893
+ * @format COUNTRY
894
+ */
707
895
  country?: string | null;
708
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
896
+ /**
897
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
898
+ * @maxLength 50
899
+ */
709
900
  subdivision?: string | null;
710
- /** City name. */
901
+ /**
902
+ * City name.
903
+ * @maxLength 1000
904
+ */
711
905
  city?: string | null;
712
- /** Postal or zip code. */
906
+ /**
907
+ * Postal or zip code.
908
+ * @maxLength 1000
909
+ */
713
910
  postalCode?: string | null;
714
911
  /** Street address object, with number, name, and apartment number in separate fields. */
715
912
  streetAddress?: StreetAddress;
716
- /** Main address line (usually street name and number). */
913
+ /**
914
+ * Main address line (usually street name and number).
915
+ * @maxLength 1000
916
+ */
717
917
  addressLine?: string | null;
718
- /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
918
+ /**
919
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
920
+ * @maxLength 1000
921
+ */
719
922
  addressLine2?: string | null;
720
923
  /**
721
924
  * Country's full name.
@@ -761,7 +964,10 @@ export interface V1ShippingPrice {
761
964
  discount?: Price;
762
965
  }
763
966
  export interface ShippingRegion {
764
- /** Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. */
967
+ /**
968
+ * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
969
+ * @maxLength 100
970
+ */
765
971
  name?: string | null;
766
972
  }
767
973
  export interface ShippingChangedDetails {
@@ -770,20 +976,38 @@ export interface ShippingChangedDetails {
770
976
  }
771
977
  /** Buyer Info */
772
978
  export interface BuyerInfo extends BuyerInfoIdOneOf {
773
- /** Visitor ID (if site visitor is not a member). */
979
+ /**
980
+ * Visitor ID (if site visitor is not a member).
981
+ * @format GUID
982
+ */
774
983
  visitorId?: string;
775
- /** Member ID (if site visitor is a site member). */
984
+ /**
985
+ * Member ID (if site visitor is a site member).
986
+ * @format GUID
987
+ */
776
988
  memberId?: string;
777
- /** Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction). */
989
+ /**
990
+ * Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
991
+ * @format GUID
992
+ */
778
993
  contactId?: string | null;
779
- /** Buyer email address. */
994
+ /**
995
+ * Buyer email address.
996
+ * @format EMAIL
997
+ */
780
998
  email?: string | null;
781
999
  }
782
1000
  /** @oneof */
783
1001
  export interface BuyerInfoIdOneOf {
784
- /** Visitor ID (if site visitor is not a member). */
1002
+ /**
1003
+ * Visitor ID (if site visitor is not a member).
1004
+ * @format GUID
1005
+ */
785
1006
  visitorId?: string;
786
- /** Member ID (if site visitor is a site member). */
1007
+ /**
1008
+ * Member ID (if site visitor is a site member).
1009
+ * @format GUID
1010
+ */
787
1011
  memberId?: string;
788
1012
  }
789
1013
  export interface AdditionalFeeDetails {
@@ -803,32 +1027,51 @@ export interface AdditionalFeeDetails {
803
1027
  applied?: boolean;
804
1028
  }
805
1029
  export interface AdditionalFee {
806
- /** Additional fee's unique code for future processing. */
1030
+ /**
1031
+ * Additional fee's unique code for future processing.
1032
+ * @minLength 1
1033
+ * @maxLength 100
1034
+ */
807
1035
  code?: string | null;
808
- /** Name of additional fee. */
1036
+ /**
1037
+ * Name of additional fee.
1038
+ * @minLength 1
1039
+ * @maxLength 50
1040
+ */
809
1041
  name?: string;
810
1042
  /** Additional fee's price. */
811
1043
  price?: Price;
812
1044
  /** Tax details. */
813
1045
  taxDetails?: ItemTaxFullDetails;
814
- /** SPI implementer's `appId`. */
1046
+ /**
1047
+ * SPI implementer's `appId`.
1048
+ * @format GUID
1049
+ */
815
1050
  providerAppId?: string | null;
816
1051
  /** Additional fee's price before tax. */
817
1052
  priceBeforeTax?: Price;
818
1053
  /** Additional fee's price after tax. */
819
1054
  priceAfterTax?: Price;
820
- /** Additional fee's id. */
1055
+ /**
1056
+ * Additional fee's id.
1057
+ * @format GUID
1058
+ * @immutable
1059
+ */
821
1060
  id?: string;
822
1061
  /**
823
1062
  * Optional - Line items associated with this additional fee.
824
1063
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1064
+ * @format GUID
825
1065
  */
826
1066
  lineItemIds?: string[];
827
1067
  }
828
1068
  export interface TaxDetails {
829
1069
  /** Indication if additional fee is taxable or not */
830
1070
  taxable?: boolean;
831
- /** Optional tax group ID to use when calculating tax for this additional fee */
1071
+ /**
1072
+ * Optional tax group ID to use when calculating tax for this additional fee
1073
+ * @format GUID
1074
+ */
832
1075
  taxGroupId?: string | null;
833
1076
  }
834
1077
  export declare enum SourceType {
@@ -870,13 +1113,19 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
870
1113
  /**
871
1114
  * IDs of line items discount applies to.
872
1115
  * Deprecated. Use `line_item_discounts` instead.
1116
+ * @format GUID
1117
+ * @maxSize 1
873
1118
  * @deprecated IDs of line items discount applies to.
874
1119
  * Deprecated. Use `line_item_discounts` instead.
875
1120
  * @replacedBy line_item_discounts
876
1121
  * @targetRemovalDate 2024-10-30
877
1122
  */
878
1123
  lineItemIds?: string[];
879
- /** Discount id. */
1124
+ /**
1125
+ * Discount id.
1126
+ * @format GUID
1127
+ * @immutable
1128
+ */
880
1129
  id?: string | null;
881
1130
  }
882
1131
  /** @oneof */
@@ -910,7 +1159,10 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
910
1159
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
911
1160
  */
912
1161
  discountReason?: DiscountReason;
913
- /** Discount description as free text (optional). */
1162
+ /**
1163
+ * Discount description as free text (optional).
1164
+ * @maxLength 200
1165
+ */
914
1166
  description?: string | null;
915
1167
  /** Discount amount. */
916
1168
  amount?: Price;
@@ -922,7 +1174,10 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
922
1174
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
923
1175
  */
924
1176
  discountReason?: DiscountReason;
925
- /** Discount description as free text (optional). */
1177
+ /**
1178
+ * Discount description as free text (optional).
1179
+ * @maxLength 200
1180
+ */
926
1181
  description?: string | null;
927
1182
  }
928
1183
  export declare enum DiscountReason {
@@ -930,7 +1185,10 @@ export declare enum DiscountReason {
930
1185
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
931
1186
  }
932
1187
  export interface DiscountRule {
933
- /** Discount rule ID */
1188
+ /**
1189
+ * Discount rule ID
1190
+ * @format GUID
1191
+ */
934
1192
  id?: string;
935
1193
  /** Discount rule name */
936
1194
  name?: DiscountRuleName;
@@ -938,28 +1196,51 @@ export interface DiscountRule {
938
1196
  amount?: Price;
939
1197
  }
940
1198
  export interface DiscountRuleName {
941
- /** Original discount rule name (in site's default language). */
1199
+ /**
1200
+ * Original discount rule name (in site's default language).
1201
+ * @minLength 1
1202
+ * @maxLength 256
1203
+ */
942
1204
  original?: string;
943
- /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
1205
+ /**
1206
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1207
+ * @minLength 1
1208
+ * @maxLength 500
1209
+ */
944
1210
  translated?: string | null;
945
1211
  }
946
1212
  export interface LineItemDiscount {
947
- /** ID of line item the discount applies to. */
1213
+ /**
1214
+ * ID of line item the discount applies to.
1215
+ * @format GUID
1216
+ */
948
1217
  id?: string;
949
1218
  /** Total discount for this line item. */
950
1219
  totalDiscount?: Price;
951
1220
  }
952
1221
  export interface CreatedBy extends CreatedByStringOneOf {
953
- /** User ID. When the draft order was created by a Wix user. */
1222
+ /**
1223
+ * User ID. When the draft order was created by a Wix user.
1224
+ * @format GUID
1225
+ */
954
1226
  userId?: string;
955
- /** App ID. When the draft order was created by an app. */
1227
+ /**
1228
+ * App ID. When the draft order was created by an app.
1229
+ * @format GUID
1230
+ */
956
1231
  appId?: string;
957
1232
  }
958
1233
  /** @oneof */
959
1234
  export interface CreatedByStringOneOf {
960
- /** User ID. When the draft order was created by a Wix user. */
1235
+ /**
1236
+ * User ID. When the draft order was created by a Wix user.
1237
+ * @format GUID
1238
+ */
961
1239
  userId?: string;
962
- /** App ID. When the draft order was created by an app. */
1240
+ /**
1241
+ * App ID. When the draft order was created by an app.
1242
+ * @format GUID
1243
+ */
963
1244
  appId?: string;
964
1245
  }
965
1246
  export declare enum EditingStatus {
@@ -1021,6 +1302,7 @@ export interface Balance {
1021
1302
  * Balance amount.
1022
1303
  *
1023
1304
  * A negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made.
1305
+ * @decimalValue options { }
1024
1306
  * @readonly
1025
1307
  */
1026
1308
  amount?: string;
@@ -1059,11 +1341,15 @@ export interface DraftOrderCommitSettings {
1059
1341
  /**
1060
1342
  * Line item IDs for which to perform an inventory change.
1061
1343
  * When not provided, inventory will not change.
1344
+ * @maxSize 300
1062
1345
  */
1063
1346
  updateInventory?: InventoryUpdate[];
1064
1347
  }
1065
1348
  export interface InventoryUpdate {
1066
- /** Line item ID. */
1349
+ /**
1350
+ * Line item ID.
1351
+ * @format GUID
1352
+ */
1067
1353
  lineItemId?: string;
1068
1354
  }
1069
1355
  export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
@@ -1092,7 +1378,10 @@ export interface RecipientInfoChangedDetails {
1092
1378
  export interface OrderTaxInfo {
1093
1379
  /** Calculated tax, added from line items. */
1094
1380
  totalTax?: Price;
1095
- /** The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. */
1381
+ /**
1382
+ * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
1383
+ * @maxSize 50
1384
+ */
1096
1385
  taxBreakdown?: OrderTaxBreakdown[];
1097
1386
  /**
1098
1387
  * Whether the order is exempt from tax calculations.
@@ -1107,15 +1396,28 @@ export interface OrderTaxInfo {
1107
1396
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1108
1397
  */
1109
1398
  export interface OrderTaxBreakdown {
1110
- /** The name of the tax against which this tax amount was calculated. */
1399
+ /**
1400
+ * The name of the tax against which this tax amount was calculated.
1401
+ * @maxLength 200
1402
+ */
1111
1403
  taxName?: string;
1112
- /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
1404
+ /**
1405
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
1406
+ * @maxLength 200
1407
+ */
1113
1408
  taxType?: string;
1114
- /** The name of the jurisdiction in which this tax detail applies. */
1409
+ /**
1410
+ * The name of the jurisdiction in which this tax detail applies.
1411
+ * @maxLength 200
1412
+ */
1115
1413
  jurisdiction?: string;
1116
1414
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1117
1415
  jurisdictionType?: JurisdictionType;
1118
- /** The rate at which this tax detail was calculated. */
1416
+ /**
1417
+ * The rate at which this tax detail was calculated.
1418
+ * @format DECIMAL_VALUE
1419
+ * @decimalValue options { gte:0, maxScale:6 }
1420
+ */
1119
1421
  rate?: string;
1120
1422
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1121
1423
  aggregatedTaxAmount?: Price;
@@ -1135,26 +1437,48 @@ export interface BillingDetailsChangeTypeOneOf {
1135
1437
  export interface BillingChangedDetails {
1136
1438
  }
1137
1439
  export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
1440
+ /** Indicates that business location was added during draft. */
1441
+ added?: boolean;
1442
+ /** Indicates that business location was changed. Contains business location before draft. */
1443
+ changedDetails?: BusinessLocationChangedDetails;
1444
+ /** Indicates that business location was removed during draft. */
1445
+ removed?: boolean;
1446
+ /** Business location. */
1447
+ businessLocation?: Location;
1138
1448
  }
1139
1449
  /** @oneof */
1140
1450
  export interface BusinessLocationDetailsChangeTypeOneOf {
1451
+ /** Indicates that business location was added during draft. */
1452
+ added?: boolean;
1453
+ /** Indicates that business location was changed. Contains business location before draft. */
1454
+ changedDetails?: BusinessLocationChangedDetails;
1455
+ /** Indicates that business location was removed during draft. */
1456
+ removed?: boolean;
1141
1457
  }
1142
1458
  export interface Location {
1143
1459
  /**
1144
1460
  * Location ID.
1145
1461
  * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
1462
+ * @format GUID
1146
1463
  */
1147
1464
  id?: string;
1148
1465
  /**
1149
1466
  * Location name.
1467
+ * @minLength 1
1468
+ * @maxLength 500
1150
1469
  * @readonly
1151
1470
  */
1152
1471
  name?: string;
1153
1472
  }
1154
1473
  export interface BusinessLocationChangedDetails {
1474
+ /** Business location before draft. */
1475
+ businessLocationBeforeChange?: Location;
1155
1476
  }
1156
1477
  export interface CreateDraftOrderRequest {
1157
- /** To create a draft from existing order, provide its id. Otherwise, an empty draft will be created. */
1478
+ /**
1479
+ * To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
1480
+ * @format GUID
1481
+ */
1158
1482
  orderId: string | null;
1159
1483
  }
1160
1484
  export interface CreateDraftOrderResponse {
@@ -1173,7 +1497,10 @@ export interface CalculatedDraftOrder {
1173
1497
  calculationErrors?: CalculationErrors;
1174
1498
  }
1175
1499
  export interface ShippingOption {
1176
- /** This carrier's unique ID */
1500
+ /**
1501
+ * This carrier's unique ID
1502
+ * @format GUID
1503
+ */
1177
1504
  carrierId?: string | null;
1178
1505
  /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
1179
1506
  code?: string;
@@ -1220,7 +1547,10 @@ export interface DeliveryTimeSlot {
1220
1547
  export interface ShippingPrice {
1221
1548
  /** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
1222
1549
  price?: Price;
1223
- /** Currency of the shipping rate price as a 3-letter [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217). Must align with the `currency` passed to the function. */
1550
+ /**
1551
+ * Currency of the shipping rate price as a 3-letter [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217). Must align with the `currency` passed to the function.
1552
+ * @format CURRENCY
1553
+ */
1224
1554
  currency?: string;
1225
1555
  }
1226
1556
  export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
@@ -1351,29 +1681,47 @@ export interface CreateEmptyDraftOrderResponse {
1351
1681
  calculatedDraftOrder?: CalculatedDraftOrder;
1352
1682
  }
1353
1683
  export interface AddLineItemsToDraftOrderRequest {
1354
- /** The draft order id */
1684
+ /**
1685
+ * The draft order id
1686
+ * @format GUID
1687
+ */
1355
1688
  draftOrderId: string;
1356
- /** Catalog line items to add to draft order. */
1689
+ /**
1690
+ * Catalog line items to add to draft order.
1691
+ * @maxSize 300
1692
+ */
1357
1693
  catalogLineItems?: CatalogReferenceLineItem[];
1358
- /** Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin. */
1694
+ /**
1695
+ * Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
1696
+ * @maxSize 300
1697
+ */
1359
1698
  customLineItems?: CustomLineItem[];
1360
1699
  }
1361
1700
  export interface CatalogReferenceLineItem {
1362
1701
  /** 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. */
1363
1702
  catalogReference?: CatalogReference;
1364
- /** Item quantity. */
1703
+ /**
1704
+ * Item quantity.
1705
+ * @min 1
1706
+ * @max 100000
1707
+ */
1365
1708
  quantity?: number;
1366
1709
  /** Item price override. */
1367
1710
  price?: Price;
1368
1711
  }
1369
1712
  export interface CustomLineItem {
1370
- /** Line item ID. */
1713
+ /**
1714
+ * Line item ID.
1715
+ * @format GUID
1716
+ */
1371
1717
  id?: string | null;
1372
1718
  /**
1373
1719
  * Item quantity.
1374
1720
  *
1375
1721
  * Min: `"1"`
1376
1722
  * Max: `"100000"`
1723
+ * @min 1
1724
+ * @max 100000
1377
1725
  */
1378
1726
  quantity?: number;
1379
1727
  /** 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. */
@@ -1405,7 +1753,10 @@ export interface CustomLineItem {
1405
1753
  itemType?: ItemType;
1406
1754
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1407
1755
  priceDescription?: PriceDescription;
1408
- /** Delivery Profile Id for the product */
1756
+ /**
1757
+ * Delivery Profile Id for the product
1758
+ * @format GUID
1759
+ */
1409
1760
  deliveryProfileId?: string | null;
1410
1761
  }
1411
1762
  export interface PageUrlV2 {
@@ -1415,9 +1766,17 @@ export interface PageUrlV2 {
1415
1766
  url?: string | null;
1416
1767
  }
1417
1768
  export interface SecuredMedia {
1418
- /** Media ID in Wix Media Manager. */
1769
+ /**
1770
+ * Media ID in Wix Media Manager.
1771
+ * @minLength 1
1772
+ * @maxLength 100
1773
+ */
1419
1774
  id?: string;
1420
- /** Original filename. */
1775
+ /**
1776
+ * Original filename.
1777
+ * @minLength 1
1778
+ * @maxLength 1000
1779
+ */
1421
1780
  fileName?: string;
1422
1781
  /** File type. */
1423
1782
  fileType?: FileType;
@@ -1435,17 +1794,33 @@ export interface AddLineItemsToDraftOrderResponse {
1435
1794
  calculatedDraftOrder?: CalculatedDraftOrder;
1436
1795
  }
1437
1796
  export interface UpdateLineItemsRequest {
1438
- /** The draft order id */
1797
+ /**
1798
+ * The draft order id
1799
+ * @format GUID
1800
+ */
1439
1801
  draftOrderId: string;
1440
- /** Details of changes to apply per line item */
1802
+ /**
1803
+ * Details of changes to apply per line item
1804
+ * @minSize 1
1805
+ * @maxSize 300
1806
+ */
1441
1807
  lineItemChanges?: LineItemChangeDetails[];
1442
1808
  }
1443
1809
  export interface LineItemChangeDetails {
1444
- /** The line item id to change */
1810
+ /**
1811
+ * The line item id to change
1812
+ * @format GUID
1813
+ */
1445
1814
  lineItemId?: string;
1446
- /** The new quantity for the line item. quantity zero means to remove the line item. */
1815
+ /**
1816
+ * The new quantity for the line item. quantity zero means to remove the line item.
1817
+ * @max 1000000
1818
+ */
1447
1819
  newQuantity?: number | null;
1448
- /** The new price for 1 unit of the line item */
1820
+ /**
1821
+ * The new price for 1 unit of the line item
1822
+ * @decimalValue options { gte:0, lte:1000000000000000 }
1823
+ */
1449
1824
  newPrice?: string | null;
1450
1825
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1451
1826
  newPriceDescription?: PriceDescription;
@@ -1455,9 +1830,15 @@ export interface UpdateLineItemsResponse {
1455
1830
  calculatedDraftOrder?: CalculatedDraftOrder;
1456
1831
  }
1457
1832
  export interface SetDiscountsRequest {
1458
- /** The draft order id */
1833
+ /**
1834
+ * The draft order id
1835
+ * @format GUID
1836
+ */
1459
1837
  draftOrderId: string;
1460
- /** The discount ids to opt-in. all existing discounts not listed are to be opted-out. */
1838
+ /**
1839
+ * The discount ids to opt-in. all existing discounts not listed are to be opted-out.
1840
+ * @minSize 1
1841
+ */
1461
1842
  discounts: IdAndApplied[];
1462
1843
  }
1463
1844
  export interface IdAndApplied {
@@ -1471,9 +1852,16 @@ export interface SetDiscountsResponse {
1471
1852
  calculatedDraftOrder?: CalculatedDraftOrder;
1472
1853
  }
1473
1854
  export interface CreateCustomDiscountsRequest {
1474
- /** The draft order id */
1855
+ /**
1856
+ * The draft order id
1857
+ * @format GUID
1858
+ */
1475
1859
  draftOrderId: string;
1476
- /** The discounts to add. */
1860
+ /**
1861
+ * The discounts to add.
1862
+ * @minSize 1
1863
+ * @maxSize 100
1864
+ */
1477
1865
  discounts?: DiscountOption[];
1478
1866
  }
1479
1867
  export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
@@ -1486,6 +1874,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
1486
1874
  discountType?: DiscountType;
1487
1875
  /**
1488
1876
  * ID of line item discount applies to.
1877
+ * @format GUID
1489
1878
  * @deprecated ID of line item discount applies to.
1490
1879
  * @replacedBy line_item_discounts
1491
1880
  * @targetRemovalDate 2024-10-30
@@ -1498,7 +1887,10 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
1498
1887
  * @targetRemovalDate 2024-08-30
1499
1888
  */
1500
1889
  amount?: Price;
1501
- /** Discount description as free text (optional). */
1890
+ /**
1891
+ * Discount description as free text (optional).
1892
+ * @maxLength 200
1893
+ */
1502
1894
  description?: string | null;
1503
1895
  /**
1504
1896
  * Should opt-in the added discount. default = false.
@@ -1520,9 +1912,17 @@ export interface CreateCustomDiscountsResponse {
1520
1912
  calculatedDraftOrder?: CalculatedDraftOrder;
1521
1913
  }
1522
1914
  export interface DeleteCustomDiscountsRequest {
1523
- /** The draft order id */
1915
+ /**
1916
+ * The draft order id
1917
+ * @format GUID
1918
+ */
1524
1919
  draftOrderId: string;
1525
- /** The discounts to remove */
1920
+ /**
1921
+ * The discounts to remove
1922
+ * @format GUID
1923
+ * @minSize 1
1924
+ * @maxSize 100
1925
+ */
1526
1926
  discountIds: string[];
1527
1927
  }
1528
1928
  export interface DeleteCustomDiscountsResponse {
@@ -1530,9 +1930,16 @@ export interface DeleteCustomDiscountsResponse {
1530
1930
  calculatedDraftOrder?: CalculatedDraftOrder;
1531
1931
  }
1532
1932
  export interface SetAdditionalFeesRequest {
1533
- /** The draft order id */
1933
+ /**
1934
+ * The draft order id
1935
+ * @format GUID
1936
+ */
1534
1937
  draftOrderId: string;
1535
- /** The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out */
1938
+ /**
1939
+ * The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
1940
+ * @minSize 1
1941
+ * @maxSize 100
1942
+ */
1536
1943
  additionalFees: IdAndApplied[];
1537
1944
  }
1538
1945
  export interface SetAdditionalFeesResponse {
@@ -1540,13 +1947,24 @@ export interface SetAdditionalFeesResponse {
1540
1947
  calculatedDraftOrder?: CalculatedDraftOrder;
1541
1948
  }
1542
1949
  export interface CreateCustomAdditionalFeesRequest {
1543
- /** The draft order id */
1950
+ /**
1951
+ * The draft order id
1952
+ * @format GUID
1953
+ */
1544
1954
  draftOrderId: string;
1545
- /** The additional fees to add. added with opted-out setting */
1955
+ /**
1956
+ * The additional fees to add. added with opted-out setting
1957
+ * @minSize 1
1958
+ * @maxSize 100
1959
+ */
1546
1960
  customAdditionalFees?: AdditionalFeeOption[];
1547
1961
  }
1548
1962
  export interface AdditionalFeeOption {
1549
- /** Translated additional fee's name */
1963
+ /**
1964
+ * Translated additional fee's name
1965
+ * @minLength 1
1966
+ * @maxLength 50
1967
+ */
1550
1968
  name?: string;
1551
1969
  /** Additional fee's price */
1552
1970
  price?: Price;
@@ -1557,7 +1975,11 @@ export interface AdditionalFeeOption {
1557
1975
  * if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee ids
1558
1976
  */
1559
1977
  applyToDraftOrder?: boolean | null;
1560
- /** Additional fee's unique code (or ID) for future processing */
1978
+ /**
1979
+ * Additional fee's unique code (or ID) for future processing
1980
+ * @minLength 1
1981
+ * @maxLength 100
1982
+ */
1561
1983
  code?: string | null;
1562
1984
  }
1563
1985
  export interface CreateCustomAdditionalFeesResponse {
@@ -1565,9 +1987,17 @@ export interface CreateCustomAdditionalFeesResponse {
1565
1987
  calculatedDraftOrder?: CalculatedDraftOrder;
1566
1988
  }
1567
1989
  export interface DeleteCustomAdditionalFeesRequest {
1568
- /** The draft order id */
1990
+ /**
1991
+ * The draft order id
1992
+ * @format GUID
1993
+ */
1569
1994
  draftOrderId: string;
1570
- /** The additional fees to remove */
1995
+ /**
1996
+ * The additional fees to remove
1997
+ * @format GUID
1998
+ * @minSize 1
1999
+ * @maxSize 100
2000
+ */
1571
2001
  customAdditionalFees: string[];
1572
2002
  }
1573
2003
  export interface DeleteCustomAdditionalFeesResponse {
@@ -1591,7 +2021,10 @@ export interface SetBillingInfoRequest {
1591
2021
  export interface SetBillingInfoResponse {
1592
2022
  }
1593
2023
  export interface UpdateShippingInfoRequest {
1594
- /** The draft order id */
2024
+ /**
2025
+ * The draft order id
2026
+ * @format GUID
2027
+ */
1595
2028
  draftOrderId?: string;
1596
2029
  /** update the shipping option on the order. if not set then the selected shipping is removed */
1597
2030
  shippingOption?: ShippingOption;
@@ -1601,7 +2034,10 @@ export interface UpdateShippingInfoResponse {
1601
2034
  calculatedDraftOrder?: CalculatedDraftOrder;
1602
2035
  }
1603
2036
  export interface GetDraftOrderRequest {
1604
- /** The draft order id */
2037
+ /**
2038
+ * The draft order id
2039
+ * @format GUID
2040
+ */
1605
2041
  draftOrderId: string;
1606
2042
  }
1607
2043
  export interface GetDraftOrderResponse {
@@ -1609,15 +2045,26 @@ export interface GetDraftOrderResponse {
1609
2045
  calculatedDraftOrder?: CalculatedDraftOrder;
1610
2046
  }
1611
2047
  export interface GetOrderDraftabilityStatusRequest {
1612
- /** Order ID. */
2048
+ /**
2049
+ * Order ID.
2050
+ * @minLength 1
2051
+ * @maxLength 100
2052
+ */
1613
2053
  orderId: string;
1614
2054
  }
1615
2055
  export interface GetOrderDraftabilityStatusResponse {
1616
- /** Order ID. */
2056
+ /**
2057
+ * Order ID.
2058
+ * @minLength 1
2059
+ * @maxLength 100
2060
+ */
1617
2061
  orderId?: string;
1618
2062
  /** Whether a draft can be created from this order */
1619
2063
  orderDraftable?: boolean;
1620
- /** Reasons why the order is not draftable */
2064
+ /**
2065
+ * Reasons why the order is not draftable
2066
+ * @maxSize 5
2067
+ */
1621
2068
  nonDraftableReasons?: NonDraftableReason[];
1622
2069
  }
1623
2070
  export declare enum NonDraftableReason {
@@ -1635,11 +2082,17 @@ export declare enum NonDraftableReason {
1635
2082
  TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
1636
2083
  }
1637
2084
  export interface CommitDraftOrderRequest {
1638
- /** The draft order id */
2085
+ /**
2086
+ * The draft order id
2087
+ * @format GUID
2088
+ */
1639
2089
  draftOrderId: string;
1640
2090
  /** Optional side effects to trigger */
1641
2091
  commitSettings?: DraftOrderCommitSettings;
1642
- /** Reason for edit, given by user (optional). */
2092
+ /**
2093
+ * Reason for edit, given by user (optional).
2094
+ * @maxLength 200
2095
+ */
1643
2096
  reason?: string | null;
1644
2097
  }
1645
2098
  export interface CommitDraftOrderResponse {
@@ -1651,6 +2104,7 @@ export interface CommitDraftOrderResponse {
1651
2104
  export interface Order {
1652
2105
  /**
1653
2106
  * Order ID.
2107
+ * @format GUID
1654
2108
  * @readonly
1655
2109
  */
1656
2110
  id?: string | null;
@@ -1662,6 +2116,7 @@ export interface Order {
1662
2116
  /**
1663
2117
  * Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
1664
2118
  * @readonly
2119
+ * @immutable
1665
2120
  */
1666
2121
  createdDate?: Date | null;
1667
2122
  /**
@@ -1671,6 +2126,8 @@ export interface Order {
1671
2126
  updatedDate?: Date | null;
1672
2127
  /**
1673
2128
  * Order line items.
2129
+ * @minSize 1
2130
+ * @maxSize 300
1674
2131
  * @readonly
1675
2132
  */
1676
2133
  lineItems?: OrderLineItem[];
@@ -1690,13 +2147,20 @@ export interface Order {
1690
2147
  buyerLanguage?: string | null;
1691
2148
  /** Weight measurement unit - defaults to site's weight unit. */
1692
2149
  weightUnit?: WeightUnit;
1693
- /** Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. */
2150
+ /**
2151
+ * Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
2152
+ * @format CURRENCY
2153
+ */
1694
2154
  currency?: string | null;
1695
- /** Whether tax is included in line item prices. */
2155
+ /**
2156
+ * Whether tax is included in line item prices.
2157
+ * @immutable
2158
+ */
1696
2159
  taxIncludedInPrices?: boolean;
1697
2160
  /**
1698
2161
  * Site language in which original values are shown.
1699
2162
  * @readonly
2163
+ * @immutable
1700
2164
  */
1701
2165
  siteLanguage?: string | null;
1702
2166
  /**
@@ -1708,7 +2172,10 @@ export interface Order {
1708
2172
  billingInfo?: AddressWithContact;
1709
2173
  /** Shipping info and selected shipping option details. */
1710
2174
  shippingInfo?: V1ShippingInformation;
1711
- /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
2175
+ /**
2176
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
2177
+ * @maxLength 1000
2178
+ */
1712
2179
  buyerNote?: string | null;
1713
2180
  /** Order status. */
1714
2181
  status?: OrderStatus;
@@ -1727,11 +2194,15 @@ export interface Order {
1727
2194
  taxSummary?: TaxSummary;
1728
2195
  /** Tax information. */
1729
2196
  taxInfo?: OrderTaxInfo;
1730
- /** Applied discounts. */
2197
+ /**
2198
+ * Applied discounts.
2199
+ * @maxSize 320
2200
+ */
1731
2201
  appliedDiscounts?: AppliedDiscount[];
1732
2202
  /**
1733
2203
  * Order activities.
1734
2204
  * @readonly
2205
+ * @maxSize 1000
1735
2206
  */
1736
2207
  activities?: Activity[];
1737
2208
  /** Order attribution source. */
@@ -1745,7 +2216,10 @@ export interface Order {
1745
2216
  channelInfo?: ChannelInfo;
1746
2217
  /** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
1747
2218
  seenByAHuman?: boolean | null;
1748
- /** Checkout ID. */
2219
+ /**
2220
+ * Checkout ID.
2221
+ * @format GUID
2222
+ */
1749
2223
  checkoutId?: string | null;
1750
2224
  /** Custom fields. */
1751
2225
  customFields?: CustomField[];
@@ -1754,7 +2228,10 @@ export interface Order {
1754
2228
  * @readonly
1755
2229
  */
1756
2230
  balanceSummary?: V1BalanceSummary;
1757
- /** Additional fees applied to the order. */
2231
+ /**
2232
+ * Additional fees applied to the order.
2233
+ * @maxSize 100
2234
+ */
1758
2235
  additionalFees?: AdditionalFee[];
1759
2236
  /**
1760
2237
  * Custom field data for the order object.
@@ -1762,7 +2239,10 @@ export interface Order {
1762
2239
  * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
1763
2240
  */
1764
2241
  extendedFields?: ExtendedFields;
1765
- /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
2242
+ /**
2243
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
2244
+ * @format GUID
2245
+ */
1766
2246
  purchaseFlowId?: string | null;
1767
2247
  /**
1768
2248
  * Order recipient address and contact details.
@@ -1775,8 +2255,11 @@ export interface Order {
1775
2255
  /**
1776
2256
  * Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
1777
2257
  * Used for migration from external systems.
2258
+ * @immutable
1778
2259
  */
1779
2260
  purchasedDate?: Date | null;
2261
+ /** Order Location */
2262
+ businessLocation?: Location;
1780
2263
  }
1781
2264
  export declare enum PaymentStatus {
1782
2265
  UNSPECIFIED = "UNSPECIFIED",
@@ -1864,11 +2347,13 @@ export interface Activity extends ActivityContentOneOf {
1864
2347
  orderRefunded?: OrderRefunded;
1865
2348
  /**
1866
2349
  * Activity ID.
2350
+ * @format GUID
1867
2351
  * @readonly
1868
2352
  */
1869
2353
  id?: string | null;
1870
2354
  /**
1871
2355
  * Activity author's email.
2356
+ * @format EMAIL
1872
2357
  * @readonly
1873
2358
  */
1874
2359
  authorEmail?: string | null;
@@ -1890,16 +2375,26 @@ export interface ActivityContentOneOf {
1890
2375
  orderRefunded?: OrderRefunded;
1891
2376
  }
1892
2377
  export interface CustomActivity {
1893
- /** ID of the app that created the custom activity. */
2378
+ /**
2379
+ * ID of the app that created the custom activity.
2380
+ * @format GUID
2381
+ */
1894
2382
  appId?: string;
1895
- /** Custom activity type. For example, `"Ticket number set"`. */
2383
+ /**
2384
+ * Custom activity type. For example, `"Ticket number set"`.
2385
+ * @maxLength 100
2386
+ */
1896
2387
  type?: string;
1897
2388
  /** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
1898
2389
  additionalData?: Record<string, string>;
1899
2390
  }
1900
2391
  /** Store owner added a comment */
1901
2392
  export interface MerchantComment {
1902
- /** Merchant comment message. */
2393
+ /**
2394
+ * Merchant comment message.
2395
+ * @minLength 1
2396
+ * @maxLength 5000
2397
+ */
1903
2398
  message?: string;
1904
2399
  }
1905
2400
  export interface OrderRefunded {
@@ -1907,29 +2402,52 @@ export interface OrderRefunded {
1907
2402
  manual?: boolean;
1908
2403
  /** Refund amount. */
1909
2404
  amount?: Price;
1910
- /** Reason for refund. */
2405
+ /**
2406
+ * Reason for refund.
2407
+ * @maxLength 200
2408
+ */
1911
2409
  reason?: string;
1912
2410
  }
1913
2411
  export interface OrderCreatedFromExchange {
1914
- /** ID of the original order for which the exchange happened. */
2412
+ /**
2413
+ * ID of the original order for which the exchange happened.
2414
+ * @format GUID
2415
+ */
1915
2416
  originalOrderId?: string;
1916
2417
  }
1917
2418
  export interface NewExchangeOrderCreated {
1918
- /** ID of the new order created as a result of an exchange of items. */
2419
+ /**
2420
+ * ID of the new order created as a result of an exchange of items.
2421
+ * @format GUID
2422
+ */
1919
2423
  exchangeOrderId?: string;
1920
- /** IDs of the items that were exchanged. */
2424
+ /**
2425
+ * IDs of the items that were exchanged.
2426
+ * @minSize 1
2427
+ * @maxSize 300
2428
+ */
1921
2429
  lineItems?: LineItemExchangeData[];
1922
2430
  }
1923
2431
  export interface LineItemExchangeData {
1924
- /** ID of the exchanged line item. */
2432
+ /**
2433
+ * ID of the exchanged line item.
2434
+ * @format GUID
2435
+ */
1925
2436
  lineItemId?: string;
1926
- /** Line item quantity being exchanged. */
2437
+ /**
2438
+ * Line item quantity being exchanged.
2439
+ * @min 1
2440
+ * @max 100000
2441
+ */
1927
2442
  quantity?: number;
1928
2443
  }
1929
2444
  export interface DraftOrderChangesApplied {
1930
2445
  /** Draft order id. */
1931
2446
  draftOrderId?: string;
1932
- /** Reason for edit, given by user (optional). */
2447
+ /**
2448
+ * Reason for edit, given by user (optional).
2449
+ * @maxLength 200
2450
+ */
1933
2451
  reason?: string | null;
1934
2452
  /** Changes applied to order. */
1935
2453
  changes?: OrderChange[];
@@ -1958,7 +2476,10 @@ export interface OrderChangeValueOneOf {
1958
2476
  shippingInformationChanged?: ShippingInformationChange;
1959
2477
  }
1960
2478
  export interface LineItemChanges {
1961
- /** Line item ID. */
2479
+ /**
2480
+ * Line item ID.
2481
+ * @format GUID
2482
+ */
1962
2483
  id?: string;
1963
2484
  /** Item name. */
1964
2485
  name?: ProductName;
@@ -1968,11 +2489,21 @@ export interface LineItemChanges {
1968
2489
  price?: LineItemPriceChange;
1969
2490
  }
1970
2491
  export interface LineItemQuantityChange {
1971
- /** Item quantity before update. */
2492
+ /**
2493
+ * Item quantity before update.
2494
+ * @max 1000000
2495
+ */
1972
2496
  originalQuantity?: number;
1973
- /** Item quantity after update. */
2497
+ /**
2498
+ * Item quantity after update.
2499
+ * @max 1000000
2500
+ */
1974
2501
  newQuantity?: number;
1975
- /** Difference between original and new quantity. Absolute value. */
2502
+ /**
2503
+ * Difference between original and new quantity. Absolute value.
2504
+ * @min 1
2505
+ * @max 1000000
2506
+ */
1976
2507
  diff?: number;
1977
2508
  /** Type of quantity change: increase or decrease. */
1978
2509
  deltaType?: LineItemQuantityChangeType;
@@ -1990,15 +2521,25 @@ export interface LineItemPriceChange {
1990
2521
  newPrice?: Price;
1991
2522
  }
1992
2523
  export interface ManagedLineItem {
1993
- /** Line item ID. */
2524
+ /**
2525
+ * Line item ID.
2526
+ * @format GUID
2527
+ */
1994
2528
  id?: string;
1995
2529
  /** Item name. */
1996
2530
  name?: ProductName;
1997
- /** Added or removed item quantity. */
2531
+ /**
2532
+ * Added or removed item quantity.
2533
+ * @min 1
2534
+ * @max 1000000
2535
+ */
1998
2536
  quantity?: number;
1999
2537
  }
2000
2538
  export interface ManagedDiscount {
2001
- /** Discount id. */
2539
+ /**
2540
+ * Discount id.
2541
+ * @format GUID
2542
+ */
2002
2543
  id?: string;
2003
2544
  /** Discount name: coupon name / discount rule name / merchant discount description. */
2004
2545
  name?: TranslatedValue;
@@ -2008,13 +2549,22 @@ export interface ManagedDiscount {
2008
2549
  totalAmount?: Price;
2009
2550
  }
2010
2551
  export interface TranslatedValue {
2011
- /** Value in site default language. */
2552
+ /**
2553
+ * Value in site default language.
2554
+ * @minLength 1
2555
+ */
2012
2556
  original?: string;
2013
- /** Translated value. */
2557
+ /**
2558
+ * Translated value.
2559
+ * @minLength 1
2560
+ */
2014
2561
  translated?: string | null;
2015
2562
  }
2016
2563
  export interface LineItemAmount {
2017
- /** Order line item id */
2564
+ /**
2565
+ * Order line item id
2566
+ * @format GUID
2567
+ */
2018
2568
  id?: string;
2019
2569
  /** Item name. */
2020
2570
  name?: ProductName;
@@ -2022,7 +2572,10 @@ export interface LineItemAmount {
2022
2572
  amount?: Price;
2023
2573
  }
2024
2574
  export interface ManagedAdditionalFee {
2025
- /** Additional fee id. */
2575
+ /**
2576
+ * Additional fee id.
2577
+ * @format GUID
2578
+ */
2026
2579
  id?: string;
2027
2580
  /** Additional fee name. */
2028
2581
  name?: TranslatedValue;
@@ -2046,54 +2599,102 @@ export interface ShippingInformationChange {
2046
2599
  export interface ShippingInformation {
2047
2600
  /** Order’s shipping price. */
2048
2601
  total?: Price;
2049
- /** Order’s shipping title. */
2602
+ /**
2603
+ * Order’s shipping title.
2604
+ * @maxLength 250
2605
+ */
2050
2606
  shippingTitle?: string;
2051
2607
  }
2052
2608
  /** Payment method is saved for order */
2053
2609
  export interface SavedPaymentMethod {
2054
- /** Payment method name */
2610
+ /**
2611
+ * Payment method name
2612
+ * @minLength 1
2613
+ * @maxLength 100
2614
+ */
2055
2615
  name?: string;
2056
- /** Payment method description */
2616
+ /**
2617
+ * Payment method description
2618
+ * @minLength 1
2619
+ * @maxLength 100
2620
+ */
2057
2621
  description?: string | null;
2058
2622
  }
2059
2623
  export interface AuthorizedPaymentCreated {
2060
- /** Payment ID of payment associated with this activity */
2624
+ /**
2625
+ * Payment ID of payment associated with this activity
2626
+ * @format GUID
2627
+ */
2061
2628
  paymentId?: string;
2062
2629
  /** Payment amount */
2063
2630
  amount?: Price;
2064
- /** The last 4 digits of the card number. */
2631
+ /**
2632
+ * The last 4 digits of the card number.
2633
+ * @maxLength 4
2634
+ */
2065
2635
  lastFourDigits?: string | null;
2066
- /** Card issuer's brand. */
2636
+ /**
2637
+ * Card issuer's brand.
2638
+ * @maxLength 100
2639
+ */
2067
2640
  brand?: string | null;
2068
2641
  }
2069
2642
  export interface AuthorizedPaymentCaptured {
2070
- /** Payment ID of payment associated with this activity */
2643
+ /**
2644
+ * Payment ID of payment associated with this activity
2645
+ * @format GUID
2646
+ */
2071
2647
  paymentId?: string;
2072
2648
  /** Payment amount */
2073
2649
  amount?: Price;
2074
- /** The last 4 digits of the card number. */
2650
+ /**
2651
+ * The last 4 digits of the card number.
2652
+ * @maxLength 4
2653
+ */
2075
2654
  lastFourDigits?: string | null;
2076
- /** Card issuer's brand. */
2655
+ /**
2656
+ * Card issuer's brand.
2657
+ * @maxLength 100
2658
+ */
2077
2659
  brand?: string | null;
2078
2660
  }
2079
2661
  export interface AuthorizedPaymentVoided {
2080
- /** Payment ID of payment associated with this activity */
2662
+ /**
2663
+ * Payment ID of payment associated with this activity
2664
+ * @format GUID
2665
+ */
2081
2666
  paymentId?: string;
2082
2667
  /** Payment amount */
2083
2668
  amount?: Price;
2084
- /** The last 4 digits of the card number. */
2669
+ /**
2670
+ * The last 4 digits of the card number.
2671
+ * @maxLength 4
2672
+ */
2085
2673
  lastFourDigits?: string | null;
2086
- /** Card issuer's brand. */
2674
+ /**
2675
+ * Card issuer's brand.
2676
+ * @maxLength 100
2677
+ */
2087
2678
  brand?: string | null;
2088
2679
  }
2089
2680
  export interface RefundInitiated {
2090
- /** Refund ID. */
2681
+ /**
2682
+ * Refund ID.
2683
+ * @format GUID
2684
+ */
2091
2685
  refundId?: string;
2092
2686
  /** Refund amount. */
2093
2687
  amount?: Price;
2094
- /** Details about the payments being refunded. */
2688
+ /**
2689
+ * Details about the payments being refunded.
2690
+ * @minSize 1
2691
+ * @maxSize 50
2692
+ */
2095
2693
  payments?: RefundedPayment[];
2096
- /** Reason for refund. */
2694
+ /**
2695
+ * Reason for refund.
2696
+ * @maxLength 100
2697
+ */
2097
2698
  reason?: string | null;
2098
2699
  }
2099
2700
  export interface RefundedPayment extends RefundedPaymentKindOneOf {
@@ -2103,7 +2704,10 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
2103
2704
  giftCard?: GiftCardPaymentRefund;
2104
2705
  /** Membership payment refund. */
2105
2706
  membership?: MembershipPaymentRefund;
2106
- /** Payment ID. */
2707
+ /**
2708
+ * Payment ID.
2709
+ * @format GUID
2710
+ */
2107
2711
  paymentId?: string;
2108
2712
  /** Whether refund was made externally and manually on the payment provider's side. */
2109
2713
  externalRefund?: boolean;
@@ -2120,29 +2724,49 @@ export interface RefundedPaymentKindOneOf {
2120
2724
  export interface RegularPaymentRefund {
2121
2725
  /** Refund amount */
2122
2726
  amount?: Price;
2123
- /** The last 4 digits of the card number. */
2727
+ /**
2728
+ * The last 4 digits of the card number.
2729
+ * @maxLength 4
2730
+ */
2124
2731
  lastFourDigits?: string | null;
2125
- /** Card issuer's brand. */
2732
+ /**
2733
+ * Card issuer's brand.
2734
+ * @maxLength 100
2735
+ */
2126
2736
  brand?: string | null;
2127
2737
  }
2128
2738
  export interface GiftCardPaymentRefund {
2129
- /** Gift card payment ID */
2739
+ /**
2740
+ * Gift card payment ID
2741
+ * @minLength 1
2742
+ * @maxLength 100
2743
+ */
2130
2744
  giftCardPaymentId?: string | null;
2131
2745
  /** Refund amount */
2132
2746
  amount?: Price;
2133
2747
  }
2134
2748
  export interface MembershipPaymentRefund {
2135
- /** Membership ID */
2749
+ /**
2750
+ * Membership ID
2751
+ * @minLength 1
2752
+ * @maxLength 100
2753
+ */
2136
2754
  membershipId?: string | null;
2137
2755
  }
2138
2756
  export interface PaymentRefunded {
2139
- /** Refund ID. */
2757
+ /**
2758
+ * Refund ID.
2759
+ * @format GUID
2760
+ */
2140
2761
  refundId?: string;
2141
2762
  /** Details about the refunded payment. */
2142
2763
  payment?: RefundedPayment;
2143
2764
  }
2144
2765
  export interface PaymentRefundFailed {
2145
- /** Refund ID. */
2766
+ /**
2767
+ * Refund ID.
2768
+ * @format GUID
2769
+ */
2146
2770
  refundId?: string;
2147
2771
  /** Details about the failed payment refund. */
2148
2772
  payment?: RefundedPayment;
@@ -2150,13 +2774,19 @@ export interface PaymentRefundFailed {
2150
2774
  export interface RefundedAsStoreCredit {
2151
2775
  /** Refund amount */
2152
2776
  amount?: Price;
2153
- /** Reason for refund */
2777
+ /**
2778
+ * Reason for refund
2779
+ * @maxLength 100
2780
+ */
2154
2781
  reason?: string | null;
2155
2782
  }
2156
2783
  export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
2157
2784
  /** Regular payment. */
2158
2785
  regular?: RegularPayment;
2159
- /** Payment ID of payment associated with this activity */
2786
+ /**
2787
+ * Payment ID of payment associated with this activity
2788
+ * @format GUID
2789
+ */
2160
2790
  paymentId?: string;
2161
2791
  }
2162
2792
  /** @oneof */
@@ -2176,15 +2806,24 @@ export interface RegularPaymentPaymentMethodDetailsOneOf {
2176
2806
  creditCardDetails?: CreditCardDetails;
2177
2807
  }
2178
2808
  export interface CreditCardDetails {
2179
- /** The last 4 digits of the card number. */
2809
+ /**
2810
+ * The last 4 digits of the card number.
2811
+ * @maxLength 4
2812
+ */
2180
2813
  lastFourDigits?: string | null;
2181
- /** Card issuer's brand. */
2814
+ /**
2815
+ * Card issuer's brand.
2816
+ * @maxLength 100
2817
+ */
2182
2818
  brand?: string | null;
2183
2819
  }
2184
2820
  export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
2185
2821
  /** Regular payment. */
2186
2822
  regular?: RegularPayment;
2187
- /** Payment ID of payment associated with this activity */
2823
+ /**
2824
+ * Payment ID of payment associated with this activity
2825
+ * @format GUID
2826
+ */
2188
2827
  paymentId?: string;
2189
2828
  }
2190
2829
  /** @oneof */
@@ -2195,7 +2834,10 @@ export interface PaymentCanceledPaymentDetailsOneOf {
2195
2834
  export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
2196
2835
  /** Regular payment. */
2197
2836
  regular?: RegularPayment;
2198
- /** Payment ID of payment associated with this activity */
2837
+ /**
2838
+ * Payment ID of payment associated with this activity
2839
+ * @format GUID
2840
+ */
2199
2841
  paymentId?: string;
2200
2842
  }
2201
2843
  /** @oneof */
@@ -2208,7 +2850,10 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
2208
2850
  wixReceipt?: WixReceipt;
2209
2851
  /** Receipt created by an external system. */
2210
2852
  externalReceipt?: ExternalReceipt;
2211
- /** Payment ID of payment associated with this activity */
2853
+ /**
2854
+ * Payment ID of payment associated with this activity
2855
+ * @format GUID
2856
+ */
2212
2857
  paymentId?: string;
2213
2858
  }
2214
2859
  /** @oneof */
@@ -2219,15 +2864,29 @@ export interface ReceiptCreatedReceiptInfoOneOf {
2219
2864
  externalReceipt?: ExternalReceipt;
2220
2865
  }
2221
2866
  export interface WixReceipt {
2222
- /** Receipt ID */
2867
+ /**
2868
+ * Receipt ID
2869
+ * @format GUID
2870
+ */
2223
2871
  receiptId?: string;
2224
- /** Display number of receipt */
2872
+ /**
2873
+ * Display number of receipt
2874
+ * @minLength 1
2875
+ * @maxLength 40
2876
+ */
2225
2877
  displayNumber?: string | null;
2226
2878
  }
2227
2879
  export interface ExternalReceipt {
2228
- /** Receipt ID */
2880
+ /**
2881
+ * Receipt ID
2882
+ * @maxLength 100
2883
+ */
2229
2884
  receiptId?: string | null;
2230
- /** Display number of receipt */
2885
+ /**
2886
+ * Display number of receipt
2887
+ * @minLength 1
2888
+ * @maxLength 40
2889
+ */
2231
2890
  displayNumber?: string | null;
2232
2891
  }
2233
2892
  export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
@@ -2235,7 +2894,10 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
2235
2894
  wixReceipt?: WixReceipt;
2236
2895
  /** Receipt created by an external system. */
2237
2896
  externalReceipt?: ExternalReceipt;
2238
- /** Payment ID of payment associated with this activity */
2897
+ /**
2898
+ * Payment ID of payment associated with this activity
2899
+ * @format GUID
2900
+ */
2239
2901
  paymentId?: string;
2240
2902
  }
2241
2903
  /** @oneof */
@@ -2290,13 +2952,23 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
2290
2952
  /**
2291
2953
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2292
2954
  * For example, via POS (point of service).
2955
+ * @format GUID
2293
2956
  */
2294
2957
  userId?: string;
2295
- /** Member ID - when the order was created by a **logged in** site visitor. */
2958
+ /**
2959
+ * Member ID - when the order was created by a **logged in** site visitor.
2960
+ * @format GUID
2961
+ */
2296
2962
  memberId?: string;
2297
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
2963
+ /**
2964
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
2965
+ * @format GUID
2966
+ */
2298
2967
  visitorId?: string;
2299
- /** App ID - when the order was created by an external application. */
2968
+ /**
2969
+ * App ID - when the order was created by an external application.
2970
+ * @format GUID
2971
+ */
2300
2972
  appId?: string;
2301
2973
  }
2302
2974
  /** @oneof */
@@ -2304,21 +2976,37 @@ export interface V1CreatedByStringOneOf {
2304
2976
  /**
2305
2977
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2306
2978
  * For example, via POS (point of service).
2979
+ * @format GUID
2307
2980
  */
2308
2981
  userId?: string;
2309
- /** Member ID - when the order was created by a **logged in** site visitor. */
2982
+ /**
2983
+ * Member ID - when the order was created by a **logged in** site visitor.
2984
+ * @format GUID
2985
+ */
2310
2986
  memberId?: string;
2311
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
2987
+ /**
2988
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
2989
+ * @format GUID
2990
+ */
2312
2991
  visitorId?: string;
2313
- /** App ID - when the order was created by an external application. */
2992
+ /**
2993
+ * App ID - when the order was created by an external application.
2994
+ * @format GUID
2995
+ */
2314
2996
  appId?: string;
2315
2997
  }
2316
2998
  export interface ChannelInfo {
2317
2999
  /** Sales channel that submitted the order. */
2318
3000
  type?: ChannelType;
2319
- /** Reference to an order ID from an external system. */
3001
+ /**
3002
+ * Reference to an order ID from an external system.
3003
+ * @maxLength 100
3004
+ */
2320
3005
  externalOrderId?: string | null;
2321
- /** URL to the order in the external system. */
3006
+ /**
3007
+ * URL to the order in the external system.
3008
+ * @maxLength 300
3009
+ */
2322
3010
  externalOrderUrl?: string | null;
2323
3011
  }
2324
3012
  export declare enum ChannelType {
@@ -2358,9 +3046,17 @@ export declare enum ChannelType {
2358
3046
  export interface CustomField {
2359
3047
  /** Custom field value. */
2360
3048
  value?: any;
2361
- /** Custom field title. */
3049
+ /**
3050
+ * Custom field title.
3051
+ * @minLength 1
3052
+ * @maxLength 500
3053
+ */
2362
3054
  title?: string;
2363
- /** Translated custom field title. */
3055
+ /**
3056
+ * Translated custom field title.
3057
+ * @minLength 1
3058
+ * @maxLength 500
3059
+ */
2364
3060
  translatedTitle?: string | null;
2365
3061
  }
2366
3062
  export interface V1BalanceSummary {
@@ -2425,7 +3121,11 @@ export interface Tags {
2425
3121
  tags?: TagList;
2426
3122
  }
2427
3123
  export interface TagList {
2428
- /** List of tag IDs */
3124
+ /**
3125
+ * List of tag IDs
3126
+ * @maxSize 100
3127
+ * @maxLength 5
3128
+ */
2429
3129
  tagIds?: string[];
2430
3130
  }
2431
3131
  export interface CreateOrderFromDraftRequest {
@@ -2437,7 +3137,10 @@ export interface OrderCreateNotifications {
2437
3137
  export interface CreateOrderFromDraftResponse {
2438
3138
  }
2439
3139
  export interface DeleteDraftOrderRequest {
2440
- /** The draft order id */
3140
+ /**
3141
+ * The draft order id
3142
+ * @format GUID
3143
+ */
2441
3144
  draftOrderId: string;
2442
3145
  }
2443
3146
  export interface DeleteDraftOrderResponse {
@@ -2463,6 +3166,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2463
3166
  * Sort object.
2464
3167
  *
2465
3168
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
3169
+ * @maxSize 5
2466
3170
  */
2467
3171
  sort?: Sorting[];
2468
3172
  }
@@ -2476,7 +3180,10 @@ export interface CursorQueryPagingMethodOneOf {
2476
3180
  cursorPaging?: CursorPaging;
2477
3181
  }
2478
3182
  export interface Sorting {
2479
- /** Name of the field to sort by. */
3183
+ /**
3184
+ * Name of the field to sort by.
3185
+ * @maxLength 512
3186
+ */
2480
3187
  fieldName?: string;
2481
3188
  /** Sort order. */
2482
3189
  order?: SortOrder;
@@ -2486,13 +3193,17 @@ export declare enum SortOrder {
2486
3193
  DESC = "DESC"
2487
3194
  }
2488
3195
  export interface CursorPaging {
2489
- /** Maximum number of items to return in the results. */
3196
+ /**
3197
+ * Maximum number of items to return in the results.
3198
+ * @max 100
3199
+ */
2490
3200
  limit?: number | null;
2491
3201
  /**
2492
3202
  * Pointer to the next or previous page in the list of results.
2493
3203
  *
2494
3204
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2495
3205
  * Not relevant for the first request.
3206
+ * @maxLength 16000
2496
3207
  */
2497
3208
  cursor?: string | null;
2498
3209
  }
@@ -2516,9 +3227,15 @@ export interface CursorPagingMetadata {
2516
3227
  hasNext?: boolean | null;
2517
3228
  }
2518
3229
  export interface Cursors {
2519
- /** Cursor string pointing to the next page in the list of results. */
3230
+ /**
3231
+ * Cursor string pointing to the next page in the list of results.
3232
+ * @maxLength 16000
3233
+ */
2520
3234
  next?: string | null;
2521
- /** Cursor pointing to the previous page in the list of results. */
3235
+ /**
3236
+ * Cursor pointing to the previous page in the list of results.
3237
+ * @maxLength 16000
3238
+ */
2522
3239
  prev?: string | null;
2523
3240
  }
2524
3241
  export interface UpdateExtendedFieldsRequest {
@@ -2538,11 +3255,17 @@ export interface SetTaxExemptionRequest {
2538
3255
  export interface SetTaxExemptionResponse {
2539
3256
  }
2540
3257
  export interface GetDraftEditabilityStatusRequest {
2541
- /** Draft order ID. */
3258
+ /**
3259
+ * Draft order ID.
3260
+ * @format GUID
3261
+ */
2542
3262
  draftOrderId?: string | null;
2543
3263
  }
2544
3264
  export interface GetDraftEditabilityStatusResponse {
2545
- /** Draft order ID. */
3265
+ /**
3266
+ * Draft order ID.
3267
+ * @format GUID
3268
+ */
2546
3269
  draftOrderId?: string | null;
2547
3270
  /**
2548
3271
  * Draft order status.
@@ -2627,9 +3350,15 @@ export interface ActionEvent {
2627
3350
  bodyAsJson?: string;
2628
3351
  }
2629
3352
  export interface MessageEnvelope {
2630
- /** App instance ID. */
3353
+ /**
3354
+ * App instance ID.
3355
+ * @format GUID
3356
+ */
2631
3357
  instanceId?: string | null;
2632
- /** Event type. */
3358
+ /**
3359
+ * Event type.
3360
+ * @maxLength 150
3361
+ */
2633
3362
  eventType?: string;
2634
3363
  /** The identification type and identity data. */
2635
3364
  identity?: IdentificationData;
@@ -2637,26 +3366,50 @@ export interface MessageEnvelope {
2637
3366
  data?: string;
2638
3367
  }
2639
3368
  export interface IdentificationData extends IdentificationDataIdOneOf {
2640
- /** ID of a site visitor that has not logged in to the site. */
3369
+ /**
3370
+ * ID of a site visitor that has not logged in to the site.
3371
+ * @format GUID
3372
+ */
2641
3373
  anonymousVisitorId?: string;
2642
- /** ID of a site visitor that has logged in to the site. */
3374
+ /**
3375
+ * ID of a site visitor that has logged in to the site.
3376
+ * @format GUID
3377
+ */
2643
3378
  memberId?: string;
2644
- /** ID of a Wix user (site owner, contributor, etc.). */
3379
+ /**
3380
+ * ID of a Wix user (site owner, contributor, etc.).
3381
+ * @format GUID
3382
+ */
2645
3383
  wixUserId?: string;
2646
- /** ID of an app. */
3384
+ /**
3385
+ * ID of an app.
3386
+ * @format GUID
3387
+ */
2647
3388
  appId?: string;
2648
3389
  /** @readonly */
2649
3390
  identityType?: WebhookIdentityType;
2650
3391
  }
2651
3392
  /** @oneof */
2652
3393
  export interface IdentificationDataIdOneOf {
2653
- /** ID of a site visitor that has not logged in to the site. */
3394
+ /**
3395
+ * ID of a site visitor that has not logged in to the site.
3396
+ * @format GUID
3397
+ */
2654
3398
  anonymousVisitorId?: string;
2655
- /** ID of a site visitor that has logged in to the site. */
3399
+ /**
3400
+ * ID of a site visitor that has logged in to the site.
3401
+ * @format GUID
3402
+ */
2656
3403
  memberId?: string;
2657
- /** ID of a Wix user (site owner, contributor, etc.). */
3404
+ /**
3405
+ * ID of a Wix user (site owner, contributor, etc.).
3406
+ * @format GUID
3407
+ */
2658
3408
  wixUserId?: string;
2659
- /** ID of an app. */
3409
+ /**
3410
+ * ID of an app.
3411
+ * @format GUID
3412
+ */
2660
3413
  appId?: string;
2661
3414
  }
2662
3415
  export declare enum WebhookIdentityType {
@@ -2936,6 +3689,19 @@ interface OrderTaxInfoNonNullableFields {
2936
3689
  totalTax?: PriceNonNullableFields;
2937
3690
  taxBreakdown: OrderTaxBreakdownNonNullableFields[];
2938
3691
  }
3692
+ interface LocationNonNullableFields {
3693
+ id: string;
3694
+ name: string;
3695
+ }
3696
+ interface BusinessLocationChangedDetailsNonNullableFields {
3697
+ businessLocationBeforeChange?: LocationNonNullableFields;
3698
+ }
3699
+ interface BusinessLocationDetailsNonNullableFields {
3700
+ added: boolean;
3701
+ changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
3702
+ removed: boolean;
3703
+ businessLocation?: LocationNonNullableFields;
3704
+ }
2939
3705
  interface DraftOrderNonNullableFields {
2940
3706
  lineItems: ItemDetailsNonNullableFields[];
2941
3707
  shippingInfo?: ShippingDetailsNonNullableFields;
@@ -2951,6 +3717,7 @@ interface DraftOrderNonNullableFields {
2951
3717
  balanceSummary?: BalanceSummaryNonNullableFields;
2952
3718
  commitSettings?: DraftOrderCommitSettingsNonNullableFields;
2953
3719
  recipientInfo?: RecipientInfoDetailsNonNullableFields;
3720
+ businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
2954
3721
  }
2955
3722
  interface PickupDetailsNonNullableFields {
2956
3723
  address?: AddressNonNullableFields;
@@ -3124,6 +3891,7 @@ interface OrderNonNullableFields {
3124
3891
  balanceSummary?: V1BalanceSummaryNonNullableFields;
3125
3892
  additionalFees: AdditionalFeeNonNullableFields[];
3126
3893
  recipientInfo?: AddressWithContactNonNullableFields;
3894
+ businessLocation?: LocationNonNullableFields;
3127
3895
  }
3128
3896
  export interface CommitDraftOrderResponseNonNullableFields {
3129
3897
  committedDraftOrder?: DraftOrderNonNullableFields;