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