@wix/auto_sdk_ecom_draft-orders 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +985 -217
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1054 -223
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +985 -217
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1054 -223
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +970 -224
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1054 -262
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +970 -224
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1054 -262
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- 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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
103
|
+
/**
|
|
104
|
+
* Member ID (if order created by a member).
|
|
105
|
+
* @format GUID
|
|
106
|
+
*/
|
|
93
107
|
memberId?: string | null;
|
|
94
|
-
/**
|
|
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
|
/**
|
|
@@ -111,6 +128,11 @@ export interface DraftOrder {
|
|
|
111
128
|
* @internal
|
|
112
129
|
*/
|
|
113
130
|
billingDetails?: BillingDetails;
|
|
131
|
+
/**
|
|
132
|
+
* Order business location
|
|
133
|
+
* Includes details about changes when relevant.
|
|
134
|
+
*/
|
|
135
|
+
businessLocationDetails?: BusinessLocationDetails;
|
|
114
136
|
}
|
|
115
137
|
export interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
116
138
|
/** Whether the line item was added as part of the draft. */
|
|
@@ -132,7 +154,10 @@ export interface ItemDetailsChangeTypeOneOf {
|
|
|
132
154
|
removed?: boolean;
|
|
133
155
|
}
|
|
134
156
|
export interface Price {
|
|
135
|
-
/**
|
|
157
|
+
/**
|
|
158
|
+
* Amount.
|
|
159
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
160
|
+
*/
|
|
136
161
|
amount?: string;
|
|
137
162
|
/**
|
|
138
163
|
* Amount formatted with currency symbol.
|
|
@@ -141,17 +166,26 @@ export interface Price {
|
|
|
141
166
|
formattedAmount?: string;
|
|
142
167
|
}
|
|
143
168
|
export interface PriceDescription {
|
|
144
|
-
/**
|
|
169
|
+
/**
|
|
170
|
+
* __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).
|
|
171
|
+
* @minLength 1
|
|
172
|
+
* @maxLength 100
|
|
173
|
+
*/
|
|
145
174
|
original?: string;
|
|
146
175
|
/**
|
|
147
176
|
* Price description translated into the buyer's language.
|
|
148
177
|
*
|
|
149
178
|
* Default: Same as `original`.
|
|
179
|
+
* @minLength 1
|
|
180
|
+
* @maxLength 100
|
|
150
181
|
*/
|
|
151
182
|
translated?: string | null;
|
|
152
183
|
}
|
|
153
184
|
export interface OrderLineItem {
|
|
154
|
-
/**
|
|
185
|
+
/**
|
|
186
|
+
* Line item ID.
|
|
187
|
+
* @immutable
|
|
188
|
+
*/
|
|
155
189
|
_id?: string;
|
|
156
190
|
/**
|
|
157
191
|
* Item name.
|
|
@@ -165,14 +199,21 @@ export interface OrderLineItem {
|
|
|
165
199
|
* This field may be empty in the case of a custom line item.
|
|
166
200
|
*/
|
|
167
201
|
catalogReference?: CatalogReference;
|
|
168
|
-
/**
|
|
202
|
+
/**
|
|
203
|
+
* Line item quantity.
|
|
204
|
+
* @min 1
|
|
205
|
+
* @max 100000
|
|
206
|
+
*/
|
|
169
207
|
quantity?: number;
|
|
170
208
|
/**
|
|
171
209
|
* Total discount for this line item's entire quantity.
|
|
172
210
|
* @readonly
|
|
173
211
|
*/
|
|
174
212
|
totalDiscount?: Price;
|
|
175
|
-
/**
|
|
213
|
+
/**
|
|
214
|
+
* Line item description lines. Used for display purposes for the cart, checkout and order.
|
|
215
|
+
* @maxSize 20
|
|
216
|
+
*/
|
|
176
217
|
descriptionLines?: DescriptionLine[];
|
|
177
218
|
/** Line item image. */
|
|
178
219
|
image?: string;
|
|
@@ -183,11 +224,18 @@ export interface OrderLineItem {
|
|
|
183
224
|
/**
|
|
184
225
|
* Fulfiller ID. Field is empty when the line item is self-fulfilled.
|
|
185
226
|
* 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).
|
|
227
|
+
* @format GUID
|
|
186
228
|
*/
|
|
187
229
|
fulfillerId?: string | null;
|
|
188
|
-
/**
|
|
230
|
+
/**
|
|
231
|
+
* Number of items that were refunded.
|
|
232
|
+
* @max 100000
|
|
233
|
+
*/
|
|
189
234
|
refundQuantity?: number | null;
|
|
190
|
-
/**
|
|
235
|
+
/**
|
|
236
|
+
* Number of items restocked.
|
|
237
|
+
* @max 100000
|
|
238
|
+
*/
|
|
191
239
|
restockQuantity?: number | null;
|
|
192
240
|
/** Line item price after line item discounts for display purposes. */
|
|
193
241
|
price?: Price;
|
|
@@ -207,11 +255,9 @@ export interface OrderLineItem {
|
|
|
207
255
|
*/
|
|
208
256
|
totalPriceAfterTax?: Price;
|
|
209
257
|
/**
|
|
210
|
-
* Type of selected payment option for current item.
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
214
|
-
* + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.
|
|
258
|
+
* Type of selected payment option for current item.
|
|
259
|
+
*
|
|
260
|
+
* Default: `FULL_PAYMENT_ONLINE`
|
|
215
261
|
*/
|
|
216
262
|
paymentOption?: PaymentOptionType;
|
|
217
263
|
/**
|
|
@@ -246,6 +292,7 @@ export interface OrderLineItem {
|
|
|
246
292
|
/**
|
|
247
293
|
* ID of the app managing the inventory.
|
|
248
294
|
* @internal
|
|
295
|
+
* @format GUID
|
|
249
296
|
*/
|
|
250
297
|
inventoryAppId?: string | null;
|
|
251
298
|
/**
|
|
@@ -261,6 +308,8 @@ export interface ProductName {
|
|
|
261
308
|
*
|
|
262
309
|
* Min: 1 character.
|
|
263
310
|
* Max: 200 characters.
|
|
311
|
+
* @minLength 1
|
|
312
|
+
* @maxLength 200
|
|
264
313
|
*/
|
|
265
314
|
original?: string;
|
|
266
315
|
/**
|
|
@@ -269,12 +318,18 @@ export interface ProductName {
|
|
|
269
318
|
* Min: 1 character.
|
|
270
319
|
* Max: 400 characters.
|
|
271
320
|
* Default: Same as `original`.
|
|
321
|
+
* @minLength 1
|
|
322
|
+
* @maxLength 400
|
|
272
323
|
*/
|
|
273
324
|
translated?: string | null;
|
|
274
325
|
}
|
|
275
326
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
276
327
|
export interface CatalogReference {
|
|
277
|
-
/**
|
|
328
|
+
/**
|
|
329
|
+
* ID of the item within the catalog it belongs to.
|
|
330
|
+
* @minLength 1
|
|
331
|
+
* @maxLength 36
|
|
332
|
+
*/
|
|
278
333
|
catalogItemId?: string;
|
|
279
334
|
/**
|
|
280
335
|
* ID of the app providing the catalog.
|
|
@@ -285,6 +340,7 @@ export interface CatalogReference {
|
|
|
285
340
|
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
286
341
|
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
287
342
|
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
343
|
+
* @minLength 1
|
|
288
344
|
*/
|
|
289
345
|
appId?: string;
|
|
290
346
|
/**
|
|
@@ -313,32 +369,44 @@ export interface DescriptionLineValueOneOf {
|
|
|
313
369
|
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
314
370
|
}
|
|
315
371
|
export interface DescriptionLineName {
|
|
316
|
-
/**
|
|
372
|
+
/**
|
|
373
|
+
* 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).
|
|
374
|
+
* @maxLength 100
|
|
375
|
+
*/
|
|
317
376
|
original?: string;
|
|
318
377
|
/**
|
|
319
378
|
* Description line name translated into the buyer's language.
|
|
320
379
|
*
|
|
321
380
|
* Default: Same as `original`.
|
|
381
|
+
* @maxLength 200
|
|
322
382
|
*/
|
|
323
383
|
translated?: string | null;
|
|
324
384
|
}
|
|
325
385
|
export interface PlainTextValue {
|
|
326
|
-
/**
|
|
386
|
+
/**
|
|
387
|
+
* 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).
|
|
388
|
+
* @maxLength 600
|
|
389
|
+
*/
|
|
327
390
|
original?: string;
|
|
328
391
|
/**
|
|
329
392
|
* Description line plain text value translated into the buyer's language.
|
|
330
393
|
*
|
|
331
394
|
* Default: Same as `original`.
|
|
395
|
+
* @maxLength 600
|
|
332
396
|
*/
|
|
333
397
|
translated?: string | null;
|
|
334
398
|
}
|
|
335
399
|
export interface Color {
|
|
336
|
-
/**
|
|
400
|
+
/**
|
|
401
|
+
* 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).
|
|
402
|
+
* @maxLength 500
|
|
403
|
+
*/
|
|
337
404
|
original?: string;
|
|
338
405
|
/**
|
|
339
406
|
* Description line color name translated into the buyer's language.
|
|
340
407
|
*
|
|
341
408
|
* Default: Same as `original`.
|
|
409
|
+
* @maxLength 500
|
|
342
410
|
*/
|
|
343
411
|
translated?: string | null;
|
|
344
412
|
/** HEX or RGB color code for display. */
|
|
@@ -365,7 +433,10 @@ export interface FocalPoint {
|
|
|
365
433
|
export interface PhysicalProperties {
|
|
366
434
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
367
435
|
weight?: number | null;
|
|
368
|
-
/**
|
|
436
|
+
/**
|
|
437
|
+
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
438
|
+
* @maxLength 40
|
|
439
|
+
*/
|
|
369
440
|
sku?: string | null;
|
|
370
441
|
/** Whether this line item is shippable. */
|
|
371
442
|
shippable?: boolean;
|
|
@@ -406,7 +477,10 @@ export declare enum PaymentOptionType {
|
|
|
406
477
|
export interface ItemTaxFullDetails {
|
|
407
478
|
/** Taxable amount of this line item. */
|
|
408
479
|
taxableAmount?: Price;
|
|
409
|
-
/**
|
|
480
|
+
/**
|
|
481
|
+
* Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
|
|
482
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
483
|
+
*/
|
|
410
484
|
taxRate?: string;
|
|
411
485
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
412
486
|
totalTax?: Price;
|
|
@@ -416,16 +490,24 @@ export interface LineItemTaxInfo {
|
|
|
416
490
|
taxAmount?: Price;
|
|
417
491
|
/** Amount for which tax is calculated. */
|
|
418
492
|
taxableAmount?: Price;
|
|
419
|
-
/**
|
|
493
|
+
/**
|
|
494
|
+
* Tax rate %, as a decimal point.
|
|
495
|
+
* @format DECIMAL_VALUE
|
|
496
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
497
|
+
*/
|
|
420
498
|
taxRate?: string | null;
|
|
421
499
|
/**
|
|
422
500
|
* Tax group ID.
|
|
423
501
|
* Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
|
|
502
|
+
* @format GUID
|
|
424
503
|
*/
|
|
425
504
|
taxGroupId?: string | null;
|
|
426
505
|
/** Indicates whether the price already includes tax. */
|
|
427
506
|
taxIncludedInPrice?: boolean;
|
|
428
|
-
/**
|
|
507
|
+
/**
|
|
508
|
+
* Tax information for a line item.
|
|
509
|
+
* @maxSize 7
|
|
510
|
+
*/
|
|
429
511
|
taxBreakdown?: LineItemTaxBreakdown[];
|
|
430
512
|
}
|
|
431
513
|
/**
|
|
@@ -433,17 +515,28 @@ export interface LineItemTaxInfo {
|
|
|
433
515
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
434
516
|
*/
|
|
435
517
|
export interface LineItemTaxBreakdown {
|
|
436
|
-
/**
|
|
518
|
+
/**
|
|
519
|
+
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
520
|
+
* @maxLength 200
|
|
521
|
+
*/
|
|
437
522
|
jurisdiction?: string | null;
|
|
438
|
-
/**
|
|
523
|
+
/**
|
|
524
|
+
* Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
|
|
525
|
+
* @format DECIMAL_VALUE
|
|
526
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
527
|
+
*/
|
|
439
528
|
rate?: string | null;
|
|
440
529
|
/** Amount of tax calculated for this line item. */
|
|
441
530
|
taxAmount?: Price;
|
|
442
|
-
/**
|
|
531
|
+
/**
|
|
532
|
+
* The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
|
|
533
|
+
* @maxLength 200
|
|
534
|
+
*/
|
|
443
535
|
taxType?: string | null;
|
|
444
536
|
/**
|
|
445
537
|
* The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
|
|
446
538
|
* This name should be explicit enough to allow the merchant to understand what tax was calculated.
|
|
539
|
+
* @maxLength 200
|
|
447
540
|
*/
|
|
448
541
|
taxName?: string | null;
|
|
449
542
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
@@ -463,9 +556,18 @@ export declare enum JurisdictionType {
|
|
|
463
556
|
SPECIAL = "SPECIAL"
|
|
464
557
|
}
|
|
465
558
|
export interface DigitalFile {
|
|
466
|
-
/**
|
|
559
|
+
/**
|
|
560
|
+
* ID of the secure file in media.
|
|
561
|
+
* @minLength 1
|
|
562
|
+
* @maxLength 100
|
|
563
|
+
*/
|
|
467
564
|
fileId?: string;
|
|
468
|
-
/**
|
|
565
|
+
/**
|
|
566
|
+
* Link will exist after the digital links have been generated on the order.
|
|
567
|
+
* @format WEB_URL
|
|
568
|
+
* @minLength 1
|
|
569
|
+
* @maxLength 2000
|
|
570
|
+
*/
|
|
469
571
|
link?: string | null;
|
|
470
572
|
/**
|
|
471
573
|
* Link expiration time and date.
|
|
@@ -474,30 +576,54 @@ export interface DigitalFile {
|
|
|
474
576
|
expirationDate?: Date | null;
|
|
475
577
|
}
|
|
476
578
|
export interface SubscriptionInfo {
|
|
477
|
-
/**
|
|
579
|
+
/**
|
|
580
|
+
* Subscription ID.
|
|
581
|
+
* @format GUID
|
|
582
|
+
*/
|
|
478
583
|
_id?: string | null;
|
|
479
|
-
/**
|
|
584
|
+
/**
|
|
585
|
+
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
586
|
+
* @min 1
|
|
587
|
+
*/
|
|
480
588
|
cycleNumber?: number;
|
|
481
|
-
/**
|
|
589
|
+
/**
|
|
590
|
+
* Subscription option title. For example, `"Monthly coffee Subscription"`.
|
|
591
|
+
* @minLength 1
|
|
592
|
+
* @maxLength 20
|
|
593
|
+
*/
|
|
482
594
|
subscriptionOptionTitle?: string;
|
|
483
|
-
/**
|
|
595
|
+
/**
|
|
596
|
+
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
597
|
+
* @maxLength 60
|
|
598
|
+
*/
|
|
484
599
|
subscriptionOptionDescription?: string | null;
|
|
485
|
-
/**
|
|
600
|
+
/**
|
|
601
|
+
* Subscription detailed information.
|
|
602
|
+
* @immutable
|
|
603
|
+
*/
|
|
486
604
|
subscriptionSettings?: SubscriptionSettings;
|
|
487
605
|
/**
|
|
488
606
|
* Description of the charges that will be applied for subscription.
|
|
489
607
|
* @internal
|
|
608
|
+
* @maxLength 1000
|
|
490
609
|
*/
|
|
491
610
|
chargesDescription?: string | null;
|
|
492
611
|
}
|
|
493
612
|
export interface SubscriptionSettings {
|
|
494
613
|
/** Frequency of recurring payment. */
|
|
495
614
|
frequency?: SubscriptionFrequency;
|
|
496
|
-
/**
|
|
615
|
+
/**
|
|
616
|
+
* Interval of recurring payment.
|
|
617
|
+
* @min 1
|
|
618
|
+
* @max 50
|
|
619
|
+
*/
|
|
497
620
|
interval?: number | null;
|
|
498
621
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
499
622
|
autoRenewal?: boolean;
|
|
500
|
-
/**
|
|
623
|
+
/**
|
|
624
|
+
* Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
|
|
625
|
+
* @min 1
|
|
626
|
+
*/
|
|
501
627
|
billingCycles?: number | null;
|
|
502
628
|
/**
|
|
503
629
|
* Whether to allow the customer to cancel the subscription.
|
|
@@ -526,23 +652,36 @@ export declare enum SubscriptionFrequency {
|
|
|
526
652
|
export interface FreeTrialPeriod {
|
|
527
653
|
/** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
|
|
528
654
|
frequency?: SubscriptionFrequency;
|
|
529
|
-
/**
|
|
655
|
+
/**
|
|
656
|
+
* interval of period
|
|
657
|
+
* @min 1
|
|
658
|
+
* @max 50
|
|
659
|
+
*/
|
|
530
660
|
interval?: number;
|
|
531
661
|
}
|
|
532
662
|
export interface LocationAndQuantity {
|
|
533
|
-
/**
|
|
663
|
+
/**
|
|
664
|
+
* Location id in the associated owner app.
|
|
665
|
+
* @format GUID
|
|
666
|
+
*/
|
|
534
667
|
_id?: string;
|
|
535
668
|
/**
|
|
536
669
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
670
|
+
* @format GUID
|
|
537
671
|
* @deprecated Location owner app, if not provided then the site business info locations will be used.
|
|
538
672
|
* @targetRemovalDate 2025-03-01
|
|
539
673
|
*/
|
|
540
674
|
appId?: string | null;
|
|
541
|
-
/**
|
|
675
|
+
/**
|
|
676
|
+
* Quantity for specific location.
|
|
677
|
+
* @min 1
|
|
678
|
+
* @max 100000
|
|
679
|
+
*/
|
|
542
680
|
quantity?: number;
|
|
543
681
|
/**
|
|
544
682
|
* Location name.
|
|
545
683
|
* @internal
|
|
684
|
+
* @maxLength 500
|
|
546
685
|
* @readonly
|
|
547
686
|
*/
|
|
548
687
|
name?: string | null;
|
|
@@ -574,7 +713,11 @@ export interface ExtendedFields {
|
|
|
574
713
|
namespaces?: Record<string, Record<string, any>>;
|
|
575
714
|
}
|
|
576
715
|
export interface ItemChangedDetails {
|
|
577
|
-
/**
|
|
716
|
+
/**
|
|
717
|
+
* Line item quantity before change.
|
|
718
|
+
* @min 1
|
|
719
|
+
* @max 1000000
|
|
720
|
+
*/
|
|
578
721
|
quantityBeforeChange?: number | null;
|
|
579
722
|
/** Line item price before change. */
|
|
580
723
|
priceBeforeChange?: Price;
|
|
@@ -601,13 +744,22 @@ export interface ShippingDetailsChangeTypeOneOf {
|
|
|
601
744
|
removed?: boolean;
|
|
602
745
|
}
|
|
603
746
|
export interface V1ShippingInformation {
|
|
604
|
-
/**
|
|
747
|
+
/**
|
|
748
|
+
* App Def Id of external provider which was a source of shipping info
|
|
749
|
+
* @minLength 1
|
|
750
|
+
* @maxLength 100
|
|
751
|
+
*/
|
|
605
752
|
carrierId?: string | null;
|
|
606
|
-
/**
|
|
753
|
+
/**
|
|
754
|
+
* Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
|
|
755
|
+
* @minLength 1
|
|
756
|
+
* @maxLength 100
|
|
757
|
+
*/
|
|
607
758
|
code?: string | null;
|
|
608
759
|
/**
|
|
609
760
|
* Shipping option title.
|
|
610
761
|
* For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
|
|
762
|
+
* @maxLength 250
|
|
611
763
|
*/
|
|
612
764
|
title?: string;
|
|
613
765
|
/** Shipping logistics. */
|
|
@@ -622,9 +774,15 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
|
622
774
|
shippingDestination?: AddressWithContact;
|
|
623
775
|
/** Pickup details. */
|
|
624
776
|
pickupDetails?: V1PickupDetails;
|
|
625
|
-
/**
|
|
777
|
+
/**
|
|
778
|
+
* Expected delivery time in free text. For example, `"3-5 business days"`.
|
|
779
|
+
* @maxLength 500
|
|
780
|
+
*/
|
|
626
781
|
deliveryTime?: string | null;
|
|
627
|
-
/**
|
|
782
|
+
/**
|
|
783
|
+
* Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
|
|
784
|
+
* @maxLength 1000
|
|
785
|
+
*/
|
|
628
786
|
instructions?: string | null;
|
|
629
787
|
/**
|
|
630
788
|
* Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
@@ -650,19 +808,37 @@ export interface AddressWithContact {
|
|
|
650
808
|
}
|
|
651
809
|
/** Physical address */
|
|
652
810
|
export interface Address {
|
|
653
|
-
/**
|
|
811
|
+
/**
|
|
812
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
813
|
+
* @format COUNTRY
|
|
814
|
+
*/
|
|
654
815
|
country?: string | null;
|
|
655
|
-
/**
|
|
816
|
+
/**
|
|
817
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
818
|
+
* @maxLength 50
|
|
819
|
+
*/
|
|
656
820
|
subdivision?: string | null;
|
|
657
|
-
/**
|
|
821
|
+
/**
|
|
822
|
+
* City name.
|
|
823
|
+
* @maxLength 50
|
|
824
|
+
*/
|
|
658
825
|
city?: string | null;
|
|
659
|
-
/**
|
|
826
|
+
/**
|
|
827
|
+
* Postal or zip code.
|
|
828
|
+
* @maxLength 50
|
|
829
|
+
*/
|
|
660
830
|
postalCode?: string | null;
|
|
661
831
|
/** Street address. */
|
|
662
832
|
streetAddress?: StreetAddress;
|
|
663
|
-
/**
|
|
833
|
+
/**
|
|
834
|
+
* Main address line (usually street name and number).
|
|
835
|
+
* @maxLength 150
|
|
836
|
+
*/
|
|
664
837
|
addressLine1?: string | null;
|
|
665
|
-
/**
|
|
838
|
+
/**
|
|
839
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
840
|
+
* @maxLength 100
|
|
841
|
+
*/
|
|
666
842
|
addressLine2?: string | null;
|
|
667
843
|
/**
|
|
668
844
|
* Country's full name.
|
|
@@ -689,13 +865,25 @@ export interface AddressLocation {
|
|
|
689
865
|
}
|
|
690
866
|
/** Full contact details for an address */
|
|
691
867
|
export interface FullAddressContactDetails {
|
|
692
|
-
/**
|
|
868
|
+
/**
|
|
869
|
+
* First name.
|
|
870
|
+
* @maxLength 100
|
|
871
|
+
*/
|
|
693
872
|
firstName?: string | null;
|
|
694
|
-
/**
|
|
873
|
+
/**
|
|
874
|
+
* Last name.
|
|
875
|
+
* @maxLength 100
|
|
876
|
+
*/
|
|
695
877
|
lastName?: string | null;
|
|
696
|
-
/**
|
|
878
|
+
/**
|
|
879
|
+
* Phone number.
|
|
880
|
+
* @format PHONE
|
|
881
|
+
*/
|
|
697
882
|
phone?: string | null;
|
|
698
|
-
/**
|
|
883
|
+
/**
|
|
884
|
+
* Company name.
|
|
885
|
+
* @maxLength 1000
|
|
886
|
+
*/
|
|
699
887
|
company?: string | null;
|
|
700
888
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
701
889
|
vatId?: VatId;
|
|
@@ -728,19 +916,37 @@ export interface V1PickupDetails {
|
|
|
728
916
|
}
|
|
729
917
|
/** Physical address */
|
|
730
918
|
export interface PickupAddress {
|
|
731
|
-
/**
|
|
919
|
+
/**
|
|
920
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
921
|
+
* @format COUNTRY
|
|
922
|
+
*/
|
|
732
923
|
country?: string | null;
|
|
733
|
-
/**
|
|
924
|
+
/**
|
|
925
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
926
|
+
* @maxLength 50
|
|
927
|
+
*/
|
|
734
928
|
subdivision?: string | null;
|
|
735
|
-
/**
|
|
929
|
+
/**
|
|
930
|
+
* City name.
|
|
931
|
+
* @maxLength 1000
|
|
932
|
+
*/
|
|
736
933
|
city?: string | null;
|
|
737
|
-
/**
|
|
934
|
+
/**
|
|
935
|
+
* Postal or zip code.
|
|
936
|
+
* @maxLength 1000
|
|
937
|
+
*/
|
|
738
938
|
postalCode?: string | null;
|
|
739
939
|
/** Street address object, with number, name, and apartment number in separate fields. */
|
|
740
940
|
streetAddress?: StreetAddress;
|
|
741
|
-
/**
|
|
941
|
+
/**
|
|
942
|
+
* Main address line (usually street name and number).
|
|
943
|
+
* @maxLength 1000
|
|
944
|
+
*/
|
|
742
945
|
addressLine1?: string | null;
|
|
743
|
-
/**
|
|
946
|
+
/**
|
|
947
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
948
|
+
* @maxLength 1000
|
|
949
|
+
*/
|
|
744
950
|
addressLine2?: string | null;
|
|
745
951
|
/**
|
|
746
952
|
* Country's full name.
|
|
@@ -786,7 +992,10 @@ export interface V1ShippingPrice {
|
|
|
786
992
|
discount?: Price;
|
|
787
993
|
}
|
|
788
994
|
export interface ShippingRegion {
|
|
789
|
-
/**
|
|
995
|
+
/**
|
|
996
|
+
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
997
|
+
* @maxLength 100
|
|
998
|
+
*/
|
|
790
999
|
name?: string | null;
|
|
791
1000
|
}
|
|
792
1001
|
export interface ShippingChangedDetails {
|
|
@@ -795,20 +1004,38 @@ export interface ShippingChangedDetails {
|
|
|
795
1004
|
}
|
|
796
1005
|
/** Buyer Info */
|
|
797
1006
|
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
798
|
-
/**
|
|
1007
|
+
/**
|
|
1008
|
+
* Visitor ID (if site visitor is not a member).
|
|
1009
|
+
* @format GUID
|
|
1010
|
+
*/
|
|
799
1011
|
visitorId?: string;
|
|
800
|
-
/**
|
|
1012
|
+
/**
|
|
1013
|
+
* Member ID (if site visitor is a site member).
|
|
1014
|
+
* @format GUID
|
|
1015
|
+
*/
|
|
801
1016
|
memberId?: string;
|
|
802
|
-
/**
|
|
1017
|
+
/**
|
|
1018
|
+
* 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).
|
|
1019
|
+
* @format GUID
|
|
1020
|
+
*/
|
|
803
1021
|
contactId?: string | null;
|
|
804
|
-
/**
|
|
1022
|
+
/**
|
|
1023
|
+
* Buyer email address.
|
|
1024
|
+
* @format EMAIL
|
|
1025
|
+
*/
|
|
805
1026
|
email?: string | null;
|
|
806
1027
|
}
|
|
807
1028
|
/** @oneof */
|
|
808
1029
|
export interface BuyerInfoIdOneOf {
|
|
809
|
-
/**
|
|
1030
|
+
/**
|
|
1031
|
+
* Visitor ID (if site visitor is not a member).
|
|
1032
|
+
* @format GUID
|
|
1033
|
+
*/
|
|
810
1034
|
visitorId?: string;
|
|
811
|
-
/**
|
|
1035
|
+
/**
|
|
1036
|
+
* Member ID (if site visitor is a site member).
|
|
1037
|
+
* @format GUID
|
|
1038
|
+
*/
|
|
812
1039
|
memberId?: string;
|
|
813
1040
|
}
|
|
814
1041
|
export interface AdditionalFeeDetails {
|
|
@@ -828,38 +1055,59 @@ export interface AdditionalFeeDetails {
|
|
|
828
1055
|
applied?: boolean;
|
|
829
1056
|
}
|
|
830
1057
|
export interface AdditionalFee {
|
|
831
|
-
/**
|
|
1058
|
+
/**
|
|
1059
|
+
* Additional fee's unique code for future processing.
|
|
1060
|
+
* @minLength 1
|
|
1061
|
+
* @maxLength 100
|
|
1062
|
+
*/
|
|
832
1063
|
code?: string | null;
|
|
833
|
-
/**
|
|
1064
|
+
/**
|
|
1065
|
+
* Name of additional fee.
|
|
1066
|
+
* @minLength 1
|
|
1067
|
+
* @maxLength 50
|
|
1068
|
+
*/
|
|
834
1069
|
name?: string;
|
|
835
1070
|
/** Additional fee's price. */
|
|
836
1071
|
price?: Price;
|
|
837
1072
|
/** Tax details. */
|
|
838
1073
|
taxDetails?: ItemTaxFullDetails;
|
|
839
|
-
/**
|
|
1074
|
+
/**
|
|
1075
|
+
* SPI implementer's `appId`.
|
|
1076
|
+
* @format GUID
|
|
1077
|
+
*/
|
|
840
1078
|
providerAppId?: string | null;
|
|
841
1079
|
/** Additional fee's price before tax. */
|
|
842
1080
|
priceBeforeTax?: Price;
|
|
843
1081
|
/** Additional fee's price after tax. */
|
|
844
1082
|
priceAfterTax?: Price;
|
|
845
|
-
/**
|
|
1083
|
+
/**
|
|
1084
|
+
* Additional fee's id.
|
|
1085
|
+
* @format GUID
|
|
1086
|
+
* @immutable
|
|
1087
|
+
*/
|
|
846
1088
|
_id?: string;
|
|
847
1089
|
/**
|
|
848
1090
|
* Optional - Line items associated with this additional fee.
|
|
849
1091
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
1092
|
+
* @format GUID
|
|
850
1093
|
*/
|
|
851
1094
|
lineItemIds?: string[];
|
|
852
1095
|
/**
|
|
853
1096
|
* Number of subscription billing cycles the additional fee applies to.
|
|
854
1097
|
* If None and additional fee is linked to subscription line item, it applies to all cycles.
|
|
855
1098
|
* @internal
|
|
1099
|
+
* @min 1
|
|
1100
|
+
* @max 999
|
|
856
1101
|
*/
|
|
857
1102
|
subscriptionCycles?: number | null;
|
|
858
1103
|
}
|
|
859
1104
|
export interface TaxDetails {
|
|
860
1105
|
/** Indication if additional fee is taxable or not */
|
|
861
1106
|
taxable?: boolean;
|
|
862
|
-
/**
|
|
1107
|
+
/**
|
|
1108
|
+
* Optional tax group ID to use when calculating tax for this additional fee
|
|
1109
|
+
* @format GUID
|
|
1110
|
+
*/
|
|
863
1111
|
taxGroupId?: string | null;
|
|
864
1112
|
}
|
|
865
1113
|
export declare enum SourceType {
|
|
@@ -901,18 +1149,26 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
901
1149
|
/**
|
|
902
1150
|
* IDs of line items discount applies to.
|
|
903
1151
|
* Deprecated. Use `line_item_discounts` instead.
|
|
1152
|
+
* @format GUID
|
|
1153
|
+
* @maxSize 1
|
|
904
1154
|
* @deprecated IDs of line items discount applies to.
|
|
905
1155
|
* Deprecated. Use `line_item_discounts` instead.
|
|
906
1156
|
* @replacedBy line_item_discounts
|
|
907
1157
|
* @targetRemovalDate 2024-10-30
|
|
908
1158
|
*/
|
|
909
1159
|
lineItemIds?: string[];
|
|
910
|
-
/**
|
|
1160
|
+
/**
|
|
1161
|
+
* Discount id.
|
|
1162
|
+
* @format GUID
|
|
1163
|
+
* @immutable
|
|
1164
|
+
*/
|
|
911
1165
|
_id?: string | null;
|
|
912
1166
|
/**
|
|
913
1167
|
* Number of subscription billing cycles the discount applies to.
|
|
914
1168
|
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
915
1169
|
* @internal
|
|
1170
|
+
* @min 1
|
|
1171
|
+
* @max 999
|
|
916
1172
|
*/
|
|
917
1173
|
subscriptionCycles?: number | null;
|
|
918
1174
|
}
|
|
@@ -947,13 +1203,18 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
947
1203
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
948
1204
|
*/
|
|
949
1205
|
discountReason?: DiscountReason;
|
|
950
|
-
/**
|
|
1206
|
+
/**
|
|
1207
|
+
* Discount description as free text (optional).
|
|
1208
|
+
* @maxLength 200
|
|
1209
|
+
*/
|
|
951
1210
|
description?: string | null;
|
|
952
1211
|
/** Discount amount. */
|
|
953
1212
|
amount?: Price;
|
|
954
1213
|
/**
|
|
955
1214
|
* Discount percentage.
|
|
956
1215
|
* @internal
|
|
1216
|
+
* @format DECIMAL_VALUE
|
|
1217
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
957
1218
|
*/
|
|
958
1219
|
percentage?: string | null;
|
|
959
1220
|
}
|
|
@@ -964,7 +1225,10 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
964
1225
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
965
1226
|
*/
|
|
966
1227
|
discountReason?: DiscountReason;
|
|
967
|
-
/**
|
|
1228
|
+
/**
|
|
1229
|
+
* Discount description as free text (optional).
|
|
1230
|
+
* @maxLength 200
|
|
1231
|
+
*/
|
|
968
1232
|
description?: string | null;
|
|
969
1233
|
}
|
|
970
1234
|
export declare enum DiscountReason {
|
|
@@ -972,7 +1236,10 @@ export declare enum DiscountReason {
|
|
|
972
1236
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
|
|
973
1237
|
}
|
|
974
1238
|
export interface DiscountRule {
|
|
975
|
-
/**
|
|
1239
|
+
/**
|
|
1240
|
+
* Discount rule ID
|
|
1241
|
+
* @format GUID
|
|
1242
|
+
*/
|
|
976
1243
|
_id?: string;
|
|
977
1244
|
/** Discount rule name */
|
|
978
1245
|
name?: DiscountRuleName;
|
|
@@ -980,28 +1247,51 @@ export interface DiscountRule {
|
|
|
980
1247
|
amount?: Price;
|
|
981
1248
|
}
|
|
982
1249
|
export interface DiscountRuleName {
|
|
983
|
-
/**
|
|
1250
|
+
/**
|
|
1251
|
+
* Original discount rule name (in site's default language).
|
|
1252
|
+
* @minLength 1
|
|
1253
|
+
* @maxLength 256
|
|
1254
|
+
*/
|
|
984
1255
|
original?: string;
|
|
985
|
-
/**
|
|
1256
|
+
/**
|
|
1257
|
+
* Translated discount rule name according to buyer language. Defaults to `original` when not provided.
|
|
1258
|
+
* @minLength 1
|
|
1259
|
+
* @maxLength 500
|
|
1260
|
+
*/
|
|
986
1261
|
translated?: string | null;
|
|
987
1262
|
}
|
|
988
1263
|
export interface LineItemDiscount {
|
|
989
|
-
/**
|
|
1264
|
+
/**
|
|
1265
|
+
* ID of line item the discount applies to.
|
|
1266
|
+
* @format GUID
|
|
1267
|
+
*/
|
|
990
1268
|
_id?: string;
|
|
991
1269
|
/** Total discount for this line item. */
|
|
992
1270
|
totalDiscount?: Price;
|
|
993
1271
|
}
|
|
994
1272
|
export interface CreatedBy extends CreatedByStringOneOf {
|
|
995
|
-
/**
|
|
1273
|
+
/**
|
|
1274
|
+
* User ID. When the draft order was created by a Wix user.
|
|
1275
|
+
* @format GUID
|
|
1276
|
+
*/
|
|
996
1277
|
userId?: string;
|
|
997
|
-
/**
|
|
1278
|
+
/**
|
|
1279
|
+
* App ID. When the draft order was created by an app.
|
|
1280
|
+
* @format GUID
|
|
1281
|
+
*/
|
|
998
1282
|
appId?: string;
|
|
999
1283
|
}
|
|
1000
1284
|
/** @oneof */
|
|
1001
1285
|
export interface CreatedByStringOneOf {
|
|
1002
|
-
/**
|
|
1286
|
+
/**
|
|
1287
|
+
* User ID. When the draft order was created by a Wix user.
|
|
1288
|
+
* @format GUID
|
|
1289
|
+
*/
|
|
1003
1290
|
userId?: string;
|
|
1004
|
-
/**
|
|
1291
|
+
/**
|
|
1292
|
+
* App ID. When the draft order was created by an app.
|
|
1293
|
+
* @format GUID
|
|
1294
|
+
*/
|
|
1005
1295
|
appId?: string;
|
|
1006
1296
|
}
|
|
1007
1297
|
export declare enum EditingStatus {
|
|
@@ -1063,6 +1353,7 @@ export interface Balance {
|
|
|
1063
1353
|
* Balance amount.
|
|
1064
1354
|
*
|
|
1065
1355
|
* 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.
|
|
1356
|
+
* @decimalValue options { }
|
|
1066
1357
|
* @readonly
|
|
1067
1358
|
*/
|
|
1068
1359
|
amount?: string;
|
|
@@ -1101,11 +1392,15 @@ export interface DraftOrderCommitSettings {
|
|
|
1101
1392
|
/**
|
|
1102
1393
|
* Line item IDs for which to perform an inventory change.
|
|
1103
1394
|
* When not provided, inventory will not change.
|
|
1395
|
+
* @maxSize 300
|
|
1104
1396
|
*/
|
|
1105
1397
|
updateInventory?: InventoryUpdate[];
|
|
1106
1398
|
}
|
|
1107
1399
|
export interface InventoryUpdate {
|
|
1108
|
-
/**
|
|
1400
|
+
/**
|
|
1401
|
+
* Line item ID.
|
|
1402
|
+
* @format GUID
|
|
1403
|
+
*/
|
|
1109
1404
|
lineItemId?: string;
|
|
1110
1405
|
}
|
|
1111
1406
|
export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
@@ -1134,7 +1429,10 @@ export interface RecipientInfoChangedDetails {
|
|
|
1134
1429
|
export interface OrderTaxInfo {
|
|
1135
1430
|
/** Calculated tax, added from line items. */
|
|
1136
1431
|
totalTax?: Price;
|
|
1137
|
-
/**
|
|
1432
|
+
/**
|
|
1433
|
+
* 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.
|
|
1434
|
+
* @maxSize 50
|
|
1435
|
+
*/
|
|
1138
1436
|
taxBreakdown?: OrderTaxBreakdown[];
|
|
1139
1437
|
/**
|
|
1140
1438
|
* Whether the order is exempt from tax calculations.
|
|
@@ -1149,15 +1447,28 @@ export interface OrderTaxInfo {
|
|
|
1149
1447
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1150
1448
|
*/
|
|
1151
1449
|
export interface OrderTaxBreakdown {
|
|
1152
|
-
/**
|
|
1450
|
+
/**
|
|
1451
|
+
* The name of the tax against which this tax amount was calculated.
|
|
1452
|
+
* @maxLength 200
|
|
1453
|
+
*/
|
|
1153
1454
|
taxName?: string;
|
|
1154
|
-
/**
|
|
1455
|
+
/**
|
|
1456
|
+
* The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
|
|
1457
|
+
* @maxLength 200
|
|
1458
|
+
*/
|
|
1155
1459
|
taxType?: string;
|
|
1156
|
-
/**
|
|
1460
|
+
/**
|
|
1461
|
+
* The name of the jurisdiction in which this tax detail applies.
|
|
1462
|
+
* @maxLength 200
|
|
1463
|
+
*/
|
|
1157
1464
|
jurisdiction?: string;
|
|
1158
1465
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1159
1466
|
jurisdictionType?: JurisdictionType;
|
|
1160
|
-
/**
|
|
1467
|
+
/**
|
|
1468
|
+
* The rate at which this tax detail was calculated.
|
|
1469
|
+
* @format DECIMAL_VALUE
|
|
1470
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
1471
|
+
*/
|
|
1161
1472
|
rate?: string;
|
|
1162
1473
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1163
1474
|
aggregatedTaxAmount?: Price;
|
|
@@ -1257,66 +1568,48 @@ export interface BillingChangedDetails {
|
|
|
1257
1568
|
billingInfoBeforeChange?: AddressWithContact;
|
|
1258
1569
|
}
|
|
1259
1570
|
export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1260
|
-
/**
|
|
1261
|
-
* Indicates that business location was added during draft.
|
|
1262
|
-
* @internal
|
|
1263
|
-
*/
|
|
1571
|
+
/** Indicates that business location was added during draft. */
|
|
1264
1572
|
added?: boolean;
|
|
1265
|
-
/**
|
|
1266
|
-
* Indicates that business location was changed. Contains business location before draft.
|
|
1267
|
-
* @internal
|
|
1268
|
-
*/
|
|
1573
|
+
/** Indicates that business location was changed. Contains business location before draft. */
|
|
1269
1574
|
changedDetails?: BusinessLocationChangedDetails;
|
|
1270
|
-
/**
|
|
1271
|
-
* Indicates that business location was removed during draft.
|
|
1272
|
-
* @internal
|
|
1273
|
-
*/
|
|
1575
|
+
/** Indicates that business location was removed during draft. */
|
|
1274
1576
|
removed?: boolean;
|
|
1275
|
-
/**
|
|
1276
|
-
* Business location.
|
|
1277
|
-
* @internal
|
|
1278
|
-
*/
|
|
1577
|
+
/** Business location. */
|
|
1279
1578
|
businessLocation?: Location;
|
|
1280
1579
|
}
|
|
1281
1580
|
/** @oneof */
|
|
1282
1581
|
export interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1283
|
-
/**
|
|
1284
|
-
* Indicates that business location was added during draft.
|
|
1285
|
-
* @internal
|
|
1286
|
-
*/
|
|
1582
|
+
/** Indicates that business location was added during draft. */
|
|
1287
1583
|
added?: boolean;
|
|
1288
|
-
/**
|
|
1289
|
-
* Indicates that business location was changed. Contains business location before draft.
|
|
1290
|
-
* @internal
|
|
1291
|
-
*/
|
|
1584
|
+
/** Indicates that business location was changed. Contains business location before draft. */
|
|
1292
1585
|
changedDetails?: BusinessLocationChangedDetails;
|
|
1293
|
-
/**
|
|
1294
|
-
* Indicates that business location was removed during draft.
|
|
1295
|
-
* @internal
|
|
1296
|
-
*/
|
|
1586
|
+
/** Indicates that business location was removed during draft. */
|
|
1297
1587
|
removed?: boolean;
|
|
1298
1588
|
}
|
|
1299
1589
|
export interface Location {
|
|
1300
1590
|
/**
|
|
1301
1591
|
* Location ID.
|
|
1302
1592
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1593
|
+
* @format GUID
|
|
1303
1594
|
*/
|
|
1304
1595
|
_id?: string;
|
|
1305
1596
|
/**
|
|
1306
1597
|
* Location name.
|
|
1598
|
+
* @minLength 1
|
|
1599
|
+
* @maxLength 500
|
|
1307
1600
|
* @readonly
|
|
1308
1601
|
*/
|
|
1309
1602
|
name?: string;
|
|
1310
1603
|
}
|
|
1311
1604
|
export interface BusinessLocationChangedDetails {
|
|
1312
|
-
/**
|
|
1313
|
-
* Business location before draft.
|
|
1314
|
-
* @internal
|
|
1315
|
-
*/
|
|
1605
|
+
/** Business location before draft. */
|
|
1316
1606
|
businessLocationBeforeChange?: Location;
|
|
1317
1607
|
}
|
|
1318
1608
|
export interface CreateDraftOrderRequest {
|
|
1319
|
-
/**
|
|
1609
|
+
/**
|
|
1610
|
+
* To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
|
|
1611
|
+
* @format GUID
|
|
1612
|
+
*/
|
|
1320
1613
|
orderId: string | null;
|
|
1321
1614
|
}
|
|
1322
1615
|
export interface CreateDraftOrderResponse {
|
|
@@ -1340,7 +1633,10 @@ export interface CalculatedDraftOrder {
|
|
|
1340
1633
|
calculationErrors?: CalculationErrors;
|
|
1341
1634
|
}
|
|
1342
1635
|
export interface ShippingOption {
|
|
1343
|
-
/**
|
|
1636
|
+
/**
|
|
1637
|
+
* This carrier's unique ID
|
|
1638
|
+
* @format GUID
|
|
1639
|
+
*/
|
|
1344
1640
|
carrierId?: string | null;
|
|
1345
1641
|
/** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
|
|
1346
1642
|
code?: string;
|
|
@@ -1387,7 +1683,10 @@ export interface DeliveryTimeSlot {
|
|
|
1387
1683
|
export interface ShippingPrice {
|
|
1388
1684
|
/** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
|
|
1389
1685
|
price?: Price;
|
|
1390
|
-
/**
|
|
1686
|
+
/**
|
|
1687
|
+
* 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.
|
|
1688
|
+
* @format CURRENCY
|
|
1689
|
+
*/
|
|
1391
1690
|
currency?: string;
|
|
1392
1691
|
}
|
|
1393
1692
|
export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
@@ -1518,29 +1817,47 @@ export interface CreateEmptyDraftOrderResponse {
|
|
|
1518
1817
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1519
1818
|
}
|
|
1520
1819
|
export interface AddLineItemsToDraftOrderRequest {
|
|
1521
|
-
/**
|
|
1820
|
+
/**
|
|
1821
|
+
* The draft order id
|
|
1822
|
+
* @format GUID
|
|
1823
|
+
*/
|
|
1522
1824
|
draftOrderId: string;
|
|
1523
|
-
/**
|
|
1825
|
+
/**
|
|
1826
|
+
* Catalog line items to add to draft order.
|
|
1827
|
+
* @maxSize 300
|
|
1828
|
+
*/
|
|
1524
1829
|
catalogLineItems?: CatalogReferenceLineItem[];
|
|
1525
|
-
/**
|
|
1830
|
+
/**
|
|
1831
|
+
* Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
|
|
1832
|
+
* @maxSize 300
|
|
1833
|
+
*/
|
|
1526
1834
|
customLineItems?: CustomLineItem[];
|
|
1527
1835
|
}
|
|
1528
1836
|
export interface CatalogReferenceLineItem {
|
|
1529
1837
|
/** 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. */
|
|
1530
1838
|
catalogReference?: CatalogReference;
|
|
1531
|
-
/**
|
|
1839
|
+
/**
|
|
1840
|
+
* Item quantity.
|
|
1841
|
+
* @min 1
|
|
1842
|
+
* @max 100000
|
|
1843
|
+
*/
|
|
1532
1844
|
quantity?: number;
|
|
1533
1845
|
/** Item price override. */
|
|
1534
1846
|
price?: Price;
|
|
1535
1847
|
}
|
|
1536
1848
|
export interface CustomLineItem {
|
|
1537
|
-
/**
|
|
1849
|
+
/**
|
|
1850
|
+
* Line item ID.
|
|
1851
|
+
* @format GUID
|
|
1852
|
+
*/
|
|
1538
1853
|
_id?: string | null;
|
|
1539
1854
|
/**
|
|
1540
1855
|
* Item quantity.
|
|
1541
1856
|
*
|
|
1542
1857
|
* Min: `"1"`
|
|
1543
1858
|
* Max: `"100000"`
|
|
1859
|
+
* @min 1
|
|
1860
|
+
* @max 100000
|
|
1544
1861
|
*/
|
|
1545
1862
|
quantity?: number;
|
|
1546
1863
|
/** 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. */
|
|
@@ -1572,13 +1889,24 @@ export interface CustomLineItem {
|
|
|
1572
1889
|
itemType?: ItemType;
|
|
1573
1890
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1574
1891
|
priceDescription?: PriceDescription;
|
|
1575
|
-
/**
|
|
1892
|
+
/**
|
|
1893
|
+
* Delivery Profile Id for the product
|
|
1894
|
+
* @format GUID
|
|
1895
|
+
*/
|
|
1576
1896
|
deliveryProfileId?: string | null;
|
|
1577
1897
|
}
|
|
1578
1898
|
export interface SecuredMedia {
|
|
1579
|
-
/**
|
|
1899
|
+
/**
|
|
1900
|
+
* Media ID in Wix Media Manager.
|
|
1901
|
+
* @minLength 1
|
|
1902
|
+
* @maxLength 100
|
|
1903
|
+
*/
|
|
1580
1904
|
_id?: string;
|
|
1581
|
-
/**
|
|
1905
|
+
/**
|
|
1906
|
+
* Original filename.
|
|
1907
|
+
* @minLength 1
|
|
1908
|
+
* @maxLength 1000
|
|
1909
|
+
*/
|
|
1582
1910
|
fileName?: string;
|
|
1583
1911
|
/** File type. */
|
|
1584
1912
|
fileType?: FileType;
|
|
@@ -1596,17 +1924,33 @@ export interface AddLineItemsToDraftOrderResponse {
|
|
|
1596
1924
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1597
1925
|
}
|
|
1598
1926
|
export interface UpdateLineItemsRequest {
|
|
1599
|
-
/**
|
|
1927
|
+
/**
|
|
1928
|
+
* The draft order id
|
|
1929
|
+
* @format GUID
|
|
1930
|
+
*/
|
|
1600
1931
|
draftOrderId: string;
|
|
1601
|
-
/**
|
|
1932
|
+
/**
|
|
1933
|
+
* Details of changes to apply per line item
|
|
1934
|
+
* @minSize 1
|
|
1935
|
+
* @maxSize 300
|
|
1936
|
+
*/
|
|
1602
1937
|
lineItemChanges?: LineItemChangeDetails[];
|
|
1603
1938
|
}
|
|
1604
1939
|
export interface LineItemChangeDetails {
|
|
1605
|
-
/**
|
|
1940
|
+
/**
|
|
1941
|
+
* The line item id to change
|
|
1942
|
+
* @format GUID
|
|
1943
|
+
*/
|
|
1606
1944
|
lineItemId?: string;
|
|
1607
|
-
/**
|
|
1945
|
+
/**
|
|
1946
|
+
* The new quantity for the line item. quantity zero means to remove the line item.
|
|
1947
|
+
* @max 1000000
|
|
1948
|
+
*/
|
|
1608
1949
|
newQuantity?: number | null;
|
|
1609
|
-
/**
|
|
1950
|
+
/**
|
|
1951
|
+
* The new price for 1 unit of the line item
|
|
1952
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
1953
|
+
*/
|
|
1610
1954
|
newPrice?: string | null;
|
|
1611
1955
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1612
1956
|
newPriceDescription?: PriceDescription;
|
|
@@ -1616,9 +1960,15 @@ export interface UpdateLineItemsResponse {
|
|
|
1616
1960
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1617
1961
|
}
|
|
1618
1962
|
export interface SetDiscountsRequest {
|
|
1619
|
-
/**
|
|
1963
|
+
/**
|
|
1964
|
+
* The draft order id
|
|
1965
|
+
* @format GUID
|
|
1966
|
+
*/
|
|
1620
1967
|
draftOrderId: string;
|
|
1621
|
-
/**
|
|
1968
|
+
/**
|
|
1969
|
+
* The discount ids to opt-in. all existing discounts not listed are to be opted-out.
|
|
1970
|
+
* @minSize 1
|
|
1971
|
+
*/
|
|
1622
1972
|
discounts: IdAndApplied[];
|
|
1623
1973
|
}
|
|
1624
1974
|
export interface IdAndApplied {
|
|
@@ -1632,9 +1982,16 @@ export interface SetDiscountsResponse {
|
|
|
1632
1982
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1633
1983
|
}
|
|
1634
1984
|
export interface CreateCustomDiscountsRequest {
|
|
1635
|
-
/**
|
|
1985
|
+
/**
|
|
1986
|
+
* The draft order id
|
|
1987
|
+
* @format GUID
|
|
1988
|
+
*/
|
|
1636
1989
|
draftOrderId: string;
|
|
1637
|
-
/**
|
|
1990
|
+
/**
|
|
1991
|
+
* The discounts to add.
|
|
1992
|
+
* @minSize 1
|
|
1993
|
+
* @maxSize 100
|
|
1994
|
+
*/
|
|
1638
1995
|
discounts?: DiscountOption[];
|
|
1639
1996
|
}
|
|
1640
1997
|
export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
@@ -1646,6 +2003,8 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1646
2003
|
/**
|
|
1647
2004
|
* Discount percentage amount.
|
|
1648
2005
|
* @internal
|
|
2006
|
+
* @format DECIMAL_VALUE
|
|
2007
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1649
2008
|
*/
|
|
1650
2009
|
percentage?: string | null;
|
|
1651
2010
|
/**
|
|
@@ -1657,6 +2016,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1657
2016
|
discountType?: DiscountType;
|
|
1658
2017
|
/**
|
|
1659
2018
|
* ID of line item discount applies to.
|
|
2019
|
+
* @format GUID
|
|
1660
2020
|
* @deprecated ID of line item discount applies to.
|
|
1661
2021
|
* @replacedBy line_item_discounts
|
|
1662
2022
|
* @targetRemovalDate 2024-10-30
|
|
@@ -1669,7 +2029,10 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1669
2029
|
* @targetRemovalDate 2024-08-30
|
|
1670
2030
|
*/
|
|
1671
2031
|
amount?: Price;
|
|
1672
|
-
/**
|
|
2032
|
+
/**
|
|
2033
|
+
* Discount description as free text (optional).
|
|
2034
|
+
* @maxLength 200
|
|
2035
|
+
*/
|
|
1673
2036
|
description?: string | null;
|
|
1674
2037
|
/**
|
|
1675
2038
|
* Should opt-in the added discount. default = false.
|
|
@@ -1687,6 +2050,8 @@ export interface DiscountOptionDiscountAmountOneOf {
|
|
|
1687
2050
|
/**
|
|
1688
2051
|
* Discount percentage amount.
|
|
1689
2052
|
* @internal
|
|
2053
|
+
* @format DECIMAL_VALUE
|
|
2054
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1690
2055
|
*/
|
|
1691
2056
|
percentage?: string | null;
|
|
1692
2057
|
}
|
|
@@ -1701,9 +2066,17 @@ export interface CreateCustomDiscountsResponse {
|
|
|
1701
2066
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1702
2067
|
}
|
|
1703
2068
|
export interface DeleteCustomDiscountsRequest {
|
|
1704
|
-
/**
|
|
2069
|
+
/**
|
|
2070
|
+
* The draft order id
|
|
2071
|
+
* @format GUID
|
|
2072
|
+
*/
|
|
1705
2073
|
draftOrderId: string;
|
|
1706
|
-
/**
|
|
2074
|
+
/**
|
|
2075
|
+
* The discounts to remove
|
|
2076
|
+
* @format GUID
|
|
2077
|
+
* @minSize 1
|
|
2078
|
+
* @maxSize 100
|
|
2079
|
+
*/
|
|
1707
2080
|
discountIds: string[];
|
|
1708
2081
|
}
|
|
1709
2082
|
export interface DeleteCustomDiscountsResponse {
|
|
@@ -1711,9 +2084,16 @@ export interface DeleteCustomDiscountsResponse {
|
|
|
1711
2084
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1712
2085
|
}
|
|
1713
2086
|
export interface SetAdditionalFeesRequest {
|
|
1714
|
-
/**
|
|
2087
|
+
/**
|
|
2088
|
+
* The draft order id
|
|
2089
|
+
* @format GUID
|
|
2090
|
+
*/
|
|
1715
2091
|
draftOrderId: string;
|
|
1716
|
-
/**
|
|
2092
|
+
/**
|
|
2093
|
+
* The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
|
|
2094
|
+
* @minSize 1
|
|
2095
|
+
* @maxSize 100
|
|
2096
|
+
*/
|
|
1717
2097
|
additionalFees: IdAndApplied[];
|
|
1718
2098
|
}
|
|
1719
2099
|
export interface SetAdditionalFeesResponse {
|
|
@@ -1721,13 +2101,24 @@ export interface SetAdditionalFeesResponse {
|
|
|
1721
2101
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1722
2102
|
}
|
|
1723
2103
|
export interface CreateCustomAdditionalFeesRequest {
|
|
1724
|
-
/**
|
|
2104
|
+
/**
|
|
2105
|
+
* The draft order id
|
|
2106
|
+
* @format GUID
|
|
2107
|
+
*/
|
|
1725
2108
|
draftOrderId: string;
|
|
1726
|
-
/**
|
|
2109
|
+
/**
|
|
2110
|
+
* The additional fees to add. added with opted-out setting
|
|
2111
|
+
* @minSize 1
|
|
2112
|
+
* @maxSize 100
|
|
2113
|
+
*/
|
|
1727
2114
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
1728
2115
|
}
|
|
1729
2116
|
export interface AdditionalFeeOption {
|
|
1730
|
-
/**
|
|
2117
|
+
/**
|
|
2118
|
+
* Translated additional fee's name
|
|
2119
|
+
* @minLength 1
|
|
2120
|
+
* @maxLength 50
|
|
2121
|
+
*/
|
|
1731
2122
|
name?: string;
|
|
1732
2123
|
/** Additional fee's price */
|
|
1733
2124
|
price?: Price;
|
|
@@ -1738,7 +2129,11 @@ export interface AdditionalFeeOption {
|
|
|
1738
2129
|
* if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee ids
|
|
1739
2130
|
*/
|
|
1740
2131
|
applyToDraftOrder?: boolean | null;
|
|
1741
|
-
/**
|
|
2132
|
+
/**
|
|
2133
|
+
* Additional fee's unique code (or ID) for future processing
|
|
2134
|
+
* @minLength 1
|
|
2135
|
+
* @maxLength 100
|
|
2136
|
+
*/
|
|
1742
2137
|
code?: string | null;
|
|
1743
2138
|
}
|
|
1744
2139
|
export interface CreateCustomAdditionalFeesResponse {
|
|
@@ -1746,9 +2141,17 @@ export interface CreateCustomAdditionalFeesResponse {
|
|
|
1746
2141
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1747
2142
|
}
|
|
1748
2143
|
export interface DeleteCustomAdditionalFeesRequest {
|
|
1749
|
-
/**
|
|
2144
|
+
/**
|
|
2145
|
+
* The draft order id
|
|
2146
|
+
* @format GUID
|
|
2147
|
+
*/
|
|
1750
2148
|
draftOrderId: string;
|
|
1751
|
-
/**
|
|
2149
|
+
/**
|
|
2150
|
+
* The additional fees to remove
|
|
2151
|
+
* @format GUID
|
|
2152
|
+
* @minSize 1
|
|
2153
|
+
* @maxSize 100
|
|
2154
|
+
*/
|
|
1752
2155
|
customAdditionalFees: string[];
|
|
1753
2156
|
}
|
|
1754
2157
|
export interface DeleteCustomAdditionalFeesResponse {
|
|
@@ -1759,6 +2162,7 @@ export interface SetShippingInfoRequest {
|
|
|
1759
2162
|
/**
|
|
1760
2163
|
* The draft order id
|
|
1761
2164
|
* @internal
|
|
2165
|
+
* @format GUID
|
|
1762
2166
|
*/
|
|
1763
2167
|
draftOrderId: string;
|
|
1764
2168
|
/**
|
|
@@ -1778,6 +2182,7 @@ export interface SetBuyerInfoRequest {
|
|
|
1778
2182
|
/**
|
|
1779
2183
|
* The draft order id
|
|
1780
2184
|
* @internal
|
|
2185
|
+
* @format GUID
|
|
1781
2186
|
*/
|
|
1782
2187
|
draftOrderId: string;
|
|
1783
2188
|
/**
|
|
@@ -1797,6 +2202,7 @@ export interface SetRecipientInfoRequest {
|
|
|
1797
2202
|
/**
|
|
1798
2203
|
* The draft order id
|
|
1799
2204
|
* @internal
|
|
2205
|
+
* @format GUID
|
|
1800
2206
|
*/
|
|
1801
2207
|
draftOrderId: string;
|
|
1802
2208
|
/**
|
|
@@ -1816,6 +2222,7 @@ export interface SetBillingInfoRequest {
|
|
|
1816
2222
|
/**
|
|
1817
2223
|
* The draft order id
|
|
1818
2224
|
* @internal
|
|
2225
|
+
* @format GUID
|
|
1819
2226
|
*/
|
|
1820
2227
|
draftOrderId: string;
|
|
1821
2228
|
/**
|
|
@@ -1832,7 +2239,10 @@ export interface SetBillingInfoResponse {
|
|
|
1832
2239
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1833
2240
|
}
|
|
1834
2241
|
export interface UpdateShippingInfoRequest {
|
|
1835
|
-
/**
|
|
2242
|
+
/**
|
|
2243
|
+
* The draft order id
|
|
2244
|
+
* @format GUID
|
|
2245
|
+
*/
|
|
1836
2246
|
draftOrderId?: string;
|
|
1837
2247
|
/** update the shipping option on the order. if not set then the selected shipping is removed */
|
|
1838
2248
|
shippingOption?: ShippingOption;
|
|
@@ -1842,7 +2252,10 @@ export interface UpdateShippingInfoResponse {
|
|
|
1842
2252
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1843
2253
|
}
|
|
1844
2254
|
export interface GetDraftOrderRequest {
|
|
1845
|
-
/**
|
|
2255
|
+
/**
|
|
2256
|
+
* The draft order id
|
|
2257
|
+
* @format GUID
|
|
2258
|
+
*/
|
|
1846
2259
|
draftOrderId: string;
|
|
1847
2260
|
}
|
|
1848
2261
|
export interface GetDraftOrderResponse {
|
|
@@ -1850,15 +2263,26 @@ export interface GetDraftOrderResponse {
|
|
|
1850
2263
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1851
2264
|
}
|
|
1852
2265
|
export interface GetOrderDraftabilityStatusRequest {
|
|
1853
|
-
/**
|
|
2266
|
+
/**
|
|
2267
|
+
* Order ID.
|
|
2268
|
+
* @minLength 1
|
|
2269
|
+
* @maxLength 100
|
|
2270
|
+
*/
|
|
1854
2271
|
orderId: string;
|
|
1855
2272
|
}
|
|
1856
2273
|
export interface GetOrderDraftabilityStatusResponse {
|
|
1857
|
-
/**
|
|
2274
|
+
/**
|
|
2275
|
+
* Order ID.
|
|
2276
|
+
* @minLength 1
|
|
2277
|
+
* @maxLength 100
|
|
2278
|
+
*/
|
|
1858
2279
|
orderId?: string;
|
|
1859
2280
|
/** Whether a draft can be created from this order */
|
|
1860
2281
|
orderDraftable?: boolean;
|
|
1861
|
-
/**
|
|
2282
|
+
/**
|
|
2283
|
+
* Reasons why the order is not draftable
|
|
2284
|
+
* @maxSize 5
|
|
2285
|
+
*/
|
|
1862
2286
|
nonDraftableReasons?: NonDraftableReason[];
|
|
1863
2287
|
}
|
|
1864
2288
|
export declare enum NonDraftableReason {
|
|
@@ -1876,11 +2300,17 @@ export declare enum NonDraftableReason {
|
|
|
1876
2300
|
TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
|
|
1877
2301
|
}
|
|
1878
2302
|
export interface CommitDraftOrderRequest {
|
|
1879
|
-
/**
|
|
2303
|
+
/**
|
|
2304
|
+
* The draft order id
|
|
2305
|
+
* @format GUID
|
|
2306
|
+
*/
|
|
1880
2307
|
draftOrderId: string;
|
|
1881
2308
|
/** Optional side effects to trigger */
|
|
1882
2309
|
commitSettings?: DraftOrderCommitSettings;
|
|
1883
|
-
/**
|
|
2310
|
+
/**
|
|
2311
|
+
* Reason for edit, given by user (optional).
|
|
2312
|
+
* @maxLength 200
|
|
2313
|
+
*/
|
|
1884
2314
|
reason?: string | null;
|
|
1885
2315
|
}
|
|
1886
2316
|
export interface CommitDraftOrderResponse {
|
|
@@ -1892,6 +2322,7 @@ export interface CommitDraftOrderResponse {
|
|
|
1892
2322
|
export interface Order {
|
|
1893
2323
|
/**
|
|
1894
2324
|
* Order ID.
|
|
2325
|
+
* @format GUID
|
|
1895
2326
|
* @readonly
|
|
1896
2327
|
*/
|
|
1897
2328
|
_id?: string | null;
|
|
@@ -1903,6 +2334,7 @@ export interface Order {
|
|
|
1903
2334
|
/**
|
|
1904
2335
|
* Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
1905
2336
|
* @readonly
|
|
2337
|
+
* @immutable
|
|
1906
2338
|
*/
|
|
1907
2339
|
_createdDate?: Date | null;
|
|
1908
2340
|
/**
|
|
@@ -1912,6 +2344,8 @@ export interface Order {
|
|
|
1912
2344
|
_updatedDate?: Date | null;
|
|
1913
2345
|
/**
|
|
1914
2346
|
* Order line items.
|
|
2347
|
+
* @minSize 1
|
|
2348
|
+
* @maxSize 300
|
|
1915
2349
|
* @readonly
|
|
1916
2350
|
*/
|
|
1917
2351
|
lineItems?: OrderLineItem[];
|
|
@@ -1931,13 +2365,20 @@ export interface Order {
|
|
|
1931
2365
|
buyerLanguage?: string | null;
|
|
1932
2366
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
1933
2367
|
weightUnit?: WeightUnit;
|
|
1934
|
-
/**
|
|
2368
|
+
/**
|
|
2369
|
+
* 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.
|
|
2370
|
+
* @format CURRENCY
|
|
2371
|
+
*/
|
|
1935
2372
|
currency?: string | null;
|
|
1936
|
-
/**
|
|
2373
|
+
/**
|
|
2374
|
+
* Whether tax is included in line item prices.
|
|
2375
|
+
* @immutable
|
|
2376
|
+
*/
|
|
1937
2377
|
taxIncludedInPrices?: boolean;
|
|
1938
2378
|
/**
|
|
1939
2379
|
* Site language in which original values are shown.
|
|
1940
2380
|
* @readonly
|
|
2381
|
+
* @immutable
|
|
1941
2382
|
*/
|
|
1942
2383
|
siteLanguage?: string | null;
|
|
1943
2384
|
/**
|
|
@@ -1949,7 +2390,10 @@ export interface Order {
|
|
|
1949
2390
|
billingInfo?: AddressWithContact;
|
|
1950
2391
|
/** Shipping info and selected shipping option details. */
|
|
1951
2392
|
shippingInfo?: V1ShippingInformation;
|
|
1952
|
-
/**
|
|
2393
|
+
/**
|
|
2394
|
+
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
2395
|
+
* @maxLength 1000
|
|
2396
|
+
*/
|
|
1953
2397
|
buyerNote?: string | null;
|
|
1954
2398
|
/** Order status. */
|
|
1955
2399
|
status?: OrderStatus;
|
|
@@ -1968,11 +2412,15 @@ export interface Order {
|
|
|
1968
2412
|
taxSummary?: TaxSummary;
|
|
1969
2413
|
/** Tax information. */
|
|
1970
2414
|
taxInfo?: OrderTaxInfo;
|
|
1971
|
-
/**
|
|
2415
|
+
/**
|
|
2416
|
+
* Applied discounts.
|
|
2417
|
+
* @maxSize 320
|
|
2418
|
+
*/
|
|
1972
2419
|
appliedDiscounts?: AppliedDiscount[];
|
|
1973
2420
|
/**
|
|
1974
2421
|
* Order activities.
|
|
1975
2422
|
* @readonly
|
|
2423
|
+
* @maxSize 1000
|
|
1976
2424
|
*/
|
|
1977
2425
|
activities?: Activity[];
|
|
1978
2426
|
/** Order attribution source. */
|
|
@@ -1986,7 +2434,10 @@ export interface Order {
|
|
|
1986
2434
|
channelInfo?: ChannelInfo;
|
|
1987
2435
|
/** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
|
|
1988
2436
|
seenByAHuman?: boolean | null;
|
|
1989
|
-
/**
|
|
2437
|
+
/**
|
|
2438
|
+
* Checkout ID.
|
|
2439
|
+
* @format GUID
|
|
2440
|
+
*/
|
|
1990
2441
|
checkoutId?: string | null;
|
|
1991
2442
|
/** Custom fields. */
|
|
1992
2443
|
customFields?: CustomField[];
|
|
@@ -1995,7 +2446,10 @@ export interface Order {
|
|
|
1995
2446
|
* @readonly
|
|
1996
2447
|
*/
|
|
1997
2448
|
balanceSummary?: V1BalanceSummary;
|
|
1998
|
-
/**
|
|
2449
|
+
/**
|
|
2450
|
+
* Additional fees applied to the order.
|
|
2451
|
+
* @maxSize 100
|
|
2452
|
+
*/
|
|
1999
2453
|
additionalFees?: AdditionalFee[];
|
|
2000
2454
|
/**
|
|
2001
2455
|
* Custom field data for the order object.
|
|
@@ -2003,7 +2457,10 @@ export interface Order {
|
|
|
2003
2457
|
* [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.
|
|
2004
2458
|
*/
|
|
2005
2459
|
extendedFields?: ExtendedFields;
|
|
2006
|
-
/**
|
|
2460
|
+
/**
|
|
2461
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
2462
|
+
* @format GUID
|
|
2463
|
+
*/
|
|
2007
2464
|
purchaseFlowId?: string | null;
|
|
2008
2465
|
/**
|
|
2009
2466
|
* Order recipient address and contact details.
|
|
@@ -2016,8 +2473,11 @@ export interface Order {
|
|
|
2016
2473
|
/**
|
|
2017
2474
|
* Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2018
2475
|
* Used for migration from external systems.
|
|
2476
|
+
* @immutable
|
|
2019
2477
|
*/
|
|
2020
2478
|
purchasedDate?: Date | null;
|
|
2479
|
+
/** Order Location */
|
|
2480
|
+
businessLocation?: Location;
|
|
2021
2481
|
/**
|
|
2022
2482
|
* Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
|
|
2023
2483
|
* @internal
|
|
@@ -2165,11 +2625,13 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2165
2625
|
receiptSent?: ReceiptSent;
|
|
2166
2626
|
/**
|
|
2167
2627
|
* Activity ID.
|
|
2628
|
+
* @format GUID
|
|
2168
2629
|
* @readonly
|
|
2169
2630
|
*/
|
|
2170
2631
|
_id?: string | null;
|
|
2171
2632
|
/**
|
|
2172
2633
|
* Activity author's email.
|
|
2634
|
+
* @format EMAIL
|
|
2173
2635
|
* @readonly
|
|
2174
2636
|
*/
|
|
2175
2637
|
authorEmail?: string | null;
|
|
@@ -2245,16 +2707,26 @@ export interface ActivityContentOneOf {
|
|
|
2245
2707
|
receiptSent?: ReceiptSent;
|
|
2246
2708
|
}
|
|
2247
2709
|
export interface CustomActivity {
|
|
2248
|
-
/**
|
|
2710
|
+
/**
|
|
2711
|
+
* ID of the app that created the custom activity.
|
|
2712
|
+
* @format GUID
|
|
2713
|
+
*/
|
|
2249
2714
|
appId?: string;
|
|
2250
|
-
/**
|
|
2715
|
+
/**
|
|
2716
|
+
* Custom activity type. For example, `"Ticket number set"`.
|
|
2717
|
+
* @maxLength 100
|
|
2718
|
+
*/
|
|
2251
2719
|
type?: string;
|
|
2252
2720
|
/** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
|
|
2253
2721
|
additionalData?: Record<string, string>;
|
|
2254
2722
|
}
|
|
2255
2723
|
/** Store owner added a comment */
|
|
2256
2724
|
export interface MerchantComment {
|
|
2257
|
-
/**
|
|
2725
|
+
/**
|
|
2726
|
+
* Merchant comment message.
|
|
2727
|
+
* @minLength 1
|
|
2728
|
+
* @maxLength 5000
|
|
2729
|
+
*/
|
|
2258
2730
|
message?: string;
|
|
2259
2731
|
}
|
|
2260
2732
|
export interface OrderRefunded {
|
|
@@ -2262,29 +2734,52 @@ export interface OrderRefunded {
|
|
|
2262
2734
|
manual?: boolean;
|
|
2263
2735
|
/** Refund amount. */
|
|
2264
2736
|
amount?: Price;
|
|
2265
|
-
/**
|
|
2737
|
+
/**
|
|
2738
|
+
* Reason for refund.
|
|
2739
|
+
* @maxLength 200
|
|
2740
|
+
*/
|
|
2266
2741
|
reason?: string;
|
|
2267
2742
|
}
|
|
2268
2743
|
export interface OrderCreatedFromExchange {
|
|
2269
|
-
/**
|
|
2744
|
+
/**
|
|
2745
|
+
* ID of the original order for which the exchange happened.
|
|
2746
|
+
* @format GUID
|
|
2747
|
+
*/
|
|
2270
2748
|
originalOrderId?: string;
|
|
2271
2749
|
}
|
|
2272
2750
|
export interface NewExchangeOrderCreated {
|
|
2273
|
-
/**
|
|
2751
|
+
/**
|
|
2752
|
+
* ID of the new order created as a result of an exchange of items.
|
|
2753
|
+
* @format GUID
|
|
2754
|
+
*/
|
|
2274
2755
|
exchangeOrderId?: string;
|
|
2275
|
-
/**
|
|
2756
|
+
/**
|
|
2757
|
+
* IDs of the items that were exchanged.
|
|
2758
|
+
* @minSize 1
|
|
2759
|
+
* @maxSize 300
|
|
2760
|
+
*/
|
|
2276
2761
|
lineItems?: LineItemExchangeData[];
|
|
2277
2762
|
}
|
|
2278
2763
|
export interface LineItemExchangeData {
|
|
2279
|
-
/**
|
|
2764
|
+
/**
|
|
2765
|
+
* ID of the exchanged line item.
|
|
2766
|
+
* @format GUID
|
|
2767
|
+
*/
|
|
2280
2768
|
lineItemId?: string;
|
|
2281
|
-
/**
|
|
2769
|
+
/**
|
|
2770
|
+
* Line item quantity being exchanged.
|
|
2771
|
+
* @min 1
|
|
2772
|
+
* @max 100000
|
|
2773
|
+
*/
|
|
2282
2774
|
quantity?: number;
|
|
2283
2775
|
}
|
|
2284
2776
|
export interface DraftOrderChangesApplied {
|
|
2285
2777
|
/** Draft order id. */
|
|
2286
2778
|
draftOrderId?: string;
|
|
2287
|
-
/**
|
|
2779
|
+
/**
|
|
2780
|
+
* Reason for edit, given by user (optional).
|
|
2781
|
+
* @maxLength 200
|
|
2782
|
+
*/
|
|
2288
2783
|
reason?: string | null;
|
|
2289
2784
|
/** Changes applied to order. */
|
|
2290
2785
|
changes?: OrderChange[];
|
|
@@ -2313,7 +2808,10 @@ export interface OrderChangeValueOneOf {
|
|
|
2313
2808
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2314
2809
|
}
|
|
2315
2810
|
export interface LineItemChanges {
|
|
2316
|
-
/**
|
|
2811
|
+
/**
|
|
2812
|
+
* Line item ID.
|
|
2813
|
+
* @format GUID
|
|
2814
|
+
*/
|
|
2317
2815
|
_id?: string;
|
|
2318
2816
|
/** Item name. */
|
|
2319
2817
|
name?: ProductName;
|
|
@@ -2323,11 +2821,21 @@ export interface LineItemChanges {
|
|
|
2323
2821
|
price?: LineItemPriceChange;
|
|
2324
2822
|
}
|
|
2325
2823
|
export interface LineItemQuantityChange {
|
|
2326
|
-
/**
|
|
2824
|
+
/**
|
|
2825
|
+
* Item quantity before update.
|
|
2826
|
+
* @max 1000000
|
|
2827
|
+
*/
|
|
2327
2828
|
originalQuantity?: number;
|
|
2328
|
-
/**
|
|
2829
|
+
/**
|
|
2830
|
+
* Item quantity after update.
|
|
2831
|
+
* @max 1000000
|
|
2832
|
+
*/
|
|
2329
2833
|
newQuantity?: number;
|
|
2330
|
-
/**
|
|
2834
|
+
/**
|
|
2835
|
+
* Difference between original and new quantity. Absolute value.
|
|
2836
|
+
* @min 1
|
|
2837
|
+
* @max 1000000
|
|
2838
|
+
*/
|
|
2331
2839
|
diff?: number;
|
|
2332
2840
|
/** Type of quantity change: increase or decrease. */
|
|
2333
2841
|
deltaType?: LineItemQuantityChangeType;
|
|
@@ -2345,15 +2853,25 @@ export interface LineItemPriceChange {
|
|
|
2345
2853
|
newPrice?: Price;
|
|
2346
2854
|
}
|
|
2347
2855
|
export interface ManagedLineItem {
|
|
2348
|
-
/**
|
|
2856
|
+
/**
|
|
2857
|
+
* Line item ID.
|
|
2858
|
+
* @format GUID
|
|
2859
|
+
*/
|
|
2349
2860
|
_id?: string;
|
|
2350
2861
|
/** Item name. */
|
|
2351
2862
|
name?: ProductName;
|
|
2352
|
-
/**
|
|
2863
|
+
/**
|
|
2864
|
+
* Added or removed item quantity.
|
|
2865
|
+
* @min 1
|
|
2866
|
+
* @max 1000000
|
|
2867
|
+
*/
|
|
2353
2868
|
quantity?: number;
|
|
2354
2869
|
}
|
|
2355
2870
|
export interface ManagedDiscount {
|
|
2356
|
-
/**
|
|
2871
|
+
/**
|
|
2872
|
+
* Discount id.
|
|
2873
|
+
* @format GUID
|
|
2874
|
+
*/
|
|
2357
2875
|
_id?: string;
|
|
2358
2876
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2359
2877
|
name?: TranslatedValue;
|
|
@@ -2363,13 +2881,22 @@ export interface ManagedDiscount {
|
|
|
2363
2881
|
totalAmount?: Price;
|
|
2364
2882
|
}
|
|
2365
2883
|
export interface TranslatedValue {
|
|
2366
|
-
/**
|
|
2884
|
+
/**
|
|
2885
|
+
* Value in site default language.
|
|
2886
|
+
* @minLength 1
|
|
2887
|
+
*/
|
|
2367
2888
|
original?: string;
|
|
2368
|
-
/**
|
|
2889
|
+
/**
|
|
2890
|
+
* Translated value.
|
|
2891
|
+
* @minLength 1
|
|
2892
|
+
*/
|
|
2369
2893
|
translated?: string | null;
|
|
2370
2894
|
}
|
|
2371
2895
|
export interface LineItemAmount {
|
|
2372
|
-
/**
|
|
2896
|
+
/**
|
|
2897
|
+
* Order line item id
|
|
2898
|
+
* @format GUID
|
|
2899
|
+
*/
|
|
2373
2900
|
_id?: string;
|
|
2374
2901
|
/** Item name. */
|
|
2375
2902
|
name?: ProductName;
|
|
@@ -2377,7 +2904,10 @@ export interface LineItemAmount {
|
|
|
2377
2904
|
amount?: Price;
|
|
2378
2905
|
}
|
|
2379
2906
|
export interface ManagedAdditionalFee {
|
|
2380
|
-
/**
|
|
2907
|
+
/**
|
|
2908
|
+
* Additional fee id.
|
|
2909
|
+
* @format GUID
|
|
2910
|
+
*/
|
|
2381
2911
|
_id?: string;
|
|
2382
2912
|
/** Additional fee name. */
|
|
2383
2913
|
name?: TranslatedValue;
|
|
@@ -2401,54 +2931,102 @@ export interface ShippingInformationChange {
|
|
|
2401
2931
|
export interface ShippingInformation {
|
|
2402
2932
|
/** Order’s shipping price. */
|
|
2403
2933
|
total?: Price;
|
|
2404
|
-
/**
|
|
2934
|
+
/**
|
|
2935
|
+
* Order’s shipping title.
|
|
2936
|
+
* @maxLength 250
|
|
2937
|
+
*/
|
|
2405
2938
|
shippingTitle?: string;
|
|
2406
2939
|
}
|
|
2407
2940
|
/** Payment method is saved for order */
|
|
2408
2941
|
export interface SavedPaymentMethod {
|
|
2409
|
-
/**
|
|
2942
|
+
/**
|
|
2943
|
+
* Payment method name
|
|
2944
|
+
* @minLength 1
|
|
2945
|
+
* @maxLength 100
|
|
2946
|
+
*/
|
|
2410
2947
|
name?: string;
|
|
2411
|
-
/**
|
|
2948
|
+
/**
|
|
2949
|
+
* Payment method description
|
|
2950
|
+
* @minLength 1
|
|
2951
|
+
* @maxLength 100
|
|
2952
|
+
*/
|
|
2412
2953
|
description?: string | null;
|
|
2413
2954
|
}
|
|
2414
2955
|
export interface AuthorizedPaymentCreated {
|
|
2415
|
-
/**
|
|
2956
|
+
/**
|
|
2957
|
+
* Payment ID of payment associated with this activity
|
|
2958
|
+
* @format GUID
|
|
2959
|
+
*/
|
|
2416
2960
|
paymentId?: string;
|
|
2417
2961
|
/** Payment amount */
|
|
2418
2962
|
amount?: Price;
|
|
2419
|
-
/**
|
|
2963
|
+
/**
|
|
2964
|
+
* The last 4 digits of the card number.
|
|
2965
|
+
* @maxLength 4
|
|
2966
|
+
*/
|
|
2420
2967
|
lastFourDigits?: string | null;
|
|
2421
|
-
/**
|
|
2968
|
+
/**
|
|
2969
|
+
* Card issuer's brand.
|
|
2970
|
+
* @maxLength 100
|
|
2971
|
+
*/
|
|
2422
2972
|
brand?: string | null;
|
|
2423
2973
|
}
|
|
2424
2974
|
export interface AuthorizedPaymentCaptured {
|
|
2425
|
-
/**
|
|
2975
|
+
/**
|
|
2976
|
+
* Payment ID of payment associated with this activity
|
|
2977
|
+
* @format GUID
|
|
2978
|
+
*/
|
|
2426
2979
|
paymentId?: string;
|
|
2427
2980
|
/** Payment amount */
|
|
2428
2981
|
amount?: Price;
|
|
2429
|
-
/**
|
|
2982
|
+
/**
|
|
2983
|
+
* The last 4 digits of the card number.
|
|
2984
|
+
* @maxLength 4
|
|
2985
|
+
*/
|
|
2430
2986
|
lastFourDigits?: string | null;
|
|
2431
|
-
/**
|
|
2987
|
+
/**
|
|
2988
|
+
* Card issuer's brand.
|
|
2989
|
+
* @maxLength 100
|
|
2990
|
+
*/
|
|
2432
2991
|
brand?: string | null;
|
|
2433
2992
|
}
|
|
2434
2993
|
export interface AuthorizedPaymentVoided {
|
|
2435
|
-
/**
|
|
2994
|
+
/**
|
|
2995
|
+
* Payment ID of payment associated with this activity
|
|
2996
|
+
* @format GUID
|
|
2997
|
+
*/
|
|
2436
2998
|
paymentId?: string;
|
|
2437
2999
|
/** Payment amount */
|
|
2438
3000
|
amount?: Price;
|
|
2439
|
-
/**
|
|
3001
|
+
/**
|
|
3002
|
+
* The last 4 digits of the card number.
|
|
3003
|
+
* @maxLength 4
|
|
3004
|
+
*/
|
|
2440
3005
|
lastFourDigits?: string | null;
|
|
2441
|
-
/**
|
|
3006
|
+
/**
|
|
3007
|
+
* Card issuer's brand.
|
|
3008
|
+
* @maxLength 100
|
|
3009
|
+
*/
|
|
2442
3010
|
brand?: string | null;
|
|
2443
3011
|
}
|
|
2444
3012
|
export interface RefundInitiated {
|
|
2445
|
-
/**
|
|
3013
|
+
/**
|
|
3014
|
+
* Refund ID.
|
|
3015
|
+
* @format GUID
|
|
3016
|
+
*/
|
|
2446
3017
|
refundId?: string;
|
|
2447
3018
|
/** Refund amount. */
|
|
2448
3019
|
amount?: Price;
|
|
2449
|
-
/**
|
|
3020
|
+
/**
|
|
3021
|
+
* Details about the payments being refunded.
|
|
3022
|
+
* @minSize 1
|
|
3023
|
+
* @maxSize 50
|
|
3024
|
+
*/
|
|
2450
3025
|
payments?: RefundedPayment[];
|
|
2451
|
-
/**
|
|
3026
|
+
/**
|
|
3027
|
+
* Reason for refund.
|
|
3028
|
+
* @maxLength 100
|
|
3029
|
+
*/
|
|
2452
3030
|
reason?: string | null;
|
|
2453
3031
|
}
|
|
2454
3032
|
export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
@@ -2458,7 +3036,10 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
2458
3036
|
giftCard?: GiftCardPaymentRefund;
|
|
2459
3037
|
/** Membership payment refund. */
|
|
2460
3038
|
membership?: MembershipPaymentRefund;
|
|
2461
|
-
/**
|
|
3039
|
+
/**
|
|
3040
|
+
* Payment ID.
|
|
3041
|
+
* @format GUID
|
|
3042
|
+
*/
|
|
2462
3043
|
paymentId?: string;
|
|
2463
3044
|
/** Whether refund was made externally and manually on the payment provider's side. */
|
|
2464
3045
|
externalRefund?: boolean;
|
|
@@ -2475,29 +3056,49 @@ export interface RefundedPaymentKindOneOf {
|
|
|
2475
3056
|
export interface RegularPaymentRefund {
|
|
2476
3057
|
/** Refund amount */
|
|
2477
3058
|
amount?: Price;
|
|
2478
|
-
/**
|
|
3059
|
+
/**
|
|
3060
|
+
* The last 4 digits of the card number.
|
|
3061
|
+
* @maxLength 4
|
|
3062
|
+
*/
|
|
2479
3063
|
lastFourDigits?: string | null;
|
|
2480
|
-
/**
|
|
3064
|
+
/**
|
|
3065
|
+
* Card issuer's brand.
|
|
3066
|
+
* @maxLength 100
|
|
3067
|
+
*/
|
|
2481
3068
|
brand?: string | null;
|
|
2482
3069
|
}
|
|
2483
3070
|
export interface GiftCardPaymentRefund {
|
|
2484
|
-
/**
|
|
3071
|
+
/**
|
|
3072
|
+
* Gift card payment ID
|
|
3073
|
+
* @minLength 1
|
|
3074
|
+
* @maxLength 100
|
|
3075
|
+
*/
|
|
2485
3076
|
giftCardPaymentId?: string | null;
|
|
2486
3077
|
/** Refund amount */
|
|
2487
3078
|
amount?: Price;
|
|
2488
3079
|
}
|
|
2489
3080
|
export interface MembershipPaymentRefund {
|
|
2490
|
-
/**
|
|
3081
|
+
/**
|
|
3082
|
+
* Membership ID
|
|
3083
|
+
* @minLength 1
|
|
3084
|
+
* @maxLength 100
|
|
3085
|
+
*/
|
|
2491
3086
|
membershipId?: string | null;
|
|
2492
3087
|
}
|
|
2493
3088
|
export interface PaymentRefunded {
|
|
2494
|
-
/**
|
|
3089
|
+
/**
|
|
3090
|
+
* Refund ID.
|
|
3091
|
+
* @format GUID
|
|
3092
|
+
*/
|
|
2495
3093
|
refundId?: string;
|
|
2496
3094
|
/** Details about the refunded payment. */
|
|
2497
3095
|
payment?: RefundedPayment;
|
|
2498
3096
|
}
|
|
2499
3097
|
export interface PaymentRefundFailed {
|
|
2500
|
-
/**
|
|
3098
|
+
/**
|
|
3099
|
+
* Refund ID.
|
|
3100
|
+
* @format GUID
|
|
3101
|
+
*/
|
|
2501
3102
|
refundId?: string;
|
|
2502
3103
|
/** Details about the failed payment refund. */
|
|
2503
3104
|
payment?: RefundedPayment;
|
|
@@ -2505,13 +3106,19 @@ export interface PaymentRefundFailed {
|
|
|
2505
3106
|
export interface RefundedAsStoreCredit {
|
|
2506
3107
|
/** Refund amount */
|
|
2507
3108
|
amount?: Price;
|
|
2508
|
-
/**
|
|
3109
|
+
/**
|
|
3110
|
+
* Reason for refund
|
|
3111
|
+
* @maxLength 100
|
|
3112
|
+
*/
|
|
2509
3113
|
reason?: string | null;
|
|
2510
3114
|
}
|
|
2511
3115
|
export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
2512
3116
|
/** Regular payment. */
|
|
2513
3117
|
regular?: RegularPayment;
|
|
2514
|
-
/**
|
|
3118
|
+
/**
|
|
3119
|
+
* Payment ID of payment associated with this activity
|
|
3120
|
+
* @format GUID
|
|
3121
|
+
*/
|
|
2515
3122
|
paymentId?: string;
|
|
2516
3123
|
}
|
|
2517
3124
|
/** @oneof */
|
|
@@ -2531,15 +3138,24 @@ export interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
|
2531
3138
|
creditCardDetails?: CreditCardDetails;
|
|
2532
3139
|
}
|
|
2533
3140
|
export interface CreditCardDetails {
|
|
2534
|
-
/**
|
|
3141
|
+
/**
|
|
3142
|
+
* The last 4 digits of the card number.
|
|
3143
|
+
* @maxLength 4
|
|
3144
|
+
*/
|
|
2535
3145
|
lastFourDigits?: string | null;
|
|
2536
|
-
/**
|
|
3146
|
+
/**
|
|
3147
|
+
* Card issuer's brand.
|
|
3148
|
+
* @maxLength 100
|
|
3149
|
+
*/
|
|
2537
3150
|
brand?: string | null;
|
|
2538
3151
|
}
|
|
2539
3152
|
export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
2540
3153
|
/** Regular payment. */
|
|
2541
3154
|
regular?: RegularPayment;
|
|
2542
|
-
/**
|
|
3155
|
+
/**
|
|
3156
|
+
* Payment ID of payment associated with this activity
|
|
3157
|
+
* @format GUID
|
|
3158
|
+
*/
|
|
2543
3159
|
paymentId?: string;
|
|
2544
3160
|
}
|
|
2545
3161
|
/** @oneof */
|
|
@@ -2550,7 +3166,10 @@ export interface PaymentCanceledPaymentDetailsOneOf {
|
|
|
2550
3166
|
export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
2551
3167
|
/** Regular payment. */
|
|
2552
3168
|
regular?: RegularPayment;
|
|
2553
|
-
/**
|
|
3169
|
+
/**
|
|
3170
|
+
* Payment ID of payment associated with this activity
|
|
3171
|
+
* @format GUID
|
|
3172
|
+
*/
|
|
2554
3173
|
paymentId?: string;
|
|
2555
3174
|
}
|
|
2556
3175
|
/** @oneof */
|
|
@@ -2563,7 +3182,10 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
2563
3182
|
wixReceipt?: WixReceipt;
|
|
2564
3183
|
/** Receipt created by an external system. */
|
|
2565
3184
|
externalReceipt?: ExternalReceipt;
|
|
2566
|
-
/**
|
|
3185
|
+
/**
|
|
3186
|
+
* Payment ID of payment associated with this activity
|
|
3187
|
+
* @format GUID
|
|
3188
|
+
*/
|
|
2567
3189
|
paymentId?: string;
|
|
2568
3190
|
}
|
|
2569
3191
|
/** @oneof */
|
|
@@ -2574,15 +3196,29 @@ export interface ReceiptCreatedReceiptInfoOneOf {
|
|
|
2574
3196
|
externalReceipt?: ExternalReceipt;
|
|
2575
3197
|
}
|
|
2576
3198
|
export interface WixReceipt {
|
|
2577
|
-
/**
|
|
3199
|
+
/**
|
|
3200
|
+
* Receipt ID
|
|
3201
|
+
* @format GUID
|
|
3202
|
+
*/
|
|
2578
3203
|
receiptId?: string;
|
|
2579
|
-
/**
|
|
3204
|
+
/**
|
|
3205
|
+
* Display number of receipt
|
|
3206
|
+
* @minLength 1
|
|
3207
|
+
* @maxLength 40
|
|
3208
|
+
*/
|
|
2580
3209
|
displayNumber?: string | null;
|
|
2581
3210
|
}
|
|
2582
3211
|
export interface ExternalReceipt {
|
|
2583
|
-
/**
|
|
3212
|
+
/**
|
|
3213
|
+
* Receipt ID
|
|
3214
|
+
* @maxLength 100
|
|
3215
|
+
*/
|
|
2584
3216
|
receiptId?: string | null;
|
|
2585
|
-
/**
|
|
3217
|
+
/**
|
|
3218
|
+
* Display number of receipt
|
|
3219
|
+
* @minLength 1
|
|
3220
|
+
* @maxLength 40
|
|
3221
|
+
*/
|
|
2586
3222
|
displayNumber?: string | null;
|
|
2587
3223
|
}
|
|
2588
3224
|
export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
@@ -2590,7 +3226,10 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
2590
3226
|
wixReceipt?: WixReceipt;
|
|
2591
3227
|
/** Receipt created by an external system. */
|
|
2592
3228
|
externalReceipt?: ExternalReceipt;
|
|
2593
|
-
/**
|
|
3229
|
+
/**
|
|
3230
|
+
* Payment ID of payment associated with this activity
|
|
3231
|
+
* @format GUID
|
|
3232
|
+
*/
|
|
2594
3233
|
paymentId?: string;
|
|
2595
3234
|
}
|
|
2596
3235
|
/** @oneof */
|
|
@@ -2645,13 +3284,23 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
2645
3284
|
/**
|
|
2646
3285
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
2647
3286
|
* For example, via POS (point of service).
|
|
3287
|
+
* @format GUID
|
|
2648
3288
|
*/
|
|
2649
3289
|
userId?: string;
|
|
2650
|
-
/**
|
|
3290
|
+
/**
|
|
3291
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
3292
|
+
* @format GUID
|
|
3293
|
+
*/
|
|
2651
3294
|
memberId?: string;
|
|
2652
|
-
/**
|
|
3295
|
+
/**
|
|
3296
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
3297
|
+
* @format GUID
|
|
3298
|
+
*/
|
|
2653
3299
|
visitorId?: string;
|
|
2654
|
-
/**
|
|
3300
|
+
/**
|
|
3301
|
+
* App ID - when the order was created by an external application.
|
|
3302
|
+
* @format GUID
|
|
3303
|
+
*/
|
|
2655
3304
|
appId?: string;
|
|
2656
3305
|
}
|
|
2657
3306
|
/** @oneof */
|
|
@@ -2659,21 +3308,37 @@ export interface V1CreatedByStringOneOf {
|
|
|
2659
3308
|
/**
|
|
2660
3309
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
2661
3310
|
* For example, via POS (point of service).
|
|
3311
|
+
* @format GUID
|
|
2662
3312
|
*/
|
|
2663
3313
|
userId?: string;
|
|
2664
|
-
/**
|
|
3314
|
+
/**
|
|
3315
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
3316
|
+
* @format GUID
|
|
3317
|
+
*/
|
|
2665
3318
|
memberId?: string;
|
|
2666
|
-
/**
|
|
3319
|
+
/**
|
|
3320
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
3321
|
+
* @format GUID
|
|
3322
|
+
*/
|
|
2667
3323
|
visitorId?: string;
|
|
2668
|
-
/**
|
|
3324
|
+
/**
|
|
3325
|
+
* App ID - when the order was created by an external application.
|
|
3326
|
+
* @format GUID
|
|
3327
|
+
*/
|
|
2669
3328
|
appId?: string;
|
|
2670
3329
|
}
|
|
2671
3330
|
export interface ChannelInfo {
|
|
2672
3331
|
/** Sales channel that submitted the order. */
|
|
2673
3332
|
type?: ChannelType;
|
|
2674
|
-
/**
|
|
3333
|
+
/**
|
|
3334
|
+
* Reference to an order ID from an external system.
|
|
3335
|
+
* @maxLength 100
|
|
3336
|
+
*/
|
|
2675
3337
|
externalOrderId?: string | null;
|
|
2676
|
-
/**
|
|
3338
|
+
/**
|
|
3339
|
+
* URL to the order in the external system.
|
|
3340
|
+
* @maxLength 300
|
|
3341
|
+
*/
|
|
2677
3342
|
externalOrderUrl?: string | null;
|
|
2678
3343
|
}
|
|
2679
3344
|
export declare enum ChannelType {
|
|
@@ -2713,9 +3378,17 @@ export declare enum ChannelType {
|
|
|
2713
3378
|
export interface CustomField {
|
|
2714
3379
|
/** Custom field value. */
|
|
2715
3380
|
value?: any;
|
|
2716
|
-
/**
|
|
3381
|
+
/**
|
|
3382
|
+
* Custom field title.
|
|
3383
|
+
* @minLength 1
|
|
3384
|
+
* @maxLength 500
|
|
3385
|
+
*/
|
|
2717
3386
|
title?: string;
|
|
2718
|
-
/**
|
|
3387
|
+
/**
|
|
3388
|
+
* Translated custom field title.
|
|
3389
|
+
* @minLength 1
|
|
3390
|
+
* @maxLength 500
|
|
3391
|
+
*/
|
|
2719
3392
|
translatedTitle?: string | null;
|
|
2720
3393
|
}
|
|
2721
3394
|
export interface V1BalanceSummary {
|
|
@@ -2786,13 +3459,18 @@ export interface Tags {
|
|
|
2786
3459
|
tags?: TagList;
|
|
2787
3460
|
}
|
|
2788
3461
|
export interface TagList {
|
|
2789
|
-
/**
|
|
3462
|
+
/**
|
|
3463
|
+
* List of tag IDs
|
|
3464
|
+
* @maxSize 100
|
|
3465
|
+
* @maxLength 5
|
|
3466
|
+
*/
|
|
2790
3467
|
tagIds?: string[];
|
|
2791
3468
|
}
|
|
2792
3469
|
export interface CreateOrderFromDraftRequest {
|
|
2793
3470
|
/**
|
|
2794
3471
|
* The draft order id
|
|
2795
3472
|
* @internal
|
|
3473
|
+
* @format GUID
|
|
2796
3474
|
*/
|
|
2797
3475
|
draftOrderId: string;
|
|
2798
3476
|
/**
|
|
@@ -2803,6 +3481,7 @@ export interface CreateOrderFromDraftRequest {
|
|
|
2803
3481
|
/**
|
|
2804
3482
|
* Reason for order creation, given by user (optional).
|
|
2805
3483
|
* @internal
|
|
3484
|
+
* @maxLength 200
|
|
2806
3485
|
*/
|
|
2807
3486
|
reason?: string | null;
|
|
2808
3487
|
/**
|
|
@@ -2847,7 +3526,10 @@ export interface CreateOrderFromDraftResponse {
|
|
|
2847
3526
|
createdOrder?: Order;
|
|
2848
3527
|
}
|
|
2849
3528
|
export interface DeleteDraftOrderRequest {
|
|
2850
|
-
/**
|
|
3529
|
+
/**
|
|
3530
|
+
* The draft order id
|
|
3531
|
+
* @format GUID
|
|
3532
|
+
*/
|
|
2851
3533
|
draftOrderId: string;
|
|
2852
3534
|
}
|
|
2853
3535
|
export interface DeleteDraftOrderResponse {
|
|
@@ -2873,6 +3555,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2873
3555
|
* Sort object.
|
|
2874
3556
|
*
|
|
2875
3557
|
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
3558
|
+
* @maxSize 5
|
|
2876
3559
|
*/
|
|
2877
3560
|
sort?: Sorting[];
|
|
2878
3561
|
}
|
|
@@ -2886,7 +3569,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
2886
3569
|
cursorPaging?: CursorPaging;
|
|
2887
3570
|
}
|
|
2888
3571
|
export interface Sorting {
|
|
2889
|
-
/**
|
|
3572
|
+
/**
|
|
3573
|
+
* Name of the field to sort by.
|
|
3574
|
+
* @maxLength 512
|
|
3575
|
+
*/
|
|
2890
3576
|
fieldName?: string;
|
|
2891
3577
|
/** Sort order. */
|
|
2892
3578
|
order?: SortOrder;
|
|
@@ -2896,13 +3582,17 @@ export declare enum SortOrder {
|
|
|
2896
3582
|
DESC = "DESC"
|
|
2897
3583
|
}
|
|
2898
3584
|
export interface CursorPaging {
|
|
2899
|
-
/**
|
|
3585
|
+
/**
|
|
3586
|
+
* Maximum number of items to return in the results.
|
|
3587
|
+
* @max 100
|
|
3588
|
+
*/
|
|
2900
3589
|
limit?: number | null;
|
|
2901
3590
|
/**
|
|
2902
3591
|
* Pointer to the next or previous page in the list of results.
|
|
2903
3592
|
*
|
|
2904
3593
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2905
3594
|
* Not relevant for the first request.
|
|
3595
|
+
* @maxLength 16000
|
|
2906
3596
|
*/
|
|
2907
3597
|
cursor?: string | null;
|
|
2908
3598
|
}
|
|
@@ -2926,9 +3616,15 @@ export interface CursorPagingMetadata {
|
|
|
2926
3616
|
hasNext?: boolean | null;
|
|
2927
3617
|
}
|
|
2928
3618
|
export interface Cursors {
|
|
2929
|
-
/**
|
|
3619
|
+
/**
|
|
3620
|
+
* Cursor string pointing to the next page in the list of results.
|
|
3621
|
+
* @maxLength 16000
|
|
3622
|
+
*/
|
|
2930
3623
|
next?: string | null;
|
|
2931
|
-
/**
|
|
3624
|
+
/**
|
|
3625
|
+
* Cursor pointing to the previous page in the list of results.
|
|
3626
|
+
* @maxLength 16000
|
|
3627
|
+
*/
|
|
2932
3628
|
prev?: string | null;
|
|
2933
3629
|
}
|
|
2934
3630
|
export interface UpdateExtendedFieldsRequest {
|
|
@@ -2947,6 +3643,7 @@ export interface SetTaxExemptionRequest {
|
|
|
2947
3643
|
/**
|
|
2948
3644
|
* Draft order ID.
|
|
2949
3645
|
* @internal
|
|
3646
|
+
* @format GUID
|
|
2950
3647
|
*/
|
|
2951
3648
|
draftOrderId: string;
|
|
2952
3649
|
/**
|
|
@@ -2965,11 +3662,17 @@ export interface SetTaxExemptionResponse {
|
|
|
2965
3662
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2966
3663
|
}
|
|
2967
3664
|
export interface GetDraftEditabilityStatusRequest {
|
|
2968
|
-
/**
|
|
3665
|
+
/**
|
|
3666
|
+
* Draft order ID.
|
|
3667
|
+
* @format GUID
|
|
3668
|
+
*/
|
|
2969
3669
|
draftOrderId?: string | null;
|
|
2970
3670
|
}
|
|
2971
3671
|
export interface GetDraftEditabilityStatusResponse {
|
|
2972
|
-
/**
|
|
3672
|
+
/**
|
|
3673
|
+
* Draft order ID.
|
|
3674
|
+
* @format GUID
|
|
3675
|
+
*/
|
|
2973
3676
|
draftOrderId?: string | null;
|
|
2974
3677
|
/**
|
|
2975
3678
|
* Draft order status.
|
|
@@ -2981,6 +3684,7 @@ export interface SetBusinessLocationRequest {
|
|
|
2981
3684
|
/**
|
|
2982
3685
|
* Draft order ID.
|
|
2983
3686
|
* @internal
|
|
3687
|
+
* @format GUID
|
|
2984
3688
|
*/
|
|
2985
3689
|
draftOrderId: string;
|
|
2986
3690
|
/**
|
|
@@ -3067,9 +3771,15 @@ export interface ActionEvent {
|
|
|
3067
3771
|
body?: string;
|
|
3068
3772
|
}
|
|
3069
3773
|
export interface MessageEnvelope {
|
|
3070
|
-
/**
|
|
3774
|
+
/**
|
|
3775
|
+
* App instance ID.
|
|
3776
|
+
* @format GUID
|
|
3777
|
+
*/
|
|
3071
3778
|
instanceId?: string | null;
|
|
3072
|
-
/**
|
|
3779
|
+
/**
|
|
3780
|
+
* Event type.
|
|
3781
|
+
* @maxLength 150
|
|
3782
|
+
*/
|
|
3073
3783
|
eventType?: string;
|
|
3074
3784
|
/** The identification type and identity data. */
|
|
3075
3785
|
identity?: IdentificationData;
|
|
@@ -3077,26 +3787,50 @@ export interface MessageEnvelope {
|
|
|
3077
3787
|
data?: string;
|
|
3078
3788
|
}
|
|
3079
3789
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3080
|
-
/**
|
|
3790
|
+
/**
|
|
3791
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3792
|
+
* @format GUID
|
|
3793
|
+
*/
|
|
3081
3794
|
anonymousVisitorId?: string;
|
|
3082
|
-
/**
|
|
3795
|
+
/**
|
|
3796
|
+
* ID of a site visitor that has logged in to the site.
|
|
3797
|
+
* @format GUID
|
|
3798
|
+
*/
|
|
3083
3799
|
memberId?: string;
|
|
3084
|
-
/**
|
|
3800
|
+
/**
|
|
3801
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3802
|
+
* @format GUID
|
|
3803
|
+
*/
|
|
3085
3804
|
wixUserId?: string;
|
|
3086
|
-
/**
|
|
3805
|
+
/**
|
|
3806
|
+
* ID of an app.
|
|
3807
|
+
* @format GUID
|
|
3808
|
+
*/
|
|
3087
3809
|
appId?: string;
|
|
3088
3810
|
/** @readonly */
|
|
3089
3811
|
identityType?: WebhookIdentityType;
|
|
3090
3812
|
}
|
|
3091
3813
|
/** @oneof */
|
|
3092
3814
|
export interface IdentificationDataIdOneOf {
|
|
3093
|
-
/**
|
|
3815
|
+
/**
|
|
3816
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3817
|
+
* @format GUID
|
|
3818
|
+
*/
|
|
3094
3819
|
anonymousVisitorId?: string;
|
|
3095
|
-
/**
|
|
3820
|
+
/**
|
|
3821
|
+
* ID of a site visitor that has logged in to the site.
|
|
3822
|
+
* @format GUID
|
|
3823
|
+
*/
|
|
3096
3824
|
memberId?: string;
|
|
3097
|
-
/**
|
|
3825
|
+
/**
|
|
3826
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3827
|
+
* @format GUID
|
|
3828
|
+
*/
|
|
3098
3829
|
wixUserId?: string;
|
|
3099
|
-
/**
|
|
3830
|
+
/**
|
|
3831
|
+
* ID of an app.
|
|
3832
|
+
* @format GUID
|
|
3833
|
+
*/
|
|
3100
3834
|
appId?: string;
|
|
3101
3835
|
}
|
|
3102
3836
|
export declare enum WebhookIdentityType {
|
|
@@ -3427,17 +4161,12 @@ interface LocationNonNullableFields {
|
|
|
3427
4161
|
name: string;
|
|
3428
4162
|
}
|
|
3429
4163
|
interface BusinessLocationChangedDetailsNonNullableFields {
|
|
3430
|
-
/** @internal */
|
|
3431
4164
|
businessLocationBeforeChange?: LocationNonNullableFields;
|
|
3432
4165
|
}
|
|
3433
4166
|
interface BusinessLocationDetailsNonNullableFields {
|
|
3434
|
-
/** @internal */
|
|
3435
4167
|
added: boolean;
|
|
3436
|
-
/** @internal */
|
|
3437
4168
|
changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
|
|
3438
|
-
/** @internal */
|
|
3439
4169
|
removed: boolean;
|
|
3440
|
-
/** @internal */
|
|
3441
4170
|
businessLocation?: LocationNonNullableFields;
|
|
3442
4171
|
}
|
|
3443
4172
|
interface DraftOrderNonNullableFields {
|
|
@@ -3461,7 +4190,6 @@ interface DraftOrderNonNullableFields {
|
|
|
3461
4190
|
buyerDetails?: BuyerDetailsNonNullableFields;
|
|
3462
4191
|
/** @internal */
|
|
3463
4192
|
billingDetails?: BillingDetailsNonNullableFields;
|
|
3464
|
-
/** @internal */
|
|
3465
4193
|
businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
|
|
3466
4194
|
}
|
|
3467
4195
|
interface PickupDetailsNonNullableFields {
|
|
@@ -3820,7 +4548,6 @@ interface OrderNonNullableFields {
|
|
|
3820
4548
|
recipientInfo?: AddressWithContactNonNullableFields;
|
|
3821
4549
|
/** @internal */
|
|
3822
4550
|
tags?: TagsNonNullableFields;
|
|
3823
|
-
/** @internal */
|
|
3824
4551
|
businessLocation?: LocationNonNullableFields;
|
|
3825
4552
|
/** @internal */
|
|
3826
4553
|
payAfterFreeTrial?: PriceSummaryNonNullableFields;
|
|
@@ -3860,6 +4587,8 @@ export interface SetBusinessLocationResponseNonNullableFields {
|
|
|
3860
4587
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
3861
4588
|
* @permissionScope Manage Stores - all permissions
|
|
3862
4589
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4590
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4591
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3863
4592
|
* @permissionScope Manage eCommerce - all permissions
|
|
3864
4593
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3865
4594
|
* @applicableIdentity APP
|
|
@@ -3875,6 +4604,8 @@ export declare function createDraftOrder(orderId: string | null): Promise<Create
|
|
|
3875
4604
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
3876
4605
|
* @permissionScope Manage Stores - all permissions
|
|
3877
4606
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4607
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4608
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3878
4609
|
* @permissionScope Manage eCommerce - all permissions
|
|
3879
4610
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3880
4611
|
* @applicableIdentity APP
|
|
@@ -3891,6 +4622,8 @@ export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderRe
|
|
|
3891
4622
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
3892
4623
|
* @permissionScope Manage Stores - all permissions
|
|
3893
4624
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4625
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4626
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3894
4627
|
* @permissionScope Manage eCommerce - all permissions
|
|
3895
4628
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3896
4629
|
* @applicableIdentity APP
|
|
@@ -3898,9 +4631,15 @@ export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderRe
|
|
|
3898
4631
|
*/
|
|
3899
4632
|
export declare function addLineItemsToDraftOrder(draftOrderId: string, options?: AddLineItemsToDraftOrderOptions): Promise<AddLineItemsToDraftOrderResponse & AddLineItemsToDraftOrderResponseNonNullableFields>;
|
|
3900
4633
|
export interface AddLineItemsToDraftOrderOptions {
|
|
3901
|
-
/**
|
|
4634
|
+
/**
|
|
4635
|
+
* Catalog line items to add to draft order.
|
|
4636
|
+
* @maxSize 300
|
|
4637
|
+
*/
|
|
3902
4638
|
catalogLineItems?: CatalogReferenceLineItem[];
|
|
3903
|
-
/**
|
|
4639
|
+
/**
|
|
4640
|
+
* Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
|
|
4641
|
+
* @maxSize 300
|
|
4642
|
+
*/
|
|
3904
4643
|
customLineItems?: CustomLineItem[];
|
|
3905
4644
|
}
|
|
3906
4645
|
/**
|
|
@@ -3918,6 +4657,8 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
3918
4657
|
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
3919
4658
|
* @permissionScope Manage Stores - all permissions
|
|
3920
4659
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4660
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4661
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3921
4662
|
* @permissionScope Manage eCommerce - all permissions
|
|
3922
4663
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3923
4664
|
* @applicableIdentity APP
|
|
@@ -3925,7 +4666,11 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
3925
4666
|
*/
|
|
3926
4667
|
export declare function updateLineItems(draftOrderId: string, options?: UpdateLineItemsOptions): Promise<UpdateLineItemsResponse & UpdateLineItemsResponseNonNullableFields>;
|
|
3927
4668
|
export interface UpdateLineItemsOptions {
|
|
3928
|
-
/**
|
|
4669
|
+
/**
|
|
4670
|
+
* Details of changes to apply per line item
|
|
4671
|
+
* @minSize 1
|
|
4672
|
+
* @maxSize 300
|
|
4673
|
+
*/
|
|
3929
4674
|
lineItemChanges?: LineItemChangeDetails[];
|
|
3930
4675
|
}
|
|
3931
4676
|
/**
|
|
@@ -3941,6 +4686,8 @@ export interface UpdateLineItemsOptions {
|
|
|
3941
4686
|
* @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
|
|
3942
4687
|
* @permissionScope Manage Stores - all permissions
|
|
3943
4688
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4689
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4690
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3944
4691
|
* @permissionScope Manage eCommerce - all permissions
|
|
3945
4692
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3946
4693
|
* @applicableIdentity APP
|
|
@@ -3959,6 +4706,8 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
|
|
|
3959
4706
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
|
|
3960
4707
|
* @permissionScope Manage Stores - all permissions
|
|
3961
4708
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4709
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4710
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3962
4711
|
* @permissionScope Manage eCommerce - all permissions
|
|
3963
4712
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3964
4713
|
* @applicableIdentity APP
|
|
@@ -3966,7 +4715,11 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
|
|
|
3966
4715
|
*/
|
|
3967
4716
|
export declare function createCustomDiscounts(draftOrderId: string, options?: CreateCustomDiscountsOptions): Promise<CreateCustomDiscountsResponse & CreateCustomDiscountsResponseNonNullableFields>;
|
|
3968
4717
|
export interface CreateCustomDiscountsOptions {
|
|
3969
|
-
/**
|
|
4718
|
+
/**
|
|
4719
|
+
* The discounts to add.
|
|
4720
|
+
* @minSize 1
|
|
4721
|
+
* @maxSize 100
|
|
4722
|
+
*/
|
|
3970
4723
|
discounts?: DiscountOption[];
|
|
3971
4724
|
}
|
|
3972
4725
|
/**
|
|
@@ -3980,6 +4733,8 @@ export interface CreateCustomDiscountsOptions {
|
|
|
3980
4733
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
3981
4734
|
* @permissionScope Manage Stores - all permissions
|
|
3982
4735
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4736
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4737
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3983
4738
|
* @permissionScope Manage eCommerce - all permissions
|
|
3984
4739
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3985
4740
|
* @applicableIdentity APP
|
|
@@ -3998,6 +4753,8 @@ export declare function deleteCustomDiscounts(draftOrderId: string, discountIds:
|
|
|
3998
4753
|
* @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
|
|
3999
4754
|
* @permissionScope Manage Stores - all permissions
|
|
4000
4755
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4756
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4757
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4001
4758
|
* @permissionScope Manage eCommerce - all permissions
|
|
4002
4759
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4003
4760
|
* @applicableIdentity APP
|
|
@@ -4018,6 +4775,8 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
|
|
|
4018
4775
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
|
|
4019
4776
|
* @permissionScope Manage Stores - all permissions
|
|
4020
4777
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4778
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4779
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4021
4780
|
* @permissionScope Manage eCommerce - all permissions
|
|
4022
4781
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4023
4782
|
* @applicableIdentity APP
|
|
@@ -4025,7 +4784,11 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
|
|
|
4025
4784
|
*/
|
|
4026
4785
|
export declare function createCustomAdditionalFees(draftOrderId: string, options?: CreateCustomAdditionalFeesOptions): Promise<CreateCustomAdditionalFeesResponse & CreateCustomAdditionalFeesResponseNonNullableFields>;
|
|
4027
4786
|
export interface CreateCustomAdditionalFeesOptions {
|
|
4028
|
-
/**
|
|
4787
|
+
/**
|
|
4788
|
+
* The additional fees to add. added with opted-out setting
|
|
4789
|
+
* @minSize 1
|
|
4790
|
+
* @maxSize 100
|
|
4791
|
+
*/
|
|
4029
4792
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
4030
4793
|
}
|
|
4031
4794
|
/**
|
|
@@ -4039,6 +4802,8 @@ export interface CreateCustomAdditionalFeesOptions {
|
|
|
4039
4802
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
4040
4803
|
* @permissionScope Manage Stores - all permissions
|
|
4041
4804
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4805
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4806
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4042
4807
|
* @permissionScope Manage eCommerce - all permissions
|
|
4043
4808
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4044
4809
|
* @applicableIdentity APP
|
|
@@ -4052,6 +4817,8 @@ export declare function deleteCustomAdditionalFees(draftOrderId: string, customA
|
|
|
4052
4817
|
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
4053
4818
|
* @permissionScope Manage Stores - all permissions
|
|
4054
4819
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4820
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4821
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4055
4822
|
* @permissionScope Manage eCommerce - all permissions
|
|
4056
4823
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4057
4824
|
* @applicableIdentity APP
|
|
@@ -4065,6 +4832,8 @@ export declare function setShippingInfo(): Promise<void>;
|
|
|
4065
4832
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
4066
4833
|
* @permissionScope Manage Stores - all permissions
|
|
4067
4834
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4835
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4836
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4068
4837
|
* @permissionScope Manage eCommerce - all permissions
|
|
4069
4838
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4070
4839
|
* @applicableIdentity APP
|
|
@@ -4078,6 +4847,8 @@ export declare function setBuyerInfo(): Promise<void>;
|
|
|
4078
4847
|
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
4079
4848
|
* @permissionScope Manage Stores - all permissions
|
|
4080
4849
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4850
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4851
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4081
4852
|
* @permissionScope Manage eCommerce - all permissions
|
|
4082
4853
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4083
4854
|
* @applicableIdentity APP
|
|
@@ -4091,6 +4862,8 @@ export declare function setRecipientInfo(): Promise<void>;
|
|
|
4091
4862
|
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
4092
4863
|
* @permissionScope Manage Stores - all permissions
|
|
4093
4864
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4865
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4866
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4094
4867
|
* @permissionScope Manage eCommerce - all permissions
|
|
4095
4868
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4096
4869
|
* @applicableIdentity APP
|
|
@@ -4111,6 +4884,8 @@ export declare function setBillingInfo(): Promise<void>;
|
|
|
4111
4884
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4112
4885
|
* @permissionScope Manage Stores - all permissions
|
|
4113
4886
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4887
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4888
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4114
4889
|
* @permissionScope Manage eCommerce - all permissions
|
|
4115
4890
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4116
4891
|
* @applicableIdentity APP
|
|
@@ -4126,6 +4901,8 @@ export declare function getDraftOrder(draftOrderId: string): Promise<GetDraftOrd
|
|
|
4126
4901
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4127
4902
|
* @permissionScope Manage Stores - all permissions
|
|
4128
4903
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4904
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4905
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4129
4906
|
* @permissionScope Manage eCommerce - all permissions
|
|
4130
4907
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4131
4908
|
* @applicableIdentity APP
|
|
@@ -4144,6 +4921,8 @@ export declare function getOrderDraftabilityStatus(orderId: string): Promise<Get
|
|
|
4144
4921
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4145
4922
|
* @permissionScope Manage Stores - all permissions
|
|
4146
4923
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4924
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4925
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4147
4926
|
* @permissionScope Manage eCommerce - all permissions
|
|
4148
4927
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4149
4928
|
* @applicableIdentity APP
|
|
@@ -4153,7 +4932,10 @@ export declare function commitDraftOrder(draftOrderId: string, options?: CommitD
|
|
|
4153
4932
|
export interface CommitDraftOrderOptions {
|
|
4154
4933
|
/** Optional side effects to trigger */
|
|
4155
4934
|
commitSettings?: DraftOrderCommitSettings;
|
|
4156
|
-
/**
|
|
4935
|
+
/**
|
|
4936
|
+
* Reason for edit, given by user (optional).
|
|
4937
|
+
* @maxLength 200
|
|
4938
|
+
*/
|
|
4157
4939
|
reason?: string | null;
|
|
4158
4940
|
}
|
|
4159
4941
|
/**
|
|
@@ -4166,6 +4948,8 @@ export interface CommitDraftOrderOptions {
|
|
|
4166
4948
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4167
4949
|
* @permissionScope Manage Stores - all permissions
|
|
4168
4950
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4951
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4952
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4169
4953
|
* @permissionScope Manage eCommerce - all permissions
|
|
4170
4954
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4171
4955
|
* @applicableIdentity APP
|
|
@@ -4183,6 +4967,8 @@ export declare function createOrderFromDraft(): Promise<void>;
|
|
|
4183
4967
|
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
4184
4968
|
* @permissionScope Manage Stores - all permissions
|
|
4185
4969
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4970
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4971
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4186
4972
|
* @permissionScope Manage eCommerce - all permissions
|
|
4187
4973
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4188
4974
|
* @applicableIdentity APP
|
|
@@ -4204,6 +4990,8 @@ export declare function deleteDraftOrder(draftOrderId: string): Promise<void>;
|
|
|
4204
4990
|
* @documentationMaturity preview
|
|
4205
4991
|
* @permissionScope Manage Stores - all permissions
|
|
4206
4992
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4993
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4994
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4207
4995
|
* @permissionScope Manage eCommerce - all permissions
|
|
4208
4996
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4209
4997
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
@@ -4295,6 +5083,8 @@ export interface DraftOrdersQueryBuilder {
|
|
|
4295
5083
|
* @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
|
|
4296
5084
|
* @permissionScope Manage Stores - all permissions
|
|
4297
5085
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
5086
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
5087
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4298
5088
|
* @permissionScope Manage eCommerce - all permissions
|
|
4299
5089
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4300
5090
|
* @applicableIdentity APP
|
|
@@ -4308,6 +5098,8 @@ export declare function setTaxExemption(): Promise<void>;
|
|
|
4308
5098
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|
|
4309
5099
|
* @permissionScope Manage Stores - all permissions
|
|
4310
5100
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
5101
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
5102
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4311
5103
|
* @permissionScope Manage eCommerce - all permissions
|
|
4312
5104
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4313
5105
|
* @applicableIdentity APP
|