@wix/auto_sdk_ecom_draft-orders 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +1017 -217
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1086 -223
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +1017 -217
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1086 -223
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +997 -225
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1075 -264
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +997 -225
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +1075 -264
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +44 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -2,14 +2,20 @@
|
|
|
2
2
|
export interface DraftOrder {
|
|
3
3
|
/**
|
|
4
4
|
* Draft order ID.
|
|
5
|
+
* @format GUID
|
|
5
6
|
* @readonly
|
|
6
7
|
*/
|
|
7
8
|
id?: string | null;
|
|
8
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* ID of the order this draft commits to.
|
|
11
|
+
* @format GUID
|
|
12
|
+
*/
|
|
9
13
|
orderId?: string | null;
|
|
10
14
|
/**
|
|
11
15
|
* Line items.
|
|
12
16
|
* Includes details about changes when relevant.
|
|
17
|
+
* @minSize 1
|
|
18
|
+
* @maxSize 300
|
|
13
19
|
*/
|
|
14
20
|
lineItems?: ItemDetails[];
|
|
15
21
|
/**
|
|
@@ -34,11 +40,13 @@ export interface DraftOrder {
|
|
|
34
40
|
/**
|
|
35
41
|
* Additional fees.
|
|
36
42
|
* Includes details about the source, and whether the additional fee is applied to the order.
|
|
43
|
+
* @maxSize 100
|
|
37
44
|
*/
|
|
38
45
|
additionalFees?: AdditionalFeeDetails[];
|
|
39
46
|
/**
|
|
40
47
|
* Discounts.
|
|
41
48
|
* Includes details about the source, and whether the discount is applied to the order.
|
|
49
|
+
* @maxSize 320
|
|
42
50
|
*/
|
|
43
51
|
discounts?: DiscountDetails[];
|
|
44
52
|
/**
|
|
@@ -63,7 +71,10 @@ export interface DraftOrder {
|
|
|
63
71
|
status?: EditingStatus;
|
|
64
72
|
/** Weight measurement unit. Defaults to the site's weight unit. */
|
|
65
73
|
weightUnit?: WeightUnit;
|
|
66
|
-
/**
|
|
74
|
+
/**
|
|
75
|
+
* Currency used for pricing.
|
|
76
|
+
* @format CURRENCY
|
|
77
|
+
*/
|
|
67
78
|
currency?: string | null;
|
|
68
79
|
/**
|
|
69
80
|
* Price summary.
|
|
@@ -89,9 +100,15 @@ export interface DraftOrder {
|
|
|
89
100
|
balanceSummary?: BalanceSummary;
|
|
90
101
|
/** Side effects to perform on commit. */
|
|
91
102
|
commitSettings?: DraftOrderCommitSettings;
|
|
92
|
-
/**
|
|
103
|
+
/**
|
|
104
|
+
* Member ID (if order created by a member).
|
|
105
|
+
* @format GUID
|
|
106
|
+
*/
|
|
93
107
|
memberId?: string | null;
|
|
94
|
-
/**
|
|
108
|
+
/**
|
|
109
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
110
|
+
* @format GUID
|
|
111
|
+
*/
|
|
95
112
|
purchaseFlowId?: string | null;
|
|
96
113
|
recipientInfo?: RecipientInfoDetails;
|
|
97
114
|
/**
|
|
@@ -99,6 +116,11 @@ export interface DraftOrder {
|
|
|
99
116
|
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
|
|
100
117
|
*/
|
|
101
118
|
extendedFields?: ExtendedFields;
|
|
119
|
+
/**
|
|
120
|
+
* Order business location
|
|
121
|
+
* Includes details about changes when relevant.
|
|
122
|
+
*/
|
|
123
|
+
businessLocationDetails?: BusinessLocationDetails;
|
|
102
124
|
}
|
|
103
125
|
export interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
104
126
|
/** Whether the line item was added as part of the draft. */
|
|
@@ -120,7 +142,10 @@ export interface ItemDetailsChangeTypeOneOf {
|
|
|
120
142
|
removed?: boolean;
|
|
121
143
|
}
|
|
122
144
|
export interface Price {
|
|
123
|
-
/**
|
|
145
|
+
/**
|
|
146
|
+
* Amount.
|
|
147
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
148
|
+
*/
|
|
124
149
|
amount?: string;
|
|
125
150
|
/**
|
|
126
151
|
* Amount formatted with currency symbol.
|
|
@@ -129,17 +154,26 @@ export interface Price {
|
|
|
129
154
|
formattedAmount?: string;
|
|
130
155
|
}
|
|
131
156
|
export interface PriceDescription {
|
|
132
|
-
/**
|
|
157
|
+
/**
|
|
158
|
+
* __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
159
|
+
* @minLength 1
|
|
160
|
+
* @maxLength 100
|
|
161
|
+
*/
|
|
133
162
|
original?: string;
|
|
134
163
|
/**
|
|
135
164
|
* Price description translated into the buyer's language.
|
|
136
165
|
*
|
|
137
166
|
* Default: Same as `original`.
|
|
167
|
+
* @minLength 1
|
|
168
|
+
* @maxLength 100
|
|
138
169
|
*/
|
|
139
170
|
translated?: string | null;
|
|
140
171
|
}
|
|
141
172
|
export interface OrderLineItem {
|
|
142
|
-
/**
|
|
173
|
+
/**
|
|
174
|
+
* Line item ID.
|
|
175
|
+
* @immutable
|
|
176
|
+
*/
|
|
143
177
|
id?: string;
|
|
144
178
|
/**
|
|
145
179
|
* Item name.
|
|
@@ -153,14 +187,21 @@ export interface OrderLineItem {
|
|
|
153
187
|
* This field may be empty in the case of a custom line item.
|
|
154
188
|
*/
|
|
155
189
|
catalogReference?: CatalogReference;
|
|
156
|
-
/**
|
|
190
|
+
/**
|
|
191
|
+
* Line item quantity.
|
|
192
|
+
* @min 1
|
|
193
|
+
* @max 100000
|
|
194
|
+
*/
|
|
157
195
|
quantity?: number;
|
|
158
196
|
/**
|
|
159
197
|
* Total discount for this line item's entire quantity.
|
|
160
198
|
* @readonly
|
|
161
199
|
*/
|
|
162
200
|
totalDiscount?: Price;
|
|
163
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Line item description lines. Used for display purposes for the cart, checkout and order.
|
|
203
|
+
* @maxSize 20
|
|
204
|
+
*/
|
|
164
205
|
descriptionLines?: DescriptionLine[];
|
|
165
206
|
/** Line item image. */
|
|
166
207
|
image?: Image;
|
|
@@ -171,11 +212,18 @@ export interface OrderLineItem {
|
|
|
171
212
|
/**
|
|
172
213
|
* Fulfiller ID. Field is empty when the line item is self-fulfilled.
|
|
173
214
|
* To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
|
|
215
|
+
* @format GUID
|
|
174
216
|
*/
|
|
175
217
|
fulfillerId?: string | null;
|
|
176
|
-
/**
|
|
218
|
+
/**
|
|
219
|
+
* Number of items that were refunded.
|
|
220
|
+
* @max 100000
|
|
221
|
+
*/
|
|
177
222
|
refundQuantity?: number | null;
|
|
178
|
-
/**
|
|
223
|
+
/**
|
|
224
|
+
* Number of items restocked.
|
|
225
|
+
* @max 100000
|
|
226
|
+
*/
|
|
179
227
|
restockQuantity?: number | null;
|
|
180
228
|
/** Line item price after line item discounts for display purposes. */
|
|
181
229
|
price?: Price;
|
|
@@ -195,11 +243,9 @@ export interface OrderLineItem {
|
|
|
195
243
|
*/
|
|
196
244
|
totalPriceAfterTax?: Price;
|
|
197
245
|
/**
|
|
198
|
-
* Type of selected payment option for current item.
|
|
199
|
-
*
|
|
200
|
-
*
|
|
201
|
-
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
202
|
-
* + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.
|
|
246
|
+
* Type of selected payment option for current item.
|
|
247
|
+
*
|
|
248
|
+
* Default: `FULL_PAYMENT_ONLINE`
|
|
203
249
|
*/
|
|
204
250
|
paymentOption?: PaymentOptionType;
|
|
205
251
|
/**
|
|
@@ -226,6 +272,13 @@ export interface OrderLineItem {
|
|
|
226
272
|
* @readonly
|
|
227
273
|
*/
|
|
228
274
|
depositAmount?: Price;
|
|
275
|
+
/**
|
|
276
|
+
* Line item locations.
|
|
277
|
+
*
|
|
278
|
+
* The location's total quantity must not exceed the line item quantity.
|
|
279
|
+
* @maxSize 5
|
|
280
|
+
*/
|
|
281
|
+
locations?: LocationAndQuantity[];
|
|
229
282
|
/**
|
|
230
283
|
* Custom extended fields for the line item object.
|
|
231
284
|
*
|
|
@@ -239,6 +292,8 @@ export interface ProductName {
|
|
|
239
292
|
*
|
|
240
293
|
* Min: 1 character.
|
|
241
294
|
* Max: 200 characters.
|
|
295
|
+
* @minLength 1
|
|
296
|
+
* @maxLength 200
|
|
242
297
|
*/
|
|
243
298
|
original?: string;
|
|
244
299
|
/**
|
|
@@ -247,12 +302,18 @@ export interface ProductName {
|
|
|
247
302
|
* Min: 1 character.
|
|
248
303
|
* Max: 400 characters.
|
|
249
304
|
* Default: Same as `original`.
|
|
305
|
+
* @minLength 1
|
|
306
|
+
* @maxLength 400
|
|
250
307
|
*/
|
|
251
308
|
translated?: string | null;
|
|
252
309
|
}
|
|
253
310
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
254
311
|
export interface CatalogReference {
|
|
255
|
-
/**
|
|
312
|
+
/**
|
|
313
|
+
* ID of the item within the catalog it belongs to.
|
|
314
|
+
* @minLength 1
|
|
315
|
+
* @maxLength 36
|
|
316
|
+
*/
|
|
256
317
|
catalogItemId?: string;
|
|
257
318
|
/**
|
|
258
319
|
* ID of the app providing the catalog.
|
|
@@ -263,6 +324,7 @@ export interface CatalogReference {
|
|
|
263
324
|
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
264
325
|
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
265
326
|
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
327
|
+
* @minLength 1
|
|
266
328
|
*/
|
|
267
329
|
appId?: string;
|
|
268
330
|
/**
|
|
@@ -291,32 +353,44 @@ export interface DescriptionLineValueOneOf {
|
|
|
291
353
|
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
292
354
|
}
|
|
293
355
|
export interface DescriptionLineName {
|
|
294
|
-
/**
|
|
356
|
+
/**
|
|
357
|
+
* Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
358
|
+
* @maxLength 100
|
|
359
|
+
*/
|
|
295
360
|
original?: string;
|
|
296
361
|
/**
|
|
297
362
|
* Description line name translated into the buyer's language.
|
|
298
363
|
*
|
|
299
364
|
* Default: Same as `original`.
|
|
365
|
+
* @maxLength 200
|
|
300
366
|
*/
|
|
301
367
|
translated?: string | null;
|
|
302
368
|
}
|
|
303
369
|
export interface PlainTextValue {
|
|
304
|
-
/**
|
|
370
|
+
/**
|
|
371
|
+
* Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
372
|
+
* @maxLength 600
|
|
373
|
+
*/
|
|
305
374
|
original?: string;
|
|
306
375
|
/**
|
|
307
376
|
* Description line plain text value translated into the buyer's language.
|
|
308
377
|
*
|
|
309
378
|
* Default: Same as `original`.
|
|
379
|
+
* @maxLength 600
|
|
310
380
|
*/
|
|
311
381
|
translated?: string | null;
|
|
312
382
|
}
|
|
313
383
|
export interface Color {
|
|
314
|
-
/**
|
|
384
|
+
/**
|
|
385
|
+
* Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
386
|
+
* @maxLength 500
|
|
387
|
+
*/
|
|
315
388
|
original?: string;
|
|
316
389
|
/**
|
|
317
390
|
* Description line color name translated into the buyer's language.
|
|
318
391
|
*
|
|
319
392
|
* Default: Same as `original`.
|
|
393
|
+
* @maxLength 500
|
|
320
394
|
*/
|
|
321
395
|
translated?: string | null;
|
|
322
396
|
/** HEX or RGB color code for display. */
|
|
@@ -366,7 +440,10 @@ export interface FocalPoint {
|
|
|
366
440
|
export interface PhysicalProperties {
|
|
367
441
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
368
442
|
weight?: number | null;
|
|
369
|
-
/**
|
|
443
|
+
/**
|
|
444
|
+
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
445
|
+
* @maxLength 40
|
|
446
|
+
*/
|
|
370
447
|
sku?: string | null;
|
|
371
448
|
/** Whether this line item is shippable. */
|
|
372
449
|
shippable?: boolean;
|
|
@@ -407,7 +484,10 @@ export declare enum PaymentOptionType {
|
|
|
407
484
|
export interface ItemTaxFullDetails {
|
|
408
485
|
/** Taxable amount of this line item. */
|
|
409
486
|
taxableAmount?: Price;
|
|
410
|
-
/**
|
|
487
|
+
/**
|
|
488
|
+
* Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
|
|
489
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
490
|
+
*/
|
|
411
491
|
taxRate?: string;
|
|
412
492
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
413
493
|
totalTax?: Price;
|
|
@@ -417,16 +497,24 @@ export interface LineItemTaxInfo {
|
|
|
417
497
|
taxAmount?: Price;
|
|
418
498
|
/** Amount for which tax is calculated. */
|
|
419
499
|
taxableAmount?: Price;
|
|
420
|
-
/**
|
|
500
|
+
/**
|
|
501
|
+
* Tax rate %, as a decimal point.
|
|
502
|
+
* @format DECIMAL_VALUE
|
|
503
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
504
|
+
*/
|
|
421
505
|
taxRate?: string | null;
|
|
422
506
|
/**
|
|
423
507
|
* Tax group ID.
|
|
424
508
|
* Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
|
|
509
|
+
* @format GUID
|
|
425
510
|
*/
|
|
426
511
|
taxGroupId?: string | null;
|
|
427
512
|
/** Indicates whether the price already includes tax. */
|
|
428
513
|
taxIncludedInPrice?: boolean;
|
|
429
|
-
/**
|
|
514
|
+
/**
|
|
515
|
+
* Tax information for a line item.
|
|
516
|
+
* @maxSize 7
|
|
517
|
+
*/
|
|
430
518
|
taxBreakdown?: LineItemTaxBreakdown[];
|
|
431
519
|
}
|
|
432
520
|
/**
|
|
@@ -434,17 +522,28 @@ export interface LineItemTaxInfo {
|
|
|
434
522
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
435
523
|
*/
|
|
436
524
|
export interface LineItemTaxBreakdown {
|
|
437
|
-
/**
|
|
525
|
+
/**
|
|
526
|
+
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
527
|
+
* @maxLength 200
|
|
528
|
+
*/
|
|
438
529
|
jurisdiction?: string | null;
|
|
439
|
-
/**
|
|
530
|
+
/**
|
|
531
|
+
* Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
|
|
532
|
+
* @format DECIMAL_VALUE
|
|
533
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
534
|
+
*/
|
|
440
535
|
rate?: string | null;
|
|
441
536
|
/** Amount of tax calculated for this line item. */
|
|
442
537
|
taxAmount?: Price;
|
|
443
|
-
/**
|
|
538
|
+
/**
|
|
539
|
+
* The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
|
|
540
|
+
* @maxLength 200
|
|
541
|
+
*/
|
|
444
542
|
taxType?: string | null;
|
|
445
543
|
/**
|
|
446
544
|
* The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
|
|
447
545
|
* This name should be explicit enough to allow the merchant to understand what tax was calculated.
|
|
546
|
+
* @maxLength 200
|
|
448
547
|
*/
|
|
449
548
|
taxName?: string | null;
|
|
450
549
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
@@ -464,9 +563,18 @@ export declare enum JurisdictionType {
|
|
|
464
563
|
SPECIAL = "SPECIAL"
|
|
465
564
|
}
|
|
466
565
|
export interface DigitalFile {
|
|
467
|
-
/**
|
|
566
|
+
/**
|
|
567
|
+
* ID of the secure file in media.
|
|
568
|
+
* @minLength 1
|
|
569
|
+
* @maxLength 100
|
|
570
|
+
*/
|
|
468
571
|
fileId?: string;
|
|
469
|
-
/**
|
|
572
|
+
/**
|
|
573
|
+
* Link will exist after the digital links have been generated on the order.
|
|
574
|
+
* @format WEB_URL
|
|
575
|
+
* @minLength 1
|
|
576
|
+
* @maxLength 2000
|
|
577
|
+
*/
|
|
470
578
|
link?: string | null;
|
|
471
579
|
/**
|
|
472
580
|
* Link expiration time and date.
|
|
@@ -475,25 +583,48 @@ export interface DigitalFile {
|
|
|
475
583
|
expirationDate?: Date | null;
|
|
476
584
|
}
|
|
477
585
|
export interface SubscriptionInfo {
|
|
478
|
-
/**
|
|
586
|
+
/**
|
|
587
|
+
* Subscription ID.
|
|
588
|
+
* @format GUID
|
|
589
|
+
*/
|
|
479
590
|
id?: string | null;
|
|
480
|
-
/**
|
|
591
|
+
/**
|
|
592
|
+
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
593
|
+
* @min 1
|
|
594
|
+
*/
|
|
481
595
|
cycleNumber?: number;
|
|
482
|
-
/**
|
|
596
|
+
/**
|
|
597
|
+
* Subscription option title. For example, `"Monthly coffee Subscription"`.
|
|
598
|
+
* @minLength 1
|
|
599
|
+
* @maxLength 20
|
|
600
|
+
*/
|
|
483
601
|
subscriptionOptionTitle?: string;
|
|
484
|
-
/**
|
|
602
|
+
/**
|
|
603
|
+
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
604
|
+
* @maxLength 60
|
|
605
|
+
*/
|
|
485
606
|
subscriptionOptionDescription?: string | null;
|
|
486
|
-
/**
|
|
607
|
+
/**
|
|
608
|
+
* Subscription detailed information.
|
|
609
|
+
* @immutable
|
|
610
|
+
*/
|
|
487
611
|
subscriptionSettings?: SubscriptionSettings;
|
|
488
612
|
}
|
|
489
613
|
export interface SubscriptionSettings {
|
|
490
614
|
/** Frequency of recurring payment. */
|
|
491
615
|
frequency?: SubscriptionFrequency;
|
|
492
|
-
/**
|
|
616
|
+
/**
|
|
617
|
+
* Interval of recurring payment.
|
|
618
|
+
* @min 1
|
|
619
|
+
* @max 50
|
|
620
|
+
*/
|
|
493
621
|
interval?: number | null;
|
|
494
622
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
495
623
|
autoRenewal?: boolean;
|
|
496
|
-
/**
|
|
624
|
+
/**
|
|
625
|
+
* Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
|
|
626
|
+
* @min 1
|
|
627
|
+
*/
|
|
497
628
|
billingCycles?: number | null;
|
|
498
629
|
}
|
|
499
630
|
/** Frequency unit of recurring payment */
|
|
@@ -507,20 +638,38 @@ export declare enum SubscriptionFrequency {
|
|
|
507
638
|
export interface FreeTrialPeriod {
|
|
508
639
|
/** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
|
|
509
640
|
frequency?: SubscriptionFrequency;
|
|
510
|
-
/**
|
|
641
|
+
/**
|
|
642
|
+
* interval of period
|
|
643
|
+
* @min 1
|
|
644
|
+
* @max 50
|
|
645
|
+
*/
|
|
511
646
|
interval?: number;
|
|
512
647
|
}
|
|
513
648
|
export interface LocationAndQuantity {
|
|
514
|
-
/**
|
|
649
|
+
/**
|
|
650
|
+
* Location id in the associated owner app.
|
|
651
|
+
* @format GUID
|
|
652
|
+
*/
|
|
515
653
|
id?: string;
|
|
516
654
|
/**
|
|
517
655
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
656
|
+
* @format GUID
|
|
518
657
|
* @deprecated Location owner app, if not provided then the site business info locations will be used.
|
|
519
658
|
* @targetRemovalDate 2025-03-01
|
|
520
659
|
*/
|
|
521
660
|
appId?: string | null;
|
|
522
|
-
/**
|
|
661
|
+
/**
|
|
662
|
+
* Quantity for specific location.
|
|
663
|
+
* @min 1
|
|
664
|
+
* @max 100000
|
|
665
|
+
*/
|
|
523
666
|
quantity?: number;
|
|
667
|
+
/**
|
|
668
|
+
* Location name.
|
|
669
|
+
* @maxLength 500
|
|
670
|
+
* @readonly
|
|
671
|
+
*/
|
|
672
|
+
name?: string | null;
|
|
524
673
|
}
|
|
525
674
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
526
675
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
@@ -549,7 +698,11 @@ export interface ExtendedFields {
|
|
|
549
698
|
namespaces?: Record<string, Record<string, any>>;
|
|
550
699
|
}
|
|
551
700
|
export interface ItemChangedDetails {
|
|
552
|
-
/**
|
|
701
|
+
/**
|
|
702
|
+
* Line item quantity before change.
|
|
703
|
+
* @min 1
|
|
704
|
+
* @max 1000000
|
|
705
|
+
*/
|
|
553
706
|
quantityBeforeChange?: number | null;
|
|
554
707
|
/** Line item price before change. */
|
|
555
708
|
priceBeforeChange?: Price;
|
|
@@ -576,13 +729,22 @@ export interface ShippingDetailsChangeTypeOneOf {
|
|
|
576
729
|
removed?: boolean;
|
|
577
730
|
}
|
|
578
731
|
export interface V1ShippingInformation {
|
|
579
|
-
/**
|
|
732
|
+
/**
|
|
733
|
+
* App Def Id of external provider which was a source of shipping info
|
|
734
|
+
* @minLength 1
|
|
735
|
+
* @maxLength 100
|
|
736
|
+
*/
|
|
580
737
|
carrierId?: string | null;
|
|
581
|
-
/**
|
|
738
|
+
/**
|
|
739
|
+
* Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
|
|
740
|
+
* @minLength 1
|
|
741
|
+
* @maxLength 100
|
|
742
|
+
*/
|
|
582
743
|
code?: string | null;
|
|
583
744
|
/**
|
|
584
745
|
* Shipping option title.
|
|
585
746
|
* For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
|
|
747
|
+
* @maxLength 250
|
|
586
748
|
*/
|
|
587
749
|
title?: string;
|
|
588
750
|
/** Shipping logistics. */
|
|
@@ -597,9 +759,15 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
|
597
759
|
shippingDestination?: AddressWithContact;
|
|
598
760
|
/** Pickup details. */
|
|
599
761
|
pickupDetails?: V1PickupDetails;
|
|
600
|
-
/**
|
|
762
|
+
/**
|
|
763
|
+
* Expected delivery time in free text. For example, `"3-5 business days"`.
|
|
764
|
+
* @maxLength 500
|
|
765
|
+
*/
|
|
601
766
|
deliveryTime?: string | null;
|
|
602
|
-
/**
|
|
767
|
+
/**
|
|
768
|
+
* Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
|
|
769
|
+
* @maxLength 1000
|
|
770
|
+
*/
|
|
603
771
|
instructions?: string | null;
|
|
604
772
|
/**
|
|
605
773
|
* Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
@@ -625,19 +793,37 @@ export interface AddressWithContact {
|
|
|
625
793
|
}
|
|
626
794
|
/** Physical address */
|
|
627
795
|
export interface Address {
|
|
628
|
-
/**
|
|
796
|
+
/**
|
|
797
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
798
|
+
* @format COUNTRY
|
|
799
|
+
*/
|
|
629
800
|
country?: string | null;
|
|
630
|
-
/**
|
|
801
|
+
/**
|
|
802
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
803
|
+
* @maxLength 50
|
|
804
|
+
*/
|
|
631
805
|
subdivision?: string | null;
|
|
632
|
-
/**
|
|
806
|
+
/**
|
|
807
|
+
* City name.
|
|
808
|
+
* @maxLength 50
|
|
809
|
+
*/
|
|
633
810
|
city?: string | null;
|
|
634
|
-
/**
|
|
811
|
+
/**
|
|
812
|
+
* Postal or zip code.
|
|
813
|
+
* @maxLength 50
|
|
814
|
+
*/
|
|
635
815
|
postalCode?: string | null;
|
|
636
816
|
/** Street address. */
|
|
637
817
|
streetAddress?: StreetAddress;
|
|
638
|
-
/**
|
|
818
|
+
/**
|
|
819
|
+
* Main address line (usually street name and number).
|
|
820
|
+
* @maxLength 150
|
|
821
|
+
*/
|
|
639
822
|
addressLine?: string | null;
|
|
640
|
-
/**
|
|
823
|
+
/**
|
|
824
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
825
|
+
* @maxLength 100
|
|
826
|
+
*/
|
|
641
827
|
addressLine2?: string | null;
|
|
642
828
|
/**
|
|
643
829
|
* Country's full name.
|
|
@@ -664,13 +850,25 @@ export interface AddressLocation {
|
|
|
664
850
|
}
|
|
665
851
|
/** Full contact details for an address */
|
|
666
852
|
export interface FullAddressContactDetails {
|
|
667
|
-
/**
|
|
853
|
+
/**
|
|
854
|
+
* First name.
|
|
855
|
+
* @maxLength 100
|
|
856
|
+
*/
|
|
668
857
|
firstName?: string | null;
|
|
669
|
-
/**
|
|
858
|
+
/**
|
|
859
|
+
* Last name.
|
|
860
|
+
* @maxLength 100
|
|
861
|
+
*/
|
|
670
862
|
lastName?: string | null;
|
|
671
|
-
/**
|
|
863
|
+
/**
|
|
864
|
+
* Phone number.
|
|
865
|
+
* @format PHONE
|
|
866
|
+
*/
|
|
672
867
|
phone?: string | null;
|
|
673
|
-
/**
|
|
868
|
+
/**
|
|
869
|
+
* Company name.
|
|
870
|
+
* @maxLength 1000
|
|
871
|
+
*/
|
|
674
872
|
company?: string | null;
|
|
675
873
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
676
874
|
vatId?: VatId;
|
|
@@ -703,19 +901,37 @@ export interface V1PickupDetails {
|
|
|
703
901
|
}
|
|
704
902
|
/** Physical address */
|
|
705
903
|
export interface PickupAddress {
|
|
706
|
-
/**
|
|
904
|
+
/**
|
|
905
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
906
|
+
* @format COUNTRY
|
|
907
|
+
*/
|
|
707
908
|
country?: string | null;
|
|
708
|
-
/**
|
|
909
|
+
/**
|
|
910
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
911
|
+
* @maxLength 50
|
|
912
|
+
*/
|
|
709
913
|
subdivision?: string | null;
|
|
710
|
-
/**
|
|
914
|
+
/**
|
|
915
|
+
* City name.
|
|
916
|
+
* @maxLength 1000
|
|
917
|
+
*/
|
|
711
918
|
city?: string | null;
|
|
712
|
-
/**
|
|
919
|
+
/**
|
|
920
|
+
* Postal or zip code.
|
|
921
|
+
* @maxLength 1000
|
|
922
|
+
*/
|
|
713
923
|
postalCode?: string | null;
|
|
714
924
|
/** Street address object, with number, name, and apartment number in separate fields. */
|
|
715
925
|
streetAddress?: StreetAddress;
|
|
716
|
-
/**
|
|
926
|
+
/**
|
|
927
|
+
* Main address line (usually street name and number).
|
|
928
|
+
* @maxLength 1000
|
|
929
|
+
*/
|
|
717
930
|
addressLine?: string | null;
|
|
718
|
-
/**
|
|
931
|
+
/**
|
|
932
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
933
|
+
* @maxLength 1000
|
|
934
|
+
*/
|
|
719
935
|
addressLine2?: string | null;
|
|
720
936
|
/**
|
|
721
937
|
* Country's full name.
|
|
@@ -761,7 +977,10 @@ export interface V1ShippingPrice {
|
|
|
761
977
|
discount?: Price;
|
|
762
978
|
}
|
|
763
979
|
export interface ShippingRegion {
|
|
764
|
-
/**
|
|
980
|
+
/**
|
|
981
|
+
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
982
|
+
* @maxLength 100
|
|
983
|
+
*/
|
|
765
984
|
name?: string | null;
|
|
766
985
|
}
|
|
767
986
|
export interface ShippingChangedDetails {
|
|
@@ -770,20 +989,38 @@ export interface ShippingChangedDetails {
|
|
|
770
989
|
}
|
|
771
990
|
/** Buyer Info */
|
|
772
991
|
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
773
|
-
/**
|
|
992
|
+
/**
|
|
993
|
+
* Visitor ID (if site visitor is not a member).
|
|
994
|
+
* @format GUID
|
|
995
|
+
*/
|
|
774
996
|
visitorId?: string;
|
|
775
|
-
/**
|
|
997
|
+
/**
|
|
998
|
+
* Member ID (if site visitor is a site member).
|
|
999
|
+
* @format GUID
|
|
1000
|
+
*/
|
|
776
1001
|
memberId?: string;
|
|
777
|
-
/**
|
|
1002
|
+
/**
|
|
1003
|
+
* 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).
|
|
1004
|
+
* @format GUID
|
|
1005
|
+
*/
|
|
778
1006
|
contactId?: string | null;
|
|
779
|
-
/**
|
|
1007
|
+
/**
|
|
1008
|
+
* Buyer email address.
|
|
1009
|
+
* @format EMAIL
|
|
1010
|
+
*/
|
|
780
1011
|
email?: string | null;
|
|
781
1012
|
}
|
|
782
1013
|
/** @oneof */
|
|
783
1014
|
export interface BuyerInfoIdOneOf {
|
|
784
|
-
/**
|
|
1015
|
+
/**
|
|
1016
|
+
* Visitor ID (if site visitor is not a member).
|
|
1017
|
+
* @format GUID
|
|
1018
|
+
*/
|
|
785
1019
|
visitorId?: string;
|
|
786
|
-
/**
|
|
1020
|
+
/**
|
|
1021
|
+
* Member ID (if site visitor is a site member).
|
|
1022
|
+
* @format GUID
|
|
1023
|
+
*/
|
|
787
1024
|
memberId?: string;
|
|
788
1025
|
}
|
|
789
1026
|
export interface AdditionalFeeDetails {
|
|
@@ -803,32 +1040,51 @@ export interface AdditionalFeeDetails {
|
|
|
803
1040
|
applied?: boolean;
|
|
804
1041
|
}
|
|
805
1042
|
export interface AdditionalFee {
|
|
806
|
-
/**
|
|
1043
|
+
/**
|
|
1044
|
+
* Additional fee's unique code for future processing.
|
|
1045
|
+
* @minLength 1
|
|
1046
|
+
* @maxLength 100
|
|
1047
|
+
*/
|
|
807
1048
|
code?: string | null;
|
|
808
|
-
/**
|
|
1049
|
+
/**
|
|
1050
|
+
* Name of additional fee.
|
|
1051
|
+
* @minLength 1
|
|
1052
|
+
* @maxLength 50
|
|
1053
|
+
*/
|
|
809
1054
|
name?: string;
|
|
810
1055
|
/** Additional fee's price. */
|
|
811
1056
|
price?: Price;
|
|
812
1057
|
/** Tax details. */
|
|
813
1058
|
taxDetails?: ItemTaxFullDetails;
|
|
814
|
-
/**
|
|
1059
|
+
/**
|
|
1060
|
+
* SPI implementer's `appId`.
|
|
1061
|
+
* @format GUID
|
|
1062
|
+
*/
|
|
815
1063
|
providerAppId?: string | null;
|
|
816
1064
|
/** Additional fee's price before tax. */
|
|
817
1065
|
priceBeforeTax?: Price;
|
|
818
1066
|
/** Additional fee's price after tax. */
|
|
819
1067
|
priceAfterTax?: Price;
|
|
820
|
-
/**
|
|
1068
|
+
/**
|
|
1069
|
+
* Additional fee's id.
|
|
1070
|
+
* @format GUID
|
|
1071
|
+
* @immutable
|
|
1072
|
+
*/
|
|
821
1073
|
id?: string;
|
|
822
1074
|
/**
|
|
823
1075
|
* Optional - Line items associated with this additional fee.
|
|
824
1076
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
1077
|
+
* @format GUID
|
|
825
1078
|
*/
|
|
826
1079
|
lineItemIds?: string[];
|
|
827
1080
|
}
|
|
828
1081
|
export interface TaxDetails {
|
|
829
1082
|
/** Indication if additional fee is taxable or not */
|
|
830
1083
|
taxable?: boolean;
|
|
831
|
-
/**
|
|
1084
|
+
/**
|
|
1085
|
+
* Optional tax group ID to use when calculating tax for this additional fee
|
|
1086
|
+
* @format GUID
|
|
1087
|
+
*/
|
|
832
1088
|
taxGroupId?: string | null;
|
|
833
1089
|
}
|
|
834
1090
|
export declare enum SourceType {
|
|
@@ -870,13 +1126,19 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
870
1126
|
/**
|
|
871
1127
|
* IDs of line items discount applies to.
|
|
872
1128
|
* Deprecated. Use `line_item_discounts` instead.
|
|
1129
|
+
* @format GUID
|
|
1130
|
+
* @maxSize 1
|
|
873
1131
|
* @deprecated IDs of line items discount applies to.
|
|
874
1132
|
* Deprecated. Use `line_item_discounts` instead.
|
|
875
1133
|
* @replacedBy line_item_discounts
|
|
876
1134
|
* @targetRemovalDate 2024-10-30
|
|
877
1135
|
*/
|
|
878
1136
|
lineItemIds?: string[];
|
|
879
|
-
/**
|
|
1137
|
+
/**
|
|
1138
|
+
* Discount id.
|
|
1139
|
+
* @format GUID
|
|
1140
|
+
* @immutable
|
|
1141
|
+
*/
|
|
880
1142
|
id?: string | null;
|
|
881
1143
|
}
|
|
882
1144
|
/** @oneof */
|
|
@@ -910,7 +1172,10 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
910
1172
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
911
1173
|
*/
|
|
912
1174
|
discountReason?: DiscountReason;
|
|
913
|
-
/**
|
|
1175
|
+
/**
|
|
1176
|
+
* Discount description as free text (optional).
|
|
1177
|
+
* @maxLength 200
|
|
1178
|
+
*/
|
|
914
1179
|
description?: string | null;
|
|
915
1180
|
/** Discount amount. */
|
|
916
1181
|
amount?: Price;
|
|
@@ -922,7 +1187,10 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
922
1187
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
923
1188
|
*/
|
|
924
1189
|
discountReason?: DiscountReason;
|
|
925
|
-
/**
|
|
1190
|
+
/**
|
|
1191
|
+
* Discount description as free text (optional).
|
|
1192
|
+
* @maxLength 200
|
|
1193
|
+
*/
|
|
926
1194
|
description?: string | null;
|
|
927
1195
|
}
|
|
928
1196
|
export declare enum DiscountReason {
|
|
@@ -930,7 +1198,10 @@ export declare enum DiscountReason {
|
|
|
930
1198
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
|
|
931
1199
|
}
|
|
932
1200
|
export interface DiscountRule {
|
|
933
|
-
/**
|
|
1201
|
+
/**
|
|
1202
|
+
* Discount rule ID
|
|
1203
|
+
* @format GUID
|
|
1204
|
+
*/
|
|
934
1205
|
id?: string;
|
|
935
1206
|
/** Discount rule name */
|
|
936
1207
|
name?: DiscountRuleName;
|
|
@@ -938,28 +1209,51 @@ export interface DiscountRule {
|
|
|
938
1209
|
amount?: Price;
|
|
939
1210
|
}
|
|
940
1211
|
export interface DiscountRuleName {
|
|
941
|
-
/**
|
|
1212
|
+
/**
|
|
1213
|
+
* Original discount rule name (in site's default language).
|
|
1214
|
+
* @minLength 1
|
|
1215
|
+
* @maxLength 256
|
|
1216
|
+
*/
|
|
942
1217
|
original?: string;
|
|
943
|
-
/**
|
|
1218
|
+
/**
|
|
1219
|
+
* Translated discount rule name according to buyer language. Defaults to `original` when not provided.
|
|
1220
|
+
* @minLength 1
|
|
1221
|
+
* @maxLength 500
|
|
1222
|
+
*/
|
|
944
1223
|
translated?: string | null;
|
|
945
1224
|
}
|
|
946
1225
|
export interface LineItemDiscount {
|
|
947
|
-
/**
|
|
1226
|
+
/**
|
|
1227
|
+
* ID of line item the discount applies to.
|
|
1228
|
+
* @format GUID
|
|
1229
|
+
*/
|
|
948
1230
|
id?: string;
|
|
949
1231
|
/** Total discount for this line item. */
|
|
950
1232
|
totalDiscount?: Price;
|
|
951
1233
|
}
|
|
952
1234
|
export interface CreatedBy extends CreatedByStringOneOf {
|
|
953
|
-
/**
|
|
1235
|
+
/**
|
|
1236
|
+
* User ID. When the draft order was created by a Wix user.
|
|
1237
|
+
* @format GUID
|
|
1238
|
+
*/
|
|
954
1239
|
userId?: string;
|
|
955
|
-
/**
|
|
1240
|
+
/**
|
|
1241
|
+
* App ID. When the draft order was created by an app.
|
|
1242
|
+
* @format GUID
|
|
1243
|
+
*/
|
|
956
1244
|
appId?: string;
|
|
957
1245
|
}
|
|
958
1246
|
/** @oneof */
|
|
959
1247
|
export interface CreatedByStringOneOf {
|
|
960
|
-
/**
|
|
1248
|
+
/**
|
|
1249
|
+
* User ID. When the draft order was created by a Wix user.
|
|
1250
|
+
* @format GUID
|
|
1251
|
+
*/
|
|
961
1252
|
userId?: string;
|
|
962
|
-
/**
|
|
1253
|
+
/**
|
|
1254
|
+
* App ID. When the draft order was created by an app.
|
|
1255
|
+
* @format GUID
|
|
1256
|
+
*/
|
|
963
1257
|
appId?: string;
|
|
964
1258
|
}
|
|
965
1259
|
export declare enum EditingStatus {
|
|
@@ -1021,6 +1315,7 @@ export interface Balance {
|
|
|
1021
1315
|
* Balance amount.
|
|
1022
1316
|
*
|
|
1023
1317
|
* 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.
|
|
1318
|
+
* @decimalValue options { }
|
|
1024
1319
|
* @readonly
|
|
1025
1320
|
*/
|
|
1026
1321
|
amount?: string;
|
|
@@ -1059,11 +1354,15 @@ export interface DraftOrderCommitSettings {
|
|
|
1059
1354
|
/**
|
|
1060
1355
|
* Line item IDs for which to perform an inventory change.
|
|
1061
1356
|
* When not provided, inventory will not change.
|
|
1357
|
+
* @maxSize 300
|
|
1062
1358
|
*/
|
|
1063
1359
|
updateInventory?: InventoryUpdate[];
|
|
1064
1360
|
}
|
|
1065
1361
|
export interface InventoryUpdate {
|
|
1066
|
-
/**
|
|
1362
|
+
/**
|
|
1363
|
+
* Line item ID.
|
|
1364
|
+
* @format GUID
|
|
1365
|
+
*/
|
|
1067
1366
|
lineItemId?: string;
|
|
1068
1367
|
}
|
|
1069
1368
|
export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
@@ -1092,7 +1391,10 @@ export interface RecipientInfoChangedDetails {
|
|
|
1092
1391
|
export interface OrderTaxInfo {
|
|
1093
1392
|
/** Calculated tax, added from line items. */
|
|
1094
1393
|
totalTax?: Price;
|
|
1095
|
-
/**
|
|
1394
|
+
/**
|
|
1395
|
+
* 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.
|
|
1396
|
+
* @maxSize 50
|
|
1397
|
+
*/
|
|
1096
1398
|
taxBreakdown?: OrderTaxBreakdown[];
|
|
1097
1399
|
/**
|
|
1098
1400
|
* Whether the order is exempt from tax calculations.
|
|
@@ -1107,15 +1409,28 @@ export interface OrderTaxInfo {
|
|
|
1107
1409
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1108
1410
|
*/
|
|
1109
1411
|
export interface OrderTaxBreakdown {
|
|
1110
|
-
/**
|
|
1412
|
+
/**
|
|
1413
|
+
* The name of the tax against which this tax amount was calculated.
|
|
1414
|
+
* @maxLength 200
|
|
1415
|
+
*/
|
|
1111
1416
|
taxName?: string;
|
|
1112
|
-
/**
|
|
1417
|
+
/**
|
|
1418
|
+
* The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
|
|
1419
|
+
* @maxLength 200
|
|
1420
|
+
*/
|
|
1113
1421
|
taxType?: string;
|
|
1114
|
-
/**
|
|
1422
|
+
/**
|
|
1423
|
+
* The name of the jurisdiction in which this tax detail applies.
|
|
1424
|
+
* @maxLength 200
|
|
1425
|
+
*/
|
|
1115
1426
|
jurisdiction?: string;
|
|
1116
1427
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1117
1428
|
jurisdictionType?: JurisdictionType;
|
|
1118
|
-
/**
|
|
1429
|
+
/**
|
|
1430
|
+
* The rate at which this tax detail was calculated.
|
|
1431
|
+
* @format DECIMAL_VALUE
|
|
1432
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
1433
|
+
*/
|
|
1119
1434
|
rate?: string;
|
|
1120
1435
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1121
1436
|
aggregatedTaxAmount?: Price;
|
|
@@ -1135,26 +1450,48 @@ export interface BillingDetailsChangeTypeOneOf {
|
|
|
1135
1450
|
export interface BillingChangedDetails {
|
|
1136
1451
|
}
|
|
1137
1452
|
export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1453
|
+
/** Indicates that business location was added during draft. */
|
|
1454
|
+
added?: boolean;
|
|
1455
|
+
/** Indicates that business location was changed. Contains business location before draft. */
|
|
1456
|
+
changedDetails?: BusinessLocationChangedDetails;
|
|
1457
|
+
/** Indicates that business location was removed during draft. */
|
|
1458
|
+
removed?: boolean;
|
|
1459
|
+
/** Business location. */
|
|
1460
|
+
businessLocation?: Location;
|
|
1138
1461
|
}
|
|
1139
1462
|
/** @oneof */
|
|
1140
1463
|
export interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1464
|
+
/** Indicates that business location was added during draft. */
|
|
1465
|
+
added?: boolean;
|
|
1466
|
+
/** Indicates that business location was changed. Contains business location before draft. */
|
|
1467
|
+
changedDetails?: BusinessLocationChangedDetails;
|
|
1468
|
+
/** Indicates that business location was removed during draft. */
|
|
1469
|
+
removed?: boolean;
|
|
1141
1470
|
}
|
|
1142
1471
|
export interface Location {
|
|
1143
1472
|
/**
|
|
1144
1473
|
* Location ID.
|
|
1145
1474
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1475
|
+
* @format GUID
|
|
1146
1476
|
*/
|
|
1147
1477
|
id?: string;
|
|
1148
1478
|
/**
|
|
1149
1479
|
* Location name.
|
|
1480
|
+
* @minLength 1
|
|
1481
|
+
* @maxLength 500
|
|
1150
1482
|
* @readonly
|
|
1151
1483
|
*/
|
|
1152
1484
|
name?: string;
|
|
1153
1485
|
}
|
|
1154
1486
|
export interface BusinessLocationChangedDetails {
|
|
1487
|
+
/** Business location before draft. */
|
|
1488
|
+
businessLocationBeforeChange?: Location;
|
|
1155
1489
|
}
|
|
1156
1490
|
export interface CreateDraftOrderRequest {
|
|
1157
|
-
/**
|
|
1491
|
+
/**
|
|
1492
|
+
* To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
|
|
1493
|
+
* @format GUID
|
|
1494
|
+
*/
|
|
1158
1495
|
orderId: string | null;
|
|
1159
1496
|
}
|
|
1160
1497
|
export interface CreateDraftOrderResponse {
|
|
@@ -1173,7 +1510,10 @@ export interface CalculatedDraftOrder {
|
|
|
1173
1510
|
calculationErrors?: CalculationErrors;
|
|
1174
1511
|
}
|
|
1175
1512
|
export interface ShippingOption {
|
|
1176
|
-
/**
|
|
1513
|
+
/**
|
|
1514
|
+
* This carrier's unique ID
|
|
1515
|
+
* @format GUID
|
|
1516
|
+
*/
|
|
1177
1517
|
carrierId?: string | null;
|
|
1178
1518
|
/** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
|
|
1179
1519
|
code?: string;
|
|
@@ -1220,7 +1560,10 @@ export interface DeliveryTimeSlot {
|
|
|
1220
1560
|
export interface ShippingPrice {
|
|
1221
1561
|
/** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
|
|
1222
1562
|
price?: Price;
|
|
1223
|
-
/**
|
|
1563
|
+
/**
|
|
1564
|
+
* 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.
|
|
1565
|
+
* @format CURRENCY
|
|
1566
|
+
*/
|
|
1224
1567
|
currency?: string;
|
|
1225
1568
|
}
|
|
1226
1569
|
export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
@@ -1351,29 +1694,54 @@ export interface CreateEmptyDraftOrderResponse {
|
|
|
1351
1694
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1352
1695
|
}
|
|
1353
1696
|
export interface AddLineItemsToDraftOrderRequest {
|
|
1354
|
-
/**
|
|
1697
|
+
/**
|
|
1698
|
+
* The draft order id
|
|
1699
|
+
* @format GUID
|
|
1700
|
+
*/
|
|
1355
1701
|
draftOrderId: string;
|
|
1356
|
-
/**
|
|
1702
|
+
/**
|
|
1703
|
+
* Catalog line items to add to draft order.
|
|
1704
|
+
* @maxSize 300
|
|
1705
|
+
*/
|
|
1357
1706
|
catalogLineItems?: CatalogReferenceLineItem[];
|
|
1358
|
-
/**
|
|
1707
|
+
/**
|
|
1708
|
+
* Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
|
|
1709
|
+
* @maxSize 300
|
|
1710
|
+
*/
|
|
1359
1711
|
customLineItems?: CustomLineItem[];
|
|
1360
1712
|
}
|
|
1361
1713
|
export interface CatalogReferenceLineItem {
|
|
1362
1714
|
/** 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. */
|
|
1363
1715
|
catalogReference?: CatalogReference;
|
|
1364
|
-
/**
|
|
1716
|
+
/**
|
|
1717
|
+
* Item quantity.
|
|
1718
|
+
* @min 1
|
|
1719
|
+
* @max 100000
|
|
1720
|
+
*/
|
|
1365
1721
|
quantity?: number;
|
|
1366
1722
|
/** Item price override. */
|
|
1367
1723
|
price?: Price;
|
|
1724
|
+
/**
|
|
1725
|
+
* Line item locations.
|
|
1726
|
+
*
|
|
1727
|
+
* The location's total quantity must not exceed the line item quantity.
|
|
1728
|
+
* @maxSize 5
|
|
1729
|
+
*/
|
|
1730
|
+
locations?: LocationAndQuantity[];
|
|
1368
1731
|
}
|
|
1369
1732
|
export interface CustomLineItem {
|
|
1370
|
-
/**
|
|
1733
|
+
/**
|
|
1734
|
+
* Line item ID.
|
|
1735
|
+
* @format GUID
|
|
1736
|
+
*/
|
|
1371
1737
|
id?: string | null;
|
|
1372
1738
|
/**
|
|
1373
1739
|
* Item quantity.
|
|
1374
1740
|
*
|
|
1375
1741
|
* Min: `"1"`
|
|
1376
1742
|
* Max: `"100000"`
|
|
1743
|
+
* @min 1
|
|
1744
|
+
* @max 100000
|
|
1377
1745
|
*/
|
|
1378
1746
|
quantity?: number;
|
|
1379
1747
|
/** 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. */
|
|
@@ -1405,8 +1773,18 @@ export interface CustomLineItem {
|
|
|
1405
1773
|
itemType?: ItemType;
|
|
1406
1774
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1407
1775
|
priceDescription?: PriceDescription;
|
|
1408
|
-
/**
|
|
1776
|
+
/**
|
|
1777
|
+
* Delivery Profile Id for the product
|
|
1778
|
+
* @format GUID
|
|
1779
|
+
*/
|
|
1409
1780
|
deliveryProfileId?: string | null;
|
|
1781
|
+
/**
|
|
1782
|
+
* Line item locations.
|
|
1783
|
+
*
|
|
1784
|
+
* The location's total quantity must not exceed the line item quantity.
|
|
1785
|
+
* @maxSize 5
|
|
1786
|
+
*/
|
|
1787
|
+
locations?: LocationAndQuantity[];
|
|
1410
1788
|
}
|
|
1411
1789
|
export interface PageUrlV2 {
|
|
1412
1790
|
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
@@ -1415,9 +1793,17 @@ export interface PageUrlV2 {
|
|
|
1415
1793
|
url?: string | null;
|
|
1416
1794
|
}
|
|
1417
1795
|
export interface SecuredMedia {
|
|
1418
|
-
/**
|
|
1796
|
+
/**
|
|
1797
|
+
* Media ID in Wix Media Manager.
|
|
1798
|
+
* @minLength 1
|
|
1799
|
+
* @maxLength 100
|
|
1800
|
+
*/
|
|
1419
1801
|
id?: string;
|
|
1420
|
-
/**
|
|
1802
|
+
/**
|
|
1803
|
+
* Original filename.
|
|
1804
|
+
* @minLength 1
|
|
1805
|
+
* @maxLength 1000
|
|
1806
|
+
*/
|
|
1421
1807
|
fileName?: string;
|
|
1422
1808
|
/** File type. */
|
|
1423
1809
|
fileType?: FileType;
|
|
@@ -1435,17 +1821,33 @@ export interface AddLineItemsToDraftOrderResponse {
|
|
|
1435
1821
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1436
1822
|
}
|
|
1437
1823
|
export interface UpdateLineItemsRequest {
|
|
1438
|
-
/**
|
|
1824
|
+
/**
|
|
1825
|
+
* The draft order id
|
|
1826
|
+
* @format GUID
|
|
1827
|
+
*/
|
|
1439
1828
|
draftOrderId: string;
|
|
1440
|
-
/**
|
|
1829
|
+
/**
|
|
1830
|
+
* Details of changes to apply per line item
|
|
1831
|
+
* @minSize 1
|
|
1832
|
+
* @maxSize 300
|
|
1833
|
+
*/
|
|
1441
1834
|
lineItemChanges?: LineItemChangeDetails[];
|
|
1442
1835
|
}
|
|
1443
1836
|
export interface LineItemChangeDetails {
|
|
1444
|
-
/**
|
|
1837
|
+
/**
|
|
1838
|
+
* The line item id to change
|
|
1839
|
+
* @format GUID
|
|
1840
|
+
*/
|
|
1445
1841
|
lineItemId?: string;
|
|
1446
|
-
/**
|
|
1842
|
+
/**
|
|
1843
|
+
* The new quantity for the line item. quantity zero means to remove the line item.
|
|
1844
|
+
* @max 1000000
|
|
1845
|
+
*/
|
|
1447
1846
|
newQuantity?: number | null;
|
|
1448
|
-
/**
|
|
1847
|
+
/**
|
|
1848
|
+
* The new price for 1 unit of the line item
|
|
1849
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
1850
|
+
*/
|
|
1449
1851
|
newPrice?: string | null;
|
|
1450
1852
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1451
1853
|
newPriceDescription?: PriceDescription;
|
|
@@ -1455,9 +1857,15 @@ export interface UpdateLineItemsResponse {
|
|
|
1455
1857
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1456
1858
|
}
|
|
1457
1859
|
export interface SetDiscountsRequest {
|
|
1458
|
-
/**
|
|
1860
|
+
/**
|
|
1861
|
+
* The draft order id
|
|
1862
|
+
* @format GUID
|
|
1863
|
+
*/
|
|
1459
1864
|
draftOrderId: string;
|
|
1460
|
-
/**
|
|
1865
|
+
/**
|
|
1866
|
+
* The discount ids to opt-in. all existing discounts not listed are to be opted-out.
|
|
1867
|
+
* @minSize 1
|
|
1868
|
+
*/
|
|
1461
1869
|
discounts: IdAndApplied[];
|
|
1462
1870
|
}
|
|
1463
1871
|
export interface IdAndApplied {
|
|
@@ -1471,9 +1879,16 @@ export interface SetDiscountsResponse {
|
|
|
1471
1879
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1472
1880
|
}
|
|
1473
1881
|
export interface CreateCustomDiscountsRequest {
|
|
1474
|
-
/**
|
|
1882
|
+
/**
|
|
1883
|
+
* The draft order id
|
|
1884
|
+
* @format GUID
|
|
1885
|
+
*/
|
|
1475
1886
|
draftOrderId: string;
|
|
1476
|
-
/**
|
|
1887
|
+
/**
|
|
1888
|
+
* The discounts to add.
|
|
1889
|
+
* @minSize 1
|
|
1890
|
+
* @maxSize 100
|
|
1891
|
+
*/
|
|
1477
1892
|
discounts?: DiscountOption[];
|
|
1478
1893
|
}
|
|
1479
1894
|
export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
@@ -1486,6 +1901,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1486
1901
|
discountType?: DiscountType;
|
|
1487
1902
|
/**
|
|
1488
1903
|
* ID of line item discount applies to.
|
|
1904
|
+
* @format GUID
|
|
1489
1905
|
* @deprecated ID of line item discount applies to.
|
|
1490
1906
|
* @replacedBy line_item_discounts
|
|
1491
1907
|
* @targetRemovalDate 2024-10-30
|
|
@@ -1498,7 +1914,10 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1498
1914
|
* @targetRemovalDate 2024-08-30
|
|
1499
1915
|
*/
|
|
1500
1916
|
amount?: Price;
|
|
1501
|
-
/**
|
|
1917
|
+
/**
|
|
1918
|
+
* Discount description as free text (optional).
|
|
1919
|
+
* @maxLength 200
|
|
1920
|
+
*/
|
|
1502
1921
|
description?: string | null;
|
|
1503
1922
|
/**
|
|
1504
1923
|
* Should opt-in the added discount. default = false.
|
|
@@ -1520,9 +1939,17 @@ export interface CreateCustomDiscountsResponse {
|
|
|
1520
1939
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1521
1940
|
}
|
|
1522
1941
|
export interface DeleteCustomDiscountsRequest {
|
|
1523
|
-
/**
|
|
1942
|
+
/**
|
|
1943
|
+
* The draft order id
|
|
1944
|
+
* @format GUID
|
|
1945
|
+
*/
|
|
1524
1946
|
draftOrderId: string;
|
|
1525
|
-
/**
|
|
1947
|
+
/**
|
|
1948
|
+
* The discounts to remove
|
|
1949
|
+
* @format GUID
|
|
1950
|
+
* @minSize 1
|
|
1951
|
+
* @maxSize 100
|
|
1952
|
+
*/
|
|
1526
1953
|
discountIds: string[];
|
|
1527
1954
|
}
|
|
1528
1955
|
export interface DeleteCustomDiscountsResponse {
|
|
@@ -1530,9 +1957,16 @@ export interface DeleteCustomDiscountsResponse {
|
|
|
1530
1957
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1531
1958
|
}
|
|
1532
1959
|
export interface SetAdditionalFeesRequest {
|
|
1533
|
-
/**
|
|
1960
|
+
/**
|
|
1961
|
+
* The draft order id
|
|
1962
|
+
* @format GUID
|
|
1963
|
+
*/
|
|
1534
1964
|
draftOrderId: string;
|
|
1535
|
-
/**
|
|
1965
|
+
/**
|
|
1966
|
+
* The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
|
|
1967
|
+
* @minSize 1
|
|
1968
|
+
* @maxSize 100
|
|
1969
|
+
*/
|
|
1536
1970
|
additionalFees: IdAndApplied[];
|
|
1537
1971
|
}
|
|
1538
1972
|
export interface SetAdditionalFeesResponse {
|
|
@@ -1540,13 +1974,24 @@ export interface SetAdditionalFeesResponse {
|
|
|
1540
1974
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1541
1975
|
}
|
|
1542
1976
|
export interface CreateCustomAdditionalFeesRequest {
|
|
1543
|
-
/**
|
|
1977
|
+
/**
|
|
1978
|
+
* The draft order id
|
|
1979
|
+
* @format GUID
|
|
1980
|
+
*/
|
|
1544
1981
|
draftOrderId: string;
|
|
1545
|
-
/**
|
|
1982
|
+
/**
|
|
1983
|
+
* The additional fees to add. added with opted-out setting
|
|
1984
|
+
* @minSize 1
|
|
1985
|
+
* @maxSize 100
|
|
1986
|
+
*/
|
|
1546
1987
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
1547
1988
|
}
|
|
1548
1989
|
export interface AdditionalFeeOption {
|
|
1549
|
-
/**
|
|
1990
|
+
/**
|
|
1991
|
+
* Translated additional fee's name
|
|
1992
|
+
* @minLength 1
|
|
1993
|
+
* @maxLength 50
|
|
1994
|
+
*/
|
|
1550
1995
|
name?: string;
|
|
1551
1996
|
/** Additional fee's price */
|
|
1552
1997
|
price?: Price;
|
|
@@ -1557,7 +2002,11 @@ export interface AdditionalFeeOption {
|
|
|
1557
2002
|
* if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee ids
|
|
1558
2003
|
*/
|
|
1559
2004
|
applyToDraftOrder?: boolean | null;
|
|
1560
|
-
/**
|
|
2005
|
+
/**
|
|
2006
|
+
* Additional fee's unique code (or ID) for future processing
|
|
2007
|
+
* @minLength 1
|
|
2008
|
+
* @maxLength 100
|
|
2009
|
+
*/
|
|
1561
2010
|
code?: string | null;
|
|
1562
2011
|
}
|
|
1563
2012
|
export interface CreateCustomAdditionalFeesResponse {
|
|
@@ -1565,9 +2014,17 @@ export interface CreateCustomAdditionalFeesResponse {
|
|
|
1565
2014
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1566
2015
|
}
|
|
1567
2016
|
export interface DeleteCustomAdditionalFeesRequest {
|
|
1568
|
-
/**
|
|
2017
|
+
/**
|
|
2018
|
+
* The draft order id
|
|
2019
|
+
* @format GUID
|
|
2020
|
+
*/
|
|
1569
2021
|
draftOrderId: string;
|
|
1570
|
-
/**
|
|
2022
|
+
/**
|
|
2023
|
+
* The additional fees to remove
|
|
2024
|
+
* @format GUID
|
|
2025
|
+
* @minSize 1
|
|
2026
|
+
* @maxSize 100
|
|
2027
|
+
*/
|
|
1571
2028
|
customAdditionalFees: string[];
|
|
1572
2029
|
}
|
|
1573
2030
|
export interface DeleteCustomAdditionalFeesResponse {
|
|
@@ -1591,7 +2048,10 @@ export interface SetBillingInfoRequest {
|
|
|
1591
2048
|
export interface SetBillingInfoResponse {
|
|
1592
2049
|
}
|
|
1593
2050
|
export interface UpdateShippingInfoRequest {
|
|
1594
|
-
/**
|
|
2051
|
+
/**
|
|
2052
|
+
* The draft order id
|
|
2053
|
+
* @format GUID
|
|
2054
|
+
*/
|
|
1595
2055
|
draftOrderId?: string;
|
|
1596
2056
|
/** update the shipping option on the order. if not set then the selected shipping is removed */
|
|
1597
2057
|
shippingOption?: ShippingOption;
|
|
@@ -1601,7 +2061,10 @@ export interface UpdateShippingInfoResponse {
|
|
|
1601
2061
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1602
2062
|
}
|
|
1603
2063
|
export interface GetDraftOrderRequest {
|
|
1604
|
-
/**
|
|
2064
|
+
/**
|
|
2065
|
+
* The draft order id
|
|
2066
|
+
* @format GUID
|
|
2067
|
+
*/
|
|
1605
2068
|
draftOrderId: string;
|
|
1606
2069
|
}
|
|
1607
2070
|
export interface GetDraftOrderResponse {
|
|
@@ -1609,15 +2072,26 @@ export interface GetDraftOrderResponse {
|
|
|
1609
2072
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1610
2073
|
}
|
|
1611
2074
|
export interface GetOrderDraftabilityStatusRequest {
|
|
1612
|
-
/**
|
|
2075
|
+
/**
|
|
2076
|
+
* Order ID.
|
|
2077
|
+
* @minLength 1
|
|
2078
|
+
* @maxLength 100
|
|
2079
|
+
*/
|
|
1613
2080
|
orderId: string;
|
|
1614
2081
|
}
|
|
1615
2082
|
export interface GetOrderDraftabilityStatusResponse {
|
|
1616
|
-
/**
|
|
2083
|
+
/**
|
|
2084
|
+
* Order ID.
|
|
2085
|
+
* @minLength 1
|
|
2086
|
+
* @maxLength 100
|
|
2087
|
+
*/
|
|
1617
2088
|
orderId?: string;
|
|
1618
2089
|
/** Whether a draft can be created from this order */
|
|
1619
2090
|
orderDraftable?: boolean;
|
|
1620
|
-
/**
|
|
2091
|
+
/**
|
|
2092
|
+
* Reasons why the order is not draftable
|
|
2093
|
+
* @maxSize 5
|
|
2094
|
+
*/
|
|
1621
2095
|
nonDraftableReasons?: NonDraftableReason[];
|
|
1622
2096
|
}
|
|
1623
2097
|
export declare enum NonDraftableReason {
|
|
@@ -1635,11 +2109,17 @@ export declare enum NonDraftableReason {
|
|
|
1635
2109
|
TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
|
|
1636
2110
|
}
|
|
1637
2111
|
export interface CommitDraftOrderRequest {
|
|
1638
|
-
/**
|
|
2112
|
+
/**
|
|
2113
|
+
* The draft order id
|
|
2114
|
+
* @format GUID
|
|
2115
|
+
*/
|
|
1639
2116
|
draftOrderId: string;
|
|
1640
2117
|
/** Optional side effects to trigger */
|
|
1641
2118
|
commitSettings?: DraftOrderCommitSettings;
|
|
1642
|
-
/**
|
|
2119
|
+
/**
|
|
2120
|
+
* Reason for edit, given by user (optional).
|
|
2121
|
+
* @maxLength 200
|
|
2122
|
+
*/
|
|
1643
2123
|
reason?: string | null;
|
|
1644
2124
|
}
|
|
1645
2125
|
export interface CommitDraftOrderResponse {
|
|
@@ -1651,6 +2131,7 @@ export interface CommitDraftOrderResponse {
|
|
|
1651
2131
|
export interface Order {
|
|
1652
2132
|
/**
|
|
1653
2133
|
* Order ID.
|
|
2134
|
+
* @format GUID
|
|
1654
2135
|
* @readonly
|
|
1655
2136
|
*/
|
|
1656
2137
|
id?: string | null;
|
|
@@ -1662,6 +2143,7 @@ export interface Order {
|
|
|
1662
2143
|
/**
|
|
1663
2144
|
* Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
1664
2145
|
* @readonly
|
|
2146
|
+
* @immutable
|
|
1665
2147
|
*/
|
|
1666
2148
|
createdDate?: Date | null;
|
|
1667
2149
|
/**
|
|
@@ -1671,6 +2153,8 @@ export interface Order {
|
|
|
1671
2153
|
updatedDate?: Date | null;
|
|
1672
2154
|
/**
|
|
1673
2155
|
* Order line items.
|
|
2156
|
+
* @minSize 1
|
|
2157
|
+
* @maxSize 300
|
|
1674
2158
|
* @readonly
|
|
1675
2159
|
*/
|
|
1676
2160
|
lineItems?: OrderLineItem[];
|
|
@@ -1690,13 +2174,20 @@ export interface Order {
|
|
|
1690
2174
|
buyerLanguage?: string | null;
|
|
1691
2175
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
1692
2176
|
weightUnit?: WeightUnit;
|
|
1693
|
-
/**
|
|
2177
|
+
/**
|
|
2178
|
+
* 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.
|
|
2179
|
+
* @format CURRENCY
|
|
2180
|
+
*/
|
|
1694
2181
|
currency?: string | null;
|
|
1695
|
-
/**
|
|
2182
|
+
/**
|
|
2183
|
+
* Whether tax is included in line item prices.
|
|
2184
|
+
* @immutable
|
|
2185
|
+
*/
|
|
1696
2186
|
taxIncludedInPrices?: boolean;
|
|
1697
2187
|
/**
|
|
1698
2188
|
* Site language in which original values are shown.
|
|
1699
2189
|
* @readonly
|
|
2190
|
+
* @immutable
|
|
1700
2191
|
*/
|
|
1701
2192
|
siteLanguage?: string | null;
|
|
1702
2193
|
/**
|
|
@@ -1708,7 +2199,10 @@ export interface Order {
|
|
|
1708
2199
|
billingInfo?: AddressWithContact;
|
|
1709
2200
|
/** Shipping info and selected shipping option details. */
|
|
1710
2201
|
shippingInfo?: V1ShippingInformation;
|
|
1711
|
-
/**
|
|
2202
|
+
/**
|
|
2203
|
+
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
2204
|
+
* @maxLength 1000
|
|
2205
|
+
*/
|
|
1712
2206
|
buyerNote?: string | null;
|
|
1713
2207
|
/** Order status. */
|
|
1714
2208
|
status?: OrderStatus;
|
|
@@ -1727,11 +2221,15 @@ export interface Order {
|
|
|
1727
2221
|
taxSummary?: TaxSummary;
|
|
1728
2222
|
/** Tax information. */
|
|
1729
2223
|
taxInfo?: OrderTaxInfo;
|
|
1730
|
-
/**
|
|
2224
|
+
/**
|
|
2225
|
+
* Applied discounts.
|
|
2226
|
+
* @maxSize 320
|
|
2227
|
+
*/
|
|
1731
2228
|
appliedDiscounts?: AppliedDiscount[];
|
|
1732
2229
|
/**
|
|
1733
2230
|
* Order activities.
|
|
1734
2231
|
* @readonly
|
|
2232
|
+
* @maxSize 1000
|
|
1735
2233
|
*/
|
|
1736
2234
|
activities?: Activity[];
|
|
1737
2235
|
/** Order attribution source. */
|
|
@@ -1745,7 +2243,10 @@ export interface Order {
|
|
|
1745
2243
|
channelInfo?: ChannelInfo;
|
|
1746
2244
|
/** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
|
|
1747
2245
|
seenByAHuman?: boolean | null;
|
|
1748
|
-
/**
|
|
2246
|
+
/**
|
|
2247
|
+
* Checkout ID.
|
|
2248
|
+
* @format GUID
|
|
2249
|
+
*/
|
|
1749
2250
|
checkoutId?: string | null;
|
|
1750
2251
|
/** Custom fields. */
|
|
1751
2252
|
customFields?: CustomField[];
|
|
@@ -1754,7 +2255,10 @@ export interface Order {
|
|
|
1754
2255
|
* @readonly
|
|
1755
2256
|
*/
|
|
1756
2257
|
balanceSummary?: V1BalanceSummary;
|
|
1757
|
-
/**
|
|
2258
|
+
/**
|
|
2259
|
+
* Additional fees applied to the order.
|
|
2260
|
+
* @maxSize 100
|
|
2261
|
+
*/
|
|
1758
2262
|
additionalFees?: AdditionalFee[];
|
|
1759
2263
|
/**
|
|
1760
2264
|
* Custom field data for the order object.
|
|
@@ -1762,7 +2266,10 @@ export interface Order {
|
|
|
1762
2266
|
* [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.
|
|
1763
2267
|
*/
|
|
1764
2268
|
extendedFields?: ExtendedFields;
|
|
1765
|
-
/**
|
|
2269
|
+
/**
|
|
2270
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
2271
|
+
* @format GUID
|
|
2272
|
+
*/
|
|
1766
2273
|
purchaseFlowId?: string | null;
|
|
1767
2274
|
/**
|
|
1768
2275
|
* Order recipient address and contact details.
|
|
@@ -1775,8 +2282,11 @@ export interface Order {
|
|
|
1775
2282
|
/**
|
|
1776
2283
|
* Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
1777
2284
|
* Used for migration from external systems.
|
|
2285
|
+
* @immutable
|
|
1778
2286
|
*/
|
|
1779
2287
|
purchasedDate?: Date | null;
|
|
2288
|
+
/** Order Location */
|
|
2289
|
+
businessLocation?: Location;
|
|
1780
2290
|
}
|
|
1781
2291
|
export declare enum PaymentStatus {
|
|
1782
2292
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -1864,11 +2374,13 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
1864
2374
|
orderRefunded?: OrderRefunded;
|
|
1865
2375
|
/**
|
|
1866
2376
|
* Activity ID.
|
|
2377
|
+
* @format GUID
|
|
1867
2378
|
* @readonly
|
|
1868
2379
|
*/
|
|
1869
2380
|
id?: string | null;
|
|
1870
2381
|
/**
|
|
1871
2382
|
* Activity author's email.
|
|
2383
|
+
* @format EMAIL
|
|
1872
2384
|
* @readonly
|
|
1873
2385
|
*/
|
|
1874
2386
|
authorEmail?: string | null;
|
|
@@ -1890,16 +2402,26 @@ export interface ActivityContentOneOf {
|
|
|
1890
2402
|
orderRefunded?: OrderRefunded;
|
|
1891
2403
|
}
|
|
1892
2404
|
export interface CustomActivity {
|
|
1893
|
-
/**
|
|
2405
|
+
/**
|
|
2406
|
+
* ID of the app that created the custom activity.
|
|
2407
|
+
* @format GUID
|
|
2408
|
+
*/
|
|
1894
2409
|
appId?: string;
|
|
1895
|
-
/**
|
|
2410
|
+
/**
|
|
2411
|
+
* Custom activity type. For example, `"Ticket number set"`.
|
|
2412
|
+
* @maxLength 100
|
|
2413
|
+
*/
|
|
1896
2414
|
type?: string;
|
|
1897
2415
|
/** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
|
|
1898
2416
|
additionalData?: Record<string, string>;
|
|
1899
2417
|
}
|
|
1900
2418
|
/** Store owner added a comment */
|
|
1901
2419
|
export interface MerchantComment {
|
|
1902
|
-
/**
|
|
2420
|
+
/**
|
|
2421
|
+
* Merchant comment message.
|
|
2422
|
+
* @minLength 1
|
|
2423
|
+
* @maxLength 5000
|
|
2424
|
+
*/
|
|
1903
2425
|
message?: string;
|
|
1904
2426
|
}
|
|
1905
2427
|
export interface OrderRefunded {
|
|
@@ -1907,29 +2429,52 @@ export interface OrderRefunded {
|
|
|
1907
2429
|
manual?: boolean;
|
|
1908
2430
|
/** Refund amount. */
|
|
1909
2431
|
amount?: Price;
|
|
1910
|
-
/**
|
|
2432
|
+
/**
|
|
2433
|
+
* Reason for refund.
|
|
2434
|
+
* @maxLength 200
|
|
2435
|
+
*/
|
|
1911
2436
|
reason?: string;
|
|
1912
2437
|
}
|
|
1913
2438
|
export interface OrderCreatedFromExchange {
|
|
1914
|
-
/**
|
|
2439
|
+
/**
|
|
2440
|
+
* ID of the original order for which the exchange happened.
|
|
2441
|
+
* @format GUID
|
|
2442
|
+
*/
|
|
1915
2443
|
originalOrderId?: string;
|
|
1916
2444
|
}
|
|
1917
2445
|
export interface NewExchangeOrderCreated {
|
|
1918
|
-
/**
|
|
2446
|
+
/**
|
|
2447
|
+
* ID of the new order created as a result of an exchange of items.
|
|
2448
|
+
* @format GUID
|
|
2449
|
+
*/
|
|
1919
2450
|
exchangeOrderId?: string;
|
|
1920
|
-
/**
|
|
2451
|
+
/**
|
|
2452
|
+
* IDs of the items that were exchanged.
|
|
2453
|
+
* @minSize 1
|
|
2454
|
+
* @maxSize 300
|
|
2455
|
+
*/
|
|
1921
2456
|
lineItems?: LineItemExchangeData[];
|
|
1922
2457
|
}
|
|
1923
2458
|
export interface LineItemExchangeData {
|
|
1924
|
-
/**
|
|
2459
|
+
/**
|
|
2460
|
+
* ID of the exchanged line item.
|
|
2461
|
+
* @format GUID
|
|
2462
|
+
*/
|
|
1925
2463
|
lineItemId?: string;
|
|
1926
|
-
/**
|
|
2464
|
+
/**
|
|
2465
|
+
* Line item quantity being exchanged.
|
|
2466
|
+
* @min 1
|
|
2467
|
+
* @max 100000
|
|
2468
|
+
*/
|
|
1927
2469
|
quantity?: number;
|
|
1928
2470
|
}
|
|
1929
2471
|
export interface DraftOrderChangesApplied {
|
|
1930
2472
|
/** Draft order id. */
|
|
1931
2473
|
draftOrderId?: string;
|
|
1932
|
-
/**
|
|
2474
|
+
/**
|
|
2475
|
+
* Reason for edit, given by user (optional).
|
|
2476
|
+
* @maxLength 200
|
|
2477
|
+
*/
|
|
1933
2478
|
reason?: string | null;
|
|
1934
2479
|
/** Changes applied to order. */
|
|
1935
2480
|
changes?: OrderChange[];
|
|
@@ -1958,7 +2503,10 @@ export interface OrderChangeValueOneOf {
|
|
|
1958
2503
|
shippingInformationChanged?: ShippingInformationChange;
|
|
1959
2504
|
}
|
|
1960
2505
|
export interface LineItemChanges {
|
|
1961
|
-
/**
|
|
2506
|
+
/**
|
|
2507
|
+
* Line item ID.
|
|
2508
|
+
* @format GUID
|
|
2509
|
+
*/
|
|
1962
2510
|
id?: string;
|
|
1963
2511
|
/** Item name. */
|
|
1964
2512
|
name?: ProductName;
|
|
@@ -1968,11 +2516,21 @@ export interface LineItemChanges {
|
|
|
1968
2516
|
price?: LineItemPriceChange;
|
|
1969
2517
|
}
|
|
1970
2518
|
export interface LineItemQuantityChange {
|
|
1971
|
-
/**
|
|
2519
|
+
/**
|
|
2520
|
+
* Item quantity before update.
|
|
2521
|
+
* @max 1000000
|
|
2522
|
+
*/
|
|
1972
2523
|
originalQuantity?: number;
|
|
1973
|
-
/**
|
|
2524
|
+
/**
|
|
2525
|
+
* Item quantity after update.
|
|
2526
|
+
* @max 1000000
|
|
2527
|
+
*/
|
|
1974
2528
|
newQuantity?: number;
|
|
1975
|
-
/**
|
|
2529
|
+
/**
|
|
2530
|
+
* Difference between original and new quantity. Absolute value.
|
|
2531
|
+
* @min 1
|
|
2532
|
+
* @max 1000000
|
|
2533
|
+
*/
|
|
1976
2534
|
diff?: number;
|
|
1977
2535
|
/** Type of quantity change: increase or decrease. */
|
|
1978
2536
|
deltaType?: LineItemQuantityChangeType;
|
|
@@ -1990,15 +2548,25 @@ export interface LineItemPriceChange {
|
|
|
1990
2548
|
newPrice?: Price;
|
|
1991
2549
|
}
|
|
1992
2550
|
export interface ManagedLineItem {
|
|
1993
|
-
/**
|
|
2551
|
+
/**
|
|
2552
|
+
* Line item ID.
|
|
2553
|
+
* @format GUID
|
|
2554
|
+
*/
|
|
1994
2555
|
id?: string;
|
|
1995
2556
|
/** Item name. */
|
|
1996
2557
|
name?: ProductName;
|
|
1997
|
-
/**
|
|
2558
|
+
/**
|
|
2559
|
+
* Added or removed item quantity.
|
|
2560
|
+
* @min 1
|
|
2561
|
+
* @max 1000000
|
|
2562
|
+
*/
|
|
1998
2563
|
quantity?: number;
|
|
1999
2564
|
}
|
|
2000
2565
|
export interface ManagedDiscount {
|
|
2001
|
-
/**
|
|
2566
|
+
/**
|
|
2567
|
+
* Discount id.
|
|
2568
|
+
* @format GUID
|
|
2569
|
+
*/
|
|
2002
2570
|
id?: string;
|
|
2003
2571
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2004
2572
|
name?: TranslatedValue;
|
|
@@ -2008,13 +2576,22 @@ export interface ManagedDiscount {
|
|
|
2008
2576
|
totalAmount?: Price;
|
|
2009
2577
|
}
|
|
2010
2578
|
export interface TranslatedValue {
|
|
2011
|
-
/**
|
|
2579
|
+
/**
|
|
2580
|
+
* Value in site default language.
|
|
2581
|
+
* @minLength 1
|
|
2582
|
+
*/
|
|
2012
2583
|
original?: string;
|
|
2013
|
-
/**
|
|
2584
|
+
/**
|
|
2585
|
+
* Translated value.
|
|
2586
|
+
* @minLength 1
|
|
2587
|
+
*/
|
|
2014
2588
|
translated?: string | null;
|
|
2015
2589
|
}
|
|
2016
2590
|
export interface LineItemAmount {
|
|
2017
|
-
/**
|
|
2591
|
+
/**
|
|
2592
|
+
* Order line item id
|
|
2593
|
+
* @format GUID
|
|
2594
|
+
*/
|
|
2018
2595
|
id?: string;
|
|
2019
2596
|
/** Item name. */
|
|
2020
2597
|
name?: ProductName;
|
|
@@ -2022,7 +2599,10 @@ export interface LineItemAmount {
|
|
|
2022
2599
|
amount?: Price;
|
|
2023
2600
|
}
|
|
2024
2601
|
export interface ManagedAdditionalFee {
|
|
2025
|
-
/**
|
|
2602
|
+
/**
|
|
2603
|
+
* Additional fee id.
|
|
2604
|
+
* @format GUID
|
|
2605
|
+
*/
|
|
2026
2606
|
id?: string;
|
|
2027
2607
|
/** Additional fee name. */
|
|
2028
2608
|
name?: TranslatedValue;
|
|
@@ -2046,54 +2626,102 @@ export interface ShippingInformationChange {
|
|
|
2046
2626
|
export interface ShippingInformation {
|
|
2047
2627
|
/** Order’s shipping price. */
|
|
2048
2628
|
total?: Price;
|
|
2049
|
-
/**
|
|
2629
|
+
/**
|
|
2630
|
+
* Order’s shipping title.
|
|
2631
|
+
* @maxLength 250
|
|
2632
|
+
*/
|
|
2050
2633
|
shippingTitle?: string;
|
|
2051
2634
|
}
|
|
2052
2635
|
/** Payment method is saved for order */
|
|
2053
2636
|
export interface SavedPaymentMethod {
|
|
2054
|
-
/**
|
|
2637
|
+
/**
|
|
2638
|
+
* Payment method name
|
|
2639
|
+
* @minLength 1
|
|
2640
|
+
* @maxLength 100
|
|
2641
|
+
*/
|
|
2055
2642
|
name?: string;
|
|
2056
|
-
/**
|
|
2643
|
+
/**
|
|
2644
|
+
* Payment method description
|
|
2645
|
+
* @minLength 1
|
|
2646
|
+
* @maxLength 100
|
|
2647
|
+
*/
|
|
2057
2648
|
description?: string | null;
|
|
2058
2649
|
}
|
|
2059
2650
|
export interface AuthorizedPaymentCreated {
|
|
2060
|
-
/**
|
|
2651
|
+
/**
|
|
2652
|
+
* Payment ID of payment associated with this activity
|
|
2653
|
+
* @format GUID
|
|
2654
|
+
*/
|
|
2061
2655
|
paymentId?: string;
|
|
2062
2656
|
/** Payment amount */
|
|
2063
2657
|
amount?: Price;
|
|
2064
|
-
/**
|
|
2658
|
+
/**
|
|
2659
|
+
* The last 4 digits of the card number.
|
|
2660
|
+
* @maxLength 4
|
|
2661
|
+
*/
|
|
2065
2662
|
lastFourDigits?: string | null;
|
|
2066
|
-
/**
|
|
2663
|
+
/**
|
|
2664
|
+
* Card issuer's brand.
|
|
2665
|
+
* @maxLength 100
|
|
2666
|
+
*/
|
|
2067
2667
|
brand?: string | null;
|
|
2068
2668
|
}
|
|
2069
2669
|
export interface AuthorizedPaymentCaptured {
|
|
2070
|
-
/**
|
|
2670
|
+
/**
|
|
2671
|
+
* Payment ID of payment associated with this activity
|
|
2672
|
+
* @format GUID
|
|
2673
|
+
*/
|
|
2071
2674
|
paymentId?: string;
|
|
2072
2675
|
/** Payment amount */
|
|
2073
2676
|
amount?: Price;
|
|
2074
|
-
/**
|
|
2677
|
+
/**
|
|
2678
|
+
* The last 4 digits of the card number.
|
|
2679
|
+
* @maxLength 4
|
|
2680
|
+
*/
|
|
2075
2681
|
lastFourDigits?: string | null;
|
|
2076
|
-
/**
|
|
2682
|
+
/**
|
|
2683
|
+
* Card issuer's brand.
|
|
2684
|
+
* @maxLength 100
|
|
2685
|
+
*/
|
|
2077
2686
|
brand?: string | null;
|
|
2078
2687
|
}
|
|
2079
2688
|
export interface AuthorizedPaymentVoided {
|
|
2080
|
-
/**
|
|
2689
|
+
/**
|
|
2690
|
+
* Payment ID of payment associated with this activity
|
|
2691
|
+
* @format GUID
|
|
2692
|
+
*/
|
|
2081
2693
|
paymentId?: string;
|
|
2082
2694
|
/** Payment amount */
|
|
2083
2695
|
amount?: Price;
|
|
2084
|
-
/**
|
|
2696
|
+
/**
|
|
2697
|
+
* The last 4 digits of the card number.
|
|
2698
|
+
* @maxLength 4
|
|
2699
|
+
*/
|
|
2085
2700
|
lastFourDigits?: string | null;
|
|
2086
|
-
/**
|
|
2701
|
+
/**
|
|
2702
|
+
* Card issuer's brand.
|
|
2703
|
+
* @maxLength 100
|
|
2704
|
+
*/
|
|
2087
2705
|
brand?: string | null;
|
|
2088
2706
|
}
|
|
2089
2707
|
export interface RefundInitiated {
|
|
2090
|
-
/**
|
|
2708
|
+
/**
|
|
2709
|
+
* Refund ID.
|
|
2710
|
+
* @format GUID
|
|
2711
|
+
*/
|
|
2091
2712
|
refundId?: string;
|
|
2092
2713
|
/** Refund amount. */
|
|
2093
2714
|
amount?: Price;
|
|
2094
|
-
/**
|
|
2715
|
+
/**
|
|
2716
|
+
* Details about the payments being refunded.
|
|
2717
|
+
* @minSize 1
|
|
2718
|
+
* @maxSize 50
|
|
2719
|
+
*/
|
|
2095
2720
|
payments?: RefundedPayment[];
|
|
2096
|
-
/**
|
|
2721
|
+
/**
|
|
2722
|
+
* Reason for refund.
|
|
2723
|
+
* @maxLength 100
|
|
2724
|
+
*/
|
|
2097
2725
|
reason?: string | null;
|
|
2098
2726
|
}
|
|
2099
2727
|
export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
@@ -2103,7 +2731,10 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
2103
2731
|
giftCard?: GiftCardPaymentRefund;
|
|
2104
2732
|
/** Membership payment refund. */
|
|
2105
2733
|
membership?: MembershipPaymentRefund;
|
|
2106
|
-
/**
|
|
2734
|
+
/**
|
|
2735
|
+
* Payment ID.
|
|
2736
|
+
* @format GUID
|
|
2737
|
+
*/
|
|
2107
2738
|
paymentId?: string;
|
|
2108
2739
|
/** Whether refund was made externally and manually on the payment provider's side. */
|
|
2109
2740
|
externalRefund?: boolean;
|
|
@@ -2120,29 +2751,49 @@ export interface RefundedPaymentKindOneOf {
|
|
|
2120
2751
|
export interface RegularPaymentRefund {
|
|
2121
2752
|
/** Refund amount */
|
|
2122
2753
|
amount?: Price;
|
|
2123
|
-
/**
|
|
2754
|
+
/**
|
|
2755
|
+
* The last 4 digits of the card number.
|
|
2756
|
+
* @maxLength 4
|
|
2757
|
+
*/
|
|
2124
2758
|
lastFourDigits?: string | null;
|
|
2125
|
-
/**
|
|
2759
|
+
/**
|
|
2760
|
+
* Card issuer's brand.
|
|
2761
|
+
* @maxLength 100
|
|
2762
|
+
*/
|
|
2126
2763
|
brand?: string | null;
|
|
2127
2764
|
}
|
|
2128
2765
|
export interface GiftCardPaymentRefund {
|
|
2129
|
-
/**
|
|
2766
|
+
/**
|
|
2767
|
+
* Gift card payment ID
|
|
2768
|
+
* @minLength 1
|
|
2769
|
+
* @maxLength 100
|
|
2770
|
+
*/
|
|
2130
2771
|
giftCardPaymentId?: string | null;
|
|
2131
2772
|
/** Refund amount */
|
|
2132
2773
|
amount?: Price;
|
|
2133
2774
|
}
|
|
2134
2775
|
export interface MembershipPaymentRefund {
|
|
2135
|
-
/**
|
|
2776
|
+
/**
|
|
2777
|
+
* Membership ID
|
|
2778
|
+
* @minLength 1
|
|
2779
|
+
* @maxLength 100
|
|
2780
|
+
*/
|
|
2136
2781
|
membershipId?: string | null;
|
|
2137
2782
|
}
|
|
2138
2783
|
export interface PaymentRefunded {
|
|
2139
|
-
/**
|
|
2784
|
+
/**
|
|
2785
|
+
* Refund ID.
|
|
2786
|
+
* @format GUID
|
|
2787
|
+
*/
|
|
2140
2788
|
refundId?: string;
|
|
2141
2789
|
/** Details about the refunded payment. */
|
|
2142
2790
|
payment?: RefundedPayment;
|
|
2143
2791
|
}
|
|
2144
2792
|
export interface PaymentRefundFailed {
|
|
2145
|
-
/**
|
|
2793
|
+
/**
|
|
2794
|
+
* Refund ID.
|
|
2795
|
+
* @format GUID
|
|
2796
|
+
*/
|
|
2146
2797
|
refundId?: string;
|
|
2147
2798
|
/** Details about the failed payment refund. */
|
|
2148
2799
|
payment?: RefundedPayment;
|
|
@@ -2150,13 +2801,19 @@ export interface PaymentRefundFailed {
|
|
|
2150
2801
|
export interface RefundedAsStoreCredit {
|
|
2151
2802
|
/** Refund amount */
|
|
2152
2803
|
amount?: Price;
|
|
2153
|
-
/**
|
|
2804
|
+
/**
|
|
2805
|
+
* Reason for refund
|
|
2806
|
+
* @maxLength 100
|
|
2807
|
+
*/
|
|
2154
2808
|
reason?: string | null;
|
|
2155
2809
|
}
|
|
2156
2810
|
export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
2157
2811
|
/** Regular payment. */
|
|
2158
2812
|
regular?: RegularPayment;
|
|
2159
|
-
/**
|
|
2813
|
+
/**
|
|
2814
|
+
* Payment ID of payment associated with this activity
|
|
2815
|
+
* @format GUID
|
|
2816
|
+
*/
|
|
2160
2817
|
paymentId?: string;
|
|
2161
2818
|
}
|
|
2162
2819
|
/** @oneof */
|
|
@@ -2176,15 +2833,24 @@ export interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
|
2176
2833
|
creditCardDetails?: CreditCardDetails;
|
|
2177
2834
|
}
|
|
2178
2835
|
export interface CreditCardDetails {
|
|
2179
|
-
/**
|
|
2836
|
+
/**
|
|
2837
|
+
* The last 4 digits of the card number.
|
|
2838
|
+
* @maxLength 4
|
|
2839
|
+
*/
|
|
2180
2840
|
lastFourDigits?: string | null;
|
|
2181
|
-
/**
|
|
2841
|
+
/**
|
|
2842
|
+
* Card issuer's brand.
|
|
2843
|
+
* @maxLength 100
|
|
2844
|
+
*/
|
|
2182
2845
|
brand?: string | null;
|
|
2183
2846
|
}
|
|
2184
2847
|
export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
2185
2848
|
/** Regular payment. */
|
|
2186
2849
|
regular?: RegularPayment;
|
|
2187
|
-
/**
|
|
2850
|
+
/**
|
|
2851
|
+
* Payment ID of payment associated with this activity
|
|
2852
|
+
* @format GUID
|
|
2853
|
+
*/
|
|
2188
2854
|
paymentId?: string;
|
|
2189
2855
|
}
|
|
2190
2856
|
/** @oneof */
|
|
@@ -2195,7 +2861,10 @@ export interface PaymentCanceledPaymentDetailsOneOf {
|
|
|
2195
2861
|
export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
2196
2862
|
/** Regular payment. */
|
|
2197
2863
|
regular?: RegularPayment;
|
|
2198
|
-
/**
|
|
2864
|
+
/**
|
|
2865
|
+
* Payment ID of payment associated with this activity
|
|
2866
|
+
* @format GUID
|
|
2867
|
+
*/
|
|
2199
2868
|
paymentId?: string;
|
|
2200
2869
|
}
|
|
2201
2870
|
/** @oneof */
|
|
@@ -2208,7 +2877,10 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
2208
2877
|
wixReceipt?: WixReceipt;
|
|
2209
2878
|
/** Receipt created by an external system. */
|
|
2210
2879
|
externalReceipt?: ExternalReceipt;
|
|
2211
|
-
/**
|
|
2880
|
+
/**
|
|
2881
|
+
* Payment ID of payment associated with this activity
|
|
2882
|
+
* @format GUID
|
|
2883
|
+
*/
|
|
2212
2884
|
paymentId?: string;
|
|
2213
2885
|
}
|
|
2214
2886
|
/** @oneof */
|
|
@@ -2219,15 +2891,29 @@ export interface ReceiptCreatedReceiptInfoOneOf {
|
|
|
2219
2891
|
externalReceipt?: ExternalReceipt;
|
|
2220
2892
|
}
|
|
2221
2893
|
export interface WixReceipt {
|
|
2222
|
-
/**
|
|
2894
|
+
/**
|
|
2895
|
+
* Receipt ID
|
|
2896
|
+
* @format GUID
|
|
2897
|
+
*/
|
|
2223
2898
|
receiptId?: string;
|
|
2224
|
-
/**
|
|
2899
|
+
/**
|
|
2900
|
+
* Display number of receipt
|
|
2901
|
+
* @minLength 1
|
|
2902
|
+
* @maxLength 40
|
|
2903
|
+
*/
|
|
2225
2904
|
displayNumber?: string | null;
|
|
2226
2905
|
}
|
|
2227
2906
|
export interface ExternalReceipt {
|
|
2228
|
-
/**
|
|
2907
|
+
/**
|
|
2908
|
+
* Receipt ID
|
|
2909
|
+
* @maxLength 100
|
|
2910
|
+
*/
|
|
2229
2911
|
receiptId?: string | null;
|
|
2230
|
-
/**
|
|
2912
|
+
/**
|
|
2913
|
+
* Display number of receipt
|
|
2914
|
+
* @minLength 1
|
|
2915
|
+
* @maxLength 40
|
|
2916
|
+
*/
|
|
2231
2917
|
displayNumber?: string | null;
|
|
2232
2918
|
}
|
|
2233
2919
|
export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
@@ -2235,7 +2921,10 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
2235
2921
|
wixReceipt?: WixReceipt;
|
|
2236
2922
|
/** Receipt created by an external system. */
|
|
2237
2923
|
externalReceipt?: ExternalReceipt;
|
|
2238
|
-
/**
|
|
2924
|
+
/**
|
|
2925
|
+
* Payment ID of payment associated with this activity
|
|
2926
|
+
* @format GUID
|
|
2927
|
+
*/
|
|
2239
2928
|
paymentId?: string;
|
|
2240
2929
|
}
|
|
2241
2930
|
/** @oneof */
|
|
@@ -2290,13 +2979,23 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
2290
2979
|
/**
|
|
2291
2980
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
2292
2981
|
* For example, via POS (point of service).
|
|
2982
|
+
* @format GUID
|
|
2293
2983
|
*/
|
|
2294
2984
|
userId?: string;
|
|
2295
|
-
/**
|
|
2985
|
+
/**
|
|
2986
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
2987
|
+
* @format GUID
|
|
2988
|
+
*/
|
|
2296
2989
|
memberId?: string;
|
|
2297
|
-
/**
|
|
2990
|
+
/**
|
|
2991
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
2992
|
+
* @format GUID
|
|
2993
|
+
*/
|
|
2298
2994
|
visitorId?: string;
|
|
2299
|
-
/**
|
|
2995
|
+
/**
|
|
2996
|
+
* App ID - when the order was created by an external application.
|
|
2997
|
+
* @format GUID
|
|
2998
|
+
*/
|
|
2300
2999
|
appId?: string;
|
|
2301
3000
|
}
|
|
2302
3001
|
/** @oneof */
|
|
@@ -2304,21 +3003,37 @@ export interface V1CreatedByStringOneOf {
|
|
|
2304
3003
|
/**
|
|
2305
3004
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
2306
3005
|
* For example, via POS (point of service).
|
|
3006
|
+
* @format GUID
|
|
2307
3007
|
*/
|
|
2308
3008
|
userId?: string;
|
|
2309
|
-
/**
|
|
3009
|
+
/**
|
|
3010
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
3011
|
+
* @format GUID
|
|
3012
|
+
*/
|
|
2310
3013
|
memberId?: string;
|
|
2311
|
-
/**
|
|
3014
|
+
/**
|
|
3015
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
3016
|
+
* @format GUID
|
|
3017
|
+
*/
|
|
2312
3018
|
visitorId?: string;
|
|
2313
|
-
/**
|
|
3019
|
+
/**
|
|
3020
|
+
* App ID - when the order was created by an external application.
|
|
3021
|
+
* @format GUID
|
|
3022
|
+
*/
|
|
2314
3023
|
appId?: string;
|
|
2315
3024
|
}
|
|
2316
3025
|
export interface ChannelInfo {
|
|
2317
3026
|
/** Sales channel that submitted the order. */
|
|
2318
3027
|
type?: ChannelType;
|
|
2319
|
-
/**
|
|
3028
|
+
/**
|
|
3029
|
+
* Reference to an order ID from an external system.
|
|
3030
|
+
* @maxLength 100
|
|
3031
|
+
*/
|
|
2320
3032
|
externalOrderId?: string | null;
|
|
2321
|
-
/**
|
|
3033
|
+
/**
|
|
3034
|
+
* URL to the order in the external system.
|
|
3035
|
+
* @maxLength 300
|
|
3036
|
+
*/
|
|
2322
3037
|
externalOrderUrl?: string | null;
|
|
2323
3038
|
}
|
|
2324
3039
|
export declare enum ChannelType {
|
|
@@ -2358,9 +3073,17 @@ export declare enum ChannelType {
|
|
|
2358
3073
|
export interface CustomField {
|
|
2359
3074
|
/** Custom field value. */
|
|
2360
3075
|
value?: any;
|
|
2361
|
-
/**
|
|
3076
|
+
/**
|
|
3077
|
+
* Custom field title.
|
|
3078
|
+
* @minLength 1
|
|
3079
|
+
* @maxLength 500
|
|
3080
|
+
*/
|
|
2362
3081
|
title?: string;
|
|
2363
|
-
/**
|
|
3082
|
+
/**
|
|
3083
|
+
* Translated custom field title.
|
|
3084
|
+
* @minLength 1
|
|
3085
|
+
* @maxLength 500
|
|
3086
|
+
*/
|
|
2364
3087
|
translatedTitle?: string | null;
|
|
2365
3088
|
}
|
|
2366
3089
|
export interface V1BalanceSummary {
|
|
@@ -2425,7 +3148,11 @@ export interface Tags {
|
|
|
2425
3148
|
tags?: TagList;
|
|
2426
3149
|
}
|
|
2427
3150
|
export interface TagList {
|
|
2428
|
-
/**
|
|
3151
|
+
/**
|
|
3152
|
+
* List of tag IDs
|
|
3153
|
+
* @maxSize 100
|
|
3154
|
+
* @maxLength 5
|
|
3155
|
+
*/
|
|
2429
3156
|
tagIds?: string[];
|
|
2430
3157
|
}
|
|
2431
3158
|
export interface CreateOrderFromDraftRequest {
|
|
@@ -2437,7 +3164,10 @@ export interface OrderCreateNotifications {
|
|
|
2437
3164
|
export interface CreateOrderFromDraftResponse {
|
|
2438
3165
|
}
|
|
2439
3166
|
export interface DeleteDraftOrderRequest {
|
|
2440
|
-
/**
|
|
3167
|
+
/**
|
|
3168
|
+
* The draft order id
|
|
3169
|
+
* @format GUID
|
|
3170
|
+
*/
|
|
2441
3171
|
draftOrderId: string;
|
|
2442
3172
|
}
|
|
2443
3173
|
export interface DeleteDraftOrderResponse {
|
|
@@ -2463,6 +3193,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2463
3193
|
* Sort object.
|
|
2464
3194
|
*
|
|
2465
3195
|
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
3196
|
+
* @maxSize 5
|
|
2466
3197
|
*/
|
|
2467
3198
|
sort?: Sorting[];
|
|
2468
3199
|
}
|
|
@@ -2476,7 +3207,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
2476
3207
|
cursorPaging?: CursorPaging;
|
|
2477
3208
|
}
|
|
2478
3209
|
export interface Sorting {
|
|
2479
|
-
/**
|
|
3210
|
+
/**
|
|
3211
|
+
* Name of the field to sort by.
|
|
3212
|
+
* @maxLength 512
|
|
3213
|
+
*/
|
|
2480
3214
|
fieldName?: string;
|
|
2481
3215
|
/** Sort order. */
|
|
2482
3216
|
order?: SortOrder;
|
|
@@ -2486,13 +3220,17 @@ export declare enum SortOrder {
|
|
|
2486
3220
|
DESC = "DESC"
|
|
2487
3221
|
}
|
|
2488
3222
|
export interface CursorPaging {
|
|
2489
|
-
/**
|
|
3223
|
+
/**
|
|
3224
|
+
* Maximum number of items to return in the results.
|
|
3225
|
+
* @max 100
|
|
3226
|
+
*/
|
|
2490
3227
|
limit?: number | null;
|
|
2491
3228
|
/**
|
|
2492
3229
|
* Pointer to the next or previous page in the list of results.
|
|
2493
3230
|
*
|
|
2494
3231
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2495
3232
|
* Not relevant for the first request.
|
|
3233
|
+
* @maxLength 16000
|
|
2496
3234
|
*/
|
|
2497
3235
|
cursor?: string | null;
|
|
2498
3236
|
}
|
|
@@ -2516,9 +3254,15 @@ export interface CursorPagingMetadata {
|
|
|
2516
3254
|
hasNext?: boolean | null;
|
|
2517
3255
|
}
|
|
2518
3256
|
export interface Cursors {
|
|
2519
|
-
/**
|
|
3257
|
+
/**
|
|
3258
|
+
* Cursor string pointing to the next page in the list of results.
|
|
3259
|
+
* @maxLength 16000
|
|
3260
|
+
*/
|
|
2520
3261
|
next?: string | null;
|
|
2521
|
-
/**
|
|
3262
|
+
/**
|
|
3263
|
+
* Cursor pointing to the previous page in the list of results.
|
|
3264
|
+
* @maxLength 16000
|
|
3265
|
+
*/
|
|
2522
3266
|
prev?: string | null;
|
|
2523
3267
|
}
|
|
2524
3268
|
export interface UpdateExtendedFieldsRequest {
|
|
@@ -2538,11 +3282,17 @@ export interface SetTaxExemptionRequest {
|
|
|
2538
3282
|
export interface SetTaxExemptionResponse {
|
|
2539
3283
|
}
|
|
2540
3284
|
export interface GetDraftEditabilityStatusRequest {
|
|
2541
|
-
/**
|
|
3285
|
+
/**
|
|
3286
|
+
* Draft order ID.
|
|
3287
|
+
* @format GUID
|
|
3288
|
+
*/
|
|
2542
3289
|
draftOrderId?: string | null;
|
|
2543
3290
|
}
|
|
2544
3291
|
export interface GetDraftEditabilityStatusResponse {
|
|
2545
|
-
/**
|
|
3292
|
+
/**
|
|
3293
|
+
* Draft order ID.
|
|
3294
|
+
* @format GUID
|
|
3295
|
+
*/
|
|
2546
3296
|
draftOrderId?: string | null;
|
|
2547
3297
|
/**
|
|
2548
3298
|
* Draft order status.
|
|
@@ -2627,9 +3377,15 @@ export interface ActionEvent {
|
|
|
2627
3377
|
bodyAsJson?: string;
|
|
2628
3378
|
}
|
|
2629
3379
|
export interface MessageEnvelope {
|
|
2630
|
-
/**
|
|
3380
|
+
/**
|
|
3381
|
+
* App instance ID.
|
|
3382
|
+
* @format GUID
|
|
3383
|
+
*/
|
|
2631
3384
|
instanceId?: string | null;
|
|
2632
|
-
/**
|
|
3385
|
+
/**
|
|
3386
|
+
* Event type.
|
|
3387
|
+
* @maxLength 150
|
|
3388
|
+
*/
|
|
2633
3389
|
eventType?: string;
|
|
2634
3390
|
/** The identification type and identity data. */
|
|
2635
3391
|
identity?: IdentificationData;
|
|
@@ -2637,26 +3393,50 @@ export interface MessageEnvelope {
|
|
|
2637
3393
|
data?: string;
|
|
2638
3394
|
}
|
|
2639
3395
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2640
|
-
/**
|
|
3396
|
+
/**
|
|
3397
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3398
|
+
* @format GUID
|
|
3399
|
+
*/
|
|
2641
3400
|
anonymousVisitorId?: string;
|
|
2642
|
-
/**
|
|
3401
|
+
/**
|
|
3402
|
+
* ID of a site visitor that has logged in to the site.
|
|
3403
|
+
* @format GUID
|
|
3404
|
+
*/
|
|
2643
3405
|
memberId?: string;
|
|
2644
|
-
/**
|
|
3406
|
+
/**
|
|
3407
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3408
|
+
* @format GUID
|
|
3409
|
+
*/
|
|
2645
3410
|
wixUserId?: string;
|
|
2646
|
-
/**
|
|
3411
|
+
/**
|
|
3412
|
+
* ID of an app.
|
|
3413
|
+
* @format GUID
|
|
3414
|
+
*/
|
|
2647
3415
|
appId?: string;
|
|
2648
3416
|
/** @readonly */
|
|
2649
3417
|
identityType?: WebhookIdentityType;
|
|
2650
3418
|
}
|
|
2651
3419
|
/** @oneof */
|
|
2652
3420
|
export interface IdentificationDataIdOneOf {
|
|
2653
|
-
/**
|
|
3421
|
+
/**
|
|
3422
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3423
|
+
* @format GUID
|
|
3424
|
+
*/
|
|
2654
3425
|
anonymousVisitorId?: string;
|
|
2655
|
-
/**
|
|
3426
|
+
/**
|
|
3427
|
+
* ID of a site visitor that has logged in to the site.
|
|
3428
|
+
* @format GUID
|
|
3429
|
+
*/
|
|
2656
3430
|
memberId?: string;
|
|
2657
|
-
/**
|
|
3431
|
+
/**
|
|
3432
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3433
|
+
* @format GUID
|
|
3434
|
+
*/
|
|
2658
3435
|
wixUserId?: string;
|
|
2659
|
-
/**
|
|
3436
|
+
/**
|
|
3437
|
+
* ID of an app.
|
|
3438
|
+
* @format GUID
|
|
3439
|
+
*/
|
|
2660
3440
|
appId?: string;
|
|
2661
3441
|
}
|
|
2662
3442
|
export declare enum WebhookIdentityType {
|
|
@@ -2748,6 +3528,10 @@ interface SubscriptionInfoNonNullableFields {
|
|
|
2748
3528
|
subscriptionOptionTitle: string;
|
|
2749
3529
|
subscriptionSettings?: SubscriptionSettingsNonNullableFields;
|
|
2750
3530
|
}
|
|
3531
|
+
interface LocationAndQuantityNonNullableFields {
|
|
3532
|
+
id: string;
|
|
3533
|
+
quantity: number;
|
|
3534
|
+
}
|
|
2751
3535
|
interface OrderLineItemNonNullableFields {
|
|
2752
3536
|
id: string;
|
|
2753
3537
|
productName?: ProductNameNonNullableFields;
|
|
@@ -2769,6 +3553,7 @@ interface OrderLineItemNonNullableFields {
|
|
|
2769
3553
|
subscriptionInfo?: SubscriptionInfoNonNullableFields;
|
|
2770
3554
|
priceDescription?: PriceDescriptionNonNullableFields;
|
|
2771
3555
|
depositAmount?: PriceNonNullableFields;
|
|
3556
|
+
locations: LocationAndQuantityNonNullableFields[];
|
|
2772
3557
|
lineItemPrice?: PriceNonNullableFields;
|
|
2773
3558
|
}
|
|
2774
3559
|
interface ItemDetailsNonNullableFields {
|
|
@@ -2936,6 +3721,19 @@ interface OrderTaxInfoNonNullableFields {
|
|
|
2936
3721
|
totalTax?: PriceNonNullableFields;
|
|
2937
3722
|
taxBreakdown: OrderTaxBreakdownNonNullableFields[];
|
|
2938
3723
|
}
|
|
3724
|
+
interface LocationNonNullableFields {
|
|
3725
|
+
id: string;
|
|
3726
|
+
name: string;
|
|
3727
|
+
}
|
|
3728
|
+
interface BusinessLocationChangedDetailsNonNullableFields {
|
|
3729
|
+
businessLocationBeforeChange?: LocationNonNullableFields;
|
|
3730
|
+
}
|
|
3731
|
+
interface BusinessLocationDetailsNonNullableFields {
|
|
3732
|
+
added: boolean;
|
|
3733
|
+
changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
|
|
3734
|
+
removed: boolean;
|
|
3735
|
+
businessLocation?: LocationNonNullableFields;
|
|
3736
|
+
}
|
|
2939
3737
|
interface DraftOrderNonNullableFields {
|
|
2940
3738
|
lineItems: ItemDetailsNonNullableFields[];
|
|
2941
3739
|
shippingInfo?: ShippingDetailsNonNullableFields;
|
|
@@ -2951,6 +3749,7 @@ interface DraftOrderNonNullableFields {
|
|
|
2951
3749
|
balanceSummary?: BalanceSummaryNonNullableFields;
|
|
2952
3750
|
commitSettings?: DraftOrderCommitSettingsNonNullableFields;
|
|
2953
3751
|
recipientInfo?: RecipientInfoDetailsNonNullableFields;
|
|
3752
|
+
businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
|
|
2954
3753
|
}
|
|
2955
3754
|
interface PickupDetailsNonNullableFields {
|
|
2956
3755
|
address?: AddressNonNullableFields;
|
|
@@ -3124,6 +3923,7 @@ interface OrderNonNullableFields {
|
|
|
3124
3923
|
balanceSummary?: V1BalanceSummaryNonNullableFields;
|
|
3125
3924
|
additionalFees: AdditionalFeeNonNullableFields[];
|
|
3126
3925
|
recipientInfo?: AddressWithContactNonNullableFields;
|
|
3926
|
+
businessLocation?: LocationNonNullableFields;
|
|
3127
3927
|
}
|
|
3128
3928
|
export interface CommitDraftOrderResponseNonNullableFields {
|
|
3129
3929
|
committedDraftOrder?: DraftOrderNonNullableFields;
|