@wix/auto_sdk_ecom_draft-orders 1.0.1 → 1.0.3

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 +1017 -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 +1086 -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 +1017 -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 +1086 -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 +997 -225
  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 +1075 -264
  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 +997 -225
  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 +1075 -264
  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
  /**
@@ -226,6 +272,13 @@ export interface OrderLineItem {
226
272
  * @readonly
227
273
  */
228
274
  depositAmount?: Price;
275
+ /**
276
+ * Line item locations.
277
+ *
278
+ * The location's total quantity must not exceed the line item quantity.
279
+ * @maxSize 5
280
+ */
281
+ locations?: LocationAndQuantity[];
229
282
  /**
230
283
  * Custom extended fields for the line item object.
231
284
  *
@@ -239,6 +292,8 @@ export interface ProductName {
239
292
  *
240
293
  * Min: 1 character.
241
294
  * Max: 200 characters.
295
+ * @minLength 1
296
+ * @maxLength 200
242
297
  */
243
298
  original?: string;
244
299
  /**
@@ -247,12 +302,18 @@ export interface ProductName {
247
302
  * Min: 1 character.
248
303
  * Max: 400 characters.
249
304
  * Default: Same as `original`.
305
+ * @minLength 1
306
+ * @maxLength 400
250
307
  */
251
308
  translated?: string | null;
252
309
  }
253
310
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
254
311
  export interface CatalogReference {
255
- /** ID of the item within the catalog it belongs to. */
312
+ /**
313
+ * ID of the item within the catalog it belongs to.
314
+ * @minLength 1
315
+ * @maxLength 36
316
+ */
256
317
  catalogItemId?: string;
257
318
  /**
258
319
  * ID of the app providing the catalog.
@@ -263,6 +324,7 @@ export interface CatalogReference {
263
324
  * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
264
325
  * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
265
326
  * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
327
+ * @minLength 1
266
328
  */
267
329
  appId?: string;
268
330
  /**
@@ -291,32 +353,44 @@ export interface DescriptionLineValueOneOf {
291
353
  export interface DescriptionLineDescriptionLineValueOneOf {
292
354
  }
293
355
  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). */
356
+ /**
357
+ * 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).
358
+ * @maxLength 100
359
+ */
295
360
  original?: string;
296
361
  /**
297
362
  * Description line name translated into the buyer's language.
298
363
  *
299
364
  * Default: Same as `original`.
365
+ * @maxLength 200
300
366
  */
301
367
  translated?: string | null;
302
368
  }
303
369
  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). */
370
+ /**
371
+ * 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).
372
+ * @maxLength 600
373
+ */
305
374
  original?: string;
306
375
  /**
307
376
  * Description line plain text value translated into the buyer's language.
308
377
  *
309
378
  * Default: Same as `original`.
379
+ * @maxLength 600
310
380
  */
311
381
  translated?: string | null;
312
382
  }
313
383
  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). */
384
+ /**
385
+ * 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).
386
+ * @maxLength 500
387
+ */
315
388
  original?: string;
316
389
  /**
317
390
  * Description line color name translated into the buyer's language.
318
391
  *
319
392
  * Default: Same as `original`.
393
+ * @maxLength 500
320
394
  */
321
395
  translated?: string | null;
322
396
  /** HEX or RGB color code for display. */
@@ -343,7 +417,10 @@ export interface FocalPoint {
343
417
  export interface PhysicalProperties {
344
418
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
345
419
  weight?: number | null;
346
- /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
420
+ /**
421
+ * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
422
+ * @maxLength 40
423
+ */
347
424
  sku?: string | null;
348
425
  /** Whether this line item is shippable. */
349
426
  shippable?: boolean;
@@ -384,7 +461,10 @@ export declare enum PaymentOptionType {
384
461
  export interface ItemTaxFullDetails {
385
462
  /** Taxable amount of this line item. */
386
463
  taxableAmount?: Price;
387
- /** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`. */
464
+ /**
465
+ * Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
466
+ * @decimalValue options { gte:0, maxScale:6 }
467
+ */
388
468
  taxRate?: string;
389
469
  /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
390
470
  totalTax?: Price;
@@ -394,16 +474,24 @@ export interface LineItemTaxInfo {
394
474
  taxAmount?: Price;
395
475
  /** Amount for which tax is calculated. */
396
476
  taxableAmount?: Price;
397
- /** Tax rate %, as a decimal point. */
477
+ /**
478
+ * Tax rate %, as a decimal point.
479
+ * @format DECIMAL_VALUE
480
+ * @decimalValue options { gte:0, maxScale:6 }
481
+ */
398
482
  taxRate?: string | null;
399
483
  /**
400
484
  * Tax group ID.
401
485
  * Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
486
+ * @format GUID
402
487
  */
403
488
  taxGroupId?: string | null;
404
489
  /** Indicates whether the price already includes tax. */
405
490
  taxIncludedInPrice?: boolean;
406
- /** Tax information for a line item. */
491
+ /**
492
+ * Tax information for a line item.
493
+ * @maxSize 7
494
+ */
407
495
  taxBreakdown?: LineItemTaxBreakdown[];
408
496
  }
409
497
  /**
@@ -411,17 +499,28 @@ export interface LineItemTaxInfo {
411
499
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
412
500
  */
413
501
  export interface LineItemTaxBreakdown {
414
- /** Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". */
502
+ /**
503
+ * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
504
+ * @maxLength 200
505
+ */
415
506
  jurisdiction?: string | null;
416
- /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. */
507
+ /**
508
+ * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
509
+ * @format DECIMAL_VALUE
510
+ * @decimalValue options { gte:0, maxScale:6 }
511
+ */
417
512
  rate?: string | null;
418
513
  /** Amount of tax calculated for this line item. */
419
514
  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. */
515
+ /**
516
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
517
+ * @maxLength 200
518
+ */
421
519
  taxType?: string | null;
422
520
  /**
423
521
  * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
424
522
  * This name should be explicit enough to allow the merchant to understand what tax was calculated.
523
+ * @maxLength 200
425
524
  */
426
525
  taxName?: string | null;
427
526
  /** Type of jurisdiction that taxes were calculated for. */
@@ -441,9 +540,18 @@ export declare enum JurisdictionType {
441
540
  SPECIAL = "SPECIAL"
442
541
  }
443
542
  export interface DigitalFile {
444
- /** ID of the secure file in media. */
543
+ /**
544
+ * ID of the secure file in media.
545
+ * @minLength 1
546
+ * @maxLength 100
547
+ */
445
548
  fileId?: string;
446
- /** Link will exist after the digital links have been generated on the order. */
549
+ /**
550
+ * Link will exist after the digital links have been generated on the order.
551
+ * @format WEB_URL
552
+ * @minLength 1
553
+ * @maxLength 2000
554
+ */
447
555
  link?: string | null;
448
556
  /**
449
557
  * Link expiration time and date.
@@ -452,25 +560,48 @@ export interface DigitalFile {
452
560
  expirationDate?: Date | null;
453
561
  }
454
562
  export interface SubscriptionInfo {
455
- /** Subscription ID. */
563
+ /**
564
+ * Subscription ID.
565
+ * @format GUID
566
+ */
456
567
  _id?: string | null;
457
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
568
+ /**
569
+ * Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
570
+ * @min 1
571
+ */
458
572
  cycleNumber?: number;
459
- /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
573
+ /**
574
+ * Subscription option title. For example, `"Monthly coffee Subscription"`.
575
+ * @minLength 1
576
+ * @maxLength 20
577
+ */
460
578
  subscriptionOptionTitle?: string;
461
- /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
579
+ /**
580
+ * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
581
+ * @maxLength 60
582
+ */
462
583
  subscriptionOptionDescription?: string | null;
463
- /** Subscription detailed information. */
584
+ /**
585
+ * Subscription detailed information.
586
+ * @immutable
587
+ */
464
588
  subscriptionSettings?: SubscriptionSettings;
465
589
  }
466
590
  export interface SubscriptionSettings {
467
591
  /** Frequency of recurring payment. */
468
592
  frequency?: SubscriptionFrequency;
469
- /** Interval of recurring payment. */
593
+ /**
594
+ * Interval of recurring payment.
595
+ * @min 1
596
+ * @max 50
597
+ */
470
598
  interval?: number | null;
471
599
  /** Whether subscription is renewed automatically at the end of each period. */
472
600
  autoRenewal?: boolean;
473
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
601
+ /**
602
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
603
+ * @min 1
604
+ */
474
605
  billingCycles?: number | null;
475
606
  }
476
607
  /** Frequency unit of recurring payment */
@@ -484,20 +615,38 @@ export declare enum SubscriptionFrequency {
484
615
  export interface FreeTrialPeriod {
485
616
  /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
486
617
  frequency?: SubscriptionFrequency;
487
- /** interval of period */
618
+ /**
619
+ * interval of period
620
+ * @min 1
621
+ * @max 50
622
+ */
488
623
  interval?: number;
489
624
  }
490
625
  export interface LocationAndQuantity {
491
- /** Location id in the associated owner app. */
626
+ /**
627
+ * Location id in the associated owner app.
628
+ * @format GUID
629
+ */
492
630
  _id?: string;
493
631
  /**
494
632
  * Location owner app, if not provided then the site business info locations will be used.
633
+ * @format GUID
495
634
  * @deprecated Location owner app, if not provided then the site business info locations will be used.
496
635
  * @targetRemovalDate 2025-03-01
497
636
  */
498
637
  appId?: string | null;
499
- /** Quantity for specific location. */
638
+ /**
639
+ * Quantity for specific location.
640
+ * @min 1
641
+ * @max 100000
642
+ */
500
643
  quantity?: number;
644
+ /**
645
+ * Location name.
646
+ * @maxLength 500
647
+ * @readonly
648
+ */
649
+ name?: string | null;
501
650
  }
502
651
  export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
503
652
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
@@ -526,7 +675,11 @@ export interface ExtendedFields {
526
675
  namespaces?: Record<string, Record<string, any>>;
527
676
  }
528
677
  export interface ItemChangedDetails {
529
- /** Line item quantity before change. */
678
+ /**
679
+ * Line item quantity before change.
680
+ * @min 1
681
+ * @max 1000000
682
+ */
530
683
  quantityBeforeChange?: number | null;
531
684
  /** Line item price before change. */
532
685
  priceBeforeChange?: Price;
@@ -553,13 +706,22 @@ export interface ShippingDetailsChangeTypeOneOf {
553
706
  removed?: boolean;
554
707
  }
555
708
  export interface V1ShippingInformation {
556
- /** App Def Id of external provider which was a source of shipping info */
709
+ /**
710
+ * App Def Id of external provider which was a source of shipping info
711
+ * @minLength 1
712
+ * @maxLength 100
713
+ */
557
714
  carrierId?: string | null;
558
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
715
+ /**
716
+ * Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
717
+ * @minLength 1
718
+ * @maxLength 100
719
+ */
559
720
  code?: string | null;
560
721
  /**
561
722
  * Shipping option title.
562
723
  * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
724
+ * @maxLength 250
563
725
  */
564
726
  title?: string;
565
727
  /** Shipping logistics. */
@@ -574,9 +736,15 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
574
736
  shippingDestination?: AddressWithContact;
575
737
  /** Pickup details. */
576
738
  pickupDetails?: V1PickupDetails;
577
- /** Expected delivery time in free text. For example, `"3-5 business days"`. */
739
+ /**
740
+ * Expected delivery time in free text. For example, `"3-5 business days"`.
741
+ * @maxLength 500
742
+ */
578
743
  deliveryTime?: string | null;
579
- /** Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. */
744
+ /**
745
+ * Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
746
+ * @maxLength 1000
747
+ */
580
748
  instructions?: string | null;
581
749
  /**
582
750
  * 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 +770,37 @@ export interface AddressWithContact {
602
770
  }
603
771
  /** Physical address */
604
772
  export interface Address {
605
- /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
773
+ /**
774
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
775
+ * @format COUNTRY
776
+ */
606
777
  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. */
778
+ /**
779
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
780
+ * @maxLength 50
781
+ */
608
782
  subdivision?: string | null;
609
- /** City name. */
783
+ /**
784
+ * City name.
785
+ * @maxLength 50
786
+ */
610
787
  city?: string | null;
611
- /** Postal or zip code. */
788
+ /**
789
+ * Postal or zip code.
790
+ * @maxLength 50
791
+ */
612
792
  postalCode?: string | null;
613
793
  /** Street address. */
614
794
  streetAddress?: StreetAddress;
615
- /** Main address line (usually street name and number). */
795
+ /**
796
+ * Main address line (usually street name and number).
797
+ * @maxLength 150
798
+ */
616
799
  addressLine1?: string | null;
617
- /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
800
+ /**
801
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
802
+ * @maxLength 100
803
+ */
618
804
  addressLine2?: string | null;
619
805
  /**
620
806
  * Country's full name.
@@ -641,13 +827,25 @@ export interface AddressLocation {
641
827
  }
642
828
  /** Full contact details for an address */
643
829
  export interface FullAddressContactDetails {
644
- /** First name. */
830
+ /**
831
+ * First name.
832
+ * @maxLength 100
833
+ */
645
834
  firstName?: string | null;
646
- /** Last name. */
835
+ /**
836
+ * Last name.
837
+ * @maxLength 100
838
+ */
647
839
  lastName?: string | null;
648
- /** Phone number. */
840
+ /**
841
+ * Phone number.
842
+ * @format PHONE
843
+ */
649
844
  phone?: string | null;
650
- /** Company name. */
845
+ /**
846
+ * Company name.
847
+ * @maxLength 1000
848
+ */
651
849
  company?: string | null;
652
850
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
653
851
  vatId?: VatId;
@@ -680,19 +878,37 @@ export interface V1PickupDetails {
680
878
  }
681
879
  /** Physical address */
682
880
  export interface PickupAddress {
683
- /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
881
+ /**
882
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
883
+ * @format COUNTRY
884
+ */
684
885
  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. */
886
+ /**
887
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
888
+ * @maxLength 50
889
+ */
686
890
  subdivision?: string | null;
687
- /** City name. */
891
+ /**
892
+ * City name.
893
+ * @maxLength 1000
894
+ */
688
895
  city?: string | null;
689
- /** Postal or zip code. */
896
+ /**
897
+ * Postal or zip code.
898
+ * @maxLength 1000
899
+ */
690
900
  postalCode?: string | null;
691
901
  /** Street address object, with number, name, and apartment number in separate fields. */
692
902
  streetAddress?: StreetAddress;
693
- /** Main address line (usually street name and number). */
903
+ /**
904
+ * Main address line (usually street name and number).
905
+ * @maxLength 1000
906
+ */
694
907
  addressLine1?: string | null;
695
- /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
908
+ /**
909
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
910
+ * @maxLength 1000
911
+ */
696
912
  addressLine2?: string | null;
697
913
  /**
698
914
  * Country's full name.
@@ -738,7 +954,10 @@ export interface V1ShippingPrice {
738
954
  discount?: Price;
739
955
  }
740
956
  export interface ShippingRegion {
741
- /** Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. */
957
+ /**
958
+ * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
959
+ * @maxLength 100
960
+ */
742
961
  name?: string | null;
743
962
  }
744
963
  export interface ShippingChangedDetails {
@@ -747,20 +966,38 @@ export interface ShippingChangedDetails {
747
966
  }
748
967
  /** Buyer Info */
749
968
  export interface BuyerInfo extends BuyerInfoIdOneOf {
750
- /** Visitor ID (if site visitor is not a member). */
969
+ /**
970
+ * Visitor ID (if site visitor is not a member).
971
+ * @format GUID
972
+ */
751
973
  visitorId?: string;
752
- /** Member ID (if site visitor is a site member). */
974
+ /**
975
+ * Member ID (if site visitor is a site member).
976
+ * @format GUID
977
+ */
753
978
  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). */
979
+ /**
980
+ * 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).
981
+ * @format GUID
982
+ */
755
983
  contactId?: string | null;
756
- /** Buyer email address. */
984
+ /**
985
+ * Buyer email address.
986
+ * @format EMAIL
987
+ */
757
988
  email?: string | null;
758
989
  }
759
990
  /** @oneof */
760
991
  export interface BuyerInfoIdOneOf {
761
- /** Visitor ID (if site visitor is not a member). */
992
+ /**
993
+ * Visitor ID (if site visitor is not a member).
994
+ * @format GUID
995
+ */
762
996
  visitorId?: string;
763
- /** Member ID (if site visitor is a site member). */
997
+ /**
998
+ * Member ID (if site visitor is a site member).
999
+ * @format GUID
1000
+ */
764
1001
  memberId?: string;
765
1002
  }
766
1003
  export interface AdditionalFeeDetails {
@@ -780,32 +1017,51 @@ export interface AdditionalFeeDetails {
780
1017
  applied?: boolean;
781
1018
  }
782
1019
  export interface AdditionalFee {
783
- /** Additional fee's unique code for future processing. */
1020
+ /**
1021
+ * Additional fee's unique code for future processing.
1022
+ * @minLength 1
1023
+ * @maxLength 100
1024
+ */
784
1025
  code?: string | null;
785
- /** Name of additional fee. */
1026
+ /**
1027
+ * Name of additional fee.
1028
+ * @minLength 1
1029
+ * @maxLength 50
1030
+ */
786
1031
  name?: string;
787
1032
  /** Additional fee's price. */
788
1033
  price?: Price;
789
1034
  /** Tax details. */
790
1035
  taxDetails?: ItemTaxFullDetails;
791
- /** SPI implementer's `appId`. */
1036
+ /**
1037
+ * SPI implementer's `appId`.
1038
+ * @format GUID
1039
+ */
792
1040
  providerAppId?: string | null;
793
1041
  /** Additional fee's price before tax. */
794
1042
  priceBeforeTax?: Price;
795
1043
  /** Additional fee's price after tax. */
796
1044
  priceAfterTax?: Price;
797
- /** Additional fee's id. */
1045
+ /**
1046
+ * Additional fee's id.
1047
+ * @format GUID
1048
+ * @immutable
1049
+ */
798
1050
  _id?: string;
799
1051
  /**
800
1052
  * Optional - Line items associated with this additional fee.
801
1053
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1054
+ * @format GUID
802
1055
  */
803
1056
  lineItemIds?: string[];
804
1057
  }
805
1058
  export interface TaxDetails {
806
1059
  /** Indication if additional fee is taxable or not */
807
1060
  taxable?: boolean;
808
- /** Optional tax group ID to use when calculating tax for this additional fee */
1061
+ /**
1062
+ * Optional tax group ID to use when calculating tax for this additional fee
1063
+ * @format GUID
1064
+ */
809
1065
  taxGroupId?: string | null;
810
1066
  }
811
1067
  export declare enum SourceType {
@@ -847,13 +1103,19 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
847
1103
  /**
848
1104
  * IDs of line items discount applies to.
849
1105
  * Deprecated. Use `line_item_discounts` instead.
1106
+ * @format GUID
1107
+ * @maxSize 1
850
1108
  * @deprecated IDs of line items discount applies to.
851
1109
  * Deprecated. Use `line_item_discounts` instead.
852
1110
  * @replacedBy line_item_discounts
853
1111
  * @targetRemovalDate 2024-10-30
854
1112
  */
855
1113
  lineItemIds?: string[];
856
- /** Discount id. */
1114
+ /**
1115
+ * Discount id.
1116
+ * @format GUID
1117
+ * @immutable
1118
+ */
857
1119
  _id?: string | null;
858
1120
  }
859
1121
  /** @oneof */
@@ -887,7 +1149,10 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
887
1149
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
888
1150
  */
889
1151
  discountReason?: DiscountReason;
890
- /** Discount description as free text (optional). */
1152
+ /**
1153
+ * Discount description as free text (optional).
1154
+ * @maxLength 200
1155
+ */
891
1156
  description?: string | null;
892
1157
  /** Discount amount. */
893
1158
  amount?: Price;
@@ -899,7 +1164,10 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
899
1164
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
900
1165
  */
901
1166
  discountReason?: DiscountReason;
902
- /** Discount description as free text (optional). */
1167
+ /**
1168
+ * Discount description as free text (optional).
1169
+ * @maxLength 200
1170
+ */
903
1171
  description?: string | null;
904
1172
  }
905
1173
  export declare enum DiscountReason {
@@ -907,7 +1175,10 @@ export declare enum DiscountReason {
907
1175
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
908
1176
  }
909
1177
  export interface DiscountRule {
910
- /** Discount rule ID */
1178
+ /**
1179
+ * Discount rule ID
1180
+ * @format GUID
1181
+ */
911
1182
  _id?: string;
912
1183
  /** Discount rule name */
913
1184
  name?: DiscountRuleName;
@@ -915,28 +1186,51 @@ export interface DiscountRule {
915
1186
  amount?: Price;
916
1187
  }
917
1188
  export interface DiscountRuleName {
918
- /** Original discount rule name (in site's default language). */
1189
+ /**
1190
+ * Original discount rule name (in site's default language).
1191
+ * @minLength 1
1192
+ * @maxLength 256
1193
+ */
919
1194
  original?: string;
920
- /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
1195
+ /**
1196
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1197
+ * @minLength 1
1198
+ * @maxLength 500
1199
+ */
921
1200
  translated?: string | null;
922
1201
  }
923
1202
  export interface LineItemDiscount {
924
- /** ID of line item the discount applies to. */
1203
+ /**
1204
+ * ID of line item the discount applies to.
1205
+ * @format GUID
1206
+ */
925
1207
  _id?: string;
926
1208
  /** Total discount for this line item. */
927
1209
  totalDiscount?: Price;
928
1210
  }
929
1211
  export interface CreatedBy extends CreatedByStringOneOf {
930
- /** 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
+ */
931
1216
  userId?: string;
932
- /** 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
+ */
933
1221
  appId?: string;
934
1222
  }
935
1223
  /** @oneof */
936
1224
  export interface CreatedByStringOneOf {
937
- /** User ID. When the draft order was created by a Wix user. */
1225
+ /**
1226
+ * User ID. When the draft order was created by a Wix user.
1227
+ * @format GUID
1228
+ */
938
1229
  userId?: string;
939
- /** App ID. When the draft order was created by an app. */
1230
+ /**
1231
+ * App ID. When the draft order was created by an app.
1232
+ * @format GUID
1233
+ */
940
1234
  appId?: string;
941
1235
  }
942
1236
  export declare enum EditingStatus {
@@ -998,6 +1292,7 @@ export interface Balance {
998
1292
  * Balance amount.
999
1293
  *
1000
1294
  * 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.
1295
+ * @decimalValue options { }
1001
1296
  * @readonly
1002
1297
  */
1003
1298
  amount?: string;
@@ -1036,11 +1331,15 @@ export interface DraftOrderCommitSettings {
1036
1331
  /**
1037
1332
  * Line item IDs for which to perform an inventory change.
1038
1333
  * When not provided, inventory will not change.
1334
+ * @maxSize 300
1039
1335
  */
1040
1336
  updateInventory?: InventoryUpdate[];
1041
1337
  }
1042
1338
  export interface InventoryUpdate {
1043
- /** Line item ID. */
1339
+ /**
1340
+ * Line item ID.
1341
+ * @format GUID
1342
+ */
1044
1343
  lineItemId?: string;
1045
1344
  }
1046
1345
  export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
@@ -1069,7 +1368,10 @@ export interface RecipientInfoChangedDetails {
1069
1368
  export interface OrderTaxInfo {
1070
1369
  /** Calculated tax, added from line items. */
1071
1370
  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. */
1371
+ /**
1372
+ * 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.
1373
+ * @maxSize 50
1374
+ */
1073
1375
  taxBreakdown?: OrderTaxBreakdown[];
1074
1376
  /**
1075
1377
  * Whether the order is exempt from tax calculations.
@@ -1084,15 +1386,28 @@ export interface OrderTaxInfo {
1084
1386
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1085
1387
  */
1086
1388
  export interface OrderTaxBreakdown {
1087
- /** The name of the tax against which this tax amount was calculated. */
1389
+ /**
1390
+ * The name of the tax against which this tax amount was calculated.
1391
+ * @maxLength 200
1392
+ */
1088
1393
  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. */
1394
+ /**
1395
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
1396
+ * @maxLength 200
1397
+ */
1090
1398
  taxType?: string;
1091
- /** The name of the jurisdiction in which this tax detail applies. */
1399
+ /**
1400
+ * The name of the jurisdiction in which this tax detail applies.
1401
+ * @maxLength 200
1402
+ */
1092
1403
  jurisdiction?: string;
1093
1404
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1094
1405
  jurisdictionType?: JurisdictionType;
1095
- /** The rate at which this tax detail was calculated. */
1406
+ /**
1407
+ * The rate at which this tax detail was calculated.
1408
+ * @format DECIMAL_VALUE
1409
+ * @decimalValue options { gte:0, maxScale:6 }
1410
+ */
1096
1411
  rate?: string;
1097
1412
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1098
1413
  aggregatedTaxAmount?: Price;
@@ -1112,26 +1427,48 @@ export interface BillingDetailsChangeTypeOneOf {
1112
1427
  export interface BillingChangedDetails {
1113
1428
  }
1114
1429
  export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
1430
+ /** Indicates that business location was added during draft. */
1431
+ added?: boolean;
1432
+ /** Indicates that business location was changed. Contains business location before draft. */
1433
+ changedDetails?: BusinessLocationChangedDetails;
1434
+ /** Indicates that business location was removed during draft. */
1435
+ removed?: boolean;
1436
+ /** Business location. */
1437
+ businessLocation?: Location;
1115
1438
  }
1116
1439
  /** @oneof */
1117
1440
  export interface BusinessLocationDetailsChangeTypeOneOf {
1441
+ /** Indicates that business location was added during draft. */
1442
+ added?: boolean;
1443
+ /** Indicates that business location was changed. Contains business location before draft. */
1444
+ changedDetails?: BusinessLocationChangedDetails;
1445
+ /** Indicates that business location was removed during draft. */
1446
+ removed?: boolean;
1118
1447
  }
1119
1448
  export interface Location {
1120
1449
  /**
1121
1450
  * Location ID.
1122
1451
  * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
1452
+ * @format GUID
1123
1453
  */
1124
1454
  _id?: string;
1125
1455
  /**
1126
1456
  * Location name.
1457
+ * @minLength 1
1458
+ * @maxLength 500
1127
1459
  * @readonly
1128
1460
  */
1129
1461
  name?: string;
1130
1462
  }
1131
1463
  export interface BusinessLocationChangedDetails {
1464
+ /** Business location before draft. */
1465
+ businessLocationBeforeChange?: Location;
1132
1466
  }
1133
1467
  export interface CreateDraftOrderRequest {
1134
- /** To create a draft from existing order, provide its id. Otherwise, an empty draft will be created. */
1468
+ /**
1469
+ * To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
1470
+ * @format GUID
1471
+ */
1135
1472
  orderId: string | null;
1136
1473
  }
1137
1474
  export interface CreateDraftOrderResponse {
@@ -1150,7 +1487,10 @@ export interface CalculatedDraftOrder {
1150
1487
  calculationErrors?: CalculationErrors;
1151
1488
  }
1152
1489
  export interface ShippingOption {
1153
- /** This carrier's unique ID */
1490
+ /**
1491
+ * This carrier's unique ID
1492
+ * @format GUID
1493
+ */
1154
1494
  carrierId?: string | null;
1155
1495
  /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
1156
1496
  code?: string;
@@ -1197,7 +1537,10 @@ export interface DeliveryTimeSlot {
1197
1537
  export interface ShippingPrice {
1198
1538
  /** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
1199
1539
  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. */
1540
+ /**
1541
+ * 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.
1542
+ * @format CURRENCY
1543
+ */
1201
1544
  currency?: string;
1202
1545
  }
1203
1546
  export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
@@ -1328,29 +1671,54 @@ export interface CreateEmptyDraftOrderResponse {
1328
1671
  calculatedDraftOrder?: CalculatedDraftOrder;
1329
1672
  }
1330
1673
  export interface AddLineItemsToDraftOrderRequest {
1331
- /** The draft order id */
1674
+ /**
1675
+ * The draft order id
1676
+ * @format GUID
1677
+ */
1332
1678
  draftOrderId: string;
1333
- /** Catalog line items to add to draft order. */
1679
+ /**
1680
+ * Catalog line items to add to draft order.
1681
+ * @maxSize 300
1682
+ */
1334
1683
  catalogLineItems?: CatalogReferenceLineItem[];
1335
- /** Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin. */
1684
+ /**
1685
+ * Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
1686
+ * @maxSize 300
1687
+ */
1336
1688
  customLineItems?: CustomLineItem[];
1337
1689
  }
1338
1690
  export interface CatalogReferenceLineItem {
1339
1691
  /** 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
1692
  catalogReference?: CatalogReference;
1341
- /** Item quantity. */
1693
+ /**
1694
+ * Item quantity.
1695
+ * @min 1
1696
+ * @max 100000
1697
+ */
1342
1698
  quantity?: number;
1343
1699
  /** Item price override. */
1344
1700
  price?: Price;
1701
+ /**
1702
+ * Line item locations.
1703
+ *
1704
+ * The location's total quantity must not exceed the line item quantity.
1705
+ * @maxSize 5
1706
+ */
1707
+ locations?: LocationAndQuantity[];
1345
1708
  }
1346
1709
  export interface CustomLineItem {
1347
- /** Line item ID. */
1710
+ /**
1711
+ * Line item ID.
1712
+ * @format GUID
1713
+ */
1348
1714
  _id?: string | null;
1349
1715
  /**
1350
1716
  * Item quantity.
1351
1717
  *
1352
1718
  * Min: `"1"`
1353
1719
  * Max: `"100000"`
1720
+ * @min 1
1721
+ * @max 100000
1354
1722
  */
1355
1723
  quantity?: number;
1356
1724
  /** 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 +1750,31 @@ export interface CustomLineItem {
1382
1750
  itemType?: ItemType;
1383
1751
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1384
1752
  priceDescription?: PriceDescription;
1385
- /** Delivery Profile Id for the product */
1753
+ /**
1754
+ * Delivery Profile Id for the product
1755
+ * @format GUID
1756
+ */
1386
1757
  deliveryProfileId?: string | null;
1758
+ /**
1759
+ * Line item locations.
1760
+ *
1761
+ * The location's total quantity must not exceed the line item quantity.
1762
+ * @maxSize 5
1763
+ */
1764
+ locations?: LocationAndQuantity[];
1387
1765
  }
1388
1766
  export interface SecuredMedia {
1389
- /** Media ID in Wix Media Manager. */
1767
+ /**
1768
+ * Media ID in Wix Media Manager.
1769
+ * @minLength 1
1770
+ * @maxLength 100
1771
+ */
1390
1772
  _id?: string;
1391
- /** Original filename. */
1773
+ /**
1774
+ * Original filename.
1775
+ * @minLength 1
1776
+ * @maxLength 1000
1777
+ */
1392
1778
  fileName?: string;
1393
1779
  /** File type. */
1394
1780
  fileType?: FileType;
@@ -1406,17 +1792,33 @@ export interface AddLineItemsToDraftOrderResponse {
1406
1792
  calculatedDraftOrder?: CalculatedDraftOrder;
1407
1793
  }
1408
1794
  export interface UpdateLineItemsRequest {
1409
- /** The draft order id */
1795
+ /**
1796
+ * The draft order id
1797
+ * @format GUID
1798
+ */
1410
1799
  draftOrderId: string;
1411
- /** Details of changes to apply per line item */
1800
+ /**
1801
+ * Details of changes to apply per line item
1802
+ * @minSize 1
1803
+ * @maxSize 300
1804
+ */
1412
1805
  lineItemChanges?: LineItemChangeDetails[];
1413
1806
  }
1414
1807
  export interface LineItemChangeDetails {
1415
- /** The line item id to change */
1808
+ /**
1809
+ * The line item id to change
1810
+ * @format GUID
1811
+ */
1416
1812
  lineItemId?: string;
1417
- /** The new quantity for the line item. quantity zero means to remove the line item. */
1813
+ /**
1814
+ * The new quantity for the line item. quantity zero means to remove the line item.
1815
+ * @max 1000000
1816
+ */
1418
1817
  newQuantity?: number | null;
1419
- /** The new price for 1 unit of the line item */
1818
+ /**
1819
+ * The new price for 1 unit of the line item
1820
+ * @decimalValue options { gte:0, lte:1000000000000000 }
1821
+ */
1420
1822
  newPrice?: string | null;
1421
1823
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1422
1824
  newPriceDescription?: PriceDescription;
@@ -1426,9 +1828,15 @@ export interface UpdateLineItemsResponse {
1426
1828
  calculatedDraftOrder?: CalculatedDraftOrder;
1427
1829
  }
1428
1830
  export interface SetDiscountsRequest {
1429
- /** The draft order id */
1831
+ /**
1832
+ * The draft order id
1833
+ * @format GUID
1834
+ */
1430
1835
  draftOrderId: string;
1431
- /** The discount ids to opt-in. all existing discounts not listed are to be opted-out. */
1836
+ /**
1837
+ * The discount ids to opt-in. all existing discounts not listed are to be opted-out.
1838
+ * @minSize 1
1839
+ */
1432
1840
  discounts: IdAndApplied[];
1433
1841
  }
1434
1842
  export interface IdAndApplied {
@@ -1442,9 +1850,16 @@ export interface SetDiscountsResponse {
1442
1850
  calculatedDraftOrder?: CalculatedDraftOrder;
1443
1851
  }
1444
1852
  export interface CreateCustomDiscountsRequest {
1445
- /** The draft order id */
1853
+ /**
1854
+ * The draft order id
1855
+ * @format GUID
1856
+ */
1446
1857
  draftOrderId: string;
1447
- /** The discounts to add. */
1858
+ /**
1859
+ * The discounts to add.
1860
+ * @minSize 1
1861
+ * @maxSize 100
1862
+ */
1448
1863
  discounts?: DiscountOption[];
1449
1864
  }
1450
1865
  export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
@@ -1457,6 +1872,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
1457
1872
  discountType?: DiscountType;
1458
1873
  /**
1459
1874
  * ID of line item discount applies to.
1875
+ * @format GUID
1460
1876
  * @deprecated ID of line item discount applies to.
1461
1877
  * @replacedBy line_item_discounts
1462
1878
  * @targetRemovalDate 2024-10-30
@@ -1469,7 +1885,10 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
1469
1885
  * @targetRemovalDate 2024-08-30
1470
1886
  */
1471
1887
  amount?: Price;
1472
- /** Discount description as free text (optional). */
1888
+ /**
1889
+ * Discount description as free text (optional).
1890
+ * @maxLength 200
1891
+ */
1473
1892
  description?: string | null;
1474
1893
  /**
1475
1894
  * Should opt-in the added discount. default = false.
@@ -1491,9 +1910,17 @@ export interface CreateCustomDiscountsResponse {
1491
1910
  calculatedDraftOrder?: CalculatedDraftOrder;
1492
1911
  }
1493
1912
  export interface DeleteCustomDiscountsRequest {
1494
- /** The draft order id */
1913
+ /**
1914
+ * The draft order id
1915
+ * @format GUID
1916
+ */
1495
1917
  draftOrderId: string;
1496
- /** The discounts to remove */
1918
+ /**
1919
+ * The discounts to remove
1920
+ * @format GUID
1921
+ * @minSize 1
1922
+ * @maxSize 100
1923
+ */
1497
1924
  discountIds: string[];
1498
1925
  }
1499
1926
  export interface DeleteCustomDiscountsResponse {
@@ -1501,9 +1928,16 @@ export interface DeleteCustomDiscountsResponse {
1501
1928
  calculatedDraftOrder?: CalculatedDraftOrder;
1502
1929
  }
1503
1930
  export interface SetAdditionalFeesRequest {
1504
- /** The draft order id */
1931
+ /**
1932
+ * The draft order id
1933
+ * @format GUID
1934
+ */
1505
1935
  draftOrderId: string;
1506
- /** The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out */
1936
+ /**
1937
+ * The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
1938
+ * @minSize 1
1939
+ * @maxSize 100
1940
+ */
1507
1941
  additionalFees: IdAndApplied[];
1508
1942
  }
1509
1943
  export interface SetAdditionalFeesResponse {
@@ -1511,13 +1945,24 @@ export interface SetAdditionalFeesResponse {
1511
1945
  calculatedDraftOrder?: CalculatedDraftOrder;
1512
1946
  }
1513
1947
  export interface CreateCustomAdditionalFeesRequest {
1514
- /** The draft order id */
1948
+ /**
1949
+ * The draft order id
1950
+ * @format GUID
1951
+ */
1515
1952
  draftOrderId: string;
1516
- /** The additional fees to add. added with opted-out setting */
1953
+ /**
1954
+ * The additional fees to add. added with opted-out setting
1955
+ * @minSize 1
1956
+ * @maxSize 100
1957
+ */
1517
1958
  customAdditionalFees?: AdditionalFeeOption[];
1518
1959
  }
1519
1960
  export interface AdditionalFeeOption {
1520
- /** Translated additional fee's name */
1961
+ /**
1962
+ * Translated additional fee's name
1963
+ * @minLength 1
1964
+ * @maxLength 50
1965
+ */
1521
1966
  name?: string;
1522
1967
  /** Additional fee's price */
1523
1968
  price?: Price;
@@ -1528,7 +1973,11 @@ export interface AdditionalFeeOption {
1528
1973
  * if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee ids
1529
1974
  */
1530
1975
  applyToDraftOrder?: boolean | null;
1531
- /** Additional fee's unique code (or ID) for future processing */
1976
+ /**
1977
+ * Additional fee's unique code (or ID) for future processing
1978
+ * @minLength 1
1979
+ * @maxLength 100
1980
+ */
1532
1981
  code?: string | null;
1533
1982
  }
1534
1983
  export interface CreateCustomAdditionalFeesResponse {
@@ -1536,9 +1985,17 @@ export interface CreateCustomAdditionalFeesResponse {
1536
1985
  calculatedDraftOrder?: CalculatedDraftOrder;
1537
1986
  }
1538
1987
  export interface DeleteCustomAdditionalFeesRequest {
1539
- /** The draft order id */
1988
+ /**
1989
+ * The draft order id
1990
+ * @format GUID
1991
+ */
1540
1992
  draftOrderId: string;
1541
- /** The additional fees to remove */
1993
+ /**
1994
+ * The additional fees to remove
1995
+ * @format GUID
1996
+ * @minSize 1
1997
+ * @maxSize 100
1998
+ */
1542
1999
  customAdditionalFees: string[];
1543
2000
  }
1544
2001
  export interface DeleteCustomAdditionalFeesResponse {
@@ -1562,7 +2019,10 @@ export interface SetBillingInfoRequest {
1562
2019
  export interface SetBillingInfoResponse {
1563
2020
  }
1564
2021
  export interface UpdateShippingInfoRequest {
1565
- /** The draft order id */
2022
+ /**
2023
+ * The draft order id
2024
+ * @format GUID
2025
+ */
1566
2026
  draftOrderId?: string;
1567
2027
  /** update the shipping option on the order. if not set then the selected shipping is removed */
1568
2028
  shippingOption?: ShippingOption;
@@ -1572,7 +2032,10 @@ export interface UpdateShippingInfoResponse {
1572
2032
  calculatedDraftOrder?: CalculatedDraftOrder;
1573
2033
  }
1574
2034
  export interface GetDraftOrderRequest {
1575
- /** The draft order id */
2035
+ /**
2036
+ * The draft order id
2037
+ * @format GUID
2038
+ */
1576
2039
  draftOrderId: string;
1577
2040
  }
1578
2041
  export interface GetDraftOrderResponse {
@@ -1580,15 +2043,26 @@ export interface GetDraftOrderResponse {
1580
2043
  calculatedDraftOrder?: CalculatedDraftOrder;
1581
2044
  }
1582
2045
  export interface GetOrderDraftabilityStatusRequest {
1583
- /** Order ID. */
2046
+ /**
2047
+ * Order ID.
2048
+ * @minLength 1
2049
+ * @maxLength 100
2050
+ */
1584
2051
  orderId: string;
1585
2052
  }
1586
2053
  export interface GetOrderDraftabilityStatusResponse {
1587
- /** Order ID. */
2054
+ /**
2055
+ * Order ID.
2056
+ * @minLength 1
2057
+ * @maxLength 100
2058
+ */
1588
2059
  orderId?: string;
1589
2060
  /** Whether a draft can be created from this order */
1590
2061
  orderDraftable?: boolean;
1591
- /** Reasons why the order is not draftable */
2062
+ /**
2063
+ * Reasons why the order is not draftable
2064
+ * @maxSize 5
2065
+ */
1592
2066
  nonDraftableReasons?: NonDraftableReason[];
1593
2067
  }
1594
2068
  export declare enum NonDraftableReason {
@@ -1606,11 +2080,17 @@ export declare enum NonDraftableReason {
1606
2080
  TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
1607
2081
  }
1608
2082
  export interface CommitDraftOrderRequest {
1609
- /** The draft order id */
2083
+ /**
2084
+ * The draft order id
2085
+ * @format GUID
2086
+ */
1610
2087
  draftOrderId: string;
1611
2088
  /** Optional side effects to trigger */
1612
2089
  commitSettings?: DraftOrderCommitSettings;
1613
- /** Reason for edit, given by user (optional). */
2090
+ /**
2091
+ * Reason for edit, given by user (optional).
2092
+ * @maxLength 200
2093
+ */
1614
2094
  reason?: string | null;
1615
2095
  }
1616
2096
  export interface CommitDraftOrderResponse {
@@ -1622,6 +2102,7 @@ export interface CommitDraftOrderResponse {
1622
2102
  export interface Order {
1623
2103
  /**
1624
2104
  * Order ID.
2105
+ * @format GUID
1625
2106
  * @readonly
1626
2107
  */
1627
2108
  _id?: string | null;
@@ -1633,6 +2114,7 @@ export interface Order {
1633
2114
  /**
1634
2115
  * Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
1635
2116
  * @readonly
2117
+ * @immutable
1636
2118
  */
1637
2119
  _createdDate?: Date | null;
1638
2120
  /**
@@ -1642,6 +2124,8 @@ export interface Order {
1642
2124
  _updatedDate?: Date | null;
1643
2125
  /**
1644
2126
  * Order line items.
2127
+ * @minSize 1
2128
+ * @maxSize 300
1645
2129
  * @readonly
1646
2130
  */
1647
2131
  lineItems?: OrderLineItem[];
@@ -1661,13 +2145,20 @@ export interface Order {
1661
2145
  buyerLanguage?: string | null;
1662
2146
  /** Weight measurement unit - defaults to site's weight unit. */
1663
2147
  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. */
2148
+ /**
2149
+ * Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
2150
+ * @format CURRENCY
2151
+ */
1665
2152
  currency?: string | null;
1666
- /** Whether tax is included in line item prices. */
2153
+ /**
2154
+ * Whether tax is included in line item prices.
2155
+ * @immutable
2156
+ */
1667
2157
  taxIncludedInPrices?: boolean;
1668
2158
  /**
1669
2159
  * Site language in which original values are shown.
1670
2160
  * @readonly
2161
+ * @immutable
1671
2162
  */
1672
2163
  siteLanguage?: string | null;
1673
2164
  /**
@@ -1679,7 +2170,10 @@ export interface Order {
1679
2170
  billingInfo?: AddressWithContact;
1680
2171
  /** Shipping info and selected shipping option details. */
1681
2172
  shippingInfo?: V1ShippingInformation;
1682
- /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
2173
+ /**
2174
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
2175
+ * @maxLength 1000
2176
+ */
1683
2177
  buyerNote?: string | null;
1684
2178
  /** Order status. */
1685
2179
  status?: OrderStatus;
@@ -1698,11 +2192,15 @@ export interface Order {
1698
2192
  taxSummary?: TaxSummary;
1699
2193
  /** Tax information. */
1700
2194
  taxInfo?: OrderTaxInfo;
1701
- /** Applied discounts. */
2195
+ /**
2196
+ * Applied discounts.
2197
+ * @maxSize 320
2198
+ */
1702
2199
  appliedDiscounts?: AppliedDiscount[];
1703
2200
  /**
1704
2201
  * Order activities.
1705
2202
  * @readonly
2203
+ * @maxSize 1000
1706
2204
  */
1707
2205
  activities?: Activity[];
1708
2206
  /** Order attribution source. */
@@ -1716,7 +2214,10 @@ export interface Order {
1716
2214
  channelInfo?: ChannelInfo;
1717
2215
  /** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
1718
2216
  seenByAHuman?: boolean | null;
1719
- /** Checkout ID. */
2217
+ /**
2218
+ * Checkout ID.
2219
+ * @format GUID
2220
+ */
1720
2221
  checkoutId?: string | null;
1721
2222
  /** Custom fields. */
1722
2223
  customFields?: CustomField[];
@@ -1725,7 +2226,10 @@ export interface Order {
1725
2226
  * @readonly
1726
2227
  */
1727
2228
  balanceSummary?: V1BalanceSummary;
1728
- /** Additional fees applied to the order. */
2229
+ /**
2230
+ * Additional fees applied to the order.
2231
+ * @maxSize 100
2232
+ */
1729
2233
  additionalFees?: AdditionalFee[];
1730
2234
  /**
1731
2235
  * Custom field data for the order object.
@@ -1733,7 +2237,10 @@ export interface Order {
1733
2237
  * [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
2238
  */
1735
2239
  extendedFields?: ExtendedFields;
1736
- /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
2240
+ /**
2241
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
2242
+ * @format GUID
2243
+ */
1737
2244
  purchaseFlowId?: string | null;
1738
2245
  /**
1739
2246
  * Order recipient address and contact details.
@@ -1746,8 +2253,11 @@ export interface Order {
1746
2253
  /**
1747
2254
  * 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
2255
  * Used for migration from external systems.
2256
+ * @immutable
1749
2257
  */
1750
2258
  purchasedDate?: Date | null;
2259
+ /** Order Location */
2260
+ businessLocation?: Location;
1751
2261
  }
1752
2262
  export declare enum PaymentStatus {
1753
2263
  UNSPECIFIED = "UNSPECIFIED",
@@ -1835,11 +2345,13 @@ export interface Activity extends ActivityContentOneOf {
1835
2345
  orderRefunded?: OrderRefunded;
1836
2346
  /**
1837
2347
  * Activity ID.
2348
+ * @format GUID
1838
2349
  * @readonly
1839
2350
  */
1840
2351
  _id?: string | null;
1841
2352
  /**
1842
2353
  * Activity author's email.
2354
+ * @format EMAIL
1843
2355
  * @readonly
1844
2356
  */
1845
2357
  authorEmail?: string | null;
@@ -1861,16 +2373,26 @@ export interface ActivityContentOneOf {
1861
2373
  orderRefunded?: OrderRefunded;
1862
2374
  }
1863
2375
  export interface CustomActivity {
1864
- /** ID of the app that created the custom activity. */
2376
+ /**
2377
+ * ID of the app that created the custom activity.
2378
+ * @format GUID
2379
+ */
1865
2380
  appId?: string;
1866
- /** Custom activity type. For example, `"Ticket number set"`. */
2381
+ /**
2382
+ * Custom activity type. For example, `"Ticket number set"`.
2383
+ * @maxLength 100
2384
+ */
1867
2385
  type?: string;
1868
2386
  /** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
1869
2387
  additionalData?: Record<string, string>;
1870
2388
  }
1871
2389
  /** Store owner added a comment */
1872
2390
  export interface MerchantComment {
1873
- /** Merchant comment message. */
2391
+ /**
2392
+ * Merchant comment message.
2393
+ * @minLength 1
2394
+ * @maxLength 5000
2395
+ */
1874
2396
  message?: string;
1875
2397
  }
1876
2398
  export interface OrderRefunded {
@@ -1878,29 +2400,52 @@ export interface OrderRefunded {
1878
2400
  manual?: boolean;
1879
2401
  /** Refund amount. */
1880
2402
  amount?: Price;
1881
- /** Reason for refund. */
2403
+ /**
2404
+ * Reason for refund.
2405
+ * @maxLength 200
2406
+ */
1882
2407
  reason?: string;
1883
2408
  }
1884
2409
  export interface OrderCreatedFromExchange {
1885
- /** ID of the original order for which the exchange happened. */
2410
+ /**
2411
+ * ID of the original order for which the exchange happened.
2412
+ * @format GUID
2413
+ */
1886
2414
  originalOrderId?: string;
1887
2415
  }
1888
2416
  export interface NewExchangeOrderCreated {
1889
- /** ID of the new order created as a result of an exchange of items. */
2417
+ /**
2418
+ * ID of the new order created as a result of an exchange of items.
2419
+ * @format GUID
2420
+ */
1890
2421
  exchangeOrderId?: string;
1891
- /** IDs of the items that were exchanged. */
2422
+ /**
2423
+ * IDs of the items that were exchanged.
2424
+ * @minSize 1
2425
+ * @maxSize 300
2426
+ */
1892
2427
  lineItems?: LineItemExchangeData[];
1893
2428
  }
1894
2429
  export interface LineItemExchangeData {
1895
- /** ID of the exchanged line item. */
2430
+ /**
2431
+ * ID of the exchanged line item.
2432
+ * @format GUID
2433
+ */
1896
2434
  lineItemId?: string;
1897
- /** Line item quantity being exchanged. */
2435
+ /**
2436
+ * Line item quantity being exchanged.
2437
+ * @min 1
2438
+ * @max 100000
2439
+ */
1898
2440
  quantity?: number;
1899
2441
  }
1900
2442
  export interface DraftOrderChangesApplied {
1901
2443
  /** Draft order id. */
1902
2444
  draftOrderId?: string;
1903
- /** Reason for edit, given by user (optional). */
2445
+ /**
2446
+ * Reason for edit, given by user (optional).
2447
+ * @maxLength 200
2448
+ */
1904
2449
  reason?: string | null;
1905
2450
  /** Changes applied to order. */
1906
2451
  changes?: OrderChange[];
@@ -1929,7 +2474,10 @@ export interface OrderChangeValueOneOf {
1929
2474
  shippingInformationChanged?: ShippingInformationChange;
1930
2475
  }
1931
2476
  export interface LineItemChanges {
1932
- /** Line item ID. */
2477
+ /**
2478
+ * Line item ID.
2479
+ * @format GUID
2480
+ */
1933
2481
  _id?: string;
1934
2482
  /** Item name. */
1935
2483
  name?: ProductName;
@@ -1939,11 +2487,21 @@ export interface LineItemChanges {
1939
2487
  price?: LineItemPriceChange;
1940
2488
  }
1941
2489
  export interface LineItemQuantityChange {
1942
- /** Item quantity before update. */
2490
+ /**
2491
+ * Item quantity before update.
2492
+ * @max 1000000
2493
+ */
1943
2494
  originalQuantity?: number;
1944
- /** Item quantity after update. */
2495
+ /**
2496
+ * Item quantity after update.
2497
+ * @max 1000000
2498
+ */
1945
2499
  newQuantity?: number;
1946
- /** Difference between original and new quantity. Absolute value. */
2500
+ /**
2501
+ * Difference between original and new quantity. Absolute value.
2502
+ * @min 1
2503
+ * @max 1000000
2504
+ */
1947
2505
  diff?: number;
1948
2506
  /** Type of quantity change: increase or decrease. */
1949
2507
  deltaType?: LineItemQuantityChangeType;
@@ -1961,15 +2519,25 @@ export interface LineItemPriceChange {
1961
2519
  newPrice?: Price;
1962
2520
  }
1963
2521
  export interface ManagedLineItem {
1964
- /** Line item ID. */
2522
+ /**
2523
+ * Line item ID.
2524
+ * @format GUID
2525
+ */
1965
2526
  _id?: string;
1966
2527
  /** Item name. */
1967
2528
  name?: ProductName;
1968
- /** Added or removed item quantity. */
2529
+ /**
2530
+ * Added or removed item quantity.
2531
+ * @min 1
2532
+ * @max 1000000
2533
+ */
1969
2534
  quantity?: number;
1970
2535
  }
1971
2536
  export interface ManagedDiscount {
1972
- /** Discount id. */
2537
+ /**
2538
+ * Discount id.
2539
+ * @format GUID
2540
+ */
1973
2541
  _id?: string;
1974
2542
  /** Discount name: coupon name / discount rule name / merchant discount description. */
1975
2543
  name?: TranslatedValue;
@@ -1979,13 +2547,22 @@ export interface ManagedDiscount {
1979
2547
  totalAmount?: Price;
1980
2548
  }
1981
2549
  export interface TranslatedValue {
1982
- /** Value in site default language. */
2550
+ /**
2551
+ * Value in site default language.
2552
+ * @minLength 1
2553
+ */
1983
2554
  original?: string;
1984
- /** Translated value. */
2555
+ /**
2556
+ * Translated value.
2557
+ * @minLength 1
2558
+ */
1985
2559
  translated?: string | null;
1986
2560
  }
1987
2561
  export interface LineItemAmount {
1988
- /** Order line item id */
2562
+ /**
2563
+ * Order line item id
2564
+ * @format GUID
2565
+ */
1989
2566
  _id?: string;
1990
2567
  /** Item name. */
1991
2568
  name?: ProductName;
@@ -1993,7 +2570,10 @@ export interface LineItemAmount {
1993
2570
  amount?: Price;
1994
2571
  }
1995
2572
  export interface ManagedAdditionalFee {
1996
- /** Additional fee id. */
2573
+ /**
2574
+ * Additional fee id.
2575
+ * @format GUID
2576
+ */
1997
2577
  _id?: string;
1998
2578
  /** Additional fee name. */
1999
2579
  name?: TranslatedValue;
@@ -2017,54 +2597,102 @@ export interface ShippingInformationChange {
2017
2597
  export interface ShippingInformation {
2018
2598
  /** Order’s shipping price. */
2019
2599
  total?: Price;
2020
- /** Order’s shipping title. */
2600
+ /**
2601
+ * Order’s shipping title.
2602
+ * @maxLength 250
2603
+ */
2021
2604
  shippingTitle?: string;
2022
2605
  }
2023
2606
  /** Payment method is saved for order */
2024
2607
  export interface SavedPaymentMethod {
2025
- /** Payment method name */
2608
+ /**
2609
+ * Payment method name
2610
+ * @minLength 1
2611
+ * @maxLength 100
2612
+ */
2026
2613
  name?: string;
2027
- /** Payment method description */
2614
+ /**
2615
+ * Payment method description
2616
+ * @minLength 1
2617
+ * @maxLength 100
2618
+ */
2028
2619
  description?: string | null;
2029
2620
  }
2030
2621
  export interface AuthorizedPaymentCreated {
2031
- /** Payment ID of payment associated with this activity */
2622
+ /**
2623
+ * Payment ID of payment associated with this activity
2624
+ * @format GUID
2625
+ */
2032
2626
  paymentId?: string;
2033
2627
  /** Payment amount */
2034
2628
  amount?: Price;
2035
- /** The last 4 digits of the card number. */
2629
+ /**
2630
+ * The last 4 digits of the card number.
2631
+ * @maxLength 4
2632
+ */
2036
2633
  lastFourDigits?: string | null;
2037
- /** Card issuer's brand. */
2634
+ /**
2635
+ * Card issuer's brand.
2636
+ * @maxLength 100
2637
+ */
2038
2638
  brand?: string | null;
2039
2639
  }
2040
2640
  export interface AuthorizedPaymentCaptured {
2041
- /** Payment ID of payment associated with this activity */
2641
+ /**
2642
+ * Payment ID of payment associated with this activity
2643
+ * @format GUID
2644
+ */
2042
2645
  paymentId?: string;
2043
2646
  /** Payment amount */
2044
2647
  amount?: Price;
2045
- /** The last 4 digits of the card number. */
2648
+ /**
2649
+ * The last 4 digits of the card number.
2650
+ * @maxLength 4
2651
+ */
2046
2652
  lastFourDigits?: string | null;
2047
- /** Card issuer's brand. */
2653
+ /**
2654
+ * Card issuer's brand.
2655
+ * @maxLength 100
2656
+ */
2048
2657
  brand?: string | null;
2049
2658
  }
2050
2659
  export interface AuthorizedPaymentVoided {
2051
- /** Payment ID of payment associated with this activity */
2660
+ /**
2661
+ * Payment ID of payment associated with this activity
2662
+ * @format GUID
2663
+ */
2052
2664
  paymentId?: string;
2053
2665
  /** Payment amount */
2054
2666
  amount?: Price;
2055
- /** The last 4 digits of the card number. */
2667
+ /**
2668
+ * The last 4 digits of the card number.
2669
+ * @maxLength 4
2670
+ */
2056
2671
  lastFourDigits?: string | null;
2057
- /** Card issuer's brand. */
2672
+ /**
2673
+ * Card issuer's brand.
2674
+ * @maxLength 100
2675
+ */
2058
2676
  brand?: string | null;
2059
2677
  }
2060
2678
  export interface RefundInitiated {
2061
- /** Refund ID. */
2679
+ /**
2680
+ * Refund ID.
2681
+ * @format GUID
2682
+ */
2062
2683
  refundId?: string;
2063
2684
  /** Refund amount. */
2064
2685
  amount?: Price;
2065
- /** Details about the payments being refunded. */
2686
+ /**
2687
+ * Details about the payments being refunded.
2688
+ * @minSize 1
2689
+ * @maxSize 50
2690
+ */
2066
2691
  payments?: RefundedPayment[];
2067
- /** Reason for refund. */
2692
+ /**
2693
+ * Reason for refund.
2694
+ * @maxLength 100
2695
+ */
2068
2696
  reason?: string | null;
2069
2697
  }
2070
2698
  export interface RefundedPayment extends RefundedPaymentKindOneOf {
@@ -2074,7 +2702,10 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
2074
2702
  giftCard?: GiftCardPaymentRefund;
2075
2703
  /** Membership payment refund. */
2076
2704
  membership?: MembershipPaymentRefund;
2077
- /** Payment ID. */
2705
+ /**
2706
+ * Payment ID.
2707
+ * @format GUID
2708
+ */
2078
2709
  paymentId?: string;
2079
2710
  /** Whether refund was made externally and manually on the payment provider's side. */
2080
2711
  externalRefund?: boolean;
@@ -2091,29 +2722,49 @@ export interface RefundedPaymentKindOneOf {
2091
2722
  export interface RegularPaymentRefund {
2092
2723
  /** Refund amount */
2093
2724
  amount?: Price;
2094
- /** The last 4 digits of the card number. */
2725
+ /**
2726
+ * The last 4 digits of the card number.
2727
+ * @maxLength 4
2728
+ */
2095
2729
  lastFourDigits?: string | null;
2096
- /** Card issuer's brand. */
2730
+ /**
2731
+ * Card issuer's brand.
2732
+ * @maxLength 100
2733
+ */
2097
2734
  brand?: string | null;
2098
2735
  }
2099
2736
  export interface GiftCardPaymentRefund {
2100
- /** Gift card payment ID */
2737
+ /**
2738
+ * Gift card payment ID
2739
+ * @minLength 1
2740
+ * @maxLength 100
2741
+ */
2101
2742
  giftCardPaymentId?: string | null;
2102
2743
  /** Refund amount */
2103
2744
  amount?: Price;
2104
2745
  }
2105
2746
  export interface MembershipPaymentRefund {
2106
- /** Membership ID */
2747
+ /**
2748
+ * Membership ID
2749
+ * @minLength 1
2750
+ * @maxLength 100
2751
+ */
2107
2752
  membershipId?: string | null;
2108
2753
  }
2109
2754
  export interface PaymentRefunded {
2110
- /** Refund ID. */
2755
+ /**
2756
+ * Refund ID.
2757
+ * @format GUID
2758
+ */
2111
2759
  refundId?: string;
2112
2760
  /** Details about the refunded payment. */
2113
2761
  payment?: RefundedPayment;
2114
2762
  }
2115
2763
  export interface PaymentRefundFailed {
2116
- /** Refund ID. */
2764
+ /**
2765
+ * Refund ID.
2766
+ * @format GUID
2767
+ */
2117
2768
  refundId?: string;
2118
2769
  /** Details about the failed payment refund. */
2119
2770
  payment?: RefundedPayment;
@@ -2121,13 +2772,19 @@ export interface PaymentRefundFailed {
2121
2772
  export interface RefundedAsStoreCredit {
2122
2773
  /** Refund amount */
2123
2774
  amount?: Price;
2124
- /** Reason for refund */
2775
+ /**
2776
+ * Reason for refund
2777
+ * @maxLength 100
2778
+ */
2125
2779
  reason?: string | null;
2126
2780
  }
2127
2781
  export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
2128
2782
  /** Regular payment. */
2129
2783
  regular?: RegularPayment;
2130
- /** Payment ID of payment associated with this activity */
2784
+ /**
2785
+ * Payment ID of payment associated with this activity
2786
+ * @format GUID
2787
+ */
2131
2788
  paymentId?: string;
2132
2789
  }
2133
2790
  /** @oneof */
@@ -2147,15 +2804,24 @@ export interface RegularPaymentPaymentMethodDetailsOneOf {
2147
2804
  creditCardDetails?: CreditCardDetails;
2148
2805
  }
2149
2806
  export interface CreditCardDetails {
2150
- /** The last 4 digits of the card number. */
2807
+ /**
2808
+ * The last 4 digits of the card number.
2809
+ * @maxLength 4
2810
+ */
2151
2811
  lastFourDigits?: string | null;
2152
- /** Card issuer's brand. */
2812
+ /**
2813
+ * Card issuer's brand.
2814
+ * @maxLength 100
2815
+ */
2153
2816
  brand?: string | null;
2154
2817
  }
2155
2818
  export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
2156
2819
  /** Regular payment. */
2157
2820
  regular?: RegularPayment;
2158
- /** Payment ID of payment associated with this activity */
2821
+ /**
2822
+ * Payment ID of payment associated with this activity
2823
+ * @format GUID
2824
+ */
2159
2825
  paymentId?: string;
2160
2826
  }
2161
2827
  /** @oneof */
@@ -2166,7 +2832,10 @@ export interface PaymentCanceledPaymentDetailsOneOf {
2166
2832
  export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
2167
2833
  /** Regular payment. */
2168
2834
  regular?: RegularPayment;
2169
- /** Payment ID of payment associated with this activity */
2835
+ /**
2836
+ * Payment ID of payment associated with this activity
2837
+ * @format GUID
2838
+ */
2170
2839
  paymentId?: string;
2171
2840
  }
2172
2841
  /** @oneof */
@@ -2179,7 +2848,10 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
2179
2848
  wixReceipt?: WixReceipt;
2180
2849
  /** Receipt created by an external system. */
2181
2850
  externalReceipt?: ExternalReceipt;
2182
- /** Payment ID of payment associated with this activity */
2851
+ /**
2852
+ * Payment ID of payment associated with this activity
2853
+ * @format GUID
2854
+ */
2183
2855
  paymentId?: string;
2184
2856
  }
2185
2857
  /** @oneof */
@@ -2190,15 +2862,29 @@ export interface ReceiptCreatedReceiptInfoOneOf {
2190
2862
  externalReceipt?: ExternalReceipt;
2191
2863
  }
2192
2864
  export interface WixReceipt {
2193
- /** Receipt ID */
2865
+ /**
2866
+ * Receipt ID
2867
+ * @format GUID
2868
+ */
2194
2869
  receiptId?: string;
2195
- /** Display number of receipt */
2870
+ /**
2871
+ * Display number of receipt
2872
+ * @minLength 1
2873
+ * @maxLength 40
2874
+ */
2196
2875
  displayNumber?: string | null;
2197
2876
  }
2198
2877
  export interface ExternalReceipt {
2199
- /** Receipt ID */
2878
+ /**
2879
+ * Receipt ID
2880
+ * @maxLength 100
2881
+ */
2200
2882
  receiptId?: string | null;
2201
- /** Display number of receipt */
2883
+ /**
2884
+ * Display number of receipt
2885
+ * @minLength 1
2886
+ * @maxLength 40
2887
+ */
2202
2888
  displayNumber?: string | null;
2203
2889
  }
2204
2890
  export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
@@ -2206,7 +2892,10 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
2206
2892
  wixReceipt?: WixReceipt;
2207
2893
  /** Receipt created by an external system. */
2208
2894
  externalReceipt?: ExternalReceipt;
2209
- /** Payment ID of payment associated with this activity */
2895
+ /**
2896
+ * Payment ID of payment associated with this activity
2897
+ * @format GUID
2898
+ */
2210
2899
  paymentId?: string;
2211
2900
  }
2212
2901
  /** @oneof */
@@ -2261,13 +2950,23 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
2261
2950
  /**
2262
2951
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2263
2952
  * For example, via POS (point of service).
2953
+ * @format GUID
2264
2954
  */
2265
2955
  userId?: string;
2266
- /** Member ID - when the order was created by a **logged in** site visitor. */
2956
+ /**
2957
+ * Member ID - when the order was created by a **logged in** site visitor.
2958
+ * @format GUID
2959
+ */
2267
2960
  memberId?: string;
2268
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
2961
+ /**
2962
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
2963
+ * @format GUID
2964
+ */
2269
2965
  visitorId?: string;
2270
- /** App ID - when the order was created by an external application. */
2966
+ /**
2967
+ * App ID - when the order was created by an external application.
2968
+ * @format GUID
2969
+ */
2271
2970
  appId?: string;
2272
2971
  }
2273
2972
  /** @oneof */
@@ -2275,21 +2974,37 @@ export interface V1CreatedByStringOneOf {
2275
2974
  /**
2276
2975
  * User ID - when the order was created by a Wix user on behalf of a buyer.
2277
2976
  * For example, via POS (point of service).
2977
+ * @format GUID
2278
2978
  */
2279
2979
  userId?: string;
2280
- /** Member ID - when the order was created by a **logged in** site visitor. */
2980
+ /**
2981
+ * Member ID - when the order was created by a **logged in** site visitor.
2982
+ * @format GUID
2983
+ */
2281
2984
  memberId?: string;
2282
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
2985
+ /**
2986
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
2987
+ * @format GUID
2988
+ */
2283
2989
  visitorId?: string;
2284
- /** App ID - when the order was created by an external application. */
2990
+ /**
2991
+ * App ID - when the order was created by an external application.
2992
+ * @format GUID
2993
+ */
2285
2994
  appId?: string;
2286
2995
  }
2287
2996
  export interface ChannelInfo {
2288
2997
  /** Sales channel that submitted the order. */
2289
2998
  type?: ChannelType;
2290
- /** Reference to an order ID from an external system. */
2999
+ /**
3000
+ * Reference to an order ID from an external system.
3001
+ * @maxLength 100
3002
+ */
2291
3003
  externalOrderId?: string | null;
2292
- /** URL to the order in the external system. */
3004
+ /**
3005
+ * URL to the order in the external system.
3006
+ * @maxLength 300
3007
+ */
2293
3008
  externalOrderUrl?: string | null;
2294
3009
  }
2295
3010
  export declare enum ChannelType {
@@ -2329,9 +3044,17 @@ export declare enum ChannelType {
2329
3044
  export interface CustomField {
2330
3045
  /** Custom field value. */
2331
3046
  value?: any;
2332
- /** Custom field title. */
3047
+ /**
3048
+ * Custom field title.
3049
+ * @minLength 1
3050
+ * @maxLength 500
3051
+ */
2333
3052
  title?: string;
2334
- /** Translated custom field title. */
3053
+ /**
3054
+ * Translated custom field title.
3055
+ * @minLength 1
3056
+ * @maxLength 500
3057
+ */
2335
3058
  translatedTitle?: string | null;
2336
3059
  }
2337
3060
  export interface V1BalanceSummary {
@@ -2396,7 +3119,11 @@ export interface Tags {
2396
3119
  tags?: TagList;
2397
3120
  }
2398
3121
  export interface TagList {
2399
- /** List of tag IDs */
3122
+ /**
3123
+ * List of tag IDs
3124
+ * @maxSize 100
3125
+ * @maxLength 5
3126
+ */
2400
3127
  tagIds?: string[];
2401
3128
  }
2402
3129
  export interface CreateOrderFromDraftRequest {
@@ -2408,7 +3135,10 @@ export interface OrderCreateNotifications {
2408
3135
  export interface CreateOrderFromDraftResponse {
2409
3136
  }
2410
3137
  export interface DeleteDraftOrderRequest {
2411
- /** The draft order id */
3138
+ /**
3139
+ * The draft order id
3140
+ * @format GUID
3141
+ */
2412
3142
  draftOrderId: string;
2413
3143
  }
2414
3144
  export interface DeleteDraftOrderResponse {
@@ -2434,6 +3164,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2434
3164
  * Sort object.
2435
3165
  *
2436
3166
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
3167
+ * @maxSize 5
2437
3168
  */
2438
3169
  sort?: Sorting[];
2439
3170
  }
@@ -2447,7 +3178,10 @@ export interface CursorQueryPagingMethodOneOf {
2447
3178
  cursorPaging?: CursorPaging;
2448
3179
  }
2449
3180
  export interface Sorting {
2450
- /** Name of the field to sort by. */
3181
+ /**
3182
+ * Name of the field to sort by.
3183
+ * @maxLength 512
3184
+ */
2451
3185
  fieldName?: string;
2452
3186
  /** Sort order. */
2453
3187
  order?: SortOrder;
@@ -2457,13 +3191,17 @@ export declare enum SortOrder {
2457
3191
  DESC = "DESC"
2458
3192
  }
2459
3193
  export interface CursorPaging {
2460
- /** Maximum number of items to return in the results. */
3194
+ /**
3195
+ * Maximum number of items to return in the results.
3196
+ * @max 100
3197
+ */
2461
3198
  limit?: number | null;
2462
3199
  /**
2463
3200
  * Pointer to the next or previous page in the list of results.
2464
3201
  *
2465
3202
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2466
3203
  * Not relevant for the first request.
3204
+ * @maxLength 16000
2467
3205
  */
2468
3206
  cursor?: string | null;
2469
3207
  }
@@ -2487,9 +3225,15 @@ export interface CursorPagingMetadata {
2487
3225
  hasNext?: boolean | null;
2488
3226
  }
2489
3227
  export interface Cursors {
2490
- /** Cursor string pointing to the next page in the list of results. */
3228
+ /**
3229
+ * Cursor string pointing to the next page in the list of results.
3230
+ * @maxLength 16000
3231
+ */
2491
3232
  next?: string | null;
2492
- /** Cursor pointing to the previous page in the list of results. */
3233
+ /**
3234
+ * Cursor pointing to the previous page in the list of results.
3235
+ * @maxLength 16000
3236
+ */
2493
3237
  prev?: string | null;
2494
3238
  }
2495
3239
  export interface UpdateExtendedFieldsRequest {
@@ -2509,11 +3253,17 @@ export interface SetTaxExemptionRequest {
2509
3253
  export interface SetTaxExemptionResponse {
2510
3254
  }
2511
3255
  export interface GetDraftEditabilityStatusRequest {
2512
- /** Draft order ID. */
3256
+ /**
3257
+ * Draft order ID.
3258
+ * @format GUID
3259
+ */
2513
3260
  draftOrderId?: string | null;
2514
3261
  }
2515
3262
  export interface GetDraftEditabilityStatusResponse {
2516
- /** Draft order ID. */
3263
+ /**
3264
+ * Draft order ID.
3265
+ * @format GUID
3266
+ */
2517
3267
  draftOrderId?: string | null;
2518
3268
  /**
2519
3269
  * Draft order status.
@@ -2596,9 +3346,15 @@ export interface ActionEvent {
2596
3346
  body?: string;
2597
3347
  }
2598
3348
  export interface MessageEnvelope {
2599
- /** App instance ID. */
3349
+ /**
3350
+ * App instance ID.
3351
+ * @format GUID
3352
+ */
2600
3353
  instanceId?: string | null;
2601
- /** Event type. */
3354
+ /**
3355
+ * Event type.
3356
+ * @maxLength 150
3357
+ */
2602
3358
  eventType?: string;
2603
3359
  /** The identification type and identity data. */
2604
3360
  identity?: IdentificationData;
@@ -2606,26 +3362,50 @@ export interface MessageEnvelope {
2606
3362
  data?: string;
2607
3363
  }
2608
3364
  export interface IdentificationData extends IdentificationDataIdOneOf {
2609
- /** ID of a site visitor that has not logged in to the site. */
3365
+ /**
3366
+ * ID of a site visitor that has not logged in to the site.
3367
+ * @format GUID
3368
+ */
2610
3369
  anonymousVisitorId?: string;
2611
- /** ID of a site visitor that has logged in to the site. */
3370
+ /**
3371
+ * ID of a site visitor that has logged in to the site.
3372
+ * @format GUID
3373
+ */
2612
3374
  memberId?: string;
2613
- /** ID of a Wix user (site owner, contributor, etc.). */
3375
+ /**
3376
+ * ID of a Wix user (site owner, contributor, etc.).
3377
+ * @format GUID
3378
+ */
2614
3379
  wixUserId?: string;
2615
- /** ID of an app. */
3380
+ /**
3381
+ * ID of an app.
3382
+ * @format GUID
3383
+ */
2616
3384
  appId?: string;
2617
3385
  /** @readonly */
2618
3386
  identityType?: WebhookIdentityType;
2619
3387
  }
2620
3388
  /** @oneof */
2621
3389
  export interface IdentificationDataIdOneOf {
2622
- /** ID of a site visitor that has not logged in to the site. */
3390
+ /**
3391
+ * ID of a site visitor that has not logged in to the site.
3392
+ * @format GUID
3393
+ */
2623
3394
  anonymousVisitorId?: string;
2624
- /** ID of a site visitor that has logged in to the site. */
3395
+ /**
3396
+ * ID of a site visitor that has logged in to the site.
3397
+ * @format GUID
3398
+ */
2625
3399
  memberId?: string;
2626
- /** ID of a Wix user (site owner, contributor, etc.). */
3400
+ /**
3401
+ * ID of a Wix user (site owner, contributor, etc.).
3402
+ * @format GUID
3403
+ */
2627
3404
  wixUserId?: string;
2628
- /** ID of an app. */
3405
+ /**
3406
+ * ID of an app.
3407
+ * @format GUID
3408
+ */
2629
3409
  appId?: string;
2630
3410
  }
2631
3411
  export declare enum WebhookIdentityType {
@@ -2706,6 +3486,10 @@ interface SubscriptionInfoNonNullableFields {
2706
3486
  subscriptionOptionTitle: string;
2707
3487
  subscriptionSettings?: SubscriptionSettingsNonNullableFields;
2708
3488
  }
3489
+ interface LocationAndQuantityNonNullableFields {
3490
+ _id: string;
3491
+ quantity: number;
3492
+ }
2709
3493
  interface OrderLineItemNonNullableFields {
2710
3494
  _id: string;
2711
3495
  productName?: ProductNameNonNullableFields;
@@ -2727,6 +3511,7 @@ interface OrderLineItemNonNullableFields {
2727
3511
  subscriptionInfo?: SubscriptionInfoNonNullableFields;
2728
3512
  priceDescription?: PriceDescriptionNonNullableFields;
2729
3513
  depositAmount?: PriceNonNullableFields;
3514
+ locations: LocationAndQuantityNonNullableFields[];
2730
3515
  lineItemPrice?: PriceNonNullableFields;
2731
3516
  }
2732
3517
  interface ItemDetailsNonNullableFields {
@@ -2894,6 +3679,19 @@ interface OrderTaxInfoNonNullableFields {
2894
3679
  totalTax?: PriceNonNullableFields;
2895
3680
  taxBreakdown: OrderTaxBreakdownNonNullableFields[];
2896
3681
  }
3682
+ interface LocationNonNullableFields {
3683
+ _id: string;
3684
+ name: string;
3685
+ }
3686
+ interface BusinessLocationChangedDetailsNonNullableFields {
3687
+ businessLocationBeforeChange?: LocationNonNullableFields;
3688
+ }
3689
+ interface BusinessLocationDetailsNonNullableFields {
3690
+ added: boolean;
3691
+ changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
3692
+ removed: boolean;
3693
+ businessLocation?: LocationNonNullableFields;
3694
+ }
2897
3695
  interface DraftOrderNonNullableFields {
2898
3696
  lineItems: ItemDetailsNonNullableFields[];
2899
3697
  shippingInfo?: ShippingDetailsNonNullableFields;
@@ -2909,6 +3707,7 @@ interface DraftOrderNonNullableFields {
2909
3707
  balanceSummary?: BalanceSummaryNonNullableFields;
2910
3708
  commitSettings?: DraftOrderCommitSettingsNonNullableFields;
2911
3709
  recipientInfo?: RecipientInfoDetailsNonNullableFields;
3710
+ businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
2912
3711
  }
2913
3712
  interface PickupDetailsNonNullableFields {
2914
3713
  address?: AddressNonNullableFields;
@@ -3082,6 +3881,7 @@ interface OrderNonNullableFields {
3082
3881
  balanceSummary?: V1BalanceSummaryNonNullableFields;
3083
3882
  additionalFees: AdditionalFeeNonNullableFields[];
3084
3883
  recipientInfo?: AddressWithContactNonNullableFields;
3884
+ businessLocation?: LocationNonNullableFields;
3085
3885
  }
3086
3886
  export interface CommitDraftOrderResponseNonNullableFields {
3087
3887
  committedDraftOrder?: DraftOrderNonNullableFields;
@@ -3110,6 +3910,8 @@ export interface SetBusinessLocationResponseNonNullableFields {
3110
3910
  * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
3111
3911
  * @permissionScope Manage Stores - all permissions
3112
3912
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3913
+ * @permissionScope Manage Restaurants - all permissions
3914
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3113
3915
  * @permissionScope Manage eCommerce - all permissions
3114
3916
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3115
3917
  * @applicableIdentity APP
@@ -3125,6 +3927,8 @@ export declare function createDraftOrder(orderId: string | null): Promise<Create
3125
3927
  * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
3126
3928
  * @permissionScope Manage Stores - all permissions
3127
3929
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3930
+ * @permissionScope Manage Restaurants - all permissions
3931
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3128
3932
  * @permissionScope Manage eCommerce - all permissions
3129
3933
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3130
3934
  * @applicableIdentity APP
@@ -3141,6 +3945,8 @@ export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderRe
3141
3945
  * @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
3142
3946
  * @permissionScope Manage Stores - all permissions
3143
3947
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3948
+ * @permissionScope Manage Restaurants - all permissions
3949
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3144
3950
  * @permissionScope Manage eCommerce - all permissions
3145
3951
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3146
3952
  * @applicableIdentity APP
@@ -3148,9 +3954,15 @@ export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderRe
3148
3954
  */
3149
3955
  export declare function addLineItemsToDraftOrder(draftOrderId: string, options?: AddLineItemsToDraftOrderOptions): Promise<AddLineItemsToDraftOrderResponse & AddLineItemsToDraftOrderResponseNonNullableFields>;
3150
3956
  export interface AddLineItemsToDraftOrderOptions {
3151
- /** Catalog line items to add to draft order. */
3957
+ /**
3958
+ * Catalog line items to add to draft order.
3959
+ * @maxSize 300
3960
+ */
3152
3961
  catalogLineItems?: CatalogReferenceLineItem[];
3153
- /** Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin. */
3962
+ /**
3963
+ * Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
3964
+ * @maxSize 300
3965
+ */
3154
3966
  customLineItems?: CustomLineItem[];
3155
3967
  }
3156
3968
  /**
@@ -3168,6 +3980,8 @@ export interface AddLineItemsToDraftOrderOptions {
3168
3980
  * @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
3169
3981
  * @permissionScope Manage Stores - all permissions
3170
3982
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3983
+ * @permissionScope Manage Restaurants - all permissions
3984
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3171
3985
  * @permissionScope Manage eCommerce - all permissions
3172
3986
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3173
3987
  * @applicableIdentity APP
@@ -3175,7 +3989,11 @@ export interface AddLineItemsToDraftOrderOptions {
3175
3989
  */
3176
3990
  export declare function updateLineItems(draftOrderId: string, options?: UpdateLineItemsOptions): Promise<UpdateLineItemsResponse & UpdateLineItemsResponseNonNullableFields>;
3177
3991
  export interface UpdateLineItemsOptions {
3178
- /** Details of changes to apply per line item */
3992
+ /**
3993
+ * Details of changes to apply per line item
3994
+ * @minSize 1
3995
+ * @maxSize 300
3996
+ */
3179
3997
  lineItemChanges?: LineItemChangeDetails[];
3180
3998
  }
3181
3999
  /**
@@ -3191,6 +4009,8 @@ export interface UpdateLineItemsOptions {
3191
4009
  * @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
3192
4010
  * @permissionScope Manage Stores - all permissions
3193
4011
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4012
+ * @permissionScope Manage Restaurants - all permissions
4013
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3194
4014
  * @permissionScope Manage eCommerce - all permissions
3195
4015
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3196
4016
  * @applicableIdentity APP
@@ -3209,6 +4029,8 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
3209
4029
  * @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
3210
4030
  * @permissionScope Manage Stores - all permissions
3211
4031
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4032
+ * @permissionScope Manage Restaurants - all permissions
4033
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3212
4034
  * @permissionScope Manage eCommerce - all permissions
3213
4035
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3214
4036
  * @applicableIdentity APP
@@ -3216,7 +4038,11 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
3216
4038
  */
3217
4039
  export declare function createCustomDiscounts(draftOrderId: string, options?: CreateCustomDiscountsOptions): Promise<CreateCustomDiscountsResponse & CreateCustomDiscountsResponseNonNullableFields>;
3218
4040
  export interface CreateCustomDiscountsOptions {
3219
- /** The discounts to add. */
4041
+ /**
4042
+ * The discounts to add.
4043
+ * @minSize 1
4044
+ * @maxSize 100
4045
+ */
3220
4046
  discounts?: DiscountOption[];
3221
4047
  }
3222
4048
  /**
@@ -3230,6 +4056,8 @@ export interface CreateCustomDiscountsOptions {
3230
4056
  * @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
3231
4057
  * @permissionScope Manage Stores - all permissions
3232
4058
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4059
+ * @permissionScope Manage Restaurants - all permissions
4060
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3233
4061
  * @permissionScope Manage eCommerce - all permissions
3234
4062
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3235
4063
  * @applicableIdentity APP
@@ -3248,6 +4076,8 @@ export declare function deleteCustomDiscounts(draftOrderId: string, discountIds:
3248
4076
  * @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
3249
4077
  * @permissionScope Manage Stores - all permissions
3250
4078
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4079
+ * @permissionScope Manage Restaurants - all permissions
4080
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3251
4081
  * @permissionScope Manage eCommerce - all permissions
3252
4082
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3253
4083
  * @applicableIdentity APP
@@ -3268,6 +4098,8 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
3268
4098
  * @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
3269
4099
  * @permissionScope Manage Stores - all permissions
3270
4100
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4101
+ * @permissionScope Manage Restaurants - all permissions
4102
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3271
4103
  * @permissionScope Manage eCommerce - all permissions
3272
4104
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3273
4105
  * @applicableIdentity APP
@@ -3275,7 +4107,11 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
3275
4107
  */
3276
4108
  export declare function createCustomAdditionalFees(draftOrderId: string, options?: CreateCustomAdditionalFeesOptions): Promise<CreateCustomAdditionalFeesResponse & CreateCustomAdditionalFeesResponseNonNullableFields>;
3277
4109
  export interface CreateCustomAdditionalFeesOptions {
3278
- /** The additional fees to add. added with opted-out setting */
4110
+ /**
4111
+ * The additional fees to add. added with opted-out setting
4112
+ * @minSize 1
4113
+ * @maxSize 100
4114
+ */
3279
4115
  customAdditionalFees?: AdditionalFeeOption[];
3280
4116
  }
3281
4117
  /**
@@ -3289,6 +4125,8 @@ export interface CreateCustomAdditionalFeesOptions {
3289
4125
  * @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
3290
4126
  * @permissionScope Manage Stores - all permissions
3291
4127
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4128
+ * @permissionScope Manage Restaurants - all permissions
4129
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3292
4130
  * @permissionScope Manage eCommerce - all permissions
3293
4131
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3294
4132
  * @applicableIdentity APP
@@ -3302,6 +4140,8 @@ export declare function deleteCustomAdditionalFees(draftOrderId: string, customA
3302
4140
  * @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
3303
4141
  * @permissionScope Manage Stores - all permissions
3304
4142
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4143
+ * @permissionScope Manage Restaurants - all permissions
4144
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3305
4145
  * @permissionScope Manage eCommerce - all permissions
3306
4146
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3307
4147
  * @applicableIdentity APP
@@ -3315,6 +4155,8 @@ export declare function setShippingInfo(): Promise<void>;
3315
4155
  * @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
3316
4156
  * @permissionScope Manage Stores - all permissions
3317
4157
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4158
+ * @permissionScope Manage Restaurants - all permissions
4159
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3318
4160
  * @permissionScope Manage eCommerce - all permissions
3319
4161
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3320
4162
  * @applicableIdentity APP
@@ -3328,6 +4170,8 @@ export declare function setBuyerInfo(): Promise<void>;
3328
4170
  * @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
3329
4171
  * @permissionScope Manage Stores - all permissions
3330
4172
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4173
+ * @permissionScope Manage Restaurants - all permissions
4174
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3331
4175
  * @permissionScope Manage eCommerce - all permissions
3332
4176
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3333
4177
  * @applicableIdentity APP
@@ -3341,6 +4185,8 @@ export declare function setRecipientInfo(): Promise<void>;
3341
4185
  * @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
3342
4186
  * @permissionScope Manage Stores - all permissions
3343
4187
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4188
+ * @permissionScope Manage Restaurants - all permissions
4189
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3344
4190
  * @permissionScope Manage eCommerce - all permissions
3345
4191
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3346
4192
  * @applicableIdentity APP
@@ -3361,6 +4207,8 @@ export declare function setBillingInfo(): Promise<void>;
3361
4207
  * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
3362
4208
  * @permissionScope Manage Stores - all permissions
3363
4209
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4210
+ * @permissionScope Manage Restaurants - all permissions
4211
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3364
4212
  * @permissionScope Manage eCommerce - all permissions
3365
4213
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3366
4214
  * @applicableIdentity APP
@@ -3376,6 +4224,8 @@ export declare function getDraftOrder(draftOrderId: string): Promise<GetDraftOrd
3376
4224
  * @permissionId ECOM.DRAFT_ORDERS_READ
3377
4225
  * @permissionScope Manage Stores - all permissions
3378
4226
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4227
+ * @permissionScope Manage Restaurants - all permissions
4228
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3379
4229
  * @permissionScope Manage eCommerce - all permissions
3380
4230
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3381
4231
  * @applicableIdentity APP
@@ -3394,6 +4244,8 @@ export declare function getOrderDraftabilityStatus(orderId: string): Promise<Get
3394
4244
  * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
3395
4245
  * @permissionScope Manage Stores - all permissions
3396
4246
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4247
+ * @permissionScope Manage Restaurants - all permissions
4248
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3397
4249
  * @permissionScope Manage eCommerce - all permissions
3398
4250
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3399
4251
  * @applicableIdentity APP
@@ -3403,7 +4255,10 @@ export declare function commitDraftOrder(draftOrderId: string, options?: CommitD
3403
4255
  export interface CommitDraftOrderOptions {
3404
4256
  /** Optional side effects to trigger */
3405
4257
  commitSettings?: DraftOrderCommitSettings;
3406
- /** Reason for edit, given by user (optional). */
4258
+ /**
4259
+ * Reason for edit, given by user (optional).
4260
+ * @maxLength 200
4261
+ */
3407
4262
  reason?: string | null;
3408
4263
  }
3409
4264
  /**
@@ -3416,6 +4271,8 @@ export interface CommitDraftOrderOptions {
3416
4271
  * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
3417
4272
  * @permissionScope Manage Stores - all permissions
3418
4273
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4274
+ * @permissionScope Manage Restaurants - all permissions
4275
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3419
4276
  * @permissionScope Manage eCommerce - all permissions
3420
4277
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3421
4278
  * @applicableIdentity APP
@@ -3433,6 +4290,8 @@ export declare function createOrderFromDraft(): Promise<void>;
3433
4290
  * @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
3434
4291
  * @permissionScope Manage Stores - all permissions
3435
4292
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4293
+ * @permissionScope Manage Restaurants - all permissions
4294
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3436
4295
  * @permissionScope Manage eCommerce - all permissions
3437
4296
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3438
4297
  * @applicableIdentity APP
@@ -3454,6 +4313,8 @@ export declare function deleteDraftOrder(draftOrderId: string): Promise<void>;
3454
4313
  * @documentationMaturity preview
3455
4314
  * @permissionScope Manage Stores - all permissions
3456
4315
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4316
+ * @permissionScope Manage Restaurants - all permissions
4317
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3457
4318
  * @permissionScope Manage eCommerce - all permissions
3458
4319
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3459
4320
  * @permissionId ECOM.DRAFT_ORDERS_READ
@@ -3545,6 +4406,8 @@ export interface DraftOrdersQueryBuilder {
3545
4406
  * @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
3546
4407
  * @permissionScope Manage Stores - all permissions
3547
4408
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4409
+ * @permissionScope Manage Restaurants - all permissions
4410
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3548
4411
  * @permissionScope Manage eCommerce - all permissions
3549
4412
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3550
4413
  * @applicableIdentity APP