@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?: string;
@@ -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. */
@@ -343,7 +410,10 @@ export interface FocalPoint {
343
410
  export interface PhysicalProperties {
344
411
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
345
412
  weight?: number | null;
346
- /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
413
+ /**
414
+ * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
415
+ * @maxLength 40
416
+ */
347
417
  sku?: string | null;
348
418
  /** Whether this line item is shippable. */
349
419
  shippable?: boolean;
@@ -384,7 +454,10 @@ export declare enum PaymentOptionType {
384
454
  export interface ItemTaxFullDetails {
385
455
  /** Taxable amount of this line item. */
386
456
  taxableAmount?: Price;
387
- /** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`. */
457
+ /**
458
+ * Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
459
+ * @decimalValue options { gte:0, maxScale:6 }
460
+ */
388
461
  taxRate?: string;
389
462
  /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
390
463
  totalTax?: Price;
@@ -394,16 +467,24 @@ export interface LineItemTaxInfo {
394
467
  taxAmount?: Price;
395
468
  /** Amount for which tax is calculated. */
396
469
  taxableAmount?: Price;
397
- /** Tax rate %, as a decimal point. */
470
+ /**
471
+ * Tax rate %, as a decimal point.
472
+ * @format DECIMAL_VALUE
473
+ * @decimalValue options { gte:0, maxScale:6 }
474
+ */
398
475
  taxRate?: string | null;
399
476
  /**
400
477
  * Tax group ID.
401
478
  * Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
479
+ * @format GUID
402
480
  */
403
481
  taxGroupId?: string | null;
404
482
  /** Indicates whether the price already includes tax. */
405
483
  taxIncludedInPrice?: boolean;
406
- /** Tax information for a line item. */
484
+ /**
485
+ * Tax information for a line item.
486
+ * @maxSize 7
487
+ */
407
488
  taxBreakdown?: LineItemTaxBreakdown[];
408
489
  }
409
490
  /**
@@ -411,17 +492,28 @@ export interface LineItemTaxInfo {
411
492
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
412
493
  */
413
494
  export interface LineItemTaxBreakdown {
414
- /** Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". */
495
+ /**
496
+ * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
497
+ * @maxLength 200
498
+ */
415
499
  jurisdiction?: string | null;
416
- /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. */
500
+ /**
501
+ * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
502
+ * @format DECIMAL_VALUE
503
+ * @decimalValue options { gte:0, maxScale:6 }
504
+ */
417
505
  rate?: string | null;
418
506
  /** Amount of tax calculated for this line item. */
419
507
  taxAmount?: Price;
420
- /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
508
+ /**
509
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
510
+ * @maxLength 200
511
+ */
421
512
  taxType?: string | null;
422
513
  /**
423
514
  * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
424
515
  * This name should be explicit enough to allow the merchant to understand what tax was calculated.
516
+ * @maxLength 200
425
517
  */
426
518
  taxName?: string | null;
427
519
  /** Type of jurisdiction that taxes were calculated for. */
@@ -441,9 +533,18 @@ export declare enum JurisdictionType {
441
533
  SPECIAL = "SPECIAL"
442
534
  }
443
535
  export interface DigitalFile {
444
- /** ID of the secure file in media. */
536
+ /**
537
+ * ID of the secure file in media.
538
+ * @minLength 1
539
+ * @maxLength 100
540
+ */
445
541
  fileId?: string;
446
- /** Link will exist after the digital links have been generated on the order. */
542
+ /**
543
+ * Link will exist after the digital links have been generated on the order.
544
+ * @format WEB_URL
545
+ * @minLength 1
546
+ * @maxLength 2000
547
+ */
447
548
  link?: string | null;
448
549
  /**
449
550
  * Link expiration time and date.
@@ -452,25 +553,48 @@ export interface DigitalFile {
452
553
  expirationDate?: Date | null;
453
554
  }
454
555
  export interface SubscriptionInfo {
455
- /** Subscription ID. */
556
+ /**
557
+ * Subscription ID.
558
+ * @format GUID
559
+ */
456
560
  _id?: string | null;
457
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
561
+ /**
562
+ * Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
563
+ * @min 1
564
+ */
458
565
  cycleNumber?: number;
459
- /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
566
+ /**
567
+ * Subscription option title. For example, `"Monthly coffee Subscription"`.
568
+ * @minLength 1
569
+ * @maxLength 20
570
+ */
460
571
  subscriptionOptionTitle?: string;
461
- /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
572
+ /**
573
+ * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
574
+ * @maxLength 60
575
+ */
462
576
  subscriptionOptionDescription?: string | null;
463
- /** Subscription detailed information. */
577
+ /**
578
+ * Subscription detailed information.
579
+ * @immutable
580
+ */
464
581
  subscriptionSettings?: SubscriptionSettings;
465
582
  }
466
583
  export interface SubscriptionSettings {
467
584
  /** Frequency of recurring payment. */
468
585
  frequency?: SubscriptionFrequency;
469
- /** Interval of recurring payment. */
586
+ /**
587
+ * Interval of recurring payment.
588
+ * @min 1
589
+ * @max 50
590
+ */
470
591
  interval?: number | null;
471
592
  /** Whether subscription is renewed automatically at the end of each period. */
472
593
  autoRenewal?: boolean;
473
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
594
+ /**
595
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
596
+ * @min 1
597
+ */
474
598
  billingCycles?: number | null;
475
599
  }
476
600
  /** Frequency unit of recurring payment */
@@ -484,19 +608,31 @@ export declare enum SubscriptionFrequency {
484
608
  export interface FreeTrialPeriod {
485
609
  /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
486
610
  frequency?: SubscriptionFrequency;
487
- /** interval of period */
611
+ /**
612
+ * interval of period
613
+ * @min 1
614
+ * @max 50
615
+ */
488
616
  interval?: number;
489
617
  }
490
618
  export interface LocationAndQuantity {
491
- /** Location id in the associated owner app. */
619
+ /**
620
+ * Location id in the associated owner app.
621
+ * @format GUID
622
+ */
492
623
  _id?: string;
493
624
  /**
494
625
  * Location owner app, if not provided then the site business info locations will be used.
626
+ * @format GUID
495
627
  * @deprecated Location owner app, if not provided then the site business info locations will be used.
496
628
  * @targetRemovalDate 2025-03-01
497
629
  */
498
630
  appId?: string | null;
499
- /** Quantity for specific location. */
631
+ /**
632
+ * Quantity for specific location.
633
+ * @min 1
634
+ * @max 100000
635
+ */
500
636
  quantity?: number;
501
637
  }
502
638
  export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
@@ -526,7 +662,11 @@ export interface ExtendedFields {
526
662
  namespaces?: Record<string, Record<string, any>>;
527
663
  }
528
664
  export interface ItemChangedDetails {
529
- /** Line item quantity before change. */
665
+ /**
666
+ * Line item quantity before change.
667
+ * @min 1
668
+ * @max 1000000
669
+ */
530
670
  quantityBeforeChange?: number | null;
531
671
  /** Line item price before change. */
532
672
  priceBeforeChange?: Price;
@@ -553,13 +693,22 @@ export interface ShippingDetailsChangeTypeOneOf {
553
693
  removed?: boolean;
554
694
  }
555
695
  export interface V1ShippingInformation {
556
- /** App Def Id of external provider which was a source of shipping info */
696
+ /**
697
+ * App Def Id of external provider which was a source of shipping info
698
+ * @minLength 1
699
+ * @maxLength 100
700
+ */
557
701
  carrierId?: string | null;
558
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
702
+ /**
703
+ * Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
704
+ * @minLength 1
705
+ * @maxLength 100
706
+ */
559
707
  code?: string | null;
560
708
  /**
561
709
  * Shipping option title.
562
710
  * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
711
+ * @maxLength 250
563
712
  */
564
713
  title?: string;
565
714
  /** Shipping logistics. */
@@ -574,9 +723,15 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
574
723
  shippingDestination?: AddressWithContact;
575
724
  /** Pickup details. */
576
725
  pickupDetails?: V1PickupDetails;
577
- /** Expected delivery time in free text. For example, `"3-5 business days"`. */
726
+ /**
727
+ * Expected delivery time in free text. For example, `"3-5 business days"`.
728
+ * @maxLength 500
729
+ */
578
730
  deliveryTime?: string | null;
579
- /** Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. */
731
+ /**
732
+ * Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
733
+ * @maxLength 1000
734
+ */
580
735
  instructions?: string | null;
581
736
  /**
582
737
  * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
@@ -602,19 +757,37 @@ export interface AddressWithContact {
602
757
  }
603
758
  /** Physical address */
604
759
  export interface Address {
605
- /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
760
+ /**
761
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
762
+ * @format COUNTRY
763
+ */
606
764
  country?: string | null;
607
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
765
+ /**
766
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
767
+ * @maxLength 50
768
+ */
608
769
  subdivision?: string | null;
609
- /** City name. */
770
+ /**
771
+ * City name.
772
+ * @maxLength 50
773
+ */
610
774
  city?: string | null;
611
- /** Postal or zip code. */
775
+ /**
776
+ * Postal or zip code.
777
+ * @maxLength 50
778
+ */
612
779
  postalCode?: string | null;
613
780
  /** Street address. */
614
781
  streetAddress?: StreetAddress;
615
- /** Main address line (usually street name and number). */
782
+ /**
783
+ * Main address line (usually street name and number).
784
+ * @maxLength 150
785
+ */
616
786
  addressLine1?: string | null;
617
- /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
787
+ /**
788
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
789
+ * @maxLength 100
790
+ */
618
791
  addressLine2?: string | null;
619
792
  /**
620
793
  * Country's full name.
@@ -641,13 +814,25 @@ export interface AddressLocation {
641
814
  }
642
815
  /** Full contact details for an address */
643
816
  export interface FullAddressContactDetails {
644
- /** First name. */
817
+ /**
818
+ * First name.
819
+ * @maxLength 100
820
+ */
645
821
  firstName?: string | null;
646
- /** Last name. */
822
+ /**
823
+ * Last name.
824
+ * @maxLength 100
825
+ */
647
826
  lastName?: string | null;
648
- /** Phone number. */
827
+ /**
828
+ * Phone number.
829
+ * @format PHONE
830
+ */
649
831
  phone?: string | null;
650
- /** Company name. */
832
+ /**
833
+ * Company name.
834
+ * @maxLength 1000
835
+ */
651
836
  company?: string | null;
652
837
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
653
838
  vatId?: VatId;
@@ -680,19 +865,37 @@ export interface V1PickupDetails {
680
865
  }
681
866
  /** Physical address */
682
867
  export interface PickupAddress {
683
- /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
868
+ /**
869
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
870
+ * @format COUNTRY
871
+ */
684
872
  country?: string | null;
685
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
873
+ /**
874
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
875
+ * @maxLength 50
876
+ */
686
877
  subdivision?: string | null;
687
- /** City name. */
878
+ /**
879
+ * City name.
880
+ * @maxLength 1000
881
+ */
688
882
  city?: string | null;
689
- /** Postal or zip code. */
883
+ /**
884
+ * Postal or zip code.
885
+ * @maxLength 1000
886
+ */
690
887
  postalCode?: string | null;
691
888
  /** Street address object, with number, name, and apartment number in separate fields. */
692
889
  streetAddress?: StreetAddress;
693
- /** Main address line (usually street name and number). */
890
+ /**
891
+ * Main address line (usually street name and number).
892
+ * @maxLength 1000
893
+ */
694
894
  addressLine1?: string | null;
695
- /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
895
+ /**
896
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
897
+ * @maxLength 1000
898
+ */
696
899
  addressLine2?: string | null;
697
900
  /**
698
901
  * Country's full name.
@@ -738,7 +941,10 @@ export interface V1ShippingPrice {
738
941
  discount?: Price;
739
942
  }
740
943
  export interface ShippingRegion {
741
- /** Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. */
944
+ /**
945
+ * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
946
+ * @maxLength 100
947
+ */
742
948
  name?: string | null;
743
949
  }
744
950
  export interface ShippingChangedDetails {
@@ -747,20 +953,38 @@ export interface ShippingChangedDetails {
747
953
  }
748
954
  /** Buyer Info */
749
955
  export interface BuyerInfo extends BuyerInfoIdOneOf {
750
- /** Visitor ID (if site visitor is not a member). */
956
+ /**
957
+ * Visitor ID (if site visitor is not a member).
958
+ * @format GUID
959
+ */
751
960
  visitorId?: string;
752
- /** Member ID (if site visitor is a site member). */
961
+ /**
962
+ * Member ID (if site visitor is a site member).
963
+ * @format GUID
964
+ */
753
965
  memberId?: string;
754
- /** 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). */
966
+ /**
967
+ * 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).
968
+ * @format GUID
969
+ */
755
970
  contactId?: string | null;
756
- /** Buyer email address. */
971
+ /**
972
+ * Buyer email address.
973
+ * @format EMAIL
974
+ */
757
975
  email?: string | null;
758
976
  }
759
977
  /** @oneof */
760
978
  export interface BuyerInfoIdOneOf {
761
- /** Visitor ID (if site visitor is not a member). */
979
+ /**
980
+ * Visitor ID (if site visitor is not a member).
981
+ * @format GUID
982
+ */
762
983
  visitorId?: string;
763
- /** Member ID (if site visitor is a site member). */
984
+ /**
985
+ * Member ID (if site visitor is a site member).
986
+ * @format GUID
987
+ */
764
988
  memberId?: string;
765
989
  }
766
990
  export interface AdditionalFeeDetails {
@@ -780,32 +1004,51 @@ export interface AdditionalFeeDetails {
780
1004
  applied?: boolean;
781
1005
  }
782
1006
  export interface AdditionalFee {
783
- /** Additional fee's unique code for future processing. */
1007
+ /**
1008
+ * Additional fee's unique code for future processing.
1009
+ * @minLength 1
1010
+ * @maxLength 100
1011
+ */
784
1012
  code?: string | null;
785
- /** Name of additional fee. */
1013
+ /**
1014
+ * Name of additional fee.
1015
+ * @minLength 1
1016
+ * @maxLength 50
1017
+ */
786
1018
  name?: string;
787
1019
  /** Additional fee's price. */
788
1020
  price?: Price;
789
1021
  /** Tax details. */
790
1022
  taxDetails?: ItemTaxFullDetails;
791
- /** SPI implementer's `appId`. */
1023
+ /**
1024
+ * SPI implementer's `appId`.
1025
+ * @format GUID
1026
+ */
792
1027
  providerAppId?: string | null;
793
1028
  /** Additional fee's price before tax. */
794
1029
  priceBeforeTax?: Price;
795
1030
  /** Additional fee's price after tax. */
796
1031
  priceAfterTax?: Price;
797
- /** Additional fee's id. */
1032
+ /**
1033
+ * Additional fee's id.
1034
+ * @format GUID
1035
+ * @immutable
1036
+ */
798
1037
  _id?: string;
799
1038
  /**
800
1039
  * Optional - Line items associated with this additional fee.
801
1040
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1041
+ * @format GUID
802
1042
  */
803
1043
  lineItemIds?: string[];
804
1044
  }
805
1045
  export interface TaxDetails {
806
1046
  /** Indication if additional fee is taxable or not */
807
1047
  taxable?: boolean;
808
- /** Optional tax group ID to use when calculating tax for this additional fee */
1048
+ /**
1049
+ * Optional tax group ID to use when calculating tax for this additional fee
1050
+ * @format GUID
1051
+ */
809
1052
  taxGroupId?: string | null;
810
1053
  }
811
1054
  export declare enum SourceType {
@@ -847,13 +1090,19 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
847
1090
  /**
848
1091
  * IDs of line items discount applies to.
849
1092
  * Deprecated. Use `line_item_discounts` instead.
1093
+ * @format GUID
1094
+ * @maxSize 1
850
1095
  * @deprecated IDs of line items discount applies to.
851
1096
  * Deprecated. Use `line_item_discounts` instead.
852
1097
  * @replacedBy line_item_discounts
853
1098
  * @targetRemovalDate 2024-10-30
854
1099
  */
855
1100
  lineItemIds?: string[];
856
- /** Discount id. */
1101
+ /**
1102
+ * Discount id.
1103
+ * @format GUID
1104
+ * @immutable
1105
+ */
857
1106
  _id?: string | null;
858
1107
  }
859
1108
  /** @oneof */
@@ -887,7 +1136,10 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
887
1136
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
888
1137
  */
889
1138
  discountReason?: DiscountReason;
890
- /** Discount description as free text (optional). */
1139
+ /**
1140
+ * Discount description as free text (optional).
1141
+ * @maxLength 200
1142
+ */
891
1143
  description?: string | null;
892
1144
  /** Discount amount. */
893
1145
  amount?: Price;
@@ -899,7 +1151,10 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
899
1151
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
900
1152
  */
901
1153
  discountReason?: DiscountReason;
902
- /** Discount description as free text (optional). */
1154
+ /**
1155
+ * Discount description as free text (optional).
1156
+ * @maxLength 200
1157
+ */
903
1158
  description?: string | null;
904
1159
  }
905
1160
  export declare enum DiscountReason {
@@ -907,7 +1162,10 @@ export declare enum DiscountReason {
907
1162
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
908
1163
  }
909
1164
  export interface DiscountRule {
910
- /** Discount rule ID */
1165
+ /**
1166
+ * Discount rule ID
1167
+ * @format GUID
1168
+ */
911
1169
  _id?: string;
912
1170
  /** Discount rule name */
913
1171
  name?: DiscountRuleName;
@@ -915,28 +1173,51 @@ export interface DiscountRule {
915
1173
  amount?: Price;
916
1174
  }
917
1175
  export interface DiscountRuleName {
918
- /** Original discount rule name (in site's default language). */
1176
+ /**
1177
+ * Original discount rule name (in site's default language).
1178
+ * @minLength 1
1179
+ * @maxLength 256
1180
+ */
919
1181
  original?: string;
920
- /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
1182
+ /**
1183
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1184
+ * @minLength 1
1185
+ * @maxLength 500
1186
+ */
921
1187
  translated?: string | null;
922
1188
  }
923
1189
  export interface LineItemDiscount {
924
- /** ID of line item the discount applies to. */
1190
+ /**
1191
+ * ID of line item the discount applies to.
1192
+ * @format GUID
1193
+ */
925
1194
  _id?: string;
926
1195
  /** Total discount for this line item. */
927
1196
  totalDiscount?: Price;
928
1197
  }
929
1198
  export interface CreatedBy extends CreatedByStringOneOf {
930
- /** User ID. When the draft order was created by a Wix user. */
1199
+ /**
1200
+ * User ID. When the draft order was created by a Wix user.
1201
+ * @format GUID
1202
+ */
931
1203
  userId?: string;
932
- /** App ID. When the draft order was created by an app. */
1204
+ /**
1205
+ * App ID. When the draft order was created by an app.
1206
+ * @format GUID
1207
+ */
933
1208
  appId?: string;
934
1209
  }
935
1210
  /** @oneof */
936
1211
  export interface CreatedByStringOneOf {
937
- /** User ID. When the draft order was created by a Wix user. */
1212
+ /**
1213
+ * User ID. When the draft order was created by a Wix user.
1214
+ * @format GUID
1215
+ */
938
1216
  userId?: string;
939
- /** App ID. When the draft order was created by an app. */
1217
+ /**
1218
+ * App ID. When the draft order was created by an app.
1219
+ * @format GUID
1220
+ */
940
1221
  appId?: string;
941
1222
  }
942
1223
  export declare enum EditingStatus {
@@ -998,6 +1279,7 @@ export interface Balance {
998
1279
  * Balance amount.
999
1280
  *
1000
1281
  * 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.
1282
+ * @decimalValue options { }
1001
1283
  * @readonly
1002
1284
  */
1003
1285
  amount?: string;
@@ -1036,11 +1318,15 @@ export interface DraftOrderCommitSettings {
1036
1318
  /**
1037
1319
  * Line item IDs for which to perform an inventory change.
1038
1320
  * When not provided, inventory will not change.
1321
+ * @maxSize 300
1039
1322
  */
1040
1323
  updateInventory?: InventoryUpdate[];
1041
1324
  }
1042
1325
  export interface InventoryUpdate {
1043
- /** Line item ID. */
1326
+ /**
1327
+ * Line item ID.
1328
+ * @format GUID
1329
+ */
1044
1330
  lineItemId?: string;
1045
1331
  }
1046
1332
  export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
@@ -1069,7 +1355,10 @@ export interface RecipientInfoChangedDetails {
1069
1355
  export interface OrderTaxInfo {
1070
1356
  /** Calculated tax, added from line items. */
1071
1357
  totalTax?: Price;
1072
- /** 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. */
1358
+ /**
1359
+ * 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.
1360
+ * @maxSize 50
1361
+ */
1073
1362
  taxBreakdown?: OrderTaxBreakdown[];
1074
1363
  /**
1075
1364
  * Whether the order is exempt from tax calculations.
@@ -1084,15 +1373,28 @@ export interface OrderTaxInfo {
1084
1373
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1085
1374
  */
1086
1375
  export interface OrderTaxBreakdown {
1087
- /** The name of the tax against which this tax amount was calculated. */
1376
+ /**
1377
+ * The name of the tax against which this tax amount was calculated.
1378
+ * @maxLength 200
1379
+ */
1088
1380
  taxName?: string;
1089
- /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
1381
+ /**
1382
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
1383
+ * @maxLength 200
1384
+ */
1090
1385
  taxType?: string;
1091
- /** The name of the jurisdiction in which this tax detail applies. */
1386
+ /**
1387
+ * The name of the jurisdiction in which this tax detail applies.
1388
+ * @maxLength 200
1389
+ */
1092
1390
  jurisdiction?: string;
1093
1391
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1094
1392
  jurisdictionType?: JurisdictionType;
1095
- /** The rate at which this tax detail was calculated. */
1393
+ /**
1394
+ * The rate at which this tax detail was calculated.
1395
+ * @format DECIMAL_VALUE
1396
+ * @decimalValue options { gte:0, maxScale:6 }
1397
+ */
1096
1398
  rate?: string;
1097
1399
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1098
1400
  aggregatedTaxAmount?: Price;
@@ -1112,26 +1414,48 @@ export interface BillingDetailsChangeTypeOneOf {
1112
1414
  export interface BillingChangedDetails {
1113
1415
  }
1114
1416
  export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
1417
+ /** Indicates that business location was added during draft. */
1418
+ added?: boolean;
1419
+ /** Indicates that business location was changed. Contains business location before draft. */
1420
+ changedDetails?: BusinessLocationChangedDetails;
1421
+ /** Indicates that business location was removed during draft. */
1422
+ removed?: boolean;
1423
+ /** Business location. */
1424
+ businessLocation?: Location;
1115
1425
  }
1116
1426
  /** @oneof */
1117
1427
  export interface BusinessLocationDetailsChangeTypeOneOf {
1428
+ /** Indicates that business location was added during draft. */
1429
+ added?: boolean;
1430
+ /** Indicates that business location was changed. Contains business location before draft. */
1431
+ changedDetails?: BusinessLocationChangedDetails;
1432
+ /** Indicates that business location was removed during draft. */
1433
+ removed?: boolean;
1118
1434
  }
1119
1435
  export interface Location {
1120
1436
  /**
1121
1437
  * Location ID.
1122
1438
  * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
1439
+ * @format GUID
1123
1440
  */
1124
1441
  _id?: string;
1125
1442
  /**
1126
1443
  * Location name.
1444
+ * @minLength 1
1445
+ * @maxLength 500
1127
1446
  * @readonly
1128
1447
  */
1129
1448
  name?: string;
1130
1449
  }
1131
1450
  export interface BusinessLocationChangedDetails {
1451
+ /** Business location before draft. */
1452
+ businessLocationBeforeChange?: Location;
1132
1453
  }
1133
1454
  export interface CreateDraftOrderRequest {
1134
- /** To create a draft from existing order, provide its id. Otherwise, an empty draft will be created. */
1455
+ /**
1456
+ * To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
1457
+ * @format GUID
1458
+ */
1135
1459
  orderId: string | null;
1136
1460
  }
1137
1461
  export interface CreateDraftOrderResponse {
@@ -1150,7 +1474,10 @@ export interface CalculatedDraftOrder {
1150
1474
  calculationErrors?: CalculationErrors;
1151
1475
  }
1152
1476
  export interface ShippingOption {
1153
- /** This carrier's unique ID */
1477
+ /**
1478
+ * This carrier's unique ID
1479
+ * @format GUID
1480
+ */
1154
1481
  carrierId?: string | null;
1155
1482
  /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
1156
1483
  code?: string;
@@ -1197,7 +1524,10 @@ export interface DeliveryTimeSlot {
1197
1524
  export interface ShippingPrice {
1198
1525
  /** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
1199
1526
  price?: Price;
1200
- /** 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. */
1527
+ /**
1528
+ * 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.
1529
+ * @format CURRENCY
1530
+ */
1201
1531
  currency?: string;
1202
1532
  }
1203
1533
  export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
@@ -1328,29 +1658,47 @@ export interface CreateEmptyDraftOrderResponse {
1328
1658
  calculatedDraftOrder?: CalculatedDraftOrder;
1329
1659
  }
1330
1660
  export interface AddLineItemsToDraftOrderRequest {
1331
- /** The draft order id */
1661
+ /**
1662
+ * The draft order id
1663
+ * @format GUID
1664
+ */
1332
1665
  draftOrderId: string;
1333
- /** Catalog line items to add to draft order. */
1666
+ /**
1667
+ * Catalog line items to add to draft order.
1668
+ * @maxSize 300
1669
+ */
1334
1670
  catalogLineItems?: CatalogReferenceLineItem[];
1335
- /** Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin. */
1671
+ /**
1672
+ * Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
1673
+ * @maxSize 300
1674
+ */
1336
1675
  customLineItems?: CustomLineItem[];
1337
1676
  }
1338
1677
  export interface CatalogReferenceLineItem {
1339
1678
  /** 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. */
1340
1679
  catalogReference?: CatalogReference;
1341
- /** Item quantity. */
1680
+ /**
1681
+ * Item quantity.
1682
+ * @min 1
1683
+ * @max 100000
1684
+ */
1342
1685
  quantity?: number;
1343
1686
  /** Item price override. */
1344
1687
  price?: Price;
1345
1688
  }
1346
1689
  export interface CustomLineItem {
1347
- /** Line item ID. */
1690
+ /**
1691
+ * Line item ID.
1692
+ * @format GUID
1693
+ */
1348
1694
  _id?: string | null;
1349
1695
  /**
1350
1696
  * Item quantity.
1351
1697
  *
1352
1698
  * Min: `"1"`
1353
1699
  * Max: `"100000"`
1700
+ * @min 1
1701
+ * @max 100000
1354
1702
  */
1355
1703
  quantity?: number;
1356
1704
  /** 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. */
@@ -1382,13 +1730,24 @@ export interface CustomLineItem {
1382
1730
  itemType?: ItemType;
1383
1731
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1384
1732
  priceDescription?: PriceDescription;
1385
- /** Delivery Profile Id for the product */
1733
+ /**
1734
+ * Delivery Profile Id for the product
1735
+ * @format GUID
1736
+ */
1386
1737
  deliveryProfileId?: string | null;
1387
1738
  }
1388
1739
  export interface SecuredMedia {
1389
- /** Media ID in Wix Media Manager. */
1740
+ /**
1741
+ * Media ID in Wix Media Manager.
1742
+ * @minLength 1
1743
+ * @maxLength 100
1744
+ */
1390
1745
  _id?: string;
1391
- /** Original filename. */
1746
+ /**
1747
+ * Original filename.
1748
+ * @minLength 1
1749
+ * @maxLength 1000
1750
+ */
1392
1751
  fileName?: string;
1393
1752
  /** File type. */
1394
1753
  fileType?: FileType;
@@ -1406,17 +1765,33 @@ export interface AddLineItemsToDraftOrderResponse {
1406
1765
  calculatedDraftOrder?: CalculatedDraftOrder;
1407
1766
  }
1408
1767
  export interface UpdateLineItemsRequest {
1409
- /** The draft order id */
1768
+ /**
1769
+ * The draft order id
1770
+ * @format GUID
1771
+ */
1410
1772
  draftOrderId: string;
1411
- /** Details of changes to apply per line item */
1773
+ /**
1774
+ * Details of changes to apply per line item
1775
+ * @minSize 1
1776
+ * @maxSize 300
1777
+ */
1412
1778
  lineItemChanges?: LineItemChangeDetails[];
1413
1779
  }
1414
1780
  export interface LineItemChangeDetails {
1415
- /** The line item id to change */
1781
+ /**
1782
+ * The line item id to change
1783
+ * @format GUID
1784
+ */
1416
1785
  lineItemId?: string;
1417
- /** The new quantity for the line item. quantity zero means to remove the line item. */
1786
+ /**
1787
+ * The new quantity for the line item. quantity zero means to remove the line item.
1788
+ * @max 1000000
1789
+ */
1418
1790
  newQuantity?: number | null;
1419
- /** The new price for 1 unit of the line item */
1791
+ /**
1792
+ * The new price for 1 unit of the line item
1793
+ * @decimalValue options { gte:0, lte:1000000000000000 }
1794
+ */
1420
1795
  newPrice?: string | null;
1421
1796
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1422
1797
  newPriceDescription?: PriceDescription;
@@ -1426,9 +1801,15 @@ export interface UpdateLineItemsResponse {
1426
1801
  calculatedDraftOrder?: CalculatedDraftOrder;
1427
1802
  }
1428
1803
  export interface SetDiscountsRequest {
1429
- /** The draft order id */
1804
+ /**
1805
+ * The draft order id
1806
+ * @format GUID
1807
+ */
1430
1808
  draftOrderId: string;
1431
- /** The discount ids to opt-in. all existing discounts not listed are to be opted-out. */
1809
+ /**
1810
+ * The discount ids to opt-in. all existing discounts not listed are to be opted-out.
1811
+ * @minSize 1
1812
+ */
1432
1813
  discounts: IdAndApplied[];
1433
1814
  }
1434
1815
  export interface IdAndApplied {
@@ -1442,9 +1823,16 @@ export interface SetDiscountsResponse {
1442
1823
  calculatedDraftOrder?: CalculatedDraftOrder;
1443
1824
  }
1444
1825
  export interface CreateCustomDiscountsRequest {
1445
- /** The draft order id */
1826
+ /**
1827
+ * The draft order id
1828
+ * @format GUID
1829
+ */
1446
1830
  draftOrderId: string;
1447
- /** The discounts to add. */
1831
+ /**
1832
+ * The discounts to add.
1833
+ * @minSize 1
1834
+ * @maxSize 100
1835
+ */
1448
1836
  discounts?: DiscountOption[];
1449
1837
  }
1450
1838
  export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
@@ -1457,6 +1845,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
1457
1845
  discountType?: DiscountType;
1458
1846
  /**
1459
1847
  * ID of line item discount applies to.
1848
+ * @format GUID
1460
1849
  * @deprecated ID of line item discount applies to.
1461
1850
  * @replacedBy line_item_discounts
1462
1851
  * @targetRemovalDate 2024-10-30
@@ -1469,7 +1858,10 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
1469
1858
  * @targetRemovalDate 2024-08-30
1470
1859
  */
1471
1860
  amount?: Price;
1472
- /** Discount description as free text (optional). */
1861
+ /**
1862
+ * Discount description as free text (optional).
1863
+ * @maxLength 200
1864
+ */
1473
1865
  description?: string | null;
1474
1866
  /**
1475
1867
  * Should opt-in the added discount. default = false.
@@ -1491,9 +1883,17 @@ export interface CreateCustomDiscountsResponse {
1491
1883
  calculatedDraftOrder?: CalculatedDraftOrder;
1492
1884
  }
1493
1885
  export interface DeleteCustomDiscountsRequest {
1494
- /** The draft order id */
1886
+ /**
1887
+ * The draft order id
1888
+ * @format GUID
1889
+ */
1495
1890
  draftOrderId: string;
1496
- /** The discounts to remove */
1891
+ /**
1892
+ * The discounts to remove
1893
+ * @format GUID
1894
+ * @minSize 1
1895
+ * @maxSize 100
1896
+ */
1497
1897
  discountIds: string[];
1498
1898
  }
1499
1899
  export interface DeleteCustomDiscountsResponse {
@@ -1501,9 +1901,16 @@ export interface DeleteCustomDiscountsResponse {
1501
1901
  calculatedDraftOrder?: CalculatedDraftOrder;
1502
1902
  }
1503
1903
  export interface SetAdditionalFeesRequest {
1504
- /** The draft order id */
1904
+ /**
1905
+ * The draft order id
1906
+ * @format GUID
1907
+ */
1505
1908
  draftOrderId: string;
1506
- /** The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out */
1909
+ /**
1910
+ * The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
1911
+ * @minSize 1
1912
+ * @maxSize 100
1913
+ */
1507
1914
  additionalFees: IdAndApplied[];
1508
1915
  }
1509
1916
  export interface SetAdditionalFeesResponse {
@@ -1511,13 +1918,24 @@ export interface SetAdditionalFeesResponse {
1511
1918
  calculatedDraftOrder?: CalculatedDraftOrder;
1512
1919
  }
1513
1920
  export interface CreateCustomAdditionalFeesRequest {
1514
- /** The draft order id */
1921
+ /**
1922
+ * The draft order id
1923
+ * @format GUID
1924
+ */
1515
1925
  draftOrderId: string;
1516
- /** The additional fees to add. added with opted-out setting */
1926
+ /**
1927
+ * The additional fees to add. added with opted-out setting
1928
+ * @minSize 1
1929
+ * @maxSize 100
1930
+ */
1517
1931
  customAdditionalFees?: AdditionalFeeOption[];
1518
1932
  }
1519
1933
  export interface AdditionalFeeOption {
1520
- /** Translated additional fee's name */
1934
+ /**
1935
+ * Translated additional fee's name
1936
+ * @minLength 1
1937
+ * @maxLength 50
1938
+ */
1521
1939
  name?: string;
1522
1940
  /** Additional fee's price */
1523
1941
  price?: Price;
@@ -1528,7 +1946,11 @@ export interface AdditionalFeeOption {
1528
1946
  * if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee ids
1529
1947
  */
1530
1948
  applyToDraftOrder?: boolean | null;
1531
- /** Additional fee's unique code (or ID) for future processing */
1949
+ /**
1950
+ * Additional fee's unique code (or ID) for future processing
1951
+ * @minLength 1
1952
+ * @maxLength 100
1953
+ */
1532
1954
  code?: string | null;
1533
1955
  }
1534
1956
  export interface CreateCustomAdditionalFeesResponse {
@@ -1536,9 +1958,17 @@ export interface CreateCustomAdditionalFeesResponse {
1536
1958
  calculatedDraftOrder?: CalculatedDraftOrder;
1537
1959
  }
1538
1960
  export interface DeleteCustomAdditionalFeesRequest {
1539
- /** The draft order id */
1961
+ /**
1962
+ * The draft order id
1963
+ * @format GUID
1964
+ */
1540
1965
  draftOrderId: string;
1541
- /** The additional fees to remove */
1966
+ /**
1967
+ * The additional fees to remove
1968
+ * @format GUID
1969
+ * @minSize 1
1970
+ * @maxSize 100
1971
+ */
1542
1972
  customAdditionalFees: string[];
1543
1973
  }
1544
1974
  export interface DeleteCustomAdditionalFeesResponse {
@@ -1562,7 +1992,10 @@ export interface SetBillingInfoRequest {
1562
1992
  export interface SetBillingInfoResponse {
1563
1993
  }
1564
1994
  export interface UpdateShippingInfoRequest {
1565
- /** The draft order id */
1995
+ /**
1996
+ * The draft order id
1997
+ * @format GUID
1998
+ */
1566
1999
  draftOrderId?: string;
1567
2000
  /** update the shipping option on the order. if not set then the selected shipping is removed */
1568
2001
  shippingOption?: ShippingOption;
@@ -1572,7 +2005,10 @@ export interface UpdateShippingInfoResponse {
1572
2005
  calculatedDraftOrder?: CalculatedDraftOrder;
1573
2006
  }
1574
2007
  export interface GetDraftOrderRequest {
1575
- /** The draft order id */
2008
+ /**
2009
+ * The draft order id
2010
+ * @format GUID
2011
+ */
1576
2012
  draftOrderId: string;
1577
2013
  }
1578
2014
  export interface GetDraftOrderResponse {
@@ -1580,15 +2016,26 @@ export interface GetDraftOrderResponse {
1580
2016
  calculatedDraftOrder?: CalculatedDraftOrder;
1581
2017
  }
1582
2018
  export interface GetOrderDraftabilityStatusRequest {
1583
- /** Order ID. */
2019
+ /**
2020
+ * Order ID.
2021
+ * @minLength 1
2022
+ * @maxLength 100
2023
+ */
1584
2024
  orderId: string;
1585
2025
  }
1586
2026
  export interface GetOrderDraftabilityStatusResponse {
1587
- /** Order ID. */
2027
+ /**
2028
+ * Order ID.
2029
+ * @minLength 1
2030
+ * @maxLength 100
2031
+ */
1588
2032
  orderId?: string;
1589
2033
  /** Whether a draft can be created from this order */
1590
2034
  orderDraftable?: boolean;
1591
- /** Reasons why the order is not draftable */
2035
+ /**
2036
+ * Reasons why the order is not draftable
2037
+ * @maxSize 5
2038
+ */
1592
2039
  nonDraftableReasons?: NonDraftableReason[];
1593
2040
  }
1594
2041
  export declare enum NonDraftableReason {
@@ -1606,11 +2053,17 @@ export declare enum NonDraftableReason {
1606
2053
  TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
1607
2054
  }
1608
2055
  export interface CommitDraftOrderRequest {
1609
- /** The draft order id */
2056
+ /**
2057
+ * The draft order id
2058
+ * @format GUID
2059
+ */
1610
2060
  draftOrderId: string;
1611
2061
  /** Optional side effects to trigger */
1612
2062
  commitSettings?: DraftOrderCommitSettings;
1613
- /** Reason for edit, given by user (optional). */
2063
+ /**
2064
+ * Reason for edit, given by user (optional).
2065
+ * @maxLength 200
2066
+ */
1614
2067
  reason?: string | null;
1615
2068
  }
1616
2069
  export interface CommitDraftOrderResponse {
@@ -1622,6 +2075,7 @@ export interface CommitDraftOrderResponse {
1622
2075
  export interface Order {
1623
2076
  /**
1624
2077
  * Order ID.
2078
+ * @format GUID
1625
2079
  * @readonly
1626
2080
  */
1627
2081
  _id?: string | null;
@@ -1633,6 +2087,7 @@ export interface Order {
1633
2087
  /**
1634
2088
  * Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
1635
2089
  * @readonly
2090
+ * @immutable
1636
2091
  */
1637
2092
  _createdDate?: Date | null;
1638
2093
  /**
@@ -1642,6 +2097,8 @@ export interface Order {
1642
2097
  _updatedDate?: Date | null;
1643
2098
  /**
1644
2099
  * Order line items.
2100
+ * @minSize 1
2101
+ * @maxSize 300
1645
2102
  * @readonly
1646
2103
  */
1647
2104
  lineItems?: OrderLineItem[];
@@ -1661,13 +2118,20 @@ export interface Order {
1661
2118
  buyerLanguage?: string | null;
1662
2119
  /** Weight measurement unit - defaults to site's weight unit. */
1663
2120
  weightUnit?: WeightUnit;
1664
- /** 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. */
2121
+ /**
2122
+ * 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.
2123
+ * @format CURRENCY
2124
+ */
1665
2125
  currency?: string | null;
1666
- /** Whether tax is included in line item prices. */
2126
+ /**
2127
+ * Whether tax is included in line item prices.
2128
+ * @immutable
2129
+ */
1667
2130
  taxIncludedInPrices?: boolean;
1668
2131
  /**
1669
2132
  * Site language in which original values are shown.
1670
2133
  * @readonly
2134
+ * @immutable
1671
2135
  */
1672
2136
  siteLanguage?: string | null;
1673
2137
  /**
@@ -1679,7 +2143,10 @@ export interface Order {
1679
2143
  billingInfo?: AddressWithContact;
1680
2144
  /** Shipping info and selected shipping option details. */
1681
2145
  shippingInfo?: V1ShippingInformation;
1682
- /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
2146
+ /**
2147
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
2148
+ * @maxLength 1000
2149
+ */
1683
2150
  buyerNote?: string | null;
1684
2151
  /** Order status. */
1685
2152
  status?: OrderStatus;
@@ -1698,11 +2165,15 @@ export interface Order {
1698
2165
  taxSummary?: TaxSummary;
1699
2166
  /** Tax information. */
1700
2167
  taxInfo?: OrderTaxInfo;
1701
- /** Applied discounts. */
2168
+ /**
2169
+ * Applied discounts.
2170
+ * @maxSize 320
2171
+ */
1702
2172
  appliedDiscounts?: AppliedDiscount[];
1703
2173
  /**
1704
2174
  * Order activities.
1705
2175
  * @readonly
2176
+ * @maxSize 1000
1706
2177
  */
1707
2178
  activities?: Activity[];
1708
2179
  /** Order attribution source. */
@@ -1716,7 +2187,10 @@ export interface Order {
1716
2187
  channelInfo?: ChannelInfo;
1717
2188
  /** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
1718
2189
  seenByAHuman?: boolean | null;
1719
- /** Checkout ID. */
2190
+ /**
2191
+ * Checkout ID.
2192
+ * @format GUID
2193
+ */
1720
2194
  checkoutId?: string | null;
1721
2195
  /** Custom fields. */
1722
2196
  customFields?: CustomField[];
@@ -1725,7 +2199,10 @@ export interface Order {
1725
2199
  * @readonly
1726
2200
  */
1727
2201
  balanceSummary?: V1BalanceSummary;
1728
- /** Additional fees applied to the order. */
2202
+ /**
2203
+ * Additional fees applied to the order.
2204
+ * @maxSize 100
2205
+ */
1729
2206
  additionalFees?: AdditionalFee[];
1730
2207
  /**
1731
2208
  * Custom field data for the order object.
@@ -1733,7 +2210,10 @@ export interface Order {
1733
2210
  * [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.
1734
2211
  */
1735
2212
  extendedFields?: ExtendedFields;
1736
- /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
2213
+ /**
2214
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
2215
+ * @format GUID
2216
+ */
1737
2217
  purchaseFlowId?: string | null;
1738
2218
  /**
1739
2219
  * Order recipient address and contact details.
@@ -1746,8 +2226,11 @@ export interface Order {
1746
2226
  /**
1747
2227
  * Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
1748
2228
  * Used for migration from external systems.
2229
+ * @immutable
1749
2230
  */
1750
2231
  purchasedDate?: Date | null;
2232
+ /** Order Location */
2233
+ businessLocation?: Location;
1751
2234
  }
1752
2235
  export declare enum PaymentStatus {
1753
2236
  UNSPECIFIED = "UNSPECIFIED",
@@ -1835,11 +2318,13 @@ export interface Activity extends ActivityContentOneOf {
1835
2318
  orderRefunded?: OrderRefunded;
1836
2319
  /**
1837
2320
  * Activity ID.
2321
+ * @format GUID
1838
2322
  * @readonly
1839
2323
  */
1840
2324
  _id?: string | null;
1841
2325
  /**
1842
2326
  * Activity author's email.
2327
+ * @format EMAIL
1843
2328
  * @readonly
1844
2329
  */
1845
2330
  authorEmail?: string | null;
@@ -1861,16 +2346,26 @@ export interface ActivityContentOneOf {
1861
2346
  orderRefunded?: OrderRefunded;
1862
2347
  }
1863
2348
  export interface CustomActivity {
1864
- /** ID of the app that created the custom activity. */
2349
+ /**
2350
+ * ID of the app that created the custom activity.
2351
+ * @format GUID
2352
+ */
1865
2353
  appId?: string;
1866
- /** Custom activity type. For example, `"Ticket number set"`. */
2354
+ /**
2355
+ * Custom activity type. For example, `"Ticket number set"`.
2356
+ * @maxLength 100
2357
+ */
1867
2358
  type?: string;
1868
2359
  /** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
1869
2360
  additionalData?: Record<string, string>;
1870
2361
  }
1871
2362
  /** Store owner added a comment */
1872
2363
  export interface MerchantComment {
1873
- /** Merchant comment message. */
2364
+ /**
2365
+ * Merchant comment message.
2366
+ * @minLength 1
2367
+ * @maxLength 5000
2368
+ */
1874
2369
  message?: string;
1875
2370
  }
1876
2371
  export interface OrderRefunded {
@@ -1878,29 +2373,52 @@ export interface OrderRefunded {
1878
2373
  manual?: boolean;
1879
2374
  /** Refund amount. */
1880
2375
  amount?: Price;
1881
- /** Reason for refund. */
2376
+ /**
2377
+ * Reason for refund.
2378
+ * @maxLength 200
2379
+ */
1882
2380
  reason?: string;
1883
2381
  }
1884
2382
  export interface OrderCreatedFromExchange {
1885
- /** ID of the original order for which the exchange happened. */
2383
+ /**
2384
+ * ID of the original order for which the exchange happened.
2385
+ * @format GUID
2386
+ */
1886
2387
  originalOrderId?: string;
1887
2388
  }
1888
2389
  export interface NewExchangeOrderCreated {
1889
- /** ID of the new order created as a result of an exchange of items. */
2390
+ /**
2391
+ * ID of the new order created as a result of an exchange of items.
2392
+ * @format GUID
2393
+ */
1890
2394
  exchangeOrderId?: string;
1891
- /** IDs of the items that were exchanged. */
2395
+ /**
2396
+ * IDs of the items that were exchanged.
2397
+ * @minSize 1
2398
+ * @maxSize 300
2399
+ */
1892
2400
  lineItems?: LineItemExchangeData[];
1893
2401
  }
1894
2402
  export interface LineItemExchangeData {
1895
- /** ID of the exchanged line item. */
2403
+ /**
2404
+ * ID of the exchanged line item.
2405
+ * @format GUID
2406
+ */
1896
2407
  lineItemId?: string;
1897
- /** Line item quantity being exchanged. */
2408
+ /**
2409
+ * Line item quantity being exchanged.
2410
+ * @min 1
2411
+ * @max 100000
2412
+ */
1898
2413
  quantity?: number;
1899
2414
  }
1900
2415
  export interface DraftOrderChangesApplied {
1901
2416
  /** Draft order id. */
1902
2417
  draftOrderId?: string;
1903
- /** Reason for edit, given by user (optional). */
2418
+ /**
2419
+ * Reason for edit, given by user (optional).
2420
+ * @maxLength 200
2421
+ */
1904
2422
  reason?: string | null;
1905
2423
  /** Changes applied to order. */
1906
2424
  changes?: OrderChange[];
@@ -1929,7 +2447,10 @@ export interface OrderChangeValueOneOf {
1929
2447
  shippingInformationChanged?: ShippingInformationChange;
1930
2448
  }
1931
2449
  export interface LineItemChanges {
1932
- /** Line item ID. */
2450
+ /**
2451
+ * Line item ID.
2452
+ * @format GUID
2453
+ */
1933
2454
  _id?: string;
1934
2455
  /** Item name. */
1935
2456
  name?: ProductName;
@@ -1939,11 +2460,21 @@ export interface LineItemChanges {
1939
2460
  price?: LineItemPriceChange;
1940
2461
  }
1941
2462
  export interface LineItemQuantityChange {
1942
- /** Item quantity before update. */
2463
+ /**
2464
+ * Item quantity before update.
2465
+ * @max 1000000
2466
+ */
1943
2467
  originalQuantity?: number;
1944
- /** Item quantity after update. */
2468
+ /**
2469
+ * Item quantity after update.
2470
+ * @max 1000000
2471
+ */
1945
2472
  newQuantity?: number;
1946
- /** Difference between original and new quantity. Absolute value. */
2473
+ /**
2474
+ * Difference between original and new quantity. Absolute value.
2475
+ * @min 1
2476
+ * @max 1000000
2477
+ */
1947
2478
  diff?: number;
1948
2479
  /** Type of quantity change: increase or decrease. */
1949
2480
  deltaType?: LineItemQuantityChangeType;
@@ -1961,15 +2492,25 @@ export interface LineItemPriceChange {
1961
2492
  newPrice?: Price;
1962
2493
  }
1963
2494
  export interface ManagedLineItem {
1964
- /** Line item ID. */
2495
+ /**
2496
+ * Line item ID.
2497
+ * @format GUID
2498
+ */
1965
2499
  _id?: string;
1966
2500
  /** Item name. */
1967
2501
  name?: ProductName;
1968
- /** Added or removed item quantity. */
2502
+ /**
2503
+ * Added or removed item quantity.
2504
+ * @min 1
2505
+ * @max 1000000
2506
+ */
1969
2507
  quantity?: number;
1970
2508
  }
1971
2509
  export interface ManagedDiscount {
1972
- /** Discount id. */
2510
+ /**
2511
+ * Discount id.
2512
+ * @format GUID
2513
+ */
1973
2514
  _id?: string;
1974
2515
  /** Discount name: coupon name / discount rule name / merchant discount description. */
1975
2516
  name?: TranslatedValue;
@@ -1979,13 +2520,22 @@ export interface ManagedDiscount {
1979
2520
  totalAmount?: Price;
1980
2521
  }
1981
2522
  export interface TranslatedValue {
1982
- /** Value in site default language. */
2523
+ /**
2524
+ * Value in site default language.
2525
+ * @minLength 1
2526
+ */
1983
2527
  original?: string;
1984
- /** Translated value. */
2528
+ /**
2529
+ * Translated value.
2530
+ * @minLength 1
2531
+ */
1985
2532
  translated?: string | null;
1986
2533
  }
1987
2534
  export interface LineItemAmount {
1988
- /** Order line item id */
2535
+ /**
2536
+ * Order line item id
2537
+ * @format GUID
2538
+ */
1989
2539
  _id?: string;
1990
2540
  /** Item name. */
1991
2541
  name?: ProductName;
@@ -1993,7 +2543,10 @@ export interface LineItemAmount {
1993
2543
  amount?: Price;
1994
2544
  }
1995
2545
  export interface ManagedAdditionalFee {
1996
- /** Additional fee id. */
2546
+ /**
2547
+ * Additional fee id.
2548
+ * @format GUID
2549
+ */
1997
2550
  _id?: string;
1998
2551
  /** Additional fee name. */
1999
2552
  name?: TranslatedValue;
@@ -2017,54 +2570,102 @@ export interface ShippingInformationChange {
2017
2570
  export interface ShippingInformation {
2018
2571
  /** Order’s shipping price. */
2019
2572
  total?: Price;
2020
- /** Order’s shipping title. */
2573
+ /**
2574
+ * Order’s shipping title.
2575
+ * @maxLength 250
2576
+ */
2021
2577
  shippingTitle?: string;
2022
2578
  }
2023
2579
  /** Payment method is saved for order */
2024
2580
  export interface SavedPaymentMethod {
2025
- /** Payment method name */
2581
+ /**
2582
+ * Payment method name
2583
+ * @minLength 1
2584
+ * @maxLength 100
2585
+ */
2026
2586
  name?: string;
2027
- /** Payment method description */
2587
+ /**
2588
+ * Payment method description
2589
+ * @minLength 1
2590
+ * @maxLength 100
2591
+ */
2028
2592
  description?: string | null;
2029
2593
  }
2030
2594
  export interface AuthorizedPaymentCreated {
2031
- /** Payment ID of payment associated with this activity */
2595
+ /**
2596
+ * Payment ID of payment associated with this activity
2597
+ * @format GUID
2598
+ */
2032
2599
  paymentId?: string;
2033
2600
  /** Payment amount */
2034
2601
  amount?: Price;
2035
- /** The last 4 digits of the card number. */
2602
+ /**
2603
+ * The last 4 digits of the card number.
2604
+ * @maxLength 4
2605
+ */
2036
2606
  lastFourDigits?: string | null;
2037
- /** Card issuer's brand. */
2607
+ /**
2608
+ * Card issuer's brand.
2609
+ * @maxLength 100
2610
+ */
2038
2611
  brand?: string | null;
2039
2612
  }
2040
2613
  export interface AuthorizedPaymentCaptured {
2041
- /** Payment ID of payment associated with this activity */
2614
+ /**
2615
+ * Payment ID of payment associated with this activity
2616
+ * @format GUID
2617
+ */
2042
2618
  paymentId?: string;
2043
2619
  /** Payment amount */
2044
2620
  amount?: Price;
2045
- /** The last 4 digits of the card number. */
2621
+ /**
2622
+ * The last 4 digits of the card number.
2623
+ * @maxLength 4
2624
+ */
2046
2625
  lastFourDigits?: string | null;
2047
- /** Card issuer's brand. */
2626
+ /**
2627
+ * Card issuer's brand.
2628
+ * @maxLength 100
2629
+ */
2048
2630
  brand?: string | null;
2049
2631
  }
2050
2632
  export interface AuthorizedPaymentVoided {
2051
- /** Payment ID of payment associated with this activity */
2633
+ /**
2634
+ * Payment ID of payment associated with this activity
2635
+ * @format GUID
2636
+ */
2052
2637
  paymentId?: string;
2053
2638
  /** Payment amount */
2054
2639
  amount?: Price;
2055
- /** The last 4 digits of the card number. */
2640
+ /**
2641
+ * The last 4 digits of the card number.
2642
+ * @maxLength 4
2643
+ */
2056
2644
  lastFourDigits?: string | null;
2057
- /** Card issuer's brand. */
2645
+ /**
2646
+ * Card issuer's brand.
2647
+ * @maxLength 100
2648
+ */
2058
2649
  brand?: string | null;
2059
2650
  }
2060
2651
  export interface RefundInitiated {
2061
- /** Refund ID. */
2652
+ /**
2653
+ * Refund ID.
2654
+ * @format GUID
2655
+ */
2062
2656
  refundId?: string;
2063
2657
  /** Refund amount. */
2064
2658
  amount?: Price;
2065
- /** Details about the payments being refunded. */
2659
+ /**
2660
+ * Details about the payments being refunded.
2661
+ * @minSize 1
2662
+ * @maxSize 50
2663
+ */
2066
2664
  payments?: RefundedPayment[];
2067
- /** Reason for refund. */
2665
+ /**
2666
+ * Reason for refund.
2667
+ * @maxLength 100
2668
+ */
2068
2669
  reason?: string | null;
2069
2670
  }
2070
2671
  export interface RefundedPayment extends RefundedPaymentKindOneOf {
@@ -2074,7 +2675,10 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
2074
2675
  giftCard?: GiftCardPaymentRefund;
2075
2676
  /** Membership payment refund. */
2076
2677
  membership?: MembershipPaymentRefund;
2077
- /** Payment ID. */
2678
+ /**
2679
+ * Payment ID.
2680
+ * @format GUID
2681
+ */
2078
2682
  paymentId?: string;
2079
2683
  /** Whether refund was made externally and manually on the payment provider's side. */
2080
2684
  externalRefund?: boolean;
@@ -2091,29 +2695,49 @@ export interface RefundedPaymentKindOneOf {
2091
2695
  export interface RegularPaymentRefund {
2092
2696
  /** Refund amount */
2093
2697
  amount?: Price;
2094
- /** The last 4 digits of the card number. */
2698
+ /**
2699
+ * The last 4 digits of the card number.
2700
+ * @maxLength 4
2701
+ */
2095
2702
  lastFourDigits?: string | null;
2096
- /** Card issuer's brand. */
2703
+ /**
2704
+ * Card issuer's brand.
2705
+ * @maxLength 100
2706
+ */
2097
2707
  brand?: string | null;
2098
2708
  }
2099
2709
  export interface GiftCardPaymentRefund {
2100
- /** Gift card payment ID */
2710
+ /**
2711
+ * Gift card payment ID
2712
+ * @minLength 1
2713
+ * @maxLength 100
2714
+ */
2101
2715
  giftCardPaymentId?: string | null;
2102
2716
  /** Refund amount */
2103
2717
  amount?: Price;
2104
2718
  }
2105
2719
  export interface MembershipPaymentRefund {
2106
- /** Membership ID */
2720
+ /**
2721
+ * Membership ID
2722
+ * @minLength 1
2723
+ * @maxLength 100
2724
+ */
2107
2725
  membershipId?: string | null;
2108
2726
  }
2109
2727
  export interface PaymentRefunded {
2110
- /** Refund ID. */
2728
+ /**
2729
+ * Refund ID.
2730
+ * @format GUID
2731
+ */
2111
2732
  refundId?: string;
2112
2733
  /** Details about the refunded payment. */
2113
2734
  payment?: RefundedPayment;
2114
2735
  }
2115
2736
  export interface PaymentRefundFailed {
2116
- /** Refund ID. */
2737
+ /**
2738
+ * Refund ID.
2739
+ * @format GUID
2740
+ */
2117
2741
  refundId?: string;
2118
2742
  /** Details about the failed payment refund. */
2119
2743
  payment?: RefundedPayment;
@@ -2121,13 +2745,19 @@ export interface PaymentRefundFailed {
2121
2745
  export interface RefundedAsStoreCredit {
2122
2746
  /** Refund amount */
2123
2747
  amount?: Price;
2124
- /** Reason for refund */
2748
+ /**
2749
+ * Reason for refund
2750
+ * @maxLength 100
2751
+ */
2125
2752
  reason?: string | null;
2126
2753
  }
2127
2754
  export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
2128
2755
  /** Regular payment. */
2129
2756
  regular?: RegularPayment;
2130
- /** Payment ID of payment associated with this activity */
2757
+ /**
2758
+ * Payment ID of payment associated with this activity
2759
+ * @format GUID
2760
+ */
2131
2761
  paymentId?: string;
2132
2762
  }
2133
2763
  /** @oneof */
@@ -2147,15 +2777,24 @@ export interface RegularPaymentPaymentMethodDetailsOneOf {
2147
2777
  creditCardDetails?: CreditCardDetails;
2148
2778
  }
2149
2779
  export interface CreditCardDetails {
2150
- /** The last 4 digits of the card number. */
2780
+ /**
2781
+ * The last 4 digits of the card number.
2782
+ * @maxLength 4
2783
+ */
2151
2784
  lastFourDigits?: string | null;
2152
- /** Card issuer's brand. */
2785
+ /**
2786
+ * Card issuer's brand.
2787
+ * @maxLength 100
2788
+ */
2153
2789
  brand?: string | null;
2154
2790
  }
2155
2791
  export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
2156
2792
  /** Regular payment. */
2157
2793
  regular?: RegularPayment;
2158
- /** Payment ID of payment associated with this activity */
2794
+ /**
2795
+ * Payment ID of payment associated with this activity
2796
+ * @format GUID
2797
+ */
2159
2798
  paymentId?: string;
2160
2799
  }
2161
2800
  /** @oneof */
@@ -2166,7 +2805,10 @@ export interface PaymentCanceledPaymentDetailsOneOf {
2166
2805
  export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
2167
2806
  /** Regular payment. */
2168
2807
  regular?: RegularPayment;
2169
- /** Payment ID of payment associated with this activity */
2808
+ /**
2809
+ * Payment ID of payment associated with this activity
2810
+ * @format GUID
2811
+ */
2170
2812
  paymentId?: string;
2171
2813
  }
2172
2814
  /** @oneof */
@@ -2179,7 +2821,10 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
2179
2821
  wixReceipt?: WixReceipt;
2180
2822
  /** Receipt created by an external system. */
2181
2823
  externalReceipt?: ExternalReceipt;
2182
- /** Payment ID of payment associated with this activity */
2824
+ /**
2825
+ * Payment ID of payment associated with this activity
2826
+ * @format GUID
2827
+ */
2183
2828
  paymentId?: string;
2184
2829
  }
2185
2830
  /** @oneof */
@@ -2190,15 +2835,29 @@ export interface ReceiptCreatedReceiptInfoOneOf {
2190
2835
  externalReceipt?: ExternalReceipt;
2191
2836
  }
2192
2837
  export interface WixReceipt {
2193
- /** Receipt ID */
2838
+ /**
2839
+ * Receipt ID
2840
+ * @format GUID
2841
+ */
2194
2842
  receiptId?: string;
2195
- /** Display number of receipt */
2843
+ /**
2844
+ * Display number of receipt
2845
+ * @minLength 1
2846
+ * @maxLength 40
2847
+ */
2196
2848
  displayNumber?: string | null;
2197
2849
  }
2198
2850
  export interface ExternalReceipt {
2199
- /** Receipt ID */
2851
+ /**
2852
+ * Receipt ID
2853
+ * @maxLength 100
2854
+ */
2200
2855
  receiptId?: string | null;
2201
- /** Display number of receipt */
2856
+ /**
2857
+ * Display number of receipt
2858
+ * @minLength 1
2859
+ * @maxLength 40
2860
+ */
2202
2861
  displayNumber?: string | null;
2203
2862
  }
2204
2863
  export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
@@ -2206,7 +2865,10 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
2206
2865
  wixReceipt?: WixReceipt;
2207
2866
  /** Receipt created by an external system. */
2208
2867
  externalReceipt?: ExternalReceipt;
2209
- /** Payment ID of payment associated with this activity */
2868
+ /**
2869
+ * Payment ID of payment associated with this activity
2870
+ * @format GUID
2871
+ */
2210
2872
  paymentId?: string;
2211
2873
  }
2212
2874
  /** @oneof */
@@ -2261,13 +2923,23 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
2261
2923
  /**
2262
2924
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2263
2925
  * For example, via POS (point of service).
2926
+ * @format GUID
2264
2927
  */
2265
2928
  userId?: string;
2266
- /** Member ID - when the order was created by a **logged in** site visitor. */
2929
+ /**
2930
+ * Member ID - when the order was created by a **logged in** site visitor.
2931
+ * @format GUID
2932
+ */
2267
2933
  memberId?: string;
2268
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
2934
+ /**
2935
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
2936
+ * @format GUID
2937
+ */
2269
2938
  visitorId?: string;
2270
- /** App ID - when the order was created by an external application. */
2939
+ /**
2940
+ * App ID - when the order was created by an external application.
2941
+ * @format GUID
2942
+ */
2271
2943
  appId?: string;
2272
2944
  }
2273
2945
  /** @oneof */
@@ -2275,21 +2947,37 @@ export interface V1CreatedByStringOneOf {
2275
2947
  /**
2276
2948
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2277
2949
  * For example, via POS (point of service).
2950
+ * @format GUID
2278
2951
  */
2279
2952
  userId?: string;
2280
- /** Member ID - when the order was created by a **logged in** site visitor. */
2953
+ /**
2954
+ * Member ID - when the order was created by a **logged in** site visitor.
2955
+ * @format GUID
2956
+ */
2281
2957
  memberId?: string;
2282
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
2958
+ /**
2959
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
2960
+ * @format GUID
2961
+ */
2283
2962
  visitorId?: string;
2284
- /** App ID - when the order was created by an external application. */
2963
+ /**
2964
+ * App ID - when the order was created by an external application.
2965
+ * @format GUID
2966
+ */
2285
2967
  appId?: string;
2286
2968
  }
2287
2969
  export interface ChannelInfo {
2288
2970
  /** Sales channel that submitted the order. */
2289
2971
  type?: ChannelType;
2290
- /** Reference to an order ID from an external system. */
2972
+ /**
2973
+ * Reference to an order ID from an external system.
2974
+ * @maxLength 100
2975
+ */
2291
2976
  externalOrderId?: string | null;
2292
- /** URL to the order in the external system. */
2977
+ /**
2978
+ * URL to the order in the external system.
2979
+ * @maxLength 300
2980
+ */
2293
2981
  externalOrderUrl?: string | null;
2294
2982
  }
2295
2983
  export declare enum ChannelType {
@@ -2329,9 +3017,17 @@ export declare enum ChannelType {
2329
3017
  export interface CustomField {
2330
3018
  /** Custom field value. */
2331
3019
  value?: any;
2332
- /** Custom field title. */
3020
+ /**
3021
+ * Custom field title.
3022
+ * @minLength 1
3023
+ * @maxLength 500
3024
+ */
2333
3025
  title?: string;
2334
- /** Translated custom field title. */
3026
+ /**
3027
+ * Translated custom field title.
3028
+ * @minLength 1
3029
+ * @maxLength 500
3030
+ */
2335
3031
  translatedTitle?: string | null;
2336
3032
  }
2337
3033
  export interface V1BalanceSummary {
@@ -2396,7 +3092,11 @@ export interface Tags {
2396
3092
  tags?: TagList;
2397
3093
  }
2398
3094
  export interface TagList {
2399
- /** List of tag IDs */
3095
+ /**
3096
+ * List of tag IDs
3097
+ * @maxSize 100
3098
+ * @maxLength 5
3099
+ */
2400
3100
  tagIds?: string[];
2401
3101
  }
2402
3102
  export interface CreateOrderFromDraftRequest {
@@ -2408,7 +3108,10 @@ export interface OrderCreateNotifications {
2408
3108
  export interface CreateOrderFromDraftResponse {
2409
3109
  }
2410
3110
  export interface DeleteDraftOrderRequest {
2411
- /** The draft order id */
3111
+ /**
3112
+ * The draft order id
3113
+ * @format GUID
3114
+ */
2412
3115
  draftOrderId: string;
2413
3116
  }
2414
3117
  export interface DeleteDraftOrderResponse {
@@ -2434,6 +3137,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2434
3137
  * Sort object.
2435
3138
  *
2436
3139
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
3140
+ * @maxSize 5
2437
3141
  */
2438
3142
  sort?: Sorting[];
2439
3143
  }
@@ -2447,7 +3151,10 @@ export interface CursorQueryPagingMethodOneOf {
2447
3151
  cursorPaging?: CursorPaging;
2448
3152
  }
2449
3153
  export interface Sorting {
2450
- /** Name of the field to sort by. */
3154
+ /**
3155
+ * Name of the field to sort by.
3156
+ * @maxLength 512
3157
+ */
2451
3158
  fieldName?: string;
2452
3159
  /** Sort order. */
2453
3160
  order?: SortOrder;
@@ -2457,13 +3164,17 @@ export declare enum SortOrder {
2457
3164
  DESC = "DESC"
2458
3165
  }
2459
3166
  export interface CursorPaging {
2460
- /** Maximum number of items to return in the results. */
3167
+ /**
3168
+ * Maximum number of items to return in the results.
3169
+ * @max 100
3170
+ */
2461
3171
  limit?: number | null;
2462
3172
  /**
2463
3173
  * Pointer to the next or previous page in the list of results.
2464
3174
  *
2465
3175
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2466
3176
  * Not relevant for the first request.
3177
+ * @maxLength 16000
2467
3178
  */
2468
3179
  cursor?: string | null;
2469
3180
  }
@@ -2487,9 +3198,15 @@ export interface CursorPagingMetadata {
2487
3198
  hasNext?: boolean | null;
2488
3199
  }
2489
3200
  export interface Cursors {
2490
- /** Cursor string pointing to the next page in the list of results. */
3201
+ /**
3202
+ * Cursor string pointing to the next page in the list of results.
3203
+ * @maxLength 16000
3204
+ */
2491
3205
  next?: string | null;
2492
- /** Cursor pointing to the previous page in the list of results. */
3206
+ /**
3207
+ * Cursor pointing to the previous page in the list of results.
3208
+ * @maxLength 16000
3209
+ */
2493
3210
  prev?: string | null;
2494
3211
  }
2495
3212
  export interface UpdateExtendedFieldsRequest {
@@ -2509,11 +3226,17 @@ export interface SetTaxExemptionRequest {
2509
3226
  export interface SetTaxExemptionResponse {
2510
3227
  }
2511
3228
  export interface GetDraftEditabilityStatusRequest {
2512
- /** Draft order ID. */
3229
+ /**
3230
+ * Draft order ID.
3231
+ * @format GUID
3232
+ */
2513
3233
  draftOrderId?: string | null;
2514
3234
  }
2515
3235
  export interface GetDraftEditabilityStatusResponse {
2516
- /** Draft order ID. */
3236
+ /**
3237
+ * Draft order ID.
3238
+ * @format GUID
3239
+ */
2517
3240
  draftOrderId?: string | null;
2518
3241
  /**
2519
3242
  * Draft order status.
@@ -2596,9 +3319,15 @@ export interface ActionEvent {
2596
3319
  body?: string;
2597
3320
  }
2598
3321
  export interface MessageEnvelope {
2599
- /** App instance ID. */
3322
+ /**
3323
+ * App instance ID.
3324
+ * @format GUID
3325
+ */
2600
3326
  instanceId?: string | null;
2601
- /** Event type. */
3327
+ /**
3328
+ * Event type.
3329
+ * @maxLength 150
3330
+ */
2602
3331
  eventType?: string;
2603
3332
  /** The identification type and identity data. */
2604
3333
  identity?: IdentificationData;
@@ -2606,26 +3335,50 @@ export interface MessageEnvelope {
2606
3335
  data?: string;
2607
3336
  }
2608
3337
  export interface IdentificationData extends IdentificationDataIdOneOf {
2609
- /** ID of a site visitor that has not logged in to the site. */
3338
+ /**
3339
+ * ID of a site visitor that has not logged in to the site.
3340
+ * @format GUID
3341
+ */
2610
3342
  anonymousVisitorId?: string;
2611
- /** ID of a site visitor that has logged in to the site. */
3343
+ /**
3344
+ * ID of a site visitor that has logged in to the site.
3345
+ * @format GUID
3346
+ */
2612
3347
  memberId?: string;
2613
- /** ID of a Wix user (site owner, contributor, etc.). */
3348
+ /**
3349
+ * ID of a Wix user (site owner, contributor, etc.).
3350
+ * @format GUID
3351
+ */
2614
3352
  wixUserId?: string;
2615
- /** ID of an app. */
3353
+ /**
3354
+ * ID of an app.
3355
+ * @format GUID
3356
+ */
2616
3357
  appId?: string;
2617
3358
  /** @readonly */
2618
3359
  identityType?: WebhookIdentityType;
2619
3360
  }
2620
3361
  /** @oneof */
2621
3362
  export interface IdentificationDataIdOneOf {
2622
- /** ID of a site visitor that has not logged in to the site. */
3363
+ /**
3364
+ * ID of a site visitor that has not logged in to the site.
3365
+ * @format GUID
3366
+ */
2623
3367
  anonymousVisitorId?: string;
2624
- /** ID of a site visitor that has logged in to the site. */
3368
+ /**
3369
+ * ID of a site visitor that has logged in to the site.
3370
+ * @format GUID
3371
+ */
2625
3372
  memberId?: string;
2626
- /** ID of a Wix user (site owner, contributor, etc.). */
3373
+ /**
3374
+ * ID of a Wix user (site owner, contributor, etc.).
3375
+ * @format GUID
3376
+ */
2627
3377
  wixUserId?: string;
2628
- /** ID of an app. */
3378
+ /**
3379
+ * ID of an app.
3380
+ * @format GUID
3381
+ */
2629
3382
  appId?: string;
2630
3383
  }
2631
3384
  export declare enum WebhookIdentityType {
@@ -2894,6 +3647,19 @@ interface OrderTaxInfoNonNullableFields {
2894
3647
  totalTax?: PriceNonNullableFields;
2895
3648
  taxBreakdown: OrderTaxBreakdownNonNullableFields[];
2896
3649
  }
3650
+ interface LocationNonNullableFields {
3651
+ _id: string;
3652
+ name: string;
3653
+ }
3654
+ interface BusinessLocationChangedDetailsNonNullableFields {
3655
+ businessLocationBeforeChange?: LocationNonNullableFields;
3656
+ }
3657
+ interface BusinessLocationDetailsNonNullableFields {
3658
+ added: boolean;
3659
+ changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
3660
+ removed: boolean;
3661
+ businessLocation?: LocationNonNullableFields;
3662
+ }
2897
3663
  interface DraftOrderNonNullableFields {
2898
3664
  lineItems: ItemDetailsNonNullableFields[];
2899
3665
  shippingInfo?: ShippingDetailsNonNullableFields;
@@ -2909,6 +3675,7 @@ interface DraftOrderNonNullableFields {
2909
3675
  balanceSummary?: BalanceSummaryNonNullableFields;
2910
3676
  commitSettings?: DraftOrderCommitSettingsNonNullableFields;
2911
3677
  recipientInfo?: RecipientInfoDetailsNonNullableFields;
3678
+ businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
2912
3679
  }
2913
3680
  interface PickupDetailsNonNullableFields {
2914
3681
  address?: AddressNonNullableFields;
@@ -3082,6 +3849,7 @@ interface OrderNonNullableFields {
3082
3849
  balanceSummary?: V1BalanceSummaryNonNullableFields;
3083
3850
  additionalFees: AdditionalFeeNonNullableFields[];
3084
3851
  recipientInfo?: AddressWithContactNonNullableFields;
3852
+ businessLocation?: LocationNonNullableFields;
3085
3853
  }
3086
3854
  export interface CommitDraftOrderResponseNonNullableFields {
3087
3855
  committedDraftOrder?: DraftOrderNonNullableFields;
@@ -3110,6 +3878,8 @@ export interface SetBusinessLocationResponseNonNullableFields {
3110
3878
  * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
3111
3879
  * @permissionScope Manage Stores - all permissions
3112
3880
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3881
+ * @permissionScope Manage Restaurants - all permissions
3882
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3113
3883
  * @permissionScope Manage eCommerce - all permissions
3114
3884
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3115
3885
  * @applicableIdentity APP
@@ -3125,6 +3895,8 @@ export declare function createDraftOrder(orderId: string | null): Promise<Create
3125
3895
  * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
3126
3896
  * @permissionScope Manage Stores - all permissions
3127
3897
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3898
+ * @permissionScope Manage Restaurants - all permissions
3899
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3128
3900
  * @permissionScope Manage eCommerce - all permissions
3129
3901
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3130
3902
  * @applicableIdentity APP
@@ -3141,6 +3913,8 @@ export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderRe
3141
3913
  * @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
3142
3914
  * @permissionScope Manage Stores - all permissions
3143
3915
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3916
+ * @permissionScope Manage Restaurants - all permissions
3917
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3144
3918
  * @permissionScope Manage eCommerce - all permissions
3145
3919
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3146
3920
  * @applicableIdentity APP
@@ -3148,9 +3922,15 @@ export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderRe
3148
3922
  */
3149
3923
  export declare function addLineItemsToDraftOrder(draftOrderId: string, options?: AddLineItemsToDraftOrderOptions): Promise<AddLineItemsToDraftOrderResponse & AddLineItemsToDraftOrderResponseNonNullableFields>;
3150
3924
  export interface AddLineItemsToDraftOrderOptions {
3151
- /** Catalog line items to add to draft order. */
3925
+ /**
3926
+ * Catalog line items to add to draft order.
3927
+ * @maxSize 300
3928
+ */
3152
3929
  catalogLineItems?: CatalogReferenceLineItem[];
3153
- /** Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin. */
3930
+ /**
3931
+ * Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
3932
+ * @maxSize 300
3933
+ */
3154
3934
  customLineItems?: CustomLineItem[];
3155
3935
  }
3156
3936
  /**
@@ -3168,6 +3948,8 @@ export interface AddLineItemsToDraftOrderOptions {
3168
3948
  * @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
3169
3949
  * @permissionScope Manage Stores - all permissions
3170
3950
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3951
+ * @permissionScope Manage Restaurants - all permissions
3952
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3171
3953
  * @permissionScope Manage eCommerce - all permissions
3172
3954
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3173
3955
  * @applicableIdentity APP
@@ -3175,7 +3957,11 @@ export interface AddLineItemsToDraftOrderOptions {
3175
3957
  */
3176
3958
  export declare function updateLineItems(draftOrderId: string, options?: UpdateLineItemsOptions): Promise<UpdateLineItemsResponse & UpdateLineItemsResponseNonNullableFields>;
3177
3959
  export interface UpdateLineItemsOptions {
3178
- /** Details of changes to apply per line item */
3960
+ /**
3961
+ * Details of changes to apply per line item
3962
+ * @minSize 1
3963
+ * @maxSize 300
3964
+ */
3179
3965
  lineItemChanges?: LineItemChangeDetails[];
3180
3966
  }
3181
3967
  /**
@@ -3191,6 +3977,8 @@ export interface UpdateLineItemsOptions {
3191
3977
  * @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
3192
3978
  * @permissionScope Manage Stores - all permissions
3193
3979
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3980
+ * @permissionScope Manage Restaurants - all permissions
3981
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3194
3982
  * @permissionScope Manage eCommerce - all permissions
3195
3983
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3196
3984
  * @applicableIdentity APP
@@ -3209,6 +3997,8 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
3209
3997
  * @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
3210
3998
  * @permissionScope Manage Stores - all permissions
3211
3999
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4000
+ * @permissionScope Manage Restaurants - all permissions
4001
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3212
4002
  * @permissionScope Manage eCommerce - all permissions
3213
4003
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3214
4004
  * @applicableIdentity APP
@@ -3216,7 +4006,11 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
3216
4006
  */
3217
4007
  export declare function createCustomDiscounts(draftOrderId: string, options?: CreateCustomDiscountsOptions): Promise<CreateCustomDiscountsResponse & CreateCustomDiscountsResponseNonNullableFields>;
3218
4008
  export interface CreateCustomDiscountsOptions {
3219
- /** The discounts to add. */
4009
+ /**
4010
+ * The discounts to add.
4011
+ * @minSize 1
4012
+ * @maxSize 100
4013
+ */
3220
4014
  discounts?: DiscountOption[];
3221
4015
  }
3222
4016
  /**
@@ -3230,6 +4024,8 @@ export interface CreateCustomDiscountsOptions {
3230
4024
  * @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
3231
4025
  * @permissionScope Manage Stores - all permissions
3232
4026
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4027
+ * @permissionScope Manage Restaurants - all permissions
4028
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3233
4029
  * @permissionScope Manage eCommerce - all permissions
3234
4030
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3235
4031
  * @applicableIdentity APP
@@ -3248,6 +4044,8 @@ export declare function deleteCustomDiscounts(draftOrderId: string, discountIds:
3248
4044
  * @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
3249
4045
  * @permissionScope Manage Stores - all permissions
3250
4046
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4047
+ * @permissionScope Manage Restaurants - all permissions
4048
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3251
4049
  * @permissionScope Manage eCommerce - all permissions
3252
4050
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3253
4051
  * @applicableIdentity APP
@@ -3268,6 +4066,8 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
3268
4066
  * @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
3269
4067
  * @permissionScope Manage Stores - all permissions
3270
4068
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4069
+ * @permissionScope Manage Restaurants - all permissions
4070
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3271
4071
  * @permissionScope Manage eCommerce - all permissions
3272
4072
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3273
4073
  * @applicableIdentity APP
@@ -3275,7 +4075,11 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
3275
4075
  */
3276
4076
  export declare function createCustomAdditionalFees(draftOrderId: string, options?: CreateCustomAdditionalFeesOptions): Promise<CreateCustomAdditionalFeesResponse & CreateCustomAdditionalFeesResponseNonNullableFields>;
3277
4077
  export interface CreateCustomAdditionalFeesOptions {
3278
- /** The additional fees to add. added with opted-out setting */
4078
+ /**
4079
+ * The additional fees to add. added with opted-out setting
4080
+ * @minSize 1
4081
+ * @maxSize 100
4082
+ */
3279
4083
  customAdditionalFees?: AdditionalFeeOption[];
3280
4084
  }
3281
4085
  /**
@@ -3289,6 +4093,8 @@ export interface CreateCustomAdditionalFeesOptions {
3289
4093
  * @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
3290
4094
  * @permissionScope Manage Stores - all permissions
3291
4095
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4096
+ * @permissionScope Manage Restaurants - all permissions
4097
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3292
4098
  * @permissionScope Manage eCommerce - all permissions
3293
4099
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3294
4100
  * @applicableIdentity APP
@@ -3302,6 +4108,8 @@ export declare function deleteCustomAdditionalFees(draftOrderId: string, customA
3302
4108
  * @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
3303
4109
  * @permissionScope Manage Stores - all permissions
3304
4110
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4111
+ * @permissionScope Manage Restaurants - all permissions
4112
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3305
4113
  * @permissionScope Manage eCommerce - all permissions
3306
4114
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3307
4115
  * @applicableIdentity APP
@@ -3315,6 +4123,8 @@ export declare function setShippingInfo(): Promise<void>;
3315
4123
  * @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
3316
4124
  * @permissionScope Manage Stores - all permissions
3317
4125
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4126
+ * @permissionScope Manage Restaurants - all permissions
4127
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3318
4128
  * @permissionScope Manage eCommerce - all permissions
3319
4129
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3320
4130
  * @applicableIdentity APP
@@ -3328,6 +4138,8 @@ export declare function setBuyerInfo(): Promise<void>;
3328
4138
  * @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
3329
4139
  * @permissionScope Manage Stores - all permissions
3330
4140
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4141
+ * @permissionScope Manage Restaurants - all permissions
4142
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3331
4143
  * @permissionScope Manage eCommerce - all permissions
3332
4144
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3333
4145
  * @applicableIdentity APP
@@ -3341,6 +4153,8 @@ export declare function setRecipientInfo(): Promise<void>;
3341
4153
  * @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
3342
4154
  * @permissionScope Manage Stores - all permissions
3343
4155
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4156
+ * @permissionScope Manage Restaurants - all permissions
4157
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3344
4158
  * @permissionScope Manage eCommerce - all permissions
3345
4159
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3346
4160
  * @applicableIdentity APP
@@ -3361,6 +4175,8 @@ export declare function setBillingInfo(): Promise<void>;
3361
4175
  * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
3362
4176
  * @permissionScope Manage Stores - all permissions
3363
4177
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4178
+ * @permissionScope Manage Restaurants - all permissions
4179
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3364
4180
  * @permissionScope Manage eCommerce - all permissions
3365
4181
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3366
4182
  * @applicableIdentity APP
@@ -3376,6 +4192,8 @@ export declare function getDraftOrder(draftOrderId: string): Promise<GetDraftOrd
3376
4192
  * @permissionId ECOM.DRAFT_ORDERS_READ
3377
4193
  * @permissionScope Manage Stores - all permissions
3378
4194
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4195
+ * @permissionScope Manage Restaurants - all permissions
4196
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3379
4197
  * @permissionScope Manage eCommerce - all permissions
3380
4198
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3381
4199
  * @applicableIdentity APP
@@ -3394,6 +4212,8 @@ export declare function getOrderDraftabilityStatus(orderId: string): Promise<Get
3394
4212
  * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
3395
4213
  * @permissionScope Manage Stores - all permissions
3396
4214
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4215
+ * @permissionScope Manage Restaurants - all permissions
4216
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3397
4217
  * @permissionScope Manage eCommerce - all permissions
3398
4218
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3399
4219
  * @applicableIdentity APP
@@ -3403,7 +4223,10 @@ export declare function commitDraftOrder(draftOrderId: string, options?: CommitD
3403
4223
  export interface CommitDraftOrderOptions {
3404
4224
  /** Optional side effects to trigger */
3405
4225
  commitSettings?: DraftOrderCommitSettings;
3406
- /** Reason for edit, given by user (optional). */
4226
+ /**
4227
+ * Reason for edit, given by user (optional).
4228
+ * @maxLength 200
4229
+ */
3407
4230
  reason?: string | null;
3408
4231
  }
3409
4232
  /**
@@ -3416,6 +4239,8 @@ export interface CommitDraftOrderOptions {
3416
4239
  * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
3417
4240
  * @permissionScope Manage Stores - all permissions
3418
4241
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4242
+ * @permissionScope Manage Restaurants - all permissions
4243
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3419
4244
  * @permissionScope Manage eCommerce - all permissions
3420
4245
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3421
4246
  * @applicableIdentity APP
@@ -3433,6 +4258,8 @@ export declare function createOrderFromDraft(): Promise<void>;
3433
4258
  * @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
3434
4259
  * @permissionScope Manage Stores - all permissions
3435
4260
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4261
+ * @permissionScope Manage Restaurants - all permissions
4262
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3436
4263
  * @permissionScope Manage eCommerce - all permissions
3437
4264
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3438
4265
  * @applicableIdentity APP
@@ -3454,6 +4281,8 @@ export declare function deleteDraftOrder(draftOrderId: string): Promise<void>;
3454
4281
  * @documentationMaturity preview
3455
4282
  * @permissionScope Manage Stores - all permissions
3456
4283
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4284
+ * @permissionScope Manage Restaurants - all permissions
4285
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3457
4286
  * @permissionScope Manage eCommerce - all permissions
3458
4287
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3459
4288
  * @permissionId ECOM.DRAFT_ORDERS_READ
@@ -3545,6 +4374,8 @@ export interface DraftOrdersQueryBuilder {
3545
4374
  * @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
3546
4375
  * @permissionScope Manage Stores - all permissions
3547
4376
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4377
+ * @permissionScope Manage Restaurants - all permissions
4378
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3548
4379
  * @permissionScope Manage eCommerce - all permissions
3549
4380
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3550
4381
  * @applicableIdentity APP