@wix/auto_sdk_ecom_draft-orders 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +1017 -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 +1086 -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 +1017 -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 +1086 -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 +997 -225
- 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 +1075 -264
- 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 +997 -225
- 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 +1075 -264
- 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
|
/**
|
|
@@ -238,6 +284,13 @@ export interface OrderLineItem {
|
|
|
238
284
|
* @readonly
|
|
239
285
|
*/
|
|
240
286
|
depositAmount?: Price;
|
|
287
|
+
/**
|
|
288
|
+
* Line item locations.
|
|
289
|
+
*
|
|
290
|
+
* The location's total quantity must not exceed the line item quantity.
|
|
291
|
+
* @maxSize 5
|
|
292
|
+
*/
|
|
293
|
+
locations?: LocationAndQuantity[];
|
|
241
294
|
/**
|
|
242
295
|
* Address used for tax calculation.
|
|
243
296
|
* @internal
|
|
@@ -246,6 +299,7 @@ export interface OrderLineItem {
|
|
|
246
299
|
/**
|
|
247
300
|
* ID of the app managing the inventory.
|
|
248
301
|
* @internal
|
|
302
|
+
* @format GUID
|
|
249
303
|
*/
|
|
250
304
|
inventoryAppId?: string | null;
|
|
251
305
|
/**
|
|
@@ -261,6 +315,8 @@ export interface ProductName {
|
|
|
261
315
|
*
|
|
262
316
|
* Min: 1 character.
|
|
263
317
|
* Max: 200 characters.
|
|
318
|
+
* @minLength 1
|
|
319
|
+
* @maxLength 200
|
|
264
320
|
*/
|
|
265
321
|
original?: string;
|
|
266
322
|
/**
|
|
@@ -269,12 +325,18 @@ export interface ProductName {
|
|
|
269
325
|
* Min: 1 character.
|
|
270
326
|
* Max: 400 characters.
|
|
271
327
|
* Default: Same as `original`.
|
|
328
|
+
* @minLength 1
|
|
329
|
+
* @maxLength 400
|
|
272
330
|
*/
|
|
273
331
|
translated?: string | null;
|
|
274
332
|
}
|
|
275
333
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
276
334
|
export interface CatalogReference {
|
|
277
|
-
/**
|
|
335
|
+
/**
|
|
336
|
+
* ID of the item within the catalog it belongs to.
|
|
337
|
+
* @minLength 1
|
|
338
|
+
* @maxLength 36
|
|
339
|
+
*/
|
|
278
340
|
catalogItemId?: string;
|
|
279
341
|
/**
|
|
280
342
|
* ID of the app providing the catalog.
|
|
@@ -285,6 +347,7 @@ export interface CatalogReference {
|
|
|
285
347
|
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
286
348
|
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
287
349
|
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
350
|
+
* @minLength 1
|
|
288
351
|
*/
|
|
289
352
|
appId?: string;
|
|
290
353
|
/**
|
|
@@ -313,32 +376,44 @@ export interface DescriptionLineValueOneOf {
|
|
|
313
376
|
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
314
377
|
}
|
|
315
378
|
export interface DescriptionLineName {
|
|
316
|
-
/**
|
|
379
|
+
/**
|
|
380
|
+
* 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).
|
|
381
|
+
* @maxLength 100
|
|
382
|
+
*/
|
|
317
383
|
original?: string;
|
|
318
384
|
/**
|
|
319
385
|
* Description line name translated into the buyer's language.
|
|
320
386
|
*
|
|
321
387
|
* Default: Same as `original`.
|
|
388
|
+
* @maxLength 200
|
|
322
389
|
*/
|
|
323
390
|
translated?: string | null;
|
|
324
391
|
}
|
|
325
392
|
export interface PlainTextValue {
|
|
326
|
-
/**
|
|
393
|
+
/**
|
|
394
|
+
* 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).
|
|
395
|
+
* @maxLength 600
|
|
396
|
+
*/
|
|
327
397
|
original?: string;
|
|
328
398
|
/**
|
|
329
399
|
* Description line plain text value translated into the buyer's language.
|
|
330
400
|
*
|
|
331
401
|
* Default: Same as `original`.
|
|
402
|
+
* @maxLength 600
|
|
332
403
|
*/
|
|
333
404
|
translated?: string | null;
|
|
334
405
|
}
|
|
335
406
|
export interface Color {
|
|
336
|
-
/**
|
|
407
|
+
/**
|
|
408
|
+
* 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).
|
|
409
|
+
* @maxLength 500
|
|
410
|
+
*/
|
|
337
411
|
original?: string;
|
|
338
412
|
/**
|
|
339
413
|
* Description line color name translated into the buyer's language.
|
|
340
414
|
*
|
|
341
415
|
* Default: Same as `original`.
|
|
416
|
+
* @maxLength 500
|
|
342
417
|
*/
|
|
343
418
|
translated?: string | null;
|
|
344
419
|
/** HEX or RGB color code for display. */
|
|
@@ -365,7 +440,10 @@ export interface FocalPoint {
|
|
|
365
440
|
export interface PhysicalProperties {
|
|
366
441
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
367
442
|
weight?: number | null;
|
|
368
|
-
/**
|
|
443
|
+
/**
|
|
444
|
+
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
445
|
+
* @maxLength 40
|
|
446
|
+
*/
|
|
369
447
|
sku?: string | null;
|
|
370
448
|
/** Whether this line item is shippable. */
|
|
371
449
|
shippable?: boolean;
|
|
@@ -406,7 +484,10 @@ export declare enum PaymentOptionType {
|
|
|
406
484
|
export interface ItemTaxFullDetails {
|
|
407
485
|
/** Taxable amount of this line item. */
|
|
408
486
|
taxableAmount?: Price;
|
|
409
|
-
/**
|
|
487
|
+
/**
|
|
488
|
+
* Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
|
|
489
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
490
|
+
*/
|
|
410
491
|
taxRate?: string;
|
|
411
492
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
412
493
|
totalTax?: Price;
|
|
@@ -416,16 +497,24 @@ export interface LineItemTaxInfo {
|
|
|
416
497
|
taxAmount?: Price;
|
|
417
498
|
/** Amount for which tax is calculated. */
|
|
418
499
|
taxableAmount?: Price;
|
|
419
|
-
/**
|
|
500
|
+
/**
|
|
501
|
+
* Tax rate %, as a decimal point.
|
|
502
|
+
* @format DECIMAL_VALUE
|
|
503
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
504
|
+
*/
|
|
420
505
|
taxRate?: string | null;
|
|
421
506
|
/**
|
|
422
507
|
* Tax group ID.
|
|
423
508
|
* Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
|
|
509
|
+
* @format GUID
|
|
424
510
|
*/
|
|
425
511
|
taxGroupId?: string | null;
|
|
426
512
|
/** Indicates whether the price already includes tax. */
|
|
427
513
|
taxIncludedInPrice?: boolean;
|
|
428
|
-
/**
|
|
514
|
+
/**
|
|
515
|
+
* Tax information for a line item.
|
|
516
|
+
* @maxSize 7
|
|
517
|
+
*/
|
|
429
518
|
taxBreakdown?: LineItemTaxBreakdown[];
|
|
430
519
|
}
|
|
431
520
|
/**
|
|
@@ -433,17 +522,28 @@ export interface LineItemTaxInfo {
|
|
|
433
522
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
434
523
|
*/
|
|
435
524
|
export interface LineItemTaxBreakdown {
|
|
436
|
-
/**
|
|
525
|
+
/**
|
|
526
|
+
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
527
|
+
* @maxLength 200
|
|
528
|
+
*/
|
|
437
529
|
jurisdiction?: string | null;
|
|
438
|
-
/**
|
|
530
|
+
/**
|
|
531
|
+
* Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
|
|
532
|
+
* @format DECIMAL_VALUE
|
|
533
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
534
|
+
*/
|
|
439
535
|
rate?: string | null;
|
|
440
536
|
/** Amount of tax calculated for this line item. */
|
|
441
537
|
taxAmount?: Price;
|
|
442
|
-
/**
|
|
538
|
+
/**
|
|
539
|
+
* The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
|
|
540
|
+
* @maxLength 200
|
|
541
|
+
*/
|
|
443
542
|
taxType?: string | null;
|
|
444
543
|
/**
|
|
445
544
|
* The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
|
|
446
545
|
* This name should be explicit enough to allow the merchant to understand what tax was calculated.
|
|
546
|
+
* @maxLength 200
|
|
447
547
|
*/
|
|
448
548
|
taxName?: string | null;
|
|
449
549
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
@@ -463,9 +563,18 @@ export declare enum JurisdictionType {
|
|
|
463
563
|
SPECIAL = "SPECIAL"
|
|
464
564
|
}
|
|
465
565
|
export interface DigitalFile {
|
|
466
|
-
/**
|
|
566
|
+
/**
|
|
567
|
+
* ID of the secure file in media.
|
|
568
|
+
* @minLength 1
|
|
569
|
+
* @maxLength 100
|
|
570
|
+
*/
|
|
467
571
|
fileId?: string;
|
|
468
|
-
/**
|
|
572
|
+
/**
|
|
573
|
+
* Link will exist after the digital links have been generated on the order.
|
|
574
|
+
* @format WEB_URL
|
|
575
|
+
* @minLength 1
|
|
576
|
+
* @maxLength 2000
|
|
577
|
+
*/
|
|
469
578
|
link?: string | null;
|
|
470
579
|
/**
|
|
471
580
|
* Link expiration time and date.
|
|
@@ -474,30 +583,54 @@ export interface DigitalFile {
|
|
|
474
583
|
expirationDate?: Date | null;
|
|
475
584
|
}
|
|
476
585
|
export interface SubscriptionInfo {
|
|
477
|
-
/**
|
|
586
|
+
/**
|
|
587
|
+
* Subscription ID.
|
|
588
|
+
* @format GUID
|
|
589
|
+
*/
|
|
478
590
|
_id?: string | null;
|
|
479
|
-
/**
|
|
591
|
+
/**
|
|
592
|
+
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
593
|
+
* @min 1
|
|
594
|
+
*/
|
|
480
595
|
cycleNumber?: number;
|
|
481
|
-
/**
|
|
596
|
+
/**
|
|
597
|
+
* Subscription option title. For example, `"Monthly coffee Subscription"`.
|
|
598
|
+
* @minLength 1
|
|
599
|
+
* @maxLength 20
|
|
600
|
+
*/
|
|
482
601
|
subscriptionOptionTitle?: string;
|
|
483
|
-
/**
|
|
602
|
+
/**
|
|
603
|
+
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
604
|
+
* @maxLength 60
|
|
605
|
+
*/
|
|
484
606
|
subscriptionOptionDescription?: string | null;
|
|
485
|
-
/**
|
|
607
|
+
/**
|
|
608
|
+
* Subscription detailed information.
|
|
609
|
+
* @immutable
|
|
610
|
+
*/
|
|
486
611
|
subscriptionSettings?: SubscriptionSettings;
|
|
487
612
|
/**
|
|
488
613
|
* Description of the charges that will be applied for subscription.
|
|
489
614
|
* @internal
|
|
615
|
+
* @maxLength 1000
|
|
490
616
|
*/
|
|
491
617
|
chargesDescription?: string | null;
|
|
492
618
|
}
|
|
493
619
|
export interface SubscriptionSettings {
|
|
494
620
|
/** Frequency of recurring payment. */
|
|
495
621
|
frequency?: SubscriptionFrequency;
|
|
496
|
-
/**
|
|
622
|
+
/**
|
|
623
|
+
* Interval of recurring payment.
|
|
624
|
+
* @min 1
|
|
625
|
+
* @max 50
|
|
626
|
+
*/
|
|
497
627
|
interval?: number | null;
|
|
498
628
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
499
629
|
autoRenewal?: boolean;
|
|
500
|
-
/**
|
|
630
|
+
/**
|
|
631
|
+
* Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
|
|
632
|
+
* @min 1
|
|
633
|
+
*/
|
|
501
634
|
billingCycles?: number | null;
|
|
502
635
|
/**
|
|
503
636
|
* Whether to allow the customer to cancel the subscription.
|
|
@@ -526,23 +659,35 @@ export declare enum SubscriptionFrequency {
|
|
|
526
659
|
export interface FreeTrialPeriod {
|
|
527
660
|
/** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
|
|
528
661
|
frequency?: SubscriptionFrequency;
|
|
529
|
-
/**
|
|
662
|
+
/**
|
|
663
|
+
* interval of period
|
|
664
|
+
* @min 1
|
|
665
|
+
* @max 50
|
|
666
|
+
*/
|
|
530
667
|
interval?: number;
|
|
531
668
|
}
|
|
532
669
|
export interface LocationAndQuantity {
|
|
533
|
-
/**
|
|
670
|
+
/**
|
|
671
|
+
* Location id in the associated owner app.
|
|
672
|
+
* @format GUID
|
|
673
|
+
*/
|
|
534
674
|
_id?: string;
|
|
535
675
|
/**
|
|
536
676
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
677
|
+
* @format GUID
|
|
537
678
|
* @deprecated Location owner app, if not provided then the site business info locations will be used.
|
|
538
679
|
* @targetRemovalDate 2025-03-01
|
|
539
680
|
*/
|
|
540
681
|
appId?: string | null;
|
|
541
|
-
/**
|
|
682
|
+
/**
|
|
683
|
+
* Quantity for specific location.
|
|
684
|
+
* @min 1
|
|
685
|
+
* @max 100000
|
|
686
|
+
*/
|
|
542
687
|
quantity?: number;
|
|
543
688
|
/**
|
|
544
689
|
* Location name.
|
|
545
|
-
* @
|
|
690
|
+
* @maxLength 500
|
|
546
691
|
* @readonly
|
|
547
692
|
*/
|
|
548
693
|
name?: string | null;
|
|
@@ -574,7 +719,11 @@ export interface ExtendedFields {
|
|
|
574
719
|
namespaces?: Record<string, Record<string, any>>;
|
|
575
720
|
}
|
|
576
721
|
export interface ItemChangedDetails {
|
|
577
|
-
/**
|
|
722
|
+
/**
|
|
723
|
+
* Line item quantity before change.
|
|
724
|
+
* @min 1
|
|
725
|
+
* @max 1000000
|
|
726
|
+
*/
|
|
578
727
|
quantityBeforeChange?: number | null;
|
|
579
728
|
/** Line item price before change. */
|
|
580
729
|
priceBeforeChange?: Price;
|
|
@@ -601,13 +750,22 @@ export interface ShippingDetailsChangeTypeOneOf {
|
|
|
601
750
|
removed?: boolean;
|
|
602
751
|
}
|
|
603
752
|
export interface V1ShippingInformation {
|
|
604
|
-
/**
|
|
753
|
+
/**
|
|
754
|
+
* App Def Id of external provider which was a source of shipping info
|
|
755
|
+
* @minLength 1
|
|
756
|
+
* @maxLength 100
|
|
757
|
+
*/
|
|
605
758
|
carrierId?: string | null;
|
|
606
|
-
/**
|
|
759
|
+
/**
|
|
760
|
+
* Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
|
|
761
|
+
* @minLength 1
|
|
762
|
+
* @maxLength 100
|
|
763
|
+
*/
|
|
607
764
|
code?: string | null;
|
|
608
765
|
/**
|
|
609
766
|
* Shipping option title.
|
|
610
767
|
* For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
|
|
768
|
+
* @maxLength 250
|
|
611
769
|
*/
|
|
612
770
|
title?: string;
|
|
613
771
|
/** Shipping logistics. */
|
|
@@ -622,9 +780,15 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
|
622
780
|
shippingDestination?: AddressWithContact;
|
|
623
781
|
/** Pickup details. */
|
|
624
782
|
pickupDetails?: V1PickupDetails;
|
|
625
|
-
/**
|
|
783
|
+
/**
|
|
784
|
+
* Expected delivery time in free text. For example, `"3-5 business days"`.
|
|
785
|
+
* @maxLength 500
|
|
786
|
+
*/
|
|
626
787
|
deliveryTime?: string | null;
|
|
627
|
-
/**
|
|
788
|
+
/**
|
|
789
|
+
* Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
|
|
790
|
+
* @maxLength 1000
|
|
791
|
+
*/
|
|
628
792
|
instructions?: string | null;
|
|
629
793
|
/**
|
|
630
794
|
* 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 +814,37 @@ export interface AddressWithContact {
|
|
|
650
814
|
}
|
|
651
815
|
/** Physical address */
|
|
652
816
|
export interface Address {
|
|
653
|
-
/**
|
|
817
|
+
/**
|
|
818
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
819
|
+
* @format COUNTRY
|
|
820
|
+
*/
|
|
654
821
|
country?: string | null;
|
|
655
|
-
/**
|
|
822
|
+
/**
|
|
823
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
824
|
+
* @maxLength 50
|
|
825
|
+
*/
|
|
656
826
|
subdivision?: string | null;
|
|
657
|
-
/**
|
|
827
|
+
/**
|
|
828
|
+
* City name.
|
|
829
|
+
* @maxLength 50
|
|
830
|
+
*/
|
|
658
831
|
city?: string | null;
|
|
659
|
-
/**
|
|
832
|
+
/**
|
|
833
|
+
* Postal or zip code.
|
|
834
|
+
* @maxLength 50
|
|
835
|
+
*/
|
|
660
836
|
postalCode?: string | null;
|
|
661
837
|
/** Street address. */
|
|
662
838
|
streetAddress?: StreetAddress;
|
|
663
|
-
/**
|
|
839
|
+
/**
|
|
840
|
+
* Main address line (usually street name and number).
|
|
841
|
+
* @maxLength 150
|
|
842
|
+
*/
|
|
664
843
|
addressLine1?: string | null;
|
|
665
|
-
/**
|
|
844
|
+
/**
|
|
845
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
846
|
+
* @maxLength 100
|
|
847
|
+
*/
|
|
666
848
|
addressLine2?: string | null;
|
|
667
849
|
/**
|
|
668
850
|
* Country's full name.
|
|
@@ -689,13 +871,25 @@ export interface AddressLocation {
|
|
|
689
871
|
}
|
|
690
872
|
/** Full contact details for an address */
|
|
691
873
|
export interface FullAddressContactDetails {
|
|
692
|
-
/**
|
|
874
|
+
/**
|
|
875
|
+
* First name.
|
|
876
|
+
* @maxLength 100
|
|
877
|
+
*/
|
|
693
878
|
firstName?: string | null;
|
|
694
|
-
/**
|
|
879
|
+
/**
|
|
880
|
+
* Last name.
|
|
881
|
+
* @maxLength 100
|
|
882
|
+
*/
|
|
695
883
|
lastName?: string | null;
|
|
696
|
-
/**
|
|
884
|
+
/**
|
|
885
|
+
* Phone number.
|
|
886
|
+
* @format PHONE
|
|
887
|
+
*/
|
|
697
888
|
phone?: string | null;
|
|
698
|
-
/**
|
|
889
|
+
/**
|
|
890
|
+
* Company name.
|
|
891
|
+
* @maxLength 1000
|
|
892
|
+
*/
|
|
699
893
|
company?: string | null;
|
|
700
894
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
701
895
|
vatId?: VatId;
|
|
@@ -728,19 +922,37 @@ export interface V1PickupDetails {
|
|
|
728
922
|
}
|
|
729
923
|
/** Physical address */
|
|
730
924
|
export interface PickupAddress {
|
|
731
|
-
/**
|
|
925
|
+
/**
|
|
926
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
927
|
+
* @format COUNTRY
|
|
928
|
+
*/
|
|
732
929
|
country?: string | null;
|
|
733
|
-
/**
|
|
930
|
+
/**
|
|
931
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
932
|
+
* @maxLength 50
|
|
933
|
+
*/
|
|
734
934
|
subdivision?: string | null;
|
|
735
|
-
/**
|
|
935
|
+
/**
|
|
936
|
+
* City name.
|
|
937
|
+
* @maxLength 1000
|
|
938
|
+
*/
|
|
736
939
|
city?: string | null;
|
|
737
|
-
/**
|
|
940
|
+
/**
|
|
941
|
+
* Postal or zip code.
|
|
942
|
+
* @maxLength 1000
|
|
943
|
+
*/
|
|
738
944
|
postalCode?: string | null;
|
|
739
945
|
/** Street address object, with number, name, and apartment number in separate fields. */
|
|
740
946
|
streetAddress?: StreetAddress;
|
|
741
|
-
/**
|
|
947
|
+
/**
|
|
948
|
+
* Main address line (usually street name and number).
|
|
949
|
+
* @maxLength 1000
|
|
950
|
+
*/
|
|
742
951
|
addressLine1?: string | null;
|
|
743
|
-
/**
|
|
952
|
+
/**
|
|
953
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
954
|
+
* @maxLength 1000
|
|
955
|
+
*/
|
|
744
956
|
addressLine2?: string | null;
|
|
745
957
|
/**
|
|
746
958
|
* Country's full name.
|
|
@@ -786,7 +998,10 @@ export interface V1ShippingPrice {
|
|
|
786
998
|
discount?: Price;
|
|
787
999
|
}
|
|
788
1000
|
export interface ShippingRegion {
|
|
789
|
-
/**
|
|
1001
|
+
/**
|
|
1002
|
+
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1003
|
+
* @maxLength 100
|
|
1004
|
+
*/
|
|
790
1005
|
name?: string | null;
|
|
791
1006
|
}
|
|
792
1007
|
export interface ShippingChangedDetails {
|
|
@@ -795,20 +1010,38 @@ export interface ShippingChangedDetails {
|
|
|
795
1010
|
}
|
|
796
1011
|
/** Buyer Info */
|
|
797
1012
|
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
798
|
-
/**
|
|
1013
|
+
/**
|
|
1014
|
+
* Visitor ID (if site visitor is not a member).
|
|
1015
|
+
* @format GUID
|
|
1016
|
+
*/
|
|
799
1017
|
visitorId?: string;
|
|
800
|
-
/**
|
|
1018
|
+
/**
|
|
1019
|
+
* Member ID (if site visitor is a site member).
|
|
1020
|
+
* @format GUID
|
|
1021
|
+
*/
|
|
801
1022
|
memberId?: string;
|
|
802
|
-
/**
|
|
1023
|
+
/**
|
|
1024
|
+
* 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).
|
|
1025
|
+
* @format GUID
|
|
1026
|
+
*/
|
|
803
1027
|
contactId?: string | null;
|
|
804
|
-
/**
|
|
1028
|
+
/**
|
|
1029
|
+
* Buyer email address.
|
|
1030
|
+
* @format EMAIL
|
|
1031
|
+
*/
|
|
805
1032
|
email?: string | null;
|
|
806
1033
|
}
|
|
807
1034
|
/** @oneof */
|
|
808
1035
|
export interface BuyerInfoIdOneOf {
|
|
809
|
-
/**
|
|
1036
|
+
/**
|
|
1037
|
+
* Visitor ID (if site visitor is not a member).
|
|
1038
|
+
* @format GUID
|
|
1039
|
+
*/
|
|
810
1040
|
visitorId?: string;
|
|
811
|
-
/**
|
|
1041
|
+
/**
|
|
1042
|
+
* Member ID (if site visitor is a site member).
|
|
1043
|
+
* @format GUID
|
|
1044
|
+
*/
|
|
812
1045
|
memberId?: string;
|
|
813
1046
|
}
|
|
814
1047
|
export interface AdditionalFeeDetails {
|
|
@@ -828,38 +1061,59 @@ export interface AdditionalFeeDetails {
|
|
|
828
1061
|
applied?: boolean;
|
|
829
1062
|
}
|
|
830
1063
|
export interface AdditionalFee {
|
|
831
|
-
/**
|
|
1064
|
+
/**
|
|
1065
|
+
* Additional fee's unique code for future processing.
|
|
1066
|
+
* @minLength 1
|
|
1067
|
+
* @maxLength 100
|
|
1068
|
+
*/
|
|
832
1069
|
code?: string | null;
|
|
833
|
-
/**
|
|
1070
|
+
/**
|
|
1071
|
+
* Name of additional fee.
|
|
1072
|
+
* @minLength 1
|
|
1073
|
+
* @maxLength 50
|
|
1074
|
+
*/
|
|
834
1075
|
name?: string;
|
|
835
1076
|
/** Additional fee's price. */
|
|
836
1077
|
price?: Price;
|
|
837
1078
|
/** Tax details. */
|
|
838
1079
|
taxDetails?: ItemTaxFullDetails;
|
|
839
|
-
/**
|
|
1080
|
+
/**
|
|
1081
|
+
* SPI implementer's `appId`.
|
|
1082
|
+
* @format GUID
|
|
1083
|
+
*/
|
|
840
1084
|
providerAppId?: string | null;
|
|
841
1085
|
/** Additional fee's price before tax. */
|
|
842
1086
|
priceBeforeTax?: Price;
|
|
843
1087
|
/** Additional fee's price after tax. */
|
|
844
1088
|
priceAfterTax?: Price;
|
|
845
|
-
/**
|
|
1089
|
+
/**
|
|
1090
|
+
* Additional fee's id.
|
|
1091
|
+
* @format GUID
|
|
1092
|
+
* @immutable
|
|
1093
|
+
*/
|
|
846
1094
|
_id?: string;
|
|
847
1095
|
/**
|
|
848
1096
|
* Optional - Line items associated with this additional fee.
|
|
849
1097
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
1098
|
+
* @format GUID
|
|
850
1099
|
*/
|
|
851
1100
|
lineItemIds?: string[];
|
|
852
1101
|
/**
|
|
853
1102
|
* Number of subscription billing cycles the additional fee applies to.
|
|
854
1103
|
* If None and additional fee is linked to subscription line item, it applies to all cycles.
|
|
855
1104
|
* @internal
|
|
1105
|
+
* @min 1
|
|
1106
|
+
* @max 999
|
|
856
1107
|
*/
|
|
857
1108
|
subscriptionCycles?: number | null;
|
|
858
1109
|
}
|
|
859
1110
|
export interface TaxDetails {
|
|
860
1111
|
/** Indication if additional fee is taxable or not */
|
|
861
1112
|
taxable?: boolean;
|
|
862
|
-
/**
|
|
1113
|
+
/**
|
|
1114
|
+
* Optional tax group ID to use when calculating tax for this additional fee
|
|
1115
|
+
* @format GUID
|
|
1116
|
+
*/
|
|
863
1117
|
taxGroupId?: string | null;
|
|
864
1118
|
}
|
|
865
1119
|
export declare enum SourceType {
|
|
@@ -901,18 +1155,26 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
901
1155
|
/**
|
|
902
1156
|
* IDs of line items discount applies to.
|
|
903
1157
|
* Deprecated. Use `line_item_discounts` instead.
|
|
1158
|
+
* @format GUID
|
|
1159
|
+
* @maxSize 1
|
|
904
1160
|
* @deprecated IDs of line items discount applies to.
|
|
905
1161
|
* Deprecated. Use `line_item_discounts` instead.
|
|
906
1162
|
* @replacedBy line_item_discounts
|
|
907
1163
|
* @targetRemovalDate 2024-10-30
|
|
908
1164
|
*/
|
|
909
1165
|
lineItemIds?: string[];
|
|
910
|
-
/**
|
|
1166
|
+
/**
|
|
1167
|
+
* Discount id.
|
|
1168
|
+
* @format GUID
|
|
1169
|
+
* @immutable
|
|
1170
|
+
*/
|
|
911
1171
|
_id?: string | null;
|
|
912
1172
|
/**
|
|
913
1173
|
* Number of subscription billing cycles the discount applies to.
|
|
914
1174
|
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
915
1175
|
* @internal
|
|
1176
|
+
* @min 1
|
|
1177
|
+
* @max 999
|
|
916
1178
|
*/
|
|
917
1179
|
subscriptionCycles?: number | null;
|
|
918
1180
|
}
|
|
@@ -947,13 +1209,18 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
947
1209
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
948
1210
|
*/
|
|
949
1211
|
discountReason?: DiscountReason;
|
|
950
|
-
/**
|
|
1212
|
+
/**
|
|
1213
|
+
* Discount description as free text (optional).
|
|
1214
|
+
* @maxLength 200
|
|
1215
|
+
*/
|
|
951
1216
|
description?: string | null;
|
|
952
1217
|
/** Discount amount. */
|
|
953
1218
|
amount?: Price;
|
|
954
1219
|
/**
|
|
955
1220
|
* Discount percentage.
|
|
956
1221
|
* @internal
|
|
1222
|
+
* @format DECIMAL_VALUE
|
|
1223
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
957
1224
|
*/
|
|
958
1225
|
percentage?: string | null;
|
|
959
1226
|
}
|
|
@@ -964,7 +1231,10 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
964
1231
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
965
1232
|
*/
|
|
966
1233
|
discountReason?: DiscountReason;
|
|
967
|
-
/**
|
|
1234
|
+
/**
|
|
1235
|
+
* Discount description as free text (optional).
|
|
1236
|
+
* @maxLength 200
|
|
1237
|
+
*/
|
|
968
1238
|
description?: string | null;
|
|
969
1239
|
}
|
|
970
1240
|
export declare enum DiscountReason {
|
|
@@ -972,7 +1242,10 @@ export declare enum DiscountReason {
|
|
|
972
1242
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
|
|
973
1243
|
}
|
|
974
1244
|
export interface DiscountRule {
|
|
975
|
-
/**
|
|
1245
|
+
/**
|
|
1246
|
+
* Discount rule ID
|
|
1247
|
+
* @format GUID
|
|
1248
|
+
*/
|
|
976
1249
|
_id?: string;
|
|
977
1250
|
/** Discount rule name */
|
|
978
1251
|
name?: DiscountRuleName;
|
|
@@ -980,28 +1253,51 @@ export interface DiscountRule {
|
|
|
980
1253
|
amount?: Price;
|
|
981
1254
|
}
|
|
982
1255
|
export interface DiscountRuleName {
|
|
983
|
-
/**
|
|
1256
|
+
/**
|
|
1257
|
+
* Original discount rule name (in site's default language).
|
|
1258
|
+
* @minLength 1
|
|
1259
|
+
* @maxLength 256
|
|
1260
|
+
*/
|
|
984
1261
|
original?: string;
|
|
985
|
-
/**
|
|
1262
|
+
/**
|
|
1263
|
+
* Translated discount rule name according to buyer language. Defaults to `original` when not provided.
|
|
1264
|
+
* @minLength 1
|
|
1265
|
+
* @maxLength 500
|
|
1266
|
+
*/
|
|
986
1267
|
translated?: string | null;
|
|
987
1268
|
}
|
|
988
1269
|
export interface LineItemDiscount {
|
|
989
|
-
/**
|
|
1270
|
+
/**
|
|
1271
|
+
* ID of line item the discount applies to.
|
|
1272
|
+
* @format GUID
|
|
1273
|
+
*/
|
|
990
1274
|
_id?: string;
|
|
991
1275
|
/** Total discount for this line item. */
|
|
992
1276
|
totalDiscount?: Price;
|
|
993
1277
|
}
|
|
994
1278
|
export interface CreatedBy extends CreatedByStringOneOf {
|
|
995
|
-
/**
|
|
1279
|
+
/**
|
|
1280
|
+
* User ID. When the draft order was created by a Wix user.
|
|
1281
|
+
* @format GUID
|
|
1282
|
+
*/
|
|
996
1283
|
userId?: string;
|
|
997
|
-
/**
|
|
1284
|
+
/**
|
|
1285
|
+
* App ID. When the draft order was created by an app.
|
|
1286
|
+
* @format GUID
|
|
1287
|
+
*/
|
|
998
1288
|
appId?: string;
|
|
999
1289
|
}
|
|
1000
1290
|
/** @oneof */
|
|
1001
1291
|
export interface CreatedByStringOneOf {
|
|
1002
|
-
/**
|
|
1292
|
+
/**
|
|
1293
|
+
* User ID. When the draft order was created by a Wix user.
|
|
1294
|
+
* @format GUID
|
|
1295
|
+
*/
|
|
1003
1296
|
userId?: string;
|
|
1004
|
-
/**
|
|
1297
|
+
/**
|
|
1298
|
+
* App ID. When the draft order was created by an app.
|
|
1299
|
+
* @format GUID
|
|
1300
|
+
*/
|
|
1005
1301
|
appId?: string;
|
|
1006
1302
|
}
|
|
1007
1303
|
export declare enum EditingStatus {
|
|
@@ -1063,6 +1359,7 @@ export interface Balance {
|
|
|
1063
1359
|
* Balance amount.
|
|
1064
1360
|
*
|
|
1065
1361
|
* 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.
|
|
1362
|
+
* @decimalValue options { }
|
|
1066
1363
|
* @readonly
|
|
1067
1364
|
*/
|
|
1068
1365
|
amount?: string;
|
|
@@ -1101,11 +1398,15 @@ export interface DraftOrderCommitSettings {
|
|
|
1101
1398
|
/**
|
|
1102
1399
|
* Line item IDs for which to perform an inventory change.
|
|
1103
1400
|
* When not provided, inventory will not change.
|
|
1401
|
+
* @maxSize 300
|
|
1104
1402
|
*/
|
|
1105
1403
|
updateInventory?: InventoryUpdate[];
|
|
1106
1404
|
}
|
|
1107
1405
|
export interface InventoryUpdate {
|
|
1108
|
-
/**
|
|
1406
|
+
/**
|
|
1407
|
+
* Line item ID.
|
|
1408
|
+
* @format GUID
|
|
1409
|
+
*/
|
|
1109
1410
|
lineItemId?: string;
|
|
1110
1411
|
}
|
|
1111
1412
|
export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
@@ -1134,7 +1435,10 @@ export interface RecipientInfoChangedDetails {
|
|
|
1134
1435
|
export interface OrderTaxInfo {
|
|
1135
1436
|
/** Calculated tax, added from line items. */
|
|
1136
1437
|
totalTax?: Price;
|
|
1137
|
-
/**
|
|
1438
|
+
/**
|
|
1439
|
+
* 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.
|
|
1440
|
+
* @maxSize 50
|
|
1441
|
+
*/
|
|
1138
1442
|
taxBreakdown?: OrderTaxBreakdown[];
|
|
1139
1443
|
/**
|
|
1140
1444
|
* Whether the order is exempt from tax calculations.
|
|
@@ -1149,15 +1453,28 @@ export interface OrderTaxInfo {
|
|
|
1149
1453
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1150
1454
|
*/
|
|
1151
1455
|
export interface OrderTaxBreakdown {
|
|
1152
|
-
/**
|
|
1456
|
+
/**
|
|
1457
|
+
* The name of the tax against which this tax amount was calculated.
|
|
1458
|
+
* @maxLength 200
|
|
1459
|
+
*/
|
|
1153
1460
|
taxName?: string;
|
|
1154
|
-
/**
|
|
1461
|
+
/**
|
|
1462
|
+
* The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
|
|
1463
|
+
* @maxLength 200
|
|
1464
|
+
*/
|
|
1155
1465
|
taxType?: string;
|
|
1156
|
-
/**
|
|
1466
|
+
/**
|
|
1467
|
+
* The name of the jurisdiction in which this tax detail applies.
|
|
1468
|
+
* @maxLength 200
|
|
1469
|
+
*/
|
|
1157
1470
|
jurisdiction?: string;
|
|
1158
1471
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1159
1472
|
jurisdictionType?: JurisdictionType;
|
|
1160
|
-
/**
|
|
1473
|
+
/**
|
|
1474
|
+
* The rate at which this tax detail was calculated.
|
|
1475
|
+
* @format DECIMAL_VALUE
|
|
1476
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
1477
|
+
*/
|
|
1161
1478
|
rate?: string;
|
|
1162
1479
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1163
1480
|
aggregatedTaxAmount?: Price;
|
|
@@ -1257,66 +1574,48 @@ export interface BillingChangedDetails {
|
|
|
1257
1574
|
billingInfoBeforeChange?: AddressWithContact;
|
|
1258
1575
|
}
|
|
1259
1576
|
export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1260
|
-
/**
|
|
1261
|
-
* Indicates that business location was added during draft.
|
|
1262
|
-
* @internal
|
|
1263
|
-
*/
|
|
1577
|
+
/** Indicates that business location was added during draft. */
|
|
1264
1578
|
added?: boolean;
|
|
1265
|
-
/**
|
|
1266
|
-
* Indicates that business location was changed. Contains business location before draft.
|
|
1267
|
-
* @internal
|
|
1268
|
-
*/
|
|
1579
|
+
/** Indicates that business location was changed. Contains business location before draft. */
|
|
1269
1580
|
changedDetails?: BusinessLocationChangedDetails;
|
|
1270
|
-
/**
|
|
1271
|
-
* Indicates that business location was removed during draft.
|
|
1272
|
-
* @internal
|
|
1273
|
-
*/
|
|
1581
|
+
/** Indicates that business location was removed during draft. */
|
|
1274
1582
|
removed?: boolean;
|
|
1275
|
-
/**
|
|
1276
|
-
* Business location.
|
|
1277
|
-
* @internal
|
|
1278
|
-
*/
|
|
1583
|
+
/** Business location. */
|
|
1279
1584
|
businessLocation?: Location;
|
|
1280
1585
|
}
|
|
1281
1586
|
/** @oneof */
|
|
1282
1587
|
export interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1283
|
-
/**
|
|
1284
|
-
* Indicates that business location was added during draft.
|
|
1285
|
-
* @internal
|
|
1286
|
-
*/
|
|
1588
|
+
/** Indicates that business location was added during draft. */
|
|
1287
1589
|
added?: boolean;
|
|
1288
|
-
/**
|
|
1289
|
-
* Indicates that business location was changed. Contains business location before draft.
|
|
1290
|
-
* @internal
|
|
1291
|
-
*/
|
|
1590
|
+
/** Indicates that business location was changed. Contains business location before draft. */
|
|
1292
1591
|
changedDetails?: BusinessLocationChangedDetails;
|
|
1293
|
-
/**
|
|
1294
|
-
* Indicates that business location was removed during draft.
|
|
1295
|
-
* @internal
|
|
1296
|
-
*/
|
|
1592
|
+
/** Indicates that business location was removed during draft. */
|
|
1297
1593
|
removed?: boolean;
|
|
1298
1594
|
}
|
|
1299
1595
|
export interface Location {
|
|
1300
1596
|
/**
|
|
1301
1597
|
* Location ID.
|
|
1302
1598
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1599
|
+
* @format GUID
|
|
1303
1600
|
*/
|
|
1304
1601
|
_id?: string;
|
|
1305
1602
|
/**
|
|
1306
1603
|
* Location name.
|
|
1604
|
+
* @minLength 1
|
|
1605
|
+
* @maxLength 500
|
|
1307
1606
|
* @readonly
|
|
1308
1607
|
*/
|
|
1309
1608
|
name?: string;
|
|
1310
1609
|
}
|
|
1311
1610
|
export interface BusinessLocationChangedDetails {
|
|
1312
|
-
/**
|
|
1313
|
-
* Business location before draft.
|
|
1314
|
-
* @internal
|
|
1315
|
-
*/
|
|
1611
|
+
/** Business location before draft. */
|
|
1316
1612
|
businessLocationBeforeChange?: Location;
|
|
1317
1613
|
}
|
|
1318
1614
|
export interface CreateDraftOrderRequest {
|
|
1319
|
-
/**
|
|
1615
|
+
/**
|
|
1616
|
+
* To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
|
|
1617
|
+
* @format GUID
|
|
1618
|
+
*/
|
|
1320
1619
|
orderId: string | null;
|
|
1321
1620
|
}
|
|
1322
1621
|
export interface CreateDraftOrderResponse {
|
|
@@ -1340,7 +1639,10 @@ export interface CalculatedDraftOrder {
|
|
|
1340
1639
|
calculationErrors?: CalculationErrors;
|
|
1341
1640
|
}
|
|
1342
1641
|
export interface ShippingOption {
|
|
1343
|
-
/**
|
|
1642
|
+
/**
|
|
1643
|
+
* This carrier's unique ID
|
|
1644
|
+
* @format GUID
|
|
1645
|
+
*/
|
|
1344
1646
|
carrierId?: string | null;
|
|
1345
1647
|
/** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
|
|
1346
1648
|
code?: string;
|
|
@@ -1387,7 +1689,10 @@ export interface DeliveryTimeSlot {
|
|
|
1387
1689
|
export interface ShippingPrice {
|
|
1388
1690
|
/** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
|
|
1389
1691
|
price?: Price;
|
|
1390
|
-
/**
|
|
1692
|
+
/**
|
|
1693
|
+
* 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.
|
|
1694
|
+
* @format CURRENCY
|
|
1695
|
+
*/
|
|
1391
1696
|
currency?: string;
|
|
1392
1697
|
}
|
|
1393
1698
|
export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
@@ -1518,29 +1823,54 @@ export interface CreateEmptyDraftOrderResponse {
|
|
|
1518
1823
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1519
1824
|
}
|
|
1520
1825
|
export interface AddLineItemsToDraftOrderRequest {
|
|
1521
|
-
/**
|
|
1826
|
+
/**
|
|
1827
|
+
* The draft order id
|
|
1828
|
+
* @format GUID
|
|
1829
|
+
*/
|
|
1522
1830
|
draftOrderId: string;
|
|
1523
|
-
/**
|
|
1831
|
+
/**
|
|
1832
|
+
* Catalog line items to add to draft order.
|
|
1833
|
+
* @maxSize 300
|
|
1834
|
+
*/
|
|
1524
1835
|
catalogLineItems?: CatalogReferenceLineItem[];
|
|
1525
|
-
/**
|
|
1836
|
+
/**
|
|
1837
|
+
* Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
|
|
1838
|
+
* @maxSize 300
|
|
1839
|
+
*/
|
|
1526
1840
|
customLineItems?: CustomLineItem[];
|
|
1527
1841
|
}
|
|
1528
1842
|
export interface CatalogReferenceLineItem {
|
|
1529
1843
|
/** 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
1844
|
catalogReference?: CatalogReference;
|
|
1531
|
-
/**
|
|
1845
|
+
/**
|
|
1846
|
+
* Item quantity.
|
|
1847
|
+
* @min 1
|
|
1848
|
+
* @max 100000
|
|
1849
|
+
*/
|
|
1532
1850
|
quantity?: number;
|
|
1533
1851
|
/** Item price override. */
|
|
1534
1852
|
price?: Price;
|
|
1853
|
+
/**
|
|
1854
|
+
* Line item locations.
|
|
1855
|
+
*
|
|
1856
|
+
* The location's total quantity must not exceed the line item quantity.
|
|
1857
|
+
* @maxSize 5
|
|
1858
|
+
*/
|
|
1859
|
+
locations?: LocationAndQuantity[];
|
|
1535
1860
|
}
|
|
1536
1861
|
export interface CustomLineItem {
|
|
1537
|
-
/**
|
|
1862
|
+
/**
|
|
1863
|
+
* Line item ID.
|
|
1864
|
+
* @format GUID
|
|
1865
|
+
*/
|
|
1538
1866
|
_id?: string | null;
|
|
1539
1867
|
/**
|
|
1540
1868
|
* Item quantity.
|
|
1541
1869
|
*
|
|
1542
1870
|
* Min: `"1"`
|
|
1543
1871
|
* Max: `"100000"`
|
|
1872
|
+
* @min 1
|
|
1873
|
+
* @max 100000
|
|
1544
1874
|
*/
|
|
1545
1875
|
quantity?: number;
|
|
1546
1876
|
/** 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 +1902,31 @@ export interface CustomLineItem {
|
|
|
1572
1902
|
itemType?: ItemType;
|
|
1573
1903
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1574
1904
|
priceDescription?: PriceDescription;
|
|
1575
|
-
/**
|
|
1905
|
+
/**
|
|
1906
|
+
* Delivery Profile Id for the product
|
|
1907
|
+
* @format GUID
|
|
1908
|
+
*/
|
|
1576
1909
|
deliveryProfileId?: string | null;
|
|
1910
|
+
/**
|
|
1911
|
+
* Line item locations.
|
|
1912
|
+
*
|
|
1913
|
+
* The location's total quantity must not exceed the line item quantity.
|
|
1914
|
+
* @maxSize 5
|
|
1915
|
+
*/
|
|
1916
|
+
locations?: LocationAndQuantity[];
|
|
1577
1917
|
}
|
|
1578
1918
|
export interface SecuredMedia {
|
|
1579
|
-
/**
|
|
1919
|
+
/**
|
|
1920
|
+
* Media ID in Wix Media Manager.
|
|
1921
|
+
* @minLength 1
|
|
1922
|
+
* @maxLength 100
|
|
1923
|
+
*/
|
|
1580
1924
|
_id?: string;
|
|
1581
|
-
/**
|
|
1925
|
+
/**
|
|
1926
|
+
* Original filename.
|
|
1927
|
+
* @minLength 1
|
|
1928
|
+
* @maxLength 1000
|
|
1929
|
+
*/
|
|
1582
1930
|
fileName?: string;
|
|
1583
1931
|
/** File type. */
|
|
1584
1932
|
fileType?: FileType;
|
|
@@ -1596,17 +1944,33 @@ export interface AddLineItemsToDraftOrderResponse {
|
|
|
1596
1944
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1597
1945
|
}
|
|
1598
1946
|
export interface UpdateLineItemsRequest {
|
|
1599
|
-
/**
|
|
1947
|
+
/**
|
|
1948
|
+
* The draft order id
|
|
1949
|
+
* @format GUID
|
|
1950
|
+
*/
|
|
1600
1951
|
draftOrderId: string;
|
|
1601
|
-
/**
|
|
1952
|
+
/**
|
|
1953
|
+
* Details of changes to apply per line item
|
|
1954
|
+
* @minSize 1
|
|
1955
|
+
* @maxSize 300
|
|
1956
|
+
*/
|
|
1602
1957
|
lineItemChanges?: LineItemChangeDetails[];
|
|
1603
1958
|
}
|
|
1604
1959
|
export interface LineItemChangeDetails {
|
|
1605
|
-
/**
|
|
1960
|
+
/**
|
|
1961
|
+
* The line item id to change
|
|
1962
|
+
* @format GUID
|
|
1963
|
+
*/
|
|
1606
1964
|
lineItemId?: string;
|
|
1607
|
-
/**
|
|
1965
|
+
/**
|
|
1966
|
+
* The new quantity for the line item. quantity zero means to remove the line item.
|
|
1967
|
+
* @max 1000000
|
|
1968
|
+
*/
|
|
1608
1969
|
newQuantity?: number | null;
|
|
1609
|
-
/**
|
|
1970
|
+
/**
|
|
1971
|
+
* The new price for 1 unit of the line item
|
|
1972
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
1973
|
+
*/
|
|
1610
1974
|
newPrice?: string | null;
|
|
1611
1975
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1612
1976
|
newPriceDescription?: PriceDescription;
|
|
@@ -1616,9 +1980,15 @@ export interface UpdateLineItemsResponse {
|
|
|
1616
1980
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1617
1981
|
}
|
|
1618
1982
|
export interface SetDiscountsRequest {
|
|
1619
|
-
/**
|
|
1983
|
+
/**
|
|
1984
|
+
* The draft order id
|
|
1985
|
+
* @format GUID
|
|
1986
|
+
*/
|
|
1620
1987
|
draftOrderId: string;
|
|
1621
|
-
/**
|
|
1988
|
+
/**
|
|
1989
|
+
* The discount ids to opt-in. all existing discounts not listed are to be opted-out.
|
|
1990
|
+
* @minSize 1
|
|
1991
|
+
*/
|
|
1622
1992
|
discounts: IdAndApplied[];
|
|
1623
1993
|
}
|
|
1624
1994
|
export interface IdAndApplied {
|
|
@@ -1632,9 +2002,16 @@ export interface SetDiscountsResponse {
|
|
|
1632
2002
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1633
2003
|
}
|
|
1634
2004
|
export interface CreateCustomDiscountsRequest {
|
|
1635
|
-
/**
|
|
2005
|
+
/**
|
|
2006
|
+
* The draft order id
|
|
2007
|
+
* @format GUID
|
|
2008
|
+
*/
|
|
1636
2009
|
draftOrderId: string;
|
|
1637
|
-
/**
|
|
2010
|
+
/**
|
|
2011
|
+
* The discounts to add.
|
|
2012
|
+
* @minSize 1
|
|
2013
|
+
* @maxSize 100
|
|
2014
|
+
*/
|
|
1638
2015
|
discounts?: DiscountOption[];
|
|
1639
2016
|
}
|
|
1640
2017
|
export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
@@ -1646,6 +2023,8 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1646
2023
|
/**
|
|
1647
2024
|
* Discount percentage amount.
|
|
1648
2025
|
* @internal
|
|
2026
|
+
* @format DECIMAL_VALUE
|
|
2027
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1649
2028
|
*/
|
|
1650
2029
|
percentage?: string | null;
|
|
1651
2030
|
/**
|
|
@@ -1657,6 +2036,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1657
2036
|
discountType?: DiscountType;
|
|
1658
2037
|
/**
|
|
1659
2038
|
* ID of line item discount applies to.
|
|
2039
|
+
* @format GUID
|
|
1660
2040
|
* @deprecated ID of line item discount applies to.
|
|
1661
2041
|
* @replacedBy line_item_discounts
|
|
1662
2042
|
* @targetRemovalDate 2024-10-30
|
|
@@ -1669,7 +2049,10 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1669
2049
|
* @targetRemovalDate 2024-08-30
|
|
1670
2050
|
*/
|
|
1671
2051
|
amount?: Price;
|
|
1672
|
-
/**
|
|
2052
|
+
/**
|
|
2053
|
+
* Discount description as free text (optional).
|
|
2054
|
+
* @maxLength 200
|
|
2055
|
+
*/
|
|
1673
2056
|
description?: string | null;
|
|
1674
2057
|
/**
|
|
1675
2058
|
* Should opt-in the added discount. default = false.
|
|
@@ -1687,6 +2070,8 @@ export interface DiscountOptionDiscountAmountOneOf {
|
|
|
1687
2070
|
/**
|
|
1688
2071
|
* Discount percentage amount.
|
|
1689
2072
|
* @internal
|
|
2073
|
+
* @format DECIMAL_VALUE
|
|
2074
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1690
2075
|
*/
|
|
1691
2076
|
percentage?: string | null;
|
|
1692
2077
|
}
|
|
@@ -1701,9 +2086,17 @@ export interface CreateCustomDiscountsResponse {
|
|
|
1701
2086
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1702
2087
|
}
|
|
1703
2088
|
export interface DeleteCustomDiscountsRequest {
|
|
1704
|
-
/**
|
|
2089
|
+
/**
|
|
2090
|
+
* The draft order id
|
|
2091
|
+
* @format GUID
|
|
2092
|
+
*/
|
|
1705
2093
|
draftOrderId: string;
|
|
1706
|
-
/**
|
|
2094
|
+
/**
|
|
2095
|
+
* The discounts to remove
|
|
2096
|
+
* @format GUID
|
|
2097
|
+
* @minSize 1
|
|
2098
|
+
* @maxSize 100
|
|
2099
|
+
*/
|
|
1707
2100
|
discountIds: string[];
|
|
1708
2101
|
}
|
|
1709
2102
|
export interface DeleteCustomDiscountsResponse {
|
|
@@ -1711,9 +2104,16 @@ export interface DeleteCustomDiscountsResponse {
|
|
|
1711
2104
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1712
2105
|
}
|
|
1713
2106
|
export interface SetAdditionalFeesRequest {
|
|
1714
|
-
/**
|
|
2107
|
+
/**
|
|
2108
|
+
* The draft order id
|
|
2109
|
+
* @format GUID
|
|
2110
|
+
*/
|
|
1715
2111
|
draftOrderId: string;
|
|
1716
|
-
/**
|
|
2112
|
+
/**
|
|
2113
|
+
* The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
|
|
2114
|
+
* @minSize 1
|
|
2115
|
+
* @maxSize 100
|
|
2116
|
+
*/
|
|
1717
2117
|
additionalFees: IdAndApplied[];
|
|
1718
2118
|
}
|
|
1719
2119
|
export interface SetAdditionalFeesResponse {
|
|
@@ -1721,13 +2121,24 @@ export interface SetAdditionalFeesResponse {
|
|
|
1721
2121
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1722
2122
|
}
|
|
1723
2123
|
export interface CreateCustomAdditionalFeesRequest {
|
|
1724
|
-
/**
|
|
2124
|
+
/**
|
|
2125
|
+
* The draft order id
|
|
2126
|
+
* @format GUID
|
|
2127
|
+
*/
|
|
1725
2128
|
draftOrderId: string;
|
|
1726
|
-
/**
|
|
2129
|
+
/**
|
|
2130
|
+
* The additional fees to add. added with opted-out setting
|
|
2131
|
+
* @minSize 1
|
|
2132
|
+
* @maxSize 100
|
|
2133
|
+
*/
|
|
1727
2134
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
1728
2135
|
}
|
|
1729
2136
|
export interface AdditionalFeeOption {
|
|
1730
|
-
/**
|
|
2137
|
+
/**
|
|
2138
|
+
* Translated additional fee's name
|
|
2139
|
+
* @minLength 1
|
|
2140
|
+
* @maxLength 50
|
|
2141
|
+
*/
|
|
1731
2142
|
name?: string;
|
|
1732
2143
|
/** Additional fee's price */
|
|
1733
2144
|
price?: Price;
|
|
@@ -1738,7 +2149,11 @@ export interface AdditionalFeeOption {
|
|
|
1738
2149
|
* if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee ids
|
|
1739
2150
|
*/
|
|
1740
2151
|
applyToDraftOrder?: boolean | null;
|
|
1741
|
-
/**
|
|
2152
|
+
/**
|
|
2153
|
+
* Additional fee's unique code (or ID) for future processing
|
|
2154
|
+
* @minLength 1
|
|
2155
|
+
* @maxLength 100
|
|
2156
|
+
*/
|
|
1742
2157
|
code?: string | null;
|
|
1743
2158
|
}
|
|
1744
2159
|
export interface CreateCustomAdditionalFeesResponse {
|
|
@@ -1746,9 +2161,17 @@ export interface CreateCustomAdditionalFeesResponse {
|
|
|
1746
2161
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1747
2162
|
}
|
|
1748
2163
|
export interface DeleteCustomAdditionalFeesRequest {
|
|
1749
|
-
/**
|
|
2164
|
+
/**
|
|
2165
|
+
* The draft order id
|
|
2166
|
+
* @format GUID
|
|
2167
|
+
*/
|
|
1750
2168
|
draftOrderId: string;
|
|
1751
|
-
/**
|
|
2169
|
+
/**
|
|
2170
|
+
* The additional fees to remove
|
|
2171
|
+
* @format GUID
|
|
2172
|
+
* @minSize 1
|
|
2173
|
+
* @maxSize 100
|
|
2174
|
+
*/
|
|
1752
2175
|
customAdditionalFees: string[];
|
|
1753
2176
|
}
|
|
1754
2177
|
export interface DeleteCustomAdditionalFeesResponse {
|
|
@@ -1759,6 +2182,7 @@ export interface SetShippingInfoRequest {
|
|
|
1759
2182
|
/**
|
|
1760
2183
|
* The draft order id
|
|
1761
2184
|
* @internal
|
|
2185
|
+
* @format GUID
|
|
1762
2186
|
*/
|
|
1763
2187
|
draftOrderId: string;
|
|
1764
2188
|
/**
|
|
@@ -1778,6 +2202,7 @@ export interface SetBuyerInfoRequest {
|
|
|
1778
2202
|
/**
|
|
1779
2203
|
* The draft order id
|
|
1780
2204
|
* @internal
|
|
2205
|
+
* @format GUID
|
|
1781
2206
|
*/
|
|
1782
2207
|
draftOrderId: string;
|
|
1783
2208
|
/**
|
|
@@ -1797,6 +2222,7 @@ export interface SetRecipientInfoRequest {
|
|
|
1797
2222
|
/**
|
|
1798
2223
|
* The draft order id
|
|
1799
2224
|
* @internal
|
|
2225
|
+
* @format GUID
|
|
1800
2226
|
*/
|
|
1801
2227
|
draftOrderId: string;
|
|
1802
2228
|
/**
|
|
@@ -1816,6 +2242,7 @@ export interface SetBillingInfoRequest {
|
|
|
1816
2242
|
/**
|
|
1817
2243
|
* The draft order id
|
|
1818
2244
|
* @internal
|
|
2245
|
+
* @format GUID
|
|
1819
2246
|
*/
|
|
1820
2247
|
draftOrderId: string;
|
|
1821
2248
|
/**
|
|
@@ -1832,7 +2259,10 @@ export interface SetBillingInfoResponse {
|
|
|
1832
2259
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1833
2260
|
}
|
|
1834
2261
|
export interface UpdateShippingInfoRequest {
|
|
1835
|
-
/**
|
|
2262
|
+
/**
|
|
2263
|
+
* The draft order id
|
|
2264
|
+
* @format GUID
|
|
2265
|
+
*/
|
|
1836
2266
|
draftOrderId?: string;
|
|
1837
2267
|
/** update the shipping option on the order. if not set then the selected shipping is removed */
|
|
1838
2268
|
shippingOption?: ShippingOption;
|
|
@@ -1842,7 +2272,10 @@ export interface UpdateShippingInfoResponse {
|
|
|
1842
2272
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1843
2273
|
}
|
|
1844
2274
|
export interface GetDraftOrderRequest {
|
|
1845
|
-
/**
|
|
2275
|
+
/**
|
|
2276
|
+
* The draft order id
|
|
2277
|
+
* @format GUID
|
|
2278
|
+
*/
|
|
1846
2279
|
draftOrderId: string;
|
|
1847
2280
|
}
|
|
1848
2281
|
export interface GetDraftOrderResponse {
|
|
@@ -1850,15 +2283,26 @@ export interface GetDraftOrderResponse {
|
|
|
1850
2283
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1851
2284
|
}
|
|
1852
2285
|
export interface GetOrderDraftabilityStatusRequest {
|
|
1853
|
-
/**
|
|
2286
|
+
/**
|
|
2287
|
+
* Order ID.
|
|
2288
|
+
* @minLength 1
|
|
2289
|
+
* @maxLength 100
|
|
2290
|
+
*/
|
|
1854
2291
|
orderId: string;
|
|
1855
2292
|
}
|
|
1856
2293
|
export interface GetOrderDraftabilityStatusResponse {
|
|
1857
|
-
/**
|
|
2294
|
+
/**
|
|
2295
|
+
* Order ID.
|
|
2296
|
+
* @minLength 1
|
|
2297
|
+
* @maxLength 100
|
|
2298
|
+
*/
|
|
1858
2299
|
orderId?: string;
|
|
1859
2300
|
/** Whether a draft can be created from this order */
|
|
1860
2301
|
orderDraftable?: boolean;
|
|
1861
|
-
/**
|
|
2302
|
+
/**
|
|
2303
|
+
* Reasons why the order is not draftable
|
|
2304
|
+
* @maxSize 5
|
|
2305
|
+
*/
|
|
1862
2306
|
nonDraftableReasons?: NonDraftableReason[];
|
|
1863
2307
|
}
|
|
1864
2308
|
export declare enum NonDraftableReason {
|
|
@@ -1876,11 +2320,17 @@ export declare enum NonDraftableReason {
|
|
|
1876
2320
|
TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
|
|
1877
2321
|
}
|
|
1878
2322
|
export interface CommitDraftOrderRequest {
|
|
1879
|
-
/**
|
|
2323
|
+
/**
|
|
2324
|
+
* The draft order id
|
|
2325
|
+
* @format GUID
|
|
2326
|
+
*/
|
|
1880
2327
|
draftOrderId: string;
|
|
1881
2328
|
/** Optional side effects to trigger */
|
|
1882
2329
|
commitSettings?: DraftOrderCommitSettings;
|
|
1883
|
-
/**
|
|
2330
|
+
/**
|
|
2331
|
+
* Reason for edit, given by user (optional).
|
|
2332
|
+
* @maxLength 200
|
|
2333
|
+
*/
|
|
1884
2334
|
reason?: string | null;
|
|
1885
2335
|
}
|
|
1886
2336
|
export interface CommitDraftOrderResponse {
|
|
@@ -1892,6 +2342,7 @@ export interface CommitDraftOrderResponse {
|
|
|
1892
2342
|
export interface Order {
|
|
1893
2343
|
/**
|
|
1894
2344
|
* Order ID.
|
|
2345
|
+
* @format GUID
|
|
1895
2346
|
* @readonly
|
|
1896
2347
|
*/
|
|
1897
2348
|
_id?: string | null;
|
|
@@ -1903,6 +2354,7 @@ export interface Order {
|
|
|
1903
2354
|
/**
|
|
1904
2355
|
* Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
1905
2356
|
* @readonly
|
|
2357
|
+
* @immutable
|
|
1906
2358
|
*/
|
|
1907
2359
|
_createdDate?: Date | null;
|
|
1908
2360
|
/**
|
|
@@ -1912,6 +2364,8 @@ export interface Order {
|
|
|
1912
2364
|
_updatedDate?: Date | null;
|
|
1913
2365
|
/**
|
|
1914
2366
|
* Order line items.
|
|
2367
|
+
* @minSize 1
|
|
2368
|
+
* @maxSize 300
|
|
1915
2369
|
* @readonly
|
|
1916
2370
|
*/
|
|
1917
2371
|
lineItems?: OrderLineItem[];
|
|
@@ -1931,13 +2385,20 @@ export interface Order {
|
|
|
1931
2385
|
buyerLanguage?: string | null;
|
|
1932
2386
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
1933
2387
|
weightUnit?: WeightUnit;
|
|
1934
|
-
/**
|
|
2388
|
+
/**
|
|
2389
|
+
* 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.
|
|
2390
|
+
* @format CURRENCY
|
|
2391
|
+
*/
|
|
1935
2392
|
currency?: string | null;
|
|
1936
|
-
/**
|
|
2393
|
+
/**
|
|
2394
|
+
* Whether tax is included in line item prices.
|
|
2395
|
+
* @immutable
|
|
2396
|
+
*/
|
|
1937
2397
|
taxIncludedInPrices?: boolean;
|
|
1938
2398
|
/**
|
|
1939
2399
|
* Site language in which original values are shown.
|
|
1940
2400
|
* @readonly
|
|
2401
|
+
* @immutable
|
|
1941
2402
|
*/
|
|
1942
2403
|
siteLanguage?: string | null;
|
|
1943
2404
|
/**
|
|
@@ -1949,7 +2410,10 @@ export interface Order {
|
|
|
1949
2410
|
billingInfo?: AddressWithContact;
|
|
1950
2411
|
/** Shipping info and selected shipping option details. */
|
|
1951
2412
|
shippingInfo?: V1ShippingInformation;
|
|
1952
|
-
/**
|
|
2413
|
+
/**
|
|
2414
|
+
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
2415
|
+
* @maxLength 1000
|
|
2416
|
+
*/
|
|
1953
2417
|
buyerNote?: string | null;
|
|
1954
2418
|
/** Order status. */
|
|
1955
2419
|
status?: OrderStatus;
|
|
@@ -1968,11 +2432,15 @@ export interface Order {
|
|
|
1968
2432
|
taxSummary?: TaxSummary;
|
|
1969
2433
|
/** Tax information. */
|
|
1970
2434
|
taxInfo?: OrderTaxInfo;
|
|
1971
|
-
/**
|
|
2435
|
+
/**
|
|
2436
|
+
* Applied discounts.
|
|
2437
|
+
* @maxSize 320
|
|
2438
|
+
*/
|
|
1972
2439
|
appliedDiscounts?: AppliedDiscount[];
|
|
1973
2440
|
/**
|
|
1974
2441
|
* Order activities.
|
|
1975
2442
|
* @readonly
|
|
2443
|
+
* @maxSize 1000
|
|
1976
2444
|
*/
|
|
1977
2445
|
activities?: Activity[];
|
|
1978
2446
|
/** Order attribution source. */
|
|
@@ -1986,7 +2454,10 @@ export interface Order {
|
|
|
1986
2454
|
channelInfo?: ChannelInfo;
|
|
1987
2455
|
/** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
|
|
1988
2456
|
seenByAHuman?: boolean | null;
|
|
1989
|
-
/**
|
|
2457
|
+
/**
|
|
2458
|
+
* Checkout ID.
|
|
2459
|
+
* @format GUID
|
|
2460
|
+
*/
|
|
1990
2461
|
checkoutId?: string | null;
|
|
1991
2462
|
/** Custom fields. */
|
|
1992
2463
|
customFields?: CustomField[];
|
|
@@ -1995,7 +2466,10 @@ export interface Order {
|
|
|
1995
2466
|
* @readonly
|
|
1996
2467
|
*/
|
|
1997
2468
|
balanceSummary?: V1BalanceSummary;
|
|
1998
|
-
/**
|
|
2469
|
+
/**
|
|
2470
|
+
* Additional fees applied to the order.
|
|
2471
|
+
* @maxSize 100
|
|
2472
|
+
*/
|
|
1999
2473
|
additionalFees?: AdditionalFee[];
|
|
2000
2474
|
/**
|
|
2001
2475
|
* Custom field data for the order object.
|
|
@@ -2003,7 +2477,10 @@ export interface Order {
|
|
|
2003
2477
|
* [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
2478
|
*/
|
|
2005
2479
|
extendedFields?: ExtendedFields;
|
|
2006
|
-
/**
|
|
2480
|
+
/**
|
|
2481
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
2482
|
+
* @format GUID
|
|
2483
|
+
*/
|
|
2007
2484
|
purchaseFlowId?: string | null;
|
|
2008
2485
|
/**
|
|
2009
2486
|
* Order recipient address and contact details.
|
|
@@ -2016,8 +2493,11 @@ export interface Order {
|
|
|
2016
2493
|
/**
|
|
2017
2494
|
* 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
2495
|
* Used for migration from external systems.
|
|
2496
|
+
* @immutable
|
|
2019
2497
|
*/
|
|
2020
2498
|
purchasedDate?: Date | null;
|
|
2499
|
+
/** Order Location */
|
|
2500
|
+
businessLocation?: Location;
|
|
2021
2501
|
/**
|
|
2022
2502
|
* Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
|
|
2023
2503
|
* @internal
|
|
@@ -2165,11 +2645,13 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2165
2645
|
receiptSent?: ReceiptSent;
|
|
2166
2646
|
/**
|
|
2167
2647
|
* Activity ID.
|
|
2648
|
+
* @format GUID
|
|
2168
2649
|
* @readonly
|
|
2169
2650
|
*/
|
|
2170
2651
|
_id?: string | null;
|
|
2171
2652
|
/**
|
|
2172
2653
|
* Activity author's email.
|
|
2654
|
+
* @format EMAIL
|
|
2173
2655
|
* @readonly
|
|
2174
2656
|
*/
|
|
2175
2657
|
authorEmail?: string | null;
|
|
@@ -2245,16 +2727,26 @@ export interface ActivityContentOneOf {
|
|
|
2245
2727
|
receiptSent?: ReceiptSent;
|
|
2246
2728
|
}
|
|
2247
2729
|
export interface CustomActivity {
|
|
2248
|
-
/**
|
|
2730
|
+
/**
|
|
2731
|
+
* ID of the app that created the custom activity.
|
|
2732
|
+
* @format GUID
|
|
2733
|
+
*/
|
|
2249
2734
|
appId?: string;
|
|
2250
|
-
/**
|
|
2735
|
+
/**
|
|
2736
|
+
* Custom activity type. For example, `"Ticket number set"`.
|
|
2737
|
+
* @maxLength 100
|
|
2738
|
+
*/
|
|
2251
2739
|
type?: string;
|
|
2252
2740
|
/** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
|
|
2253
2741
|
additionalData?: Record<string, string>;
|
|
2254
2742
|
}
|
|
2255
2743
|
/** Store owner added a comment */
|
|
2256
2744
|
export interface MerchantComment {
|
|
2257
|
-
/**
|
|
2745
|
+
/**
|
|
2746
|
+
* Merchant comment message.
|
|
2747
|
+
* @minLength 1
|
|
2748
|
+
* @maxLength 5000
|
|
2749
|
+
*/
|
|
2258
2750
|
message?: string;
|
|
2259
2751
|
}
|
|
2260
2752
|
export interface OrderRefunded {
|
|
@@ -2262,29 +2754,52 @@ export interface OrderRefunded {
|
|
|
2262
2754
|
manual?: boolean;
|
|
2263
2755
|
/** Refund amount. */
|
|
2264
2756
|
amount?: Price;
|
|
2265
|
-
/**
|
|
2757
|
+
/**
|
|
2758
|
+
* Reason for refund.
|
|
2759
|
+
* @maxLength 200
|
|
2760
|
+
*/
|
|
2266
2761
|
reason?: string;
|
|
2267
2762
|
}
|
|
2268
2763
|
export interface OrderCreatedFromExchange {
|
|
2269
|
-
/**
|
|
2764
|
+
/**
|
|
2765
|
+
* ID of the original order for which the exchange happened.
|
|
2766
|
+
* @format GUID
|
|
2767
|
+
*/
|
|
2270
2768
|
originalOrderId?: string;
|
|
2271
2769
|
}
|
|
2272
2770
|
export interface NewExchangeOrderCreated {
|
|
2273
|
-
/**
|
|
2771
|
+
/**
|
|
2772
|
+
* ID of the new order created as a result of an exchange of items.
|
|
2773
|
+
* @format GUID
|
|
2774
|
+
*/
|
|
2274
2775
|
exchangeOrderId?: string;
|
|
2275
|
-
/**
|
|
2776
|
+
/**
|
|
2777
|
+
* IDs of the items that were exchanged.
|
|
2778
|
+
* @minSize 1
|
|
2779
|
+
* @maxSize 300
|
|
2780
|
+
*/
|
|
2276
2781
|
lineItems?: LineItemExchangeData[];
|
|
2277
2782
|
}
|
|
2278
2783
|
export interface LineItemExchangeData {
|
|
2279
|
-
/**
|
|
2784
|
+
/**
|
|
2785
|
+
* ID of the exchanged line item.
|
|
2786
|
+
* @format GUID
|
|
2787
|
+
*/
|
|
2280
2788
|
lineItemId?: string;
|
|
2281
|
-
/**
|
|
2789
|
+
/**
|
|
2790
|
+
* Line item quantity being exchanged.
|
|
2791
|
+
* @min 1
|
|
2792
|
+
* @max 100000
|
|
2793
|
+
*/
|
|
2282
2794
|
quantity?: number;
|
|
2283
2795
|
}
|
|
2284
2796
|
export interface DraftOrderChangesApplied {
|
|
2285
2797
|
/** Draft order id. */
|
|
2286
2798
|
draftOrderId?: string;
|
|
2287
|
-
/**
|
|
2799
|
+
/**
|
|
2800
|
+
* Reason for edit, given by user (optional).
|
|
2801
|
+
* @maxLength 200
|
|
2802
|
+
*/
|
|
2288
2803
|
reason?: string | null;
|
|
2289
2804
|
/** Changes applied to order. */
|
|
2290
2805
|
changes?: OrderChange[];
|
|
@@ -2313,7 +2828,10 @@ export interface OrderChangeValueOneOf {
|
|
|
2313
2828
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2314
2829
|
}
|
|
2315
2830
|
export interface LineItemChanges {
|
|
2316
|
-
/**
|
|
2831
|
+
/**
|
|
2832
|
+
* Line item ID.
|
|
2833
|
+
* @format GUID
|
|
2834
|
+
*/
|
|
2317
2835
|
_id?: string;
|
|
2318
2836
|
/** Item name. */
|
|
2319
2837
|
name?: ProductName;
|
|
@@ -2323,11 +2841,21 @@ export interface LineItemChanges {
|
|
|
2323
2841
|
price?: LineItemPriceChange;
|
|
2324
2842
|
}
|
|
2325
2843
|
export interface LineItemQuantityChange {
|
|
2326
|
-
/**
|
|
2844
|
+
/**
|
|
2845
|
+
* Item quantity before update.
|
|
2846
|
+
* @max 1000000
|
|
2847
|
+
*/
|
|
2327
2848
|
originalQuantity?: number;
|
|
2328
|
-
/**
|
|
2849
|
+
/**
|
|
2850
|
+
* Item quantity after update.
|
|
2851
|
+
* @max 1000000
|
|
2852
|
+
*/
|
|
2329
2853
|
newQuantity?: number;
|
|
2330
|
-
/**
|
|
2854
|
+
/**
|
|
2855
|
+
* Difference between original and new quantity. Absolute value.
|
|
2856
|
+
* @min 1
|
|
2857
|
+
* @max 1000000
|
|
2858
|
+
*/
|
|
2331
2859
|
diff?: number;
|
|
2332
2860
|
/** Type of quantity change: increase or decrease. */
|
|
2333
2861
|
deltaType?: LineItemQuantityChangeType;
|
|
@@ -2345,15 +2873,25 @@ export interface LineItemPriceChange {
|
|
|
2345
2873
|
newPrice?: Price;
|
|
2346
2874
|
}
|
|
2347
2875
|
export interface ManagedLineItem {
|
|
2348
|
-
/**
|
|
2876
|
+
/**
|
|
2877
|
+
* Line item ID.
|
|
2878
|
+
* @format GUID
|
|
2879
|
+
*/
|
|
2349
2880
|
_id?: string;
|
|
2350
2881
|
/** Item name. */
|
|
2351
2882
|
name?: ProductName;
|
|
2352
|
-
/**
|
|
2883
|
+
/**
|
|
2884
|
+
* Added or removed item quantity.
|
|
2885
|
+
* @min 1
|
|
2886
|
+
* @max 1000000
|
|
2887
|
+
*/
|
|
2353
2888
|
quantity?: number;
|
|
2354
2889
|
}
|
|
2355
2890
|
export interface ManagedDiscount {
|
|
2356
|
-
/**
|
|
2891
|
+
/**
|
|
2892
|
+
* Discount id.
|
|
2893
|
+
* @format GUID
|
|
2894
|
+
*/
|
|
2357
2895
|
_id?: string;
|
|
2358
2896
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2359
2897
|
name?: TranslatedValue;
|
|
@@ -2363,13 +2901,22 @@ export interface ManagedDiscount {
|
|
|
2363
2901
|
totalAmount?: Price;
|
|
2364
2902
|
}
|
|
2365
2903
|
export interface TranslatedValue {
|
|
2366
|
-
/**
|
|
2904
|
+
/**
|
|
2905
|
+
* Value in site default language.
|
|
2906
|
+
* @minLength 1
|
|
2907
|
+
*/
|
|
2367
2908
|
original?: string;
|
|
2368
|
-
/**
|
|
2909
|
+
/**
|
|
2910
|
+
* Translated value.
|
|
2911
|
+
* @minLength 1
|
|
2912
|
+
*/
|
|
2369
2913
|
translated?: string | null;
|
|
2370
2914
|
}
|
|
2371
2915
|
export interface LineItemAmount {
|
|
2372
|
-
/**
|
|
2916
|
+
/**
|
|
2917
|
+
* Order line item id
|
|
2918
|
+
* @format GUID
|
|
2919
|
+
*/
|
|
2373
2920
|
_id?: string;
|
|
2374
2921
|
/** Item name. */
|
|
2375
2922
|
name?: ProductName;
|
|
@@ -2377,7 +2924,10 @@ export interface LineItemAmount {
|
|
|
2377
2924
|
amount?: Price;
|
|
2378
2925
|
}
|
|
2379
2926
|
export interface ManagedAdditionalFee {
|
|
2380
|
-
/**
|
|
2927
|
+
/**
|
|
2928
|
+
* Additional fee id.
|
|
2929
|
+
* @format GUID
|
|
2930
|
+
*/
|
|
2381
2931
|
_id?: string;
|
|
2382
2932
|
/** Additional fee name. */
|
|
2383
2933
|
name?: TranslatedValue;
|
|
@@ -2401,54 +2951,102 @@ export interface ShippingInformationChange {
|
|
|
2401
2951
|
export interface ShippingInformation {
|
|
2402
2952
|
/** Order’s shipping price. */
|
|
2403
2953
|
total?: Price;
|
|
2404
|
-
/**
|
|
2954
|
+
/**
|
|
2955
|
+
* Order’s shipping title.
|
|
2956
|
+
* @maxLength 250
|
|
2957
|
+
*/
|
|
2405
2958
|
shippingTitle?: string;
|
|
2406
2959
|
}
|
|
2407
2960
|
/** Payment method is saved for order */
|
|
2408
2961
|
export interface SavedPaymentMethod {
|
|
2409
|
-
/**
|
|
2962
|
+
/**
|
|
2963
|
+
* Payment method name
|
|
2964
|
+
* @minLength 1
|
|
2965
|
+
* @maxLength 100
|
|
2966
|
+
*/
|
|
2410
2967
|
name?: string;
|
|
2411
|
-
/**
|
|
2968
|
+
/**
|
|
2969
|
+
* Payment method description
|
|
2970
|
+
* @minLength 1
|
|
2971
|
+
* @maxLength 100
|
|
2972
|
+
*/
|
|
2412
2973
|
description?: string | null;
|
|
2413
2974
|
}
|
|
2414
2975
|
export interface AuthorizedPaymentCreated {
|
|
2415
|
-
/**
|
|
2976
|
+
/**
|
|
2977
|
+
* Payment ID of payment associated with this activity
|
|
2978
|
+
* @format GUID
|
|
2979
|
+
*/
|
|
2416
2980
|
paymentId?: string;
|
|
2417
2981
|
/** Payment amount */
|
|
2418
2982
|
amount?: Price;
|
|
2419
|
-
/**
|
|
2983
|
+
/**
|
|
2984
|
+
* The last 4 digits of the card number.
|
|
2985
|
+
* @maxLength 4
|
|
2986
|
+
*/
|
|
2420
2987
|
lastFourDigits?: string | null;
|
|
2421
|
-
/**
|
|
2988
|
+
/**
|
|
2989
|
+
* Card issuer's brand.
|
|
2990
|
+
* @maxLength 100
|
|
2991
|
+
*/
|
|
2422
2992
|
brand?: string | null;
|
|
2423
2993
|
}
|
|
2424
2994
|
export interface AuthorizedPaymentCaptured {
|
|
2425
|
-
/**
|
|
2995
|
+
/**
|
|
2996
|
+
* Payment ID of payment associated with this activity
|
|
2997
|
+
* @format GUID
|
|
2998
|
+
*/
|
|
2426
2999
|
paymentId?: string;
|
|
2427
3000
|
/** Payment amount */
|
|
2428
3001
|
amount?: Price;
|
|
2429
|
-
/**
|
|
3002
|
+
/**
|
|
3003
|
+
* The last 4 digits of the card number.
|
|
3004
|
+
* @maxLength 4
|
|
3005
|
+
*/
|
|
2430
3006
|
lastFourDigits?: string | null;
|
|
2431
|
-
/**
|
|
3007
|
+
/**
|
|
3008
|
+
* Card issuer's brand.
|
|
3009
|
+
* @maxLength 100
|
|
3010
|
+
*/
|
|
2432
3011
|
brand?: string | null;
|
|
2433
3012
|
}
|
|
2434
3013
|
export interface AuthorizedPaymentVoided {
|
|
2435
|
-
/**
|
|
3014
|
+
/**
|
|
3015
|
+
* Payment ID of payment associated with this activity
|
|
3016
|
+
* @format GUID
|
|
3017
|
+
*/
|
|
2436
3018
|
paymentId?: string;
|
|
2437
3019
|
/** Payment amount */
|
|
2438
3020
|
amount?: Price;
|
|
2439
|
-
/**
|
|
3021
|
+
/**
|
|
3022
|
+
* The last 4 digits of the card number.
|
|
3023
|
+
* @maxLength 4
|
|
3024
|
+
*/
|
|
2440
3025
|
lastFourDigits?: string | null;
|
|
2441
|
-
/**
|
|
3026
|
+
/**
|
|
3027
|
+
* Card issuer's brand.
|
|
3028
|
+
* @maxLength 100
|
|
3029
|
+
*/
|
|
2442
3030
|
brand?: string | null;
|
|
2443
3031
|
}
|
|
2444
3032
|
export interface RefundInitiated {
|
|
2445
|
-
/**
|
|
3033
|
+
/**
|
|
3034
|
+
* Refund ID.
|
|
3035
|
+
* @format GUID
|
|
3036
|
+
*/
|
|
2446
3037
|
refundId?: string;
|
|
2447
3038
|
/** Refund amount. */
|
|
2448
3039
|
amount?: Price;
|
|
2449
|
-
/**
|
|
3040
|
+
/**
|
|
3041
|
+
* Details about the payments being refunded.
|
|
3042
|
+
* @minSize 1
|
|
3043
|
+
* @maxSize 50
|
|
3044
|
+
*/
|
|
2450
3045
|
payments?: RefundedPayment[];
|
|
2451
|
-
/**
|
|
3046
|
+
/**
|
|
3047
|
+
* Reason for refund.
|
|
3048
|
+
* @maxLength 100
|
|
3049
|
+
*/
|
|
2452
3050
|
reason?: string | null;
|
|
2453
3051
|
}
|
|
2454
3052
|
export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
@@ -2458,7 +3056,10 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
2458
3056
|
giftCard?: GiftCardPaymentRefund;
|
|
2459
3057
|
/** Membership payment refund. */
|
|
2460
3058
|
membership?: MembershipPaymentRefund;
|
|
2461
|
-
/**
|
|
3059
|
+
/**
|
|
3060
|
+
* Payment ID.
|
|
3061
|
+
* @format GUID
|
|
3062
|
+
*/
|
|
2462
3063
|
paymentId?: string;
|
|
2463
3064
|
/** Whether refund was made externally and manually on the payment provider's side. */
|
|
2464
3065
|
externalRefund?: boolean;
|
|
@@ -2475,29 +3076,49 @@ export interface RefundedPaymentKindOneOf {
|
|
|
2475
3076
|
export interface RegularPaymentRefund {
|
|
2476
3077
|
/** Refund amount */
|
|
2477
3078
|
amount?: Price;
|
|
2478
|
-
/**
|
|
3079
|
+
/**
|
|
3080
|
+
* The last 4 digits of the card number.
|
|
3081
|
+
* @maxLength 4
|
|
3082
|
+
*/
|
|
2479
3083
|
lastFourDigits?: string | null;
|
|
2480
|
-
/**
|
|
3084
|
+
/**
|
|
3085
|
+
* Card issuer's brand.
|
|
3086
|
+
* @maxLength 100
|
|
3087
|
+
*/
|
|
2481
3088
|
brand?: string | null;
|
|
2482
3089
|
}
|
|
2483
3090
|
export interface GiftCardPaymentRefund {
|
|
2484
|
-
/**
|
|
3091
|
+
/**
|
|
3092
|
+
* Gift card payment ID
|
|
3093
|
+
* @minLength 1
|
|
3094
|
+
* @maxLength 100
|
|
3095
|
+
*/
|
|
2485
3096
|
giftCardPaymentId?: string | null;
|
|
2486
3097
|
/** Refund amount */
|
|
2487
3098
|
amount?: Price;
|
|
2488
3099
|
}
|
|
2489
3100
|
export interface MembershipPaymentRefund {
|
|
2490
|
-
/**
|
|
3101
|
+
/**
|
|
3102
|
+
* Membership ID
|
|
3103
|
+
* @minLength 1
|
|
3104
|
+
* @maxLength 100
|
|
3105
|
+
*/
|
|
2491
3106
|
membershipId?: string | null;
|
|
2492
3107
|
}
|
|
2493
3108
|
export interface PaymentRefunded {
|
|
2494
|
-
/**
|
|
3109
|
+
/**
|
|
3110
|
+
* Refund ID.
|
|
3111
|
+
* @format GUID
|
|
3112
|
+
*/
|
|
2495
3113
|
refundId?: string;
|
|
2496
3114
|
/** Details about the refunded payment. */
|
|
2497
3115
|
payment?: RefundedPayment;
|
|
2498
3116
|
}
|
|
2499
3117
|
export interface PaymentRefundFailed {
|
|
2500
|
-
/**
|
|
3118
|
+
/**
|
|
3119
|
+
* Refund ID.
|
|
3120
|
+
* @format GUID
|
|
3121
|
+
*/
|
|
2501
3122
|
refundId?: string;
|
|
2502
3123
|
/** Details about the failed payment refund. */
|
|
2503
3124
|
payment?: RefundedPayment;
|
|
@@ -2505,13 +3126,19 @@ export interface PaymentRefundFailed {
|
|
|
2505
3126
|
export interface RefundedAsStoreCredit {
|
|
2506
3127
|
/** Refund amount */
|
|
2507
3128
|
amount?: Price;
|
|
2508
|
-
/**
|
|
3129
|
+
/**
|
|
3130
|
+
* Reason for refund
|
|
3131
|
+
* @maxLength 100
|
|
3132
|
+
*/
|
|
2509
3133
|
reason?: string | null;
|
|
2510
3134
|
}
|
|
2511
3135
|
export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
2512
3136
|
/** Regular payment. */
|
|
2513
3137
|
regular?: RegularPayment;
|
|
2514
|
-
/**
|
|
3138
|
+
/**
|
|
3139
|
+
* Payment ID of payment associated with this activity
|
|
3140
|
+
* @format GUID
|
|
3141
|
+
*/
|
|
2515
3142
|
paymentId?: string;
|
|
2516
3143
|
}
|
|
2517
3144
|
/** @oneof */
|
|
@@ -2531,15 +3158,24 @@ export interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
|
2531
3158
|
creditCardDetails?: CreditCardDetails;
|
|
2532
3159
|
}
|
|
2533
3160
|
export interface CreditCardDetails {
|
|
2534
|
-
/**
|
|
3161
|
+
/**
|
|
3162
|
+
* The last 4 digits of the card number.
|
|
3163
|
+
* @maxLength 4
|
|
3164
|
+
*/
|
|
2535
3165
|
lastFourDigits?: string | null;
|
|
2536
|
-
/**
|
|
3166
|
+
/**
|
|
3167
|
+
* Card issuer's brand.
|
|
3168
|
+
* @maxLength 100
|
|
3169
|
+
*/
|
|
2537
3170
|
brand?: string | null;
|
|
2538
3171
|
}
|
|
2539
3172
|
export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
2540
3173
|
/** Regular payment. */
|
|
2541
3174
|
regular?: RegularPayment;
|
|
2542
|
-
/**
|
|
3175
|
+
/**
|
|
3176
|
+
* Payment ID of payment associated with this activity
|
|
3177
|
+
* @format GUID
|
|
3178
|
+
*/
|
|
2543
3179
|
paymentId?: string;
|
|
2544
3180
|
}
|
|
2545
3181
|
/** @oneof */
|
|
@@ -2550,7 +3186,10 @@ export interface PaymentCanceledPaymentDetailsOneOf {
|
|
|
2550
3186
|
export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
2551
3187
|
/** Regular payment. */
|
|
2552
3188
|
regular?: RegularPayment;
|
|
2553
|
-
/**
|
|
3189
|
+
/**
|
|
3190
|
+
* Payment ID of payment associated with this activity
|
|
3191
|
+
* @format GUID
|
|
3192
|
+
*/
|
|
2554
3193
|
paymentId?: string;
|
|
2555
3194
|
}
|
|
2556
3195
|
/** @oneof */
|
|
@@ -2563,7 +3202,10 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
2563
3202
|
wixReceipt?: WixReceipt;
|
|
2564
3203
|
/** Receipt created by an external system. */
|
|
2565
3204
|
externalReceipt?: ExternalReceipt;
|
|
2566
|
-
/**
|
|
3205
|
+
/**
|
|
3206
|
+
* Payment ID of payment associated with this activity
|
|
3207
|
+
* @format GUID
|
|
3208
|
+
*/
|
|
2567
3209
|
paymentId?: string;
|
|
2568
3210
|
}
|
|
2569
3211
|
/** @oneof */
|
|
@@ -2574,15 +3216,29 @@ export interface ReceiptCreatedReceiptInfoOneOf {
|
|
|
2574
3216
|
externalReceipt?: ExternalReceipt;
|
|
2575
3217
|
}
|
|
2576
3218
|
export interface WixReceipt {
|
|
2577
|
-
/**
|
|
3219
|
+
/**
|
|
3220
|
+
* Receipt ID
|
|
3221
|
+
* @format GUID
|
|
3222
|
+
*/
|
|
2578
3223
|
receiptId?: string;
|
|
2579
|
-
/**
|
|
3224
|
+
/**
|
|
3225
|
+
* Display number of receipt
|
|
3226
|
+
* @minLength 1
|
|
3227
|
+
* @maxLength 40
|
|
3228
|
+
*/
|
|
2580
3229
|
displayNumber?: string | null;
|
|
2581
3230
|
}
|
|
2582
3231
|
export interface ExternalReceipt {
|
|
2583
|
-
/**
|
|
3232
|
+
/**
|
|
3233
|
+
* Receipt ID
|
|
3234
|
+
* @maxLength 100
|
|
3235
|
+
*/
|
|
2584
3236
|
receiptId?: string | null;
|
|
2585
|
-
/**
|
|
3237
|
+
/**
|
|
3238
|
+
* Display number of receipt
|
|
3239
|
+
* @minLength 1
|
|
3240
|
+
* @maxLength 40
|
|
3241
|
+
*/
|
|
2586
3242
|
displayNumber?: string | null;
|
|
2587
3243
|
}
|
|
2588
3244
|
export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
@@ -2590,7 +3246,10 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
2590
3246
|
wixReceipt?: WixReceipt;
|
|
2591
3247
|
/** Receipt created by an external system. */
|
|
2592
3248
|
externalReceipt?: ExternalReceipt;
|
|
2593
|
-
/**
|
|
3249
|
+
/**
|
|
3250
|
+
* Payment ID of payment associated with this activity
|
|
3251
|
+
* @format GUID
|
|
3252
|
+
*/
|
|
2594
3253
|
paymentId?: string;
|
|
2595
3254
|
}
|
|
2596
3255
|
/** @oneof */
|
|
@@ -2645,13 +3304,23 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
2645
3304
|
/**
|
|
2646
3305
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
2647
3306
|
* For example, via POS (point of service).
|
|
3307
|
+
* @format GUID
|
|
2648
3308
|
*/
|
|
2649
3309
|
userId?: string;
|
|
2650
|
-
/**
|
|
3310
|
+
/**
|
|
3311
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
3312
|
+
* @format GUID
|
|
3313
|
+
*/
|
|
2651
3314
|
memberId?: string;
|
|
2652
|
-
/**
|
|
3315
|
+
/**
|
|
3316
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
3317
|
+
* @format GUID
|
|
3318
|
+
*/
|
|
2653
3319
|
visitorId?: string;
|
|
2654
|
-
/**
|
|
3320
|
+
/**
|
|
3321
|
+
* App ID - when the order was created by an external application.
|
|
3322
|
+
* @format GUID
|
|
3323
|
+
*/
|
|
2655
3324
|
appId?: string;
|
|
2656
3325
|
}
|
|
2657
3326
|
/** @oneof */
|
|
@@ -2659,21 +3328,37 @@ export interface V1CreatedByStringOneOf {
|
|
|
2659
3328
|
/**
|
|
2660
3329
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
2661
3330
|
* For example, via POS (point of service).
|
|
3331
|
+
* @format GUID
|
|
2662
3332
|
*/
|
|
2663
3333
|
userId?: string;
|
|
2664
|
-
/**
|
|
3334
|
+
/**
|
|
3335
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
3336
|
+
* @format GUID
|
|
3337
|
+
*/
|
|
2665
3338
|
memberId?: string;
|
|
2666
|
-
/**
|
|
3339
|
+
/**
|
|
3340
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
3341
|
+
* @format GUID
|
|
3342
|
+
*/
|
|
2667
3343
|
visitorId?: string;
|
|
2668
|
-
/**
|
|
3344
|
+
/**
|
|
3345
|
+
* App ID - when the order was created by an external application.
|
|
3346
|
+
* @format GUID
|
|
3347
|
+
*/
|
|
2669
3348
|
appId?: string;
|
|
2670
3349
|
}
|
|
2671
3350
|
export interface ChannelInfo {
|
|
2672
3351
|
/** Sales channel that submitted the order. */
|
|
2673
3352
|
type?: ChannelType;
|
|
2674
|
-
/**
|
|
3353
|
+
/**
|
|
3354
|
+
* Reference to an order ID from an external system.
|
|
3355
|
+
* @maxLength 100
|
|
3356
|
+
*/
|
|
2675
3357
|
externalOrderId?: string | null;
|
|
2676
|
-
/**
|
|
3358
|
+
/**
|
|
3359
|
+
* URL to the order in the external system.
|
|
3360
|
+
* @maxLength 300
|
|
3361
|
+
*/
|
|
2677
3362
|
externalOrderUrl?: string | null;
|
|
2678
3363
|
}
|
|
2679
3364
|
export declare enum ChannelType {
|
|
@@ -2713,9 +3398,17 @@ export declare enum ChannelType {
|
|
|
2713
3398
|
export interface CustomField {
|
|
2714
3399
|
/** Custom field value. */
|
|
2715
3400
|
value?: any;
|
|
2716
|
-
/**
|
|
3401
|
+
/**
|
|
3402
|
+
* Custom field title.
|
|
3403
|
+
* @minLength 1
|
|
3404
|
+
* @maxLength 500
|
|
3405
|
+
*/
|
|
2717
3406
|
title?: string;
|
|
2718
|
-
/**
|
|
3407
|
+
/**
|
|
3408
|
+
* Translated custom field title.
|
|
3409
|
+
* @minLength 1
|
|
3410
|
+
* @maxLength 500
|
|
3411
|
+
*/
|
|
2719
3412
|
translatedTitle?: string | null;
|
|
2720
3413
|
}
|
|
2721
3414
|
export interface V1BalanceSummary {
|
|
@@ -2786,13 +3479,18 @@ export interface Tags {
|
|
|
2786
3479
|
tags?: TagList;
|
|
2787
3480
|
}
|
|
2788
3481
|
export interface TagList {
|
|
2789
|
-
/**
|
|
3482
|
+
/**
|
|
3483
|
+
* List of tag IDs
|
|
3484
|
+
* @maxSize 100
|
|
3485
|
+
* @maxLength 5
|
|
3486
|
+
*/
|
|
2790
3487
|
tagIds?: string[];
|
|
2791
3488
|
}
|
|
2792
3489
|
export interface CreateOrderFromDraftRequest {
|
|
2793
3490
|
/**
|
|
2794
3491
|
* The draft order id
|
|
2795
3492
|
* @internal
|
|
3493
|
+
* @format GUID
|
|
2796
3494
|
*/
|
|
2797
3495
|
draftOrderId: string;
|
|
2798
3496
|
/**
|
|
@@ -2803,6 +3501,7 @@ export interface CreateOrderFromDraftRequest {
|
|
|
2803
3501
|
/**
|
|
2804
3502
|
* Reason for order creation, given by user (optional).
|
|
2805
3503
|
* @internal
|
|
3504
|
+
* @maxLength 200
|
|
2806
3505
|
*/
|
|
2807
3506
|
reason?: string | null;
|
|
2808
3507
|
/**
|
|
@@ -2847,7 +3546,10 @@ export interface CreateOrderFromDraftResponse {
|
|
|
2847
3546
|
createdOrder?: Order;
|
|
2848
3547
|
}
|
|
2849
3548
|
export interface DeleteDraftOrderRequest {
|
|
2850
|
-
/**
|
|
3549
|
+
/**
|
|
3550
|
+
* The draft order id
|
|
3551
|
+
* @format GUID
|
|
3552
|
+
*/
|
|
2851
3553
|
draftOrderId: string;
|
|
2852
3554
|
}
|
|
2853
3555
|
export interface DeleteDraftOrderResponse {
|
|
@@ -2873,6 +3575,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2873
3575
|
* Sort object.
|
|
2874
3576
|
*
|
|
2875
3577
|
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
3578
|
+
* @maxSize 5
|
|
2876
3579
|
*/
|
|
2877
3580
|
sort?: Sorting[];
|
|
2878
3581
|
}
|
|
@@ -2886,7 +3589,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
2886
3589
|
cursorPaging?: CursorPaging;
|
|
2887
3590
|
}
|
|
2888
3591
|
export interface Sorting {
|
|
2889
|
-
/**
|
|
3592
|
+
/**
|
|
3593
|
+
* Name of the field to sort by.
|
|
3594
|
+
* @maxLength 512
|
|
3595
|
+
*/
|
|
2890
3596
|
fieldName?: string;
|
|
2891
3597
|
/** Sort order. */
|
|
2892
3598
|
order?: SortOrder;
|
|
@@ -2896,13 +3602,17 @@ export declare enum SortOrder {
|
|
|
2896
3602
|
DESC = "DESC"
|
|
2897
3603
|
}
|
|
2898
3604
|
export interface CursorPaging {
|
|
2899
|
-
/**
|
|
3605
|
+
/**
|
|
3606
|
+
* Maximum number of items to return in the results.
|
|
3607
|
+
* @max 100
|
|
3608
|
+
*/
|
|
2900
3609
|
limit?: number | null;
|
|
2901
3610
|
/**
|
|
2902
3611
|
* Pointer to the next or previous page in the list of results.
|
|
2903
3612
|
*
|
|
2904
3613
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2905
3614
|
* Not relevant for the first request.
|
|
3615
|
+
* @maxLength 16000
|
|
2906
3616
|
*/
|
|
2907
3617
|
cursor?: string | null;
|
|
2908
3618
|
}
|
|
@@ -2926,9 +3636,15 @@ export interface CursorPagingMetadata {
|
|
|
2926
3636
|
hasNext?: boolean | null;
|
|
2927
3637
|
}
|
|
2928
3638
|
export interface Cursors {
|
|
2929
|
-
/**
|
|
3639
|
+
/**
|
|
3640
|
+
* Cursor string pointing to the next page in the list of results.
|
|
3641
|
+
* @maxLength 16000
|
|
3642
|
+
*/
|
|
2930
3643
|
next?: string | null;
|
|
2931
|
-
/**
|
|
3644
|
+
/**
|
|
3645
|
+
* Cursor pointing to the previous page in the list of results.
|
|
3646
|
+
* @maxLength 16000
|
|
3647
|
+
*/
|
|
2932
3648
|
prev?: string | null;
|
|
2933
3649
|
}
|
|
2934
3650
|
export interface UpdateExtendedFieldsRequest {
|
|
@@ -2947,6 +3663,7 @@ export interface SetTaxExemptionRequest {
|
|
|
2947
3663
|
/**
|
|
2948
3664
|
* Draft order ID.
|
|
2949
3665
|
* @internal
|
|
3666
|
+
* @format GUID
|
|
2950
3667
|
*/
|
|
2951
3668
|
draftOrderId: string;
|
|
2952
3669
|
/**
|
|
@@ -2965,11 +3682,17 @@ export interface SetTaxExemptionResponse {
|
|
|
2965
3682
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2966
3683
|
}
|
|
2967
3684
|
export interface GetDraftEditabilityStatusRequest {
|
|
2968
|
-
/**
|
|
3685
|
+
/**
|
|
3686
|
+
* Draft order ID.
|
|
3687
|
+
* @format GUID
|
|
3688
|
+
*/
|
|
2969
3689
|
draftOrderId?: string | null;
|
|
2970
3690
|
}
|
|
2971
3691
|
export interface GetDraftEditabilityStatusResponse {
|
|
2972
|
-
/**
|
|
3692
|
+
/**
|
|
3693
|
+
* Draft order ID.
|
|
3694
|
+
* @format GUID
|
|
3695
|
+
*/
|
|
2973
3696
|
draftOrderId?: string | null;
|
|
2974
3697
|
/**
|
|
2975
3698
|
* Draft order status.
|
|
@@ -2981,6 +3704,7 @@ export interface SetBusinessLocationRequest {
|
|
|
2981
3704
|
/**
|
|
2982
3705
|
* Draft order ID.
|
|
2983
3706
|
* @internal
|
|
3707
|
+
* @format GUID
|
|
2984
3708
|
*/
|
|
2985
3709
|
draftOrderId: string;
|
|
2986
3710
|
/**
|
|
@@ -3067,9 +3791,15 @@ export interface ActionEvent {
|
|
|
3067
3791
|
body?: string;
|
|
3068
3792
|
}
|
|
3069
3793
|
export interface MessageEnvelope {
|
|
3070
|
-
/**
|
|
3794
|
+
/**
|
|
3795
|
+
* App instance ID.
|
|
3796
|
+
* @format GUID
|
|
3797
|
+
*/
|
|
3071
3798
|
instanceId?: string | null;
|
|
3072
|
-
/**
|
|
3799
|
+
/**
|
|
3800
|
+
* Event type.
|
|
3801
|
+
* @maxLength 150
|
|
3802
|
+
*/
|
|
3073
3803
|
eventType?: string;
|
|
3074
3804
|
/** The identification type and identity data. */
|
|
3075
3805
|
identity?: IdentificationData;
|
|
@@ -3077,26 +3807,50 @@ export interface MessageEnvelope {
|
|
|
3077
3807
|
data?: string;
|
|
3078
3808
|
}
|
|
3079
3809
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3080
|
-
/**
|
|
3810
|
+
/**
|
|
3811
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3812
|
+
* @format GUID
|
|
3813
|
+
*/
|
|
3081
3814
|
anonymousVisitorId?: string;
|
|
3082
|
-
/**
|
|
3815
|
+
/**
|
|
3816
|
+
* ID of a site visitor that has logged in to the site.
|
|
3817
|
+
* @format GUID
|
|
3818
|
+
*/
|
|
3083
3819
|
memberId?: string;
|
|
3084
|
-
/**
|
|
3820
|
+
/**
|
|
3821
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3822
|
+
* @format GUID
|
|
3823
|
+
*/
|
|
3085
3824
|
wixUserId?: string;
|
|
3086
|
-
/**
|
|
3825
|
+
/**
|
|
3826
|
+
* ID of an app.
|
|
3827
|
+
* @format GUID
|
|
3828
|
+
*/
|
|
3087
3829
|
appId?: string;
|
|
3088
3830
|
/** @readonly */
|
|
3089
3831
|
identityType?: WebhookIdentityType;
|
|
3090
3832
|
}
|
|
3091
3833
|
/** @oneof */
|
|
3092
3834
|
export interface IdentificationDataIdOneOf {
|
|
3093
|
-
/**
|
|
3835
|
+
/**
|
|
3836
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3837
|
+
* @format GUID
|
|
3838
|
+
*/
|
|
3094
3839
|
anonymousVisitorId?: string;
|
|
3095
|
-
/**
|
|
3840
|
+
/**
|
|
3841
|
+
* ID of a site visitor that has logged in to the site.
|
|
3842
|
+
* @format GUID
|
|
3843
|
+
*/
|
|
3096
3844
|
memberId?: string;
|
|
3097
|
-
/**
|
|
3845
|
+
/**
|
|
3846
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3847
|
+
* @format GUID
|
|
3848
|
+
*/
|
|
3098
3849
|
wixUserId?: string;
|
|
3099
|
-
/**
|
|
3850
|
+
/**
|
|
3851
|
+
* ID of an app.
|
|
3852
|
+
* @format GUID
|
|
3853
|
+
*/
|
|
3100
3854
|
appId?: string;
|
|
3101
3855
|
}
|
|
3102
3856
|
export declare enum WebhookIdentityType {
|
|
@@ -3213,7 +3967,6 @@ interface OrderLineItemNonNullableFields {
|
|
|
3213
3967
|
subscriptionInfo?: SubscriptionInfoNonNullableFields;
|
|
3214
3968
|
priceDescription?: PriceDescriptionNonNullableFields;
|
|
3215
3969
|
depositAmount?: PriceNonNullableFields;
|
|
3216
|
-
/** @internal */
|
|
3217
3970
|
locations: LocationAndQuantityNonNullableFields[];
|
|
3218
3971
|
lineItemPrice?: PriceNonNullableFields;
|
|
3219
3972
|
/** @internal */
|
|
@@ -3427,17 +4180,12 @@ interface LocationNonNullableFields {
|
|
|
3427
4180
|
name: string;
|
|
3428
4181
|
}
|
|
3429
4182
|
interface BusinessLocationChangedDetailsNonNullableFields {
|
|
3430
|
-
/** @internal */
|
|
3431
4183
|
businessLocationBeforeChange?: LocationNonNullableFields;
|
|
3432
4184
|
}
|
|
3433
4185
|
interface BusinessLocationDetailsNonNullableFields {
|
|
3434
|
-
/** @internal */
|
|
3435
4186
|
added: boolean;
|
|
3436
|
-
/** @internal */
|
|
3437
4187
|
changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
|
|
3438
|
-
/** @internal */
|
|
3439
4188
|
removed: boolean;
|
|
3440
|
-
/** @internal */
|
|
3441
4189
|
businessLocation?: LocationNonNullableFields;
|
|
3442
4190
|
}
|
|
3443
4191
|
interface DraftOrderNonNullableFields {
|
|
@@ -3461,7 +4209,6 @@ interface DraftOrderNonNullableFields {
|
|
|
3461
4209
|
buyerDetails?: BuyerDetailsNonNullableFields;
|
|
3462
4210
|
/** @internal */
|
|
3463
4211
|
billingDetails?: BillingDetailsNonNullableFields;
|
|
3464
|
-
/** @internal */
|
|
3465
4212
|
businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
|
|
3466
4213
|
}
|
|
3467
4214
|
interface PickupDetailsNonNullableFields {
|
|
@@ -3820,7 +4567,6 @@ interface OrderNonNullableFields {
|
|
|
3820
4567
|
recipientInfo?: AddressWithContactNonNullableFields;
|
|
3821
4568
|
/** @internal */
|
|
3822
4569
|
tags?: TagsNonNullableFields;
|
|
3823
|
-
/** @internal */
|
|
3824
4570
|
businessLocation?: LocationNonNullableFields;
|
|
3825
4571
|
/** @internal */
|
|
3826
4572
|
payAfterFreeTrial?: PriceSummaryNonNullableFields;
|
|
@@ -3860,6 +4606,8 @@ export interface SetBusinessLocationResponseNonNullableFields {
|
|
|
3860
4606
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
3861
4607
|
* @permissionScope Manage Stores - all permissions
|
|
3862
4608
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4609
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4610
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3863
4611
|
* @permissionScope Manage eCommerce - all permissions
|
|
3864
4612
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3865
4613
|
* @applicableIdentity APP
|
|
@@ -3875,6 +4623,8 @@ export declare function createDraftOrder(orderId: string | null): Promise<Create
|
|
|
3875
4623
|
* @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
3876
4624
|
* @permissionScope Manage Stores - all permissions
|
|
3877
4625
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4626
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4627
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3878
4628
|
* @permissionScope Manage eCommerce - all permissions
|
|
3879
4629
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3880
4630
|
* @applicableIdentity APP
|
|
@@ -3891,6 +4641,8 @@ export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderRe
|
|
|
3891
4641
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
|
|
3892
4642
|
* @permissionScope Manage Stores - all permissions
|
|
3893
4643
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4644
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4645
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3894
4646
|
* @permissionScope Manage eCommerce - all permissions
|
|
3895
4647
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3896
4648
|
* @applicableIdentity APP
|
|
@@ -3898,9 +4650,15 @@ export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderRe
|
|
|
3898
4650
|
*/
|
|
3899
4651
|
export declare function addLineItemsToDraftOrder(draftOrderId: string, options?: AddLineItemsToDraftOrderOptions): Promise<AddLineItemsToDraftOrderResponse & AddLineItemsToDraftOrderResponseNonNullableFields>;
|
|
3900
4652
|
export interface AddLineItemsToDraftOrderOptions {
|
|
3901
|
-
/**
|
|
4653
|
+
/**
|
|
4654
|
+
* Catalog line items to add to draft order.
|
|
4655
|
+
* @maxSize 300
|
|
4656
|
+
*/
|
|
3902
4657
|
catalogLineItems?: CatalogReferenceLineItem[];
|
|
3903
|
-
/**
|
|
4658
|
+
/**
|
|
4659
|
+
* Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
|
|
4660
|
+
* @maxSize 300
|
|
4661
|
+
*/
|
|
3904
4662
|
customLineItems?: CustomLineItem[];
|
|
3905
4663
|
}
|
|
3906
4664
|
/**
|
|
@@ -3918,6 +4676,8 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
3918
4676
|
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
3919
4677
|
* @permissionScope Manage Stores - all permissions
|
|
3920
4678
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4679
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4680
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3921
4681
|
* @permissionScope Manage eCommerce - all permissions
|
|
3922
4682
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3923
4683
|
* @applicableIdentity APP
|
|
@@ -3925,7 +4685,11 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
3925
4685
|
*/
|
|
3926
4686
|
export declare function updateLineItems(draftOrderId: string, options?: UpdateLineItemsOptions): Promise<UpdateLineItemsResponse & UpdateLineItemsResponseNonNullableFields>;
|
|
3927
4687
|
export interface UpdateLineItemsOptions {
|
|
3928
|
-
/**
|
|
4688
|
+
/**
|
|
4689
|
+
* Details of changes to apply per line item
|
|
4690
|
+
* @minSize 1
|
|
4691
|
+
* @maxSize 300
|
|
4692
|
+
*/
|
|
3929
4693
|
lineItemChanges?: LineItemChangeDetails[];
|
|
3930
4694
|
}
|
|
3931
4695
|
/**
|
|
@@ -3941,6 +4705,8 @@ export interface UpdateLineItemsOptions {
|
|
|
3941
4705
|
* @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
|
|
3942
4706
|
* @permissionScope Manage Stores - all permissions
|
|
3943
4707
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4708
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4709
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3944
4710
|
* @permissionScope Manage eCommerce - all permissions
|
|
3945
4711
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3946
4712
|
* @applicableIdentity APP
|
|
@@ -3959,6 +4725,8 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
|
|
|
3959
4725
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
|
|
3960
4726
|
* @permissionScope Manage Stores - all permissions
|
|
3961
4727
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4728
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4729
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3962
4730
|
* @permissionScope Manage eCommerce - all permissions
|
|
3963
4731
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3964
4732
|
* @applicableIdentity APP
|
|
@@ -3966,7 +4734,11 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
|
|
|
3966
4734
|
*/
|
|
3967
4735
|
export declare function createCustomDiscounts(draftOrderId: string, options?: CreateCustomDiscountsOptions): Promise<CreateCustomDiscountsResponse & CreateCustomDiscountsResponseNonNullableFields>;
|
|
3968
4736
|
export interface CreateCustomDiscountsOptions {
|
|
3969
|
-
/**
|
|
4737
|
+
/**
|
|
4738
|
+
* The discounts to add.
|
|
4739
|
+
* @minSize 1
|
|
4740
|
+
* @maxSize 100
|
|
4741
|
+
*/
|
|
3970
4742
|
discounts?: DiscountOption[];
|
|
3971
4743
|
}
|
|
3972
4744
|
/**
|
|
@@ -3980,6 +4752,8 @@ export interface CreateCustomDiscountsOptions {
|
|
|
3980
4752
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
|
|
3981
4753
|
* @permissionScope Manage Stores - all permissions
|
|
3982
4754
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4755
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4756
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3983
4757
|
* @permissionScope Manage eCommerce - all permissions
|
|
3984
4758
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3985
4759
|
* @applicableIdentity APP
|
|
@@ -3998,6 +4772,8 @@ export declare function deleteCustomDiscounts(draftOrderId: string, discountIds:
|
|
|
3998
4772
|
* @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
|
|
3999
4773
|
* @permissionScope Manage Stores - all permissions
|
|
4000
4774
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4775
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4776
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4001
4777
|
* @permissionScope Manage eCommerce - all permissions
|
|
4002
4778
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4003
4779
|
* @applicableIdentity APP
|
|
@@ -4018,6 +4794,8 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
|
|
|
4018
4794
|
* @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
|
|
4019
4795
|
* @permissionScope Manage Stores - all permissions
|
|
4020
4796
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4797
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4798
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4021
4799
|
* @permissionScope Manage eCommerce - all permissions
|
|
4022
4800
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4023
4801
|
* @applicableIdentity APP
|
|
@@ -4025,7 +4803,11 @@ export declare function setAdditionalFees(draftOrderId: string, additionalFees:
|
|
|
4025
4803
|
*/
|
|
4026
4804
|
export declare function createCustomAdditionalFees(draftOrderId: string, options?: CreateCustomAdditionalFeesOptions): Promise<CreateCustomAdditionalFeesResponse & CreateCustomAdditionalFeesResponseNonNullableFields>;
|
|
4027
4805
|
export interface CreateCustomAdditionalFeesOptions {
|
|
4028
|
-
/**
|
|
4806
|
+
/**
|
|
4807
|
+
* The additional fees to add. added with opted-out setting
|
|
4808
|
+
* @minSize 1
|
|
4809
|
+
* @maxSize 100
|
|
4810
|
+
*/
|
|
4029
4811
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
4030
4812
|
}
|
|
4031
4813
|
/**
|
|
@@ -4039,6 +4821,8 @@ export interface CreateCustomAdditionalFeesOptions {
|
|
|
4039
4821
|
* @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
|
|
4040
4822
|
* @permissionScope Manage Stores - all permissions
|
|
4041
4823
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4824
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4825
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4042
4826
|
* @permissionScope Manage eCommerce - all permissions
|
|
4043
4827
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4044
4828
|
* @applicableIdentity APP
|
|
@@ -4052,6 +4836,8 @@ export declare function deleteCustomAdditionalFees(draftOrderId: string, customA
|
|
|
4052
4836
|
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
4053
4837
|
* @permissionScope Manage Stores - all permissions
|
|
4054
4838
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4839
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4840
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4055
4841
|
* @permissionScope Manage eCommerce - all permissions
|
|
4056
4842
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4057
4843
|
* @applicableIdentity APP
|
|
@@ -4065,6 +4851,8 @@ export declare function setShippingInfo(): Promise<void>;
|
|
|
4065
4851
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
4066
4852
|
* @permissionScope Manage Stores - all permissions
|
|
4067
4853
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4854
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4855
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4068
4856
|
* @permissionScope Manage eCommerce - all permissions
|
|
4069
4857
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4070
4858
|
* @applicableIdentity APP
|
|
@@ -4078,6 +4866,8 @@ export declare function setBuyerInfo(): Promise<void>;
|
|
|
4078
4866
|
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
4079
4867
|
* @permissionScope Manage Stores - all permissions
|
|
4080
4868
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4869
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4870
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4081
4871
|
* @permissionScope Manage eCommerce - all permissions
|
|
4082
4872
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4083
4873
|
* @applicableIdentity APP
|
|
@@ -4091,6 +4881,8 @@ export declare function setRecipientInfo(): Promise<void>;
|
|
|
4091
4881
|
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
4092
4882
|
* @permissionScope Manage Stores - all permissions
|
|
4093
4883
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4884
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4885
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4094
4886
|
* @permissionScope Manage eCommerce - all permissions
|
|
4095
4887
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4096
4888
|
* @applicableIdentity APP
|
|
@@ -4111,6 +4903,8 @@ export declare function setBillingInfo(): Promise<void>;
|
|
|
4111
4903
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4112
4904
|
* @permissionScope Manage Stores - all permissions
|
|
4113
4905
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4906
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4907
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4114
4908
|
* @permissionScope Manage eCommerce - all permissions
|
|
4115
4909
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4116
4910
|
* @applicableIdentity APP
|
|
@@ -4126,6 +4920,8 @@ export declare function getDraftOrder(draftOrderId: string): Promise<GetDraftOrd
|
|
|
4126
4920
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
4127
4921
|
* @permissionScope Manage Stores - all permissions
|
|
4128
4922
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4923
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4924
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4129
4925
|
* @permissionScope Manage eCommerce - all permissions
|
|
4130
4926
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4131
4927
|
* @applicableIdentity APP
|
|
@@ -4144,6 +4940,8 @@ export declare function getOrderDraftabilityStatus(orderId: string): Promise<Get
|
|
|
4144
4940
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4145
4941
|
* @permissionScope Manage Stores - all permissions
|
|
4146
4942
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4943
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4944
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4147
4945
|
* @permissionScope Manage eCommerce - all permissions
|
|
4148
4946
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4149
4947
|
* @applicableIdentity APP
|
|
@@ -4153,7 +4951,10 @@ export declare function commitDraftOrder(draftOrderId: string, options?: CommitD
|
|
|
4153
4951
|
export interface CommitDraftOrderOptions {
|
|
4154
4952
|
/** Optional side effects to trigger */
|
|
4155
4953
|
commitSettings?: DraftOrderCommitSettings;
|
|
4156
|
-
/**
|
|
4954
|
+
/**
|
|
4955
|
+
* Reason for edit, given by user (optional).
|
|
4956
|
+
* @maxLength 200
|
|
4957
|
+
*/
|
|
4157
4958
|
reason?: string | null;
|
|
4158
4959
|
}
|
|
4159
4960
|
/**
|
|
@@ -4166,6 +4967,8 @@ export interface CommitDraftOrderOptions {
|
|
|
4166
4967
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
4167
4968
|
* @permissionScope Manage Stores - all permissions
|
|
4168
4969
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4970
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4971
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4169
4972
|
* @permissionScope Manage eCommerce - all permissions
|
|
4170
4973
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4171
4974
|
* @applicableIdentity APP
|
|
@@ -4183,6 +4986,8 @@ export declare function createOrderFromDraft(): Promise<void>;
|
|
|
4183
4986
|
* @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
|
|
4184
4987
|
* @permissionScope Manage Stores - all permissions
|
|
4185
4988
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4989
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4990
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4186
4991
|
* @permissionScope Manage eCommerce - all permissions
|
|
4187
4992
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4188
4993
|
* @applicableIdentity APP
|
|
@@ -4204,6 +5009,8 @@ export declare function deleteDraftOrder(draftOrderId: string): Promise<void>;
|
|
|
4204
5009
|
* @documentationMaturity preview
|
|
4205
5010
|
* @permissionScope Manage Stores - all permissions
|
|
4206
5011
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
5012
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
5013
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4207
5014
|
* @permissionScope Manage eCommerce - all permissions
|
|
4208
5015
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4209
5016
|
* @permissionId ECOM.DRAFT_ORDERS_READ
|
|
@@ -4295,6 +5102,8 @@ export interface DraftOrdersQueryBuilder {
|
|
|
4295
5102
|
* @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
|
|
4296
5103
|
* @permissionScope Manage Stores - all permissions
|
|
4297
5104
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
5105
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
5106
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4298
5107
|
* @permissionScope Manage eCommerce - all permissions
|
|
4299
5108
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4300
5109
|
* @applicableIdentity APP
|
|
@@ -4308,6 +5117,8 @@ export declare function setTaxExemption(): Promise<void>;
|
|
|
4308
5117
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|
|
4309
5118
|
* @permissionScope Manage Stores - all permissions
|
|
4310
5119
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
5120
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
5121
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4311
5122
|
* @permissionScope Manage eCommerce - all permissions
|
|
4312
5123
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4313
5124
|
* @applicableIdentity APP
|