@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. */
|
|
@@ -315,7 +315,7 @@ export interface OrderLineItem {
|
|
|
315
315
|
*/
|
|
316
316
|
extendedFields?: ExtendedFields;
|
|
317
317
|
}
|
|
318
|
-
|
|
318
|
+
interface ProductName {
|
|
319
319
|
/**
|
|
320
320
|
* __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
321
|
*
|
|
@@ -337,7 +337,7 @@ export interface ProductName {
|
|
|
337
337
|
translated?: string | null;
|
|
338
338
|
}
|
|
339
339
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
340
|
-
|
|
340
|
+
interface CatalogReference {
|
|
341
341
|
/**
|
|
342
342
|
* ID of the item within the catalog it belongs to.
|
|
343
343
|
* @minLength 1
|
|
@@ -363,7 +363,7 @@ export interface CatalogReference {
|
|
|
363
363
|
*/
|
|
364
364
|
options?: Record<string, any> | null;
|
|
365
365
|
}
|
|
366
|
-
|
|
366
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
367
367
|
/** Description line plain text value. */
|
|
368
368
|
plainText?: PlainTextValue;
|
|
369
369
|
/** Description line color value. */
|
|
@@ -372,16 +372,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
372
372
|
name?: DescriptionLineName;
|
|
373
373
|
}
|
|
374
374
|
/** @oneof */
|
|
375
|
-
|
|
375
|
+
interface DescriptionLineValueOneOf {
|
|
376
376
|
/** Description line plain text value. */
|
|
377
377
|
plainText?: PlainTextValue;
|
|
378
378
|
/** Description line color value. */
|
|
379
379
|
colorInfo?: Color;
|
|
380
380
|
}
|
|
381
381
|
/** @oneof */
|
|
382
|
-
|
|
382
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
383
383
|
}
|
|
384
|
-
|
|
384
|
+
interface DescriptionLineName {
|
|
385
385
|
/**
|
|
386
386
|
* 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
387
|
* @maxLength 100
|
|
@@ -395,7 +395,7 @@ export interface DescriptionLineName {
|
|
|
395
395
|
*/
|
|
396
396
|
translated?: string | null;
|
|
397
397
|
}
|
|
398
|
-
|
|
398
|
+
interface PlainTextValue {
|
|
399
399
|
/**
|
|
400
400
|
* 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
401
|
* @maxLength 600
|
|
@@ -409,7 +409,7 @@ export interface PlainTextValue {
|
|
|
409
409
|
*/
|
|
410
410
|
translated?: string | null;
|
|
411
411
|
}
|
|
412
|
-
|
|
412
|
+
interface Color {
|
|
413
413
|
/**
|
|
414
414
|
* 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
415
|
* @maxLength 500
|
|
@@ -425,7 +425,7 @@ export interface Color {
|
|
|
425
425
|
/** HEX or RGB color code for display. */
|
|
426
426
|
code?: string | null;
|
|
427
427
|
}
|
|
428
|
-
|
|
428
|
+
declare enum DescriptionLineType {
|
|
429
429
|
/** Unrecognized type. */
|
|
430
430
|
UNRECOGNISED = "UNRECOGNISED",
|
|
431
431
|
/** Plain text type. */
|
|
@@ -433,32 +433,7 @@ export declare enum DescriptionLineType {
|
|
|
433
433
|
/** Color type. */
|
|
434
434
|
COLOR = "COLOR"
|
|
435
435
|
}
|
|
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 {
|
|
436
|
+
interface FocalPoint {
|
|
462
437
|
/** X-coordinate of the focal point. */
|
|
463
438
|
x?: number;
|
|
464
439
|
/** Y-coordinate of the focal point. */
|
|
@@ -468,7 +443,7 @@ export interface FocalPoint {
|
|
|
468
443
|
/** crop by width */
|
|
469
444
|
width?: number | null;
|
|
470
445
|
}
|
|
471
|
-
|
|
446
|
+
interface PhysicalProperties {
|
|
472
447
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
473
448
|
weight?: number | null;
|
|
474
449
|
/**
|
|
@@ -479,20 +454,20 @@ export interface PhysicalProperties {
|
|
|
479
454
|
/** Whether this line item is shippable. */
|
|
480
455
|
shippable?: boolean;
|
|
481
456
|
}
|
|
482
|
-
|
|
457
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
483
458
|
/** Preset item type. */
|
|
484
459
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
485
460
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
486
461
|
custom?: string;
|
|
487
462
|
}
|
|
488
463
|
/** @oneof */
|
|
489
|
-
|
|
464
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
490
465
|
/** Preset item type. */
|
|
491
466
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
492
467
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
493
468
|
custom?: string;
|
|
494
469
|
}
|
|
495
|
-
|
|
470
|
+
declare enum ItemTypeItemType {
|
|
496
471
|
UNRECOGNISED = "UNRECOGNISED",
|
|
497
472
|
PHYSICAL = "PHYSICAL",
|
|
498
473
|
DIGITAL = "DIGITAL",
|
|
@@ -500,9 +475,9 @@ export declare enum ItemTypeItemType {
|
|
|
500
475
|
SERVICE = "SERVICE"
|
|
501
476
|
}
|
|
502
477
|
/** @enumType */
|
|
503
|
-
|
|
478
|
+
type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
504
479
|
/** Type of selected payment option for catalog item */
|
|
505
|
-
|
|
480
|
+
declare enum PaymentOptionType {
|
|
506
481
|
/** The entire payment for this item happens as part of the checkout. */
|
|
507
482
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
508
483
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -515,8 +490,8 @@ export declare enum PaymentOptionType {
|
|
|
515
490
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
516
491
|
}
|
|
517
492
|
/** @enumType */
|
|
518
|
-
|
|
519
|
-
|
|
493
|
+
type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
494
|
+
interface ItemTaxFullDetails {
|
|
520
495
|
/** Taxable amount of this line item. */
|
|
521
496
|
taxableAmount?: Price;
|
|
522
497
|
/**
|
|
@@ -527,7 +502,7 @@ export interface ItemTaxFullDetails {
|
|
|
527
502
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
528
503
|
totalTax?: Price;
|
|
529
504
|
}
|
|
530
|
-
|
|
505
|
+
interface LineItemTaxInfo {
|
|
531
506
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
532
507
|
taxAmount?: Price;
|
|
533
508
|
/** Amount for which tax is calculated. */
|
|
@@ -555,7 +530,7 @@ export interface LineItemTaxInfo {
|
|
|
555
530
|
* TaxBreakdown represents tax information for a line item.
|
|
556
531
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
557
532
|
*/
|
|
558
|
-
|
|
533
|
+
interface LineItemTaxBreakdown {
|
|
559
534
|
/**
|
|
560
535
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
561
536
|
* @maxLength 200
|
|
@@ -588,7 +563,7 @@ export interface LineItemTaxBreakdown {
|
|
|
588
563
|
taxableAmount?: Price;
|
|
589
564
|
}
|
|
590
565
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
591
|
-
|
|
566
|
+
declare enum JurisdictionType {
|
|
592
567
|
UNDEFINED = "UNDEFINED",
|
|
593
568
|
COUNTRY = "COUNTRY",
|
|
594
569
|
STATE = "STATE",
|
|
@@ -597,8 +572,8 @@ export declare enum JurisdictionType {
|
|
|
597
572
|
SPECIAL = "SPECIAL"
|
|
598
573
|
}
|
|
599
574
|
/** @enumType */
|
|
600
|
-
|
|
601
|
-
|
|
575
|
+
type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
576
|
+
interface DigitalFile {
|
|
602
577
|
/**
|
|
603
578
|
* ID of the secure file in media.
|
|
604
579
|
* @minLength 1
|
|
@@ -618,12 +593,12 @@ export interface DigitalFile {
|
|
|
618
593
|
*/
|
|
619
594
|
expirationDate?: Date | null;
|
|
620
595
|
}
|
|
621
|
-
|
|
596
|
+
interface SubscriptionInfo {
|
|
622
597
|
/**
|
|
623
598
|
* Subscription ID.
|
|
624
599
|
* @format GUID
|
|
625
600
|
*/
|
|
626
|
-
|
|
601
|
+
_id?: string | null;
|
|
627
602
|
/**
|
|
628
603
|
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
629
604
|
* @min 1
|
|
@@ -656,7 +631,7 @@ export interface SubscriptionInfo {
|
|
|
656
631
|
*/
|
|
657
632
|
chargesDescription?: string | null;
|
|
658
633
|
}
|
|
659
|
-
|
|
634
|
+
interface SubscriptionTitle {
|
|
660
635
|
/**
|
|
661
636
|
* 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
637
|
* @minLength 1
|
|
@@ -672,7 +647,7 @@ export interface SubscriptionTitle {
|
|
|
672
647
|
*/
|
|
673
648
|
translated?: string | null;
|
|
674
649
|
}
|
|
675
|
-
|
|
650
|
+
interface SubscriptionDescription {
|
|
676
651
|
/**
|
|
677
652
|
* Subscription option description.
|
|
678
653
|
* @maxLength 500
|
|
@@ -684,7 +659,7 @@ export interface SubscriptionDescription {
|
|
|
684
659
|
*/
|
|
685
660
|
translated?: string | null;
|
|
686
661
|
}
|
|
687
|
-
|
|
662
|
+
interface SubscriptionSettings {
|
|
688
663
|
/** Frequency of recurring payment. */
|
|
689
664
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
690
665
|
/**
|
|
@@ -706,7 +681,7 @@ export interface SubscriptionSettings {
|
|
|
706
681
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
707
682
|
}
|
|
708
683
|
/** Frequency unit of recurring payment */
|
|
709
|
-
|
|
684
|
+
declare enum SubscriptionFrequency {
|
|
710
685
|
UNDEFINED = "UNDEFINED",
|
|
711
686
|
DAY = "DAY",
|
|
712
687
|
WEEK = "WEEK",
|
|
@@ -714,8 +689,8 @@ export declare enum SubscriptionFrequency {
|
|
|
714
689
|
YEAR = "YEAR"
|
|
715
690
|
}
|
|
716
691
|
/** @enumType */
|
|
717
|
-
|
|
718
|
-
|
|
692
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
693
|
+
interface FreeTrialPeriod {
|
|
719
694
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
720
695
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
721
696
|
/**
|
|
@@ -725,13 +700,13 @@ export interface FreeTrialPeriod {
|
|
|
725
700
|
*/
|
|
726
701
|
interval?: number;
|
|
727
702
|
}
|
|
728
|
-
|
|
703
|
+
interface BillingAdjustment {
|
|
729
704
|
/** The type of adjustment. */
|
|
730
705
|
type?: AdjustmentTypeWithLiterals;
|
|
731
706
|
/** Summary of the prorated adjustment amount. */
|
|
732
707
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
733
708
|
}
|
|
734
|
-
|
|
709
|
+
declare enum AdjustmentType {
|
|
735
710
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
736
711
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
737
712
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
@@ -739,8 +714,8 @@ export declare enum AdjustmentType {
|
|
|
739
714
|
CREDIT = "CREDIT"
|
|
740
715
|
}
|
|
741
716
|
/** @enumType */
|
|
742
|
-
|
|
743
|
-
|
|
717
|
+
type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
718
|
+
interface BillingAdjustmentPriceSummary {
|
|
744
719
|
/** Subtotal of adjustment, before tax. */
|
|
745
720
|
subtotal?: Price;
|
|
746
721
|
/** Tax on adjustment. */
|
|
@@ -748,12 +723,12 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
748
723
|
/** Total price after tax. */
|
|
749
724
|
total?: Price;
|
|
750
725
|
}
|
|
751
|
-
|
|
726
|
+
interface LocationAndQuantity {
|
|
752
727
|
/**
|
|
753
728
|
* Location id in the associated owner app.
|
|
754
729
|
* @format GUID
|
|
755
730
|
*/
|
|
756
|
-
|
|
731
|
+
_id?: string;
|
|
757
732
|
/**
|
|
758
733
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
759
734
|
* @format GUID
|
|
@@ -774,24 +749,24 @@ export interface LocationAndQuantity {
|
|
|
774
749
|
*/
|
|
775
750
|
name?: string | null;
|
|
776
751
|
}
|
|
777
|
-
|
|
752
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
778
753
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
779
754
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
780
755
|
}
|
|
781
756
|
/** @oneof */
|
|
782
|
-
|
|
757
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
783
758
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
784
759
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
785
760
|
}
|
|
786
|
-
|
|
761
|
+
declare enum TaxableAddressType {
|
|
787
762
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
788
763
|
BUSINESS = "BUSINESS",
|
|
789
764
|
BILLING = "BILLING",
|
|
790
765
|
SHIPPING = "SHIPPING"
|
|
791
766
|
}
|
|
792
767
|
/** @enumType */
|
|
793
|
-
|
|
794
|
-
|
|
768
|
+
type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
769
|
+
interface ExtendedFields {
|
|
795
770
|
/**
|
|
796
771
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
797
772
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -802,13 +777,13 @@ export interface ExtendedFields {
|
|
|
802
777
|
*/
|
|
803
778
|
namespaces?: Record<string, Record<string, any>>;
|
|
804
779
|
}
|
|
805
|
-
|
|
780
|
+
interface ModifierGroup {
|
|
806
781
|
/**
|
|
807
782
|
* Modifier group id.
|
|
808
783
|
* @minLength 1
|
|
809
784
|
* @maxLength 36
|
|
810
785
|
*/
|
|
811
|
-
|
|
786
|
+
_id?: string;
|
|
812
787
|
/** Modifier group name. */
|
|
813
788
|
name?: TranslatableString;
|
|
814
789
|
/**
|
|
@@ -818,7 +793,7 @@ export interface ModifierGroup {
|
|
|
818
793
|
*/
|
|
819
794
|
modifiers?: ItemModifier[];
|
|
820
795
|
}
|
|
821
|
-
|
|
796
|
+
interface TranslatableString {
|
|
822
797
|
/**
|
|
823
798
|
* __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
799
|
*
|
|
@@ -839,13 +814,13 @@ export interface TranslatableString {
|
|
|
839
814
|
*/
|
|
840
815
|
translated?: string | null;
|
|
841
816
|
}
|
|
842
|
-
|
|
817
|
+
interface ItemModifier {
|
|
843
818
|
/**
|
|
844
819
|
* Modifier ID.
|
|
845
820
|
* @minLength 1
|
|
846
821
|
* @maxLength 36
|
|
847
822
|
*/
|
|
848
|
-
|
|
823
|
+
_id?: string;
|
|
849
824
|
/**
|
|
850
825
|
* The quantity of this modifier.
|
|
851
826
|
* @min 1
|
|
@@ -859,7 +834,7 @@ export interface ItemModifier {
|
|
|
859
834
|
/** The price of the modifier. */
|
|
860
835
|
price?: Price;
|
|
861
836
|
}
|
|
862
|
-
|
|
837
|
+
interface ItemChangedDetails {
|
|
863
838
|
/**
|
|
864
839
|
* Line item quantity before change.
|
|
865
840
|
* @min 1
|
|
@@ -871,7 +846,7 @@ export interface ItemChangedDetails {
|
|
|
871
846
|
/** Line item price description before change. */
|
|
872
847
|
priceDescriptionBeforeChange?: PriceDescription;
|
|
873
848
|
}
|
|
874
|
-
|
|
849
|
+
interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
875
850
|
/** Whether shipping info was added as part of the draft. */
|
|
876
851
|
added?: boolean;
|
|
877
852
|
/** Shipping info before the change. */
|
|
@@ -882,7 +857,7 @@ export interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
|
882
857
|
shippingInfo?: V1ShippingInformation;
|
|
883
858
|
}
|
|
884
859
|
/** @oneof */
|
|
885
|
-
|
|
860
|
+
interface ShippingDetailsChangeTypeOneOf {
|
|
886
861
|
/** Whether shipping info was added as part of the draft. */
|
|
887
862
|
added?: boolean;
|
|
888
863
|
/** Shipping info before the change. */
|
|
@@ -890,7 +865,7 @@ export interface ShippingDetailsChangeTypeOneOf {
|
|
|
890
865
|
/** Whether shipping info was removed as part of the draft. */
|
|
891
866
|
removed?: boolean;
|
|
892
867
|
}
|
|
893
|
-
|
|
868
|
+
interface V1ShippingInformation {
|
|
894
869
|
/**
|
|
895
870
|
* App Def Id of external provider which was a source of shipping info
|
|
896
871
|
* @minLength 1
|
|
@@ -916,7 +891,7 @@ export interface V1ShippingInformation {
|
|
|
916
891
|
/** Shipping region. */
|
|
917
892
|
region?: ShippingRegion;
|
|
918
893
|
}
|
|
919
|
-
|
|
894
|
+
interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
920
895
|
/** Shipping address and contact details. */
|
|
921
896
|
shippingDestination?: AddressWithContact;
|
|
922
897
|
/** Pickup details. */
|
|
@@ -940,21 +915,21 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
|
940
915
|
deliveryTimeSlot?: V1DeliveryTimeSlot;
|
|
941
916
|
}
|
|
942
917
|
/** @oneof */
|
|
943
|
-
|
|
918
|
+
interface V1DeliveryLogisticsAddressOneOf {
|
|
944
919
|
/** Shipping address and contact details. */
|
|
945
920
|
shippingDestination?: AddressWithContact;
|
|
946
921
|
/** Pickup details. */
|
|
947
922
|
pickupDetails?: V1PickupDetails;
|
|
948
923
|
}
|
|
949
924
|
/** Billing Info and shipping details */
|
|
950
|
-
|
|
925
|
+
interface AddressWithContact {
|
|
951
926
|
/** Address. */
|
|
952
927
|
address?: Address;
|
|
953
928
|
/** Contact details. */
|
|
954
929
|
contactDetails?: FullAddressContactDetails;
|
|
955
930
|
}
|
|
956
931
|
/** Physical address */
|
|
957
|
-
|
|
932
|
+
interface Address {
|
|
958
933
|
/**
|
|
959
934
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
960
935
|
* @format COUNTRY
|
|
@@ -981,7 +956,7 @@ export interface Address {
|
|
|
981
956
|
* Main address line (usually street name and number).
|
|
982
957
|
* @maxLength 150
|
|
983
958
|
*/
|
|
984
|
-
|
|
959
|
+
addressLine1?: string | null;
|
|
985
960
|
/**
|
|
986
961
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
987
962
|
* @maxLength 100
|
|
@@ -998,20 +973,20 @@ export interface Address {
|
|
|
998
973
|
*/
|
|
999
974
|
subdivisionFullname?: string | null;
|
|
1000
975
|
}
|
|
1001
|
-
|
|
976
|
+
interface StreetAddress {
|
|
1002
977
|
/** Street number. */
|
|
1003
978
|
number?: string;
|
|
1004
979
|
/** Street name. */
|
|
1005
980
|
name?: string;
|
|
1006
981
|
}
|
|
1007
|
-
|
|
982
|
+
interface AddressLocation {
|
|
1008
983
|
/** Address latitude. */
|
|
1009
984
|
latitude?: number | null;
|
|
1010
985
|
/** Address longitude. */
|
|
1011
986
|
longitude?: number | null;
|
|
1012
987
|
}
|
|
1013
988
|
/** Full contact details for an address */
|
|
1014
|
-
|
|
989
|
+
interface FullAddressContactDetails {
|
|
1015
990
|
/**
|
|
1016
991
|
* First name.
|
|
1017
992
|
* @maxLength 100
|
|
@@ -1035,9 +1010,9 @@ export interface FullAddressContactDetails {
|
|
|
1035
1010
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1036
1011
|
vatId?: VatId;
|
|
1037
1012
|
}
|
|
1038
|
-
|
|
1013
|
+
interface VatId {
|
|
1039
1014
|
/** Customer's tax ID. */
|
|
1040
|
-
|
|
1015
|
+
_id?: string;
|
|
1041
1016
|
/**
|
|
1042
1017
|
* Tax type.
|
|
1043
1018
|
*
|
|
@@ -1048,7 +1023,7 @@ export interface VatId {
|
|
|
1048
1023
|
type?: VatTypeWithLiterals;
|
|
1049
1024
|
}
|
|
1050
1025
|
/** tax info types */
|
|
1051
|
-
|
|
1026
|
+
declare enum VatType {
|
|
1052
1027
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1053
1028
|
/** CPF - for individual tax payers. */
|
|
1054
1029
|
CPF = "CPF",
|
|
@@ -1056,15 +1031,15 @@ export declare enum VatType {
|
|
|
1056
1031
|
CNPJ = "CNPJ"
|
|
1057
1032
|
}
|
|
1058
1033
|
/** @enumType */
|
|
1059
|
-
|
|
1060
|
-
|
|
1034
|
+
type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1035
|
+
interface V1PickupDetails {
|
|
1061
1036
|
/** Pickup address. */
|
|
1062
1037
|
address?: PickupAddress;
|
|
1063
1038
|
/** Pickup method */
|
|
1064
1039
|
pickupMethod?: PickupDetailsPickupMethodWithLiterals;
|
|
1065
1040
|
}
|
|
1066
1041
|
/** Physical address */
|
|
1067
|
-
|
|
1042
|
+
interface PickupAddress {
|
|
1068
1043
|
/**
|
|
1069
1044
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1070
1045
|
* @format COUNTRY
|
|
@@ -1091,7 +1066,7 @@ export interface PickupAddress {
|
|
|
1091
1066
|
* Main address line (usually street name and number).
|
|
1092
1067
|
* @maxLength 1000
|
|
1093
1068
|
*/
|
|
1094
|
-
|
|
1069
|
+
addressLine1?: string | null;
|
|
1095
1070
|
/**
|
|
1096
1071
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
1097
1072
|
* @maxLength 1000
|
|
@@ -1108,20 +1083,20 @@ export interface PickupAddress {
|
|
|
1108
1083
|
*/
|
|
1109
1084
|
subdivisionFullname?: string | null;
|
|
1110
1085
|
}
|
|
1111
|
-
|
|
1086
|
+
declare enum PickupDetailsPickupMethod {
|
|
1112
1087
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1113
1088
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1114
1089
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1115
1090
|
}
|
|
1116
1091
|
/** @enumType */
|
|
1117
|
-
|
|
1118
|
-
|
|
1092
|
+
type PickupDetailsPickupMethodWithLiterals = PickupDetailsPickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1093
|
+
interface V1DeliveryTimeSlot {
|
|
1119
1094
|
/** Delivery slot starting time. */
|
|
1120
1095
|
from?: Date | null;
|
|
1121
1096
|
/** Delivery slot ending time. */
|
|
1122
1097
|
to?: Date | null;
|
|
1123
1098
|
}
|
|
1124
|
-
|
|
1099
|
+
interface V1ShippingPrice {
|
|
1125
1100
|
/** Shipping price for display purposes. */
|
|
1126
1101
|
price?: Price;
|
|
1127
1102
|
/**
|
|
@@ -1142,19 +1117,19 @@ export interface V1ShippingPrice {
|
|
|
1142
1117
|
*/
|
|
1143
1118
|
discount?: Price;
|
|
1144
1119
|
}
|
|
1145
|
-
|
|
1120
|
+
interface ShippingRegion {
|
|
1146
1121
|
/**
|
|
1147
1122
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1148
1123
|
* @maxLength 100
|
|
1149
1124
|
*/
|
|
1150
1125
|
name?: string | null;
|
|
1151
1126
|
}
|
|
1152
|
-
|
|
1127
|
+
interface ShippingChangedDetails {
|
|
1153
1128
|
/** Shipping info before the change. */
|
|
1154
1129
|
shippingInfoBeforeChange?: V1ShippingInformation;
|
|
1155
1130
|
}
|
|
1156
1131
|
/** Buyer Info */
|
|
1157
|
-
|
|
1132
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1158
1133
|
/**
|
|
1159
1134
|
* Visitor ID (if site visitor is not a member).
|
|
1160
1135
|
* @format GUID
|
|
@@ -1177,7 +1152,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1177
1152
|
email?: string | null;
|
|
1178
1153
|
}
|
|
1179
1154
|
/** @oneof */
|
|
1180
|
-
|
|
1155
|
+
interface BuyerInfoIdOneOf {
|
|
1181
1156
|
/**
|
|
1182
1157
|
* Visitor ID (if site visitor is not a member).
|
|
1183
1158
|
* @format GUID
|
|
@@ -1189,7 +1164,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
1189
1164
|
*/
|
|
1190
1165
|
memberId?: string;
|
|
1191
1166
|
}
|
|
1192
|
-
|
|
1167
|
+
interface AdditionalFeeDetails {
|
|
1193
1168
|
/** Additional fee. */
|
|
1194
1169
|
additionalFee?: AdditionalFee;
|
|
1195
1170
|
/** Tax details related to the additional fee. */
|
|
@@ -1206,7 +1181,7 @@ export interface AdditionalFeeDetails {
|
|
|
1206
1181
|
/** Whether this additional fee is applied to the order. */
|
|
1207
1182
|
applied?: boolean;
|
|
1208
1183
|
}
|
|
1209
|
-
|
|
1184
|
+
interface AdditionalFee {
|
|
1210
1185
|
/**
|
|
1211
1186
|
* Additional fee's unique code for future processing.
|
|
1212
1187
|
* @minLength 1
|
|
@@ -1237,7 +1212,7 @@ export interface AdditionalFee {
|
|
|
1237
1212
|
* @format GUID
|
|
1238
1213
|
* @immutable
|
|
1239
1214
|
*/
|
|
1240
|
-
|
|
1215
|
+
_id?: string;
|
|
1241
1216
|
/**
|
|
1242
1217
|
* Optional - Line items associated with this additional fee.
|
|
1243
1218
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
@@ -1245,7 +1220,7 @@ export interface AdditionalFee {
|
|
|
1245
1220
|
*/
|
|
1246
1221
|
lineItemIds?: string[];
|
|
1247
1222
|
}
|
|
1248
|
-
|
|
1223
|
+
interface TaxDetails {
|
|
1249
1224
|
/** Whether the additional fee is taxable. */
|
|
1250
1225
|
taxable?: boolean;
|
|
1251
1226
|
/**
|
|
@@ -1254,7 +1229,7 @@ export interface TaxDetails {
|
|
|
1254
1229
|
*/
|
|
1255
1230
|
taxGroupId?: string | null;
|
|
1256
1231
|
}
|
|
1257
|
-
|
|
1232
|
+
declare enum SourceType {
|
|
1258
1233
|
/** Part of the original order. */
|
|
1259
1234
|
ORIGINAL_ORDER = "ORIGINAL_ORDER",
|
|
1260
1235
|
/** Added automatically, as the result of recalculation caused by changes in draft order. */
|
|
@@ -1263,8 +1238,8 @@ export declare enum SourceType {
|
|
|
1263
1238
|
CUSTOM = "CUSTOM"
|
|
1264
1239
|
}
|
|
1265
1240
|
/** @enumType */
|
|
1266
|
-
|
|
1267
|
-
|
|
1241
|
+
type SourceTypeWithLiterals = SourceType | 'ORIGINAL_ORDER' | 'AUTOMATIC' | 'CUSTOM';
|
|
1242
|
+
interface DiscountDetails {
|
|
1268
1243
|
/** Discount details. */
|
|
1269
1244
|
discount?: AppliedDiscount;
|
|
1270
1245
|
/**
|
|
@@ -1278,7 +1253,7 @@ export interface DiscountDetails {
|
|
|
1278
1253
|
/** Whether this discount is applied to the order. */
|
|
1279
1254
|
applied?: boolean;
|
|
1280
1255
|
}
|
|
1281
|
-
|
|
1256
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1282
1257
|
/** Applied coupon info. */
|
|
1283
1258
|
coupon?: Coupon;
|
|
1284
1259
|
/** Merchant discount. */
|
|
@@ -1308,10 +1283,10 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1308
1283
|
* @format GUID
|
|
1309
1284
|
* @immutable
|
|
1310
1285
|
*/
|
|
1311
|
-
|
|
1286
|
+
_id?: string | null;
|
|
1312
1287
|
}
|
|
1313
1288
|
/** @oneof */
|
|
1314
|
-
|
|
1289
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1315
1290
|
/** Applied coupon info. */
|
|
1316
1291
|
coupon?: Coupon;
|
|
1317
1292
|
/** Merchant discount. */
|
|
@@ -1319,17 +1294,17 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1319
1294
|
/** Automatic Discount */
|
|
1320
1295
|
discountRule?: DiscountRule;
|
|
1321
1296
|
}
|
|
1322
|
-
|
|
1297
|
+
declare enum AppliedDiscountDiscountType {
|
|
1323
1298
|
GLOBAL = "GLOBAL",
|
|
1324
1299
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1325
1300
|
SHIPPING = "SHIPPING"
|
|
1326
1301
|
}
|
|
1327
1302
|
/** @enumType */
|
|
1328
|
-
|
|
1303
|
+
type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1329
1304
|
/** Coupon */
|
|
1330
|
-
|
|
1305
|
+
interface Coupon {
|
|
1331
1306
|
/** Coupon ID. */
|
|
1332
|
-
|
|
1307
|
+
_id?: string;
|
|
1333
1308
|
/** Coupon code. */
|
|
1334
1309
|
code?: string;
|
|
1335
1310
|
/** Coupon name. */
|
|
@@ -1337,7 +1312,7 @@ export interface Coupon {
|
|
|
1337
1312
|
/** Coupon value. */
|
|
1338
1313
|
amount?: Price;
|
|
1339
1314
|
}
|
|
1340
|
-
|
|
1315
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1341
1316
|
/**
|
|
1342
1317
|
* Pre-defined discount reason (optional).
|
|
1343
1318
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1352,7 +1327,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1352
1327
|
amount?: Price;
|
|
1353
1328
|
}
|
|
1354
1329
|
/** @oneof */
|
|
1355
|
-
|
|
1330
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1356
1331
|
/**
|
|
1357
1332
|
* Pre-defined discount reason (optional).
|
|
1358
1333
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1364,25 +1339,25 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1364
1339
|
*/
|
|
1365
1340
|
description?: string | null;
|
|
1366
1341
|
}
|
|
1367
|
-
|
|
1342
|
+
declare enum DiscountReason {
|
|
1368
1343
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1369
1344
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1370
1345
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1371
1346
|
}
|
|
1372
1347
|
/** @enumType */
|
|
1373
|
-
|
|
1374
|
-
|
|
1348
|
+
type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1349
|
+
interface DiscountRule {
|
|
1375
1350
|
/**
|
|
1376
1351
|
* Discount rule ID
|
|
1377
1352
|
* @format GUID
|
|
1378
1353
|
*/
|
|
1379
|
-
|
|
1354
|
+
_id?: string;
|
|
1380
1355
|
/** Discount rule name */
|
|
1381
1356
|
name?: DiscountRuleName;
|
|
1382
1357
|
/** Discount value. */
|
|
1383
1358
|
amount?: Price;
|
|
1384
1359
|
}
|
|
1385
|
-
|
|
1360
|
+
interface DiscountRuleName {
|
|
1386
1361
|
/**
|
|
1387
1362
|
* Original discount rule name (in site's default language).
|
|
1388
1363
|
* @minLength 1
|
|
@@ -1396,16 +1371,16 @@ export interface DiscountRuleName {
|
|
|
1396
1371
|
*/
|
|
1397
1372
|
translated?: string | null;
|
|
1398
1373
|
}
|
|
1399
|
-
|
|
1374
|
+
interface LineItemDiscount {
|
|
1400
1375
|
/**
|
|
1401
1376
|
* ID of line item the discount applies to.
|
|
1402
1377
|
* @format GUID
|
|
1403
1378
|
*/
|
|
1404
|
-
|
|
1379
|
+
_id?: string;
|
|
1405
1380
|
/** Total discount for this line item. */
|
|
1406
1381
|
totalDiscount?: Price;
|
|
1407
1382
|
}
|
|
1408
|
-
|
|
1383
|
+
interface CreatedBy extends CreatedByStringOneOf {
|
|
1409
1384
|
/**
|
|
1410
1385
|
* User ID. When the draft order was created by a Wix user.
|
|
1411
1386
|
* @format GUID
|
|
@@ -1418,7 +1393,7 @@ export interface CreatedBy extends CreatedByStringOneOf {
|
|
|
1418
1393
|
appId?: string;
|
|
1419
1394
|
}
|
|
1420
1395
|
/** @oneof */
|
|
1421
|
-
|
|
1396
|
+
interface CreatedByStringOneOf {
|
|
1422
1397
|
/**
|
|
1423
1398
|
* User ID. When the draft order was created by a Wix user.
|
|
1424
1399
|
* @format GUID
|
|
@@ -1430,7 +1405,7 @@ export interface CreatedByStringOneOf {
|
|
|
1430
1405
|
*/
|
|
1431
1406
|
appId?: string;
|
|
1432
1407
|
}
|
|
1433
|
-
|
|
1408
|
+
declare enum EditingStatus {
|
|
1434
1409
|
/** Draft order is being edited. */
|
|
1435
1410
|
DRAFT = "DRAFT",
|
|
1436
1411
|
/**
|
|
@@ -1441,8 +1416,8 @@ export declare enum EditingStatus {
|
|
|
1441
1416
|
COMMITTED = "COMMITTED"
|
|
1442
1417
|
}
|
|
1443
1418
|
/** @enumType */
|
|
1444
|
-
|
|
1445
|
-
|
|
1419
|
+
type EditingStatusWithLiterals = EditingStatus | 'DRAFT' | 'COMMITTED';
|
|
1420
|
+
declare enum WeightUnit {
|
|
1446
1421
|
/** Weight unit can't be classified due to an error. */
|
|
1447
1422
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1448
1423
|
/** Kilograms. */
|
|
@@ -1451,8 +1426,8 @@ export declare enum WeightUnit {
|
|
|
1451
1426
|
LB = "LB"
|
|
1452
1427
|
}
|
|
1453
1428
|
/** @enumType */
|
|
1454
|
-
|
|
1455
|
-
|
|
1429
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1430
|
+
interface PriceSummary {
|
|
1456
1431
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
1457
1432
|
subtotal?: Price;
|
|
1458
1433
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1466,14 +1441,14 @@ export interface PriceSummary {
|
|
|
1466
1441
|
/** Total price of additional fees before tax. */
|
|
1467
1442
|
totalAdditionalFees?: Price;
|
|
1468
1443
|
}
|
|
1469
|
-
|
|
1444
|
+
interface TaxSummary {
|
|
1470
1445
|
/**
|
|
1471
1446
|
* Total tax.
|
|
1472
1447
|
* @readonly
|
|
1473
1448
|
*/
|
|
1474
1449
|
totalTax?: Price;
|
|
1475
1450
|
}
|
|
1476
|
-
|
|
1451
|
+
interface BalanceSummary {
|
|
1477
1452
|
/**
|
|
1478
1453
|
* Amount left to pay for the order to be considered paid.
|
|
1479
1454
|
* @readonly
|
|
@@ -1504,7 +1479,7 @@ export interface BalanceSummary {
|
|
|
1504
1479
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
1505
1480
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
1506
1481
|
*/
|
|
1507
|
-
|
|
1482
|
+
interface Balance {
|
|
1508
1483
|
/**
|
|
1509
1484
|
* Balance amount.
|
|
1510
1485
|
*
|
|
@@ -1520,7 +1495,7 @@ export interface Balance {
|
|
|
1520
1495
|
formattedAmount?: string;
|
|
1521
1496
|
}
|
|
1522
1497
|
/** Side-effects upon committing a draft order. */
|
|
1523
|
-
|
|
1498
|
+
interface DraftOrderCommitSettings {
|
|
1524
1499
|
/**
|
|
1525
1500
|
* Whether to send notifications to the buyer.
|
|
1526
1501
|
*
|
|
@@ -1552,14 +1527,14 @@ export interface DraftOrderCommitSettings {
|
|
|
1552
1527
|
*/
|
|
1553
1528
|
updateInventory?: InventoryUpdate[];
|
|
1554
1529
|
}
|
|
1555
|
-
|
|
1530
|
+
interface InventoryUpdate {
|
|
1556
1531
|
/**
|
|
1557
1532
|
* Line item ID.
|
|
1558
1533
|
* @format GUID
|
|
1559
1534
|
*/
|
|
1560
1535
|
lineItemId?: string;
|
|
1561
1536
|
}
|
|
1562
|
-
|
|
1537
|
+
interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
1563
1538
|
/** Indicates that recipient information was added during draft. */
|
|
1564
1539
|
added?: boolean;
|
|
1565
1540
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1570,7 +1545,7 @@ export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneO
|
|
|
1570
1545
|
recipientInfo?: AddressWithContact;
|
|
1571
1546
|
}
|
|
1572
1547
|
/** @oneof */
|
|
1573
|
-
|
|
1548
|
+
interface RecipientInfoDetailsChangeTypeOneOf {
|
|
1574
1549
|
/** Indicates that recipient information was added during draft. */
|
|
1575
1550
|
added?: boolean;
|
|
1576
1551
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1578,11 +1553,11 @@ export interface RecipientInfoDetailsChangeTypeOneOf {
|
|
|
1578
1553
|
/** Indicates that recipient information was removed during draft. */
|
|
1579
1554
|
removed?: boolean;
|
|
1580
1555
|
}
|
|
1581
|
-
|
|
1556
|
+
interface RecipientInfoChangedDetails {
|
|
1582
1557
|
/** Order recipient address and contact details before draft. */
|
|
1583
1558
|
recipientInfoBeforeChange?: AddressWithContact;
|
|
1584
1559
|
}
|
|
1585
|
-
|
|
1560
|
+
interface OrderTaxInfo {
|
|
1586
1561
|
/** Calculated tax, added from line items. */
|
|
1587
1562
|
totalTax?: Price;
|
|
1588
1563
|
/**
|
|
@@ -1602,7 +1577,7 @@ export interface OrderTaxInfo {
|
|
|
1602
1577
|
* 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
1578
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1604
1579
|
*/
|
|
1605
|
-
|
|
1580
|
+
interface OrderTaxBreakdown {
|
|
1606
1581
|
/**
|
|
1607
1582
|
* The name of the tax against which this tax amount was calculated.
|
|
1608
1583
|
* @maxLength 200
|
|
@@ -1629,7 +1604,7 @@ export interface OrderTaxBreakdown {
|
|
|
1629
1604
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1630
1605
|
aggregatedTaxAmount?: Price;
|
|
1631
1606
|
}
|
|
1632
|
-
|
|
1607
|
+
interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
1633
1608
|
/** Indicates that buyer information was added during draft. */
|
|
1634
1609
|
added?: boolean;
|
|
1635
1610
|
/** Indicates that buyer information was changed. Contains billing information before draft. */
|
|
@@ -1640,7 +1615,7 @@ export interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
|
1640
1615
|
buyerInfo?: BuyerInfo;
|
|
1641
1616
|
}
|
|
1642
1617
|
/** @oneof */
|
|
1643
|
-
|
|
1618
|
+
interface BuyerDetailsChangeTypeOneOf {
|
|
1644
1619
|
/** Indicates that buyer information was added during draft. */
|
|
1645
1620
|
added?: boolean;
|
|
1646
1621
|
/** Indicates that buyer information was changed. Contains billing information before draft. */
|
|
@@ -1648,11 +1623,11 @@ export interface BuyerDetailsChangeTypeOneOf {
|
|
|
1648
1623
|
/** Indicates that buyer information was removed during draft. */
|
|
1649
1624
|
removed?: boolean;
|
|
1650
1625
|
}
|
|
1651
|
-
|
|
1626
|
+
interface BuyerChangedDetails {
|
|
1652
1627
|
/** Buyer information before draft. */
|
|
1653
1628
|
buyerInfoBeforeChange?: BuyerInfo;
|
|
1654
1629
|
}
|
|
1655
|
-
|
|
1630
|
+
interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
1656
1631
|
/** Indicates that billing information was added during draft. */
|
|
1657
1632
|
added?: boolean;
|
|
1658
1633
|
/** Indicates that billing information was changed. Contains billing information before draft. */
|
|
@@ -1663,7 +1638,7 @@ export interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
|
1663
1638
|
billingInfo?: AddressWithContact;
|
|
1664
1639
|
}
|
|
1665
1640
|
/** @oneof */
|
|
1666
|
-
|
|
1641
|
+
interface BillingDetailsChangeTypeOneOf {
|
|
1667
1642
|
/** Indicates that billing information was added during draft. */
|
|
1668
1643
|
added?: boolean;
|
|
1669
1644
|
/** Indicates that billing information was changed. Contains billing information before draft. */
|
|
@@ -1671,11 +1646,11 @@ export interface BillingDetailsChangeTypeOneOf {
|
|
|
1671
1646
|
/** Indicates that billing information was removed during draft. */
|
|
1672
1647
|
removed?: boolean;
|
|
1673
1648
|
}
|
|
1674
|
-
|
|
1649
|
+
interface BillingChangedDetails {
|
|
1675
1650
|
/** Billing address and contact details before draft. */
|
|
1676
1651
|
billingInfoBeforeChange?: AddressWithContact;
|
|
1677
1652
|
}
|
|
1678
|
-
|
|
1653
|
+
interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1679
1654
|
/** Indicates that business location was added during draft. */
|
|
1680
1655
|
added?: boolean;
|
|
1681
1656
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1686,7 +1661,7 @@ export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTy
|
|
|
1686
1661
|
businessLocation?: Location;
|
|
1687
1662
|
}
|
|
1688
1663
|
/** @oneof */
|
|
1689
|
-
|
|
1664
|
+
interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1690
1665
|
/** Indicates that business location was added during draft. */
|
|
1691
1666
|
added?: boolean;
|
|
1692
1667
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1694,13 +1669,13 @@ export interface BusinessLocationDetailsChangeTypeOneOf {
|
|
|
1694
1669
|
/** Indicates that business location was removed during draft. */
|
|
1695
1670
|
removed?: boolean;
|
|
1696
1671
|
}
|
|
1697
|
-
|
|
1672
|
+
interface Location {
|
|
1698
1673
|
/**
|
|
1699
1674
|
* Location ID.
|
|
1700
1675
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1701
1676
|
* @format GUID
|
|
1702
1677
|
*/
|
|
1703
|
-
|
|
1678
|
+
_id?: string;
|
|
1704
1679
|
/**
|
|
1705
1680
|
* Location name.
|
|
1706
1681
|
* @minLength 1
|
|
@@ -1709,18 +1684,18 @@ export interface Location {
|
|
|
1709
1684
|
*/
|
|
1710
1685
|
name?: string;
|
|
1711
1686
|
}
|
|
1712
|
-
|
|
1687
|
+
interface BusinessLocationChangedDetails {
|
|
1713
1688
|
/** Business location before draft. */
|
|
1714
1689
|
businessLocationBeforeChange?: Location;
|
|
1715
1690
|
}
|
|
1716
|
-
|
|
1691
|
+
interface CreateDraftOrderRequest {
|
|
1717
1692
|
/**
|
|
1718
1693
|
* ID of the order to create a draft for.
|
|
1719
1694
|
* @format GUID
|
|
1720
1695
|
*/
|
|
1721
1696
|
orderId: string | null;
|
|
1722
1697
|
}
|
|
1723
|
-
|
|
1698
|
+
interface CreateDraftOrderResponse {
|
|
1724
1699
|
/** Draft order calculated with the latest changes. */
|
|
1725
1700
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1726
1701
|
/**
|
|
@@ -1731,7 +1706,7 @@ export interface CreateDraftOrderResponse {
|
|
|
1731
1706
|
*/
|
|
1732
1707
|
preexistingDraftOrder?: boolean | null;
|
|
1733
1708
|
}
|
|
1734
|
-
|
|
1709
|
+
interface CalculatedDraftOrder {
|
|
1735
1710
|
/** Draft order. */
|
|
1736
1711
|
draftOrder?: DraftOrder;
|
|
1737
1712
|
/** Shipping options. */
|
|
@@ -1739,7 +1714,7 @@ export interface CalculatedDraftOrder {
|
|
|
1739
1714
|
/** Errors that occurred during calculation. */
|
|
1740
1715
|
calculationErrors?: CalculationErrors;
|
|
1741
1716
|
}
|
|
1742
|
-
|
|
1717
|
+
interface ShippingOption {
|
|
1743
1718
|
/**
|
|
1744
1719
|
* Carrier ID.
|
|
1745
1720
|
* @format GUID
|
|
@@ -1754,7 +1729,7 @@ export interface ShippingOption {
|
|
|
1754
1729
|
/** Shipping cost. */
|
|
1755
1730
|
cost?: ShippingPrice;
|
|
1756
1731
|
}
|
|
1757
|
-
|
|
1732
|
+
interface DeliveryLogistics {
|
|
1758
1733
|
/** When the item is expected to be delivered in free text, e.g "3-5 business days" */
|
|
1759
1734
|
deliveryTime?: string | null;
|
|
1760
1735
|
/**
|
|
@@ -1768,13 +1743,13 @@ export interface DeliveryLogistics {
|
|
|
1768
1743
|
/** Expected delivery time slot. */
|
|
1769
1744
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1770
1745
|
}
|
|
1771
|
-
|
|
1746
|
+
interface PickupDetails {
|
|
1772
1747
|
/** Pickup address. */
|
|
1773
1748
|
address?: Address;
|
|
1774
1749
|
/** Pickup method. */
|
|
1775
1750
|
pickupMethod?: PickupMethodWithLiterals;
|
|
1776
1751
|
}
|
|
1777
|
-
|
|
1752
|
+
declare enum PickupMethod {
|
|
1778
1753
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1779
1754
|
/** Store pickup. */
|
|
1780
1755
|
STORE_PICKUP = "STORE_PICKUP",
|
|
@@ -1782,14 +1757,14 @@ export declare enum PickupMethod {
|
|
|
1782
1757
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1783
1758
|
}
|
|
1784
1759
|
/** @enumType */
|
|
1785
|
-
|
|
1786
|
-
|
|
1760
|
+
type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1761
|
+
interface DeliveryTimeSlot {
|
|
1787
1762
|
/** Delivery time slot start time. */
|
|
1788
1763
|
from?: Date | null;
|
|
1789
1764
|
/** Delivery time slot end time. */
|
|
1790
1765
|
to?: Date | null;
|
|
1791
1766
|
}
|
|
1792
|
-
|
|
1767
|
+
interface ShippingPrice {
|
|
1793
1768
|
/** Shipping price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
|
|
1794
1769
|
price?: Price;
|
|
1795
1770
|
/**
|
|
@@ -1798,7 +1773,7 @@ export interface ShippingPrice {
|
|
|
1798
1773
|
*/
|
|
1799
1774
|
currency?: string;
|
|
1800
1775
|
}
|
|
1801
|
-
|
|
1776
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1802
1777
|
/** General shipping calculation error. */
|
|
1803
1778
|
generalShippingCalculationError?: Details;
|
|
1804
1779
|
/** Carrier errors. */
|
|
@@ -1809,13 +1784,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
1809
1784
|
orderValidationErrors?: ApplicationError[];
|
|
1810
1785
|
}
|
|
1811
1786
|
/** @oneof */
|
|
1812
|
-
|
|
1787
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1813
1788
|
/** General shipping calculation error. */
|
|
1814
1789
|
generalShippingCalculationError?: Details;
|
|
1815
1790
|
/** Carrier errors. */
|
|
1816
1791
|
carrierErrors?: CarrierErrors;
|
|
1817
1792
|
}
|
|
1818
|
-
|
|
1793
|
+
interface Details extends DetailsKindOneOf {
|
|
1819
1794
|
applicationError?: ApplicationError;
|
|
1820
1795
|
validationError?: ValidationError;
|
|
1821
1796
|
systemError?: SystemError;
|
|
@@ -1826,12 +1801,12 @@ export interface Details extends DetailsKindOneOf {
|
|
|
1826
1801
|
tracing?: Record<string, string>;
|
|
1827
1802
|
}
|
|
1828
1803
|
/** @oneof */
|
|
1829
|
-
|
|
1804
|
+
interface DetailsKindOneOf {
|
|
1830
1805
|
applicationError?: ApplicationError;
|
|
1831
1806
|
validationError?: ValidationError;
|
|
1832
1807
|
systemError?: SystemError;
|
|
1833
1808
|
}
|
|
1834
|
-
|
|
1809
|
+
interface ApplicationError {
|
|
1835
1810
|
/** Error code. */
|
|
1836
1811
|
code?: string;
|
|
1837
1812
|
/** Description of the error. */
|
|
@@ -1871,10 +1846,10 @@ export interface ApplicationError {
|
|
|
1871
1846
|
* ]
|
|
1872
1847
|
* }
|
|
1873
1848
|
*/
|
|
1874
|
-
|
|
1849
|
+
interface ValidationError {
|
|
1875
1850
|
fieldViolations?: FieldViolation[];
|
|
1876
1851
|
}
|
|
1877
|
-
|
|
1852
|
+
declare enum RuleType {
|
|
1878
1853
|
VALIDATION = "VALIDATION",
|
|
1879
1854
|
OTHER = "OTHER",
|
|
1880
1855
|
MAX = "MAX",
|
|
@@ -1898,8 +1873,8 @@ export declare enum RuleType {
|
|
|
1898
1873
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1899
1874
|
}
|
|
1900
1875
|
/** @enumType */
|
|
1901
|
-
|
|
1902
|
-
|
|
1876
|
+
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';
|
|
1877
|
+
interface FieldViolation {
|
|
1903
1878
|
field?: string;
|
|
1904
1879
|
description?: string;
|
|
1905
1880
|
violatedRule?: RuleTypeWithLiterals;
|
|
@@ -1907,27 +1882,27 @@ export interface FieldViolation {
|
|
|
1907
1882
|
ruleName?: string | null;
|
|
1908
1883
|
data?: Record<string, any> | null;
|
|
1909
1884
|
}
|
|
1910
|
-
|
|
1885
|
+
interface SystemError {
|
|
1911
1886
|
/** Error code. */
|
|
1912
1887
|
errorCode?: string | null;
|
|
1913
1888
|
}
|
|
1914
|
-
|
|
1889
|
+
interface CarrierErrors {
|
|
1915
1890
|
/** Carrier errors. */
|
|
1916
1891
|
errors?: CarrierError[];
|
|
1917
1892
|
}
|
|
1918
|
-
|
|
1893
|
+
interface CarrierError {
|
|
1919
1894
|
/** Carrier ID. */
|
|
1920
1895
|
carrierId?: string;
|
|
1921
1896
|
/** Error details. */
|
|
1922
1897
|
error?: Details;
|
|
1923
1898
|
}
|
|
1924
|
-
|
|
1899
|
+
interface CreateEmptyDraftOrderRequest {
|
|
1925
1900
|
}
|
|
1926
|
-
|
|
1901
|
+
interface CreateEmptyDraftOrderResponse {
|
|
1927
1902
|
/** Draft order calculated with the latest changes. */
|
|
1928
1903
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1929
1904
|
}
|
|
1930
|
-
|
|
1905
|
+
interface AddLineItemsToDraftOrderRequest {
|
|
1931
1906
|
/**
|
|
1932
1907
|
* Draft order ID.
|
|
1933
1908
|
* @format GUID
|
|
@@ -1946,7 +1921,7 @@ export interface AddLineItemsToDraftOrderRequest {
|
|
|
1946
1921
|
*/
|
|
1947
1922
|
customLineItems?: CustomLineItem[];
|
|
1948
1923
|
}
|
|
1949
|
-
|
|
1924
|
+
interface CatalogReferenceLineItem {
|
|
1950
1925
|
/**
|
|
1951
1926
|
* Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
|
|
1952
1927
|
* Optional for custom line items, which don't trigger the Catalog service plugin.
|
|
@@ -1974,12 +1949,12 @@ export interface CatalogReferenceLineItem {
|
|
|
1974
1949
|
*/
|
|
1975
1950
|
locations?: LocationAndQuantity[];
|
|
1976
1951
|
}
|
|
1977
|
-
|
|
1952
|
+
interface CustomLineItem {
|
|
1978
1953
|
/**
|
|
1979
1954
|
* Line item ID.
|
|
1980
1955
|
* @format GUID
|
|
1981
1956
|
*/
|
|
1982
|
-
|
|
1957
|
+
_id?: string | null;
|
|
1983
1958
|
/**
|
|
1984
1959
|
* Item quantity.
|
|
1985
1960
|
*
|
|
@@ -2004,7 +1979,7 @@ export interface CustomLineItem {
|
|
|
2004
1979
|
*/
|
|
2005
1980
|
productName?: ProductName;
|
|
2006
1981
|
/** URL to the item's page on the site. */
|
|
2007
|
-
url?:
|
|
1982
|
+
url?: string;
|
|
2008
1983
|
/** Item price **after** catalog-defined discount and line item discounts. */
|
|
2009
1984
|
price?: Price;
|
|
2010
1985
|
/** Total line item price **after** catalog-defined discount and line item discounts. */
|
|
@@ -2016,7 +1991,7 @@ export interface CustomLineItem {
|
|
|
2016
1991
|
/** Line item description lines. Used for display purposes for order. */
|
|
2017
1992
|
descriptionLines?: DescriptionLine[];
|
|
2018
1993
|
/** Line item image details. */
|
|
2019
|
-
media?:
|
|
1994
|
+
media?: string;
|
|
2020
1995
|
/** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
|
|
2021
1996
|
physicalProperties?: PhysicalProperties;
|
|
2022
1997
|
/** Item type. Either a preset type or custom. */
|
|
@@ -2036,19 +2011,13 @@ export interface CustomLineItem {
|
|
|
2036
2011
|
*/
|
|
2037
2012
|
locations?: LocationAndQuantity[];
|
|
2038
2013
|
}
|
|
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 {
|
|
2014
|
+
interface SecuredMedia {
|
|
2046
2015
|
/**
|
|
2047
2016
|
* Media ID in Wix Media Manager.
|
|
2048
2017
|
* @minLength 1
|
|
2049
2018
|
* @maxLength 100
|
|
2050
2019
|
*/
|
|
2051
|
-
|
|
2020
|
+
_id?: string;
|
|
2052
2021
|
/**
|
|
2053
2022
|
* Original filename.
|
|
2054
2023
|
* @minLength 1
|
|
@@ -2058,7 +2027,7 @@ export interface SecuredMedia {
|
|
|
2058
2027
|
/** File type. */
|
|
2059
2028
|
fileType?: FileTypeWithLiterals;
|
|
2060
2029
|
}
|
|
2061
|
-
|
|
2030
|
+
declare enum FileType {
|
|
2062
2031
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2063
2032
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
2064
2033
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -2067,12 +2036,12 @@ export declare enum FileType {
|
|
|
2067
2036
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
2068
2037
|
}
|
|
2069
2038
|
/** @enumType */
|
|
2070
|
-
|
|
2071
|
-
|
|
2039
|
+
type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
2040
|
+
interface AddLineItemsToDraftOrderResponse {
|
|
2072
2041
|
/** Draft order calculated with the latest changes. */
|
|
2073
2042
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2074
2043
|
}
|
|
2075
|
-
|
|
2044
|
+
interface UpdateLineItemsRequest {
|
|
2076
2045
|
/**
|
|
2077
2046
|
* Draft order ID.
|
|
2078
2047
|
* @format GUID
|
|
@@ -2085,7 +2054,7 @@ export interface UpdateLineItemsRequest {
|
|
|
2085
2054
|
*/
|
|
2086
2055
|
lineItemChanges: LineItemChangeDetails[];
|
|
2087
2056
|
}
|
|
2088
|
-
|
|
2057
|
+
interface LineItemChangeDetails {
|
|
2089
2058
|
/**
|
|
2090
2059
|
* Line item ID.
|
|
2091
2060
|
* @format GUID
|
|
@@ -2110,11 +2079,11 @@ export interface LineItemChangeDetails {
|
|
|
2110
2079
|
*/
|
|
2111
2080
|
newPriceDescription?: PriceDescription;
|
|
2112
2081
|
}
|
|
2113
|
-
|
|
2082
|
+
interface UpdateLineItemsResponse {
|
|
2114
2083
|
/** Draft order calculated with the latest changes. */
|
|
2115
2084
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2116
2085
|
}
|
|
2117
|
-
|
|
2086
|
+
interface SetDiscountsRequest {
|
|
2118
2087
|
/**
|
|
2119
2088
|
* Draft order ID.
|
|
2120
2089
|
* @format GUID
|
|
@@ -2129,22 +2098,22 @@ export interface SetDiscountsRequest {
|
|
|
2129
2098
|
*/
|
|
2130
2099
|
discounts: IdAndApplied[];
|
|
2131
2100
|
}
|
|
2132
|
-
|
|
2101
|
+
interface IdAndApplied {
|
|
2133
2102
|
/**
|
|
2134
2103
|
* Entity ID.
|
|
2135
2104
|
*
|
|
2136
2105
|
* Depending on the context, the value is either a discount ID or an additional fee ID.
|
|
2137
2106
|
* @format GUID
|
|
2138
2107
|
*/
|
|
2139
|
-
|
|
2108
|
+
_id?: string;
|
|
2140
2109
|
/** Whether the discount or additional fee should be applied to the draft order. */
|
|
2141
2110
|
applied?: boolean;
|
|
2142
2111
|
}
|
|
2143
|
-
|
|
2112
|
+
interface SetDiscountsResponse {
|
|
2144
2113
|
/** Draft order calculated with the latest changes. */
|
|
2145
2114
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2146
2115
|
}
|
|
2147
|
-
|
|
2116
|
+
interface CreateCustomDiscountsRequest {
|
|
2148
2117
|
/**
|
|
2149
2118
|
* Draft order ID.
|
|
2150
2119
|
* @format GUID
|
|
@@ -2159,7 +2128,7 @@ export interface CreateCustomDiscountsRequest {
|
|
|
2159
2128
|
*/
|
|
2160
2129
|
discounts?: DiscountOption[];
|
|
2161
2130
|
}
|
|
2162
|
-
|
|
2131
|
+
interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
2163
2132
|
/** Amount to discount from the line item price. */
|
|
2164
2133
|
priceAmount?: Price;
|
|
2165
2134
|
/**
|
|
@@ -2203,7 +2172,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
2203
2172
|
lineItemDiscounts?: LineItemDiscount[];
|
|
2204
2173
|
}
|
|
2205
2174
|
/** @oneof */
|
|
2206
|
-
|
|
2175
|
+
interface DiscountOptionDiscountAmountOneOf {
|
|
2207
2176
|
/** Amount to discount from the line item price. */
|
|
2208
2177
|
priceAmount?: Price;
|
|
2209
2178
|
/**
|
|
@@ -2213,7 +2182,7 @@ export interface DiscountOptionDiscountAmountOneOf {
|
|
|
2213
2182
|
*/
|
|
2214
2183
|
percentage?: string | null;
|
|
2215
2184
|
}
|
|
2216
|
-
|
|
2185
|
+
declare enum DiscountType {
|
|
2217
2186
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
2218
2187
|
/** Discount applies to the entire order. */
|
|
2219
2188
|
GLOBAL = "GLOBAL",
|
|
@@ -2223,12 +2192,12 @@ export declare enum DiscountType {
|
|
|
2223
2192
|
SHIPPING = "SHIPPING"
|
|
2224
2193
|
}
|
|
2225
2194
|
/** @enumType */
|
|
2226
|
-
|
|
2227
|
-
|
|
2195
|
+
type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_TYPE' | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
2196
|
+
interface CreateCustomDiscountsResponse {
|
|
2228
2197
|
/** Draft order calculated with the latest changes. */
|
|
2229
2198
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2230
2199
|
}
|
|
2231
|
-
|
|
2200
|
+
interface DeleteCustomDiscountsRequest {
|
|
2232
2201
|
/**
|
|
2233
2202
|
* Draft order ID.
|
|
2234
2203
|
* @format GUID
|
|
@@ -2242,11 +2211,11 @@ export interface DeleteCustomDiscountsRequest {
|
|
|
2242
2211
|
*/
|
|
2243
2212
|
discountIds: string[];
|
|
2244
2213
|
}
|
|
2245
|
-
|
|
2214
|
+
interface DeleteCustomDiscountsResponse {
|
|
2246
2215
|
/** Draft order calculated with the latest changes. */
|
|
2247
2216
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2248
2217
|
}
|
|
2249
|
-
|
|
2218
|
+
interface SetAdditionalFeesRequest {
|
|
2250
2219
|
/**
|
|
2251
2220
|
* Draft order ID.
|
|
2252
2221
|
* @format GUID
|
|
@@ -2261,11 +2230,11 @@ export interface SetAdditionalFeesRequest {
|
|
|
2261
2230
|
*/
|
|
2262
2231
|
additionalFees: IdAndApplied[];
|
|
2263
2232
|
}
|
|
2264
|
-
|
|
2233
|
+
interface SetAdditionalFeesResponse {
|
|
2265
2234
|
/** Draft order calculated with the latest changes. */
|
|
2266
2235
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2267
2236
|
}
|
|
2268
|
-
|
|
2237
|
+
interface CreateCustomAdditionalFeesRequest {
|
|
2269
2238
|
/**
|
|
2270
2239
|
* Draft order ID.
|
|
2271
2240
|
* @format GUID
|
|
@@ -2280,7 +2249,7 @@ export interface CreateCustomAdditionalFeesRequest {
|
|
|
2280
2249
|
*/
|
|
2281
2250
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
2282
2251
|
}
|
|
2283
|
-
|
|
2252
|
+
interface AdditionalFeeOption {
|
|
2284
2253
|
/**
|
|
2285
2254
|
* Name of the additional fee.
|
|
2286
2255
|
* @minLength 1
|
|
@@ -2312,11 +2281,11 @@ export interface AdditionalFeeOption {
|
|
|
2312
2281
|
*/
|
|
2313
2282
|
lineItemIds?: string[];
|
|
2314
2283
|
}
|
|
2315
|
-
|
|
2284
|
+
interface CreateCustomAdditionalFeesResponse {
|
|
2316
2285
|
/** Draft order calculated with the latest changes. */
|
|
2317
2286
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2318
2287
|
}
|
|
2319
|
-
|
|
2288
|
+
interface DeleteCustomAdditionalFeesRequest {
|
|
2320
2289
|
/**
|
|
2321
2290
|
* Draft order ID.
|
|
2322
2291
|
* @format GUID
|
|
@@ -2330,11 +2299,11 @@ export interface DeleteCustomAdditionalFeesRequest {
|
|
|
2330
2299
|
*/
|
|
2331
2300
|
customAdditionalFees: string[];
|
|
2332
2301
|
}
|
|
2333
|
-
|
|
2302
|
+
interface DeleteCustomAdditionalFeesResponse {
|
|
2334
2303
|
/** Draft order calculated with the latest changes. */
|
|
2335
2304
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2336
2305
|
}
|
|
2337
|
-
|
|
2306
|
+
interface SetShippingInfoRequest {
|
|
2338
2307
|
/**
|
|
2339
2308
|
* Draft order ID.
|
|
2340
2309
|
* @format GUID
|
|
@@ -2347,11 +2316,11 @@ export interface SetShippingInfoRequest {
|
|
|
2347
2316
|
*/
|
|
2348
2317
|
shippingInfo?: V1ShippingInformation;
|
|
2349
2318
|
}
|
|
2350
|
-
|
|
2319
|
+
interface SetShippingInfoResponse {
|
|
2351
2320
|
/** Draft order calculated with the latest changes. */
|
|
2352
2321
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2353
2322
|
}
|
|
2354
|
-
|
|
2323
|
+
interface SetBuyerInfoRequest {
|
|
2355
2324
|
/**
|
|
2356
2325
|
* Draft order ID.
|
|
2357
2326
|
* @format GUID
|
|
@@ -2364,11 +2333,11 @@ export interface SetBuyerInfoRequest {
|
|
|
2364
2333
|
*/
|
|
2365
2334
|
buyerInfo?: BuyerInfo;
|
|
2366
2335
|
}
|
|
2367
|
-
|
|
2336
|
+
interface SetBuyerInfoResponse {
|
|
2368
2337
|
/** Draft order calculated with the latest changes. */
|
|
2369
2338
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2370
2339
|
}
|
|
2371
|
-
|
|
2340
|
+
interface SetRecipientInfoRequest {
|
|
2372
2341
|
/**
|
|
2373
2342
|
* Draft order ID.
|
|
2374
2343
|
* @format GUID
|
|
@@ -2381,11 +2350,11 @@ export interface SetRecipientInfoRequest {
|
|
|
2381
2350
|
*/
|
|
2382
2351
|
recipientInfo?: AddressWithContact;
|
|
2383
2352
|
}
|
|
2384
|
-
|
|
2353
|
+
interface SetRecipientInfoResponse {
|
|
2385
2354
|
/** Draft order calculated with the latest changes. */
|
|
2386
2355
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2387
2356
|
}
|
|
2388
|
-
|
|
2357
|
+
interface SetBillingInfoRequest {
|
|
2389
2358
|
/**
|
|
2390
2359
|
* Draft order ID.
|
|
2391
2360
|
* @format GUID
|
|
@@ -2398,12 +2367,12 @@ export interface SetBillingInfoRequest {
|
|
|
2398
2367
|
*/
|
|
2399
2368
|
billingInfo?: AddressWithContact;
|
|
2400
2369
|
}
|
|
2401
|
-
|
|
2370
|
+
interface SetBillingInfoResponse {
|
|
2402
2371
|
/** Draft order calculated with the latest changes. */
|
|
2403
2372
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2404
2373
|
}
|
|
2405
2374
|
/** Deprecated */
|
|
2406
|
-
|
|
2375
|
+
interface UpdateShippingInfoRequest {
|
|
2407
2376
|
/**
|
|
2408
2377
|
* Draft order ID.
|
|
2409
2378
|
* @format GUID
|
|
@@ -2413,29 +2382,29 @@ export interface UpdateShippingInfoRequest {
|
|
|
2413
2382
|
shippingOption?: ShippingOption;
|
|
2414
2383
|
}
|
|
2415
2384
|
/** Deprecated */
|
|
2416
|
-
|
|
2385
|
+
interface UpdateShippingInfoResponse {
|
|
2417
2386
|
/** Draft order calculated with the latest changes. */
|
|
2418
2387
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2419
2388
|
}
|
|
2420
|
-
|
|
2389
|
+
interface GetDraftOrderRequest {
|
|
2421
2390
|
/**
|
|
2422
2391
|
* Draft order ID.
|
|
2423
2392
|
* @format GUID
|
|
2424
2393
|
*/
|
|
2425
2394
|
draftOrderId: string;
|
|
2426
2395
|
}
|
|
2427
|
-
|
|
2396
|
+
interface GetDraftOrderResponse {
|
|
2428
2397
|
/** Draft order calculated with the latest changes. */
|
|
2429
2398
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2430
2399
|
}
|
|
2431
|
-
|
|
2400
|
+
interface GetOrderDraftabilityStatusRequest {
|
|
2432
2401
|
/**
|
|
2433
2402
|
* Order ID.
|
|
2434
2403
|
* @format GUID
|
|
2435
2404
|
*/
|
|
2436
2405
|
orderId: string;
|
|
2437
2406
|
}
|
|
2438
|
-
|
|
2407
|
+
interface GetOrderDraftabilityStatusResponse {
|
|
2439
2408
|
/**
|
|
2440
2409
|
* Order ID.
|
|
2441
2410
|
* @format GUID
|
|
@@ -2449,7 +2418,7 @@ export interface GetOrderDraftabilityStatusResponse {
|
|
|
2449
2418
|
*/
|
|
2450
2419
|
nonDraftableReasons?: NonDraftableReasonWithLiterals[];
|
|
2451
2420
|
}
|
|
2452
|
-
|
|
2421
|
+
declare enum NonDraftableReason {
|
|
2453
2422
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2454
2423
|
/** Modifications of refunded orders are not supported. */
|
|
2455
2424
|
PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
|
|
@@ -2473,8 +2442,8 @@ export declare enum NonDraftableReason {
|
|
|
2473
2442
|
SUBSCRIPTION_LINE_ITEM_EXISTS = "SUBSCRIPTION_LINE_ITEM_EXISTS"
|
|
2474
2443
|
}
|
|
2475
2444
|
/** @enumType */
|
|
2476
|
-
|
|
2477
|
-
|
|
2445
|
+
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';
|
|
2446
|
+
interface CommitDraftOrderRequest {
|
|
2478
2447
|
/**
|
|
2479
2448
|
* Draft order ID.
|
|
2480
2449
|
* @format GUID
|
|
@@ -2488,19 +2457,19 @@ export interface CommitDraftOrderRequest {
|
|
|
2488
2457
|
*/
|
|
2489
2458
|
reason?: string | null;
|
|
2490
2459
|
}
|
|
2491
|
-
|
|
2460
|
+
interface CommitDraftOrderResponse {
|
|
2492
2461
|
/** Draft order after commit. */
|
|
2493
2462
|
committedDraftOrder?: DraftOrder;
|
|
2494
2463
|
/** Updated order after commit. */
|
|
2495
2464
|
orderAfterCommit?: Order;
|
|
2496
2465
|
}
|
|
2497
|
-
|
|
2466
|
+
interface Order {
|
|
2498
2467
|
/**
|
|
2499
2468
|
* Order ID.
|
|
2500
2469
|
* @format GUID
|
|
2501
2470
|
* @readonly
|
|
2502
2471
|
*/
|
|
2503
|
-
|
|
2472
|
+
_id?: string | null;
|
|
2504
2473
|
/**
|
|
2505
2474
|
* Order number displayed in the site owner's dashboard (auto-generated).
|
|
2506
2475
|
* @readonly
|
|
@@ -2511,12 +2480,12 @@ export interface Order {
|
|
|
2511
2480
|
* @readonly
|
|
2512
2481
|
* @immutable
|
|
2513
2482
|
*/
|
|
2514
|
-
|
|
2483
|
+
_createdDate?: Date | null;
|
|
2515
2484
|
/**
|
|
2516
2485
|
* 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
2486
|
* @readonly
|
|
2518
2487
|
*/
|
|
2519
|
-
|
|
2488
|
+
_updatedDate?: Date | null;
|
|
2520
2489
|
/**
|
|
2521
2490
|
* Order line items.
|
|
2522
2491
|
* @minSize 1
|
|
@@ -2667,7 +2636,7 @@ export interface Order {
|
|
|
2667
2636
|
*/
|
|
2668
2637
|
payAfterFreeTrial?: PriceSummary;
|
|
2669
2638
|
}
|
|
2670
|
-
|
|
2639
|
+
declare enum PaymentStatus {
|
|
2671
2640
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2672
2641
|
/**
|
|
2673
2642
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -2709,8 +2678,8 @@ export declare enum PaymentStatus {
|
|
|
2709
2678
|
DECLINED = "DECLINED"
|
|
2710
2679
|
}
|
|
2711
2680
|
/** @enumType */
|
|
2712
|
-
|
|
2713
|
-
|
|
2681
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
|
|
2682
|
+
declare enum FulfillmentStatus {
|
|
2714
2683
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
2715
2684
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
2716
2685
|
/**
|
|
@@ -2722,8 +2691,8 @@ export declare enum FulfillmentStatus {
|
|
|
2722
2691
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
2723
2692
|
}
|
|
2724
2693
|
/** @enumType */
|
|
2725
|
-
|
|
2726
|
-
|
|
2694
|
+
type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
|
|
2695
|
+
interface CurrencyConversionDetails {
|
|
2727
2696
|
/**
|
|
2728
2697
|
* 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
2698
|
*
|
|
@@ -2741,7 +2710,7 @@ export interface CurrencyConversionDetails {
|
|
|
2741
2710
|
*/
|
|
2742
2711
|
conversionRate?: string | null;
|
|
2743
2712
|
}
|
|
2744
|
-
|
|
2713
|
+
declare enum OrderStatus {
|
|
2745
2714
|
/** Order created, but not yet approved or canceled. */
|
|
2746
2715
|
INITIALIZED = "INITIALIZED",
|
|
2747
2716
|
/**
|
|
@@ -2767,8 +2736,8 @@ export declare enum OrderStatus {
|
|
|
2767
2736
|
REJECTED = "REJECTED"
|
|
2768
2737
|
}
|
|
2769
2738
|
/** @enumType */
|
|
2770
|
-
|
|
2771
|
-
|
|
2739
|
+
type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
|
|
2740
|
+
interface Activity extends ActivityContentOneOf {
|
|
2772
2741
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2773
2742
|
customActivity?: CustomActivity;
|
|
2774
2743
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -2780,7 +2749,7 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2780
2749
|
* @format GUID
|
|
2781
2750
|
* @readonly
|
|
2782
2751
|
*/
|
|
2783
|
-
|
|
2752
|
+
_id?: string | null;
|
|
2784
2753
|
/**
|
|
2785
2754
|
* Activity author's email.
|
|
2786
2755
|
* @format EMAIL
|
|
@@ -2791,12 +2760,12 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2791
2760
|
* Activity creation date and time.
|
|
2792
2761
|
* @readonly
|
|
2793
2762
|
*/
|
|
2794
|
-
|
|
2763
|
+
_createdDate?: Date | null;
|
|
2795
2764
|
/** Activity type. */
|
|
2796
2765
|
type?: ActivityTypeWithLiterals;
|
|
2797
2766
|
}
|
|
2798
2767
|
/** @oneof */
|
|
2799
|
-
|
|
2768
|
+
interface ActivityContentOneOf {
|
|
2800
2769
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2801
2770
|
customActivity?: CustomActivity;
|
|
2802
2771
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -2804,7 +2773,7 @@ export interface ActivityContentOneOf {
|
|
|
2804
2773
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2805
2774
|
orderRefunded?: OrderRefunded;
|
|
2806
2775
|
}
|
|
2807
|
-
|
|
2776
|
+
interface CustomActivity {
|
|
2808
2777
|
/**
|
|
2809
2778
|
* ID of the app that created the custom activity.
|
|
2810
2779
|
* @format GUID
|
|
@@ -2819,7 +2788,7 @@ export interface CustomActivity {
|
|
|
2819
2788
|
additionalData?: Record<string, string>;
|
|
2820
2789
|
}
|
|
2821
2790
|
/** Store owner added a comment */
|
|
2822
|
-
|
|
2791
|
+
interface MerchantComment {
|
|
2823
2792
|
/**
|
|
2824
2793
|
* Merchant comment message.
|
|
2825
2794
|
* @minLength 1
|
|
@@ -2827,7 +2796,7 @@ export interface MerchantComment {
|
|
|
2827
2796
|
*/
|
|
2828
2797
|
message?: string;
|
|
2829
2798
|
}
|
|
2830
|
-
|
|
2799
|
+
interface OrderRefunded {
|
|
2831
2800
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
2832
2801
|
manual?: boolean;
|
|
2833
2802
|
/** Refund amount. */
|
|
@@ -2838,14 +2807,14 @@ export interface OrderRefunded {
|
|
|
2838
2807
|
*/
|
|
2839
2808
|
reason?: string;
|
|
2840
2809
|
}
|
|
2841
|
-
|
|
2810
|
+
interface OrderCreatedFromExchange {
|
|
2842
2811
|
/**
|
|
2843
2812
|
* ID of the original order for which the exchange happened.
|
|
2844
2813
|
* @format GUID
|
|
2845
2814
|
*/
|
|
2846
2815
|
originalOrderId?: string;
|
|
2847
2816
|
}
|
|
2848
|
-
|
|
2817
|
+
interface NewExchangeOrderCreated {
|
|
2849
2818
|
/**
|
|
2850
2819
|
* ID of the new order created as a result of an exchange of items.
|
|
2851
2820
|
* @format GUID
|
|
@@ -2858,7 +2827,7 @@ export interface NewExchangeOrderCreated {
|
|
|
2858
2827
|
*/
|
|
2859
2828
|
lineItems?: LineItemExchangeData[];
|
|
2860
2829
|
}
|
|
2861
|
-
|
|
2830
|
+
interface LineItemExchangeData {
|
|
2862
2831
|
/**
|
|
2863
2832
|
* ID of the exchanged line item.
|
|
2864
2833
|
* @format GUID
|
|
@@ -2871,7 +2840,7 @@ export interface LineItemExchangeData {
|
|
|
2871
2840
|
*/
|
|
2872
2841
|
quantity?: number;
|
|
2873
2842
|
}
|
|
2874
|
-
|
|
2843
|
+
interface DraftOrderChangesApplied {
|
|
2875
2844
|
/** Draft order id. */
|
|
2876
2845
|
draftOrderId?: string;
|
|
2877
2846
|
/**
|
|
@@ -2882,7 +2851,7 @@ export interface DraftOrderChangesApplied {
|
|
|
2882
2851
|
/** Changes applied to order. */
|
|
2883
2852
|
changes?: OrderChange[];
|
|
2884
2853
|
}
|
|
2885
|
-
|
|
2854
|
+
interface OrderChange extends OrderChangeValueOneOf {
|
|
2886
2855
|
lineItemChanged?: LineItemChanges;
|
|
2887
2856
|
lineItemAdded?: ManagedLineItem;
|
|
2888
2857
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2894,7 +2863,7 @@ export interface OrderChange extends OrderChangeValueOneOf {
|
|
|
2894
2863
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2895
2864
|
}
|
|
2896
2865
|
/** @oneof */
|
|
2897
|
-
|
|
2866
|
+
interface OrderChangeValueOneOf {
|
|
2898
2867
|
lineItemChanged?: LineItemChanges;
|
|
2899
2868
|
lineItemAdded?: ManagedLineItem;
|
|
2900
2869
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2905,12 +2874,12 @@ export interface OrderChangeValueOneOf {
|
|
|
2905
2874
|
totalPriceChanged?: TotalPriceChange;
|
|
2906
2875
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2907
2876
|
}
|
|
2908
|
-
|
|
2877
|
+
interface LineItemChanges {
|
|
2909
2878
|
/**
|
|
2910
2879
|
* Line item ID.
|
|
2911
2880
|
* @format GUID
|
|
2912
2881
|
*/
|
|
2913
|
-
|
|
2882
|
+
_id?: string;
|
|
2914
2883
|
/** Item name. */
|
|
2915
2884
|
name?: ProductName;
|
|
2916
2885
|
/** Item quantity change. */
|
|
@@ -2918,7 +2887,7 @@ export interface LineItemChanges {
|
|
|
2918
2887
|
/** Item price change. */
|
|
2919
2888
|
price?: LineItemPriceChange;
|
|
2920
2889
|
}
|
|
2921
|
-
|
|
2890
|
+
interface LineItemQuantityChange {
|
|
2922
2891
|
/**
|
|
2923
2892
|
* Item quantity before update.
|
|
2924
2893
|
* @max 1000000
|
|
@@ -2938,26 +2907,26 @@ export interface LineItemQuantityChange {
|
|
|
2938
2907
|
/** Type of quantity change: increase or decrease. */
|
|
2939
2908
|
deltaType?: LineItemQuantityChangeTypeWithLiterals;
|
|
2940
2909
|
}
|
|
2941
|
-
|
|
2910
|
+
declare enum LineItemQuantityChangeType {
|
|
2942
2911
|
/** Quantity increased. */
|
|
2943
2912
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
2944
2913
|
/** Quantity decreased. */
|
|
2945
2914
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
2946
2915
|
}
|
|
2947
2916
|
/** @enumType */
|
|
2948
|
-
|
|
2949
|
-
|
|
2917
|
+
type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
|
|
2918
|
+
interface LineItemPriceChange {
|
|
2950
2919
|
/** Item price before update. */
|
|
2951
2920
|
originalPrice?: Price;
|
|
2952
2921
|
/** Item price after update. */
|
|
2953
2922
|
newPrice?: Price;
|
|
2954
2923
|
}
|
|
2955
|
-
|
|
2924
|
+
interface ManagedLineItem {
|
|
2956
2925
|
/**
|
|
2957
2926
|
* Line item ID.
|
|
2958
2927
|
* @format GUID
|
|
2959
2928
|
*/
|
|
2960
|
-
|
|
2929
|
+
_id?: string;
|
|
2961
2930
|
/** Item name. */
|
|
2962
2931
|
name?: ProductName;
|
|
2963
2932
|
/**
|
|
@@ -2967,12 +2936,12 @@ export interface ManagedLineItem {
|
|
|
2967
2936
|
*/
|
|
2968
2937
|
quantity?: number;
|
|
2969
2938
|
}
|
|
2970
|
-
|
|
2939
|
+
interface ManagedDiscount {
|
|
2971
2940
|
/**
|
|
2972
2941
|
* Discount id.
|
|
2973
2942
|
* @format GUID
|
|
2974
2943
|
*/
|
|
2975
|
-
|
|
2944
|
+
_id?: string;
|
|
2976
2945
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2977
2946
|
name?: TranslatedValue;
|
|
2978
2947
|
/** Line items discount applies to. */
|
|
@@ -2980,7 +2949,7 @@ export interface ManagedDiscount {
|
|
|
2980
2949
|
/** Discount amount. */
|
|
2981
2950
|
totalAmount?: Price;
|
|
2982
2951
|
}
|
|
2983
|
-
|
|
2952
|
+
interface TranslatedValue {
|
|
2984
2953
|
/**
|
|
2985
2954
|
* Value in site default language.
|
|
2986
2955
|
* @minLength 1
|
|
@@ -2992,23 +2961,23 @@ export interface TranslatedValue {
|
|
|
2992
2961
|
*/
|
|
2993
2962
|
translated?: string | null;
|
|
2994
2963
|
}
|
|
2995
|
-
|
|
2964
|
+
interface LineItemAmount {
|
|
2996
2965
|
/**
|
|
2997
2966
|
* Order line item id
|
|
2998
2967
|
* @format GUID
|
|
2999
2968
|
*/
|
|
3000
|
-
|
|
2969
|
+
_id?: string;
|
|
3001
2970
|
/** Item name. */
|
|
3002
2971
|
name?: ProductName;
|
|
3003
2972
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
3004
2973
|
amount?: Price;
|
|
3005
2974
|
}
|
|
3006
|
-
|
|
2975
|
+
interface ManagedAdditionalFee {
|
|
3007
2976
|
/**
|
|
3008
2977
|
* Additional fee id.
|
|
3009
2978
|
* @format GUID
|
|
3010
2979
|
*/
|
|
3011
|
-
|
|
2980
|
+
_id?: string;
|
|
3012
2981
|
/** Additional fee name. */
|
|
3013
2982
|
name?: TranslatedValue;
|
|
3014
2983
|
/** Line items additional fee applies to. */
|
|
@@ -3016,19 +2985,19 @@ export interface ManagedAdditionalFee {
|
|
|
3016
2985
|
/** Additional fee amount. */
|
|
3017
2986
|
totalAmount?: Price;
|
|
3018
2987
|
}
|
|
3019
|
-
|
|
2988
|
+
interface TotalPriceChange {
|
|
3020
2989
|
/** Order’s total price after discounts and tax. Before update */
|
|
3021
2990
|
originalTotal?: Price;
|
|
3022
2991
|
/** Order’s total price after discounts and tax. After update */
|
|
3023
2992
|
newTotal?: Price;
|
|
3024
2993
|
}
|
|
3025
|
-
|
|
2994
|
+
interface ShippingInformationChange {
|
|
3026
2995
|
/** Order’s Shipping Information. Before update */
|
|
3027
2996
|
originalShippingInfo?: ShippingInformation;
|
|
3028
2997
|
/** Order’s Shipping Information. After update */
|
|
3029
2998
|
newShippingInfo?: ShippingInformation;
|
|
3030
2999
|
}
|
|
3031
|
-
|
|
3000
|
+
interface ShippingInformation {
|
|
3032
3001
|
/** Order’s shipping price. */
|
|
3033
3002
|
total?: Price;
|
|
3034
3003
|
/**
|
|
@@ -3038,7 +3007,7 @@ export interface ShippingInformation {
|
|
|
3038
3007
|
shippingTitle?: string;
|
|
3039
3008
|
}
|
|
3040
3009
|
/** Payment method is saved for order */
|
|
3041
|
-
|
|
3010
|
+
interface SavedPaymentMethod {
|
|
3042
3011
|
/**
|
|
3043
3012
|
* Payment method name
|
|
3044
3013
|
* @minLength 1
|
|
@@ -3052,7 +3021,7 @@ export interface SavedPaymentMethod {
|
|
|
3052
3021
|
*/
|
|
3053
3022
|
description?: string | null;
|
|
3054
3023
|
}
|
|
3055
|
-
|
|
3024
|
+
interface AuthorizedPaymentCreated {
|
|
3056
3025
|
/**
|
|
3057
3026
|
* Payment ID of payment associated with this activity
|
|
3058
3027
|
* @format GUID
|
|
@@ -3071,7 +3040,7 @@ export interface AuthorizedPaymentCreated {
|
|
|
3071
3040
|
*/
|
|
3072
3041
|
brand?: string | null;
|
|
3073
3042
|
}
|
|
3074
|
-
|
|
3043
|
+
interface AuthorizedPaymentCaptured {
|
|
3075
3044
|
/**
|
|
3076
3045
|
* Payment ID of payment associated with this activity
|
|
3077
3046
|
* @format GUID
|
|
@@ -3090,7 +3059,7 @@ export interface AuthorizedPaymentCaptured {
|
|
|
3090
3059
|
*/
|
|
3091
3060
|
brand?: string | null;
|
|
3092
3061
|
}
|
|
3093
|
-
|
|
3062
|
+
interface AuthorizedPaymentVoided {
|
|
3094
3063
|
/**
|
|
3095
3064
|
* Payment ID of payment associated with this activity
|
|
3096
3065
|
* @format GUID
|
|
@@ -3109,7 +3078,7 @@ export interface AuthorizedPaymentVoided {
|
|
|
3109
3078
|
*/
|
|
3110
3079
|
brand?: string | null;
|
|
3111
3080
|
}
|
|
3112
|
-
|
|
3081
|
+
interface RefundInitiated {
|
|
3113
3082
|
/**
|
|
3114
3083
|
* Refund ID.
|
|
3115
3084
|
* @format GUID
|
|
@@ -3125,11 +3094,11 @@ export interface RefundInitiated {
|
|
|
3125
3094
|
payments?: RefundedPayment[];
|
|
3126
3095
|
/**
|
|
3127
3096
|
* Reason for refund.
|
|
3128
|
-
* @maxLength
|
|
3097
|
+
* @maxLength 200
|
|
3129
3098
|
*/
|
|
3130
3099
|
reason?: string | null;
|
|
3131
3100
|
}
|
|
3132
|
-
|
|
3101
|
+
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
3133
3102
|
/** Regular payment refund. */
|
|
3134
3103
|
regular?: RegularPaymentRefund;
|
|
3135
3104
|
/** Gift card payment refund. */
|
|
@@ -3145,7 +3114,7 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
3145
3114
|
externalRefund?: boolean;
|
|
3146
3115
|
}
|
|
3147
3116
|
/** @oneof */
|
|
3148
|
-
|
|
3117
|
+
interface RefundedPaymentKindOneOf {
|
|
3149
3118
|
/** Regular payment refund. */
|
|
3150
3119
|
regular?: RegularPaymentRefund;
|
|
3151
3120
|
/** Gift card payment refund. */
|
|
@@ -3153,7 +3122,7 @@ export interface RefundedPaymentKindOneOf {
|
|
|
3153
3122
|
/** Membership payment refund. */
|
|
3154
3123
|
membership?: MembershipPaymentRefund;
|
|
3155
3124
|
}
|
|
3156
|
-
|
|
3125
|
+
interface RegularPaymentRefund {
|
|
3157
3126
|
/** Refund amount */
|
|
3158
3127
|
amount?: Price;
|
|
3159
3128
|
/**
|
|
@@ -3167,7 +3136,7 @@ export interface RegularPaymentRefund {
|
|
|
3167
3136
|
*/
|
|
3168
3137
|
brand?: string | null;
|
|
3169
3138
|
}
|
|
3170
|
-
|
|
3139
|
+
interface GiftCardPaymentRefund {
|
|
3171
3140
|
/**
|
|
3172
3141
|
* Gift card payment ID
|
|
3173
3142
|
* @minLength 1
|
|
@@ -3177,7 +3146,7 @@ export interface GiftCardPaymentRefund {
|
|
|
3177
3146
|
/** Refund amount */
|
|
3178
3147
|
amount?: Price;
|
|
3179
3148
|
}
|
|
3180
|
-
|
|
3149
|
+
interface MembershipPaymentRefund {
|
|
3181
3150
|
/**
|
|
3182
3151
|
* Membership ID
|
|
3183
3152
|
* @minLength 1
|
|
@@ -3185,7 +3154,7 @@ export interface MembershipPaymentRefund {
|
|
|
3185
3154
|
*/
|
|
3186
3155
|
membershipId?: string | null;
|
|
3187
3156
|
}
|
|
3188
|
-
|
|
3157
|
+
interface PaymentRefunded {
|
|
3189
3158
|
/**
|
|
3190
3159
|
* Refund ID.
|
|
3191
3160
|
* @format GUID
|
|
@@ -3194,7 +3163,7 @@ export interface PaymentRefunded {
|
|
|
3194
3163
|
/** Details about the refunded payment. */
|
|
3195
3164
|
payment?: RefundedPayment;
|
|
3196
3165
|
}
|
|
3197
|
-
|
|
3166
|
+
interface PaymentRefundFailed {
|
|
3198
3167
|
/**
|
|
3199
3168
|
* Refund ID.
|
|
3200
3169
|
* @format GUID
|
|
@@ -3203,7 +3172,7 @@ export interface PaymentRefundFailed {
|
|
|
3203
3172
|
/** Details about the failed payment refund. */
|
|
3204
3173
|
payment?: RefundedPayment;
|
|
3205
3174
|
}
|
|
3206
|
-
|
|
3175
|
+
interface RefundedAsStoreCredit {
|
|
3207
3176
|
/** Refund amount */
|
|
3208
3177
|
amount?: Price;
|
|
3209
3178
|
/**
|
|
@@ -3212,7 +3181,7 @@ export interface RefundedAsStoreCredit {
|
|
|
3212
3181
|
*/
|
|
3213
3182
|
reason?: string | null;
|
|
3214
3183
|
}
|
|
3215
|
-
|
|
3184
|
+
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
3216
3185
|
/** Regular payment. */
|
|
3217
3186
|
regular?: RegularPayment;
|
|
3218
3187
|
/**
|
|
@@ -3222,22 +3191,22 @@ export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
3222
3191
|
paymentId?: string;
|
|
3223
3192
|
}
|
|
3224
3193
|
/** @oneof */
|
|
3225
|
-
|
|
3194
|
+
interface PaymentPendingPaymentDetailsOneOf {
|
|
3226
3195
|
/** Regular payment. */
|
|
3227
3196
|
regular?: RegularPayment;
|
|
3228
3197
|
}
|
|
3229
|
-
|
|
3198
|
+
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
3230
3199
|
/** Whether regular card used */
|
|
3231
3200
|
creditCardDetails?: CreditCardDetails;
|
|
3232
3201
|
/** Payment amount */
|
|
3233
3202
|
amount?: Price;
|
|
3234
3203
|
}
|
|
3235
3204
|
/** @oneof */
|
|
3236
|
-
|
|
3205
|
+
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
3237
3206
|
/** Whether regular card used */
|
|
3238
3207
|
creditCardDetails?: CreditCardDetails;
|
|
3239
3208
|
}
|
|
3240
|
-
|
|
3209
|
+
interface CreditCardDetails {
|
|
3241
3210
|
/**
|
|
3242
3211
|
* The last 4 digits of the card number.
|
|
3243
3212
|
* @maxLength 4
|
|
@@ -3249,7 +3218,7 @@ export interface CreditCardDetails {
|
|
|
3249
3218
|
*/
|
|
3250
3219
|
brand?: string | null;
|
|
3251
3220
|
}
|
|
3252
|
-
|
|
3221
|
+
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
3253
3222
|
/** Regular payment. */
|
|
3254
3223
|
regular?: RegularPayment;
|
|
3255
3224
|
/**
|
|
@@ -3259,11 +3228,11 @@ export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
3259
3228
|
paymentId?: string;
|
|
3260
3229
|
}
|
|
3261
3230
|
/** @oneof */
|
|
3262
|
-
|
|
3231
|
+
interface PaymentCanceledPaymentDetailsOneOf {
|
|
3263
3232
|
/** Regular payment. */
|
|
3264
3233
|
regular?: RegularPayment;
|
|
3265
3234
|
}
|
|
3266
|
-
|
|
3235
|
+
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
3267
3236
|
/** Regular payment. */
|
|
3268
3237
|
regular?: RegularPayment;
|
|
3269
3238
|
/**
|
|
@@ -3273,11 +3242,11 @@ export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
3273
3242
|
paymentId?: string;
|
|
3274
3243
|
}
|
|
3275
3244
|
/** @oneof */
|
|
3276
|
-
|
|
3245
|
+
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
3277
3246
|
/** Regular payment. */
|
|
3278
3247
|
regular?: RegularPayment;
|
|
3279
3248
|
}
|
|
3280
|
-
|
|
3249
|
+
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
3281
3250
|
/** Receipt created by Wix */
|
|
3282
3251
|
wixReceipt?: WixReceipt;
|
|
3283
3252
|
/** Receipt created by an external system. */
|
|
@@ -3289,13 +3258,13 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
3289
3258
|
paymentId?: string;
|
|
3290
3259
|
}
|
|
3291
3260
|
/** @oneof */
|
|
3292
|
-
|
|
3261
|
+
interface ReceiptCreatedReceiptInfoOneOf {
|
|
3293
3262
|
/** Receipt created by Wix */
|
|
3294
3263
|
wixReceipt?: WixReceipt;
|
|
3295
3264
|
/** Receipt created by an external system. */
|
|
3296
3265
|
externalReceipt?: ExternalReceipt;
|
|
3297
3266
|
}
|
|
3298
|
-
|
|
3267
|
+
interface WixReceipt {
|
|
3299
3268
|
/**
|
|
3300
3269
|
* Receipt ID
|
|
3301
3270
|
* @format GUID
|
|
@@ -3308,7 +3277,7 @@ export interface WixReceipt {
|
|
|
3308
3277
|
*/
|
|
3309
3278
|
displayNumber?: string | null;
|
|
3310
3279
|
}
|
|
3311
|
-
|
|
3280
|
+
interface ExternalReceipt {
|
|
3312
3281
|
/**
|
|
3313
3282
|
* Receipt ID
|
|
3314
3283
|
* @maxLength 100
|
|
@@ -3321,7 +3290,7 @@ export interface ExternalReceipt {
|
|
|
3321
3290
|
*/
|
|
3322
3291
|
displayNumber?: string | null;
|
|
3323
3292
|
}
|
|
3324
|
-
|
|
3293
|
+
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
3325
3294
|
/** Receipt created by Wix */
|
|
3326
3295
|
wixReceipt?: WixReceipt;
|
|
3327
3296
|
/** Receipt created by an external system. */
|
|
@@ -3333,13 +3302,13 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
3333
3302
|
paymentId?: string;
|
|
3334
3303
|
}
|
|
3335
3304
|
/** @oneof */
|
|
3336
|
-
|
|
3305
|
+
interface ReceiptSentReceiptInfoOneOf {
|
|
3337
3306
|
/** Receipt created by Wix */
|
|
3338
3307
|
wixReceipt?: WixReceipt;
|
|
3339
3308
|
/** Receipt created by an external system. */
|
|
3340
3309
|
externalReceipt?: ExternalReceipt;
|
|
3341
3310
|
}
|
|
3342
|
-
|
|
3311
|
+
declare enum ActivityType {
|
|
3343
3312
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
3344
3313
|
ORDER_PLACED = "ORDER_PLACED",
|
|
3345
3314
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -3377,14 +3346,14 @@ export declare enum ActivityType {
|
|
|
3377
3346
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
3378
3347
|
}
|
|
3379
3348
|
/** @enumType */
|
|
3380
|
-
|
|
3381
|
-
|
|
3349
|
+
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';
|
|
3350
|
+
declare enum AttributionSource {
|
|
3382
3351
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3383
3352
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
3384
3353
|
}
|
|
3385
3354
|
/** @enumType */
|
|
3386
|
-
|
|
3387
|
-
|
|
3355
|
+
type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
|
|
3356
|
+
interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3388
3357
|
/**
|
|
3389
3358
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3390
3359
|
* For example, via POS (point of service).
|
|
@@ -3408,7 +3377,7 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
3408
3377
|
appId?: string;
|
|
3409
3378
|
}
|
|
3410
3379
|
/** @oneof */
|
|
3411
|
-
|
|
3380
|
+
interface V1CreatedByStringOneOf {
|
|
3412
3381
|
/**
|
|
3413
3382
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3414
3383
|
* For example, via POS (point of service).
|
|
@@ -3431,7 +3400,7 @@ export interface V1CreatedByStringOneOf {
|
|
|
3431
3400
|
*/
|
|
3432
3401
|
appId?: string;
|
|
3433
3402
|
}
|
|
3434
|
-
|
|
3403
|
+
interface ChannelInfo {
|
|
3435
3404
|
/** Sales channel that submitted the order. */
|
|
3436
3405
|
type?: ChannelTypeWithLiterals;
|
|
3437
3406
|
/**
|
|
@@ -3445,7 +3414,7 @@ export interface ChannelInfo {
|
|
|
3445
3414
|
*/
|
|
3446
3415
|
externalOrderUrl?: string | null;
|
|
3447
3416
|
}
|
|
3448
|
-
|
|
3417
|
+
declare enum ChannelType {
|
|
3449
3418
|
/** Unspecified sales channel. This value is not supported. */
|
|
3450
3419
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3451
3420
|
/** A web client. */
|
|
@@ -3480,8 +3449,8 @@ export declare enum ChannelType {
|
|
|
3480
3449
|
FAIRE_COM = "FAIRE_COM"
|
|
3481
3450
|
}
|
|
3482
3451
|
/** @enumType */
|
|
3483
|
-
|
|
3484
|
-
|
|
3452
|
+
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';
|
|
3453
|
+
interface CustomField {
|
|
3485
3454
|
/** Custom field value. */
|
|
3486
3455
|
value?: any;
|
|
3487
3456
|
/**
|
|
@@ -3497,7 +3466,7 @@ export interface CustomField {
|
|
|
3497
3466
|
*/
|
|
3498
3467
|
translatedTitle?: string | null;
|
|
3499
3468
|
}
|
|
3500
|
-
|
|
3469
|
+
interface V1BalanceSummary {
|
|
3501
3470
|
/**
|
|
3502
3471
|
* Current amount left to pay.
|
|
3503
3472
|
* @readonly
|
|
@@ -3526,7 +3495,7 @@ export interface V1BalanceSummary {
|
|
|
3526
3495
|
*/
|
|
3527
3496
|
pending?: Price;
|
|
3528
3497
|
}
|
|
3529
|
-
|
|
3498
|
+
interface FulfillmentStatusesAggregate {
|
|
3530
3499
|
/** Unique string values based on Fulfillment entities statuses */
|
|
3531
3500
|
statuses?: string[] | null;
|
|
3532
3501
|
}
|
|
@@ -3552,13 +3521,13 @@ export interface FulfillmentStatusesAggregate {
|
|
|
3552
3521
|
* }
|
|
3553
3522
|
* }
|
|
3554
3523
|
*/
|
|
3555
|
-
|
|
3524
|
+
interface Tags {
|
|
3556
3525
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
3557
3526
|
privateTags?: TagList;
|
|
3558
3527
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
3559
3528
|
tags?: TagList;
|
|
3560
3529
|
}
|
|
3561
|
-
|
|
3530
|
+
interface TagList {
|
|
3562
3531
|
/**
|
|
3563
3532
|
* List of tag IDs
|
|
3564
3533
|
* @maxSize 100
|
|
@@ -3566,7 +3535,7 @@ export interface TagList {
|
|
|
3566
3535
|
*/
|
|
3567
3536
|
tagIds?: string[];
|
|
3568
3537
|
}
|
|
3569
|
-
|
|
3538
|
+
interface CreateOrderFromDraftRequest {
|
|
3570
3539
|
/**
|
|
3571
3540
|
* Draft order ID.
|
|
3572
3541
|
* @format GUID
|
|
@@ -3582,11 +3551,11 @@ export interface CreateOrderFromDraftRequest {
|
|
|
3582
3551
|
/** Information about the sales channel that submitted this order. */
|
|
3583
3552
|
channelInfo?: ChannelInfo;
|
|
3584
3553
|
}
|
|
3585
|
-
|
|
3554
|
+
interface OrderCreateSettings {
|
|
3586
3555
|
/** Notification settings to be applied on order creation */
|
|
3587
3556
|
notifications?: OrderCreateNotifications;
|
|
3588
3557
|
}
|
|
3589
|
-
|
|
3558
|
+
interface OrderCreateNotifications {
|
|
3590
3559
|
/**
|
|
3591
3560
|
* Whether to send notification to the buyer.
|
|
3592
3561
|
*
|
|
@@ -3600,26 +3569,26 @@ export interface OrderCreateNotifications {
|
|
|
3600
3569
|
*/
|
|
3601
3570
|
sendNotificationsToBusiness?: boolean | null;
|
|
3602
3571
|
}
|
|
3603
|
-
|
|
3572
|
+
interface CreateOrderFromDraftResponse {
|
|
3604
3573
|
/** Draft order after commit. */
|
|
3605
3574
|
committedDraftOrder?: DraftOrder;
|
|
3606
3575
|
/** Created order. */
|
|
3607
3576
|
createdOrder?: Order;
|
|
3608
3577
|
}
|
|
3609
|
-
|
|
3578
|
+
interface DeleteDraftOrderRequest {
|
|
3610
3579
|
/**
|
|
3611
3580
|
* Draft order ID.
|
|
3612
3581
|
* @format GUID
|
|
3613
3582
|
*/
|
|
3614
3583
|
draftOrderId: string;
|
|
3615
3584
|
}
|
|
3616
|
-
|
|
3585
|
+
interface DeleteDraftOrderResponse {
|
|
3617
3586
|
}
|
|
3618
|
-
|
|
3587
|
+
interface QueryDraftOrdersRequest {
|
|
3619
3588
|
/** Query options. */
|
|
3620
3589
|
query?: CursorQuery;
|
|
3621
3590
|
}
|
|
3622
|
-
|
|
3591
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3623
3592
|
/**
|
|
3624
3593
|
* Cursor paging options.
|
|
3625
3594
|
*
|
|
@@ -3641,7 +3610,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3641
3610
|
sort?: Sorting[];
|
|
3642
3611
|
}
|
|
3643
3612
|
/** @oneof */
|
|
3644
|
-
|
|
3613
|
+
interface CursorQueryPagingMethodOneOf {
|
|
3645
3614
|
/**
|
|
3646
3615
|
* Cursor paging options.
|
|
3647
3616
|
*
|
|
@@ -3649,7 +3618,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
3649
3618
|
*/
|
|
3650
3619
|
cursorPaging?: CursorPaging;
|
|
3651
3620
|
}
|
|
3652
|
-
|
|
3621
|
+
interface Sorting {
|
|
3653
3622
|
/**
|
|
3654
3623
|
* Name of the field to sort by.
|
|
3655
3624
|
* @maxLength 512
|
|
@@ -3658,13 +3627,13 @@ export interface Sorting {
|
|
|
3658
3627
|
/** Sort order. */
|
|
3659
3628
|
order?: SortOrderWithLiterals;
|
|
3660
3629
|
}
|
|
3661
|
-
|
|
3630
|
+
declare enum SortOrder {
|
|
3662
3631
|
ASC = "ASC",
|
|
3663
3632
|
DESC = "DESC"
|
|
3664
3633
|
}
|
|
3665
3634
|
/** @enumType */
|
|
3666
|
-
|
|
3667
|
-
|
|
3635
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
3636
|
+
interface CursorPaging {
|
|
3668
3637
|
/**
|
|
3669
3638
|
* Maximum number of items to return in the results.
|
|
3670
3639
|
* @max 100
|
|
@@ -3679,13 +3648,13 @@ export interface CursorPaging {
|
|
|
3679
3648
|
*/
|
|
3680
3649
|
cursor?: string | null;
|
|
3681
3650
|
}
|
|
3682
|
-
|
|
3651
|
+
interface QueryDraftOrdersResponse {
|
|
3683
3652
|
/** Draft orders, found by query. */
|
|
3684
3653
|
draftOrders?: DraftOrder[];
|
|
3685
3654
|
/** Paging metadata. */
|
|
3686
3655
|
pagingMetadata?: CursorPagingMetadata;
|
|
3687
3656
|
}
|
|
3688
|
-
|
|
3657
|
+
interface CursorPagingMetadata {
|
|
3689
3658
|
/** Number of items returned in current page. */
|
|
3690
3659
|
count?: number | null;
|
|
3691
3660
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -3698,7 +3667,7 @@ export interface CursorPagingMetadata {
|
|
|
3698
3667
|
*/
|
|
3699
3668
|
hasNext?: boolean | null;
|
|
3700
3669
|
}
|
|
3701
|
-
|
|
3670
|
+
interface Cursors {
|
|
3702
3671
|
/**
|
|
3703
3672
|
* Cursor string pointing to the next page in the list of results.
|
|
3704
3673
|
* @maxLength 16000
|
|
@@ -3710,19 +3679,19 @@ export interface Cursors {
|
|
|
3710
3679
|
*/
|
|
3711
3680
|
prev?: string | null;
|
|
3712
3681
|
}
|
|
3713
|
-
|
|
3682
|
+
interface UpdateExtendedFieldsRequest {
|
|
3714
3683
|
/** ID of the entity to update. */
|
|
3715
|
-
|
|
3684
|
+
_id: string;
|
|
3716
3685
|
/** Identifier for the app whose extended fields are being updated. */
|
|
3717
3686
|
namespace: string;
|
|
3718
3687
|
/** 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
3688
|
namespaceData: Record<string, any> | null;
|
|
3720
3689
|
}
|
|
3721
|
-
|
|
3690
|
+
interface UpdateExtendedFieldsResponse {
|
|
3722
3691
|
/** Updated draft order. */
|
|
3723
3692
|
draftOrder?: DraftOrder;
|
|
3724
3693
|
}
|
|
3725
|
-
|
|
3694
|
+
interface SetTaxExemptionRequest {
|
|
3726
3695
|
/**
|
|
3727
3696
|
* Draft order ID.
|
|
3728
3697
|
* @format GUID
|
|
@@ -3735,11 +3704,11 @@ export interface SetTaxExemptionRequest {
|
|
|
3735
3704
|
*/
|
|
3736
3705
|
taxExempt: boolean | null;
|
|
3737
3706
|
}
|
|
3738
|
-
|
|
3707
|
+
interface SetTaxExemptionResponse {
|
|
3739
3708
|
/** Draft order calculated with the latest changes. */
|
|
3740
3709
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3741
3710
|
}
|
|
3742
|
-
|
|
3711
|
+
interface SetBusinessLocationRequest {
|
|
3743
3712
|
/**
|
|
3744
3713
|
* Draft order ID.
|
|
3745
3714
|
* @format GUID
|
|
@@ -3748,17 +3717,17 @@ export interface SetBusinessLocationRequest {
|
|
|
3748
3717
|
/** Business location. */
|
|
3749
3718
|
businessLocation?: Location;
|
|
3750
3719
|
}
|
|
3751
|
-
|
|
3720
|
+
interface SetBusinessLocationResponse {
|
|
3752
3721
|
/** Draft order calculated with the latest changes. */
|
|
3753
3722
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3754
3723
|
}
|
|
3755
|
-
|
|
3724
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3756
3725
|
createdEvent?: EntityCreatedEvent;
|
|
3757
3726
|
updatedEvent?: EntityUpdatedEvent;
|
|
3758
3727
|
deletedEvent?: EntityDeletedEvent;
|
|
3759
3728
|
actionEvent?: ActionEvent;
|
|
3760
3729
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3761
|
-
|
|
3730
|
+
_id?: string;
|
|
3762
3731
|
/**
|
|
3763
3732
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3764
3733
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -3787,36 +3756,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3787
3756
|
entityEventSequence?: string | null;
|
|
3788
3757
|
}
|
|
3789
3758
|
/** @oneof */
|
|
3790
|
-
|
|
3759
|
+
interface DomainEventBodyOneOf {
|
|
3791
3760
|
createdEvent?: EntityCreatedEvent;
|
|
3792
3761
|
updatedEvent?: EntityUpdatedEvent;
|
|
3793
3762
|
deletedEvent?: EntityDeletedEvent;
|
|
3794
3763
|
actionEvent?: ActionEvent;
|
|
3795
3764
|
}
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3799
|
-
restoreInfo?: RestoreInfo;
|
|
3765
|
+
interface EntityCreatedEvent {
|
|
3766
|
+
entity?: string;
|
|
3800
3767
|
}
|
|
3801
|
-
|
|
3768
|
+
interface RestoreInfo {
|
|
3802
3769
|
deletedDate?: Date | null;
|
|
3803
3770
|
}
|
|
3804
|
-
|
|
3771
|
+
interface EntityUpdatedEvent {
|
|
3805
3772
|
/**
|
|
3806
3773
|
* 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
3774
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3808
3775
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3809
3776
|
*/
|
|
3810
|
-
|
|
3777
|
+
currentEntity?: string;
|
|
3811
3778
|
}
|
|
3812
|
-
|
|
3779
|
+
interface EntityDeletedEvent {
|
|
3813
3780
|
/** Entity that was deleted. */
|
|
3814
|
-
|
|
3781
|
+
deletedEntity?: string | null;
|
|
3815
3782
|
}
|
|
3816
|
-
|
|
3817
|
-
|
|
3783
|
+
interface ActionEvent {
|
|
3784
|
+
body?: string;
|
|
3818
3785
|
}
|
|
3819
|
-
|
|
3786
|
+
interface MessageEnvelope {
|
|
3820
3787
|
/**
|
|
3821
3788
|
* App instance ID.
|
|
3822
3789
|
* @format GUID
|
|
@@ -3832,7 +3799,7 @@ export interface MessageEnvelope {
|
|
|
3832
3799
|
/** Stringify payload. */
|
|
3833
3800
|
data?: string;
|
|
3834
3801
|
}
|
|
3835
|
-
|
|
3802
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3836
3803
|
/**
|
|
3837
3804
|
* ID of a site visitor that has not logged in to the site.
|
|
3838
3805
|
* @format GUID
|
|
@@ -3857,7 +3824,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3857
3824
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3858
3825
|
}
|
|
3859
3826
|
/** @oneof */
|
|
3860
|
-
|
|
3827
|
+
interface IdentificationDataIdOneOf {
|
|
3861
3828
|
/**
|
|
3862
3829
|
* ID of a site visitor that has not logged in to the site.
|
|
3863
3830
|
* @format GUID
|
|
@@ -3879,7 +3846,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
3879
3846
|
*/
|
|
3880
3847
|
appId?: string;
|
|
3881
3848
|
}
|
|
3882
|
-
|
|
3849
|
+
declare enum WebhookIdentityType {
|
|
3883
3850
|
UNKNOWN = "UNKNOWN",
|
|
3884
3851
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3885
3852
|
MEMBER = "MEMBER",
|
|
@@ -3887,4 +3854,240 @@ export declare enum WebhookIdentityType {
|
|
|
3887
3854
|
APP = "APP"
|
|
3888
3855
|
}
|
|
3889
3856
|
/** @enumType */
|
|
3890
|
-
|
|
3857
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3858
|
+
interface BaseEventMetadata {
|
|
3859
|
+
/**
|
|
3860
|
+
* App instance ID.
|
|
3861
|
+
* @format GUID
|
|
3862
|
+
*/
|
|
3863
|
+
instanceId?: string | null;
|
|
3864
|
+
/**
|
|
3865
|
+
* Event type.
|
|
3866
|
+
* @maxLength 150
|
|
3867
|
+
*/
|
|
3868
|
+
eventType?: string;
|
|
3869
|
+
/** The identification type and identity data. */
|
|
3870
|
+
identity?: IdentificationData;
|
|
3871
|
+
}
|
|
3872
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
3873
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3874
|
+
_id?: string;
|
|
3875
|
+
/**
|
|
3876
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3877
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3878
|
+
*/
|
|
3879
|
+
entityFqdn?: string;
|
|
3880
|
+
/**
|
|
3881
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3882
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3883
|
+
*/
|
|
3884
|
+
slug?: string;
|
|
3885
|
+
/** ID of the entity associated with the event. */
|
|
3886
|
+
entityId?: string;
|
|
3887
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3888
|
+
eventTime?: Date | null;
|
|
3889
|
+
/**
|
|
3890
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3891
|
+
* (for example, GDPR).
|
|
3892
|
+
*/
|
|
3893
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3894
|
+
/** If present, indicates the action that triggered the event. */
|
|
3895
|
+
originatedFrom?: string | null;
|
|
3896
|
+
/**
|
|
3897
|
+
* 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.
|
|
3898
|
+
* 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.
|
|
3899
|
+
*/
|
|
3900
|
+
entityEventSequence?: string | null;
|
|
3901
|
+
}
|
|
3902
|
+
interface DraftOrderCreatedEnvelope {
|
|
3903
|
+
entity: DraftOrder;
|
|
3904
|
+
metadata: EventMetadata;
|
|
3905
|
+
}
|
|
3906
|
+
interface DraftOrderDeletedEnvelope {
|
|
3907
|
+
metadata: EventMetadata;
|
|
3908
|
+
}
|
|
3909
|
+
interface DraftOrderUpdatedEnvelope {
|
|
3910
|
+
entity: DraftOrder;
|
|
3911
|
+
metadata: EventMetadata;
|
|
3912
|
+
}
|
|
3913
|
+
interface AddLineItemsToDraftOrderOptions {
|
|
3914
|
+
/**
|
|
3915
|
+
* Catalog line items to add to draft order.
|
|
3916
|
+
* @maxSize 300
|
|
3917
|
+
*/
|
|
3918
|
+
catalogLineItems?: CatalogReferenceLineItem[];
|
|
3919
|
+
/**
|
|
3920
|
+
* Custom line items to add to draft order.
|
|
3921
|
+
*
|
|
3922
|
+
* Custom line items do not trigger the Catalog Service Plugin.
|
|
3923
|
+
* @maxSize 300
|
|
3924
|
+
*/
|
|
3925
|
+
customLineItems?: CustomLineItem[];
|
|
3926
|
+
}
|
|
3927
|
+
interface CreateCustomDiscountsOptions {
|
|
3928
|
+
/**
|
|
3929
|
+
* Custom discounts to create.
|
|
3930
|
+
*
|
|
3931
|
+
* Created discounts are not applied by default.
|
|
3932
|
+
* @minSize 1
|
|
3933
|
+
* @maxSize 100
|
|
3934
|
+
*/
|
|
3935
|
+
discounts?: DiscountOption[];
|
|
3936
|
+
}
|
|
3937
|
+
interface CreateCustomAdditionalFeesOptions {
|
|
3938
|
+
/**
|
|
3939
|
+
* Custom additional fees to create.
|
|
3940
|
+
*
|
|
3941
|
+
* Created additional fees are not applied by default.
|
|
3942
|
+
* @minSize 1
|
|
3943
|
+
* @maxSize 100
|
|
3944
|
+
*/
|
|
3945
|
+
customAdditionalFees?: AdditionalFeeOption[];
|
|
3946
|
+
}
|
|
3947
|
+
interface SetShippingInfoOptions {
|
|
3948
|
+
/**
|
|
3949
|
+
* Shipping info to set on the draft order.
|
|
3950
|
+
*
|
|
3951
|
+
* > **Note:** Passing an empty object will remove the existing shipping info.
|
|
3952
|
+
*/
|
|
3953
|
+
shippingInfo?: V1ShippingInformation;
|
|
3954
|
+
}
|
|
3955
|
+
interface SetBuyerInfoOptions {
|
|
3956
|
+
/**
|
|
3957
|
+
* Shipping info to set on the draft order.
|
|
3958
|
+
*
|
|
3959
|
+
* > **Note:** Passing an empty object will remove the existing shipping info.
|
|
3960
|
+
*/
|
|
3961
|
+
buyerInfo?: BuyerInfo;
|
|
3962
|
+
}
|
|
3963
|
+
interface SetRecipientInfoOptions {
|
|
3964
|
+
/**
|
|
3965
|
+
* Recipient address and contact details.
|
|
3966
|
+
*
|
|
3967
|
+
* > **Note:** Passing an empty object will remove the existing recipient info.
|
|
3968
|
+
*/
|
|
3969
|
+
recipientInfo?: AddressWithContact;
|
|
3970
|
+
}
|
|
3971
|
+
interface SetBillingInfoOptions {
|
|
3972
|
+
/**
|
|
3973
|
+
* Billing address and contact details.
|
|
3974
|
+
*
|
|
3975
|
+
* > **Note:** Passing an empty object will remove the existing billing info.
|
|
3976
|
+
*/
|
|
3977
|
+
billingInfo?: AddressWithContact;
|
|
3978
|
+
}
|
|
3979
|
+
interface CommitDraftOrderOptions {
|
|
3980
|
+
/** Optional side effects to trigger. */
|
|
3981
|
+
commitSettings?: DraftOrderCommitSettings;
|
|
3982
|
+
/**
|
|
3983
|
+
* Reason for edit, provided by user (optional).
|
|
3984
|
+
* @maxLength 200
|
|
3985
|
+
*/
|
|
3986
|
+
reason?: string | null;
|
|
3987
|
+
}
|
|
3988
|
+
interface CreateOrderFromDraftOptions {
|
|
3989
|
+
/** Optional side effects to trigger. */
|
|
3990
|
+
createSettings?: OrderCreateSettings;
|
|
3991
|
+
/**
|
|
3992
|
+
* Reason for order creation, provided by user (optional).
|
|
3993
|
+
* @maxLength 200
|
|
3994
|
+
*/
|
|
3995
|
+
reason?: string | null;
|
|
3996
|
+
/** Information about the sales channel that submitted this order. */
|
|
3997
|
+
channelInfo?: ChannelInfo;
|
|
3998
|
+
}
|
|
3999
|
+
interface QueryCursorResult {
|
|
4000
|
+
cursors: Cursors;
|
|
4001
|
+
hasNext: () => boolean;
|
|
4002
|
+
hasPrev: () => boolean;
|
|
4003
|
+
length: number;
|
|
4004
|
+
pageSize: number;
|
|
4005
|
+
}
|
|
4006
|
+
interface DraftOrdersQueryResult extends QueryCursorResult {
|
|
4007
|
+
items: DraftOrder[];
|
|
4008
|
+
query: DraftOrdersQueryBuilder;
|
|
4009
|
+
next: () => Promise<DraftOrdersQueryResult>;
|
|
4010
|
+
prev: () => Promise<DraftOrdersQueryResult>;
|
|
4011
|
+
}
|
|
4012
|
+
interface DraftOrdersQueryBuilder {
|
|
4013
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4014
|
+
* @param value - Value to compare against.
|
|
4015
|
+
* @documentationMaturity preview
|
|
4016
|
+
*/
|
|
4017
|
+
eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
4018
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4019
|
+
* @param value - Value to compare against.
|
|
4020
|
+
* @documentationMaturity preview
|
|
4021
|
+
*/
|
|
4022
|
+
ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
4023
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4024
|
+
* @param value - Value to compare against.
|
|
4025
|
+
* @documentationMaturity preview
|
|
4026
|
+
*/
|
|
4027
|
+
ge: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4028
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4029
|
+
* @param value - Value to compare against.
|
|
4030
|
+
* @documentationMaturity preview
|
|
4031
|
+
*/
|
|
4032
|
+
gt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4033
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4034
|
+
* @param value - Value to compare against.
|
|
4035
|
+
* @documentationMaturity preview
|
|
4036
|
+
*/
|
|
4037
|
+
le: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4038
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
4039
|
+
* @param value - Value to compare against.
|
|
4040
|
+
* @documentationMaturity preview
|
|
4041
|
+
*/
|
|
4042
|
+
lt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4043
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
4044
|
+
* @param string - String to compare against. Case-insensitive.
|
|
4045
|
+
* @documentationMaturity preview
|
|
4046
|
+
*/
|
|
4047
|
+
startsWith: (propertyName: 'orderId', value: string) => DraftOrdersQueryBuilder;
|
|
4048
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
4049
|
+
* @param values - List of values to compare against.
|
|
4050
|
+
* @documentationMaturity preview
|
|
4051
|
+
*/
|
|
4052
|
+
hasSome: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;
|
|
4053
|
+
/** @documentationMaturity preview */
|
|
4054
|
+
in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
4055
|
+
/** @documentationMaturity preview */
|
|
4056
|
+
exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;
|
|
4057
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
4058
|
+
* @documentationMaturity preview
|
|
4059
|
+
*/
|
|
4060
|
+
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
4061
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
4062
|
+
* @documentationMaturity preview
|
|
4063
|
+
*/
|
|
4064
|
+
descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
4065
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
4066
|
+
* @documentationMaturity preview
|
|
4067
|
+
*/
|
|
4068
|
+
limit: (limit: number) => DraftOrdersQueryBuilder;
|
|
4069
|
+
/** @param cursor - A pointer to specific record
|
|
4070
|
+
* @documentationMaturity preview
|
|
4071
|
+
*/
|
|
4072
|
+
skipTo: (cursor: string) => DraftOrdersQueryBuilder;
|
|
4073
|
+
/** @documentationMaturity preview */
|
|
4074
|
+
find: () => Promise<DraftOrdersQueryResult>;
|
|
4075
|
+
}
|
|
4076
|
+
interface UpdateExtendedFieldsOptions {
|
|
4077
|
+
/** 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. */
|
|
4078
|
+
namespaceData: Record<string, any> | null;
|
|
4079
|
+
}
|
|
4080
|
+
interface SetTaxExemptionOptions {
|
|
4081
|
+
/**
|
|
4082
|
+
* Whether the draft order is exempt from tax calculations.
|
|
4083
|
+
*
|
|
4084
|
+
* Default: `false`
|
|
4085
|
+
*/
|
|
4086
|
+
taxExempt: boolean | null;
|
|
4087
|
+
}
|
|
4088
|
+
interface SetBusinessLocationOptions {
|
|
4089
|
+
/** Business location. */
|
|
4090
|
+
businessLocation?: Location;
|
|
4091
|
+
}
|
|
4092
|
+
|
|
4093
|
+
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 };
|