@wix/auto_sdk_ecom_draft-orders 1.0.34 → 1.0.36
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/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-BiN0i3mF.d.mts} +572 -369
- package/build/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-BiN0i3mF.d.ts} +572 -369
- package/build/index.d.mts +291 -0
- package/build/index.d.ts +291 -0
- package/build/index.js +5403 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +5326 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-DkIb6bMI.d.mts} +747 -369
- package/build/internal/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-DkIb6bMI.d.ts} +747 -369
- package/build/internal/index.d.mts +291 -0
- package/build/internal/index.d.ts +291 -0
- package/build/internal/index.js +5403 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +5326 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +3140 -0
- package/build/internal/meta.d.ts +3140 -0
- package/build/internal/meta.js +3455 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +3406 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +3140 -0
- package/build/meta.d.ts +3140 -0
- package/build/meta.js +3455 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +3406 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -43
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -75
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -131
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -3097
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -63
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -465
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -255
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -385
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -378
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4726
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -2453
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -43
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -43
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -131
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -3071
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -63
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -416
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -255
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -330
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -375
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4726
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -2403
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -43
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -75
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -131
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -3097
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -63
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -465
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -255
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -385
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -378
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4901
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -2453
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -43
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -43
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -131
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -3071
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -63
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -416
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -255
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -330
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -375
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4901
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -2403
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
* Draft Order main entity.
|
|
3
3
|
* A temporary version of an order, allowing modifications before finalization.
|
|
4
4
|
*/
|
|
5
|
-
|
|
5
|
+
interface DraftOrder {
|
|
6
6
|
/**
|
|
7
7
|
* Draft order ID.
|
|
8
8
|
* @format GUID
|
|
9
9
|
* @readonly
|
|
10
10
|
*/
|
|
11
|
-
|
|
11
|
+
_id?: string | null;
|
|
12
12
|
/**
|
|
13
13
|
* ID of the order this draft commits to.
|
|
14
14
|
* @format GUID
|
|
@@ -58,12 +58,12 @@ export interface DraftOrder {
|
|
|
58
58
|
* Date and time the draft order was created.
|
|
59
59
|
* @readonly
|
|
60
60
|
*/
|
|
61
|
-
|
|
61
|
+
_createdDate?: Date | null;
|
|
62
62
|
/**
|
|
63
63
|
* Date and time the draft order was updated.
|
|
64
64
|
* @readonly
|
|
65
65
|
*/
|
|
66
|
-
|
|
66
|
+
_updatedDate?: Date | null;
|
|
67
67
|
/**
|
|
68
68
|
* Identity of the draft order's initiator.
|
|
69
69
|
* @readonly
|
|
@@ -149,7 +149,7 @@ export interface DraftOrder {
|
|
|
149
149
|
*/
|
|
150
150
|
businessLocationDetails?: BusinessLocationDetails;
|
|
151
151
|
}
|
|
152
|
-
|
|
152
|
+
interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
153
153
|
/** Whether the line item was added as part of the draft. */
|
|
154
154
|
added?: boolean;
|
|
155
155
|
/** Line item fields before the change. */
|
|
@@ -160,7 +160,7 @@ export interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
|
160
160
|
lineItem?: OrderLineItem;
|
|
161
161
|
}
|
|
162
162
|
/** @oneof */
|
|
163
|
-
|
|
163
|
+
interface ItemDetailsChangeTypeOneOf {
|
|
164
164
|
/** Whether the line item was added as part of the draft. */
|
|
165
165
|
added?: boolean;
|
|
166
166
|
/** Line item fields before the change. */
|
|
@@ -168,7 +168,7 @@ export interface ItemDetailsChangeTypeOneOf {
|
|
|
168
168
|
/** Whether the line item was removed as part of the draft. */
|
|
169
169
|
removed?: boolean;
|
|
170
170
|
}
|
|
171
|
-
|
|
171
|
+
interface Price {
|
|
172
172
|
/**
|
|
173
173
|
* Amount.
|
|
174
174
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -180,7 +180,7 @@ export interface Price {
|
|
|
180
180
|
*/
|
|
181
181
|
formattedAmount?: string;
|
|
182
182
|
}
|
|
183
|
-
|
|
183
|
+
interface PriceDescription {
|
|
184
184
|
/**
|
|
185
185
|
* __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).
|
|
186
186
|
* @minLength 1
|
|
@@ -196,12 +196,12 @@ export interface PriceDescription {
|
|
|
196
196
|
*/
|
|
197
197
|
translated?: string | null;
|
|
198
198
|
}
|
|
199
|
-
|
|
199
|
+
interface OrderLineItem {
|
|
200
200
|
/**
|
|
201
201
|
* Line item ID.
|
|
202
202
|
* @immutable
|
|
203
203
|
*/
|
|
204
|
-
|
|
204
|
+
_id?: string;
|
|
205
205
|
/**
|
|
206
206
|
* Item name.
|
|
207
207
|
* + Stores - `product.name`
|
|
@@ -231,7 +231,7 @@ export interface OrderLineItem {
|
|
|
231
231
|
*/
|
|
232
232
|
descriptionLines?: DescriptionLine[];
|
|
233
233
|
/** Line item image. */
|
|
234
|
-
image?:
|
|
234
|
+
image?: string;
|
|
235
235
|
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
236
236
|
physicalProperties?: PhysicalProperties;
|
|
237
237
|
/** Item type. Either a preset type or custom. */
|
|
@@ -308,14 +308,27 @@ export interface OrderLineItem {
|
|
|
308
308
|
locations?: LocationAndQuantity[];
|
|
309
309
|
/** Address used for tax calculation. */
|
|
310
310
|
taxableAddress?: TaxableAddress;
|
|
311
|
+
/**
|
|
312
|
+
* ID of the app managing the inventory.
|
|
313
|
+
* @internal
|
|
314
|
+
* @format GUID
|
|
315
|
+
*/
|
|
316
|
+
inventoryAppId?: string | null;
|
|
311
317
|
/**
|
|
312
318
|
* Custom extended fields for the line item object.
|
|
313
319
|
*
|
|
314
320
|
* [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.
|
|
315
321
|
*/
|
|
316
322
|
extendedFields?: ExtendedFields;
|
|
323
|
+
/**
|
|
324
|
+
* Modifier groups that were added to the item.
|
|
325
|
+
* @internal
|
|
326
|
+
* @readonly
|
|
327
|
+
* @maxSize 10
|
|
328
|
+
*/
|
|
329
|
+
modifierGroups?: ModifierGroup[];
|
|
317
330
|
}
|
|
318
|
-
|
|
331
|
+
interface ProductName {
|
|
319
332
|
/**
|
|
320
333
|
* __Required.__ Item 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).
|
|
321
334
|
*
|
|
@@ -337,7 +350,7 @@ export interface ProductName {
|
|
|
337
350
|
translated?: string | null;
|
|
338
351
|
}
|
|
339
352
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
340
|
-
|
|
353
|
+
interface CatalogReference {
|
|
341
354
|
/**
|
|
342
355
|
* ID of the item within the catalog it belongs to.
|
|
343
356
|
* @minLength 1
|
|
@@ -363,25 +376,30 @@ export interface CatalogReference {
|
|
|
363
376
|
*/
|
|
364
377
|
options?: Record<string, any> | null;
|
|
365
378
|
}
|
|
366
|
-
|
|
379
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
367
380
|
/** Description line plain text value. */
|
|
368
381
|
plainText?: PlainTextValue;
|
|
369
382
|
/** Description line color value. */
|
|
370
383
|
colorInfo?: Color;
|
|
371
384
|
/** Description line name. */
|
|
372
385
|
name?: DescriptionLineName;
|
|
386
|
+
/**
|
|
387
|
+
* Whether the description line originates from a modifier.
|
|
388
|
+
* @internal
|
|
389
|
+
*/
|
|
390
|
+
modifierDescriptionLine?: boolean;
|
|
373
391
|
}
|
|
374
392
|
/** @oneof */
|
|
375
|
-
|
|
393
|
+
interface DescriptionLineValueOneOf {
|
|
376
394
|
/** Description line plain text value. */
|
|
377
395
|
plainText?: PlainTextValue;
|
|
378
396
|
/** Description line color value. */
|
|
379
397
|
colorInfo?: Color;
|
|
380
398
|
}
|
|
381
399
|
/** @oneof */
|
|
382
|
-
|
|
400
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
383
401
|
}
|
|
384
|
-
|
|
402
|
+
interface DescriptionLineName {
|
|
385
403
|
/**
|
|
386
404
|
* 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).
|
|
387
405
|
* @maxLength 100
|
|
@@ -395,7 +413,7 @@ export interface DescriptionLineName {
|
|
|
395
413
|
*/
|
|
396
414
|
translated?: string | null;
|
|
397
415
|
}
|
|
398
|
-
|
|
416
|
+
interface PlainTextValue {
|
|
399
417
|
/**
|
|
400
418
|
* 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).
|
|
401
419
|
* @maxLength 600
|
|
@@ -409,7 +427,7 @@ export interface PlainTextValue {
|
|
|
409
427
|
*/
|
|
410
428
|
translated?: string | null;
|
|
411
429
|
}
|
|
412
|
-
|
|
430
|
+
interface Color {
|
|
413
431
|
/**
|
|
414
432
|
* 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).
|
|
415
433
|
* @maxLength 500
|
|
@@ -425,7 +443,7 @@ export interface Color {
|
|
|
425
443
|
/** HEX or RGB color code for display. */
|
|
426
444
|
code?: string | null;
|
|
427
445
|
}
|
|
428
|
-
|
|
446
|
+
declare enum DescriptionLineType {
|
|
429
447
|
/** Unrecognized type. */
|
|
430
448
|
UNRECOGNISED = "UNRECOGNISED",
|
|
431
449
|
/** Plain text type. */
|
|
@@ -433,32 +451,7 @@ export declare enum DescriptionLineType {
|
|
|
433
451
|
/** Color type. */
|
|
434
452
|
COLOR = "COLOR"
|
|
435
453
|
}
|
|
436
|
-
|
|
437
|
-
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
438
|
-
export interface Image {
|
|
439
|
-
/** WixMedia image ID. */
|
|
440
|
-
id?: string;
|
|
441
|
-
/** Image URL. */
|
|
442
|
-
url?: string;
|
|
443
|
-
/**
|
|
444
|
-
* Original image height.
|
|
445
|
-
* @readonly
|
|
446
|
-
*/
|
|
447
|
-
height?: number;
|
|
448
|
-
/**
|
|
449
|
-
* Original image width.
|
|
450
|
-
* @readonly
|
|
451
|
-
*/
|
|
452
|
-
width?: number;
|
|
453
|
-
/** Image alt text. */
|
|
454
|
-
altText?: string | null;
|
|
455
|
-
/**
|
|
456
|
-
* Image filename.
|
|
457
|
-
* @readonly
|
|
458
|
-
*/
|
|
459
|
-
filename?: string | null;
|
|
460
|
-
}
|
|
461
|
-
export interface FocalPoint {
|
|
454
|
+
interface FocalPoint {
|
|
462
455
|
/** X-coordinate of the focal point. */
|
|
463
456
|
x?: number;
|
|
464
457
|
/** Y-coordinate of the focal point. */
|
|
@@ -468,7 +461,7 @@ export interface FocalPoint {
|
|
|
468
461
|
/** crop by width */
|
|
469
462
|
width?: number | null;
|
|
470
463
|
}
|
|
471
|
-
|
|
464
|
+
interface PhysicalProperties {
|
|
472
465
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
473
466
|
weight?: number | null;
|
|
474
467
|
/**
|
|
@@ -479,20 +472,20 @@ export interface PhysicalProperties {
|
|
|
479
472
|
/** Whether this line item is shippable. */
|
|
480
473
|
shippable?: boolean;
|
|
481
474
|
}
|
|
482
|
-
|
|
475
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
483
476
|
/** Preset item type. */
|
|
484
477
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
485
478
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
486
479
|
custom?: string;
|
|
487
480
|
}
|
|
488
481
|
/** @oneof */
|
|
489
|
-
|
|
482
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
490
483
|
/** Preset item type. */
|
|
491
484
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
492
485
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
493
486
|
custom?: string;
|
|
494
487
|
}
|
|
495
|
-
|
|
488
|
+
declare enum ItemTypeItemType {
|
|
496
489
|
UNRECOGNISED = "UNRECOGNISED",
|
|
497
490
|
PHYSICAL = "PHYSICAL",
|
|
498
491
|
DIGITAL = "DIGITAL",
|
|
@@ -500,9 +493,9 @@ export declare enum ItemTypeItemType {
|
|
|
500
493
|
SERVICE = "SERVICE"
|
|
501
494
|
}
|
|
502
495
|
/** @enumType */
|
|
503
|
-
|
|
496
|
+
type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
504
497
|
/** Type of selected payment option for catalog item */
|
|
505
|
-
|
|
498
|
+
declare enum PaymentOptionType {
|
|
506
499
|
/** The entire payment for this item happens as part of the checkout. */
|
|
507
500
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
508
501
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -515,8 +508,8 @@ export declare enum PaymentOptionType {
|
|
|
515
508
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
516
509
|
}
|
|
517
510
|
/** @enumType */
|
|
518
|
-
|
|
519
|
-
|
|
511
|
+
type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
512
|
+
interface ItemTaxFullDetails {
|
|
520
513
|
/** Taxable amount of this line item. */
|
|
521
514
|
taxableAmount?: Price;
|
|
522
515
|
/**
|
|
@@ -527,7 +520,7 @@ export interface ItemTaxFullDetails {
|
|
|
527
520
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
528
521
|
totalTax?: Price;
|
|
529
522
|
}
|
|
530
|
-
|
|
523
|
+
interface LineItemTaxInfo {
|
|
531
524
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
532
525
|
taxAmount?: Price;
|
|
533
526
|
/** Amount for which tax is calculated. */
|
|
@@ -555,7 +548,7 @@ export interface LineItemTaxInfo {
|
|
|
555
548
|
* TaxBreakdown represents tax information for a line item.
|
|
556
549
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
557
550
|
*/
|
|
558
|
-
|
|
551
|
+
interface LineItemTaxBreakdown {
|
|
559
552
|
/**
|
|
560
553
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
561
554
|
* @maxLength 200
|
|
@@ -588,7 +581,7 @@ export interface LineItemTaxBreakdown {
|
|
|
588
581
|
taxableAmount?: Price;
|
|
589
582
|
}
|
|
590
583
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
591
|
-
|
|
584
|
+
declare enum JurisdictionType {
|
|
592
585
|
UNDEFINED = "UNDEFINED",
|
|
593
586
|
COUNTRY = "COUNTRY",
|
|
594
587
|
STATE = "STATE",
|
|
@@ -597,8 +590,8 @@ export declare enum JurisdictionType {
|
|
|
597
590
|
SPECIAL = "SPECIAL"
|
|
598
591
|
}
|
|
599
592
|
/** @enumType */
|
|
600
|
-
|
|
601
|
-
|
|
593
|
+
type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
594
|
+
interface DigitalFile {
|
|
602
595
|
/**
|
|
603
596
|
* ID of the secure file in media.
|
|
604
597
|
* @minLength 1
|
|
@@ -618,12 +611,12 @@ export interface DigitalFile {
|
|
|
618
611
|
*/
|
|
619
612
|
expirationDate?: Date | null;
|
|
620
613
|
}
|
|
621
|
-
|
|
614
|
+
interface SubscriptionInfo {
|
|
622
615
|
/**
|
|
623
616
|
* Subscription ID.
|
|
624
617
|
* @format GUID
|
|
625
618
|
*/
|
|
626
|
-
|
|
619
|
+
_id?: string | null;
|
|
627
620
|
/**
|
|
628
621
|
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
629
622
|
* @min 1
|
|
@@ -637,6 +630,11 @@ export interface SubscriptionInfo {
|
|
|
637
630
|
* @targetRemovalDate 2025-10-01
|
|
638
631
|
*/
|
|
639
632
|
subscriptionOptionTitle?: string;
|
|
633
|
+
/**
|
|
634
|
+
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
635
|
+
* @internal
|
|
636
|
+
*/
|
|
637
|
+
title?: SubscriptionTitle;
|
|
640
638
|
/**
|
|
641
639
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
642
640
|
* @maxLength 60
|
|
@@ -645,6 +643,11 @@ export interface SubscriptionInfo {
|
|
|
645
643
|
* @targetRemovalDate 2025-10-01
|
|
646
644
|
*/
|
|
647
645
|
subscriptionOptionDescription?: string | null;
|
|
646
|
+
/**
|
|
647
|
+
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
648
|
+
* @internal
|
|
649
|
+
*/
|
|
650
|
+
description?: SubscriptionDescription;
|
|
648
651
|
/**
|
|
649
652
|
* Subscription detailed information.
|
|
650
653
|
* @immutable
|
|
@@ -655,8 +658,13 @@ export interface SubscriptionInfo {
|
|
|
655
658
|
* @maxLength 1000
|
|
656
659
|
*/
|
|
657
660
|
chargesDescription?: string | null;
|
|
661
|
+
/**
|
|
662
|
+
* Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
|
|
663
|
+
* @internal
|
|
664
|
+
*/
|
|
665
|
+
billingAdjustment?: BillingAdjustment;
|
|
658
666
|
}
|
|
659
|
-
|
|
667
|
+
interface SubscriptionTitle {
|
|
660
668
|
/**
|
|
661
669
|
* Subscription option 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).
|
|
662
670
|
* @minLength 1
|
|
@@ -672,7 +680,7 @@ export interface SubscriptionTitle {
|
|
|
672
680
|
*/
|
|
673
681
|
translated?: string | null;
|
|
674
682
|
}
|
|
675
|
-
|
|
683
|
+
interface SubscriptionDescription {
|
|
676
684
|
/**
|
|
677
685
|
* Subscription option description.
|
|
678
686
|
* @maxLength 500
|
|
@@ -684,7 +692,7 @@ export interface SubscriptionDescription {
|
|
|
684
692
|
*/
|
|
685
693
|
translated?: string | null;
|
|
686
694
|
}
|
|
687
|
-
|
|
695
|
+
interface SubscriptionSettings {
|
|
688
696
|
/** Frequency of recurring payment. */
|
|
689
697
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
690
698
|
/**
|
|
@@ -704,9 +712,14 @@ export interface SubscriptionSettings {
|
|
|
704
712
|
enableCustomerCancellation?: boolean;
|
|
705
713
|
/** Period until first cycle starts. If None => no free trial */
|
|
706
714
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
715
|
+
/**
|
|
716
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
717
|
+
* @internal
|
|
718
|
+
*/
|
|
719
|
+
startDate?: Date | null;
|
|
707
720
|
}
|
|
708
721
|
/** Frequency unit of recurring payment */
|
|
709
|
-
|
|
722
|
+
declare enum SubscriptionFrequency {
|
|
710
723
|
UNDEFINED = "UNDEFINED",
|
|
711
724
|
DAY = "DAY",
|
|
712
725
|
WEEK = "WEEK",
|
|
@@ -714,8 +727,8 @@ export declare enum SubscriptionFrequency {
|
|
|
714
727
|
YEAR = "YEAR"
|
|
715
728
|
}
|
|
716
729
|
/** @enumType */
|
|
717
|
-
|
|
718
|
-
|
|
730
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
731
|
+
interface FreeTrialPeriod {
|
|
719
732
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
720
733
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
721
734
|
/**
|
|
@@ -725,13 +738,13 @@ export interface FreeTrialPeriod {
|
|
|
725
738
|
*/
|
|
726
739
|
interval?: number;
|
|
727
740
|
}
|
|
728
|
-
|
|
741
|
+
interface BillingAdjustment {
|
|
729
742
|
/** The type of adjustment. */
|
|
730
743
|
type?: AdjustmentTypeWithLiterals;
|
|
731
744
|
/** Summary of the prorated adjustment amount. */
|
|
732
745
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
733
746
|
}
|
|
734
|
-
|
|
747
|
+
declare enum AdjustmentType {
|
|
735
748
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
736
749
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
737
750
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
@@ -739,8 +752,8 @@ export declare enum AdjustmentType {
|
|
|
739
752
|
CREDIT = "CREDIT"
|
|
740
753
|
}
|
|
741
754
|
/** @enumType */
|
|
742
|
-
|
|
743
|
-
|
|
755
|
+
type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
756
|
+
interface BillingAdjustmentPriceSummary {
|
|
744
757
|
/** Subtotal of adjustment, before tax. */
|
|
745
758
|
subtotal?: Price;
|
|
746
759
|
/** Tax on adjustment. */
|
|
@@ -748,12 +761,12 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
748
761
|
/** Total price after tax. */
|
|
749
762
|
total?: Price;
|
|
750
763
|
}
|
|
751
|
-
|
|
764
|
+
interface LocationAndQuantity {
|
|
752
765
|
/**
|
|
753
766
|
* Location id in the associated owner app.
|
|
754
767
|
* @format GUID
|
|
755
768
|
*/
|
|
756
|
-
|
|
769
|
+
_id?: string;
|
|
757
770
|
/**
|
|
758
771
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
759
772
|
* @format GUID
|
|
@@ -774,24 +787,24 @@ export interface LocationAndQuantity {
|
|
|
774
787
|
*/
|
|
775
788
|
name?: string | null;
|
|
776
789
|
}
|
|
777
|
-
|
|
790
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
778
791
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
779
792
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
780
793
|
}
|
|
781
794
|
/** @oneof */
|
|
782
|
-
|
|
795
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
783
796
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
784
797
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
785
798
|
}
|
|
786
|
-
|
|
799
|
+
declare enum TaxableAddressType {
|
|
787
800
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
788
801
|
BUSINESS = "BUSINESS",
|
|
789
802
|
BILLING = "BILLING",
|
|
790
803
|
SHIPPING = "SHIPPING"
|
|
791
804
|
}
|
|
792
805
|
/** @enumType */
|
|
793
|
-
|
|
794
|
-
|
|
806
|
+
type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
807
|
+
interface ExtendedFields {
|
|
795
808
|
/**
|
|
796
809
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
797
810
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -802,13 +815,13 @@ export interface ExtendedFields {
|
|
|
802
815
|
*/
|
|
803
816
|
namespaces?: Record<string, Record<string, any>>;
|
|
804
817
|
}
|
|
805
|
-
|
|
818
|
+
interface ModifierGroup {
|
|
806
819
|
/**
|
|
807
820
|
* Modifier group id.
|
|
808
821
|
* @minLength 1
|
|
809
822
|
* @maxLength 36
|
|
810
823
|
*/
|
|
811
|
-
|
|
824
|
+
_id?: string;
|
|
812
825
|
/** Modifier group name. */
|
|
813
826
|
name?: TranslatableString;
|
|
814
827
|
/**
|
|
@@ -818,7 +831,7 @@ export interface ModifierGroup {
|
|
|
818
831
|
*/
|
|
819
832
|
modifiers?: ItemModifier[];
|
|
820
833
|
}
|
|
821
|
-
|
|
834
|
+
interface TranslatableString {
|
|
822
835
|
/**
|
|
823
836
|
* __Required.__ String 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).
|
|
824
837
|
*
|
|
@@ -839,13 +852,13 @@ export interface TranslatableString {
|
|
|
839
852
|
*/
|
|
840
853
|
translated?: string | null;
|
|
841
854
|
}
|
|
842
|
-
|
|
855
|
+
interface ItemModifier {
|
|
843
856
|
/**
|
|
844
857
|
* Modifier ID.
|
|
845
858
|
* @minLength 1
|
|
846
859
|
* @maxLength 36
|
|
847
860
|
*/
|
|
848
|
-
|
|
861
|
+
_id?: string;
|
|
849
862
|
/**
|
|
850
863
|
* The quantity of this modifier.
|
|
851
864
|
* @min 1
|
|
@@ -859,7 +872,7 @@ export interface ItemModifier {
|
|
|
859
872
|
/** The price of the modifier. */
|
|
860
873
|
price?: Price;
|
|
861
874
|
}
|
|
862
|
-
|
|
875
|
+
interface ItemChangedDetails {
|
|
863
876
|
/**
|
|
864
877
|
* Line item quantity before change.
|
|
865
878
|
* @min 1
|
|
@@ -871,7 +884,7 @@ export interface ItemChangedDetails {
|
|
|
871
884
|
/** Line item price description before change. */
|
|
872
885
|
priceDescriptionBeforeChange?: PriceDescription;
|
|
873
886
|
}
|
|
874
|
-
|
|
887
|
+
interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
875
888
|
/** Whether shipping info was added as part of the draft. */
|
|
876
889
|
added?: boolean;
|
|
877
890
|
/** Shipping info before the change. */
|
|
@@ -882,7 +895,7 @@ export interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
|
882
895
|
shippingInfo?: V1ShippingInformation;
|
|
883
896
|
}
|
|
884
897
|
/** @oneof */
|
|
885
|
-
|
|
898
|
+
interface ShippingDetailsChangeTypeOneOf {
|
|
886
899
|
/** Whether shipping info was added as part of the draft. */
|
|
887
900
|
added?: boolean;
|
|
888
901
|
/** Shipping info before the change. */
|
|
@@ -890,7 +903,7 @@ export interface ShippingDetailsChangeTypeOneOf {
|
|
|
890
903
|
/** Whether shipping info was removed as part of the draft. */
|
|
891
904
|
removed?: boolean;
|
|
892
905
|
}
|
|
893
|
-
|
|
906
|
+
interface V1ShippingInformation {
|
|
894
907
|
/**
|
|
895
908
|
* App Def Id of external provider which was a source of shipping info
|
|
896
909
|
* @minLength 1
|
|
@@ -916,7 +929,7 @@ export interface V1ShippingInformation {
|
|
|
916
929
|
/** Shipping region. */
|
|
917
930
|
region?: ShippingRegion;
|
|
918
931
|
}
|
|
919
|
-
|
|
932
|
+
interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
920
933
|
/** Shipping address and contact details. */
|
|
921
934
|
shippingDestination?: AddressWithContact;
|
|
922
935
|
/** Pickup details. */
|
|
@@ -940,21 +953,21 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
|
940
953
|
deliveryTimeSlot?: V1DeliveryTimeSlot;
|
|
941
954
|
}
|
|
942
955
|
/** @oneof */
|
|
943
|
-
|
|
956
|
+
interface V1DeliveryLogisticsAddressOneOf {
|
|
944
957
|
/** Shipping address and contact details. */
|
|
945
958
|
shippingDestination?: AddressWithContact;
|
|
946
959
|
/** Pickup details. */
|
|
947
960
|
pickupDetails?: V1PickupDetails;
|
|
948
961
|
}
|
|
949
962
|
/** Billing Info and shipping details */
|
|
950
|
-
|
|
963
|
+
interface AddressWithContact {
|
|
951
964
|
/** Address. */
|
|
952
965
|
address?: Address;
|
|
953
966
|
/** Contact details. */
|
|
954
967
|
contactDetails?: FullAddressContactDetails;
|
|
955
968
|
}
|
|
956
969
|
/** Physical address */
|
|
957
|
-
|
|
970
|
+
interface Address {
|
|
958
971
|
/**
|
|
959
972
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
960
973
|
* @format COUNTRY
|
|
@@ -981,7 +994,7 @@ export interface Address {
|
|
|
981
994
|
* Main address line (usually street name and number).
|
|
982
995
|
* @maxLength 150
|
|
983
996
|
*/
|
|
984
|
-
|
|
997
|
+
addressLine1?: string | null;
|
|
985
998
|
/**
|
|
986
999
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
987
1000
|
* @maxLength 100
|
|
@@ -998,20 +1011,20 @@ export interface Address {
|
|
|
998
1011
|
*/
|
|
999
1012
|
subdivisionFullname?: string | null;
|
|
1000
1013
|
}
|
|
1001
|
-
|
|
1014
|
+
interface StreetAddress {
|
|
1002
1015
|
/** Street number. */
|
|
1003
1016
|
number?: string;
|
|
1004
1017
|
/** Street name. */
|
|
1005
1018
|
name?: string;
|
|
1006
1019
|
}
|
|
1007
|
-
|
|
1020
|
+
interface AddressLocation {
|
|
1008
1021
|
/** Address latitude. */
|
|
1009
1022
|
latitude?: number | null;
|
|
1010
1023
|
/** Address longitude. */
|
|
1011
1024
|
longitude?: number | null;
|
|
1012
1025
|
}
|
|
1013
1026
|
/** Full contact details for an address */
|
|
1014
|
-
|
|
1027
|
+
interface FullAddressContactDetails {
|
|
1015
1028
|
/**
|
|
1016
1029
|
* First name.
|
|
1017
1030
|
* @maxLength 100
|
|
@@ -1035,9 +1048,9 @@ export interface FullAddressContactDetails {
|
|
|
1035
1048
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1036
1049
|
vatId?: VatId;
|
|
1037
1050
|
}
|
|
1038
|
-
|
|
1051
|
+
interface VatId {
|
|
1039
1052
|
/** Customer's tax ID. */
|
|
1040
|
-
|
|
1053
|
+
_id?: string;
|
|
1041
1054
|
/**
|
|
1042
1055
|
* Tax type.
|
|
1043
1056
|
*
|
|
@@ -1048,7 +1061,7 @@ export interface VatId {
|
|
|
1048
1061
|
type?: VatTypeWithLiterals;
|
|
1049
1062
|
}
|
|
1050
1063
|
/** tax info types */
|
|
1051
|
-
|
|
1064
|
+
declare enum VatType {
|
|
1052
1065
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1053
1066
|
/** CPF - for individual tax payers. */
|
|
1054
1067
|
CPF = "CPF",
|
|
@@ -1056,15 +1069,15 @@ export declare enum VatType {
|
|
|
1056
1069
|
CNPJ = "CNPJ"
|
|
1057
1070
|
}
|
|
1058
1071
|
/** @enumType */
|
|
1059
|
-
|
|
1060
|
-
|
|
1072
|
+
type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1073
|
+
interface V1PickupDetails {
|
|
1061
1074
|
/** Pickup address. */
|
|
1062
1075
|
address?: PickupAddress;
|
|
1063
1076
|
/** Pickup method */
|
|
1064
1077
|
pickupMethod?: PickupDetailsPickupMethodWithLiterals;
|
|
1065
1078
|
}
|
|
1066
1079
|
/** Physical address */
|
|
1067
|
-
|
|
1080
|
+
interface PickupAddress {
|
|
1068
1081
|
/**
|
|
1069
1082
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1070
1083
|
* @format COUNTRY
|
|
@@ -1091,7 +1104,7 @@ export interface PickupAddress {
|
|
|
1091
1104
|
* Main address line (usually street name and number).
|
|
1092
1105
|
* @maxLength 1000
|
|
1093
1106
|
*/
|
|
1094
|
-
|
|
1107
|
+
addressLine1?: string | null;
|
|
1095
1108
|
/**
|
|
1096
1109
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
1097
1110
|
* @maxLength 1000
|
|
@@ -1108,20 +1121,20 @@ export interface PickupAddress {
|
|
|
1108
1121
|
*/
|
|
1109
1122
|
subdivisionFullname?: string | null;
|
|
1110
1123
|
}
|
|
1111
|
-
|
|
1124
|
+
declare enum PickupDetailsPickupMethod {
|
|
1112
1125
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1113
1126
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1114
1127
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1115
1128
|
}
|
|
1116
1129
|
/** @enumType */
|
|
1117
|
-
|
|
1118
|
-
|
|
1130
|
+
type PickupDetailsPickupMethodWithLiterals = PickupDetailsPickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1131
|
+
interface V1DeliveryTimeSlot {
|
|
1119
1132
|
/** Delivery slot starting time. */
|
|
1120
1133
|
from?: Date | null;
|
|
1121
1134
|
/** Delivery slot ending time. */
|
|
1122
1135
|
to?: Date | null;
|
|
1123
1136
|
}
|
|
1124
|
-
|
|
1137
|
+
interface V1ShippingPrice {
|
|
1125
1138
|
/** Shipping price for display purposes. */
|
|
1126
1139
|
price?: Price;
|
|
1127
1140
|
/**
|
|
@@ -1142,19 +1155,19 @@ export interface V1ShippingPrice {
|
|
|
1142
1155
|
*/
|
|
1143
1156
|
discount?: Price;
|
|
1144
1157
|
}
|
|
1145
|
-
|
|
1158
|
+
interface ShippingRegion {
|
|
1146
1159
|
/**
|
|
1147
1160
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1148
1161
|
* @maxLength 100
|
|
1149
1162
|
*/
|
|
1150
1163
|
name?: string | null;
|
|
1151
1164
|
}
|
|
1152
|
-
|
|
1165
|
+
interface ShippingChangedDetails {
|
|
1153
1166
|
/** Shipping info before the change. */
|
|
1154
1167
|
shippingInfoBeforeChange?: V1ShippingInformation;
|
|
1155
1168
|
}
|
|
1156
1169
|
/** Buyer Info */
|
|
1157
|
-
|
|
1170
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1158
1171
|
/**
|
|
1159
1172
|
* Visitor ID (if site visitor is not a member).
|
|
1160
1173
|
* @format GUID
|
|
@@ -1177,7 +1190,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1177
1190
|
email?: string | null;
|
|
1178
1191
|
}
|
|
1179
1192
|
/** @oneof */
|
|
1180
|
-
|
|
1193
|
+
interface BuyerInfoIdOneOf {
|
|
1181
1194
|
/**
|
|
1182
1195
|
* Visitor ID (if site visitor is not a member).
|
|
1183
1196
|
* @format GUID
|
|
@@ -1189,7 +1202,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
1189
1202
|
*/
|
|
1190
1203
|
memberId?: string;
|
|
1191
1204
|
}
|
|
1192
|
-
|
|
1205
|
+
interface AdditionalFeeDetails {
|
|
1193
1206
|
/** Additional fee. */
|
|
1194
1207
|
additionalFee?: AdditionalFee;
|
|
1195
1208
|
/** Tax details related to the additional fee. */
|
|
@@ -1206,7 +1219,7 @@ export interface AdditionalFeeDetails {
|
|
|
1206
1219
|
/** Whether this additional fee is applied to the order. */
|
|
1207
1220
|
applied?: boolean;
|
|
1208
1221
|
}
|
|
1209
|
-
|
|
1222
|
+
interface AdditionalFee {
|
|
1210
1223
|
/**
|
|
1211
1224
|
* Additional fee's unique code for future processing.
|
|
1212
1225
|
* @minLength 1
|
|
@@ -1237,15 +1250,23 @@ export interface AdditionalFee {
|
|
|
1237
1250
|
* @format GUID
|
|
1238
1251
|
* @immutable
|
|
1239
1252
|
*/
|
|
1240
|
-
|
|
1253
|
+
_id?: string;
|
|
1241
1254
|
/**
|
|
1242
1255
|
* Optional - Line items associated with this additional fee.
|
|
1243
1256
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
1244
1257
|
* @format GUID
|
|
1245
1258
|
*/
|
|
1246
1259
|
lineItemIds?: string[];
|
|
1260
|
+
/**
|
|
1261
|
+
* Number of subscription billing cycles the additional fee applies to.
|
|
1262
|
+
* If None and additional fee is linked to subscription line item, it applies to all cycles.
|
|
1263
|
+
* @internal
|
|
1264
|
+
* @min 1
|
|
1265
|
+
* @max 999
|
|
1266
|
+
*/
|
|
1267
|
+
subscriptionCycles?: number | null;
|
|
1247
1268
|
}
|
|
1248
|
-
|
|
1269
|
+
interface TaxDetails {
|
|
1249
1270
|
/** Whether the additional fee is taxable. */
|
|
1250
1271
|
taxable?: boolean;
|
|
1251
1272
|
/**
|
|
@@ -1254,7 +1275,7 @@ export interface TaxDetails {
|
|
|
1254
1275
|
*/
|
|
1255
1276
|
taxGroupId?: string | null;
|
|
1256
1277
|
}
|
|
1257
|
-
|
|
1278
|
+
declare enum SourceType {
|
|
1258
1279
|
/** Part of the original order. */
|
|
1259
1280
|
ORIGINAL_ORDER = "ORIGINAL_ORDER",
|
|
1260
1281
|
/** Added automatically, as the result of recalculation caused by changes in draft order. */
|
|
@@ -1263,8 +1284,8 @@ export declare enum SourceType {
|
|
|
1263
1284
|
CUSTOM = "CUSTOM"
|
|
1264
1285
|
}
|
|
1265
1286
|
/** @enumType */
|
|
1266
|
-
|
|
1267
|
-
|
|
1287
|
+
type SourceTypeWithLiterals = SourceType | 'ORIGINAL_ORDER' | 'AUTOMATIC' | 'CUSTOM';
|
|
1288
|
+
interface DiscountDetails {
|
|
1268
1289
|
/** Discount details. */
|
|
1269
1290
|
discount?: AppliedDiscount;
|
|
1270
1291
|
/**
|
|
@@ -1278,7 +1299,7 @@ export interface DiscountDetails {
|
|
|
1278
1299
|
/** Whether this discount is applied to the order. */
|
|
1279
1300
|
applied?: boolean;
|
|
1280
1301
|
}
|
|
1281
|
-
|
|
1302
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1282
1303
|
/** Applied coupon info. */
|
|
1283
1304
|
coupon?: Coupon;
|
|
1284
1305
|
/** Merchant discount. */
|
|
@@ -1308,10 +1329,18 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1308
1329
|
* @format GUID
|
|
1309
1330
|
* @immutable
|
|
1310
1331
|
*/
|
|
1311
|
-
|
|
1332
|
+
_id?: string | null;
|
|
1333
|
+
/**
|
|
1334
|
+
* Number of subscription billing cycles the discount applies to.
|
|
1335
|
+
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
1336
|
+
* @internal
|
|
1337
|
+
* @min 1
|
|
1338
|
+
* @max 999
|
|
1339
|
+
*/
|
|
1340
|
+
subscriptionCycles?: number | null;
|
|
1312
1341
|
}
|
|
1313
1342
|
/** @oneof */
|
|
1314
|
-
|
|
1343
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1315
1344
|
/** Applied coupon info. */
|
|
1316
1345
|
coupon?: Coupon;
|
|
1317
1346
|
/** Merchant discount. */
|
|
@@ -1319,17 +1348,17 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1319
1348
|
/** Automatic Discount */
|
|
1320
1349
|
discountRule?: DiscountRule;
|
|
1321
1350
|
}
|
|
1322
|
-
|
|
1351
|
+
declare enum AppliedDiscountDiscountType {
|
|
1323
1352
|
GLOBAL = "GLOBAL",
|
|
1324
1353
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1325
1354
|
SHIPPING = "SHIPPING"
|
|
1326
1355
|
}
|
|
1327
1356
|
/** @enumType */
|
|
1328
|
-
|
|
1357
|
+
type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1329
1358
|
/** Coupon */
|
|
1330
|
-
|
|
1359
|
+
interface Coupon {
|
|
1331
1360
|
/** Coupon ID. */
|
|
1332
|
-
|
|
1361
|
+
_id?: string;
|
|
1333
1362
|
/** Coupon code. */
|
|
1334
1363
|
code?: string;
|
|
1335
1364
|
/** Coupon name. */
|
|
@@ -1337,7 +1366,7 @@ export interface Coupon {
|
|
|
1337
1366
|
/** Coupon value. */
|
|
1338
1367
|
amount?: Price;
|
|
1339
1368
|
}
|
|
1340
|
-
|
|
1369
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1341
1370
|
/**
|
|
1342
1371
|
* Pre-defined discount reason (optional).
|
|
1343
1372
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1350,9 +1379,16 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1350
1379
|
description?: string | null;
|
|
1351
1380
|
/** Discount amount. */
|
|
1352
1381
|
amount?: Price;
|
|
1382
|
+
/**
|
|
1383
|
+
* Discount percentage.
|
|
1384
|
+
* @internal
|
|
1385
|
+
* @format DECIMAL_VALUE
|
|
1386
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1387
|
+
*/
|
|
1388
|
+
percentage?: string | null;
|
|
1353
1389
|
}
|
|
1354
1390
|
/** @oneof */
|
|
1355
|
-
|
|
1391
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1356
1392
|
/**
|
|
1357
1393
|
* Pre-defined discount reason (optional).
|
|
1358
1394
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1364,25 +1400,25 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1364
1400
|
*/
|
|
1365
1401
|
description?: string | null;
|
|
1366
1402
|
}
|
|
1367
|
-
|
|
1403
|
+
declare enum DiscountReason {
|
|
1368
1404
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1369
1405
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1370
1406
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1371
1407
|
}
|
|
1372
1408
|
/** @enumType */
|
|
1373
|
-
|
|
1374
|
-
|
|
1409
|
+
type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1410
|
+
interface DiscountRule {
|
|
1375
1411
|
/**
|
|
1376
1412
|
* Discount rule ID
|
|
1377
1413
|
* @format GUID
|
|
1378
1414
|
*/
|
|
1379
|
-
|
|
1415
|
+
_id?: string;
|
|
1380
1416
|
/** Discount rule name */
|
|
1381
1417
|
name?: DiscountRuleName;
|
|
1382
1418
|
/** Discount value. */
|
|
1383
1419
|
amount?: Price;
|
|
1384
1420
|
}
|
|
1385
|
-
|
|
1421
|
+
interface DiscountRuleName {
|
|
1386
1422
|
/**
|
|
1387
1423
|
* Original discount rule name (in site's default language).
|
|
1388
1424
|
* @minLength 1
|
|
@@ -1396,16 +1432,16 @@ export interface DiscountRuleName {
|
|
|
1396
1432
|
*/
|
|
1397
1433
|
translated?: string | null;
|
|
1398
1434
|
}
|
|
1399
|
-
|
|
1435
|
+
interface LineItemDiscount {
|
|
1400
1436
|
/**
|
|
1401
1437
|
* ID of line item the discount applies to.
|
|
1402
1438
|
* @format GUID
|
|
1403
1439
|
*/
|
|
1404
|
-
|
|
1440
|
+
_id?: string;
|
|
1405
1441
|
/** Total discount for this line item. */
|
|
1406
1442
|
totalDiscount?: Price;
|
|
1407
1443
|
}
|
|
1408
|
-
|
|
1444
|
+
interface CreatedBy extends CreatedByStringOneOf {
|
|
1409
1445
|
/**
|
|
1410
1446
|
* User ID. When the draft order was created by a Wix user.
|
|
1411
1447
|
* @format GUID
|
|
@@ -1418,7 +1454,7 @@ export interface CreatedBy extends CreatedByStringOneOf {
|
|
|
1418
1454
|
appId?: string;
|
|
1419
1455
|
}
|
|
1420
1456
|
/** @oneof */
|
|
1421
|
-
|
|
1457
|
+
interface CreatedByStringOneOf {
|
|
1422
1458
|
/**
|
|
1423
1459
|
* User ID. When the draft order was created by a Wix user.
|
|
1424
1460
|
* @format GUID
|
|
@@ -1430,7 +1466,7 @@ export interface CreatedByStringOneOf {
|
|
|
1430
1466
|
*/
|
|
1431
1467
|
appId?: string;
|
|
1432
1468
|
}
|
|
1433
|
-
|
|
1469
|
+
declare enum EditingStatus {
|
|
1434
1470
|
/** Draft order is being edited. */
|
|
1435
1471
|
DRAFT = "DRAFT",
|
|
1436
1472
|
/**
|
|
@@ -1441,8 +1477,8 @@ export declare enum EditingStatus {
|
|
|
1441
1477
|
COMMITTED = "COMMITTED"
|
|
1442
1478
|
}
|
|
1443
1479
|
/** @enumType */
|
|
1444
|
-
|
|
1445
|
-
|
|
1480
|
+
type EditingStatusWithLiterals = EditingStatus | 'DRAFT' | 'COMMITTED';
|
|
1481
|
+
declare enum WeightUnit {
|
|
1446
1482
|
/** Weight unit can't be classified due to an error. */
|
|
1447
1483
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1448
1484
|
/** Kilograms. */
|
|
@@ -1451,8 +1487,8 @@ export declare enum WeightUnit {
|
|
|
1451
1487
|
LB = "LB"
|
|
1452
1488
|
}
|
|
1453
1489
|
/** @enumType */
|
|
1454
|
-
|
|
1455
|
-
|
|
1490
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1491
|
+
interface PriceSummary {
|
|
1456
1492
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
1457
1493
|
subtotal?: Price;
|
|
1458
1494
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1466,14 +1502,14 @@ export interface PriceSummary {
|
|
|
1466
1502
|
/** Total price of additional fees before tax. */
|
|
1467
1503
|
totalAdditionalFees?: Price;
|
|
1468
1504
|
}
|
|
1469
|
-
|
|
1505
|
+
interface TaxSummary {
|
|
1470
1506
|
/**
|
|
1471
1507
|
* Total tax.
|
|
1472
1508
|
* @readonly
|
|
1473
1509
|
*/
|
|
1474
1510
|
totalTax?: Price;
|
|
1475
1511
|
}
|
|
1476
|
-
|
|
1512
|
+
interface BalanceSummary {
|
|
1477
1513
|
/**
|
|
1478
1514
|
* Amount left to pay for the order to be considered paid.
|
|
1479
1515
|
* @readonly
|
|
@@ -1504,7 +1540,7 @@ export interface BalanceSummary {
|
|
|
1504
1540
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
1505
1541
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
1506
1542
|
*/
|
|
1507
|
-
|
|
1543
|
+
interface Balance {
|
|
1508
1544
|
/**
|
|
1509
1545
|
* Balance amount.
|
|
1510
1546
|
*
|
|
@@ -1520,7 +1556,7 @@ export interface Balance {
|
|
|
1520
1556
|
formattedAmount?: string;
|
|
1521
1557
|
}
|
|
1522
1558
|
/** Side-effects upon committing a draft order. */
|
|
1523
|
-
|
|
1559
|
+
interface DraftOrderCommitSettings {
|
|
1524
1560
|
/**
|
|
1525
1561
|
* Whether to send notifications to the buyer.
|
|
1526
1562
|
*
|
|
@@ -1552,14 +1588,14 @@ export interface DraftOrderCommitSettings {
|
|
|
1552
1588
|
*/
|
|
1553
1589
|
updateInventory?: InventoryUpdate[];
|
|
1554
1590
|
}
|
|
1555
|
-
|
|
1591
|
+
interface InventoryUpdate {
|
|
1556
1592
|
/**
|
|
1557
1593
|
* Line item ID.
|
|
1558
1594
|
* @format GUID
|
|
1559
1595
|
*/
|
|
1560
1596
|
lineItemId?: string;
|
|
1561
1597
|
}
|
|
1562
|
-
|
|
1598
|
+
interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
1563
1599
|
/** Indicates that recipient information was added during draft. */
|
|
1564
1600
|
added?: boolean;
|
|
1565
1601
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1570,7 +1606,7 @@ export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneO
|
|
|
1570
1606
|
recipientInfo?: AddressWithContact;
|
|
1571
1607
|
}
|
|
1572
1608
|
/** @oneof */
|
|
1573
|
-
|
|
1609
|
+
interface RecipientInfoDetailsChangeTypeOneOf {
|
|
1574
1610
|
/** Indicates that recipient information was added during draft. */
|
|
1575
1611
|
added?: boolean;
|
|
1576
1612
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1578,11 +1614,11 @@ export interface RecipientInfoDetailsChangeTypeOneOf {
|
|
|
1578
1614
|
/** Indicates that recipient information was removed during draft. */
|
|
1579
1615
|
removed?: boolean;
|
|
1580
1616
|
}
|
|
1581
|
-
|
|
1617
|
+
interface RecipientInfoChangedDetails {
|
|
1582
1618
|
/** Order recipient address and contact details before draft. */
|
|
1583
1619
|
recipientInfoBeforeChange?: AddressWithContact;
|
|
1584
1620
|
}
|
|
1585
|
-
|
|
1621
|
+
interface OrderTaxInfo {
|
|
1586
1622
|
/** Calculated tax, added from line items. */
|
|
1587
1623
|
totalTax?: Price;
|
|
1588
1624
|
/**
|
|
@@ -1602,7 +1638,7 @@ export interface OrderTaxInfo {
|
|
|
1602
1638
|
* 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.
|
|
1603
1639
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1604
1640
|
*/
|
|
1605
|
-
|
|
1641
|
+
interface OrderTaxBreakdown {
|
|
1606
1642
|
/**
|
|
1607
1643
|
* The name of the tax against which this tax amount was calculated.
|
|
1608
1644
|
* @maxLength 200
|
|
@@ -1629,7 +1665,7 @@ export interface OrderTaxBreakdown {
|
|
|
1629
1665
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1630
1666
|
aggregatedTaxAmount?: Price;
|
|
1631
1667
|
}
|
|
1632
|
-
|
|
1668
|
+
interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
1633
1669
|
/** Indicates that buyer information was added during draft. */
|
|
1634
1670
|
added?: boolean;
|
|
1635
1671
|
/** Indicates that buyer information was changed. Contains billing information before draft. */
|
|
@@ -1640,7 +1676,7 @@ export interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
|
1640
1676
|
buyerInfo?: BuyerInfo;
|
|
1641
1677
|
}
|
|
1642
1678
|
/** @oneof */
|
|
1643
|
-
|
|
1679
|
+
interface BuyerDetailsChangeTypeOneOf {
|
|
1644
1680
|
/** Indicates that buyer information was added during draft. */
|
|
1645
1681
|
added?: boolean;
|
|
1646
1682
|
/** Indicates that buyer information was changed. Contains billing information before draft. */
|
|
@@ -1648,11 +1684,11 @@ export interface BuyerDetailsChangeTypeOneOf {
|
|
|
1648
1684
|
/** Indicates that buyer information was removed during draft. */
|
|
1649
1685
|
removed?: boolean;
|
|
1650
1686
|
}
|
|
1651
|
-
|
|
1687
|
+
interface BuyerChangedDetails {
|
|
1652
1688
|
/** Buyer information before draft. */
|
|
1653
1689
|
buyerInfoBeforeChange?: BuyerInfo;
|
|
1654
1690
|
}
|
|
1655
|
-
|
|
1691
|
+
interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
1656
1692
|
/** Indicates that billing information was added during draft. */
|
|
1657
1693
|
added?: boolean;
|
|
1658
1694
|
/** Indicates that billing information was changed. Contains billing information before draft. */
|
|
@@ -1663,7 +1699,7 @@ export interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
|
1663
1699
|
billingInfo?: AddressWithContact;
|
|
1664
1700
|
}
|
|
1665
1701
|
/** @oneof */
|
|
1666
|
-
|
|
1702
|
+
interface BillingDetailsChangeTypeOneOf {
|
|
1667
1703
|
/** Indicates that billing information was added during draft. */
|
|
1668
1704
|
added?: boolean;
|
|
1669
1705
|
/** Indicates that billing information was changed. Contains billing information before draft. */
|
|
@@ -1671,11 +1707,11 @@ export interface BillingDetailsChangeTypeOneOf {
|
|
|
1671
1707
|
/** Indicates that billing information was removed during draft. */
|
|
1672
1708
|
removed?: boolean;
|
|
1673
1709
|
}
|
|
1674
|
-
|
|
1710
|
+
interface BillingChangedDetails {
|
|
1675
1711
|
/** Billing address and contact details before draft. */
|
|
1676
1712
|
billingInfoBeforeChange?: AddressWithContact;
|
|
1677
1713
|
}
|
|
1678
|
-
|
|
1714
|
+
interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1679
1715
|
/** Indicates that business location was added during draft. */
|
|
1680
1716
|
added?: boolean;
|
|
1681
1717
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1686,7 +1722,7 @@ export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTy
|
|
|
1686
1722
|
businessLocation?: Location;
|
|
1687
1723
|
}
|
|
1688
1724
|
/** @oneof */
|
|
1689
|
-
|
|
1725
|
+
interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1690
1726
|
/** Indicates that business location was added during draft. */
|
|
1691
1727
|
added?: boolean;
|
|
1692
1728
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1694,13 +1730,13 @@ export interface BusinessLocationDetailsChangeTypeOneOf {
|
|
|
1694
1730
|
/** Indicates that business location was removed during draft. */
|
|
1695
1731
|
removed?: boolean;
|
|
1696
1732
|
}
|
|
1697
|
-
|
|
1733
|
+
interface Location {
|
|
1698
1734
|
/**
|
|
1699
1735
|
* Location ID.
|
|
1700
1736
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1701
1737
|
* @format GUID
|
|
1702
1738
|
*/
|
|
1703
|
-
|
|
1739
|
+
_id?: string;
|
|
1704
1740
|
/**
|
|
1705
1741
|
* Location name.
|
|
1706
1742
|
* @minLength 1
|
|
@@ -1709,18 +1745,18 @@ export interface Location {
|
|
|
1709
1745
|
*/
|
|
1710
1746
|
name?: string;
|
|
1711
1747
|
}
|
|
1712
|
-
|
|
1748
|
+
interface BusinessLocationChangedDetails {
|
|
1713
1749
|
/** Business location before draft. */
|
|
1714
1750
|
businessLocationBeforeChange?: Location;
|
|
1715
1751
|
}
|
|
1716
|
-
|
|
1752
|
+
interface CreateDraftOrderRequest {
|
|
1717
1753
|
/**
|
|
1718
1754
|
* ID of the order to create a draft for.
|
|
1719
1755
|
* @format GUID
|
|
1720
1756
|
*/
|
|
1721
1757
|
orderId: string | null;
|
|
1722
1758
|
}
|
|
1723
|
-
|
|
1759
|
+
interface CreateDraftOrderResponse {
|
|
1724
1760
|
/** Draft order calculated with the latest changes. */
|
|
1725
1761
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1726
1762
|
/**
|
|
@@ -1731,7 +1767,7 @@ export interface CreateDraftOrderResponse {
|
|
|
1731
1767
|
*/
|
|
1732
1768
|
preexistingDraftOrder?: boolean | null;
|
|
1733
1769
|
}
|
|
1734
|
-
|
|
1770
|
+
interface CalculatedDraftOrder {
|
|
1735
1771
|
/** Draft order. */
|
|
1736
1772
|
draftOrder?: DraftOrder;
|
|
1737
1773
|
/** Shipping options. */
|
|
@@ -1739,7 +1775,7 @@ export interface CalculatedDraftOrder {
|
|
|
1739
1775
|
/** Errors that occurred during calculation. */
|
|
1740
1776
|
calculationErrors?: CalculationErrors;
|
|
1741
1777
|
}
|
|
1742
|
-
|
|
1778
|
+
interface ShippingOption {
|
|
1743
1779
|
/**
|
|
1744
1780
|
* Carrier ID.
|
|
1745
1781
|
* @format GUID
|
|
@@ -1754,7 +1790,7 @@ export interface ShippingOption {
|
|
|
1754
1790
|
/** Shipping cost. */
|
|
1755
1791
|
cost?: ShippingPrice;
|
|
1756
1792
|
}
|
|
1757
|
-
|
|
1793
|
+
interface DeliveryLogistics {
|
|
1758
1794
|
/** When the item is expected to be delivered in free text, e.g "3-5 business days" */
|
|
1759
1795
|
deliveryTime?: string | null;
|
|
1760
1796
|
/**
|
|
@@ -1768,13 +1804,13 @@ export interface DeliveryLogistics {
|
|
|
1768
1804
|
/** Expected delivery time slot. */
|
|
1769
1805
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1770
1806
|
}
|
|
1771
|
-
|
|
1807
|
+
interface PickupDetails {
|
|
1772
1808
|
/** Pickup address. */
|
|
1773
1809
|
address?: Address;
|
|
1774
1810
|
/** Pickup method. */
|
|
1775
1811
|
pickupMethod?: PickupMethodWithLiterals;
|
|
1776
1812
|
}
|
|
1777
|
-
|
|
1813
|
+
declare enum PickupMethod {
|
|
1778
1814
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1779
1815
|
/** Store pickup. */
|
|
1780
1816
|
STORE_PICKUP = "STORE_PICKUP",
|
|
@@ -1782,14 +1818,14 @@ export declare enum PickupMethod {
|
|
|
1782
1818
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1783
1819
|
}
|
|
1784
1820
|
/** @enumType */
|
|
1785
|
-
|
|
1786
|
-
|
|
1821
|
+
type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1822
|
+
interface DeliveryTimeSlot {
|
|
1787
1823
|
/** Delivery time slot start time. */
|
|
1788
1824
|
from?: Date | null;
|
|
1789
1825
|
/** Delivery time slot end time. */
|
|
1790
1826
|
to?: Date | null;
|
|
1791
1827
|
}
|
|
1792
|
-
|
|
1828
|
+
interface ShippingPrice {
|
|
1793
1829
|
/** Shipping price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
|
|
1794
1830
|
price?: Price;
|
|
1795
1831
|
/**
|
|
@@ -1798,7 +1834,7 @@ export interface ShippingPrice {
|
|
|
1798
1834
|
*/
|
|
1799
1835
|
currency?: string;
|
|
1800
1836
|
}
|
|
1801
|
-
|
|
1837
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1802
1838
|
/** General shipping calculation error. */
|
|
1803
1839
|
generalShippingCalculationError?: Details;
|
|
1804
1840
|
/** Carrier errors. */
|
|
@@ -1809,13 +1845,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
1809
1845
|
orderValidationErrors?: ApplicationError[];
|
|
1810
1846
|
}
|
|
1811
1847
|
/** @oneof */
|
|
1812
|
-
|
|
1848
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1813
1849
|
/** General shipping calculation error. */
|
|
1814
1850
|
generalShippingCalculationError?: Details;
|
|
1815
1851
|
/** Carrier errors. */
|
|
1816
1852
|
carrierErrors?: CarrierErrors;
|
|
1817
1853
|
}
|
|
1818
|
-
|
|
1854
|
+
interface Details extends DetailsKindOneOf {
|
|
1819
1855
|
applicationError?: ApplicationError;
|
|
1820
1856
|
validationError?: ValidationError;
|
|
1821
1857
|
systemError?: SystemError;
|
|
@@ -1826,12 +1862,12 @@ export interface Details extends DetailsKindOneOf {
|
|
|
1826
1862
|
tracing?: Record<string, string>;
|
|
1827
1863
|
}
|
|
1828
1864
|
/** @oneof */
|
|
1829
|
-
|
|
1865
|
+
interface DetailsKindOneOf {
|
|
1830
1866
|
applicationError?: ApplicationError;
|
|
1831
1867
|
validationError?: ValidationError;
|
|
1832
1868
|
systemError?: SystemError;
|
|
1833
1869
|
}
|
|
1834
|
-
|
|
1870
|
+
interface ApplicationError {
|
|
1835
1871
|
/** Error code. */
|
|
1836
1872
|
code?: string;
|
|
1837
1873
|
/** Description of the error. */
|
|
@@ -1871,10 +1907,10 @@ export interface ApplicationError {
|
|
|
1871
1907
|
* ]
|
|
1872
1908
|
* }
|
|
1873
1909
|
*/
|
|
1874
|
-
|
|
1910
|
+
interface ValidationError {
|
|
1875
1911
|
fieldViolations?: FieldViolation[];
|
|
1876
1912
|
}
|
|
1877
|
-
|
|
1913
|
+
declare enum RuleType {
|
|
1878
1914
|
VALIDATION = "VALIDATION",
|
|
1879
1915
|
OTHER = "OTHER",
|
|
1880
1916
|
MAX = "MAX",
|
|
@@ -1898,8 +1934,8 @@ export declare enum RuleType {
|
|
|
1898
1934
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1899
1935
|
}
|
|
1900
1936
|
/** @enumType */
|
|
1901
|
-
|
|
1902
|
-
|
|
1937
|
+
type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
|
|
1938
|
+
interface FieldViolation {
|
|
1903
1939
|
field?: string;
|
|
1904
1940
|
description?: string;
|
|
1905
1941
|
violatedRule?: RuleTypeWithLiterals;
|
|
@@ -1907,27 +1943,27 @@ export interface FieldViolation {
|
|
|
1907
1943
|
ruleName?: string | null;
|
|
1908
1944
|
data?: Record<string, any> | null;
|
|
1909
1945
|
}
|
|
1910
|
-
|
|
1946
|
+
interface SystemError {
|
|
1911
1947
|
/** Error code. */
|
|
1912
1948
|
errorCode?: string | null;
|
|
1913
1949
|
}
|
|
1914
|
-
|
|
1950
|
+
interface CarrierErrors {
|
|
1915
1951
|
/** Carrier errors. */
|
|
1916
1952
|
errors?: CarrierError[];
|
|
1917
1953
|
}
|
|
1918
|
-
|
|
1954
|
+
interface CarrierError {
|
|
1919
1955
|
/** Carrier ID. */
|
|
1920
1956
|
carrierId?: string;
|
|
1921
1957
|
/** Error details. */
|
|
1922
1958
|
error?: Details;
|
|
1923
1959
|
}
|
|
1924
|
-
|
|
1960
|
+
interface CreateEmptyDraftOrderRequest {
|
|
1925
1961
|
}
|
|
1926
|
-
|
|
1962
|
+
interface CreateEmptyDraftOrderResponse {
|
|
1927
1963
|
/** Draft order calculated with the latest changes. */
|
|
1928
1964
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1929
1965
|
}
|
|
1930
|
-
|
|
1966
|
+
interface AddLineItemsToDraftOrderRequest {
|
|
1931
1967
|
/**
|
|
1932
1968
|
* Draft order ID.
|
|
1933
1969
|
* @format GUID
|
|
@@ -1946,7 +1982,7 @@ export interface AddLineItemsToDraftOrderRequest {
|
|
|
1946
1982
|
*/
|
|
1947
1983
|
customLineItems?: CustomLineItem[];
|
|
1948
1984
|
}
|
|
1949
|
-
|
|
1985
|
+
interface CatalogReferenceLineItem {
|
|
1950
1986
|
/**
|
|
1951
1987
|
* Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
|
|
1952
1988
|
* Optional for custom line items, which don't trigger the Catalog service plugin.
|
|
@@ -1974,12 +2010,12 @@ export interface CatalogReferenceLineItem {
|
|
|
1974
2010
|
*/
|
|
1975
2011
|
locations?: LocationAndQuantity[];
|
|
1976
2012
|
}
|
|
1977
|
-
|
|
2013
|
+
interface CustomLineItem {
|
|
1978
2014
|
/**
|
|
1979
2015
|
* Line item ID.
|
|
1980
2016
|
* @format GUID
|
|
1981
2017
|
*/
|
|
1982
|
-
|
|
2018
|
+
_id?: string | null;
|
|
1983
2019
|
/**
|
|
1984
2020
|
* Item quantity.
|
|
1985
2021
|
*
|
|
@@ -2004,7 +2040,7 @@ export interface CustomLineItem {
|
|
|
2004
2040
|
*/
|
|
2005
2041
|
productName?: ProductName;
|
|
2006
2042
|
/** URL to the item's page on the site. */
|
|
2007
|
-
url?:
|
|
2043
|
+
url?: string;
|
|
2008
2044
|
/** Item price **after** catalog-defined discount and line item discounts. */
|
|
2009
2045
|
price?: Price;
|
|
2010
2046
|
/** Total line item price **after** catalog-defined discount and line item discounts. */
|
|
@@ -2016,7 +2052,7 @@ export interface CustomLineItem {
|
|
|
2016
2052
|
/** Line item description lines. Used for display purposes for order. */
|
|
2017
2053
|
descriptionLines?: DescriptionLine[];
|
|
2018
2054
|
/** Line item image details. */
|
|
2019
|
-
media?:
|
|
2055
|
+
media?: string;
|
|
2020
2056
|
/** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
|
|
2021
2057
|
physicalProperties?: PhysicalProperties;
|
|
2022
2058
|
/** Item type. Either a preset type or custom. */
|
|
@@ -2036,19 +2072,13 @@ export interface CustomLineItem {
|
|
|
2036
2072
|
*/
|
|
2037
2073
|
locations?: LocationAndQuantity[];
|
|
2038
2074
|
}
|
|
2039
|
-
|
|
2040
|
-
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
2041
|
-
relativePath?: string;
|
|
2042
|
-
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
2043
|
-
url?: string | null;
|
|
2044
|
-
}
|
|
2045
|
-
export interface SecuredMedia {
|
|
2075
|
+
interface SecuredMedia {
|
|
2046
2076
|
/**
|
|
2047
2077
|
* Media ID in Wix Media Manager.
|
|
2048
2078
|
* @minLength 1
|
|
2049
2079
|
* @maxLength 100
|
|
2050
2080
|
*/
|
|
2051
|
-
|
|
2081
|
+
_id?: string;
|
|
2052
2082
|
/**
|
|
2053
2083
|
* Original filename.
|
|
2054
2084
|
* @minLength 1
|
|
@@ -2058,7 +2088,7 @@ export interface SecuredMedia {
|
|
|
2058
2088
|
/** File type. */
|
|
2059
2089
|
fileType?: FileTypeWithLiterals;
|
|
2060
2090
|
}
|
|
2061
|
-
|
|
2091
|
+
declare enum FileType {
|
|
2062
2092
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2063
2093
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
2064
2094
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -2067,12 +2097,12 @@ export declare enum FileType {
|
|
|
2067
2097
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
2068
2098
|
}
|
|
2069
2099
|
/** @enumType */
|
|
2070
|
-
|
|
2071
|
-
|
|
2100
|
+
type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
2101
|
+
interface AddLineItemsToDraftOrderResponse {
|
|
2072
2102
|
/** Draft order calculated with the latest changes. */
|
|
2073
2103
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2074
2104
|
}
|
|
2075
|
-
|
|
2105
|
+
interface UpdateLineItemsRequest {
|
|
2076
2106
|
/**
|
|
2077
2107
|
* Draft order ID.
|
|
2078
2108
|
* @format GUID
|
|
@@ -2085,7 +2115,7 @@ export interface UpdateLineItemsRequest {
|
|
|
2085
2115
|
*/
|
|
2086
2116
|
lineItemChanges: LineItemChangeDetails[];
|
|
2087
2117
|
}
|
|
2088
|
-
|
|
2118
|
+
interface LineItemChangeDetails {
|
|
2089
2119
|
/**
|
|
2090
2120
|
* Line item ID.
|
|
2091
2121
|
* @format GUID
|
|
@@ -2110,11 +2140,11 @@ export interface LineItemChangeDetails {
|
|
|
2110
2140
|
*/
|
|
2111
2141
|
newPriceDescription?: PriceDescription;
|
|
2112
2142
|
}
|
|
2113
|
-
|
|
2143
|
+
interface UpdateLineItemsResponse {
|
|
2114
2144
|
/** Draft order calculated with the latest changes. */
|
|
2115
2145
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2116
2146
|
}
|
|
2117
|
-
|
|
2147
|
+
interface SetDiscountsRequest {
|
|
2118
2148
|
/**
|
|
2119
2149
|
* Draft order ID.
|
|
2120
2150
|
* @format GUID
|
|
@@ -2129,22 +2159,22 @@ export interface SetDiscountsRequest {
|
|
|
2129
2159
|
*/
|
|
2130
2160
|
discounts: IdAndApplied[];
|
|
2131
2161
|
}
|
|
2132
|
-
|
|
2162
|
+
interface IdAndApplied {
|
|
2133
2163
|
/**
|
|
2134
2164
|
* Entity ID.
|
|
2135
2165
|
*
|
|
2136
2166
|
* Depending on the context, the value is either a discount ID or an additional fee ID.
|
|
2137
2167
|
* @format GUID
|
|
2138
2168
|
*/
|
|
2139
|
-
|
|
2169
|
+
_id?: string;
|
|
2140
2170
|
/** Whether the discount or additional fee should be applied to the draft order. */
|
|
2141
2171
|
applied?: boolean;
|
|
2142
2172
|
}
|
|
2143
|
-
|
|
2173
|
+
interface SetDiscountsResponse {
|
|
2144
2174
|
/** Draft order calculated with the latest changes. */
|
|
2145
2175
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2146
2176
|
}
|
|
2147
|
-
|
|
2177
|
+
interface CreateCustomDiscountsRequest {
|
|
2148
2178
|
/**
|
|
2149
2179
|
* Draft order ID.
|
|
2150
2180
|
* @format GUID
|
|
@@ -2159,7 +2189,7 @@ export interface CreateCustomDiscountsRequest {
|
|
|
2159
2189
|
*/
|
|
2160
2190
|
discounts?: DiscountOption[];
|
|
2161
2191
|
}
|
|
2162
|
-
|
|
2192
|
+
interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
2163
2193
|
/** Amount to discount from the line item price. */
|
|
2164
2194
|
priceAmount?: Price;
|
|
2165
2195
|
/**
|
|
@@ -2203,7 +2233,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
2203
2233
|
lineItemDiscounts?: LineItemDiscount[];
|
|
2204
2234
|
}
|
|
2205
2235
|
/** @oneof */
|
|
2206
|
-
|
|
2236
|
+
interface DiscountOptionDiscountAmountOneOf {
|
|
2207
2237
|
/** Amount to discount from the line item price. */
|
|
2208
2238
|
priceAmount?: Price;
|
|
2209
2239
|
/**
|
|
@@ -2213,7 +2243,7 @@ export interface DiscountOptionDiscountAmountOneOf {
|
|
|
2213
2243
|
*/
|
|
2214
2244
|
percentage?: string | null;
|
|
2215
2245
|
}
|
|
2216
|
-
|
|
2246
|
+
declare enum DiscountType {
|
|
2217
2247
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
2218
2248
|
/** Discount applies to the entire order. */
|
|
2219
2249
|
GLOBAL = "GLOBAL",
|
|
@@ -2223,12 +2253,12 @@ export declare enum DiscountType {
|
|
|
2223
2253
|
SHIPPING = "SHIPPING"
|
|
2224
2254
|
}
|
|
2225
2255
|
/** @enumType */
|
|
2226
|
-
|
|
2227
|
-
|
|
2256
|
+
type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_TYPE' | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
2257
|
+
interface CreateCustomDiscountsResponse {
|
|
2228
2258
|
/** Draft order calculated with the latest changes. */
|
|
2229
2259
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2230
2260
|
}
|
|
2231
|
-
|
|
2261
|
+
interface DeleteCustomDiscountsRequest {
|
|
2232
2262
|
/**
|
|
2233
2263
|
* Draft order ID.
|
|
2234
2264
|
* @format GUID
|
|
@@ -2242,11 +2272,11 @@ export interface DeleteCustomDiscountsRequest {
|
|
|
2242
2272
|
*/
|
|
2243
2273
|
discountIds: string[];
|
|
2244
2274
|
}
|
|
2245
|
-
|
|
2275
|
+
interface DeleteCustomDiscountsResponse {
|
|
2246
2276
|
/** Draft order calculated with the latest changes. */
|
|
2247
2277
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2248
2278
|
}
|
|
2249
|
-
|
|
2279
|
+
interface SetAdditionalFeesRequest {
|
|
2250
2280
|
/**
|
|
2251
2281
|
* Draft order ID.
|
|
2252
2282
|
* @format GUID
|
|
@@ -2261,11 +2291,11 @@ export interface SetAdditionalFeesRequest {
|
|
|
2261
2291
|
*/
|
|
2262
2292
|
additionalFees: IdAndApplied[];
|
|
2263
2293
|
}
|
|
2264
|
-
|
|
2294
|
+
interface SetAdditionalFeesResponse {
|
|
2265
2295
|
/** Draft order calculated with the latest changes. */
|
|
2266
2296
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2267
2297
|
}
|
|
2268
|
-
|
|
2298
|
+
interface CreateCustomAdditionalFeesRequest {
|
|
2269
2299
|
/**
|
|
2270
2300
|
* Draft order ID.
|
|
2271
2301
|
* @format GUID
|
|
@@ -2280,7 +2310,7 @@ export interface CreateCustomAdditionalFeesRequest {
|
|
|
2280
2310
|
*/
|
|
2281
2311
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
2282
2312
|
}
|
|
2283
|
-
|
|
2313
|
+
interface AdditionalFeeOption {
|
|
2284
2314
|
/**
|
|
2285
2315
|
* Name of the additional fee.
|
|
2286
2316
|
* @minLength 1
|
|
@@ -2312,11 +2342,11 @@ export interface AdditionalFeeOption {
|
|
|
2312
2342
|
*/
|
|
2313
2343
|
lineItemIds?: string[];
|
|
2314
2344
|
}
|
|
2315
|
-
|
|
2345
|
+
interface CreateCustomAdditionalFeesResponse {
|
|
2316
2346
|
/** Draft order calculated with the latest changes. */
|
|
2317
2347
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2318
2348
|
}
|
|
2319
|
-
|
|
2349
|
+
interface DeleteCustomAdditionalFeesRequest {
|
|
2320
2350
|
/**
|
|
2321
2351
|
* Draft order ID.
|
|
2322
2352
|
* @format GUID
|
|
@@ -2330,11 +2360,11 @@ export interface DeleteCustomAdditionalFeesRequest {
|
|
|
2330
2360
|
*/
|
|
2331
2361
|
customAdditionalFees: string[];
|
|
2332
2362
|
}
|
|
2333
|
-
|
|
2363
|
+
interface DeleteCustomAdditionalFeesResponse {
|
|
2334
2364
|
/** Draft order calculated with the latest changes. */
|
|
2335
2365
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2336
2366
|
}
|
|
2337
|
-
|
|
2367
|
+
interface SetShippingInfoRequest {
|
|
2338
2368
|
/**
|
|
2339
2369
|
* Draft order ID.
|
|
2340
2370
|
* @format GUID
|
|
@@ -2347,11 +2377,11 @@ export interface SetShippingInfoRequest {
|
|
|
2347
2377
|
*/
|
|
2348
2378
|
shippingInfo?: V1ShippingInformation;
|
|
2349
2379
|
}
|
|
2350
|
-
|
|
2380
|
+
interface SetShippingInfoResponse {
|
|
2351
2381
|
/** Draft order calculated with the latest changes. */
|
|
2352
2382
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2353
2383
|
}
|
|
2354
|
-
|
|
2384
|
+
interface SetBuyerInfoRequest {
|
|
2355
2385
|
/**
|
|
2356
2386
|
* Draft order ID.
|
|
2357
2387
|
* @format GUID
|
|
@@ -2364,11 +2394,11 @@ export interface SetBuyerInfoRequest {
|
|
|
2364
2394
|
*/
|
|
2365
2395
|
buyerInfo?: BuyerInfo;
|
|
2366
2396
|
}
|
|
2367
|
-
|
|
2397
|
+
interface SetBuyerInfoResponse {
|
|
2368
2398
|
/** Draft order calculated with the latest changes. */
|
|
2369
2399
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2370
2400
|
}
|
|
2371
|
-
|
|
2401
|
+
interface SetRecipientInfoRequest {
|
|
2372
2402
|
/**
|
|
2373
2403
|
* Draft order ID.
|
|
2374
2404
|
* @format GUID
|
|
@@ -2381,11 +2411,11 @@ export interface SetRecipientInfoRequest {
|
|
|
2381
2411
|
*/
|
|
2382
2412
|
recipientInfo?: AddressWithContact;
|
|
2383
2413
|
}
|
|
2384
|
-
|
|
2414
|
+
interface SetRecipientInfoResponse {
|
|
2385
2415
|
/** Draft order calculated with the latest changes. */
|
|
2386
2416
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2387
2417
|
}
|
|
2388
|
-
|
|
2418
|
+
interface SetBillingInfoRequest {
|
|
2389
2419
|
/**
|
|
2390
2420
|
* Draft order ID.
|
|
2391
2421
|
* @format GUID
|
|
@@ -2398,12 +2428,12 @@ export interface SetBillingInfoRequest {
|
|
|
2398
2428
|
*/
|
|
2399
2429
|
billingInfo?: AddressWithContact;
|
|
2400
2430
|
}
|
|
2401
|
-
|
|
2431
|
+
interface SetBillingInfoResponse {
|
|
2402
2432
|
/** Draft order calculated with the latest changes. */
|
|
2403
2433
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2404
2434
|
}
|
|
2405
2435
|
/** Deprecated */
|
|
2406
|
-
|
|
2436
|
+
interface UpdateShippingInfoRequest {
|
|
2407
2437
|
/**
|
|
2408
2438
|
* Draft order ID.
|
|
2409
2439
|
* @format GUID
|
|
@@ -2413,29 +2443,29 @@ export interface UpdateShippingInfoRequest {
|
|
|
2413
2443
|
shippingOption?: ShippingOption;
|
|
2414
2444
|
}
|
|
2415
2445
|
/** Deprecated */
|
|
2416
|
-
|
|
2446
|
+
interface UpdateShippingInfoResponse {
|
|
2417
2447
|
/** Draft order calculated with the latest changes. */
|
|
2418
2448
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2419
2449
|
}
|
|
2420
|
-
|
|
2450
|
+
interface GetDraftOrderRequest {
|
|
2421
2451
|
/**
|
|
2422
2452
|
* Draft order ID.
|
|
2423
2453
|
* @format GUID
|
|
2424
2454
|
*/
|
|
2425
2455
|
draftOrderId: string;
|
|
2426
2456
|
}
|
|
2427
|
-
|
|
2457
|
+
interface GetDraftOrderResponse {
|
|
2428
2458
|
/** Draft order calculated with the latest changes. */
|
|
2429
2459
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2430
2460
|
}
|
|
2431
|
-
|
|
2461
|
+
interface GetOrderDraftabilityStatusRequest {
|
|
2432
2462
|
/**
|
|
2433
2463
|
* Order ID.
|
|
2434
2464
|
* @format GUID
|
|
2435
2465
|
*/
|
|
2436
2466
|
orderId: string;
|
|
2437
2467
|
}
|
|
2438
|
-
|
|
2468
|
+
interface GetOrderDraftabilityStatusResponse {
|
|
2439
2469
|
/**
|
|
2440
2470
|
* Order ID.
|
|
2441
2471
|
* @format GUID
|
|
@@ -2449,7 +2479,7 @@ export interface GetOrderDraftabilityStatusResponse {
|
|
|
2449
2479
|
*/
|
|
2450
2480
|
nonDraftableReasons?: NonDraftableReasonWithLiterals[];
|
|
2451
2481
|
}
|
|
2452
|
-
|
|
2482
|
+
declare enum NonDraftableReason {
|
|
2453
2483
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2454
2484
|
/** Modifications of refunded orders are not supported. */
|
|
2455
2485
|
PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
|
|
@@ -2473,8 +2503,8 @@ export declare enum NonDraftableReason {
|
|
|
2473
2503
|
SUBSCRIPTION_LINE_ITEM_EXISTS = "SUBSCRIPTION_LINE_ITEM_EXISTS"
|
|
2474
2504
|
}
|
|
2475
2505
|
/** @enumType */
|
|
2476
|
-
|
|
2477
|
-
|
|
2506
|
+
type NonDraftableReasonWithLiterals = NonDraftableReason | 'UNSPECIFIED' | 'PARTIALLY_OR_FULLY_REFUNDED' | 'UNSUPPORTED_CHANNEL_TYPE' | 'ORDER_STATUS_IS_NOT_SUPPORTED' | 'ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT' | 'ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT' | 'ORDER_NOT_FOUND' | 'SUBSCRIPTION_LINE_ITEM_EXISTS';
|
|
2507
|
+
interface CommitDraftOrderRequest {
|
|
2478
2508
|
/**
|
|
2479
2509
|
* Draft order ID.
|
|
2480
2510
|
* @format GUID
|
|
@@ -2488,19 +2518,19 @@ export interface CommitDraftOrderRequest {
|
|
|
2488
2518
|
*/
|
|
2489
2519
|
reason?: string | null;
|
|
2490
2520
|
}
|
|
2491
|
-
|
|
2521
|
+
interface CommitDraftOrderResponse {
|
|
2492
2522
|
/** Draft order after commit. */
|
|
2493
2523
|
committedDraftOrder?: DraftOrder;
|
|
2494
2524
|
/** Updated order after commit. */
|
|
2495
2525
|
orderAfterCommit?: Order;
|
|
2496
2526
|
}
|
|
2497
|
-
|
|
2527
|
+
interface Order {
|
|
2498
2528
|
/**
|
|
2499
2529
|
* Order ID.
|
|
2500
2530
|
* @format GUID
|
|
2501
2531
|
* @readonly
|
|
2502
2532
|
*/
|
|
2503
|
-
|
|
2533
|
+
_id?: string | null;
|
|
2504
2534
|
/**
|
|
2505
2535
|
* Order number displayed in the site owner's dashboard (auto-generated).
|
|
2506
2536
|
* @readonly
|
|
@@ -2511,12 +2541,12 @@ export interface Order {
|
|
|
2511
2541
|
* @readonly
|
|
2512
2542
|
* @immutable
|
|
2513
2543
|
*/
|
|
2514
|
-
|
|
2544
|
+
_createdDate?: Date | null;
|
|
2515
2545
|
/**
|
|
2516
2546
|
* Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2517
2547
|
* @readonly
|
|
2518
2548
|
*/
|
|
2519
|
-
|
|
2549
|
+
_updatedDate?: Date | null;
|
|
2520
2550
|
/**
|
|
2521
2551
|
* Order line items.
|
|
2522
2552
|
* @minSize 1
|
|
@@ -2667,7 +2697,7 @@ export interface Order {
|
|
|
2667
2697
|
*/
|
|
2668
2698
|
payAfterFreeTrial?: PriceSummary;
|
|
2669
2699
|
}
|
|
2670
|
-
|
|
2700
|
+
declare enum PaymentStatus {
|
|
2671
2701
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2672
2702
|
/**
|
|
2673
2703
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -2709,8 +2739,8 @@ export declare enum PaymentStatus {
|
|
|
2709
2739
|
DECLINED = "DECLINED"
|
|
2710
2740
|
}
|
|
2711
2741
|
/** @enumType */
|
|
2712
|
-
|
|
2713
|
-
|
|
2742
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
|
|
2743
|
+
declare enum FulfillmentStatus {
|
|
2714
2744
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
2715
2745
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
2716
2746
|
/**
|
|
@@ -2722,8 +2752,8 @@ export declare enum FulfillmentStatus {
|
|
|
2722
2752
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
2723
2753
|
}
|
|
2724
2754
|
/** @enumType */
|
|
2725
|
-
|
|
2726
|
-
|
|
2755
|
+
type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
|
|
2756
|
+
interface CurrencyConversionDetails {
|
|
2727
2757
|
/**
|
|
2728
2758
|
* 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.
|
|
2729
2759
|
*
|
|
@@ -2741,7 +2771,7 @@ export interface CurrencyConversionDetails {
|
|
|
2741
2771
|
*/
|
|
2742
2772
|
conversionRate?: string | null;
|
|
2743
2773
|
}
|
|
2744
|
-
|
|
2774
|
+
declare enum OrderStatus {
|
|
2745
2775
|
/** Order created, but not yet approved or canceled. */
|
|
2746
2776
|
INITIALIZED = "INITIALIZED",
|
|
2747
2777
|
/**
|
|
@@ -2767,20 +2797,74 @@ export declare enum OrderStatus {
|
|
|
2767
2797
|
REJECTED = "REJECTED"
|
|
2768
2798
|
}
|
|
2769
2799
|
/** @enumType */
|
|
2770
|
-
|
|
2771
|
-
|
|
2800
|
+
type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
|
|
2801
|
+
interface Activity extends ActivityContentOneOf {
|
|
2772
2802
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2773
2803
|
customActivity?: CustomActivity;
|
|
2774
2804
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
2775
2805
|
merchantComment?: MerchantComment;
|
|
2776
2806
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2777
2807
|
orderRefunded?: OrderRefunded;
|
|
2808
|
+
/**
|
|
2809
|
+
* Details of an initiated refund process.
|
|
2810
|
+
*
|
|
2811
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2812
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2813
|
+
* @internal
|
|
2814
|
+
*/
|
|
2815
|
+
refundInitiated?: RefundInitiated;
|
|
2816
|
+
/**
|
|
2817
|
+
* Details of a refunded payment.
|
|
2818
|
+
*
|
|
2819
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2820
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2821
|
+
* @internal
|
|
2822
|
+
*/
|
|
2823
|
+
paymentRefunded?: PaymentRefunded;
|
|
2824
|
+
/**
|
|
2825
|
+
* Details of a failed payment refund.
|
|
2826
|
+
*
|
|
2827
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2828
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2829
|
+
* @internal
|
|
2830
|
+
*/
|
|
2831
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
2832
|
+
/**
|
|
2833
|
+
* Details of refund to store credit.
|
|
2834
|
+
* @internal
|
|
2835
|
+
*/
|
|
2836
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
2837
|
+
/**
|
|
2838
|
+
* Details of a pending payment
|
|
2839
|
+
* @internal
|
|
2840
|
+
*/
|
|
2841
|
+
paymentPending?: PaymentPending;
|
|
2842
|
+
/**
|
|
2843
|
+
* Details of a canceled payment
|
|
2844
|
+
* @internal
|
|
2845
|
+
*/
|
|
2846
|
+
paymentCanceled?: PaymentCanceled;
|
|
2847
|
+
/**
|
|
2848
|
+
* Details of a declined payment
|
|
2849
|
+
* @internal
|
|
2850
|
+
*/
|
|
2851
|
+
paymentDeclined?: PaymentDeclined;
|
|
2852
|
+
/**
|
|
2853
|
+
* Receipt was added for associated payment
|
|
2854
|
+
* @internal
|
|
2855
|
+
*/
|
|
2856
|
+
receiptCreated?: ReceiptCreated;
|
|
2857
|
+
/**
|
|
2858
|
+
* Receipt sent to customer
|
|
2859
|
+
* @internal
|
|
2860
|
+
*/
|
|
2861
|
+
receiptSent?: ReceiptSent;
|
|
2778
2862
|
/**
|
|
2779
2863
|
* Activity ID.
|
|
2780
2864
|
* @format GUID
|
|
2781
2865
|
* @readonly
|
|
2782
2866
|
*/
|
|
2783
|
-
|
|
2867
|
+
_id?: string | null;
|
|
2784
2868
|
/**
|
|
2785
2869
|
* Activity author's email.
|
|
2786
2870
|
* @format EMAIL
|
|
@@ -2791,20 +2875,74 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2791
2875
|
* Activity creation date and time.
|
|
2792
2876
|
* @readonly
|
|
2793
2877
|
*/
|
|
2794
|
-
|
|
2878
|
+
_createdDate?: Date | null;
|
|
2795
2879
|
/** Activity type. */
|
|
2796
2880
|
type?: ActivityTypeWithLiterals;
|
|
2797
2881
|
}
|
|
2798
2882
|
/** @oneof */
|
|
2799
|
-
|
|
2883
|
+
interface ActivityContentOneOf {
|
|
2800
2884
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2801
2885
|
customActivity?: CustomActivity;
|
|
2802
2886
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
2803
2887
|
merchantComment?: MerchantComment;
|
|
2804
2888
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2805
2889
|
orderRefunded?: OrderRefunded;
|
|
2890
|
+
/**
|
|
2891
|
+
* Details of an initiated refund process.
|
|
2892
|
+
*
|
|
2893
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2894
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2895
|
+
* @internal
|
|
2896
|
+
*/
|
|
2897
|
+
refundInitiated?: RefundInitiated;
|
|
2898
|
+
/**
|
|
2899
|
+
* Details of a refunded payment.
|
|
2900
|
+
*
|
|
2901
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2902
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2903
|
+
* @internal
|
|
2904
|
+
*/
|
|
2905
|
+
paymentRefunded?: PaymentRefunded;
|
|
2906
|
+
/**
|
|
2907
|
+
* Details of a failed payment refund.
|
|
2908
|
+
*
|
|
2909
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
2910
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
2911
|
+
* @internal
|
|
2912
|
+
*/
|
|
2913
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
2914
|
+
/**
|
|
2915
|
+
* Details of refund to store credit.
|
|
2916
|
+
* @internal
|
|
2917
|
+
*/
|
|
2918
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
2919
|
+
/**
|
|
2920
|
+
* Details of a pending payment
|
|
2921
|
+
* @internal
|
|
2922
|
+
*/
|
|
2923
|
+
paymentPending?: PaymentPending;
|
|
2924
|
+
/**
|
|
2925
|
+
* Details of a canceled payment
|
|
2926
|
+
* @internal
|
|
2927
|
+
*/
|
|
2928
|
+
paymentCanceled?: PaymentCanceled;
|
|
2929
|
+
/**
|
|
2930
|
+
* Details of a declined payment
|
|
2931
|
+
* @internal
|
|
2932
|
+
*/
|
|
2933
|
+
paymentDeclined?: PaymentDeclined;
|
|
2934
|
+
/**
|
|
2935
|
+
* Receipt was added for associated payment
|
|
2936
|
+
* @internal
|
|
2937
|
+
*/
|
|
2938
|
+
receiptCreated?: ReceiptCreated;
|
|
2939
|
+
/**
|
|
2940
|
+
* Receipt sent to customer
|
|
2941
|
+
* @internal
|
|
2942
|
+
*/
|
|
2943
|
+
receiptSent?: ReceiptSent;
|
|
2806
2944
|
}
|
|
2807
|
-
|
|
2945
|
+
interface CustomActivity {
|
|
2808
2946
|
/**
|
|
2809
2947
|
* ID of the app that created the custom activity.
|
|
2810
2948
|
* @format GUID
|
|
@@ -2819,7 +2957,7 @@ export interface CustomActivity {
|
|
|
2819
2957
|
additionalData?: Record<string, string>;
|
|
2820
2958
|
}
|
|
2821
2959
|
/** Store owner added a comment */
|
|
2822
|
-
|
|
2960
|
+
interface MerchantComment {
|
|
2823
2961
|
/**
|
|
2824
2962
|
* Merchant comment message.
|
|
2825
2963
|
* @minLength 1
|
|
@@ -2827,7 +2965,7 @@ export interface MerchantComment {
|
|
|
2827
2965
|
*/
|
|
2828
2966
|
message?: string;
|
|
2829
2967
|
}
|
|
2830
|
-
|
|
2968
|
+
interface OrderRefunded {
|
|
2831
2969
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
2832
2970
|
manual?: boolean;
|
|
2833
2971
|
/** Refund amount. */
|
|
@@ -2838,14 +2976,14 @@ export interface OrderRefunded {
|
|
|
2838
2976
|
*/
|
|
2839
2977
|
reason?: string;
|
|
2840
2978
|
}
|
|
2841
|
-
|
|
2979
|
+
interface OrderCreatedFromExchange {
|
|
2842
2980
|
/**
|
|
2843
2981
|
* ID of the original order for which the exchange happened.
|
|
2844
2982
|
* @format GUID
|
|
2845
2983
|
*/
|
|
2846
2984
|
originalOrderId?: string;
|
|
2847
2985
|
}
|
|
2848
|
-
|
|
2986
|
+
interface NewExchangeOrderCreated {
|
|
2849
2987
|
/**
|
|
2850
2988
|
* ID of the new order created as a result of an exchange of items.
|
|
2851
2989
|
* @format GUID
|
|
@@ -2858,7 +2996,7 @@ export interface NewExchangeOrderCreated {
|
|
|
2858
2996
|
*/
|
|
2859
2997
|
lineItems?: LineItemExchangeData[];
|
|
2860
2998
|
}
|
|
2861
|
-
|
|
2999
|
+
interface LineItemExchangeData {
|
|
2862
3000
|
/**
|
|
2863
3001
|
* ID of the exchanged line item.
|
|
2864
3002
|
* @format GUID
|
|
@@ -2871,7 +3009,7 @@ export interface LineItemExchangeData {
|
|
|
2871
3009
|
*/
|
|
2872
3010
|
quantity?: number;
|
|
2873
3011
|
}
|
|
2874
|
-
|
|
3012
|
+
interface DraftOrderChangesApplied {
|
|
2875
3013
|
/** Draft order id. */
|
|
2876
3014
|
draftOrderId?: string;
|
|
2877
3015
|
/**
|
|
@@ -2882,7 +3020,7 @@ export interface DraftOrderChangesApplied {
|
|
|
2882
3020
|
/** Changes applied to order. */
|
|
2883
3021
|
changes?: OrderChange[];
|
|
2884
3022
|
}
|
|
2885
|
-
|
|
3023
|
+
interface OrderChange extends OrderChangeValueOneOf {
|
|
2886
3024
|
lineItemChanged?: LineItemChanges;
|
|
2887
3025
|
lineItemAdded?: ManagedLineItem;
|
|
2888
3026
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2894,7 +3032,7 @@ export interface OrderChange extends OrderChangeValueOneOf {
|
|
|
2894
3032
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2895
3033
|
}
|
|
2896
3034
|
/** @oneof */
|
|
2897
|
-
|
|
3035
|
+
interface OrderChangeValueOneOf {
|
|
2898
3036
|
lineItemChanged?: LineItemChanges;
|
|
2899
3037
|
lineItemAdded?: ManagedLineItem;
|
|
2900
3038
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2905,12 +3043,12 @@ export interface OrderChangeValueOneOf {
|
|
|
2905
3043
|
totalPriceChanged?: TotalPriceChange;
|
|
2906
3044
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2907
3045
|
}
|
|
2908
|
-
|
|
3046
|
+
interface LineItemChanges {
|
|
2909
3047
|
/**
|
|
2910
3048
|
* Line item ID.
|
|
2911
3049
|
* @format GUID
|
|
2912
3050
|
*/
|
|
2913
|
-
|
|
3051
|
+
_id?: string;
|
|
2914
3052
|
/** Item name. */
|
|
2915
3053
|
name?: ProductName;
|
|
2916
3054
|
/** Item quantity change. */
|
|
@@ -2918,7 +3056,7 @@ export interface LineItemChanges {
|
|
|
2918
3056
|
/** Item price change. */
|
|
2919
3057
|
price?: LineItemPriceChange;
|
|
2920
3058
|
}
|
|
2921
|
-
|
|
3059
|
+
interface LineItemQuantityChange {
|
|
2922
3060
|
/**
|
|
2923
3061
|
* Item quantity before update.
|
|
2924
3062
|
* @max 1000000
|
|
@@ -2938,26 +3076,26 @@ export interface LineItemQuantityChange {
|
|
|
2938
3076
|
/** Type of quantity change: increase or decrease. */
|
|
2939
3077
|
deltaType?: LineItemQuantityChangeTypeWithLiterals;
|
|
2940
3078
|
}
|
|
2941
|
-
|
|
3079
|
+
declare enum LineItemQuantityChangeType {
|
|
2942
3080
|
/** Quantity increased. */
|
|
2943
3081
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
2944
3082
|
/** Quantity decreased. */
|
|
2945
3083
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
2946
3084
|
}
|
|
2947
3085
|
/** @enumType */
|
|
2948
|
-
|
|
2949
|
-
|
|
3086
|
+
type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
|
|
3087
|
+
interface LineItemPriceChange {
|
|
2950
3088
|
/** Item price before update. */
|
|
2951
3089
|
originalPrice?: Price;
|
|
2952
3090
|
/** Item price after update. */
|
|
2953
3091
|
newPrice?: Price;
|
|
2954
3092
|
}
|
|
2955
|
-
|
|
3093
|
+
interface ManagedLineItem {
|
|
2956
3094
|
/**
|
|
2957
3095
|
* Line item ID.
|
|
2958
3096
|
* @format GUID
|
|
2959
3097
|
*/
|
|
2960
|
-
|
|
3098
|
+
_id?: string;
|
|
2961
3099
|
/** Item name. */
|
|
2962
3100
|
name?: ProductName;
|
|
2963
3101
|
/**
|
|
@@ -2967,12 +3105,12 @@ export interface ManagedLineItem {
|
|
|
2967
3105
|
*/
|
|
2968
3106
|
quantity?: number;
|
|
2969
3107
|
}
|
|
2970
|
-
|
|
3108
|
+
interface ManagedDiscount {
|
|
2971
3109
|
/**
|
|
2972
3110
|
* Discount id.
|
|
2973
3111
|
* @format GUID
|
|
2974
3112
|
*/
|
|
2975
|
-
|
|
3113
|
+
_id?: string;
|
|
2976
3114
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2977
3115
|
name?: TranslatedValue;
|
|
2978
3116
|
/** Line items discount applies to. */
|
|
@@ -2980,7 +3118,7 @@ export interface ManagedDiscount {
|
|
|
2980
3118
|
/** Discount amount. */
|
|
2981
3119
|
totalAmount?: Price;
|
|
2982
3120
|
}
|
|
2983
|
-
|
|
3121
|
+
interface TranslatedValue {
|
|
2984
3122
|
/**
|
|
2985
3123
|
* Value in site default language.
|
|
2986
3124
|
* @minLength 1
|
|
@@ -2992,23 +3130,23 @@ export interface TranslatedValue {
|
|
|
2992
3130
|
*/
|
|
2993
3131
|
translated?: string | null;
|
|
2994
3132
|
}
|
|
2995
|
-
|
|
3133
|
+
interface LineItemAmount {
|
|
2996
3134
|
/**
|
|
2997
3135
|
* Order line item id
|
|
2998
3136
|
* @format GUID
|
|
2999
3137
|
*/
|
|
3000
|
-
|
|
3138
|
+
_id?: string;
|
|
3001
3139
|
/** Item name. */
|
|
3002
3140
|
name?: ProductName;
|
|
3003
3141
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
3004
3142
|
amount?: Price;
|
|
3005
3143
|
}
|
|
3006
|
-
|
|
3144
|
+
interface ManagedAdditionalFee {
|
|
3007
3145
|
/**
|
|
3008
3146
|
* Additional fee id.
|
|
3009
3147
|
* @format GUID
|
|
3010
3148
|
*/
|
|
3011
|
-
|
|
3149
|
+
_id?: string;
|
|
3012
3150
|
/** Additional fee name. */
|
|
3013
3151
|
name?: TranslatedValue;
|
|
3014
3152
|
/** Line items additional fee applies to. */
|
|
@@ -3016,19 +3154,19 @@ export interface ManagedAdditionalFee {
|
|
|
3016
3154
|
/** Additional fee amount. */
|
|
3017
3155
|
totalAmount?: Price;
|
|
3018
3156
|
}
|
|
3019
|
-
|
|
3157
|
+
interface TotalPriceChange {
|
|
3020
3158
|
/** Order’s total price after discounts and tax. Before update */
|
|
3021
3159
|
originalTotal?: Price;
|
|
3022
3160
|
/** Order’s total price after discounts and tax. After update */
|
|
3023
3161
|
newTotal?: Price;
|
|
3024
3162
|
}
|
|
3025
|
-
|
|
3163
|
+
interface ShippingInformationChange {
|
|
3026
3164
|
/** Order’s Shipping Information. Before update */
|
|
3027
3165
|
originalShippingInfo?: ShippingInformation;
|
|
3028
3166
|
/** Order’s Shipping Information. After update */
|
|
3029
3167
|
newShippingInfo?: ShippingInformation;
|
|
3030
3168
|
}
|
|
3031
|
-
|
|
3169
|
+
interface ShippingInformation {
|
|
3032
3170
|
/** Order’s shipping price. */
|
|
3033
3171
|
total?: Price;
|
|
3034
3172
|
/**
|
|
@@ -3038,7 +3176,7 @@ export interface ShippingInformation {
|
|
|
3038
3176
|
shippingTitle?: string;
|
|
3039
3177
|
}
|
|
3040
3178
|
/** Payment method is saved for order */
|
|
3041
|
-
|
|
3179
|
+
interface SavedPaymentMethod {
|
|
3042
3180
|
/**
|
|
3043
3181
|
* Payment method name
|
|
3044
3182
|
* @minLength 1
|
|
@@ -3052,7 +3190,7 @@ export interface SavedPaymentMethod {
|
|
|
3052
3190
|
*/
|
|
3053
3191
|
description?: string | null;
|
|
3054
3192
|
}
|
|
3055
|
-
|
|
3193
|
+
interface AuthorizedPaymentCreated {
|
|
3056
3194
|
/**
|
|
3057
3195
|
* Payment ID of payment associated with this activity
|
|
3058
3196
|
* @format GUID
|
|
@@ -3071,7 +3209,7 @@ export interface AuthorizedPaymentCreated {
|
|
|
3071
3209
|
*/
|
|
3072
3210
|
brand?: string | null;
|
|
3073
3211
|
}
|
|
3074
|
-
|
|
3212
|
+
interface AuthorizedPaymentCaptured {
|
|
3075
3213
|
/**
|
|
3076
3214
|
* Payment ID of payment associated with this activity
|
|
3077
3215
|
* @format GUID
|
|
@@ -3090,7 +3228,7 @@ export interface AuthorizedPaymentCaptured {
|
|
|
3090
3228
|
*/
|
|
3091
3229
|
brand?: string | null;
|
|
3092
3230
|
}
|
|
3093
|
-
|
|
3231
|
+
interface AuthorizedPaymentVoided {
|
|
3094
3232
|
/**
|
|
3095
3233
|
* Payment ID of payment associated with this activity
|
|
3096
3234
|
* @format GUID
|
|
@@ -3109,7 +3247,7 @@ export interface AuthorizedPaymentVoided {
|
|
|
3109
3247
|
*/
|
|
3110
3248
|
brand?: string | null;
|
|
3111
3249
|
}
|
|
3112
|
-
|
|
3250
|
+
interface RefundInitiated {
|
|
3113
3251
|
/**
|
|
3114
3252
|
* Refund ID.
|
|
3115
3253
|
* @format GUID
|
|
@@ -3125,11 +3263,11 @@ export interface RefundInitiated {
|
|
|
3125
3263
|
payments?: RefundedPayment[];
|
|
3126
3264
|
/**
|
|
3127
3265
|
* Reason for refund.
|
|
3128
|
-
* @maxLength
|
|
3266
|
+
* @maxLength 200
|
|
3129
3267
|
*/
|
|
3130
3268
|
reason?: string | null;
|
|
3131
3269
|
}
|
|
3132
|
-
|
|
3270
|
+
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
3133
3271
|
/** Regular payment refund. */
|
|
3134
3272
|
regular?: RegularPaymentRefund;
|
|
3135
3273
|
/** Gift card payment refund. */
|
|
@@ -3145,7 +3283,7 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
3145
3283
|
externalRefund?: boolean;
|
|
3146
3284
|
}
|
|
3147
3285
|
/** @oneof */
|
|
3148
|
-
|
|
3286
|
+
interface RefundedPaymentKindOneOf {
|
|
3149
3287
|
/** Regular payment refund. */
|
|
3150
3288
|
regular?: RegularPaymentRefund;
|
|
3151
3289
|
/** Gift card payment refund. */
|
|
@@ -3153,7 +3291,7 @@ export interface RefundedPaymentKindOneOf {
|
|
|
3153
3291
|
/** Membership payment refund. */
|
|
3154
3292
|
membership?: MembershipPaymentRefund;
|
|
3155
3293
|
}
|
|
3156
|
-
|
|
3294
|
+
interface RegularPaymentRefund {
|
|
3157
3295
|
/** Refund amount */
|
|
3158
3296
|
amount?: Price;
|
|
3159
3297
|
/**
|
|
@@ -3167,7 +3305,7 @@ export interface RegularPaymentRefund {
|
|
|
3167
3305
|
*/
|
|
3168
3306
|
brand?: string | null;
|
|
3169
3307
|
}
|
|
3170
|
-
|
|
3308
|
+
interface GiftCardPaymentRefund {
|
|
3171
3309
|
/**
|
|
3172
3310
|
* Gift card payment ID
|
|
3173
3311
|
* @minLength 1
|
|
@@ -3177,7 +3315,7 @@ export interface GiftCardPaymentRefund {
|
|
|
3177
3315
|
/** Refund amount */
|
|
3178
3316
|
amount?: Price;
|
|
3179
3317
|
}
|
|
3180
|
-
|
|
3318
|
+
interface MembershipPaymentRefund {
|
|
3181
3319
|
/**
|
|
3182
3320
|
* Membership ID
|
|
3183
3321
|
* @minLength 1
|
|
@@ -3185,7 +3323,7 @@ export interface MembershipPaymentRefund {
|
|
|
3185
3323
|
*/
|
|
3186
3324
|
membershipId?: string | null;
|
|
3187
3325
|
}
|
|
3188
|
-
|
|
3326
|
+
interface PaymentRefunded {
|
|
3189
3327
|
/**
|
|
3190
3328
|
* Refund ID.
|
|
3191
3329
|
* @format GUID
|
|
@@ -3194,7 +3332,7 @@ export interface PaymentRefunded {
|
|
|
3194
3332
|
/** Details about the refunded payment. */
|
|
3195
3333
|
payment?: RefundedPayment;
|
|
3196
3334
|
}
|
|
3197
|
-
|
|
3335
|
+
interface PaymentRefundFailed {
|
|
3198
3336
|
/**
|
|
3199
3337
|
* Refund ID.
|
|
3200
3338
|
* @format GUID
|
|
@@ -3203,7 +3341,7 @@ export interface PaymentRefundFailed {
|
|
|
3203
3341
|
/** Details about the failed payment refund. */
|
|
3204
3342
|
payment?: RefundedPayment;
|
|
3205
3343
|
}
|
|
3206
|
-
|
|
3344
|
+
interface RefundedAsStoreCredit {
|
|
3207
3345
|
/** Refund amount */
|
|
3208
3346
|
amount?: Price;
|
|
3209
3347
|
/**
|
|
@@ -3212,7 +3350,7 @@ export interface RefundedAsStoreCredit {
|
|
|
3212
3350
|
*/
|
|
3213
3351
|
reason?: string | null;
|
|
3214
3352
|
}
|
|
3215
|
-
|
|
3353
|
+
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
3216
3354
|
/** Regular payment. */
|
|
3217
3355
|
regular?: RegularPayment;
|
|
3218
3356
|
/**
|
|
@@ -3222,22 +3360,22 @@ export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
3222
3360
|
paymentId?: string;
|
|
3223
3361
|
}
|
|
3224
3362
|
/** @oneof */
|
|
3225
|
-
|
|
3363
|
+
interface PaymentPendingPaymentDetailsOneOf {
|
|
3226
3364
|
/** Regular payment. */
|
|
3227
3365
|
regular?: RegularPayment;
|
|
3228
3366
|
}
|
|
3229
|
-
|
|
3367
|
+
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
3230
3368
|
/** Whether regular card used */
|
|
3231
3369
|
creditCardDetails?: CreditCardDetails;
|
|
3232
3370
|
/** Payment amount */
|
|
3233
3371
|
amount?: Price;
|
|
3234
3372
|
}
|
|
3235
3373
|
/** @oneof */
|
|
3236
|
-
|
|
3374
|
+
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
3237
3375
|
/** Whether regular card used */
|
|
3238
3376
|
creditCardDetails?: CreditCardDetails;
|
|
3239
3377
|
}
|
|
3240
|
-
|
|
3378
|
+
interface CreditCardDetails {
|
|
3241
3379
|
/**
|
|
3242
3380
|
* The last 4 digits of the card number.
|
|
3243
3381
|
* @maxLength 4
|
|
@@ -3249,7 +3387,7 @@ export interface CreditCardDetails {
|
|
|
3249
3387
|
*/
|
|
3250
3388
|
brand?: string | null;
|
|
3251
3389
|
}
|
|
3252
|
-
|
|
3390
|
+
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
3253
3391
|
/** Regular payment. */
|
|
3254
3392
|
regular?: RegularPayment;
|
|
3255
3393
|
/**
|
|
@@ -3259,11 +3397,11 @@ export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
3259
3397
|
paymentId?: string;
|
|
3260
3398
|
}
|
|
3261
3399
|
/** @oneof */
|
|
3262
|
-
|
|
3400
|
+
interface PaymentCanceledPaymentDetailsOneOf {
|
|
3263
3401
|
/** Regular payment. */
|
|
3264
3402
|
regular?: RegularPayment;
|
|
3265
3403
|
}
|
|
3266
|
-
|
|
3404
|
+
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
3267
3405
|
/** Regular payment. */
|
|
3268
3406
|
regular?: RegularPayment;
|
|
3269
3407
|
/**
|
|
@@ -3273,11 +3411,11 @@ export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
3273
3411
|
paymentId?: string;
|
|
3274
3412
|
}
|
|
3275
3413
|
/** @oneof */
|
|
3276
|
-
|
|
3414
|
+
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
3277
3415
|
/** Regular payment. */
|
|
3278
3416
|
regular?: RegularPayment;
|
|
3279
3417
|
}
|
|
3280
|
-
|
|
3418
|
+
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
3281
3419
|
/** Receipt created by Wix */
|
|
3282
3420
|
wixReceipt?: WixReceipt;
|
|
3283
3421
|
/** Receipt created by an external system. */
|
|
@@ -3289,13 +3427,13 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
3289
3427
|
paymentId?: string;
|
|
3290
3428
|
}
|
|
3291
3429
|
/** @oneof */
|
|
3292
|
-
|
|
3430
|
+
interface ReceiptCreatedReceiptInfoOneOf {
|
|
3293
3431
|
/** Receipt created by Wix */
|
|
3294
3432
|
wixReceipt?: WixReceipt;
|
|
3295
3433
|
/** Receipt created by an external system. */
|
|
3296
3434
|
externalReceipt?: ExternalReceipt;
|
|
3297
3435
|
}
|
|
3298
|
-
|
|
3436
|
+
interface WixReceipt {
|
|
3299
3437
|
/**
|
|
3300
3438
|
* Receipt ID
|
|
3301
3439
|
* @format GUID
|
|
@@ -3308,7 +3446,7 @@ export interface WixReceipt {
|
|
|
3308
3446
|
*/
|
|
3309
3447
|
displayNumber?: string | null;
|
|
3310
3448
|
}
|
|
3311
|
-
|
|
3449
|
+
interface ExternalReceipt {
|
|
3312
3450
|
/**
|
|
3313
3451
|
* Receipt ID
|
|
3314
3452
|
* @maxLength 100
|
|
@@ -3321,7 +3459,7 @@ export interface ExternalReceipt {
|
|
|
3321
3459
|
*/
|
|
3322
3460
|
displayNumber?: string | null;
|
|
3323
3461
|
}
|
|
3324
|
-
|
|
3462
|
+
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
3325
3463
|
/** Receipt created by Wix */
|
|
3326
3464
|
wixReceipt?: WixReceipt;
|
|
3327
3465
|
/** Receipt created by an external system. */
|
|
@@ -3333,13 +3471,13 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
3333
3471
|
paymentId?: string;
|
|
3334
3472
|
}
|
|
3335
3473
|
/** @oneof */
|
|
3336
|
-
|
|
3474
|
+
interface ReceiptSentReceiptInfoOneOf {
|
|
3337
3475
|
/** Receipt created by Wix */
|
|
3338
3476
|
wixReceipt?: WixReceipt;
|
|
3339
3477
|
/** Receipt created by an external system. */
|
|
3340
3478
|
externalReceipt?: ExternalReceipt;
|
|
3341
3479
|
}
|
|
3342
|
-
|
|
3480
|
+
declare enum ActivityType {
|
|
3343
3481
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
3344
3482
|
ORDER_PLACED = "ORDER_PLACED",
|
|
3345
3483
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -3377,14 +3515,14 @@ export declare enum ActivityType {
|
|
|
3377
3515
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
3378
3516
|
}
|
|
3379
3517
|
/** @enumType */
|
|
3380
|
-
|
|
3381
|
-
|
|
3518
|
+
type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
|
|
3519
|
+
declare enum AttributionSource {
|
|
3382
3520
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3383
3521
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
3384
3522
|
}
|
|
3385
3523
|
/** @enumType */
|
|
3386
|
-
|
|
3387
|
-
|
|
3524
|
+
type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
|
|
3525
|
+
interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3388
3526
|
/**
|
|
3389
3527
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3390
3528
|
* For example, via POS (point of service).
|
|
@@ -3408,7 +3546,7 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
3408
3546
|
appId?: string;
|
|
3409
3547
|
}
|
|
3410
3548
|
/** @oneof */
|
|
3411
|
-
|
|
3549
|
+
interface V1CreatedByStringOneOf {
|
|
3412
3550
|
/**
|
|
3413
3551
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3414
3552
|
* For example, via POS (point of service).
|
|
@@ -3431,7 +3569,7 @@ export interface V1CreatedByStringOneOf {
|
|
|
3431
3569
|
*/
|
|
3432
3570
|
appId?: string;
|
|
3433
3571
|
}
|
|
3434
|
-
|
|
3572
|
+
interface ChannelInfo {
|
|
3435
3573
|
/** Sales channel that submitted the order. */
|
|
3436
3574
|
type?: ChannelTypeWithLiterals;
|
|
3437
3575
|
/**
|
|
@@ -3445,7 +3583,7 @@ export interface ChannelInfo {
|
|
|
3445
3583
|
*/
|
|
3446
3584
|
externalOrderUrl?: string | null;
|
|
3447
3585
|
}
|
|
3448
|
-
|
|
3586
|
+
declare enum ChannelType {
|
|
3449
3587
|
/** Unspecified sales channel. This value is not supported. */
|
|
3450
3588
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3451
3589
|
/** A web client. */
|
|
@@ -3480,8 +3618,8 @@ export declare enum ChannelType {
|
|
|
3480
3618
|
FAIRE_COM = "FAIRE_COM"
|
|
3481
3619
|
}
|
|
3482
3620
|
/** @enumType */
|
|
3483
|
-
|
|
3484
|
-
|
|
3621
|
+
type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
3622
|
+
interface CustomField {
|
|
3485
3623
|
/** Custom field value. */
|
|
3486
3624
|
value?: any;
|
|
3487
3625
|
/**
|
|
@@ -3497,7 +3635,7 @@ export interface CustomField {
|
|
|
3497
3635
|
*/
|
|
3498
3636
|
translatedTitle?: string | null;
|
|
3499
3637
|
}
|
|
3500
|
-
|
|
3638
|
+
interface V1BalanceSummary {
|
|
3501
3639
|
/**
|
|
3502
3640
|
* Current amount left to pay.
|
|
3503
3641
|
* @readonly
|
|
@@ -3520,13 +3658,19 @@ export interface V1BalanceSummary {
|
|
|
3520
3658
|
* @readonly
|
|
3521
3659
|
*/
|
|
3522
3660
|
authorized?: Price;
|
|
3661
|
+
/**
|
|
3662
|
+
* Sum of all pending refund transactions.
|
|
3663
|
+
* @internal
|
|
3664
|
+
* @readonly
|
|
3665
|
+
*/
|
|
3666
|
+
pendingRefund?: Price;
|
|
3523
3667
|
/**
|
|
3524
3668
|
* Sum of all pending transactions.
|
|
3525
3669
|
* @readonly
|
|
3526
3670
|
*/
|
|
3527
3671
|
pending?: Price;
|
|
3528
3672
|
}
|
|
3529
|
-
|
|
3673
|
+
interface FulfillmentStatusesAggregate {
|
|
3530
3674
|
/** Unique string values based on Fulfillment entities statuses */
|
|
3531
3675
|
statuses?: string[] | null;
|
|
3532
3676
|
}
|
|
@@ -3552,13 +3696,13 @@ export interface FulfillmentStatusesAggregate {
|
|
|
3552
3696
|
* }
|
|
3553
3697
|
* }
|
|
3554
3698
|
*/
|
|
3555
|
-
|
|
3699
|
+
interface Tags {
|
|
3556
3700
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
3557
3701
|
privateTags?: TagList;
|
|
3558
3702
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
3559
3703
|
tags?: TagList;
|
|
3560
3704
|
}
|
|
3561
|
-
|
|
3705
|
+
interface TagList {
|
|
3562
3706
|
/**
|
|
3563
3707
|
* List of tag IDs
|
|
3564
3708
|
* @maxSize 100
|
|
@@ -3566,7 +3710,7 @@ export interface TagList {
|
|
|
3566
3710
|
*/
|
|
3567
3711
|
tagIds?: string[];
|
|
3568
3712
|
}
|
|
3569
|
-
|
|
3713
|
+
interface CreateOrderFromDraftRequest {
|
|
3570
3714
|
/**
|
|
3571
3715
|
* Draft order ID.
|
|
3572
3716
|
* @format GUID
|
|
@@ -3582,11 +3726,11 @@ export interface CreateOrderFromDraftRequest {
|
|
|
3582
3726
|
/** Information about the sales channel that submitted this order. */
|
|
3583
3727
|
channelInfo?: ChannelInfo;
|
|
3584
3728
|
}
|
|
3585
|
-
|
|
3729
|
+
interface OrderCreateSettings {
|
|
3586
3730
|
/** Notification settings to be applied on order creation */
|
|
3587
3731
|
notifications?: OrderCreateNotifications;
|
|
3588
3732
|
}
|
|
3589
|
-
|
|
3733
|
+
interface OrderCreateNotifications {
|
|
3590
3734
|
/**
|
|
3591
3735
|
* Whether to send notification to the buyer.
|
|
3592
3736
|
*
|
|
@@ -3600,26 +3744,26 @@ export interface OrderCreateNotifications {
|
|
|
3600
3744
|
*/
|
|
3601
3745
|
sendNotificationsToBusiness?: boolean | null;
|
|
3602
3746
|
}
|
|
3603
|
-
|
|
3747
|
+
interface CreateOrderFromDraftResponse {
|
|
3604
3748
|
/** Draft order after commit. */
|
|
3605
3749
|
committedDraftOrder?: DraftOrder;
|
|
3606
3750
|
/** Created order. */
|
|
3607
3751
|
createdOrder?: Order;
|
|
3608
3752
|
}
|
|
3609
|
-
|
|
3753
|
+
interface DeleteDraftOrderRequest {
|
|
3610
3754
|
/**
|
|
3611
3755
|
* Draft order ID.
|
|
3612
3756
|
* @format GUID
|
|
3613
3757
|
*/
|
|
3614
3758
|
draftOrderId: string;
|
|
3615
3759
|
}
|
|
3616
|
-
|
|
3760
|
+
interface DeleteDraftOrderResponse {
|
|
3617
3761
|
}
|
|
3618
|
-
|
|
3762
|
+
interface QueryDraftOrdersRequest {
|
|
3619
3763
|
/** Query options. */
|
|
3620
3764
|
query?: CursorQuery;
|
|
3621
3765
|
}
|
|
3622
|
-
|
|
3766
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3623
3767
|
/**
|
|
3624
3768
|
* Cursor paging options.
|
|
3625
3769
|
*
|
|
@@ -3641,7 +3785,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3641
3785
|
sort?: Sorting[];
|
|
3642
3786
|
}
|
|
3643
3787
|
/** @oneof */
|
|
3644
|
-
|
|
3788
|
+
interface CursorQueryPagingMethodOneOf {
|
|
3645
3789
|
/**
|
|
3646
3790
|
* Cursor paging options.
|
|
3647
3791
|
*
|
|
@@ -3649,7 +3793,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
3649
3793
|
*/
|
|
3650
3794
|
cursorPaging?: CursorPaging;
|
|
3651
3795
|
}
|
|
3652
|
-
|
|
3796
|
+
interface Sorting {
|
|
3653
3797
|
/**
|
|
3654
3798
|
* Name of the field to sort by.
|
|
3655
3799
|
* @maxLength 512
|
|
@@ -3658,13 +3802,13 @@ export interface Sorting {
|
|
|
3658
3802
|
/** Sort order. */
|
|
3659
3803
|
order?: SortOrderWithLiterals;
|
|
3660
3804
|
}
|
|
3661
|
-
|
|
3805
|
+
declare enum SortOrder {
|
|
3662
3806
|
ASC = "ASC",
|
|
3663
3807
|
DESC = "DESC"
|
|
3664
3808
|
}
|
|
3665
3809
|
/** @enumType */
|
|
3666
|
-
|
|
3667
|
-
|
|
3810
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
3811
|
+
interface CursorPaging {
|
|
3668
3812
|
/**
|
|
3669
3813
|
* Maximum number of items to return in the results.
|
|
3670
3814
|
* @max 100
|
|
@@ -3679,13 +3823,13 @@ export interface CursorPaging {
|
|
|
3679
3823
|
*/
|
|
3680
3824
|
cursor?: string | null;
|
|
3681
3825
|
}
|
|
3682
|
-
|
|
3826
|
+
interface QueryDraftOrdersResponse {
|
|
3683
3827
|
/** Draft orders, found by query. */
|
|
3684
3828
|
draftOrders?: DraftOrder[];
|
|
3685
3829
|
/** Paging metadata. */
|
|
3686
3830
|
pagingMetadata?: CursorPagingMetadata;
|
|
3687
3831
|
}
|
|
3688
|
-
|
|
3832
|
+
interface CursorPagingMetadata {
|
|
3689
3833
|
/** Number of items returned in current page. */
|
|
3690
3834
|
count?: number | null;
|
|
3691
3835
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -3698,7 +3842,7 @@ export interface CursorPagingMetadata {
|
|
|
3698
3842
|
*/
|
|
3699
3843
|
hasNext?: boolean | null;
|
|
3700
3844
|
}
|
|
3701
|
-
|
|
3845
|
+
interface Cursors {
|
|
3702
3846
|
/**
|
|
3703
3847
|
* Cursor string pointing to the next page in the list of results.
|
|
3704
3848
|
* @maxLength 16000
|
|
@@ -3710,19 +3854,19 @@ export interface Cursors {
|
|
|
3710
3854
|
*/
|
|
3711
3855
|
prev?: string | null;
|
|
3712
3856
|
}
|
|
3713
|
-
|
|
3857
|
+
interface UpdateExtendedFieldsRequest {
|
|
3714
3858
|
/** ID of the entity to update. */
|
|
3715
|
-
|
|
3859
|
+
_id: string;
|
|
3716
3860
|
/** Identifier for the app whose extended fields are being updated. */
|
|
3717
3861
|
namespace: string;
|
|
3718
3862
|
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
3719
3863
|
namespaceData: Record<string, any> | null;
|
|
3720
3864
|
}
|
|
3721
|
-
|
|
3865
|
+
interface UpdateExtendedFieldsResponse {
|
|
3722
3866
|
/** Updated draft order. */
|
|
3723
3867
|
draftOrder?: DraftOrder;
|
|
3724
3868
|
}
|
|
3725
|
-
|
|
3869
|
+
interface SetTaxExemptionRequest {
|
|
3726
3870
|
/**
|
|
3727
3871
|
* Draft order ID.
|
|
3728
3872
|
* @format GUID
|
|
@@ -3735,11 +3879,11 @@ export interface SetTaxExemptionRequest {
|
|
|
3735
3879
|
*/
|
|
3736
3880
|
taxExempt: boolean | null;
|
|
3737
3881
|
}
|
|
3738
|
-
|
|
3882
|
+
interface SetTaxExemptionResponse {
|
|
3739
3883
|
/** Draft order calculated with the latest changes. */
|
|
3740
3884
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3741
3885
|
}
|
|
3742
|
-
|
|
3886
|
+
interface SetBusinessLocationRequest {
|
|
3743
3887
|
/**
|
|
3744
3888
|
* Draft order ID.
|
|
3745
3889
|
* @format GUID
|
|
@@ -3748,17 +3892,17 @@ export interface SetBusinessLocationRequest {
|
|
|
3748
3892
|
/** Business location. */
|
|
3749
3893
|
businessLocation?: Location;
|
|
3750
3894
|
}
|
|
3751
|
-
|
|
3895
|
+
interface SetBusinessLocationResponse {
|
|
3752
3896
|
/** Draft order calculated with the latest changes. */
|
|
3753
3897
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3754
3898
|
}
|
|
3755
|
-
|
|
3899
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3756
3900
|
createdEvent?: EntityCreatedEvent;
|
|
3757
3901
|
updatedEvent?: EntityUpdatedEvent;
|
|
3758
3902
|
deletedEvent?: EntityDeletedEvent;
|
|
3759
3903
|
actionEvent?: ActionEvent;
|
|
3760
3904
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3761
|
-
|
|
3905
|
+
_id?: string;
|
|
3762
3906
|
/**
|
|
3763
3907
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3764
3908
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -3787,36 +3931,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3787
3931
|
entityEventSequence?: string | null;
|
|
3788
3932
|
}
|
|
3789
3933
|
/** @oneof */
|
|
3790
|
-
|
|
3934
|
+
interface DomainEventBodyOneOf {
|
|
3791
3935
|
createdEvent?: EntityCreatedEvent;
|
|
3792
3936
|
updatedEvent?: EntityUpdatedEvent;
|
|
3793
3937
|
deletedEvent?: EntityDeletedEvent;
|
|
3794
3938
|
actionEvent?: ActionEvent;
|
|
3795
3939
|
}
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3799
|
-
restoreInfo?: RestoreInfo;
|
|
3940
|
+
interface EntityCreatedEvent {
|
|
3941
|
+
entity?: string;
|
|
3800
3942
|
}
|
|
3801
|
-
|
|
3943
|
+
interface RestoreInfo {
|
|
3802
3944
|
deletedDate?: Date | null;
|
|
3803
3945
|
}
|
|
3804
|
-
|
|
3946
|
+
interface EntityUpdatedEvent {
|
|
3805
3947
|
/**
|
|
3806
3948
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3807
3949
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3808
3950
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3809
3951
|
*/
|
|
3810
|
-
|
|
3952
|
+
currentEntity?: string;
|
|
3811
3953
|
}
|
|
3812
|
-
|
|
3954
|
+
interface EntityDeletedEvent {
|
|
3813
3955
|
/** Entity that was deleted. */
|
|
3814
|
-
|
|
3956
|
+
deletedEntity?: string | null;
|
|
3815
3957
|
}
|
|
3816
|
-
|
|
3817
|
-
|
|
3958
|
+
interface ActionEvent {
|
|
3959
|
+
body?: string;
|
|
3818
3960
|
}
|
|
3819
|
-
|
|
3961
|
+
interface MessageEnvelope {
|
|
3820
3962
|
/**
|
|
3821
3963
|
* App instance ID.
|
|
3822
3964
|
* @format GUID
|
|
@@ -3832,7 +3974,7 @@ export interface MessageEnvelope {
|
|
|
3832
3974
|
/** Stringify payload. */
|
|
3833
3975
|
data?: string;
|
|
3834
3976
|
}
|
|
3835
|
-
|
|
3977
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3836
3978
|
/**
|
|
3837
3979
|
* ID of a site visitor that has not logged in to the site.
|
|
3838
3980
|
* @format GUID
|
|
@@ -3857,7 +3999,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3857
3999
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3858
4000
|
}
|
|
3859
4001
|
/** @oneof */
|
|
3860
|
-
|
|
4002
|
+
interface IdentificationDataIdOneOf {
|
|
3861
4003
|
/**
|
|
3862
4004
|
* ID of a site visitor that has not logged in to the site.
|
|
3863
4005
|
* @format GUID
|
|
@@ -3879,7 +4021,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
3879
4021
|
*/
|
|
3880
4022
|
appId?: string;
|
|
3881
4023
|
}
|
|
3882
|
-
|
|
4024
|
+
declare enum WebhookIdentityType {
|
|
3883
4025
|
UNKNOWN = "UNKNOWN",
|
|
3884
4026
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3885
4027
|
MEMBER = "MEMBER",
|
|
@@ -3887,4 +4029,240 @@ export declare enum WebhookIdentityType {
|
|
|
3887
4029
|
APP = "APP"
|
|
3888
4030
|
}
|
|
3889
4031
|
/** @enumType */
|
|
3890
|
-
|
|
4032
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4033
|
+
interface BaseEventMetadata {
|
|
4034
|
+
/**
|
|
4035
|
+
* App instance ID.
|
|
4036
|
+
* @format GUID
|
|
4037
|
+
*/
|
|
4038
|
+
instanceId?: string | null;
|
|
4039
|
+
/**
|
|
4040
|
+
* Event type.
|
|
4041
|
+
* @maxLength 150
|
|
4042
|
+
*/
|
|
4043
|
+
eventType?: string;
|
|
4044
|
+
/** The identification type and identity data. */
|
|
4045
|
+
identity?: IdentificationData;
|
|
4046
|
+
}
|
|
4047
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
4048
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
4049
|
+
_id?: string;
|
|
4050
|
+
/**
|
|
4051
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
4052
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
4053
|
+
*/
|
|
4054
|
+
entityFqdn?: string;
|
|
4055
|
+
/**
|
|
4056
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
4057
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
4058
|
+
*/
|
|
4059
|
+
slug?: string;
|
|
4060
|
+
/** ID of the entity associated with the event. */
|
|
4061
|
+
entityId?: string;
|
|
4062
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
4063
|
+
eventTime?: Date | null;
|
|
4064
|
+
/**
|
|
4065
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
4066
|
+
* (for example, GDPR).
|
|
4067
|
+
*/
|
|
4068
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
4069
|
+
/** If present, indicates the action that triggered the event. */
|
|
4070
|
+
originatedFrom?: string | null;
|
|
4071
|
+
/**
|
|
4072
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
4073
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
4074
|
+
*/
|
|
4075
|
+
entityEventSequence?: string | null;
|
|
4076
|
+
}
|
|
4077
|
+
interface DraftOrderCreatedEnvelope {
|
|
4078
|
+
entity: DraftOrder;
|
|
4079
|
+
metadata: EventMetadata;
|
|
4080
|
+
}
|
|
4081
|
+
interface DraftOrderDeletedEnvelope {
|
|
4082
|
+
metadata: EventMetadata;
|
|
4083
|
+
}
|
|
4084
|
+
interface DraftOrderUpdatedEnvelope {
|
|
4085
|
+
entity: DraftOrder;
|
|
4086
|
+
metadata: EventMetadata;
|
|
4087
|
+
}
|
|
4088
|
+
interface AddLineItemsToDraftOrderOptions {
|
|
4089
|
+
/**
|
|
4090
|
+
* Catalog line items to add to draft order.
|
|
4091
|
+
* @maxSize 300
|
|
4092
|
+
*/
|
|
4093
|
+
catalogLineItems?: CatalogReferenceLineItem[];
|
|
4094
|
+
/**
|
|
4095
|
+
* Custom line items to add to draft order.
|
|
4096
|
+
*
|
|
4097
|
+
* Custom line items do not trigger the Catalog Service Plugin.
|
|
4098
|
+
* @maxSize 300
|
|
4099
|
+
*/
|
|
4100
|
+
customLineItems?: CustomLineItem[];
|
|
4101
|
+
}
|
|
4102
|
+
interface CreateCustomDiscountsOptions {
|
|
4103
|
+
/**
|
|
4104
|
+
* Custom discounts to create.
|
|
4105
|
+
*
|
|
4106
|
+
* Created discounts are not applied by default.
|
|
4107
|
+
* @minSize 1
|
|
4108
|
+
* @maxSize 100
|
|
4109
|
+
*/
|
|
4110
|
+
discounts?: DiscountOption[];
|
|
4111
|
+
}
|
|
4112
|
+
interface CreateCustomAdditionalFeesOptions {
|
|
4113
|
+
/**
|
|
4114
|
+
* Custom additional fees to create.
|
|
4115
|
+
*
|
|
4116
|
+
* Created additional fees are not applied by default.
|
|
4117
|
+
* @minSize 1
|
|
4118
|
+
* @maxSize 100
|
|
4119
|
+
*/
|
|
4120
|
+
customAdditionalFees?: AdditionalFeeOption[];
|
|
4121
|
+
}
|
|
4122
|
+
interface SetShippingInfoOptions {
|
|
4123
|
+
/**
|
|
4124
|
+
* Shipping info to set on the draft order.
|
|
4125
|
+
*
|
|
4126
|
+
* > **Note:** Passing an empty object will remove the existing shipping info.
|
|
4127
|
+
*/
|
|
4128
|
+
shippingInfo?: V1ShippingInformation;
|
|
4129
|
+
}
|
|
4130
|
+
interface SetBuyerInfoOptions {
|
|
4131
|
+
/**
|
|
4132
|
+
* Shipping info to set on the draft order.
|
|
4133
|
+
*
|
|
4134
|
+
* > **Note:** Passing an empty object will remove the existing shipping info.
|
|
4135
|
+
*/
|
|
4136
|
+
buyerInfo?: BuyerInfo;
|
|
4137
|
+
}
|
|
4138
|
+
interface SetRecipientInfoOptions {
|
|
4139
|
+
/**
|
|
4140
|
+
* Recipient address and contact details.
|
|
4141
|
+
*
|
|
4142
|
+
* > **Note:** Passing an empty object will remove the existing recipient info.
|
|
4143
|
+
*/
|
|
4144
|
+
recipientInfo?: AddressWithContact;
|
|
4145
|
+
}
|
|
4146
|
+
interface SetBillingInfoOptions {
|
|
4147
|
+
/**
|
|
4148
|
+
* Billing address and contact details.
|
|
4149
|
+
*
|
|
4150
|
+
* > **Note:** Passing an empty object will remove the existing billing info.
|
|
4151
|
+
*/
|
|
4152
|
+
billingInfo?: AddressWithContact;
|
|
4153
|
+
}
|
|
4154
|
+
interface CommitDraftOrderOptions {
|
|
4155
|
+
/** Optional side effects to trigger. */
|
|
4156
|
+
commitSettings?: DraftOrderCommitSettings;
|
|
4157
|
+
/**
|
|
4158
|
+
* Reason for edit, provided by user (optional).
|
|
4159
|
+
* @maxLength 200
|
|
4160
|
+
*/
|
|
4161
|
+
reason?: string | null;
|
|
4162
|
+
}
|
|
4163
|
+
interface CreateOrderFromDraftOptions {
|
|
4164
|
+
/** Optional side effects to trigger. */
|
|
4165
|
+
createSettings?: OrderCreateSettings;
|
|
4166
|
+
/**
|
|
4167
|
+
* Reason for order creation, provided by user (optional).
|
|
4168
|
+
* @maxLength 200
|
|
4169
|
+
*/
|
|
4170
|
+
reason?: string | null;
|
|
4171
|
+
/** Information about the sales channel that submitted this order. */
|
|
4172
|
+
channelInfo?: ChannelInfo;
|
|
4173
|
+
}
|
|
4174
|
+
interface QueryCursorResult {
|
|
4175
|
+
cursors: Cursors;
|
|
4176
|
+
hasNext: () => boolean;
|
|
4177
|
+
hasPrev: () => boolean;
|
|
4178
|
+
length: number;
|
|
4179
|
+
pageSize: number;
|
|
4180
|
+
}
|
|
4181
|
+
interface DraftOrdersQueryResult extends QueryCursorResult {
|
|
4182
|
+
items: DraftOrder[];
|
|
4183
|
+
query: DraftOrdersQueryBuilder;
|
|
4184
|
+
next: () => Promise<DraftOrdersQueryResult>;
|
|
4185
|
+
prev: () => Promise<DraftOrdersQueryResult>;
|
|
4186
|
+
}
|
|
4187
|
+
interface DraftOrdersQueryBuilder {
|
|
4188
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4189
|
+
* @param value - Value to compare against.
|
|
4190
|
+
* @documentationMaturity preview
|
|
4191
|
+
*/
|
|
4192
|
+
eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
4193
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4194
|
+
* @param value - Value to compare against.
|
|
4195
|
+
* @documentationMaturity preview
|
|
4196
|
+
*/
|
|
4197
|
+
ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
4198
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4199
|
+
* @param value - Value to compare against.
|
|
4200
|
+
* @documentationMaturity preview
|
|
4201
|
+
*/
|
|
4202
|
+
ge: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4203
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4204
|
+
* @param value - Value to compare against.
|
|
4205
|
+
* @documentationMaturity preview
|
|
4206
|
+
*/
|
|
4207
|
+
gt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4208
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4209
|
+
* @param value - Value to compare against.
|
|
4210
|
+
* @documentationMaturity preview
|
|
4211
|
+
*/
|
|
4212
|
+
le: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4213
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4214
|
+
* @param value - Value to compare against.
|
|
4215
|
+
* @documentationMaturity preview
|
|
4216
|
+
*/
|
|
4217
|
+
lt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4218
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
4219
|
+
* @param string - String to compare against. Case-insensitive.
|
|
4220
|
+
* @documentationMaturity preview
|
|
4221
|
+
*/
|
|
4222
|
+
startsWith: (propertyName: 'orderId', value: string) => DraftOrdersQueryBuilder;
|
|
4223
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
4224
|
+
* @param values - List of values to compare against.
|
|
4225
|
+
* @documentationMaturity preview
|
|
4226
|
+
*/
|
|
4227
|
+
hasSome: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;
|
|
4228
|
+
/** @documentationMaturity preview */
|
|
4229
|
+
in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
4230
|
+
/** @documentationMaturity preview */
|
|
4231
|
+
exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;
|
|
4232
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
4233
|
+
* @documentationMaturity preview
|
|
4234
|
+
*/
|
|
4235
|
+
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
4236
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
4237
|
+
* @documentationMaturity preview
|
|
4238
|
+
*/
|
|
4239
|
+
descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
4240
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
4241
|
+
* @documentationMaturity preview
|
|
4242
|
+
*/
|
|
4243
|
+
limit: (limit: number) => DraftOrdersQueryBuilder;
|
|
4244
|
+
/** @param cursor - A pointer to specific record
|
|
4245
|
+
* @documentationMaturity preview
|
|
4246
|
+
*/
|
|
4247
|
+
skipTo: (cursor: string) => DraftOrdersQueryBuilder;
|
|
4248
|
+
/** @documentationMaturity preview */
|
|
4249
|
+
find: () => Promise<DraftOrdersQueryResult>;
|
|
4250
|
+
}
|
|
4251
|
+
interface UpdateExtendedFieldsOptions {
|
|
4252
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
4253
|
+
namespaceData: Record<string, any> | null;
|
|
4254
|
+
}
|
|
4255
|
+
interface SetTaxExemptionOptions {
|
|
4256
|
+
/**
|
|
4257
|
+
* Whether the draft order is exempt from tax calculations.
|
|
4258
|
+
*
|
|
4259
|
+
* Default: `false`
|
|
4260
|
+
*/
|
|
4261
|
+
taxExempt: boolean | null;
|
|
4262
|
+
}
|
|
4263
|
+
interface SetBusinessLocationOptions {
|
|
4264
|
+
/** Business location. */
|
|
4265
|
+
businessLocation?: Location;
|
|
4266
|
+
}
|
|
4267
|
+
|
|
4268
|
+
export { PickupMethod as $, type AddLineItemsToDraftOrderOptions as A, type SetBusinessLocationOptions as B, type CreateDraftOrderResponse as C, type DeleteCustomDiscountsResponse as D, type SetBusinessLocationResponse as E, type DraftOrderCreatedEnvelope as F, type GetDraftOrderResponse as G, type DraftOrderDeletedEnvelope as H, type IdAndApplied as I, type DraftOrderUpdatedEnvelope as J, DescriptionLineType as K, type LineItemChangeDetails as L, ItemTypeItemType as M, JurisdictionType as N, SubscriptionFrequency as O, PaymentOptionType as P, AdjustmentType as Q, PickupDetailsPickupMethod as R, type SetDiscountsResponse as S, TaxableAddressType as T, type UpdateLineItemsResponse as U, VatType as V, SourceType as W, AppliedDiscountDiscountType as X, DiscountReason as Y, EditingStatus as Z, WeightUnit as _, type CreateEmptyDraftOrderResponse as a, type V1DeliveryTimeSlot as a$, RuleType as a0, FileType as a1, DiscountType as a2, NonDraftableReason as a3, PaymentStatus as a4, FulfillmentStatus as a5, OrderStatus as a6, LineItemQuantityChangeType as a7, ActivityType as a8, AttributionSource as a9, type SubscriptionTitle as aA, type SubscriptionDescription as aB, type SubscriptionSettings as aC, type FreeTrialPeriod as aD, type BillingAdjustment as aE, type BillingAdjustmentPriceSummary as aF, type LocationAndQuantity as aG, type TaxableAddress as aH, type TaxableAddressTaxableAddressDataOneOf as aI, type ExtendedFields as aJ, type ModifierGroup as aK, type TranslatableString as aL, type ItemModifier as aM, type ItemChangedDetails as aN, type ShippingDetails as aO, type ShippingDetailsChangeTypeOneOf as aP, type V1ShippingInformation as aQ, type V1DeliveryLogistics as aR, type V1DeliveryLogisticsAddressOneOf as aS, type AddressWithContact as aT, type Address as aU, type StreetAddress as aV, type AddressLocation as aW, type FullAddressContactDetails as aX, type VatId as aY, type V1PickupDetails as aZ, type PickupAddress as a_, ChannelType as aa, SortOrder as ab, WebhookIdentityType as ac, type DraftOrder as ad, type ItemDetails as ae, type ItemDetailsChangeTypeOneOf as af, type Price as ag, type PriceDescription as ah, type OrderLineItem as ai, type ProductName as aj, type CatalogReference as ak, type DescriptionLine as al, type DescriptionLineValueOneOf as am, type DescriptionLineDescriptionLineValueOneOf as an, type DescriptionLineName as ao, type PlainTextValue as ap, type Color as aq, type FocalPoint as ar, type PhysicalProperties as as, type ItemType as at, type ItemTypeItemTypeDataOneOf as au, type ItemTaxFullDetails as av, type LineItemTaxInfo as aw, type LineItemTaxBreakdown as ax, type DigitalFile as ay, type SubscriptionInfo as az, type AddLineItemsToDraftOrderResponse as b, type SetDiscountsRequest as b$, type V1ShippingPrice as b0, type ShippingRegion as b1, type ShippingChangedDetails as b2, type BuyerInfo as b3, type BuyerInfoIdOneOf as b4, type AdditionalFeeDetails as b5, type AdditionalFee as b6, type TaxDetails as b7, type DiscountDetails as b8, type AppliedDiscount as b9, type BusinessLocationDetails as bA, type BusinessLocationDetailsChangeTypeOneOf as bB, type Location as bC, type BusinessLocationChangedDetails as bD, type CreateDraftOrderRequest as bE, type CalculatedDraftOrder as bF, type ShippingOption as bG, type DeliveryLogistics as bH, type PickupDetails as bI, type DeliveryTimeSlot as bJ, type ShippingPrice as bK, type CalculationErrors as bL, type CalculationErrorsShippingCalculationErrorOneOf as bM, type Details as bN, type DetailsKindOneOf as bO, type ApplicationError as bP, type ValidationError as bQ, type FieldViolation as bR, type SystemError as bS, type CarrierErrors as bT, type CarrierError as bU, type CreateEmptyDraftOrderRequest as bV, type AddLineItemsToDraftOrderRequest as bW, type CatalogReferenceLineItem as bX, type CustomLineItem as bY, type SecuredMedia as bZ, type UpdateLineItemsRequest as b_, type AppliedDiscountDiscountSourceOneOf as ba, type Coupon as bb, type MerchantDiscount as bc, type MerchantDiscountMerchantDiscountReasonOneOf as bd, type DiscountRule as be, type DiscountRuleName as bf, type LineItemDiscount as bg, type CreatedBy as bh, type CreatedByStringOneOf as bi, type PriceSummary as bj, type TaxSummary as bk, type BalanceSummary as bl, type Balance as bm, type DraftOrderCommitSettings as bn, type InventoryUpdate as bo, type RecipientInfoDetails as bp, type RecipientInfoDetailsChangeTypeOneOf as bq, type RecipientInfoChangedDetails as br, type OrderTaxInfo as bs, type OrderTaxBreakdown as bt, type BuyerDetails as bu, type BuyerDetailsChangeTypeOneOf as bv, type BuyerChangedDetails as bw, type BillingDetails as bx, type BillingDetailsChangeTypeOneOf as by, type BillingChangedDetails as bz, type CreateCustomDiscountsOptions as c, type ReceiptCreated as c$, type CreateCustomDiscountsRequest as c0, type DiscountOption as c1, type DiscountOptionDiscountAmountOneOf as c2, type DeleteCustomDiscountsRequest as c3, type SetAdditionalFeesRequest as c4, type CreateCustomAdditionalFeesRequest as c5, type AdditionalFeeOption as c6, type DeleteCustomAdditionalFeesRequest as c7, type SetShippingInfoRequest as c8, type SetBuyerInfoRequest as c9, type LineItemAmount as cA, type ManagedAdditionalFee as cB, type TotalPriceChange as cC, type ShippingInformationChange as cD, type ShippingInformation as cE, type SavedPaymentMethod as cF, type AuthorizedPaymentCreated as cG, type AuthorizedPaymentCaptured as cH, type AuthorizedPaymentVoided as cI, type RefundInitiated as cJ, type RefundedPayment as cK, type RefundedPaymentKindOneOf as cL, type RegularPaymentRefund as cM, type GiftCardPaymentRefund as cN, type MembershipPaymentRefund as cO, type PaymentRefunded as cP, type PaymentRefundFailed as cQ, type RefundedAsStoreCredit as cR, type PaymentPending as cS, type PaymentPendingPaymentDetailsOneOf as cT, type RegularPayment as cU, type RegularPaymentPaymentMethodDetailsOneOf as cV, type CreditCardDetails as cW, type PaymentCanceled as cX, type PaymentCanceledPaymentDetailsOneOf as cY, type PaymentDeclined as cZ, type PaymentDeclinedPaymentDetailsOneOf as c_, type SetRecipientInfoRequest as ca, type SetBillingInfoRequest as cb, type UpdateShippingInfoRequest as cc, type UpdateShippingInfoResponse as cd, type GetDraftOrderRequest as ce, type GetOrderDraftabilityStatusRequest as cf, type CommitDraftOrderRequest as cg, type Order as ch, type CurrencyConversionDetails as ci, type Activity as cj, type ActivityContentOneOf as ck, type CustomActivity as cl, type MerchantComment as cm, type OrderRefunded as cn, type OrderCreatedFromExchange as co, type NewExchangeOrderCreated as cp, type LineItemExchangeData as cq, type DraftOrderChangesApplied as cr, type OrderChange as cs, type OrderChangeValueOneOf as ct, type LineItemChanges as cu, type LineItemQuantityChange as cv, type LineItemPriceChange as cw, type ManagedLineItem as cx, type ManagedDiscount as cy, type TranslatedValue as cz, type CreateCustomDiscountsResponse as d, type ReceiptCreatedReceiptInfoOneOf as d0, type WixReceipt as d1, type ExternalReceipt as d2, type ReceiptSent as d3, type ReceiptSentReceiptInfoOneOf as d4, type V1CreatedBy as d5, type V1CreatedByStringOneOf as d6, type ChannelInfo as d7, type CustomField as d8, type V1BalanceSummary as d9, type ActionEvent as dA, type MessageEnvelope as dB, type IdentificationData as dC, type IdentificationDataIdOneOf as dD, type BaseEventMetadata as dE, type EventMetadata as dF, type DraftOrdersQueryResult as dG, type FulfillmentStatusesAggregate as da, type Tags as db, type TagList as dc, type CreateOrderFromDraftRequest as dd, type OrderCreateSettings as de, type OrderCreateNotifications as df, type DeleteDraftOrderRequest as dg, type DeleteDraftOrderResponse as dh, type QueryDraftOrdersRequest as di, type CursorQuery as dj, type CursorQueryPagingMethodOneOf as dk, type Sorting as dl, type CursorPaging as dm, type QueryDraftOrdersResponse as dn, type CursorPagingMetadata as dp, type Cursors as dq, type UpdateExtendedFieldsRequest as dr, type SetTaxExemptionRequest as ds, type SetBusinessLocationRequest as dt, type DomainEvent as du, type DomainEventBodyOneOf as dv, type EntityCreatedEvent as dw, type RestoreInfo as dx, type EntityUpdatedEvent as dy, type EntityDeletedEvent as dz, type SetAdditionalFeesResponse as e, type CreateCustomAdditionalFeesOptions as f, type CreateCustomAdditionalFeesResponse as g, type DeleteCustomAdditionalFeesResponse as h, type SetShippingInfoOptions as i, type SetShippingInfoResponse as j, type SetBuyerInfoOptions as k, type SetBuyerInfoResponse as l, type SetRecipientInfoOptions as m, type SetRecipientInfoResponse as n, type SetBillingInfoOptions as o, type SetBillingInfoResponse as p, type GetOrderDraftabilityStatusResponse as q, type CommitDraftOrderOptions as r, type CommitDraftOrderResponse as s, type CreateOrderFromDraftOptions as t, type CreateOrderFromDraftResponse as u, type DraftOrdersQueryBuilder as v, type UpdateExtendedFieldsOptions as w, type UpdateExtendedFieldsResponse as x, type SetTaxExemptionOptions as y, type SetTaxExemptionResponse as z };
|