@wix/auto_sdk_ecom_draft-orders 1.0.19 → 1.0.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +26 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +57 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +97 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +2951 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +60 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +446 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +209 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +168 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -0
- package/build/{ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.mts → cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts} +336 -429
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +360 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +4055 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +1899 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +26 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +26 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +97 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +2926 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +60 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js +398 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +209 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +114 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -0
- package/build/{ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.ts → es/src/ecom-v1-draft-order-draft-orders.types.d.ts} +336 -429
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +357 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +4055 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +1851 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +26 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +57 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +97 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +2951 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +60 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +446 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +209 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +168 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -0
- package/build/internal/{ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.mts → cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts} +336 -889
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +360 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +4515 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +1899 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +26 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +26 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +97 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +2926 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +60 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js +398 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +209 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +114 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -0
- package/build/internal/{ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.ts → es/src/ecom-v1-draft-order-draft-orders.types.d.ts} +336 -889
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +357 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +4515 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +1851 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -232
- package/build/index.d.ts +0 -232
- package/build/index.js +0 -4593
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -4520
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -232
- package/build/internal/index.d.ts +0 -232
- package/build/internal/index.js +0 -4593
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -4520
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -2751
- package/build/internal/meta.d.ts +0 -2751
- package/build/internal/meta.js +0 -3323
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -3275
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -2751
- package/build/meta.d.ts +0 -2751
- package/build/meta.js +0 -3323
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -3275
- package/build/meta.mjs.map +0 -1
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
/** DraftOrder is the main entity of DraftOrders service. It represents a single edit order. */
|
|
2
|
-
interface DraftOrder {
|
|
2
|
+
export interface DraftOrder {
|
|
3
3
|
/**
|
|
4
4
|
* Draft order ID.
|
|
5
5
|
* @format GUID
|
|
6
6
|
* @readonly
|
|
7
7
|
*/
|
|
8
|
-
|
|
8
|
+
id?: string | null;
|
|
9
9
|
/**
|
|
10
10
|
* ID of the order this draft commits to.
|
|
11
11
|
* @format GUID
|
|
@@ -53,12 +53,12 @@ interface DraftOrder {
|
|
|
53
53
|
* Date and time the draft order was created.
|
|
54
54
|
* @readonly
|
|
55
55
|
*/
|
|
56
|
-
|
|
56
|
+
createdDate?: Date | null;
|
|
57
57
|
/**
|
|
58
58
|
* Date and time the draft order was updated.
|
|
59
59
|
* @readonly
|
|
60
60
|
*/
|
|
61
|
-
|
|
61
|
+
updatedDate?: Date | null;
|
|
62
62
|
/**
|
|
63
63
|
* Identity of the draft order's initiator.
|
|
64
64
|
* @readonly
|
|
@@ -122,7 +122,7 @@ interface DraftOrder {
|
|
|
122
122
|
*/
|
|
123
123
|
businessLocationDetails?: BusinessLocationDetails;
|
|
124
124
|
}
|
|
125
|
-
interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
125
|
+
export interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
126
126
|
/** Whether the line item was added as part of the draft. */
|
|
127
127
|
added?: boolean;
|
|
128
128
|
/** Line item fields before the change. */
|
|
@@ -133,7 +133,7 @@ interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
|
133
133
|
lineItem?: OrderLineItem;
|
|
134
134
|
}
|
|
135
135
|
/** @oneof */
|
|
136
|
-
interface ItemDetailsChangeTypeOneOf {
|
|
136
|
+
export interface ItemDetailsChangeTypeOneOf {
|
|
137
137
|
/** Whether the line item was added as part of the draft. */
|
|
138
138
|
added?: boolean;
|
|
139
139
|
/** Line item fields before the change. */
|
|
@@ -141,7 +141,7 @@ interface ItemDetailsChangeTypeOneOf {
|
|
|
141
141
|
/** Whether the line item was removed as part of the draft. */
|
|
142
142
|
removed?: boolean;
|
|
143
143
|
}
|
|
144
|
-
interface Price {
|
|
144
|
+
export interface Price {
|
|
145
145
|
/**
|
|
146
146
|
* Amount.
|
|
147
147
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -153,7 +153,7 @@ interface Price {
|
|
|
153
153
|
*/
|
|
154
154
|
formattedAmount?: string;
|
|
155
155
|
}
|
|
156
|
-
interface PriceDescription {
|
|
156
|
+
export interface PriceDescription {
|
|
157
157
|
/**
|
|
158
158
|
* __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
159
159
|
* @minLength 1
|
|
@@ -169,12 +169,12 @@ interface PriceDescription {
|
|
|
169
169
|
*/
|
|
170
170
|
translated?: string | null;
|
|
171
171
|
}
|
|
172
|
-
interface OrderLineItem {
|
|
172
|
+
export interface OrderLineItem {
|
|
173
173
|
/**
|
|
174
174
|
* Line item ID.
|
|
175
175
|
* @immutable
|
|
176
176
|
*/
|
|
177
|
-
|
|
177
|
+
id?: string;
|
|
178
178
|
/**
|
|
179
179
|
* Item name.
|
|
180
180
|
* + Stores - `product.name`
|
|
@@ -204,7 +204,7 @@ interface OrderLineItem {
|
|
|
204
204
|
*/
|
|
205
205
|
descriptionLines?: DescriptionLine[];
|
|
206
206
|
/** Line item image. */
|
|
207
|
-
image?:
|
|
207
|
+
image?: Image;
|
|
208
208
|
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
209
209
|
physicalProperties?: PhysicalProperties;
|
|
210
210
|
/** Item type. Either a preset type or custom. */
|
|
@@ -286,7 +286,7 @@ interface OrderLineItem {
|
|
|
286
286
|
*/
|
|
287
287
|
extendedFields?: ExtendedFields;
|
|
288
288
|
}
|
|
289
|
-
interface ProductName {
|
|
289
|
+
export interface ProductName {
|
|
290
290
|
/**
|
|
291
291
|
* __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).
|
|
292
292
|
*
|
|
@@ -308,7 +308,7 @@ interface ProductName {
|
|
|
308
308
|
translated?: string | null;
|
|
309
309
|
}
|
|
310
310
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
311
|
-
interface CatalogReference {
|
|
311
|
+
export interface CatalogReference {
|
|
312
312
|
/**
|
|
313
313
|
* ID of the item within the catalog it belongs to.
|
|
314
314
|
* @minLength 1
|
|
@@ -334,7 +334,7 @@ interface CatalogReference {
|
|
|
334
334
|
*/
|
|
335
335
|
options?: Record<string, any> | null;
|
|
336
336
|
}
|
|
337
|
-
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
337
|
+
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
338
338
|
/** Description line plain text value. */
|
|
339
339
|
plainText?: PlainTextValue;
|
|
340
340
|
/** Description line color value. */
|
|
@@ -343,16 +343,16 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
343
343
|
name?: DescriptionLineName;
|
|
344
344
|
}
|
|
345
345
|
/** @oneof */
|
|
346
|
-
interface DescriptionLineValueOneOf {
|
|
346
|
+
export interface DescriptionLineValueOneOf {
|
|
347
347
|
/** Description line plain text value. */
|
|
348
348
|
plainText?: PlainTextValue;
|
|
349
349
|
/** Description line color value. */
|
|
350
350
|
colorInfo?: Color;
|
|
351
351
|
}
|
|
352
352
|
/** @oneof */
|
|
353
|
-
interface DescriptionLineDescriptionLineValueOneOf {
|
|
353
|
+
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
354
354
|
}
|
|
355
|
-
interface DescriptionLineName {
|
|
355
|
+
export interface DescriptionLineName {
|
|
356
356
|
/**
|
|
357
357
|
* Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
358
358
|
* @maxLength 100
|
|
@@ -366,7 +366,7 @@ interface DescriptionLineName {
|
|
|
366
366
|
*/
|
|
367
367
|
translated?: string | null;
|
|
368
368
|
}
|
|
369
|
-
interface PlainTextValue {
|
|
369
|
+
export interface PlainTextValue {
|
|
370
370
|
/**
|
|
371
371
|
* Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
372
372
|
* @maxLength 600
|
|
@@ -380,7 +380,7 @@ interface PlainTextValue {
|
|
|
380
380
|
*/
|
|
381
381
|
translated?: string | null;
|
|
382
382
|
}
|
|
383
|
-
interface Color {
|
|
383
|
+
export interface Color {
|
|
384
384
|
/**
|
|
385
385
|
* Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
386
386
|
* @maxLength 500
|
|
@@ -396,7 +396,7 @@ interface Color {
|
|
|
396
396
|
/** HEX or RGB color code for display. */
|
|
397
397
|
code?: string | null;
|
|
398
398
|
}
|
|
399
|
-
declare enum DescriptionLineType {
|
|
399
|
+
export declare enum DescriptionLineType {
|
|
400
400
|
/** Unrecognized type. */
|
|
401
401
|
UNRECOGNISED = "UNRECOGNISED",
|
|
402
402
|
/** Plain text type. */
|
|
@@ -404,7 +404,30 @@ declare enum DescriptionLineType {
|
|
|
404
404
|
/** Color type. */
|
|
405
405
|
COLOR = "COLOR"
|
|
406
406
|
}
|
|
407
|
-
interface
|
|
407
|
+
export interface Image {
|
|
408
|
+
/** WixMedia image ID. */
|
|
409
|
+
id?: string;
|
|
410
|
+
/** Image URL. */
|
|
411
|
+
url?: string;
|
|
412
|
+
/**
|
|
413
|
+
* Original image height.
|
|
414
|
+
* @readonly
|
|
415
|
+
*/
|
|
416
|
+
height?: number;
|
|
417
|
+
/**
|
|
418
|
+
* Original image width.
|
|
419
|
+
* @readonly
|
|
420
|
+
*/
|
|
421
|
+
width?: number;
|
|
422
|
+
/** Image alt text. */
|
|
423
|
+
altText?: string | null;
|
|
424
|
+
/**
|
|
425
|
+
* Image filename.
|
|
426
|
+
* @readonly
|
|
427
|
+
*/
|
|
428
|
+
filename?: string | null;
|
|
429
|
+
}
|
|
430
|
+
export interface FocalPoint {
|
|
408
431
|
/** X-coordinate of the focal point. */
|
|
409
432
|
x?: number;
|
|
410
433
|
/** Y-coordinate of the focal point. */
|
|
@@ -414,7 +437,7 @@ interface FocalPoint {
|
|
|
414
437
|
/** crop by width */
|
|
415
438
|
width?: number | null;
|
|
416
439
|
}
|
|
417
|
-
interface PhysicalProperties {
|
|
440
|
+
export interface PhysicalProperties {
|
|
418
441
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
419
442
|
weight?: number | null;
|
|
420
443
|
/**
|
|
@@ -425,20 +448,20 @@ interface PhysicalProperties {
|
|
|
425
448
|
/** Whether this line item is shippable. */
|
|
426
449
|
shippable?: boolean;
|
|
427
450
|
}
|
|
428
|
-
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
451
|
+
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
429
452
|
/** Preset item type. */
|
|
430
453
|
preset?: ItemTypeItemType;
|
|
431
454
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
432
455
|
custom?: string;
|
|
433
456
|
}
|
|
434
457
|
/** @oneof */
|
|
435
|
-
interface ItemTypeItemTypeDataOneOf {
|
|
458
|
+
export interface ItemTypeItemTypeDataOneOf {
|
|
436
459
|
/** Preset item type. */
|
|
437
460
|
preset?: ItemTypeItemType;
|
|
438
461
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
439
462
|
custom?: string;
|
|
440
463
|
}
|
|
441
|
-
declare enum ItemTypeItemType {
|
|
464
|
+
export declare enum ItemTypeItemType {
|
|
442
465
|
UNRECOGNISED = "UNRECOGNISED",
|
|
443
466
|
PHYSICAL = "PHYSICAL",
|
|
444
467
|
DIGITAL = "DIGITAL",
|
|
@@ -446,7 +469,7 @@ declare enum ItemTypeItemType {
|
|
|
446
469
|
SERVICE = "SERVICE"
|
|
447
470
|
}
|
|
448
471
|
/** Type of selected payment option for catalog item */
|
|
449
|
-
declare enum PaymentOptionType {
|
|
472
|
+
export declare enum PaymentOptionType {
|
|
450
473
|
/** The entire payment for this item happens as part of the checkout. */
|
|
451
474
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
452
475
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -458,7 +481,7 @@ declare enum PaymentOptionType {
|
|
|
458
481
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
459
482
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
460
483
|
}
|
|
461
|
-
interface ItemTaxFullDetails {
|
|
484
|
+
export interface ItemTaxFullDetails {
|
|
462
485
|
/** Taxable amount of this line item. */
|
|
463
486
|
taxableAmount?: Price;
|
|
464
487
|
/**
|
|
@@ -469,7 +492,7 @@ interface ItemTaxFullDetails {
|
|
|
469
492
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
470
493
|
totalTax?: Price;
|
|
471
494
|
}
|
|
472
|
-
interface LineItemTaxInfo {
|
|
495
|
+
export interface LineItemTaxInfo {
|
|
473
496
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
474
497
|
taxAmount?: Price;
|
|
475
498
|
/** Amount for which tax is calculated. */
|
|
@@ -497,7 +520,7 @@ interface LineItemTaxInfo {
|
|
|
497
520
|
* TaxBreakdown represents tax information for a line item.
|
|
498
521
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
499
522
|
*/
|
|
500
|
-
interface LineItemTaxBreakdown {
|
|
523
|
+
export interface LineItemTaxBreakdown {
|
|
501
524
|
/**
|
|
502
525
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
503
526
|
* @maxLength 200
|
|
@@ -530,7 +553,7 @@ interface LineItemTaxBreakdown {
|
|
|
530
553
|
taxableAmount?: Price;
|
|
531
554
|
}
|
|
532
555
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
533
|
-
declare enum JurisdictionType {
|
|
556
|
+
export declare enum JurisdictionType {
|
|
534
557
|
UNDEFINED = "UNDEFINED",
|
|
535
558
|
COUNTRY = "COUNTRY",
|
|
536
559
|
STATE = "STATE",
|
|
@@ -538,7 +561,7 @@ declare enum JurisdictionType {
|
|
|
538
561
|
CITY = "CITY",
|
|
539
562
|
SPECIAL = "SPECIAL"
|
|
540
563
|
}
|
|
541
|
-
interface DigitalFile {
|
|
564
|
+
export interface DigitalFile {
|
|
542
565
|
/**
|
|
543
566
|
* ID of the secure file in media.
|
|
544
567
|
* @minLength 1
|
|
@@ -558,12 +581,12 @@ interface DigitalFile {
|
|
|
558
581
|
*/
|
|
559
582
|
expirationDate?: Date | null;
|
|
560
583
|
}
|
|
561
|
-
interface SubscriptionInfo {
|
|
584
|
+
export interface SubscriptionInfo {
|
|
562
585
|
/**
|
|
563
586
|
* Subscription ID.
|
|
564
587
|
* @format GUID
|
|
565
588
|
*/
|
|
566
|
-
|
|
589
|
+
id?: string | null;
|
|
567
590
|
/**
|
|
568
591
|
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
569
592
|
* @min 1
|
|
@@ -591,7 +614,7 @@ interface SubscriptionInfo {
|
|
|
591
614
|
*/
|
|
592
615
|
subscriptionSettings?: SubscriptionSettings;
|
|
593
616
|
}
|
|
594
|
-
interface SubscriptionTitle {
|
|
617
|
+
export interface SubscriptionTitle {
|
|
595
618
|
/**
|
|
596
619
|
* 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).
|
|
597
620
|
* @minLength 1
|
|
@@ -607,7 +630,7 @@ interface SubscriptionTitle {
|
|
|
607
630
|
*/
|
|
608
631
|
translated?: string | null;
|
|
609
632
|
}
|
|
610
|
-
interface SubscriptionDescription {
|
|
633
|
+
export interface SubscriptionDescription {
|
|
611
634
|
/**
|
|
612
635
|
* Subscription option description.
|
|
613
636
|
* @maxLength 500
|
|
@@ -619,7 +642,7 @@ interface SubscriptionDescription {
|
|
|
619
642
|
*/
|
|
620
643
|
translated?: string | null;
|
|
621
644
|
}
|
|
622
|
-
interface SubscriptionSettings {
|
|
645
|
+
export interface SubscriptionSettings {
|
|
623
646
|
/** Frequency of recurring payment. */
|
|
624
647
|
frequency?: SubscriptionFrequency;
|
|
625
648
|
/**
|
|
@@ -637,14 +660,14 @@ interface SubscriptionSettings {
|
|
|
637
660
|
billingCycles?: number | null;
|
|
638
661
|
}
|
|
639
662
|
/** Frequency unit of recurring payment */
|
|
640
|
-
declare enum SubscriptionFrequency {
|
|
663
|
+
export declare enum SubscriptionFrequency {
|
|
641
664
|
UNDEFINED = "UNDEFINED",
|
|
642
665
|
DAY = "DAY",
|
|
643
666
|
WEEK = "WEEK",
|
|
644
667
|
MONTH = "MONTH",
|
|
645
668
|
YEAR = "YEAR"
|
|
646
669
|
}
|
|
647
|
-
interface FreeTrialPeriod {
|
|
670
|
+
export interface FreeTrialPeriod {
|
|
648
671
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
649
672
|
frequency?: SubscriptionFrequency;
|
|
650
673
|
/**
|
|
@@ -654,20 +677,20 @@ interface FreeTrialPeriod {
|
|
|
654
677
|
*/
|
|
655
678
|
interval?: number;
|
|
656
679
|
}
|
|
657
|
-
interface BillingAdjustment {
|
|
680
|
+
export interface BillingAdjustment {
|
|
658
681
|
/** The type of adjustment. */
|
|
659
682
|
type?: AdjustmentType;
|
|
660
683
|
/** Summary of the prorated adjustment amount. */
|
|
661
684
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
662
685
|
}
|
|
663
|
-
declare enum AdjustmentType {
|
|
686
|
+
export declare enum AdjustmentType {
|
|
664
687
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
665
688
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
666
689
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
667
690
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
668
691
|
CREDIT = "CREDIT"
|
|
669
692
|
}
|
|
670
|
-
interface BillingAdjustmentPriceSummary {
|
|
693
|
+
export interface BillingAdjustmentPriceSummary {
|
|
671
694
|
/** Subtotal of adjustment, before tax. */
|
|
672
695
|
subtotal?: Price;
|
|
673
696
|
/** Tax on adjustment. */
|
|
@@ -675,12 +698,12 @@ interface BillingAdjustmentPriceSummary {
|
|
|
675
698
|
/** Total price after tax. */
|
|
676
699
|
total?: Price;
|
|
677
700
|
}
|
|
678
|
-
interface LocationAndQuantity {
|
|
701
|
+
export interface LocationAndQuantity {
|
|
679
702
|
/**
|
|
680
703
|
* Location id in the associated owner app.
|
|
681
704
|
* @format GUID
|
|
682
705
|
*/
|
|
683
|
-
|
|
706
|
+
id?: string;
|
|
684
707
|
/**
|
|
685
708
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
686
709
|
* @format GUID
|
|
@@ -701,22 +724,22 @@ interface LocationAndQuantity {
|
|
|
701
724
|
*/
|
|
702
725
|
name?: string | null;
|
|
703
726
|
}
|
|
704
|
-
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
727
|
+
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
705
728
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
706
729
|
addressType?: TaxableAddressType;
|
|
707
730
|
}
|
|
708
731
|
/** @oneof */
|
|
709
|
-
interface TaxableAddressTaxableAddressDataOneOf {
|
|
732
|
+
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
710
733
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
711
734
|
addressType?: TaxableAddressType;
|
|
712
735
|
}
|
|
713
|
-
declare enum TaxableAddressType {
|
|
736
|
+
export declare enum TaxableAddressType {
|
|
714
737
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
715
738
|
BUSINESS = "BUSINESS",
|
|
716
739
|
BILLING = "BILLING",
|
|
717
740
|
SHIPPING = "SHIPPING"
|
|
718
741
|
}
|
|
719
|
-
interface ExtendedFields {
|
|
742
|
+
export interface ExtendedFields {
|
|
720
743
|
/**
|
|
721
744
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
722
745
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -727,7 +750,7 @@ interface ExtendedFields {
|
|
|
727
750
|
*/
|
|
728
751
|
namespaces?: Record<string, Record<string, any>>;
|
|
729
752
|
}
|
|
730
|
-
interface ItemChangedDetails {
|
|
753
|
+
export interface ItemChangedDetails {
|
|
731
754
|
/**
|
|
732
755
|
* Line item quantity before change.
|
|
733
756
|
* @min 1
|
|
@@ -739,7 +762,7 @@ interface ItemChangedDetails {
|
|
|
739
762
|
/** Line item price description before change. */
|
|
740
763
|
priceDescriptionBeforeChange?: PriceDescription;
|
|
741
764
|
}
|
|
742
|
-
interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
765
|
+
export interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
743
766
|
/** Whether shipping info was added as part of the draft. */
|
|
744
767
|
added?: boolean;
|
|
745
768
|
/** Shipping info before the change. */
|
|
@@ -750,7 +773,7 @@ interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
|
750
773
|
shippingInfo?: V1ShippingInformation;
|
|
751
774
|
}
|
|
752
775
|
/** @oneof */
|
|
753
|
-
interface ShippingDetailsChangeTypeOneOf {
|
|
776
|
+
export interface ShippingDetailsChangeTypeOneOf {
|
|
754
777
|
/** Whether shipping info was added as part of the draft. */
|
|
755
778
|
added?: boolean;
|
|
756
779
|
/** Shipping info before the change. */
|
|
@@ -758,7 +781,7 @@ interface ShippingDetailsChangeTypeOneOf {
|
|
|
758
781
|
/** Whether shipping info was removed as part of the draft. */
|
|
759
782
|
removed?: boolean;
|
|
760
783
|
}
|
|
761
|
-
interface V1ShippingInformation {
|
|
784
|
+
export interface V1ShippingInformation {
|
|
762
785
|
/**
|
|
763
786
|
* App Def Id of external provider which was a source of shipping info
|
|
764
787
|
* @minLength 1
|
|
@@ -784,7 +807,7 @@ interface V1ShippingInformation {
|
|
|
784
807
|
/** Shipping region. */
|
|
785
808
|
region?: ShippingRegion;
|
|
786
809
|
}
|
|
787
|
-
interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
810
|
+
export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
788
811
|
/** Shipping address and contact details. */
|
|
789
812
|
shippingDestination?: AddressWithContact;
|
|
790
813
|
/** Pickup details. */
|
|
@@ -808,21 +831,21 @@ interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
|
808
831
|
deliveryTimeSlot?: V1DeliveryTimeSlot;
|
|
809
832
|
}
|
|
810
833
|
/** @oneof */
|
|
811
|
-
interface V1DeliveryLogisticsAddressOneOf {
|
|
834
|
+
export interface V1DeliveryLogisticsAddressOneOf {
|
|
812
835
|
/** Shipping address and contact details. */
|
|
813
836
|
shippingDestination?: AddressWithContact;
|
|
814
837
|
/** Pickup details. */
|
|
815
838
|
pickupDetails?: V1PickupDetails;
|
|
816
839
|
}
|
|
817
840
|
/** Billing Info and shipping details */
|
|
818
|
-
interface AddressWithContact {
|
|
841
|
+
export interface AddressWithContact {
|
|
819
842
|
/** Address. */
|
|
820
843
|
address?: Address;
|
|
821
844
|
/** Contact details. */
|
|
822
845
|
contactDetails?: FullAddressContactDetails;
|
|
823
846
|
}
|
|
824
847
|
/** Physical address */
|
|
825
|
-
interface Address {
|
|
848
|
+
export interface Address {
|
|
826
849
|
/**
|
|
827
850
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
828
851
|
* @format COUNTRY
|
|
@@ -849,7 +872,7 @@ interface Address {
|
|
|
849
872
|
* Main address line (usually street name and number).
|
|
850
873
|
* @maxLength 150
|
|
851
874
|
*/
|
|
852
|
-
|
|
875
|
+
addressLine?: string | null;
|
|
853
876
|
/**
|
|
854
877
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
855
878
|
* @maxLength 100
|
|
@@ -866,20 +889,20 @@ interface Address {
|
|
|
866
889
|
*/
|
|
867
890
|
subdivisionFullname?: string | null;
|
|
868
891
|
}
|
|
869
|
-
interface StreetAddress {
|
|
892
|
+
export interface StreetAddress {
|
|
870
893
|
/** Street number. */
|
|
871
894
|
number?: string;
|
|
872
895
|
/** Street name. */
|
|
873
896
|
name?: string;
|
|
874
897
|
}
|
|
875
|
-
interface AddressLocation {
|
|
898
|
+
export interface AddressLocation {
|
|
876
899
|
/** Address latitude. */
|
|
877
900
|
latitude?: number | null;
|
|
878
901
|
/** Address longitude. */
|
|
879
902
|
longitude?: number | null;
|
|
880
903
|
}
|
|
881
904
|
/** Full contact details for an address */
|
|
882
|
-
interface FullAddressContactDetails {
|
|
905
|
+
export interface FullAddressContactDetails {
|
|
883
906
|
/**
|
|
884
907
|
* First name.
|
|
885
908
|
* @maxLength 100
|
|
@@ -903,9 +926,9 @@ interface FullAddressContactDetails {
|
|
|
903
926
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
904
927
|
vatId?: VatId;
|
|
905
928
|
}
|
|
906
|
-
interface VatId {
|
|
929
|
+
export interface VatId {
|
|
907
930
|
/** Customer's tax ID. */
|
|
908
|
-
|
|
931
|
+
id?: string;
|
|
909
932
|
/**
|
|
910
933
|
* Tax type.
|
|
911
934
|
*
|
|
@@ -916,21 +939,21 @@ interface VatId {
|
|
|
916
939
|
type?: VatType;
|
|
917
940
|
}
|
|
918
941
|
/** tax info types */
|
|
919
|
-
declare enum VatType {
|
|
942
|
+
export declare enum VatType {
|
|
920
943
|
UNSPECIFIED = "UNSPECIFIED",
|
|
921
944
|
/** CPF - for individual tax payers. */
|
|
922
945
|
CPF = "CPF",
|
|
923
946
|
/** CNPJ - for corporations */
|
|
924
947
|
CNPJ = "CNPJ"
|
|
925
948
|
}
|
|
926
|
-
interface V1PickupDetails {
|
|
949
|
+
export interface V1PickupDetails {
|
|
927
950
|
/** Pickup address. */
|
|
928
951
|
address?: PickupAddress;
|
|
929
952
|
/** Pickup method */
|
|
930
953
|
pickupMethod?: PickupDetailsPickupMethod;
|
|
931
954
|
}
|
|
932
955
|
/** Physical address */
|
|
933
|
-
interface PickupAddress {
|
|
956
|
+
export interface PickupAddress {
|
|
934
957
|
/**
|
|
935
958
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
936
959
|
* @format COUNTRY
|
|
@@ -957,7 +980,7 @@ interface PickupAddress {
|
|
|
957
980
|
* Main address line (usually street name and number).
|
|
958
981
|
* @maxLength 1000
|
|
959
982
|
*/
|
|
960
|
-
|
|
983
|
+
addressLine?: string | null;
|
|
961
984
|
/**
|
|
962
985
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
963
986
|
* @maxLength 1000
|
|
@@ -974,18 +997,18 @@ interface PickupAddress {
|
|
|
974
997
|
*/
|
|
975
998
|
subdivisionFullname?: string | null;
|
|
976
999
|
}
|
|
977
|
-
declare enum PickupDetailsPickupMethod {
|
|
1000
|
+
export declare enum PickupDetailsPickupMethod {
|
|
978
1001
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
979
1002
|
STORE_PICKUP = "STORE_PICKUP",
|
|
980
1003
|
PICKUP_POINT = "PICKUP_POINT"
|
|
981
1004
|
}
|
|
982
|
-
interface V1DeliveryTimeSlot {
|
|
1005
|
+
export interface V1DeliveryTimeSlot {
|
|
983
1006
|
/** Delivery slot starting time. */
|
|
984
1007
|
from?: Date | null;
|
|
985
1008
|
/** Delivery slot ending time. */
|
|
986
1009
|
to?: Date | null;
|
|
987
1010
|
}
|
|
988
|
-
interface V1ShippingPrice {
|
|
1011
|
+
export interface V1ShippingPrice {
|
|
989
1012
|
/** Shipping price for display purposes. */
|
|
990
1013
|
price?: Price;
|
|
991
1014
|
/**
|
|
@@ -1006,19 +1029,19 @@ interface V1ShippingPrice {
|
|
|
1006
1029
|
*/
|
|
1007
1030
|
discount?: Price;
|
|
1008
1031
|
}
|
|
1009
|
-
interface ShippingRegion {
|
|
1032
|
+
export interface ShippingRegion {
|
|
1010
1033
|
/**
|
|
1011
1034
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1012
1035
|
* @maxLength 100
|
|
1013
1036
|
*/
|
|
1014
1037
|
name?: string | null;
|
|
1015
1038
|
}
|
|
1016
|
-
interface ShippingChangedDetails {
|
|
1039
|
+
export interface ShippingChangedDetails {
|
|
1017
1040
|
/** Shipping info before the change. */
|
|
1018
1041
|
shippingInfoBeforeChange?: V1ShippingInformation;
|
|
1019
1042
|
}
|
|
1020
1043
|
/** Buyer Info */
|
|
1021
|
-
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1044
|
+
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1022
1045
|
/**
|
|
1023
1046
|
* Visitor ID (if site visitor is not a member).
|
|
1024
1047
|
* @format GUID
|
|
@@ -1041,7 +1064,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1041
1064
|
email?: string | null;
|
|
1042
1065
|
}
|
|
1043
1066
|
/** @oneof */
|
|
1044
|
-
interface BuyerInfoIdOneOf {
|
|
1067
|
+
export interface BuyerInfoIdOneOf {
|
|
1045
1068
|
/**
|
|
1046
1069
|
* Visitor ID (if site visitor is not a member).
|
|
1047
1070
|
* @format GUID
|
|
@@ -1053,7 +1076,7 @@ interface BuyerInfoIdOneOf {
|
|
|
1053
1076
|
*/
|
|
1054
1077
|
memberId?: string;
|
|
1055
1078
|
}
|
|
1056
|
-
interface AdditionalFeeDetails {
|
|
1079
|
+
export interface AdditionalFeeDetails {
|
|
1057
1080
|
/** Additional fee. */
|
|
1058
1081
|
additionalFee?: AdditionalFee;
|
|
1059
1082
|
/** Tax details related to the additional fee. */
|
|
@@ -1069,7 +1092,7 @@ interface AdditionalFeeDetails {
|
|
|
1069
1092
|
/** Whether this additional fee is applied to the order. */
|
|
1070
1093
|
applied?: boolean;
|
|
1071
1094
|
}
|
|
1072
|
-
interface AdditionalFee {
|
|
1095
|
+
export interface AdditionalFee {
|
|
1073
1096
|
/**
|
|
1074
1097
|
* Additional fee's unique code for future processing.
|
|
1075
1098
|
* @minLength 1
|
|
@@ -1100,7 +1123,7 @@ interface AdditionalFee {
|
|
|
1100
1123
|
* @format GUID
|
|
1101
1124
|
* @immutable
|
|
1102
1125
|
*/
|
|
1103
|
-
|
|
1126
|
+
id?: string;
|
|
1104
1127
|
/**
|
|
1105
1128
|
* Optional - Line items associated with this additional fee.
|
|
1106
1129
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
@@ -1108,7 +1131,7 @@ interface AdditionalFee {
|
|
|
1108
1131
|
*/
|
|
1109
1132
|
lineItemIds?: string[];
|
|
1110
1133
|
}
|
|
1111
|
-
interface TaxDetails {
|
|
1134
|
+
export interface TaxDetails {
|
|
1112
1135
|
/** Indication if additional fee is taxable or not */
|
|
1113
1136
|
taxable?: boolean;
|
|
1114
1137
|
/**
|
|
@@ -1117,7 +1140,7 @@ interface TaxDetails {
|
|
|
1117
1140
|
*/
|
|
1118
1141
|
taxGroupId?: string | null;
|
|
1119
1142
|
}
|
|
1120
|
-
declare enum SourceType {
|
|
1143
|
+
export declare enum SourceType {
|
|
1121
1144
|
/** Part of the original order */
|
|
1122
1145
|
ORIGINAL_ORDER = "ORIGINAL_ORDER",
|
|
1123
1146
|
/** Added by estimate * */
|
|
@@ -1125,7 +1148,7 @@ declare enum SourceType {
|
|
|
1125
1148
|
/** Added manually to current draft order */
|
|
1126
1149
|
CUSTOM = "CUSTOM"
|
|
1127
1150
|
}
|
|
1128
|
-
interface DiscountDetails {
|
|
1151
|
+
export interface DiscountDetails {
|
|
1129
1152
|
/** Discount details. */
|
|
1130
1153
|
discount?: AppliedDiscount;
|
|
1131
1154
|
/**
|
|
@@ -1139,7 +1162,7 @@ interface DiscountDetails {
|
|
|
1139
1162
|
/** Whether this discount is applied to the order. */
|
|
1140
1163
|
applied?: boolean;
|
|
1141
1164
|
}
|
|
1142
|
-
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1165
|
+
export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1143
1166
|
/** Applied coupon info. */
|
|
1144
1167
|
coupon?: Coupon;
|
|
1145
1168
|
/** Merchant discount. */
|
|
@@ -1169,10 +1192,10 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1169
1192
|
* @format GUID
|
|
1170
1193
|
* @immutable
|
|
1171
1194
|
*/
|
|
1172
|
-
|
|
1195
|
+
id?: string | null;
|
|
1173
1196
|
}
|
|
1174
1197
|
/** @oneof */
|
|
1175
|
-
interface AppliedDiscountDiscountSourceOneOf {
|
|
1198
|
+
export interface AppliedDiscountDiscountSourceOneOf {
|
|
1176
1199
|
/** Applied coupon info. */
|
|
1177
1200
|
coupon?: Coupon;
|
|
1178
1201
|
/** Merchant discount. */
|
|
@@ -1180,15 +1203,15 @@ interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1180
1203
|
/** Automatic Discount */
|
|
1181
1204
|
discountRule?: DiscountRule;
|
|
1182
1205
|
}
|
|
1183
|
-
declare enum AppliedDiscountDiscountType {
|
|
1206
|
+
export declare enum AppliedDiscountDiscountType {
|
|
1184
1207
|
GLOBAL = "GLOBAL",
|
|
1185
1208
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1186
1209
|
SHIPPING = "SHIPPING"
|
|
1187
1210
|
}
|
|
1188
1211
|
/** Coupon */
|
|
1189
|
-
interface Coupon {
|
|
1212
|
+
export interface Coupon {
|
|
1190
1213
|
/** Coupon ID. */
|
|
1191
|
-
|
|
1214
|
+
id?: string;
|
|
1192
1215
|
/** Coupon code. */
|
|
1193
1216
|
code?: string;
|
|
1194
1217
|
/** Coupon name. */
|
|
@@ -1196,7 +1219,7 @@ interface Coupon {
|
|
|
1196
1219
|
/** Coupon value. */
|
|
1197
1220
|
amount?: Price;
|
|
1198
1221
|
}
|
|
1199
|
-
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1222
|
+
export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1200
1223
|
/**
|
|
1201
1224
|
* Pre-defined discount reason (optional).
|
|
1202
1225
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1211,7 +1234,7 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1211
1234
|
amount?: Price;
|
|
1212
1235
|
}
|
|
1213
1236
|
/** @oneof */
|
|
1214
|
-
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1237
|
+
export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1215
1238
|
/**
|
|
1216
1239
|
* Pre-defined discount reason (optional).
|
|
1217
1240
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1223,23 +1246,23 @@ interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1223
1246
|
*/
|
|
1224
1247
|
description?: string | null;
|
|
1225
1248
|
}
|
|
1226
|
-
declare enum DiscountReason {
|
|
1249
|
+
export declare enum DiscountReason {
|
|
1227
1250
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1228
1251
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1229
1252
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1230
1253
|
}
|
|
1231
|
-
interface DiscountRule {
|
|
1254
|
+
export interface DiscountRule {
|
|
1232
1255
|
/**
|
|
1233
1256
|
* Discount rule ID
|
|
1234
1257
|
* @format GUID
|
|
1235
1258
|
*/
|
|
1236
|
-
|
|
1259
|
+
id?: string;
|
|
1237
1260
|
/** Discount rule name */
|
|
1238
1261
|
name?: DiscountRuleName;
|
|
1239
1262
|
/** Discount value. */
|
|
1240
1263
|
amount?: Price;
|
|
1241
1264
|
}
|
|
1242
|
-
interface DiscountRuleName {
|
|
1265
|
+
export interface DiscountRuleName {
|
|
1243
1266
|
/**
|
|
1244
1267
|
* Original discount rule name (in site's default language).
|
|
1245
1268
|
* @minLength 1
|
|
@@ -1253,16 +1276,16 @@ interface DiscountRuleName {
|
|
|
1253
1276
|
*/
|
|
1254
1277
|
translated?: string | null;
|
|
1255
1278
|
}
|
|
1256
|
-
interface LineItemDiscount {
|
|
1279
|
+
export interface LineItemDiscount {
|
|
1257
1280
|
/**
|
|
1258
1281
|
* ID of line item the discount applies to.
|
|
1259
1282
|
* @format GUID
|
|
1260
1283
|
*/
|
|
1261
|
-
|
|
1284
|
+
id?: string;
|
|
1262
1285
|
/** Total discount for this line item. */
|
|
1263
1286
|
totalDiscount?: Price;
|
|
1264
1287
|
}
|
|
1265
|
-
interface CreatedBy extends CreatedByStringOneOf {
|
|
1288
|
+
export interface CreatedBy extends CreatedByStringOneOf {
|
|
1266
1289
|
/**
|
|
1267
1290
|
* User ID. When the draft order was created by a Wix user.
|
|
1268
1291
|
* @format GUID
|
|
@@ -1275,7 +1298,7 @@ interface CreatedBy extends CreatedByStringOneOf {
|
|
|
1275
1298
|
appId?: string;
|
|
1276
1299
|
}
|
|
1277
1300
|
/** @oneof */
|
|
1278
|
-
interface CreatedByStringOneOf {
|
|
1301
|
+
export interface CreatedByStringOneOf {
|
|
1279
1302
|
/**
|
|
1280
1303
|
* User ID. When the draft order was created by a Wix user.
|
|
1281
1304
|
* @format GUID
|
|
@@ -1287,13 +1310,13 @@ interface CreatedByStringOneOf {
|
|
|
1287
1310
|
*/
|
|
1288
1311
|
appId?: string;
|
|
1289
1312
|
}
|
|
1290
|
-
declare enum EditingStatus {
|
|
1313
|
+
export declare enum EditingStatus {
|
|
1291
1314
|
/** DraftOrder is in draft state. */
|
|
1292
1315
|
DRAFT = "DRAFT",
|
|
1293
1316
|
/** DraftOrder is in committed state. */
|
|
1294
1317
|
COMMITTED = "COMMITTED"
|
|
1295
1318
|
}
|
|
1296
|
-
declare enum WeightUnit {
|
|
1319
|
+
export declare enum WeightUnit {
|
|
1297
1320
|
/** Weight unit can't be classified due to an error. */
|
|
1298
1321
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1299
1322
|
/** Kilograms. */
|
|
@@ -1301,7 +1324,7 @@ declare enum WeightUnit {
|
|
|
1301
1324
|
/** Pounds. */
|
|
1302
1325
|
LB = "LB"
|
|
1303
1326
|
}
|
|
1304
|
-
interface PriceSummary {
|
|
1327
|
+
export interface PriceSummary {
|
|
1305
1328
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
1306
1329
|
subtotal?: Price;
|
|
1307
1330
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1315,14 +1338,14 @@ interface PriceSummary {
|
|
|
1315
1338
|
/** Total price of additional fees before tax. */
|
|
1316
1339
|
totalAdditionalFees?: Price;
|
|
1317
1340
|
}
|
|
1318
|
-
interface TaxSummary {
|
|
1341
|
+
export interface TaxSummary {
|
|
1319
1342
|
/**
|
|
1320
1343
|
* Total tax.
|
|
1321
1344
|
* @readonly
|
|
1322
1345
|
*/
|
|
1323
1346
|
totalTax?: Price;
|
|
1324
1347
|
}
|
|
1325
|
-
interface BalanceSummary {
|
|
1348
|
+
export interface BalanceSummary {
|
|
1326
1349
|
/**
|
|
1327
1350
|
* Amount left to pay for order to be considered paid.
|
|
1328
1351
|
* @readonly
|
|
@@ -1341,7 +1364,7 @@ interface BalanceSummary {
|
|
|
1341
1364
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
1342
1365
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
1343
1366
|
*/
|
|
1344
|
-
interface Balance {
|
|
1367
|
+
export interface Balance {
|
|
1345
1368
|
/**
|
|
1346
1369
|
* Balance amount.
|
|
1347
1370
|
*
|
|
@@ -1357,7 +1380,7 @@ interface Balance {
|
|
|
1357
1380
|
formattedAmount?: string;
|
|
1358
1381
|
}
|
|
1359
1382
|
/** Side-effects upon committing a draft order. */
|
|
1360
|
-
interface DraftOrderCommitSettings {
|
|
1383
|
+
export interface DraftOrderCommitSettings {
|
|
1361
1384
|
/**
|
|
1362
1385
|
* Whether to send notifications to the buyer.
|
|
1363
1386
|
*
|
|
@@ -1389,14 +1412,14 @@ interface DraftOrderCommitSettings {
|
|
|
1389
1412
|
*/
|
|
1390
1413
|
updateInventory?: InventoryUpdate[];
|
|
1391
1414
|
}
|
|
1392
|
-
interface InventoryUpdate {
|
|
1415
|
+
export interface InventoryUpdate {
|
|
1393
1416
|
/**
|
|
1394
1417
|
* Line item ID.
|
|
1395
1418
|
* @format GUID
|
|
1396
1419
|
*/
|
|
1397
1420
|
lineItemId?: string;
|
|
1398
1421
|
}
|
|
1399
|
-
interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
1422
|
+
export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
1400
1423
|
/** Indicates that recipient information was added during draft. */
|
|
1401
1424
|
added?: boolean;
|
|
1402
1425
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1407,7 +1430,7 @@ interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
|
1407
1430
|
recipientInfo?: AddressWithContact;
|
|
1408
1431
|
}
|
|
1409
1432
|
/** @oneof */
|
|
1410
|
-
interface RecipientInfoDetailsChangeTypeOneOf {
|
|
1433
|
+
export interface RecipientInfoDetailsChangeTypeOneOf {
|
|
1411
1434
|
/** Indicates that recipient information was added during draft. */
|
|
1412
1435
|
added?: boolean;
|
|
1413
1436
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1415,11 +1438,11 @@ interface RecipientInfoDetailsChangeTypeOneOf {
|
|
|
1415
1438
|
/** Indicates that recipient information was removed during draft. */
|
|
1416
1439
|
removed?: boolean;
|
|
1417
1440
|
}
|
|
1418
|
-
interface RecipientInfoChangedDetails {
|
|
1441
|
+
export interface RecipientInfoChangedDetails {
|
|
1419
1442
|
/** Order recipient address and contact details before draft. */
|
|
1420
1443
|
recipientInfoBeforeChange?: AddressWithContact;
|
|
1421
1444
|
}
|
|
1422
|
-
interface OrderTaxInfo {
|
|
1445
|
+
export interface OrderTaxInfo {
|
|
1423
1446
|
/** Calculated tax, added from line items. */
|
|
1424
1447
|
totalTax?: Price;
|
|
1425
1448
|
/**
|
|
@@ -1439,7 +1462,7 @@ interface OrderTaxInfo {
|
|
|
1439
1462
|
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
1440
1463
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1441
1464
|
*/
|
|
1442
|
-
interface OrderTaxBreakdown {
|
|
1465
|
+
export interface OrderTaxBreakdown {
|
|
1443
1466
|
/**
|
|
1444
1467
|
* The name of the tax against which this tax amount was calculated.
|
|
1445
1468
|
* @maxLength 200
|
|
@@ -1466,21 +1489,21 @@ interface OrderTaxBreakdown {
|
|
|
1466
1489
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1467
1490
|
aggregatedTaxAmount?: Price;
|
|
1468
1491
|
}
|
|
1469
|
-
interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
1492
|
+
export interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
1470
1493
|
}
|
|
1471
1494
|
/** @oneof */
|
|
1472
|
-
interface BuyerDetailsChangeTypeOneOf {
|
|
1495
|
+
export interface BuyerDetailsChangeTypeOneOf {
|
|
1473
1496
|
}
|
|
1474
|
-
interface BuyerChangedDetails {
|
|
1497
|
+
export interface BuyerChangedDetails {
|
|
1475
1498
|
}
|
|
1476
|
-
interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
1499
|
+
export interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
1477
1500
|
}
|
|
1478
1501
|
/** @oneof */
|
|
1479
|
-
interface BillingDetailsChangeTypeOneOf {
|
|
1502
|
+
export interface BillingDetailsChangeTypeOneOf {
|
|
1480
1503
|
}
|
|
1481
|
-
interface BillingChangedDetails {
|
|
1504
|
+
export interface BillingChangedDetails {
|
|
1482
1505
|
}
|
|
1483
|
-
interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1506
|
+
export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1484
1507
|
/** Indicates that business location was added during draft. */
|
|
1485
1508
|
added?: boolean;
|
|
1486
1509
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1491,7 +1514,7 @@ interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf
|
|
|
1491
1514
|
businessLocation?: Location;
|
|
1492
1515
|
}
|
|
1493
1516
|
/** @oneof */
|
|
1494
|
-
interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1517
|
+
export interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1495
1518
|
/** Indicates that business location was added during draft. */
|
|
1496
1519
|
added?: boolean;
|
|
1497
1520
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1499,13 +1522,13 @@ interface BusinessLocationDetailsChangeTypeOneOf {
|
|
|
1499
1522
|
/** Indicates that business location was removed during draft. */
|
|
1500
1523
|
removed?: boolean;
|
|
1501
1524
|
}
|
|
1502
|
-
interface Location {
|
|
1525
|
+
export interface Location {
|
|
1503
1526
|
/**
|
|
1504
1527
|
* Location ID.
|
|
1505
1528
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1506
1529
|
* @format GUID
|
|
1507
1530
|
*/
|
|
1508
|
-
|
|
1531
|
+
id?: string;
|
|
1509
1532
|
/**
|
|
1510
1533
|
* Location name.
|
|
1511
1534
|
* @minLength 1
|
|
@@ -1514,22 +1537,22 @@ interface Location {
|
|
|
1514
1537
|
*/
|
|
1515
1538
|
name?: string;
|
|
1516
1539
|
}
|
|
1517
|
-
interface BusinessLocationChangedDetails {
|
|
1540
|
+
export interface BusinessLocationChangedDetails {
|
|
1518
1541
|
/** Business location before draft. */
|
|
1519
1542
|
businessLocationBeforeChange?: Location;
|
|
1520
1543
|
}
|
|
1521
|
-
interface CreateDraftOrderRequest {
|
|
1544
|
+
export interface CreateDraftOrderRequest {
|
|
1522
1545
|
/**
|
|
1523
1546
|
* To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
|
|
1524
1547
|
* @format GUID
|
|
1525
1548
|
*/
|
|
1526
1549
|
orderId: string | null;
|
|
1527
1550
|
}
|
|
1528
|
-
interface CreateDraftOrderResponse {
|
|
1551
|
+
export interface CreateDraftOrderResponse {
|
|
1529
1552
|
/** The draft order details calculated with latest content */
|
|
1530
1553
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1531
1554
|
}
|
|
1532
|
-
interface CalculatedDraftOrder {
|
|
1555
|
+
export interface CalculatedDraftOrder {
|
|
1533
1556
|
/**
|
|
1534
1557
|
* The draft order full details with calculations based on it's content.
|
|
1535
1558
|
* Discount and additional fee options are also included.
|
|
@@ -1540,7 +1563,7 @@ interface CalculatedDraftOrder {
|
|
|
1540
1563
|
/** Errors that occurred during calculation. */
|
|
1541
1564
|
calculationErrors?: CalculationErrors;
|
|
1542
1565
|
}
|
|
1543
|
-
interface ShippingOption {
|
|
1566
|
+
export interface ShippingOption {
|
|
1544
1567
|
/**
|
|
1545
1568
|
* This carrier's unique ID
|
|
1546
1569
|
* @format GUID
|
|
@@ -1555,7 +1578,7 @@ interface ShippingOption {
|
|
|
1555
1578
|
/** Shipping cost. */
|
|
1556
1579
|
cost?: ShippingPrice;
|
|
1557
1580
|
}
|
|
1558
|
-
interface DeliveryLogistics {
|
|
1581
|
+
export interface DeliveryLogistics {
|
|
1559
1582
|
/** When the item is expected to be delivered in free text, e.g "3-5 business days" */
|
|
1560
1583
|
deliveryTime?: string | null;
|
|
1561
1584
|
/** Instructions for caller, e.g for pickup: "Ensure to come during Opening Hours, and please don't park in disabled-spot" */
|
|
@@ -1565,7 +1588,7 @@ interface DeliveryLogistics {
|
|
|
1565
1588
|
/** Expected delivery time slot (from and to time stamps representation) */
|
|
1566
1589
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1567
1590
|
}
|
|
1568
|
-
interface PickupDetails {
|
|
1591
|
+
export interface PickupDetails {
|
|
1569
1592
|
/** Pickup address */
|
|
1570
1593
|
address?: Address;
|
|
1571
1594
|
/**
|
|
@@ -1577,18 +1600,18 @@ interface PickupDetails {
|
|
|
1577
1600
|
*/
|
|
1578
1601
|
pickupMethod?: PickupMethod;
|
|
1579
1602
|
}
|
|
1580
|
-
declare enum PickupMethod {
|
|
1603
|
+
export declare enum PickupMethod {
|
|
1581
1604
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1582
1605
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1583
1606
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1584
1607
|
}
|
|
1585
|
-
interface DeliveryTimeSlot {
|
|
1608
|
+
export interface DeliveryTimeSlot {
|
|
1586
1609
|
/** starting time of the delivery time slot */
|
|
1587
1610
|
from?: Date | null;
|
|
1588
1611
|
/** ending time of the delivery time slot */
|
|
1589
1612
|
to?: Date | null;
|
|
1590
1613
|
}
|
|
1591
|
-
interface ShippingPrice {
|
|
1614
|
+
export interface ShippingPrice {
|
|
1592
1615
|
/** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
|
|
1593
1616
|
price?: Price;
|
|
1594
1617
|
/**
|
|
@@ -1597,7 +1620,7 @@ interface ShippingPrice {
|
|
|
1597
1620
|
*/
|
|
1598
1621
|
currency?: string;
|
|
1599
1622
|
}
|
|
1600
|
-
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1623
|
+
export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1601
1624
|
/** General shipping calculation error. */
|
|
1602
1625
|
generalShippingCalculationError?: Details;
|
|
1603
1626
|
/** Carrier errors. */
|
|
@@ -1608,13 +1631,13 @@ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOne
|
|
|
1608
1631
|
orderValidationErrors?: ApplicationError[];
|
|
1609
1632
|
}
|
|
1610
1633
|
/** @oneof */
|
|
1611
|
-
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1634
|
+
export interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1612
1635
|
/** General shipping calculation error. */
|
|
1613
1636
|
generalShippingCalculationError?: Details;
|
|
1614
1637
|
/** Carrier errors. */
|
|
1615
1638
|
carrierErrors?: CarrierErrors;
|
|
1616
1639
|
}
|
|
1617
|
-
interface Details extends DetailsKindOneOf {
|
|
1640
|
+
export interface Details extends DetailsKindOneOf {
|
|
1618
1641
|
applicationError?: ApplicationError;
|
|
1619
1642
|
validationError?: ValidationError;
|
|
1620
1643
|
systemError?: SystemError;
|
|
@@ -1625,12 +1648,12 @@ interface Details extends DetailsKindOneOf {
|
|
|
1625
1648
|
tracing?: Record<string, string>;
|
|
1626
1649
|
}
|
|
1627
1650
|
/** @oneof */
|
|
1628
|
-
interface DetailsKindOneOf {
|
|
1651
|
+
export interface DetailsKindOneOf {
|
|
1629
1652
|
applicationError?: ApplicationError;
|
|
1630
1653
|
validationError?: ValidationError;
|
|
1631
1654
|
systemError?: SystemError;
|
|
1632
1655
|
}
|
|
1633
|
-
interface ApplicationError {
|
|
1656
|
+
export interface ApplicationError {
|
|
1634
1657
|
/** Error code. */
|
|
1635
1658
|
code?: string;
|
|
1636
1659
|
/** Description of the error. */
|
|
@@ -1670,10 +1693,10 @@ interface ApplicationError {
|
|
|
1670
1693
|
* ]
|
|
1671
1694
|
* }
|
|
1672
1695
|
*/
|
|
1673
|
-
interface ValidationError {
|
|
1696
|
+
export interface ValidationError {
|
|
1674
1697
|
fieldViolations?: FieldViolation[];
|
|
1675
1698
|
}
|
|
1676
|
-
declare enum RuleType {
|
|
1699
|
+
export declare enum RuleType {
|
|
1677
1700
|
VALIDATION = "VALIDATION",
|
|
1678
1701
|
OTHER = "OTHER",
|
|
1679
1702
|
MAX = "MAX",
|
|
@@ -1696,7 +1719,7 @@ declare enum RuleType {
|
|
|
1696
1719
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1697
1720
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1698
1721
|
}
|
|
1699
|
-
interface FieldViolation {
|
|
1722
|
+
export interface FieldViolation {
|
|
1700
1723
|
field?: string;
|
|
1701
1724
|
description?: string;
|
|
1702
1725
|
violatedRule?: RuleType;
|
|
@@ -1704,27 +1727,27 @@ interface FieldViolation {
|
|
|
1704
1727
|
ruleName?: string | null;
|
|
1705
1728
|
data?: Record<string, any> | null;
|
|
1706
1729
|
}
|
|
1707
|
-
interface SystemError {
|
|
1730
|
+
export interface SystemError {
|
|
1708
1731
|
/** Error code. */
|
|
1709
1732
|
errorCode?: string | null;
|
|
1710
1733
|
}
|
|
1711
|
-
interface CarrierErrors {
|
|
1734
|
+
export interface CarrierErrors {
|
|
1712
1735
|
/** Carrier errors. */
|
|
1713
1736
|
errors?: CarrierError[];
|
|
1714
1737
|
}
|
|
1715
|
-
interface CarrierError {
|
|
1738
|
+
export interface CarrierError {
|
|
1716
1739
|
/** Carrier ID. */
|
|
1717
1740
|
carrierId?: string;
|
|
1718
1741
|
/** Error details. */
|
|
1719
1742
|
error?: Details;
|
|
1720
1743
|
}
|
|
1721
|
-
interface CreateEmptyDraftOrderRequest {
|
|
1744
|
+
export interface CreateEmptyDraftOrderRequest {
|
|
1722
1745
|
}
|
|
1723
|
-
interface CreateEmptyDraftOrderResponse {
|
|
1746
|
+
export interface CreateEmptyDraftOrderResponse {
|
|
1724
1747
|
/** The draft order details calculated with latest content */
|
|
1725
1748
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1726
1749
|
}
|
|
1727
|
-
interface AddLineItemsToDraftOrderRequest {
|
|
1750
|
+
export interface AddLineItemsToDraftOrderRequest {
|
|
1728
1751
|
/**
|
|
1729
1752
|
* The draft order id
|
|
1730
1753
|
* @format GUID
|
|
@@ -1741,7 +1764,7 @@ interface AddLineItemsToDraftOrderRequest {
|
|
|
1741
1764
|
*/
|
|
1742
1765
|
customLineItems?: CustomLineItem[];
|
|
1743
1766
|
}
|
|
1744
|
-
interface CatalogReferenceLineItem {
|
|
1767
|
+
export interface CatalogReferenceLineItem {
|
|
1745
1768
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
|
|
1746
1769
|
catalogReference?: CatalogReference;
|
|
1747
1770
|
/**
|
|
@@ -1760,12 +1783,12 @@ interface CatalogReferenceLineItem {
|
|
|
1760
1783
|
*/
|
|
1761
1784
|
locations?: LocationAndQuantity[];
|
|
1762
1785
|
}
|
|
1763
|
-
interface CustomLineItem {
|
|
1786
|
+
export interface CustomLineItem {
|
|
1764
1787
|
/**
|
|
1765
1788
|
* Line item ID.
|
|
1766
1789
|
* @format GUID
|
|
1767
1790
|
*/
|
|
1768
|
-
|
|
1791
|
+
id?: string | null;
|
|
1769
1792
|
/**
|
|
1770
1793
|
* Item quantity.
|
|
1771
1794
|
*
|
|
@@ -1785,7 +1808,7 @@ interface CustomLineItem {
|
|
|
1785
1808
|
*/
|
|
1786
1809
|
productName?: ProductName;
|
|
1787
1810
|
/** URL to the item's page on the site. */
|
|
1788
|
-
url?:
|
|
1811
|
+
url?: PageUrlV2;
|
|
1789
1812
|
/** Item price **after** catalog-defined discount and line item discounts. */
|
|
1790
1813
|
price?: Price;
|
|
1791
1814
|
/** Total line item price **after** catalog-defined discount and line item discounts. */
|
|
@@ -1797,7 +1820,7 @@ interface CustomLineItem {
|
|
|
1797
1820
|
/** Line item description lines. Used for display purposes for order. */
|
|
1798
1821
|
descriptionLines?: DescriptionLine[];
|
|
1799
1822
|
/** Line item image details. */
|
|
1800
|
-
media?:
|
|
1823
|
+
media?: Image;
|
|
1801
1824
|
/** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
|
|
1802
1825
|
physicalProperties?: PhysicalProperties;
|
|
1803
1826
|
/** Item type. Either a preset type or custom. */
|
|
@@ -1817,13 +1840,19 @@ interface CustomLineItem {
|
|
|
1817
1840
|
*/
|
|
1818
1841
|
locations?: LocationAndQuantity[];
|
|
1819
1842
|
}
|
|
1820
|
-
interface
|
|
1843
|
+
export interface PageUrlV2 {
|
|
1844
|
+
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
1845
|
+
relativePath?: string;
|
|
1846
|
+
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
1847
|
+
url?: string | null;
|
|
1848
|
+
}
|
|
1849
|
+
export interface SecuredMedia {
|
|
1821
1850
|
/**
|
|
1822
1851
|
* Media ID in Wix Media Manager.
|
|
1823
1852
|
* @minLength 1
|
|
1824
1853
|
* @maxLength 100
|
|
1825
1854
|
*/
|
|
1826
|
-
|
|
1855
|
+
id?: string;
|
|
1827
1856
|
/**
|
|
1828
1857
|
* Original filename.
|
|
1829
1858
|
* @minLength 1
|
|
@@ -1833,7 +1862,7 @@ interface SecuredMedia {
|
|
|
1833
1862
|
/** File type. */
|
|
1834
1863
|
fileType?: FileType;
|
|
1835
1864
|
}
|
|
1836
|
-
declare enum FileType {
|
|
1865
|
+
export declare enum FileType {
|
|
1837
1866
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1838
1867
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
1839
1868
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -1841,11 +1870,11 @@ declare enum FileType {
|
|
|
1841
1870
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
1842
1871
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
1843
1872
|
}
|
|
1844
|
-
interface AddLineItemsToDraftOrderResponse {
|
|
1873
|
+
export interface AddLineItemsToDraftOrderResponse {
|
|
1845
1874
|
/** The draft order details calculated with latest content */
|
|
1846
1875
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1847
1876
|
}
|
|
1848
|
-
interface UpdateLineItemsRequest {
|
|
1877
|
+
export interface UpdateLineItemsRequest {
|
|
1849
1878
|
/**
|
|
1850
1879
|
* The draft order id
|
|
1851
1880
|
* @format GUID
|
|
@@ -1858,7 +1887,7 @@ interface UpdateLineItemsRequest {
|
|
|
1858
1887
|
*/
|
|
1859
1888
|
lineItemChanges?: LineItemChangeDetails[];
|
|
1860
1889
|
}
|
|
1861
|
-
interface LineItemChangeDetails {
|
|
1890
|
+
export interface LineItemChangeDetails {
|
|
1862
1891
|
/**
|
|
1863
1892
|
* The line item id to change
|
|
1864
1893
|
* @format GUID
|
|
@@ -1877,11 +1906,11 @@ interface LineItemChangeDetails {
|
|
|
1877
1906
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1878
1907
|
newPriceDescription?: PriceDescription;
|
|
1879
1908
|
}
|
|
1880
|
-
interface UpdateLineItemsResponse {
|
|
1909
|
+
export interface UpdateLineItemsResponse {
|
|
1881
1910
|
/** The draft order details calculated with latest content */
|
|
1882
1911
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1883
1912
|
}
|
|
1884
|
-
interface SetDiscountsRequest {
|
|
1913
|
+
export interface SetDiscountsRequest {
|
|
1885
1914
|
/**
|
|
1886
1915
|
* The draft order id
|
|
1887
1916
|
* @format GUID
|
|
@@ -1893,17 +1922,17 @@ interface SetDiscountsRequest {
|
|
|
1893
1922
|
*/
|
|
1894
1923
|
discounts: IdAndApplied[];
|
|
1895
1924
|
}
|
|
1896
|
-
interface IdAndApplied {
|
|
1925
|
+
export interface IdAndApplied {
|
|
1897
1926
|
/** Discount ID. */
|
|
1898
|
-
|
|
1927
|
+
id?: string;
|
|
1899
1928
|
/** Whether to apply the discount to the draft order. */
|
|
1900
1929
|
applied?: boolean;
|
|
1901
1930
|
}
|
|
1902
|
-
interface SetDiscountsResponse {
|
|
1931
|
+
export interface SetDiscountsResponse {
|
|
1903
1932
|
/** The draft order details calculated with latest content */
|
|
1904
1933
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1905
1934
|
}
|
|
1906
|
-
interface CreateCustomDiscountsRequest {
|
|
1935
|
+
export interface CreateCustomDiscountsRequest {
|
|
1907
1936
|
/**
|
|
1908
1937
|
* The draft order id
|
|
1909
1938
|
* @format GUID
|
|
@@ -1916,7 +1945,7 @@ interface CreateCustomDiscountsRequest {
|
|
|
1916
1945
|
*/
|
|
1917
1946
|
discounts?: DiscountOption[];
|
|
1918
1947
|
}
|
|
1919
|
-
interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
1948
|
+
export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
1920
1949
|
/**
|
|
1921
1950
|
* Discount type.
|
|
1922
1951
|
* * `"GLOBAL"` - discount applies to entire order.
|
|
@@ -1951,19 +1980,19 @@ interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1951
1980
|
applyToDraftOrder?: boolean | null;
|
|
1952
1981
|
}
|
|
1953
1982
|
/** @oneof */
|
|
1954
|
-
interface DiscountOptionDiscountAmountOneOf {
|
|
1983
|
+
export interface DiscountOptionDiscountAmountOneOf {
|
|
1955
1984
|
}
|
|
1956
|
-
declare enum DiscountType {
|
|
1985
|
+
export declare enum DiscountType {
|
|
1957
1986
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
1958
1987
|
GLOBAL = "GLOBAL",
|
|
1959
1988
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1960
1989
|
SHIPPING = "SHIPPING"
|
|
1961
1990
|
}
|
|
1962
|
-
interface CreateCustomDiscountsResponse {
|
|
1991
|
+
export interface CreateCustomDiscountsResponse {
|
|
1963
1992
|
/** The draft order details with the added discounts */
|
|
1964
1993
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1965
1994
|
}
|
|
1966
|
-
interface DeleteCustomDiscountsRequest {
|
|
1995
|
+
export interface DeleteCustomDiscountsRequest {
|
|
1967
1996
|
/**
|
|
1968
1997
|
* The draft order id
|
|
1969
1998
|
* @format GUID
|
|
@@ -1977,11 +2006,11 @@ interface DeleteCustomDiscountsRequest {
|
|
|
1977
2006
|
*/
|
|
1978
2007
|
discountIds: string[];
|
|
1979
2008
|
}
|
|
1980
|
-
interface DeleteCustomDiscountsResponse {
|
|
2009
|
+
export interface DeleteCustomDiscountsResponse {
|
|
1981
2010
|
/** The draft order details calculated with latest content */
|
|
1982
2011
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1983
2012
|
}
|
|
1984
|
-
interface SetAdditionalFeesRequest {
|
|
2013
|
+
export interface SetAdditionalFeesRequest {
|
|
1985
2014
|
/**
|
|
1986
2015
|
* The draft order id
|
|
1987
2016
|
* @format GUID
|
|
@@ -1994,11 +2023,11 @@ interface SetAdditionalFeesRequest {
|
|
|
1994
2023
|
*/
|
|
1995
2024
|
additionalFees: IdAndApplied[];
|
|
1996
2025
|
}
|
|
1997
|
-
interface SetAdditionalFeesResponse {
|
|
2026
|
+
export interface SetAdditionalFeesResponse {
|
|
1998
2027
|
/** The draft order details calculated with modified additional fees */
|
|
1999
2028
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2000
2029
|
}
|
|
2001
|
-
interface CreateCustomAdditionalFeesRequest {
|
|
2030
|
+
export interface CreateCustomAdditionalFeesRequest {
|
|
2002
2031
|
/**
|
|
2003
2032
|
* The draft order id
|
|
2004
2033
|
* @format GUID
|
|
@@ -2011,7 +2040,7 @@ interface CreateCustomAdditionalFeesRequest {
|
|
|
2011
2040
|
*/
|
|
2012
2041
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
2013
2042
|
}
|
|
2014
|
-
interface AdditionalFeeOption {
|
|
2043
|
+
export interface AdditionalFeeOption {
|
|
2015
2044
|
/**
|
|
2016
2045
|
* Translated additional fee's name
|
|
2017
2046
|
* @minLength 1
|
|
@@ -2034,11 +2063,11 @@ interface AdditionalFeeOption {
|
|
|
2034
2063
|
*/
|
|
2035
2064
|
code?: string | null;
|
|
2036
2065
|
}
|
|
2037
|
-
interface CreateCustomAdditionalFeesResponse {
|
|
2066
|
+
export interface CreateCustomAdditionalFeesResponse {
|
|
2038
2067
|
/** The draft order details with added custom additional fees */
|
|
2039
2068
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2040
2069
|
}
|
|
2041
|
-
interface DeleteCustomAdditionalFeesRequest {
|
|
2070
|
+
export interface DeleteCustomAdditionalFeesRequest {
|
|
2042
2071
|
/**
|
|
2043
2072
|
* The draft order id
|
|
2044
2073
|
* @format GUID
|
|
@@ -2052,27 +2081,27 @@ interface DeleteCustomAdditionalFeesRequest {
|
|
|
2052
2081
|
*/
|
|
2053
2082
|
customAdditionalFees: string[];
|
|
2054
2083
|
}
|
|
2055
|
-
interface DeleteCustomAdditionalFeesResponse {
|
|
2084
|
+
export interface DeleteCustomAdditionalFeesResponse {
|
|
2056
2085
|
/** The draft order details calculated with latest content */
|
|
2057
2086
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2058
2087
|
}
|
|
2059
|
-
interface SetShippingInfoRequest {
|
|
2088
|
+
export interface SetShippingInfoRequest {
|
|
2060
2089
|
}
|
|
2061
|
-
interface SetShippingInfoResponse {
|
|
2090
|
+
export interface SetShippingInfoResponse {
|
|
2062
2091
|
}
|
|
2063
|
-
interface SetBuyerInfoRequest {
|
|
2092
|
+
export interface SetBuyerInfoRequest {
|
|
2064
2093
|
}
|
|
2065
|
-
interface SetBuyerInfoResponse {
|
|
2094
|
+
export interface SetBuyerInfoResponse {
|
|
2066
2095
|
}
|
|
2067
|
-
interface SetRecipientInfoRequest {
|
|
2096
|
+
export interface SetRecipientInfoRequest {
|
|
2068
2097
|
}
|
|
2069
|
-
interface SetRecipientInfoResponse {
|
|
2098
|
+
export interface SetRecipientInfoResponse {
|
|
2070
2099
|
}
|
|
2071
|
-
interface SetBillingInfoRequest {
|
|
2100
|
+
export interface SetBillingInfoRequest {
|
|
2072
2101
|
}
|
|
2073
|
-
interface SetBillingInfoResponse {
|
|
2102
|
+
export interface SetBillingInfoResponse {
|
|
2074
2103
|
}
|
|
2075
|
-
interface UpdateShippingInfoRequest {
|
|
2104
|
+
export interface UpdateShippingInfoRequest {
|
|
2076
2105
|
/**
|
|
2077
2106
|
* The draft order id
|
|
2078
2107
|
* @format GUID
|
|
@@ -2081,22 +2110,22 @@ interface UpdateShippingInfoRequest {
|
|
|
2081
2110
|
/** update the shipping option on the order. if not set then the selected shipping is removed */
|
|
2082
2111
|
shippingOption?: ShippingOption;
|
|
2083
2112
|
}
|
|
2084
|
-
interface UpdateShippingInfoResponse {
|
|
2113
|
+
export interface UpdateShippingInfoResponse {
|
|
2085
2114
|
/** The draft order details calculated with de/selected shipping info */
|
|
2086
2115
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2087
2116
|
}
|
|
2088
|
-
interface GetDraftOrderRequest {
|
|
2117
|
+
export interface GetDraftOrderRequest {
|
|
2089
2118
|
/**
|
|
2090
2119
|
* The draft order id
|
|
2091
2120
|
* @format GUID
|
|
2092
2121
|
*/
|
|
2093
2122
|
draftOrderId: string;
|
|
2094
2123
|
}
|
|
2095
|
-
interface GetDraftOrderResponse {
|
|
2124
|
+
export interface GetDraftOrderResponse {
|
|
2096
2125
|
/** The draft order details calculated with latest content */
|
|
2097
2126
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2098
2127
|
}
|
|
2099
|
-
interface GetOrderDraftabilityStatusRequest {
|
|
2128
|
+
export interface GetOrderDraftabilityStatusRequest {
|
|
2100
2129
|
/**
|
|
2101
2130
|
* Order ID.
|
|
2102
2131
|
* @minLength 1
|
|
@@ -2104,7 +2133,7 @@ interface GetOrderDraftabilityStatusRequest {
|
|
|
2104
2133
|
*/
|
|
2105
2134
|
orderId: string;
|
|
2106
2135
|
}
|
|
2107
|
-
interface GetOrderDraftabilityStatusResponse {
|
|
2136
|
+
export interface GetOrderDraftabilityStatusResponse {
|
|
2108
2137
|
/**
|
|
2109
2138
|
* Order ID.
|
|
2110
2139
|
* @minLength 1
|
|
@@ -2119,7 +2148,7 @@ interface GetOrderDraftabilityStatusResponse {
|
|
|
2119
2148
|
*/
|
|
2120
2149
|
nonDraftableReasons?: NonDraftableReason[];
|
|
2121
2150
|
}
|
|
2122
|
-
declare enum NonDraftableReason {
|
|
2151
|
+
export declare enum NonDraftableReason {
|
|
2123
2152
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2124
2153
|
PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
|
|
2125
2154
|
UNSUPPORTED_CHANNEL_TYPE = "UNSUPPORTED_CHANNEL_TYPE",
|
|
@@ -2133,7 +2162,7 @@ declare enum NonDraftableReason {
|
|
|
2133
2162
|
UNSUPPORTED_CATALOG_ITEM = "UNSUPPORTED_CATALOG_ITEM",
|
|
2134
2163
|
TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
|
|
2135
2164
|
}
|
|
2136
|
-
interface CommitDraftOrderRequest {
|
|
2165
|
+
export interface CommitDraftOrderRequest {
|
|
2137
2166
|
/**
|
|
2138
2167
|
* The draft order id
|
|
2139
2168
|
* @format GUID
|
|
@@ -2147,19 +2176,19 @@ interface CommitDraftOrderRequest {
|
|
|
2147
2176
|
*/
|
|
2148
2177
|
reason?: string | null;
|
|
2149
2178
|
}
|
|
2150
|
-
interface CommitDraftOrderResponse {
|
|
2179
|
+
export interface CommitDraftOrderResponse {
|
|
2151
2180
|
/** The draft order after commit. */
|
|
2152
2181
|
committedDraftOrder?: DraftOrder;
|
|
2153
2182
|
/** The updated order after commit. */
|
|
2154
2183
|
orderAfterCommit?: Order;
|
|
2155
2184
|
}
|
|
2156
|
-
interface Order {
|
|
2185
|
+
export interface Order {
|
|
2157
2186
|
/**
|
|
2158
2187
|
* Order ID.
|
|
2159
2188
|
* @format GUID
|
|
2160
2189
|
* @readonly
|
|
2161
2190
|
*/
|
|
2162
|
-
|
|
2191
|
+
id?: string | null;
|
|
2163
2192
|
/**
|
|
2164
2193
|
* Order number displayed in the site owner's dashboard (auto-generated).
|
|
2165
2194
|
* @readonly
|
|
@@ -2170,12 +2199,12 @@ interface Order {
|
|
|
2170
2199
|
* @readonly
|
|
2171
2200
|
* @immutable
|
|
2172
2201
|
*/
|
|
2173
|
-
|
|
2202
|
+
createdDate?: Date | null;
|
|
2174
2203
|
/**
|
|
2175
2204
|
* Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2176
2205
|
* @readonly
|
|
2177
2206
|
*/
|
|
2178
|
-
|
|
2207
|
+
updatedDate?: Date | null;
|
|
2179
2208
|
/**
|
|
2180
2209
|
* Order line items.
|
|
2181
2210
|
* @minSize 1
|
|
@@ -2321,7 +2350,7 @@ interface Order {
|
|
|
2321
2350
|
/** Order Location */
|
|
2322
2351
|
businessLocation?: Location;
|
|
2323
2352
|
}
|
|
2324
|
-
declare enum PaymentStatus {
|
|
2353
|
+
export declare enum PaymentStatus {
|
|
2325
2354
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2326
2355
|
/**
|
|
2327
2356
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -2362,7 +2391,7 @@ declare enum PaymentStatus {
|
|
|
2362
2391
|
*/
|
|
2363
2392
|
DECLINED = "DECLINED"
|
|
2364
2393
|
}
|
|
2365
|
-
declare enum FulfillmentStatus {
|
|
2394
|
+
export declare enum FulfillmentStatus {
|
|
2366
2395
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
2367
2396
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
2368
2397
|
/**
|
|
@@ -2373,7 +2402,7 @@ declare enum FulfillmentStatus {
|
|
|
2373
2402
|
/** Some, but not all, of the order items are fulfilled. */
|
|
2374
2403
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
2375
2404
|
}
|
|
2376
|
-
interface CurrencyConversionDetails {
|
|
2405
|
+
export interface CurrencyConversionDetails {
|
|
2377
2406
|
/**
|
|
2378
2407
|
* Original currency used to calculate the pricing before conversion to payment currency set on the order [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
2379
2408
|
* @readonly
|
|
@@ -2389,7 +2418,7 @@ interface CurrencyConversionDetails {
|
|
|
2389
2418
|
*/
|
|
2390
2419
|
conversionRate?: string | null;
|
|
2391
2420
|
}
|
|
2392
|
-
declare enum OrderStatus {
|
|
2421
|
+
export declare enum OrderStatus {
|
|
2393
2422
|
/** Order created, but not yet approved or canceled. */
|
|
2394
2423
|
INITIALIZED = "INITIALIZED",
|
|
2395
2424
|
/**
|
|
@@ -2414,7 +2443,7 @@ declare enum OrderStatus {
|
|
|
2414
2443
|
*/
|
|
2415
2444
|
REJECTED = "REJECTED"
|
|
2416
2445
|
}
|
|
2417
|
-
interface Activity extends ActivityContentOneOf {
|
|
2446
|
+
export interface Activity extends ActivityContentOneOf {
|
|
2418
2447
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2419
2448
|
customActivity?: CustomActivity;
|
|
2420
2449
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -2426,7 +2455,7 @@ interface Activity extends ActivityContentOneOf {
|
|
|
2426
2455
|
* @format GUID
|
|
2427
2456
|
* @readonly
|
|
2428
2457
|
*/
|
|
2429
|
-
|
|
2458
|
+
id?: string | null;
|
|
2430
2459
|
/**
|
|
2431
2460
|
* Activity author's email.
|
|
2432
2461
|
* @format EMAIL
|
|
@@ -2437,12 +2466,12 @@ interface Activity extends ActivityContentOneOf {
|
|
|
2437
2466
|
* Activity creation date and time.
|
|
2438
2467
|
* @readonly
|
|
2439
2468
|
*/
|
|
2440
|
-
|
|
2469
|
+
createdDate?: Date | null;
|
|
2441
2470
|
/** Activity type. */
|
|
2442
2471
|
type?: ActivityType;
|
|
2443
2472
|
}
|
|
2444
2473
|
/** @oneof */
|
|
2445
|
-
interface ActivityContentOneOf {
|
|
2474
|
+
export interface ActivityContentOneOf {
|
|
2446
2475
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2447
2476
|
customActivity?: CustomActivity;
|
|
2448
2477
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -2450,7 +2479,7 @@ interface ActivityContentOneOf {
|
|
|
2450
2479
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2451
2480
|
orderRefunded?: OrderRefunded;
|
|
2452
2481
|
}
|
|
2453
|
-
interface CustomActivity {
|
|
2482
|
+
export interface CustomActivity {
|
|
2454
2483
|
/**
|
|
2455
2484
|
* ID of the app that created the custom activity.
|
|
2456
2485
|
* @format GUID
|
|
@@ -2465,7 +2494,7 @@ interface CustomActivity {
|
|
|
2465
2494
|
additionalData?: Record<string, string>;
|
|
2466
2495
|
}
|
|
2467
2496
|
/** Store owner added a comment */
|
|
2468
|
-
interface MerchantComment {
|
|
2497
|
+
export interface MerchantComment {
|
|
2469
2498
|
/**
|
|
2470
2499
|
* Merchant comment message.
|
|
2471
2500
|
* @minLength 1
|
|
@@ -2473,7 +2502,7 @@ interface MerchantComment {
|
|
|
2473
2502
|
*/
|
|
2474
2503
|
message?: string;
|
|
2475
2504
|
}
|
|
2476
|
-
interface OrderRefunded {
|
|
2505
|
+
export interface OrderRefunded {
|
|
2477
2506
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
2478
2507
|
manual?: boolean;
|
|
2479
2508
|
/** Refund amount. */
|
|
@@ -2484,14 +2513,14 @@ interface OrderRefunded {
|
|
|
2484
2513
|
*/
|
|
2485
2514
|
reason?: string;
|
|
2486
2515
|
}
|
|
2487
|
-
interface OrderCreatedFromExchange {
|
|
2516
|
+
export interface OrderCreatedFromExchange {
|
|
2488
2517
|
/**
|
|
2489
2518
|
* ID of the original order for which the exchange happened.
|
|
2490
2519
|
* @format GUID
|
|
2491
2520
|
*/
|
|
2492
2521
|
originalOrderId?: string;
|
|
2493
2522
|
}
|
|
2494
|
-
interface NewExchangeOrderCreated {
|
|
2523
|
+
export interface NewExchangeOrderCreated {
|
|
2495
2524
|
/**
|
|
2496
2525
|
* ID of the new order created as a result of an exchange of items.
|
|
2497
2526
|
* @format GUID
|
|
@@ -2504,7 +2533,7 @@ interface NewExchangeOrderCreated {
|
|
|
2504
2533
|
*/
|
|
2505
2534
|
lineItems?: LineItemExchangeData[];
|
|
2506
2535
|
}
|
|
2507
|
-
interface LineItemExchangeData {
|
|
2536
|
+
export interface LineItemExchangeData {
|
|
2508
2537
|
/**
|
|
2509
2538
|
* ID of the exchanged line item.
|
|
2510
2539
|
* @format GUID
|
|
@@ -2517,7 +2546,7 @@ interface LineItemExchangeData {
|
|
|
2517
2546
|
*/
|
|
2518
2547
|
quantity?: number;
|
|
2519
2548
|
}
|
|
2520
|
-
interface DraftOrderChangesApplied {
|
|
2549
|
+
export interface DraftOrderChangesApplied {
|
|
2521
2550
|
/** Draft order id. */
|
|
2522
2551
|
draftOrderId?: string;
|
|
2523
2552
|
/**
|
|
@@ -2528,7 +2557,7 @@ interface DraftOrderChangesApplied {
|
|
|
2528
2557
|
/** Changes applied to order. */
|
|
2529
2558
|
changes?: OrderChange[];
|
|
2530
2559
|
}
|
|
2531
|
-
interface OrderChange extends OrderChangeValueOneOf {
|
|
2560
|
+
export interface OrderChange extends OrderChangeValueOneOf {
|
|
2532
2561
|
lineItemChanged?: LineItemChanges;
|
|
2533
2562
|
lineItemAdded?: ManagedLineItem;
|
|
2534
2563
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2540,7 +2569,7 @@ interface OrderChange extends OrderChangeValueOneOf {
|
|
|
2540
2569
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2541
2570
|
}
|
|
2542
2571
|
/** @oneof */
|
|
2543
|
-
interface OrderChangeValueOneOf {
|
|
2572
|
+
export interface OrderChangeValueOneOf {
|
|
2544
2573
|
lineItemChanged?: LineItemChanges;
|
|
2545
2574
|
lineItemAdded?: ManagedLineItem;
|
|
2546
2575
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2551,12 +2580,12 @@ interface OrderChangeValueOneOf {
|
|
|
2551
2580
|
totalPriceChanged?: TotalPriceChange;
|
|
2552
2581
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2553
2582
|
}
|
|
2554
|
-
interface LineItemChanges {
|
|
2583
|
+
export interface LineItemChanges {
|
|
2555
2584
|
/**
|
|
2556
2585
|
* Line item ID.
|
|
2557
2586
|
* @format GUID
|
|
2558
2587
|
*/
|
|
2559
|
-
|
|
2588
|
+
id?: string;
|
|
2560
2589
|
/** Item name. */
|
|
2561
2590
|
name?: ProductName;
|
|
2562
2591
|
/** Item quantity change. */
|
|
@@ -2564,7 +2593,7 @@ interface LineItemChanges {
|
|
|
2564
2593
|
/** Item price change. */
|
|
2565
2594
|
price?: LineItemPriceChange;
|
|
2566
2595
|
}
|
|
2567
|
-
interface LineItemQuantityChange {
|
|
2596
|
+
export interface LineItemQuantityChange {
|
|
2568
2597
|
/**
|
|
2569
2598
|
* Item quantity before update.
|
|
2570
2599
|
* @max 1000000
|
|
@@ -2584,24 +2613,24 @@ interface LineItemQuantityChange {
|
|
|
2584
2613
|
/** Type of quantity change: increase or decrease. */
|
|
2585
2614
|
deltaType?: LineItemQuantityChangeType;
|
|
2586
2615
|
}
|
|
2587
|
-
declare enum LineItemQuantityChangeType {
|
|
2616
|
+
export declare enum LineItemQuantityChangeType {
|
|
2588
2617
|
/** Quantity increased. */
|
|
2589
2618
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
2590
2619
|
/** Quantity decreased. */
|
|
2591
2620
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
2592
2621
|
}
|
|
2593
|
-
interface LineItemPriceChange {
|
|
2622
|
+
export interface LineItemPriceChange {
|
|
2594
2623
|
/** Item price before update. */
|
|
2595
2624
|
originalPrice?: Price;
|
|
2596
2625
|
/** Item price after update. */
|
|
2597
2626
|
newPrice?: Price;
|
|
2598
2627
|
}
|
|
2599
|
-
interface ManagedLineItem {
|
|
2628
|
+
export interface ManagedLineItem {
|
|
2600
2629
|
/**
|
|
2601
2630
|
* Line item ID.
|
|
2602
2631
|
* @format GUID
|
|
2603
2632
|
*/
|
|
2604
|
-
|
|
2633
|
+
id?: string;
|
|
2605
2634
|
/** Item name. */
|
|
2606
2635
|
name?: ProductName;
|
|
2607
2636
|
/**
|
|
@@ -2611,12 +2640,12 @@ interface ManagedLineItem {
|
|
|
2611
2640
|
*/
|
|
2612
2641
|
quantity?: number;
|
|
2613
2642
|
}
|
|
2614
|
-
interface ManagedDiscount {
|
|
2643
|
+
export interface ManagedDiscount {
|
|
2615
2644
|
/**
|
|
2616
2645
|
* Discount id.
|
|
2617
2646
|
* @format GUID
|
|
2618
2647
|
*/
|
|
2619
|
-
|
|
2648
|
+
id?: string;
|
|
2620
2649
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2621
2650
|
name?: TranslatedValue;
|
|
2622
2651
|
/** Line items discount applies to. */
|
|
@@ -2624,7 +2653,7 @@ interface ManagedDiscount {
|
|
|
2624
2653
|
/** Discount amount. */
|
|
2625
2654
|
totalAmount?: Price;
|
|
2626
2655
|
}
|
|
2627
|
-
interface TranslatedValue {
|
|
2656
|
+
export interface TranslatedValue {
|
|
2628
2657
|
/**
|
|
2629
2658
|
* Value in site default language.
|
|
2630
2659
|
* @minLength 1
|
|
@@ -2636,23 +2665,23 @@ interface TranslatedValue {
|
|
|
2636
2665
|
*/
|
|
2637
2666
|
translated?: string | null;
|
|
2638
2667
|
}
|
|
2639
|
-
interface LineItemAmount {
|
|
2668
|
+
export interface LineItemAmount {
|
|
2640
2669
|
/**
|
|
2641
2670
|
* Order line item id
|
|
2642
2671
|
* @format GUID
|
|
2643
2672
|
*/
|
|
2644
|
-
|
|
2673
|
+
id?: string;
|
|
2645
2674
|
/** Item name. */
|
|
2646
2675
|
name?: ProductName;
|
|
2647
2676
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
2648
2677
|
amount?: Price;
|
|
2649
2678
|
}
|
|
2650
|
-
interface ManagedAdditionalFee {
|
|
2679
|
+
export interface ManagedAdditionalFee {
|
|
2651
2680
|
/**
|
|
2652
2681
|
* Additional fee id.
|
|
2653
2682
|
* @format GUID
|
|
2654
2683
|
*/
|
|
2655
|
-
|
|
2684
|
+
id?: string;
|
|
2656
2685
|
/** Additional fee name. */
|
|
2657
2686
|
name?: TranslatedValue;
|
|
2658
2687
|
/** Line items additional fee applies to. */
|
|
@@ -2660,19 +2689,19 @@ interface ManagedAdditionalFee {
|
|
|
2660
2689
|
/** Additional fee amount. */
|
|
2661
2690
|
totalAmount?: Price;
|
|
2662
2691
|
}
|
|
2663
|
-
interface TotalPriceChange {
|
|
2692
|
+
export interface TotalPriceChange {
|
|
2664
2693
|
/** Order’s total price after discounts and tax. Before update */
|
|
2665
2694
|
originalTotal?: Price;
|
|
2666
2695
|
/** Order’s total price after discounts and tax. After update */
|
|
2667
2696
|
newTotal?: Price;
|
|
2668
2697
|
}
|
|
2669
|
-
interface ShippingInformationChange {
|
|
2698
|
+
export interface ShippingInformationChange {
|
|
2670
2699
|
/** Order’s Shipping Information. Before update */
|
|
2671
2700
|
originalShippingInfo?: ShippingInformation;
|
|
2672
2701
|
/** Order’s Shipping Information. After update */
|
|
2673
2702
|
newShippingInfo?: ShippingInformation;
|
|
2674
2703
|
}
|
|
2675
|
-
interface ShippingInformation {
|
|
2704
|
+
export interface ShippingInformation {
|
|
2676
2705
|
/** Order’s shipping price. */
|
|
2677
2706
|
total?: Price;
|
|
2678
2707
|
/**
|
|
@@ -2682,7 +2711,7 @@ interface ShippingInformation {
|
|
|
2682
2711
|
shippingTitle?: string;
|
|
2683
2712
|
}
|
|
2684
2713
|
/** Payment method is saved for order */
|
|
2685
|
-
interface SavedPaymentMethod {
|
|
2714
|
+
export interface SavedPaymentMethod {
|
|
2686
2715
|
/**
|
|
2687
2716
|
* Payment method name
|
|
2688
2717
|
* @minLength 1
|
|
@@ -2696,7 +2725,7 @@ interface SavedPaymentMethod {
|
|
|
2696
2725
|
*/
|
|
2697
2726
|
description?: string | null;
|
|
2698
2727
|
}
|
|
2699
|
-
interface AuthorizedPaymentCreated {
|
|
2728
|
+
export interface AuthorizedPaymentCreated {
|
|
2700
2729
|
/**
|
|
2701
2730
|
* Payment ID of payment associated with this activity
|
|
2702
2731
|
* @format GUID
|
|
@@ -2715,7 +2744,7 @@ interface AuthorizedPaymentCreated {
|
|
|
2715
2744
|
*/
|
|
2716
2745
|
brand?: string | null;
|
|
2717
2746
|
}
|
|
2718
|
-
interface AuthorizedPaymentCaptured {
|
|
2747
|
+
export interface AuthorizedPaymentCaptured {
|
|
2719
2748
|
/**
|
|
2720
2749
|
* Payment ID of payment associated with this activity
|
|
2721
2750
|
* @format GUID
|
|
@@ -2734,7 +2763,7 @@ interface AuthorizedPaymentCaptured {
|
|
|
2734
2763
|
*/
|
|
2735
2764
|
brand?: string | null;
|
|
2736
2765
|
}
|
|
2737
|
-
interface AuthorizedPaymentVoided {
|
|
2766
|
+
export interface AuthorizedPaymentVoided {
|
|
2738
2767
|
/**
|
|
2739
2768
|
* Payment ID of payment associated with this activity
|
|
2740
2769
|
* @format GUID
|
|
@@ -2753,7 +2782,7 @@ interface AuthorizedPaymentVoided {
|
|
|
2753
2782
|
*/
|
|
2754
2783
|
brand?: string | null;
|
|
2755
2784
|
}
|
|
2756
|
-
interface RefundInitiated {
|
|
2785
|
+
export interface RefundInitiated {
|
|
2757
2786
|
/**
|
|
2758
2787
|
* Refund ID.
|
|
2759
2788
|
* @format GUID
|
|
@@ -2773,7 +2802,7 @@ interface RefundInitiated {
|
|
|
2773
2802
|
*/
|
|
2774
2803
|
reason?: string | null;
|
|
2775
2804
|
}
|
|
2776
|
-
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
2805
|
+
export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
2777
2806
|
/** Regular payment refund. */
|
|
2778
2807
|
regular?: RegularPaymentRefund;
|
|
2779
2808
|
/** Gift card payment refund. */
|
|
@@ -2789,7 +2818,7 @@ interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
2789
2818
|
externalRefund?: boolean;
|
|
2790
2819
|
}
|
|
2791
2820
|
/** @oneof */
|
|
2792
|
-
interface RefundedPaymentKindOneOf {
|
|
2821
|
+
export interface RefundedPaymentKindOneOf {
|
|
2793
2822
|
/** Regular payment refund. */
|
|
2794
2823
|
regular?: RegularPaymentRefund;
|
|
2795
2824
|
/** Gift card payment refund. */
|
|
@@ -2797,7 +2826,7 @@ interface RefundedPaymentKindOneOf {
|
|
|
2797
2826
|
/** Membership payment refund. */
|
|
2798
2827
|
membership?: MembershipPaymentRefund;
|
|
2799
2828
|
}
|
|
2800
|
-
interface RegularPaymentRefund {
|
|
2829
|
+
export interface RegularPaymentRefund {
|
|
2801
2830
|
/** Refund amount */
|
|
2802
2831
|
amount?: Price;
|
|
2803
2832
|
/**
|
|
@@ -2811,7 +2840,7 @@ interface RegularPaymentRefund {
|
|
|
2811
2840
|
*/
|
|
2812
2841
|
brand?: string | null;
|
|
2813
2842
|
}
|
|
2814
|
-
interface GiftCardPaymentRefund {
|
|
2843
|
+
export interface GiftCardPaymentRefund {
|
|
2815
2844
|
/**
|
|
2816
2845
|
* Gift card payment ID
|
|
2817
2846
|
* @minLength 1
|
|
@@ -2821,7 +2850,7 @@ interface GiftCardPaymentRefund {
|
|
|
2821
2850
|
/** Refund amount */
|
|
2822
2851
|
amount?: Price;
|
|
2823
2852
|
}
|
|
2824
|
-
interface MembershipPaymentRefund {
|
|
2853
|
+
export interface MembershipPaymentRefund {
|
|
2825
2854
|
/**
|
|
2826
2855
|
* Membership ID
|
|
2827
2856
|
* @minLength 1
|
|
@@ -2829,7 +2858,7 @@ interface MembershipPaymentRefund {
|
|
|
2829
2858
|
*/
|
|
2830
2859
|
membershipId?: string | null;
|
|
2831
2860
|
}
|
|
2832
|
-
interface PaymentRefunded {
|
|
2861
|
+
export interface PaymentRefunded {
|
|
2833
2862
|
/**
|
|
2834
2863
|
* Refund ID.
|
|
2835
2864
|
* @format GUID
|
|
@@ -2838,7 +2867,7 @@ interface PaymentRefunded {
|
|
|
2838
2867
|
/** Details about the refunded payment. */
|
|
2839
2868
|
payment?: RefundedPayment;
|
|
2840
2869
|
}
|
|
2841
|
-
interface PaymentRefundFailed {
|
|
2870
|
+
export interface PaymentRefundFailed {
|
|
2842
2871
|
/**
|
|
2843
2872
|
* Refund ID.
|
|
2844
2873
|
* @format GUID
|
|
@@ -2847,7 +2876,7 @@ interface PaymentRefundFailed {
|
|
|
2847
2876
|
/** Details about the failed payment refund. */
|
|
2848
2877
|
payment?: RefundedPayment;
|
|
2849
2878
|
}
|
|
2850
|
-
interface RefundedAsStoreCredit {
|
|
2879
|
+
export interface RefundedAsStoreCredit {
|
|
2851
2880
|
/** Refund amount */
|
|
2852
2881
|
amount?: Price;
|
|
2853
2882
|
/**
|
|
@@ -2856,7 +2885,7 @@ interface RefundedAsStoreCredit {
|
|
|
2856
2885
|
*/
|
|
2857
2886
|
reason?: string | null;
|
|
2858
2887
|
}
|
|
2859
|
-
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
2888
|
+
export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
2860
2889
|
/** Regular payment. */
|
|
2861
2890
|
regular?: RegularPayment;
|
|
2862
2891
|
/**
|
|
@@ -2866,22 +2895,22 @@ interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
2866
2895
|
paymentId?: string;
|
|
2867
2896
|
}
|
|
2868
2897
|
/** @oneof */
|
|
2869
|
-
interface PaymentPendingPaymentDetailsOneOf {
|
|
2898
|
+
export interface PaymentPendingPaymentDetailsOneOf {
|
|
2870
2899
|
/** Regular payment. */
|
|
2871
2900
|
regular?: RegularPayment;
|
|
2872
2901
|
}
|
|
2873
|
-
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
2902
|
+
export interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
2874
2903
|
/** Whether regular card used */
|
|
2875
2904
|
creditCardDetails?: CreditCardDetails;
|
|
2876
2905
|
/** Payment amount */
|
|
2877
2906
|
amount?: Price;
|
|
2878
2907
|
}
|
|
2879
2908
|
/** @oneof */
|
|
2880
|
-
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
2909
|
+
export interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
2881
2910
|
/** Whether regular card used */
|
|
2882
2911
|
creditCardDetails?: CreditCardDetails;
|
|
2883
2912
|
}
|
|
2884
|
-
interface CreditCardDetails {
|
|
2913
|
+
export interface CreditCardDetails {
|
|
2885
2914
|
/**
|
|
2886
2915
|
* The last 4 digits of the card number.
|
|
2887
2916
|
* @maxLength 4
|
|
@@ -2893,7 +2922,7 @@ interface CreditCardDetails {
|
|
|
2893
2922
|
*/
|
|
2894
2923
|
brand?: string | null;
|
|
2895
2924
|
}
|
|
2896
|
-
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
2925
|
+
export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
2897
2926
|
/** Regular payment. */
|
|
2898
2927
|
regular?: RegularPayment;
|
|
2899
2928
|
/**
|
|
@@ -2903,11 +2932,11 @@ interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
2903
2932
|
paymentId?: string;
|
|
2904
2933
|
}
|
|
2905
2934
|
/** @oneof */
|
|
2906
|
-
interface PaymentCanceledPaymentDetailsOneOf {
|
|
2935
|
+
export interface PaymentCanceledPaymentDetailsOneOf {
|
|
2907
2936
|
/** Regular payment. */
|
|
2908
2937
|
regular?: RegularPayment;
|
|
2909
2938
|
}
|
|
2910
|
-
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
2939
|
+
export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
2911
2940
|
/** Regular payment. */
|
|
2912
2941
|
regular?: RegularPayment;
|
|
2913
2942
|
/**
|
|
@@ -2917,11 +2946,11 @@ interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
2917
2946
|
paymentId?: string;
|
|
2918
2947
|
}
|
|
2919
2948
|
/** @oneof */
|
|
2920
|
-
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
2949
|
+
export interface PaymentDeclinedPaymentDetailsOneOf {
|
|
2921
2950
|
/** Regular payment. */
|
|
2922
2951
|
regular?: RegularPayment;
|
|
2923
2952
|
}
|
|
2924
|
-
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
2953
|
+
export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
2925
2954
|
/** Receipt created by Wix */
|
|
2926
2955
|
wixReceipt?: WixReceipt;
|
|
2927
2956
|
/** Receipt created by an external system. */
|
|
@@ -2933,13 +2962,13 @@ interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
2933
2962
|
paymentId?: string;
|
|
2934
2963
|
}
|
|
2935
2964
|
/** @oneof */
|
|
2936
|
-
interface ReceiptCreatedReceiptInfoOneOf {
|
|
2965
|
+
export interface ReceiptCreatedReceiptInfoOneOf {
|
|
2937
2966
|
/** Receipt created by Wix */
|
|
2938
2967
|
wixReceipt?: WixReceipt;
|
|
2939
2968
|
/** Receipt created by an external system. */
|
|
2940
2969
|
externalReceipt?: ExternalReceipt;
|
|
2941
2970
|
}
|
|
2942
|
-
interface WixReceipt {
|
|
2971
|
+
export interface WixReceipt {
|
|
2943
2972
|
/**
|
|
2944
2973
|
* Receipt ID
|
|
2945
2974
|
* @format GUID
|
|
@@ -2952,7 +2981,7 @@ interface WixReceipt {
|
|
|
2952
2981
|
*/
|
|
2953
2982
|
displayNumber?: string | null;
|
|
2954
2983
|
}
|
|
2955
|
-
interface ExternalReceipt {
|
|
2984
|
+
export interface ExternalReceipt {
|
|
2956
2985
|
/**
|
|
2957
2986
|
* Receipt ID
|
|
2958
2987
|
* @maxLength 100
|
|
@@ -2965,7 +2994,7 @@ interface ExternalReceipt {
|
|
|
2965
2994
|
*/
|
|
2966
2995
|
displayNumber?: string | null;
|
|
2967
2996
|
}
|
|
2968
|
-
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
2997
|
+
export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
2969
2998
|
/** Receipt created by Wix */
|
|
2970
2999
|
wixReceipt?: WixReceipt;
|
|
2971
3000
|
/** Receipt created by an external system. */
|
|
@@ -2977,13 +3006,13 @@ interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
2977
3006
|
paymentId?: string;
|
|
2978
3007
|
}
|
|
2979
3008
|
/** @oneof */
|
|
2980
|
-
interface ReceiptSentReceiptInfoOneOf {
|
|
3009
|
+
export interface ReceiptSentReceiptInfoOneOf {
|
|
2981
3010
|
/** Receipt created by Wix */
|
|
2982
3011
|
wixReceipt?: WixReceipt;
|
|
2983
3012
|
/** Receipt created by an external system. */
|
|
2984
3013
|
externalReceipt?: ExternalReceipt;
|
|
2985
3014
|
}
|
|
2986
|
-
declare enum ActivityType {
|
|
3015
|
+
export declare enum ActivityType {
|
|
2987
3016
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
2988
3017
|
ORDER_PLACED = "ORDER_PLACED",
|
|
2989
3018
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -3020,11 +3049,11 @@ declare enum ActivityType {
|
|
|
3020
3049
|
/** @documentationMaturity preview */
|
|
3021
3050
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
3022
3051
|
}
|
|
3023
|
-
declare enum AttributionSource {
|
|
3052
|
+
export declare enum AttributionSource {
|
|
3024
3053
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3025
3054
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
3026
3055
|
}
|
|
3027
|
-
interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3056
|
+
export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3028
3057
|
/**
|
|
3029
3058
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3030
3059
|
* For example, via POS (point of service).
|
|
@@ -3048,7 +3077,7 @@ interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
3048
3077
|
appId?: string;
|
|
3049
3078
|
}
|
|
3050
3079
|
/** @oneof */
|
|
3051
|
-
interface V1CreatedByStringOneOf {
|
|
3080
|
+
export interface V1CreatedByStringOneOf {
|
|
3052
3081
|
/**
|
|
3053
3082
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3054
3083
|
* For example, via POS (point of service).
|
|
@@ -3071,7 +3100,7 @@ interface V1CreatedByStringOneOf {
|
|
|
3071
3100
|
*/
|
|
3072
3101
|
appId?: string;
|
|
3073
3102
|
}
|
|
3074
|
-
interface ChannelInfo {
|
|
3103
|
+
export interface ChannelInfo {
|
|
3075
3104
|
/** Sales channel that submitted the order. */
|
|
3076
3105
|
type?: ChannelType;
|
|
3077
3106
|
/**
|
|
@@ -3085,7 +3114,7 @@ interface ChannelInfo {
|
|
|
3085
3114
|
*/
|
|
3086
3115
|
externalOrderUrl?: string | null;
|
|
3087
3116
|
}
|
|
3088
|
-
declare enum ChannelType {
|
|
3117
|
+
export declare enum ChannelType {
|
|
3089
3118
|
/** Unspecified sales channel. This value is not supported. */
|
|
3090
3119
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3091
3120
|
/** A web client. */
|
|
@@ -3119,7 +3148,7 @@ declare enum ChannelType {
|
|
|
3119
3148
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
3120
3149
|
FAIRE_COM = "FAIRE_COM"
|
|
3121
3150
|
}
|
|
3122
|
-
interface CustomField {
|
|
3151
|
+
export interface CustomField {
|
|
3123
3152
|
/** Custom field value. */
|
|
3124
3153
|
value?: any;
|
|
3125
3154
|
/**
|
|
@@ -3135,7 +3164,7 @@ interface CustomField {
|
|
|
3135
3164
|
*/
|
|
3136
3165
|
translatedTitle?: string | null;
|
|
3137
3166
|
}
|
|
3138
|
-
interface V1BalanceSummary {
|
|
3167
|
+
export interface V1BalanceSummary {
|
|
3139
3168
|
/**
|
|
3140
3169
|
* Current amount left to pay.
|
|
3141
3170
|
* @readonly
|
|
@@ -3164,7 +3193,7 @@ interface V1BalanceSummary {
|
|
|
3164
3193
|
*/
|
|
3165
3194
|
pending?: Price;
|
|
3166
3195
|
}
|
|
3167
|
-
interface FulfillmentStatusesAggregate {
|
|
3196
|
+
export interface FulfillmentStatusesAggregate {
|
|
3168
3197
|
/** Unique string values based on Fulfillment entities statuses */
|
|
3169
3198
|
statuses?: string[] | null;
|
|
3170
3199
|
}
|
|
@@ -3190,13 +3219,13 @@ interface FulfillmentStatusesAggregate {
|
|
|
3190
3219
|
* }
|
|
3191
3220
|
* }
|
|
3192
3221
|
*/
|
|
3193
|
-
interface Tags {
|
|
3222
|
+
export interface Tags {
|
|
3194
3223
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
3195
3224
|
privateTags?: TagList;
|
|
3196
3225
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
3197
3226
|
tags?: TagList;
|
|
3198
3227
|
}
|
|
3199
|
-
interface TagList {
|
|
3228
|
+
export interface TagList {
|
|
3200
3229
|
/**
|
|
3201
3230
|
* List of tag IDs
|
|
3202
3231
|
* @maxSize 100
|
|
@@ -3204,28 +3233,28 @@ interface TagList {
|
|
|
3204
3233
|
*/
|
|
3205
3234
|
tagIds?: string[];
|
|
3206
3235
|
}
|
|
3207
|
-
interface CreateOrderFromDraftRequest {
|
|
3236
|
+
export interface CreateOrderFromDraftRequest {
|
|
3208
3237
|
}
|
|
3209
|
-
interface OrderCreateSettings {
|
|
3238
|
+
export interface OrderCreateSettings {
|
|
3210
3239
|
}
|
|
3211
|
-
interface OrderCreateNotifications {
|
|
3240
|
+
export interface OrderCreateNotifications {
|
|
3212
3241
|
}
|
|
3213
|
-
interface CreateOrderFromDraftResponse {
|
|
3242
|
+
export interface CreateOrderFromDraftResponse {
|
|
3214
3243
|
}
|
|
3215
|
-
interface DeleteDraftOrderRequest {
|
|
3244
|
+
export interface DeleteDraftOrderRequest {
|
|
3216
3245
|
/**
|
|
3217
3246
|
* The draft order id
|
|
3218
3247
|
* @format GUID
|
|
3219
3248
|
*/
|
|
3220
3249
|
draftOrderId: string;
|
|
3221
3250
|
}
|
|
3222
|
-
interface DeleteDraftOrderResponse {
|
|
3251
|
+
export interface DeleteDraftOrderResponse {
|
|
3223
3252
|
}
|
|
3224
|
-
interface QueryDraftOrdersRequest {
|
|
3253
|
+
export interface QueryDraftOrdersRequest {
|
|
3225
3254
|
/** WQL expression */
|
|
3226
3255
|
query?: CursorQuery;
|
|
3227
3256
|
}
|
|
3228
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3257
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3229
3258
|
/**
|
|
3230
3259
|
* Cursor paging options.
|
|
3231
3260
|
*
|
|
@@ -3247,7 +3276,7 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3247
3276
|
sort?: Sorting[];
|
|
3248
3277
|
}
|
|
3249
3278
|
/** @oneof */
|
|
3250
|
-
interface CursorQueryPagingMethodOneOf {
|
|
3279
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
3251
3280
|
/**
|
|
3252
3281
|
* Cursor paging options.
|
|
3253
3282
|
*
|
|
@@ -3255,7 +3284,7 @@ interface CursorQueryPagingMethodOneOf {
|
|
|
3255
3284
|
*/
|
|
3256
3285
|
cursorPaging?: CursorPaging;
|
|
3257
3286
|
}
|
|
3258
|
-
interface Sorting {
|
|
3287
|
+
export interface Sorting {
|
|
3259
3288
|
/**
|
|
3260
3289
|
* Name of the field to sort by.
|
|
3261
3290
|
* @maxLength 512
|
|
@@ -3264,11 +3293,11 @@ interface Sorting {
|
|
|
3264
3293
|
/** Sort order. */
|
|
3265
3294
|
order?: SortOrder;
|
|
3266
3295
|
}
|
|
3267
|
-
declare enum SortOrder {
|
|
3296
|
+
export declare enum SortOrder {
|
|
3268
3297
|
ASC = "ASC",
|
|
3269
3298
|
DESC = "DESC"
|
|
3270
3299
|
}
|
|
3271
|
-
interface CursorPaging {
|
|
3300
|
+
export interface CursorPaging {
|
|
3272
3301
|
/**
|
|
3273
3302
|
* Maximum number of items to return in the results.
|
|
3274
3303
|
* @max 100
|
|
@@ -3283,13 +3312,13 @@ interface CursorPaging {
|
|
|
3283
3312
|
*/
|
|
3284
3313
|
cursor?: string | null;
|
|
3285
3314
|
}
|
|
3286
|
-
interface QueryDraftOrdersResponse {
|
|
3315
|
+
export interface QueryDraftOrdersResponse {
|
|
3287
3316
|
/** list of edits per order */
|
|
3288
3317
|
draftOrders?: DraftOrder[];
|
|
3289
3318
|
/** Paging metadata. */
|
|
3290
3319
|
pagingMetadata?: CursorPagingMetadata;
|
|
3291
3320
|
}
|
|
3292
|
-
interface CursorPagingMetadata {
|
|
3321
|
+
export interface CursorPagingMetadata {
|
|
3293
3322
|
/** Number of items returned in current page. */
|
|
3294
3323
|
count?: number | null;
|
|
3295
3324
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -3302,7 +3331,7 @@ interface CursorPagingMetadata {
|
|
|
3302
3331
|
*/
|
|
3303
3332
|
hasNext?: boolean | null;
|
|
3304
3333
|
}
|
|
3305
|
-
interface Cursors {
|
|
3334
|
+
export interface Cursors {
|
|
3306
3335
|
/**
|
|
3307
3336
|
* Cursor string pointing to the next page in the list of results.
|
|
3308
3337
|
* @maxLength 16000
|
|
@@ -3314,30 +3343,30 @@ interface Cursors {
|
|
|
3314
3343
|
*/
|
|
3315
3344
|
prev?: string | null;
|
|
3316
3345
|
}
|
|
3317
|
-
interface UpdateExtendedFieldsRequest {
|
|
3346
|
+
export interface UpdateExtendedFieldsRequest {
|
|
3318
3347
|
/** ID of the entity to update. */
|
|
3319
|
-
|
|
3348
|
+
id?: string;
|
|
3320
3349
|
/** Identifier for the app whose extended fields are being updated. */
|
|
3321
3350
|
namespace?: string;
|
|
3322
3351
|
/** 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. */
|
|
3323
3352
|
namespaceData?: Record<string, any> | null;
|
|
3324
3353
|
}
|
|
3325
|
-
interface UpdateExtendedFieldsResponse {
|
|
3354
|
+
export interface UpdateExtendedFieldsResponse {
|
|
3326
3355
|
/** Updated DraftOrder */
|
|
3327
3356
|
draftOrder?: DraftOrder;
|
|
3328
3357
|
}
|
|
3329
|
-
interface SetTaxExemptionRequest {
|
|
3358
|
+
export interface SetTaxExemptionRequest {
|
|
3330
3359
|
}
|
|
3331
|
-
interface SetTaxExemptionResponse {
|
|
3360
|
+
export interface SetTaxExemptionResponse {
|
|
3332
3361
|
}
|
|
3333
|
-
interface GetDraftEditabilityStatusRequest {
|
|
3362
|
+
export interface GetDraftEditabilityStatusRequest {
|
|
3334
3363
|
/**
|
|
3335
3364
|
* Draft order ID.
|
|
3336
3365
|
* @format GUID
|
|
3337
3366
|
*/
|
|
3338
3367
|
draftOrderId?: string | null;
|
|
3339
3368
|
}
|
|
3340
|
-
interface GetDraftEditabilityStatusResponse {
|
|
3369
|
+
export interface GetDraftEditabilityStatusResponse {
|
|
3341
3370
|
/**
|
|
3342
3371
|
* Draft order ID.
|
|
3343
3372
|
* @format GUID
|
|
@@ -3349,11 +3378,11 @@ interface GetDraftEditabilityStatusResponse {
|
|
|
3349
3378
|
*/
|
|
3350
3379
|
status?: EditingStatus;
|
|
3351
3380
|
}
|
|
3352
|
-
interface SetBusinessLocationRequest {
|
|
3381
|
+
export interface SetBusinessLocationRequest {
|
|
3353
3382
|
}
|
|
3354
|
-
interface SetBusinessLocationResponse {
|
|
3383
|
+
export interface SetBusinessLocationResponse {
|
|
3355
3384
|
}
|
|
3356
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3385
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3357
3386
|
createdEvent?: EntityCreatedEvent;
|
|
3358
3387
|
updatedEvent?: EntityUpdatedEvent;
|
|
3359
3388
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3362,7 +3391,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3362
3391
|
* Unique event ID.
|
|
3363
3392
|
* Allows clients to ignore duplicate webhooks.
|
|
3364
3393
|
*/
|
|
3365
|
-
|
|
3394
|
+
id?: string;
|
|
3366
3395
|
/**
|
|
3367
3396
|
* Assumes actions are also always typed to an entity_type
|
|
3368
3397
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -3396,34 +3425,36 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3396
3425
|
entityEventSequence?: string | null;
|
|
3397
3426
|
}
|
|
3398
3427
|
/** @oneof */
|
|
3399
|
-
interface DomainEventBodyOneOf {
|
|
3428
|
+
export interface DomainEventBodyOneOf {
|
|
3400
3429
|
createdEvent?: EntityCreatedEvent;
|
|
3401
3430
|
updatedEvent?: EntityUpdatedEvent;
|
|
3402
3431
|
deletedEvent?: EntityDeletedEvent;
|
|
3403
3432
|
actionEvent?: ActionEvent;
|
|
3404
3433
|
}
|
|
3405
|
-
interface EntityCreatedEvent {
|
|
3406
|
-
|
|
3434
|
+
export interface EntityCreatedEvent {
|
|
3435
|
+
entityAsJson?: string;
|
|
3436
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3437
|
+
restoreInfo?: RestoreInfo;
|
|
3407
3438
|
}
|
|
3408
|
-
interface RestoreInfo {
|
|
3439
|
+
export interface RestoreInfo {
|
|
3409
3440
|
deletedDate?: Date | null;
|
|
3410
3441
|
}
|
|
3411
|
-
interface EntityUpdatedEvent {
|
|
3442
|
+
export interface EntityUpdatedEvent {
|
|
3412
3443
|
/**
|
|
3413
3444
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3414
3445
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3415
3446
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3416
3447
|
*/
|
|
3417
|
-
|
|
3448
|
+
currentEntityAsJson?: string;
|
|
3418
3449
|
}
|
|
3419
|
-
interface EntityDeletedEvent {
|
|
3450
|
+
export interface EntityDeletedEvent {
|
|
3420
3451
|
/** Entity that was deleted */
|
|
3421
|
-
|
|
3452
|
+
deletedEntityAsJson?: string | null;
|
|
3422
3453
|
}
|
|
3423
|
-
interface ActionEvent {
|
|
3424
|
-
|
|
3454
|
+
export interface ActionEvent {
|
|
3455
|
+
bodyAsJson?: string;
|
|
3425
3456
|
}
|
|
3426
|
-
interface MessageEnvelope {
|
|
3457
|
+
export interface MessageEnvelope {
|
|
3427
3458
|
/**
|
|
3428
3459
|
* App instance ID.
|
|
3429
3460
|
* @format GUID
|
|
@@ -3439,7 +3470,7 @@ interface MessageEnvelope {
|
|
|
3439
3470
|
/** Stringify payload. */
|
|
3440
3471
|
data?: string;
|
|
3441
3472
|
}
|
|
3442
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3473
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3443
3474
|
/**
|
|
3444
3475
|
* ID of a site visitor that has not logged in to the site.
|
|
3445
3476
|
* @format GUID
|
|
@@ -3464,7 +3495,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3464
3495
|
identityType?: WebhookIdentityType;
|
|
3465
3496
|
}
|
|
3466
3497
|
/** @oneof */
|
|
3467
|
-
interface IdentificationDataIdOneOf {
|
|
3498
|
+
export interface IdentificationDataIdOneOf {
|
|
3468
3499
|
/**
|
|
3469
3500
|
* ID of a site visitor that has not logged in to the site.
|
|
3470
3501
|
* @format GUID
|
|
@@ -3486,134 +3517,10 @@ interface IdentificationDataIdOneOf {
|
|
|
3486
3517
|
*/
|
|
3487
3518
|
appId?: string;
|
|
3488
3519
|
}
|
|
3489
|
-
declare enum WebhookIdentityType {
|
|
3520
|
+
export declare enum WebhookIdentityType {
|
|
3490
3521
|
UNKNOWN = "UNKNOWN",
|
|
3491
3522
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3492
3523
|
MEMBER = "MEMBER",
|
|
3493
3524
|
WIX_USER = "WIX_USER",
|
|
3494
3525
|
APP = "APP"
|
|
3495
3526
|
}
|
|
3496
|
-
interface AddLineItemsToDraftOrderOptions {
|
|
3497
|
-
/**
|
|
3498
|
-
* Catalog line items to add to draft order.
|
|
3499
|
-
* @maxSize 300
|
|
3500
|
-
*/
|
|
3501
|
-
catalogLineItems?: CatalogReferenceLineItem[];
|
|
3502
|
-
/**
|
|
3503
|
-
* Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
|
|
3504
|
-
* @maxSize 300
|
|
3505
|
-
*/
|
|
3506
|
-
customLineItems?: CustomLineItem[];
|
|
3507
|
-
}
|
|
3508
|
-
interface UpdateLineItemsOptions {
|
|
3509
|
-
/**
|
|
3510
|
-
* Details of changes to apply per line item
|
|
3511
|
-
* @minSize 1
|
|
3512
|
-
* @maxSize 300
|
|
3513
|
-
*/
|
|
3514
|
-
lineItemChanges?: LineItemChangeDetails[];
|
|
3515
|
-
}
|
|
3516
|
-
interface CreateCustomDiscountsOptions {
|
|
3517
|
-
/**
|
|
3518
|
-
* The discounts to add.
|
|
3519
|
-
* @minSize 1
|
|
3520
|
-
* @maxSize 100
|
|
3521
|
-
*/
|
|
3522
|
-
discounts?: DiscountOption[];
|
|
3523
|
-
}
|
|
3524
|
-
interface CreateCustomAdditionalFeesOptions {
|
|
3525
|
-
/**
|
|
3526
|
-
* The additional fees to add. added with opted-out setting
|
|
3527
|
-
* @minSize 1
|
|
3528
|
-
* @maxSize 100
|
|
3529
|
-
*/
|
|
3530
|
-
customAdditionalFees?: AdditionalFeeOption[];
|
|
3531
|
-
}
|
|
3532
|
-
interface CommitDraftOrderOptions {
|
|
3533
|
-
/** Optional side effects to trigger */
|
|
3534
|
-
commitSettings?: DraftOrderCommitSettings;
|
|
3535
|
-
/**
|
|
3536
|
-
* Reason for edit, given by user (optional).
|
|
3537
|
-
* @maxLength 200
|
|
3538
|
-
*/
|
|
3539
|
-
reason?: string | null;
|
|
3540
|
-
}
|
|
3541
|
-
interface QueryCursorResult {
|
|
3542
|
-
cursors: Cursors;
|
|
3543
|
-
hasNext: () => boolean;
|
|
3544
|
-
hasPrev: () => boolean;
|
|
3545
|
-
length: number;
|
|
3546
|
-
pageSize: number;
|
|
3547
|
-
}
|
|
3548
|
-
interface DraftOrdersQueryResult extends QueryCursorResult {
|
|
3549
|
-
items: DraftOrder[];
|
|
3550
|
-
query: DraftOrdersQueryBuilder;
|
|
3551
|
-
next: () => Promise<DraftOrdersQueryResult>;
|
|
3552
|
-
prev: () => Promise<DraftOrdersQueryResult>;
|
|
3553
|
-
}
|
|
3554
|
-
interface DraftOrdersQueryBuilder {
|
|
3555
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3556
|
-
* @param value - Value to compare against.
|
|
3557
|
-
* @documentationMaturity preview
|
|
3558
|
-
*/
|
|
3559
|
-
eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
3560
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3561
|
-
* @param value - Value to compare against.
|
|
3562
|
-
* @documentationMaturity preview
|
|
3563
|
-
*/
|
|
3564
|
-
ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
3565
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3566
|
-
* @param value - Value to compare against.
|
|
3567
|
-
* @documentationMaturity preview
|
|
3568
|
-
*/
|
|
3569
|
-
ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
3570
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3571
|
-
* @param value - Value to compare against.
|
|
3572
|
-
* @documentationMaturity preview
|
|
3573
|
-
*/
|
|
3574
|
-
gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
3575
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3576
|
-
* @param value - Value to compare against.
|
|
3577
|
-
* @documentationMaturity preview
|
|
3578
|
-
*/
|
|
3579
|
-
le: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
3580
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
3581
|
-
* @param value - Value to compare against.
|
|
3582
|
-
* @documentationMaturity preview
|
|
3583
|
-
*/
|
|
3584
|
-
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
3585
|
-
/** @param propertyName - Property whose value is compared with `string`.
|
|
3586
|
-
* @param string - String to compare against. Case-insensitive.
|
|
3587
|
-
* @documentationMaturity preview
|
|
3588
|
-
*/
|
|
3589
|
-
startsWith: (propertyName: 'orderId', value: string) => DraftOrdersQueryBuilder;
|
|
3590
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
3591
|
-
* @param values - List of values to compare against.
|
|
3592
|
-
* @documentationMaturity preview
|
|
3593
|
-
*/
|
|
3594
|
-
hasSome: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;
|
|
3595
|
-
/** @documentationMaturity preview */
|
|
3596
|
-
in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
|
|
3597
|
-
/** @documentationMaturity preview */
|
|
3598
|
-
exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;
|
|
3599
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
3600
|
-
* @documentationMaturity preview
|
|
3601
|
-
*/
|
|
3602
|
-
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
3603
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
3604
|
-
* @documentationMaturity preview
|
|
3605
|
-
*/
|
|
3606
|
-
descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
|
|
3607
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
3608
|
-
* @documentationMaturity preview
|
|
3609
|
-
*/
|
|
3610
|
-
limit: (limit: number) => DraftOrdersQueryBuilder;
|
|
3611
|
-
/** @param cursor - A pointer to specific record
|
|
3612
|
-
* @documentationMaturity preview
|
|
3613
|
-
*/
|
|
3614
|
-
skipTo: (cursor: string) => DraftOrdersQueryBuilder;
|
|
3615
|
-
/** @documentationMaturity preview */
|
|
3616
|
-
find: () => Promise<DraftOrdersQueryResult>;
|
|
3617
|
-
}
|
|
3618
|
-
|
|
3619
|
-
export { type OrderLineItem as $, type AddLineItemsToDraftOrderOptions as A, AttributionSource as B, type CreateDraftOrderResponse as C, type DeleteCustomDiscountsResponse as D, EditingStatus as E, FileType as F, type GetDraftOrderResponse as G, ChannelType as H, type IdAndApplied as I, JurisdictionType as J, SortOrder as K, LineItemQuantityChangeType as L, WebhookIdentityType as M, NonDraftableReason as N, OrderStatus as O, PaymentOptionType as P, type DraftOrder as Q, RuleType as R, type SetDiscountsResponse as S, TaxableAddressType as T, type UpdateLineItemsOptions as U, VatType as V, WeightUnit as W, type ItemDetails as X, type ItemDetailsChangeTypeOneOf as Y, type Price as Z, type PriceDescription as _, type CreateEmptyDraftOrderResponse as a, type BalanceSummary as a$, type ProductName as a0, type CatalogReference as a1, type DescriptionLine as a2, type DescriptionLineValueOneOf as a3, type DescriptionLineDescriptionLineValueOneOf as a4, type DescriptionLineName as a5, type PlainTextValue as a6, type Color as a7, type FocalPoint as a8, type PhysicalProperties as a9, type AddressLocation as aA, type FullAddressContactDetails as aB, type VatId as aC, type V1PickupDetails as aD, type PickupAddress as aE, type V1DeliveryTimeSlot as aF, type V1ShippingPrice as aG, type ShippingRegion as aH, type ShippingChangedDetails as aI, type BuyerInfo as aJ, type BuyerInfoIdOneOf as aK, type AdditionalFeeDetails as aL, type AdditionalFee as aM, type TaxDetails as aN, type DiscountDetails as aO, type AppliedDiscount as aP, type AppliedDiscountDiscountSourceOneOf as aQ, type Coupon as aR, type MerchantDiscount as aS, type MerchantDiscountMerchantDiscountReasonOneOf as aT, type DiscountRule as aU, type DiscountRuleName as aV, type LineItemDiscount as aW, type CreatedBy as aX, type CreatedByStringOneOf as aY, type PriceSummary as aZ, type TaxSummary as a_, type ItemType as aa, type ItemTypeItemTypeDataOneOf as ab, type ItemTaxFullDetails as ac, type LineItemTaxInfo as ad, type LineItemTaxBreakdown as ae, type DigitalFile as af, type SubscriptionInfo as ag, type SubscriptionTitle as ah, type SubscriptionDescription as ai, type SubscriptionSettings as aj, type FreeTrialPeriod as ak, type BillingAdjustment as al, type BillingAdjustmentPriceSummary as am, type LocationAndQuantity as an, type TaxableAddress as ao, type TaxableAddressTaxableAddressDataOneOf as ap, type ExtendedFields as aq, type ItemChangedDetails as ar, type ShippingDetails as as, type ShippingDetailsChangeTypeOneOf as at, type V1ShippingInformation as au, type V1DeliveryLogistics as av, type V1DeliveryLogisticsAddressOneOf as aw, type AddressWithContact as ax, type Address as ay, type StreetAddress as az, type AddLineItemsToDraftOrderResponse as b, type CommitDraftOrderRequest as b$, type Balance as b0, type DraftOrderCommitSettings as b1, type InventoryUpdate as b2, type RecipientInfoDetails as b3, type RecipientInfoDetailsChangeTypeOneOf as b4, type RecipientInfoChangedDetails as b5, type OrderTaxInfo as b6, type OrderTaxBreakdown as b7, type BuyerDetails as b8, type BuyerDetailsChangeTypeOneOf as b9, type AddLineItemsToDraftOrderRequest as bA, type CatalogReferenceLineItem as bB, type CustomLineItem as bC, type SecuredMedia as bD, type UpdateLineItemsRequest as bE, type LineItemChangeDetails as bF, type SetDiscountsRequest as bG, type CreateCustomDiscountsRequest as bH, type DiscountOption as bI, type DiscountOptionDiscountAmountOneOf as bJ, type DeleteCustomDiscountsRequest as bK, type SetAdditionalFeesRequest as bL, type CreateCustomAdditionalFeesRequest as bM, type AdditionalFeeOption as bN, type DeleteCustomAdditionalFeesRequest as bO, type SetShippingInfoRequest as bP, type SetShippingInfoResponse as bQ, type SetBuyerInfoRequest as bR, type SetBuyerInfoResponse as bS, type SetRecipientInfoRequest as bT, type SetRecipientInfoResponse as bU, type SetBillingInfoRequest as bV, type SetBillingInfoResponse as bW, type UpdateShippingInfoRequest as bX, type UpdateShippingInfoResponse as bY, type GetDraftOrderRequest as bZ, type GetOrderDraftabilityStatusRequest as b_, type BuyerChangedDetails as ba, type BillingDetails as bb, type BillingDetailsChangeTypeOneOf as bc, type BillingChangedDetails as bd, type BusinessLocationDetails as be, type BusinessLocationDetailsChangeTypeOneOf as bf, type Location as bg, type BusinessLocationChangedDetails as bh, type CreateDraftOrderRequest as bi, type CalculatedDraftOrder as bj, type ShippingOption as bk, type DeliveryLogistics as bl, type PickupDetails as bm, type DeliveryTimeSlot as bn, type ShippingPrice as bo, type CalculationErrors as bp, type CalculationErrorsShippingCalculationErrorOneOf as bq, type Details as br, type DetailsKindOneOf as bs, type ApplicationError as bt, type ValidationError as bu, type FieldViolation as bv, type SystemError as bw, type CarrierErrors as bx, type CarrierError as by, type CreateEmptyDraftOrderRequest as bz, type UpdateLineItemsResponse as c, type CreateOrderFromDraftResponse as c$, type Order as c0, type CurrencyConversionDetails as c1, type Activity as c2, type ActivityContentOneOf as c3, type CustomActivity as c4, type MerchantComment as c5, type OrderRefunded as c6, type OrderCreatedFromExchange as c7, type NewExchangeOrderCreated as c8, type LineItemExchangeData as c9, type RefundedAsStoreCredit as cA, type PaymentPending as cB, type PaymentPendingPaymentDetailsOneOf as cC, type RegularPayment as cD, type RegularPaymentPaymentMethodDetailsOneOf as cE, type CreditCardDetails as cF, type PaymentCanceled as cG, type PaymentCanceledPaymentDetailsOneOf as cH, type PaymentDeclined as cI, type PaymentDeclinedPaymentDetailsOneOf as cJ, type ReceiptCreated as cK, type ReceiptCreatedReceiptInfoOneOf as cL, type WixReceipt as cM, type ExternalReceipt as cN, type ReceiptSent as cO, type ReceiptSentReceiptInfoOneOf as cP, type V1CreatedBy as cQ, type V1CreatedByStringOneOf as cR, type ChannelInfo as cS, type CustomField as cT, type V1BalanceSummary as cU, type FulfillmentStatusesAggregate as cV, type Tags as cW, type TagList as cX, type CreateOrderFromDraftRequest as cY, type OrderCreateSettings as cZ, type OrderCreateNotifications as c_, type DraftOrderChangesApplied as ca, type OrderChange as cb, type OrderChangeValueOneOf as cc, type LineItemChanges as cd, type LineItemQuantityChange as ce, type LineItemPriceChange as cf, type ManagedLineItem as cg, type ManagedDiscount as ch, type TranslatedValue as ci, type LineItemAmount as cj, type ManagedAdditionalFee as ck, type TotalPriceChange as cl, type ShippingInformationChange as cm, type ShippingInformation as cn, type SavedPaymentMethod as co, type AuthorizedPaymentCreated as cp, type AuthorizedPaymentCaptured as cq, type AuthorizedPaymentVoided as cr, type RefundInitiated as cs, type RefundedPayment as ct, type RefundedPaymentKindOneOf as cu, type RegularPaymentRefund as cv, type GiftCardPaymentRefund as cw, type MembershipPaymentRefund as cx, type PaymentRefunded as cy, type PaymentRefundFailed as cz, type CreateCustomDiscountsOptions as d, type DeleteDraftOrderRequest as d0, type DeleteDraftOrderResponse as d1, type QueryDraftOrdersRequest as d2, type CursorQuery as d3, type CursorQueryPagingMethodOneOf as d4, type Sorting as d5, type CursorPaging as d6, type QueryDraftOrdersResponse as d7, type CursorPagingMetadata as d8, type Cursors as d9, type UpdateExtendedFieldsRequest as da, type UpdateExtendedFieldsResponse as db, type SetTaxExemptionRequest as dc, type SetTaxExemptionResponse as dd, type GetDraftEditabilityStatusRequest as de, type GetDraftEditabilityStatusResponse as df, type SetBusinessLocationRequest as dg, type SetBusinessLocationResponse as dh, type DomainEvent as di, type DomainEventBodyOneOf as dj, type EntityCreatedEvent as dk, type RestoreInfo as dl, type EntityUpdatedEvent as dm, type EntityDeletedEvent as dn, type ActionEvent as dp, type MessageEnvelope as dq, type IdentificationData as dr, type IdentificationDataIdOneOf as ds, type DraftOrdersQueryResult as dt, type CreateCustomDiscountsResponse as e, type SetAdditionalFeesResponse as f, type CreateCustomAdditionalFeesOptions as g, type CreateCustomAdditionalFeesResponse as h, type DeleteCustomAdditionalFeesResponse as i, type GetOrderDraftabilityStatusResponse as j, type CommitDraftOrderOptions as k, type CommitDraftOrderResponse as l, type DraftOrdersQueryBuilder as m, DescriptionLineType as n, ItemTypeItemType as o, SubscriptionFrequency as p, AdjustmentType as q, PickupDetailsPickupMethod as r, SourceType as s, AppliedDiscountDiscountType as t, DiscountReason as u, PickupMethod as v, DiscountType as w, PaymentStatus as x, FulfillmentStatus as y, ActivityType as z };
|