@wix/auto_sdk_ecom_draft-orders 1.0.17 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.mts} +423 -831
- package/build/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.ts} +423 -831
- package/build/index.d.mts +232 -0
- package/build/index.d.ts +232 -0
- package/build/index.js +4593 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +4520 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.mts} +885 -1096
- package/build/internal/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.ts} +885 -1096
- package/build/internal/index.d.mts +232 -0
- package/build/internal/index.d.ts +232 -0
- package/build/internal/index.js +4593 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +4520 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2751 -0
- package/build/internal/meta.d.ts +2751 -0
- package/build/internal/meta.js +3323 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +3275 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2751 -0
- package/build/meta.d.ts +2751 -0
- package/build/meta.js +3323 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +3275 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -57
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -2951
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -446
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -168
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -360
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4562
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1943
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -26
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -2926
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -398
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -114
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -357
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4562
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1895
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -57
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -2951
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -446
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -168
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -360
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -5285
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1943
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -26
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -2926
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -398
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -114
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -357
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -5285
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1895
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
/** DraftOrder is the main entity of DraftOrders service. It represents a single edit order. */
|
|
2
|
-
|
|
2
|
+
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 @@ export 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 @@ export interface DraftOrder {
|
|
|
122
122
|
*/
|
|
123
123
|
businessLocationDetails?: BusinessLocationDetails;
|
|
124
124
|
}
|
|
125
|
-
|
|
125
|
+
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 @@ export interface ItemDetails extends ItemDetailsChangeTypeOneOf {
|
|
|
133
133
|
lineItem?: OrderLineItem;
|
|
134
134
|
}
|
|
135
135
|
/** @oneof */
|
|
136
|
-
|
|
136
|
+
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 @@ export interface ItemDetailsChangeTypeOneOf {
|
|
|
141
141
|
/** Whether the line item was removed as part of the draft. */
|
|
142
142
|
removed?: boolean;
|
|
143
143
|
}
|
|
144
|
-
|
|
144
|
+
interface Price {
|
|
145
145
|
/**
|
|
146
146
|
* Amount.
|
|
147
147
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -153,7 +153,7 @@ export interface Price {
|
|
|
153
153
|
*/
|
|
154
154
|
formattedAmount?: string;
|
|
155
155
|
}
|
|
156
|
-
|
|
156
|
+
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 @@ export interface PriceDescription {
|
|
|
169
169
|
*/
|
|
170
170
|
translated?: string | null;
|
|
171
171
|
}
|
|
172
|
-
|
|
172
|
+
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 @@ export interface OrderLineItem {
|
|
|
204
204
|
*/
|
|
205
205
|
descriptionLines?: DescriptionLine[];
|
|
206
206
|
/** Line item image. */
|
|
207
|
-
image?:
|
|
207
|
+
image?: string;
|
|
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 @@ export interface OrderLineItem {
|
|
|
286
286
|
*/
|
|
287
287
|
extendedFields?: ExtendedFields;
|
|
288
288
|
}
|
|
289
|
-
|
|
289
|
+
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 @@ export 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
|
-
|
|
311
|
+
interface CatalogReference {
|
|
312
312
|
/**
|
|
313
313
|
* ID of the item within the catalog it belongs to.
|
|
314
314
|
* @minLength 1
|
|
@@ -334,7 +334,7 @@ export interface CatalogReference {
|
|
|
334
334
|
*/
|
|
335
335
|
options?: Record<string, any> | null;
|
|
336
336
|
}
|
|
337
|
-
|
|
337
|
+
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 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
343
343
|
name?: DescriptionLineName;
|
|
344
344
|
}
|
|
345
345
|
/** @oneof */
|
|
346
|
-
|
|
346
|
+
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
|
-
|
|
353
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
354
354
|
}
|
|
355
|
-
|
|
355
|
+
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 @@ export interface DescriptionLineName {
|
|
|
366
366
|
*/
|
|
367
367
|
translated?: string | null;
|
|
368
368
|
}
|
|
369
|
-
|
|
369
|
+
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 @@ export interface PlainTextValue {
|
|
|
380
380
|
*/
|
|
381
381
|
translated?: string | null;
|
|
382
382
|
}
|
|
383
|
-
|
|
383
|
+
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 @@ export interface Color {
|
|
|
396
396
|
/** HEX or RGB color code for display. */
|
|
397
397
|
code?: string | null;
|
|
398
398
|
}
|
|
399
|
-
|
|
399
|
+
declare enum DescriptionLineType {
|
|
400
400
|
/** Unrecognized type. */
|
|
401
401
|
UNRECOGNISED = "UNRECOGNISED",
|
|
402
402
|
/** Plain text type. */
|
|
@@ -404,30 +404,7 @@ export declare enum DescriptionLineType {
|
|
|
404
404
|
/** Color type. */
|
|
405
405
|
COLOR = "COLOR"
|
|
406
406
|
}
|
|
407
|
-
|
|
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 {
|
|
407
|
+
interface FocalPoint {
|
|
431
408
|
/** X-coordinate of the focal point. */
|
|
432
409
|
x?: number;
|
|
433
410
|
/** Y-coordinate of the focal point. */
|
|
@@ -437,7 +414,7 @@ export interface FocalPoint {
|
|
|
437
414
|
/** crop by width */
|
|
438
415
|
width?: number | null;
|
|
439
416
|
}
|
|
440
|
-
|
|
417
|
+
interface PhysicalProperties {
|
|
441
418
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
442
419
|
weight?: number | null;
|
|
443
420
|
/**
|
|
@@ -448,20 +425,20 @@ export interface PhysicalProperties {
|
|
|
448
425
|
/** Whether this line item is shippable. */
|
|
449
426
|
shippable?: boolean;
|
|
450
427
|
}
|
|
451
|
-
|
|
428
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
452
429
|
/** Preset item type. */
|
|
453
430
|
preset?: ItemTypeItemType;
|
|
454
431
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
455
432
|
custom?: string;
|
|
456
433
|
}
|
|
457
434
|
/** @oneof */
|
|
458
|
-
|
|
435
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
459
436
|
/** Preset item type. */
|
|
460
437
|
preset?: ItemTypeItemType;
|
|
461
438
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
462
439
|
custom?: string;
|
|
463
440
|
}
|
|
464
|
-
|
|
441
|
+
declare enum ItemTypeItemType {
|
|
465
442
|
UNRECOGNISED = "UNRECOGNISED",
|
|
466
443
|
PHYSICAL = "PHYSICAL",
|
|
467
444
|
DIGITAL = "DIGITAL",
|
|
@@ -469,7 +446,7 @@ export declare enum ItemTypeItemType {
|
|
|
469
446
|
SERVICE = "SERVICE"
|
|
470
447
|
}
|
|
471
448
|
/** Type of selected payment option for catalog item */
|
|
472
|
-
|
|
449
|
+
declare enum PaymentOptionType {
|
|
473
450
|
/** The entire payment for this item happens as part of the checkout. */
|
|
474
451
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
475
452
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -481,7 +458,7 @@ export declare enum PaymentOptionType {
|
|
|
481
458
|
/** 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`. */
|
|
482
459
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
483
460
|
}
|
|
484
|
-
|
|
461
|
+
interface ItemTaxFullDetails {
|
|
485
462
|
/** Taxable amount of this line item. */
|
|
486
463
|
taxableAmount?: Price;
|
|
487
464
|
/**
|
|
@@ -492,7 +469,7 @@ export interface ItemTaxFullDetails {
|
|
|
492
469
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
493
470
|
totalTax?: Price;
|
|
494
471
|
}
|
|
495
|
-
|
|
472
|
+
interface LineItemTaxInfo {
|
|
496
473
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
497
474
|
taxAmount?: Price;
|
|
498
475
|
/** Amount for which tax is calculated. */
|
|
@@ -520,7 +497,7 @@ export interface LineItemTaxInfo {
|
|
|
520
497
|
* TaxBreakdown represents tax information for a line item.
|
|
521
498
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
522
499
|
*/
|
|
523
|
-
|
|
500
|
+
interface LineItemTaxBreakdown {
|
|
524
501
|
/**
|
|
525
502
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
526
503
|
* @maxLength 200
|
|
@@ -553,7 +530,7 @@ export interface LineItemTaxBreakdown {
|
|
|
553
530
|
taxableAmount?: Price;
|
|
554
531
|
}
|
|
555
532
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
556
|
-
|
|
533
|
+
declare enum JurisdictionType {
|
|
557
534
|
UNDEFINED = "UNDEFINED",
|
|
558
535
|
COUNTRY = "COUNTRY",
|
|
559
536
|
STATE = "STATE",
|
|
@@ -561,7 +538,7 @@ export declare enum JurisdictionType {
|
|
|
561
538
|
CITY = "CITY",
|
|
562
539
|
SPECIAL = "SPECIAL"
|
|
563
540
|
}
|
|
564
|
-
|
|
541
|
+
interface DigitalFile {
|
|
565
542
|
/**
|
|
566
543
|
* ID of the secure file in media.
|
|
567
544
|
* @minLength 1
|
|
@@ -581,12 +558,12 @@ export interface DigitalFile {
|
|
|
581
558
|
*/
|
|
582
559
|
expirationDate?: Date | null;
|
|
583
560
|
}
|
|
584
|
-
|
|
561
|
+
interface SubscriptionInfo {
|
|
585
562
|
/**
|
|
586
563
|
* Subscription ID.
|
|
587
564
|
* @format GUID
|
|
588
565
|
*/
|
|
589
|
-
|
|
566
|
+
_id?: string | null;
|
|
590
567
|
/**
|
|
591
568
|
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
592
569
|
* @min 1
|
|
@@ -614,7 +591,7 @@ export interface SubscriptionInfo {
|
|
|
614
591
|
*/
|
|
615
592
|
subscriptionSettings?: SubscriptionSettings;
|
|
616
593
|
}
|
|
617
|
-
|
|
594
|
+
interface SubscriptionTitle {
|
|
618
595
|
/**
|
|
619
596
|
* 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).
|
|
620
597
|
* @minLength 1
|
|
@@ -630,7 +607,7 @@ export interface SubscriptionTitle {
|
|
|
630
607
|
*/
|
|
631
608
|
translated?: string | null;
|
|
632
609
|
}
|
|
633
|
-
|
|
610
|
+
interface SubscriptionDescription {
|
|
634
611
|
/**
|
|
635
612
|
* Subscription option description.
|
|
636
613
|
* @maxLength 500
|
|
@@ -642,7 +619,7 @@ export interface SubscriptionDescription {
|
|
|
642
619
|
*/
|
|
643
620
|
translated?: string | null;
|
|
644
621
|
}
|
|
645
|
-
|
|
622
|
+
interface SubscriptionSettings {
|
|
646
623
|
/** Frequency of recurring payment. */
|
|
647
624
|
frequency?: SubscriptionFrequency;
|
|
648
625
|
/**
|
|
@@ -660,14 +637,14 @@ export interface SubscriptionSettings {
|
|
|
660
637
|
billingCycles?: number | null;
|
|
661
638
|
}
|
|
662
639
|
/** Frequency unit of recurring payment */
|
|
663
|
-
|
|
640
|
+
declare enum SubscriptionFrequency {
|
|
664
641
|
UNDEFINED = "UNDEFINED",
|
|
665
642
|
DAY = "DAY",
|
|
666
643
|
WEEK = "WEEK",
|
|
667
644
|
MONTH = "MONTH",
|
|
668
645
|
YEAR = "YEAR"
|
|
669
646
|
}
|
|
670
|
-
|
|
647
|
+
interface FreeTrialPeriod {
|
|
671
648
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
672
649
|
frequency?: SubscriptionFrequency;
|
|
673
650
|
/**
|
|
@@ -677,20 +654,20 @@ export interface FreeTrialPeriod {
|
|
|
677
654
|
*/
|
|
678
655
|
interval?: number;
|
|
679
656
|
}
|
|
680
|
-
|
|
657
|
+
interface BillingAdjustment {
|
|
681
658
|
/** The type of adjustment. */
|
|
682
659
|
type?: AdjustmentType;
|
|
683
660
|
/** Summary of the prorated adjustment amount. */
|
|
684
661
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
685
662
|
}
|
|
686
|
-
|
|
663
|
+
declare enum AdjustmentType {
|
|
687
664
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
688
665
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
689
666
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
690
667
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
691
668
|
CREDIT = "CREDIT"
|
|
692
669
|
}
|
|
693
|
-
|
|
670
|
+
interface BillingAdjustmentPriceSummary {
|
|
694
671
|
/** Subtotal of adjustment, before tax. */
|
|
695
672
|
subtotal?: Price;
|
|
696
673
|
/** Tax on adjustment. */
|
|
@@ -698,12 +675,12 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
698
675
|
/** Total price after tax. */
|
|
699
676
|
total?: Price;
|
|
700
677
|
}
|
|
701
|
-
|
|
678
|
+
interface LocationAndQuantity {
|
|
702
679
|
/**
|
|
703
680
|
* Location id in the associated owner app.
|
|
704
681
|
* @format GUID
|
|
705
682
|
*/
|
|
706
|
-
|
|
683
|
+
_id?: string;
|
|
707
684
|
/**
|
|
708
685
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
709
686
|
* @format GUID
|
|
@@ -724,22 +701,22 @@ export interface LocationAndQuantity {
|
|
|
724
701
|
*/
|
|
725
702
|
name?: string | null;
|
|
726
703
|
}
|
|
727
|
-
|
|
704
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
728
705
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
729
706
|
addressType?: TaxableAddressType;
|
|
730
707
|
}
|
|
731
708
|
/** @oneof */
|
|
732
|
-
|
|
709
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
733
710
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
734
711
|
addressType?: TaxableAddressType;
|
|
735
712
|
}
|
|
736
|
-
|
|
713
|
+
declare enum TaxableAddressType {
|
|
737
714
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
738
715
|
BUSINESS = "BUSINESS",
|
|
739
716
|
BILLING = "BILLING",
|
|
740
717
|
SHIPPING = "SHIPPING"
|
|
741
718
|
}
|
|
742
|
-
|
|
719
|
+
interface ExtendedFields {
|
|
743
720
|
/**
|
|
744
721
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
745
722
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -750,7 +727,7 @@ export interface ExtendedFields {
|
|
|
750
727
|
*/
|
|
751
728
|
namespaces?: Record<string, Record<string, any>>;
|
|
752
729
|
}
|
|
753
|
-
|
|
730
|
+
interface ItemChangedDetails {
|
|
754
731
|
/**
|
|
755
732
|
* Line item quantity before change.
|
|
756
733
|
* @min 1
|
|
@@ -762,7 +739,7 @@ export interface ItemChangedDetails {
|
|
|
762
739
|
/** Line item price description before change. */
|
|
763
740
|
priceDescriptionBeforeChange?: PriceDescription;
|
|
764
741
|
}
|
|
765
|
-
|
|
742
|
+
interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
766
743
|
/** Whether shipping info was added as part of the draft. */
|
|
767
744
|
added?: boolean;
|
|
768
745
|
/** Shipping info before the change. */
|
|
@@ -773,7 +750,7 @@ export interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
|
|
|
773
750
|
shippingInfo?: V1ShippingInformation;
|
|
774
751
|
}
|
|
775
752
|
/** @oneof */
|
|
776
|
-
|
|
753
|
+
interface ShippingDetailsChangeTypeOneOf {
|
|
777
754
|
/** Whether shipping info was added as part of the draft. */
|
|
778
755
|
added?: boolean;
|
|
779
756
|
/** Shipping info before the change. */
|
|
@@ -781,7 +758,7 @@ export interface ShippingDetailsChangeTypeOneOf {
|
|
|
781
758
|
/** Whether shipping info was removed as part of the draft. */
|
|
782
759
|
removed?: boolean;
|
|
783
760
|
}
|
|
784
|
-
|
|
761
|
+
interface V1ShippingInformation {
|
|
785
762
|
/**
|
|
786
763
|
* App Def Id of external provider which was a source of shipping info
|
|
787
764
|
* @minLength 1
|
|
@@ -807,7 +784,7 @@ export interface V1ShippingInformation {
|
|
|
807
784
|
/** Shipping region. */
|
|
808
785
|
region?: ShippingRegion;
|
|
809
786
|
}
|
|
810
|
-
|
|
787
|
+
interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
811
788
|
/** Shipping address and contact details. */
|
|
812
789
|
shippingDestination?: AddressWithContact;
|
|
813
790
|
/** Pickup details. */
|
|
@@ -831,21 +808,21 @@ export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
|
|
|
831
808
|
deliveryTimeSlot?: V1DeliveryTimeSlot;
|
|
832
809
|
}
|
|
833
810
|
/** @oneof */
|
|
834
|
-
|
|
811
|
+
interface V1DeliveryLogisticsAddressOneOf {
|
|
835
812
|
/** Shipping address and contact details. */
|
|
836
813
|
shippingDestination?: AddressWithContact;
|
|
837
814
|
/** Pickup details. */
|
|
838
815
|
pickupDetails?: V1PickupDetails;
|
|
839
816
|
}
|
|
840
817
|
/** Billing Info and shipping details */
|
|
841
|
-
|
|
818
|
+
interface AddressWithContact {
|
|
842
819
|
/** Address. */
|
|
843
820
|
address?: Address;
|
|
844
821
|
/** Contact details. */
|
|
845
822
|
contactDetails?: FullAddressContactDetails;
|
|
846
823
|
}
|
|
847
824
|
/** Physical address */
|
|
848
|
-
|
|
825
|
+
interface Address {
|
|
849
826
|
/**
|
|
850
827
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
851
828
|
* @format COUNTRY
|
|
@@ -872,7 +849,7 @@ export interface Address {
|
|
|
872
849
|
* Main address line (usually street name and number).
|
|
873
850
|
* @maxLength 150
|
|
874
851
|
*/
|
|
875
|
-
|
|
852
|
+
addressLine1?: string | null;
|
|
876
853
|
/**
|
|
877
854
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
878
855
|
* @maxLength 100
|
|
@@ -889,20 +866,20 @@ export interface Address {
|
|
|
889
866
|
*/
|
|
890
867
|
subdivisionFullname?: string | null;
|
|
891
868
|
}
|
|
892
|
-
|
|
869
|
+
interface StreetAddress {
|
|
893
870
|
/** Street number. */
|
|
894
871
|
number?: string;
|
|
895
872
|
/** Street name. */
|
|
896
873
|
name?: string;
|
|
897
874
|
}
|
|
898
|
-
|
|
875
|
+
interface AddressLocation {
|
|
899
876
|
/** Address latitude. */
|
|
900
877
|
latitude?: number | null;
|
|
901
878
|
/** Address longitude. */
|
|
902
879
|
longitude?: number | null;
|
|
903
880
|
}
|
|
904
881
|
/** Full contact details for an address */
|
|
905
|
-
|
|
882
|
+
interface FullAddressContactDetails {
|
|
906
883
|
/**
|
|
907
884
|
* First name.
|
|
908
885
|
* @maxLength 100
|
|
@@ -926,9 +903,9 @@ export interface FullAddressContactDetails {
|
|
|
926
903
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
927
904
|
vatId?: VatId;
|
|
928
905
|
}
|
|
929
|
-
|
|
906
|
+
interface VatId {
|
|
930
907
|
/** Customer's tax ID. */
|
|
931
|
-
|
|
908
|
+
_id?: string;
|
|
932
909
|
/**
|
|
933
910
|
* Tax type.
|
|
934
911
|
*
|
|
@@ -939,21 +916,21 @@ export interface VatId {
|
|
|
939
916
|
type?: VatType;
|
|
940
917
|
}
|
|
941
918
|
/** tax info types */
|
|
942
|
-
|
|
919
|
+
declare enum VatType {
|
|
943
920
|
UNSPECIFIED = "UNSPECIFIED",
|
|
944
921
|
/** CPF - for individual tax payers. */
|
|
945
922
|
CPF = "CPF",
|
|
946
923
|
/** CNPJ - for corporations */
|
|
947
924
|
CNPJ = "CNPJ"
|
|
948
925
|
}
|
|
949
|
-
|
|
926
|
+
interface V1PickupDetails {
|
|
950
927
|
/** Pickup address. */
|
|
951
928
|
address?: PickupAddress;
|
|
952
929
|
/** Pickup method */
|
|
953
930
|
pickupMethod?: PickupDetailsPickupMethod;
|
|
954
931
|
}
|
|
955
932
|
/** Physical address */
|
|
956
|
-
|
|
933
|
+
interface PickupAddress {
|
|
957
934
|
/**
|
|
958
935
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
959
936
|
* @format COUNTRY
|
|
@@ -980,7 +957,7 @@ export interface PickupAddress {
|
|
|
980
957
|
* Main address line (usually street name and number).
|
|
981
958
|
* @maxLength 1000
|
|
982
959
|
*/
|
|
983
|
-
|
|
960
|
+
addressLine1?: string | null;
|
|
984
961
|
/**
|
|
985
962
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
986
963
|
* @maxLength 1000
|
|
@@ -997,18 +974,18 @@ export interface PickupAddress {
|
|
|
997
974
|
*/
|
|
998
975
|
subdivisionFullname?: string | null;
|
|
999
976
|
}
|
|
1000
|
-
|
|
977
|
+
declare enum PickupDetailsPickupMethod {
|
|
1001
978
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1002
979
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1003
980
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1004
981
|
}
|
|
1005
|
-
|
|
982
|
+
interface V1DeliveryTimeSlot {
|
|
1006
983
|
/** Delivery slot starting time. */
|
|
1007
984
|
from?: Date | null;
|
|
1008
985
|
/** Delivery slot ending time. */
|
|
1009
986
|
to?: Date | null;
|
|
1010
987
|
}
|
|
1011
|
-
|
|
988
|
+
interface V1ShippingPrice {
|
|
1012
989
|
/** Shipping price for display purposes. */
|
|
1013
990
|
price?: Price;
|
|
1014
991
|
/**
|
|
@@ -1029,19 +1006,19 @@ export interface V1ShippingPrice {
|
|
|
1029
1006
|
*/
|
|
1030
1007
|
discount?: Price;
|
|
1031
1008
|
}
|
|
1032
|
-
|
|
1009
|
+
interface ShippingRegion {
|
|
1033
1010
|
/**
|
|
1034
1011
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1035
1012
|
* @maxLength 100
|
|
1036
1013
|
*/
|
|
1037
1014
|
name?: string | null;
|
|
1038
1015
|
}
|
|
1039
|
-
|
|
1016
|
+
interface ShippingChangedDetails {
|
|
1040
1017
|
/** Shipping info before the change. */
|
|
1041
1018
|
shippingInfoBeforeChange?: V1ShippingInformation;
|
|
1042
1019
|
}
|
|
1043
1020
|
/** Buyer Info */
|
|
1044
|
-
|
|
1021
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1045
1022
|
/**
|
|
1046
1023
|
* Visitor ID (if site visitor is not a member).
|
|
1047
1024
|
* @format GUID
|
|
@@ -1064,7 +1041,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1064
1041
|
email?: string | null;
|
|
1065
1042
|
}
|
|
1066
1043
|
/** @oneof */
|
|
1067
|
-
|
|
1044
|
+
interface BuyerInfoIdOneOf {
|
|
1068
1045
|
/**
|
|
1069
1046
|
* Visitor ID (if site visitor is not a member).
|
|
1070
1047
|
* @format GUID
|
|
@@ -1076,7 +1053,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
1076
1053
|
*/
|
|
1077
1054
|
memberId?: string;
|
|
1078
1055
|
}
|
|
1079
|
-
|
|
1056
|
+
interface AdditionalFeeDetails {
|
|
1080
1057
|
/** Additional fee. */
|
|
1081
1058
|
additionalFee?: AdditionalFee;
|
|
1082
1059
|
/** Tax details related to the additional fee. */
|
|
@@ -1092,7 +1069,7 @@ export interface AdditionalFeeDetails {
|
|
|
1092
1069
|
/** Whether this additional fee is applied to the order. */
|
|
1093
1070
|
applied?: boolean;
|
|
1094
1071
|
}
|
|
1095
|
-
|
|
1072
|
+
interface AdditionalFee {
|
|
1096
1073
|
/**
|
|
1097
1074
|
* Additional fee's unique code for future processing.
|
|
1098
1075
|
* @minLength 1
|
|
@@ -1123,7 +1100,7 @@ export interface AdditionalFee {
|
|
|
1123
1100
|
* @format GUID
|
|
1124
1101
|
* @immutable
|
|
1125
1102
|
*/
|
|
1126
|
-
|
|
1103
|
+
_id?: string;
|
|
1127
1104
|
/**
|
|
1128
1105
|
* Optional - Line items associated with this additional fee.
|
|
1129
1106
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
@@ -1131,7 +1108,7 @@ export interface AdditionalFee {
|
|
|
1131
1108
|
*/
|
|
1132
1109
|
lineItemIds?: string[];
|
|
1133
1110
|
}
|
|
1134
|
-
|
|
1111
|
+
interface TaxDetails {
|
|
1135
1112
|
/** Indication if additional fee is taxable or not */
|
|
1136
1113
|
taxable?: boolean;
|
|
1137
1114
|
/**
|
|
@@ -1140,7 +1117,7 @@ export interface TaxDetails {
|
|
|
1140
1117
|
*/
|
|
1141
1118
|
taxGroupId?: string | null;
|
|
1142
1119
|
}
|
|
1143
|
-
|
|
1120
|
+
declare enum SourceType {
|
|
1144
1121
|
/** Part of the original order */
|
|
1145
1122
|
ORIGINAL_ORDER = "ORIGINAL_ORDER",
|
|
1146
1123
|
/** Added by estimate * */
|
|
@@ -1148,7 +1125,7 @@ export declare enum SourceType {
|
|
|
1148
1125
|
/** Added manually to current draft order */
|
|
1149
1126
|
CUSTOM = "CUSTOM"
|
|
1150
1127
|
}
|
|
1151
|
-
|
|
1128
|
+
interface DiscountDetails {
|
|
1152
1129
|
/** Discount details. */
|
|
1153
1130
|
discount?: AppliedDiscount;
|
|
1154
1131
|
/**
|
|
@@ -1162,7 +1139,7 @@ export interface DiscountDetails {
|
|
|
1162
1139
|
/** Whether this discount is applied to the order. */
|
|
1163
1140
|
applied?: boolean;
|
|
1164
1141
|
}
|
|
1165
|
-
|
|
1142
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1166
1143
|
/** Applied coupon info. */
|
|
1167
1144
|
coupon?: Coupon;
|
|
1168
1145
|
/** Merchant discount. */
|
|
@@ -1192,10 +1169,10 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1192
1169
|
* @format GUID
|
|
1193
1170
|
* @immutable
|
|
1194
1171
|
*/
|
|
1195
|
-
|
|
1172
|
+
_id?: string | null;
|
|
1196
1173
|
}
|
|
1197
1174
|
/** @oneof */
|
|
1198
|
-
|
|
1175
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1199
1176
|
/** Applied coupon info. */
|
|
1200
1177
|
coupon?: Coupon;
|
|
1201
1178
|
/** Merchant discount. */
|
|
@@ -1203,15 +1180,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1203
1180
|
/** Automatic Discount */
|
|
1204
1181
|
discountRule?: DiscountRule;
|
|
1205
1182
|
}
|
|
1206
|
-
|
|
1183
|
+
declare enum AppliedDiscountDiscountType {
|
|
1207
1184
|
GLOBAL = "GLOBAL",
|
|
1208
1185
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1209
1186
|
SHIPPING = "SHIPPING"
|
|
1210
1187
|
}
|
|
1211
1188
|
/** Coupon */
|
|
1212
|
-
|
|
1189
|
+
interface Coupon {
|
|
1213
1190
|
/** Coupon ID. */
|
|
1214
|
-
|
|
1191
|
+
_id?: string;
|
|
1215
1192
|
/** Coupon code. */
|
|
1216
1193
|
code?: string;
|
|
1217
1194
|
/** Coupon name. */
|
|
@@ -1219,7 +1196,7 @@ export interface Coupon {
|
|
|
1219
1196
|
/** Coupon value. */
|
|
1220
1197
|
amount?: Price;
|
|
1221
1198
|
}
|
|
1222
|
-
|
|
1199
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1223
1200
|
/**
|
|
1224
1201
|
* Pre-defined discount reason (optional).
|
|
1225
1202
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1234,7 +1211,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1234
1211
|
amount?: Price;
|
|
1235
1212
|
}
|
|
1236
1213
|
/** @oneof */
|
|
1237
|
-
|
|
1214
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1238
1215
|
/**
|
|
1239
1216
|
* Pre-defined discount reason (optional).
|
|
1240
1217
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1246,23 +1223,23 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1246
1223
|
*/
|
|
1247
1224
|
description?: string | null;
|
|
1248
1225
|
}
|
|
1249
|
-
|
|
1226
|
+
declare enum DiscountReason {
|
|
1250
1227
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1251
1228
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1252
1229
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1253
1230
|
}
|
|
1254
|
-
|
|
1231
|
+
interface DiscountRule {
|
|
1255
1232
|
/**
|
|
1256
1233
|
* Discount rule ID
|
|
1257
1234
|
* @format GUID
|
|
1258
1235
|
*/
|
|
1259
|
-
|
|
1236
|
+
_id?: string;
|
|
1260
1237
|
/** Discount rule name */
|
|
1261
1238
|
name?: DiscountRuleName;
|
|
1262
1239
|
/** Discount value. */
|
|
1263
1240
|
amount?: Price;
|
|
1264
1241
|
}
|
|
1265
|
-
|
|
1242
|
+
interface DiscountRuleName {
|
|
1266
1243
|
/**
|
|
1267
1244
|
* Original discount rule name (in site's default language).
|
|
1268
1245
|
* @minLength 1
|
|
@@ -1276,16 +1253,16 @@ export interface DiscountRuleName {
|
|
|
1276
1253
|
*/
|
|
1277
1254
|
translated?: string | null;
|
|
1278
1255
|
}
|
|
1279
|
-
|
|
1256
|
+
interface LineItemDiscount {
|
|
1280
1257
|
/**
|
|
1281
1258
|
* ID of line item the discount applies to.
|
|
1282
1259
|
* @format GUID
|
|
1283
1260
|
*/
|
|
1284
|
-
|
|
1261
|
+
_id?: string;
|
|
1285
1262
|
/** Total discount for this line item. */
|
|
1286
1263
|
totalDiscount?: Price;
|
|
1287
1264
|
}
|
|
1288
|
-
|
|
1265
|
+
interface CreatedBy extends CreatedByStringOneOf {
|
|
1289
1266
|
/**
|
|
1290
1267
|
* User ID. When the draft order was created by a Wix user.
|
|
1291
1268
|
* @format GUID
|
|
@@ -1298,7 +1275,7 @@ export interface CreatedBy extends CreatedByStringOneOf {
|
|
|
1298
1275
|
appId?: string;
|
|
1299
1276
|
}
|
|
1300
1277
|
/** @oneof */
|
|
1301
|
-
|
|
1278
|
+
interface CreatedByStringOneOf {
|
|
1302
1279
|
/**
|
|
1303
1280
|
* User ID. When the draft order was created by a Wix user.
|
|
1304
1281
|
* @format GUID
|
|
@@ -1310,13 +1287,13 @@ export interface CreatedByStringOneOf {
|
|
|
1310
1287
|
*/
|
|
1311
1288
|
appId?: string;
|
|
1312
1289
|
}
|
|
1313
|
-
|
|
1290
|
+
declare enum EditingStatus {
|
|
1314
1291
|
/** DraftOrder is in draft state. */
|
|
1315
1292
|
DRAFT = "DRAFT",
|
|
1316
1293
|
/** DraftOrder is in committed state. */
|
|
1317
1294
|
COMMITTED = "COMMITTED"
|
|
1318
1295
|
}
|
|
1319
|
-
|
|
1296
|
+
declare enum WeightUnit {
|
|
1320
1297
|
/** Weight unit can't be classified due to an error. */
|
|
1321
1298
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1322
1299
|
/** Kilograms. */
|
|
@@ -1324,7 +1301,7 @@ export declare enum WeightUnit {
|
|
|
1324
1301
|
/** Pounds. */
|
|
1325
1302
|
LB = "LB"
|
|
1326
1303
|
}
|
|
1327
|
-
|
|
1304
|
+
interface PriceSummary {
|
|
1328
1305
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
1329
1306
|
subtotal?: Price;
|
|
1330
1307
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1338,14 +1315,14 @@ export interface PriceSummary {
|
|
|
1338
1315
|
/** Total price of additional fees before tax. */
|
|
1339
1316
|
totalAdditionalFees?: Price;
|
|
1340
1317
|
}
|
|
1341
|
-
|
|
1318
|
+
interface TaxSummary {
|
|
1342
1319
|
/**
|
|
1343
1320
|
* Total tax.
|
|
1344
1321
|
* @readonly
|
|
1345
1322
|
*/
|
|
1346
1323
|
totalTax?: Price;
|
|
1347
1324
|
}
|
|
1348
|
-
|
|
1325
|
+
interface BalanceSummary {
|
|
1349
1326
|
/**
|
|
1350
1327
|
* Amount left to pay for order to be considered paid.
|
|
1351
1328
|
* @readonly
|
|
@@ -1364,7 +1341,7 @@ export interface BalanceSummary {
|
|
|
1364
1341
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
1365
1342
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
1366
1343
|
*/
|
|
1367
|
-
|
|
1344
|
+
interface Balance {
|
|
1368
1345
|
/**
|
|
1369
1346
|
* Balance amount.
|
|
1370
1347
|
*
|
|
@@ -1380,7 +1357,7 @@ export interface Balance {
|
|
|
1380
1357
|
formattedAmount?: string;
|
|
1381
1358
|
}
|
|
1382
1359
|
/** Side-effects upon committing a draft order. */
|
|
1383
|
-
|
|
1360
|
+
interface DraftOrderCommitSettings {
|
|
1384
1361
|
/**
|
|
1385
1362
|
* Whether to send notifications to the buyer.
|
|
1386
1363
|
*
|
|
@@ -1412,14 +1389,14 @@ export interface DraftOrderCommitSettings {
|
|
|
1412
1389
|
*/
|
|
1413
1390
|
updateInventory?: InventoryUpdate[];
|
|
1414
1391
|
}
|
|
1415
|
-
|
|
1392
|
+
interface InventoryUpdate {
|
|
1416
1393
|
/**
|
|
1417
1394
|
* Line item ID.
|
|
1418
1395
|
* @format GUID
|
|
1419
1396
|
*/
|
|
1420
1397
|
lineItemId?: string;
|
|
1421
1398
|
}
|
|
1422
|
-
|
|
1399
|
+
interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
|
|
1423
1400
|
/** Indicates that recipient information was added during draft. */
|
|
1424
1401
|
added?: boolean;
|
|
1425
1402
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1430,7 +1407,7 @@ export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneO
|
|
|
1430
1407
|
recipientInfo?: AddressWithContact;
|
|
1431
1408
|
}
|
|
1432
1409
|
/** @oneof */
|
|
1433
|
-
|
|
1410
|
+
interface RecipientInfoDetailsChangeTypeOneOf {
|
|
1434
1411
|
/** Indicates that recipient information was added during draft. */
|
|
1435
1412
|
added?: boolean;
|
|
1436
1413
|
/** Indicates that recipient information was changed. Contains recipient information before draft. */
|
|
@@ -1438,11 +1415,11 @@ export interface RecipientInfoDetailsChangeTypeOneOf {
|
|
|
1438
1415
|
/** Indicates that recipient information was removed during draft. */
|
|
1439
1416
|
removed?: boolean;
|
|
1440
1417
|
}
|
|
1441
|
-
|
|
1418
|
+
interface RecipientInfoChangedDetails {
|
|
1442
1419
|
/** Order recipient address and contact details before draft. */
|
|
1443
1420
|
recipientInfoBeforeChange?: AddressWithContact;
|
|
1444
1421
|
}
|
|
1445
|
-
|
|
1422
|
+
interface OrderTaxInfo {
|
|
1446
1423
|
/** Calculated tax, added from line items. */
|
|
1447
1424
|
totalTax?: Price;
|
|
1448
1425
|
/**
|
|
@@ -1462,7 +1439,7 @@ export interface OrderTaxInfo {
|
|
|
1462
1439
|
* 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.
|
|
1463
1440
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1464
1441
|
*/
|
|
1465
|
-
|
|
1442
|
+
interface OrderTaxBreakdown {
|
|
1466
1443
|
/**
|
|
1467
1444
|
* The name of the tax against which this tax amount was calculated.
|
|
1468
1445
|
* @maxLength 200
|
|
@@ -1489,21 +1466,21 @@ export interface OrderTaxBreakdown {
|
|
|
1489
1466
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1490
1467
|
aggregatedTaxAmount?: Price;
|
|
1491
1468
|
}
|
|
1492
|
-
|
|
1469
|
+
interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
1493
1470
|
}
|
|
1494
1471
|
/** @oneof */
|
|
1495
|
-
|
|
1472
|
+
interface BuyerDetailsChangeTypeOneOf {
|
|
1496
1473
|
}
|
|
1497
|
-
|
|
1474
|
+
interface BuyerChangedDetails {
|
|
1498
1475
|
}
|
|
1499
|
-
|
|
1476
|
+
interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
1500
1477
|
}
|
|
1501
1478
|
/** @oneof */
|
|
1502
|
-
|
|
1479
|
+
interface BillingDetailsChangeTypeOneOf {
|
|
1503
1480
|
}
|
|
1504
|
-
|
|
1481
|
+
interface BillingChangedDetails {
|
|
1505
1482
|
}
|
|
1506
|
-
|
|
1483
|
+
interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1507
1484
|
/** Indicates that business location was added during draft. */
|
|
1508
1485
|
added?: boolean;
|
|
1509
1486
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1514,7 +1491,7 @@ export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTy
|
|
|
1514
1491
|
businessLocation?: Location;
|
|
1515
1492
|
}
|
|
1516
1493
|
/** @oneof */
|
|
1517
|
-
|
|
1494
|
+
interface BusinessLocationDetailsChangeTypeOneOf {
|
|
1518
1495
|
/** Indicates that business location was added during draft. */
|
|
1519
1496
|
added?: boolean;
|
|
1520
1497
|
/** Indicates that business location was changed. Contains business location before draft. */
|
|
@@ -1522,13 +1499,13 @@ export interface BusinessLocationDetailsChangeTypeOneOf {
|
|
|
1522
1499
|
/** Indicates that business location was removed during draft. */
|
|
1523
1500
|
removed?: boolean;
|
|
1524
1501
|
}
|
|
1525
|
-
|
|
1502
|
+
interface Location {
|
|
1526
1503
|
/**
|
|
1527
1504
|
* Location ID.
|
|
1528
1505
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1529
1506
|
* @format GUID
|
|
1530
1507
|
*/
|
|
1531
|
-
|
|
1508
|
+
_id?: string;
|
|
1532
1509
|
/**
|
|
1533
1510
|
* Location name.
|
|
1534
1511
|
* @minLength 1
|
|
@@ -1537,22 +1514,22 @@ export interface Location {
|
|
|
1537
1514
|
*/
|
|
1538
1515
|
name?: string;
|
|
1539
1516
|
}
|
|
1540
|
-
|
|
1517
|
+
interface BusinessLocationChangedDetails {
|
|
1541
1518
|
/** Business location before draft. */
|
|
1542
1519
|
businessLocationBeforeChange?: Location;
|
|
1543
1520
|
}
|
|
1544
|
-
|
|
1521
|
+
interface CreateDraftOrderRequest {
|
|
1545
1522
|
/**
|
|
1546
1523
|
* To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
|
|
1547
1524
|
* @format GUID
|
|
1548
1525
|
*/
|
|
1549
1526
|
orderId: string | null;
|
|
1550
1527
|
}
|
|
1551
|
-
|
|
1528
|
+
interface CreateDraftOrderResponse {
|
|
1552
1529
|
/** The draft order details calculated with latest content */
|
|
1553
1530
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1554
1531
|
}
|
|
1555
|
-
|
|
1532
|
+
interface CalculatedDraftOrder {
|
|
1556
1533
|
/**
|
|
1557
1534
|
* The draft order full details with calculations based on it's content.
|
|
1558
1535
|
* Discount and additional fee options are also included.
|
|
@@ -1563,7 +1540,7 @@ export interface CalculatedDraftOrder {
|
|
|
1563
1540
|
/** Errors that occurred during calculation. */
|
|
1564
1541
|
calculationErrors?: CalculationErrors;
|
|
1565
1542
|
}
|
|
1566
|
-
|
|
1543
|
+
interface ShippingOption {
|
|
1567
1544
|
/**
|
|
1568
1545
|
* This carrier's unique ID
|
|
1569
1546
|
* @format GUID
|
|
@@ -1578,7 +1555,7 @@ export interface ShippingOption {
|
|
|
1578
1555
|
/** Shipping cost. */
|
|
1579
1556
|
cost?: ShippingPrice;
|
|
1580
1557
|
}
|
|
1581
|
-
|
|
1558
|
+
interface DeliveryLogistics {
|
|
1582
1559
|
/** When the item is expected to be delivered in free text, e.g "3-5 business days" */
|
|
1583
1560
|
deliveryTime?: string | null;
|
|
1584
1561
|
/** Instructions for caller, e.g for pickup: "Ensure to come during Opening Hours, and please don't park in disabled-spot" */
|
|
@@ -1588,7 +1565,7 @@ export interface DeliveryLogistics {
|
|
|
1588
1565
|
/** Expected delivery time slot (from and to time stamps representation) */
|
|
1589
1566
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1590
1567
|
}
|
|
1591
|
-
|
|
1568
|
+
interface PickupDetails {
|
|
1592
1569
|
/** Pickup address */
|
|
1593
1570
|
address?: Address;
|
|
1594
1571
|
/**
|
|
@@ -1600,18 +1577,18 @@ export interface PickupDetails {
|
|
|
1600
1577
|
*/
|
|
1601
1578
|
pickupMethod?: PickupMethod;
|
|
1602
1579
|
}
|
|
1603
|
-
|
|
1580
|
+
declare enum PickupMethod {
|
|
1604
1581
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1605
1582
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1606
1583
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1607
1584
|
}
|
|
1608
|
-
|
|
1585
|
+
interface DeliveryTimeSlot {
|
|
1609
1586
|
/** starting time of the delivery time slot */
|
|
1610
1587
|
from?: Date | null;
|
|
1611
1588
|
/** ending time of the delivery time slot */
|
|
1612
1589
|
to?: Date | null;
|
|
1613
1590
|
}
|
|
1614
|
-
|
|
1591
|
+
interface ShippingPrice {
|
|
1615
1592
|
/** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
|
|
1616
1593
|
price?: Price;
|
|
1617
1594
|
/**
|
|
@@ -1620,7 +1597,7 @@ export interface ShippingPrice {
|
|
|
1620
1597
|
*/
|
|
1621
1598
|
currency?: string;
|
|
1622
1599
|
}
|
|
1623
|
-
|
|
1600
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1624
1601
|
/** General shipping calculation error. */
|
|
1625
1602
|
generalShippingCalculationError?: Details;
|
|
1626
1603
|
/** Carrier errors. */
|
|
@@ -1631,13 +1608,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
1631
1608
|
orderValidationErrors?: ApplicationError[];
|
|
1632
1609
|
}
|
|
1633
1610
|
/** @oneof */
|
|
1634
|
-
|
|
1611
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1635
1612
|
/** General shipping calculation error. */
|
|
1636
1613
|
generalShippingCalculationError?: Details;
|
|
1637
1614
|
/** Carrier errors. */
|
|
1638
1615
|
carrierErrors?: CarrierErrors;
|
|
1639
1616
|
}
|
|
1640
|
-
|
|
1617
|
+
interface Details extends DetailsKindOneOf {
|
|
1641
1618
|
applicationError?: ApplicationError;
|
|
1642
1619
|
validationError?: ValidationError;
|
|
1643
1620
|
systemError?: SystemError;
|
|
@@ -1648,12 +1625,12 @@ export interface Details extends DetailsKindOneOf {
|
|
|
1648
1625
|
tracing?: Record<string, string>;
|
|
1649
1626
|
}
|
|
1650
1627
|
/** @oneof */
|
|
1651
|
-
|
|
1628
|
+
interface DetailsKindOneOf {
|
|
1652
1629
|
applicationError?: ApplicationError;
|
|
1653
1630
|
validationError?: ValidationError;
|
|
1654
1631
|
systemError?: SystemError;
|
|
1655
1632
|
}
|
|
1656
|
-
|
|
1633
|
+
interface ApplicationError {
|
|
1657
1634
|
/** Error code. */
|
|
1658
1635
|
code?: string;
|
|
1659
1636
|
/** Description of the error. */
|
|
@@ -1693,10 +1670,10 @@ export interface ApplicationError {
|
|
|
1693
1670
|
* ]
|
|
1694
1671
|
* }
|
|
1695
1672
|
*/
|
|
1696
|
-
|
|
1673
|
+
interface ValidationError {
|
|
1697
1674
|
fieldViolations?: FieldViolation[];
|
|
1698
1675
|
}
|
|
1699
|
-
|
|
1676
|
+
declare enum RuleType {
|
|
1700
1677
|
VALIDATION = "VALIDATION",
|
|
1701
1678
|
OTHER = "OTHER",
|
|
1702
1679
|
MAX = "MAX",
|
|
@@ -1719,7 +1696,7 @@ export declare enum RuleType {
|
|
|
1719
1696
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1720
1697
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1721
1698
|
}
|
|
1722
|
-
|
|
1699
|
+
interface FieldViolation {
|
|
1723
1700
|
field?: string;
|
|
1724
1701
|
description?: string;
|
|
1725
1702
|
violatedRule?: RuleType;
|
|
@@ -1727,27 +1704,27 @@ export interface FieldViolation {
|
|
|
1727
1704
|
ruleName?: string | null;
|
|
1728
1705
|
data?: Record<string, any> | null;
|
|
1729
1706
|
}
|
|
1730
|
-
|
|
1707
|
+
interface SystemError {
|
|
1731
1708
|
/** Error code. */
|
|
1732
1709
|
errorCode?: string | null;
|
|
1733
1710
|
}
|
|
1734
|
-
|
|
1711
|
+
interface CarrierErrors {
|
|
1735
1712
|
/** Carrier errors. */
|
|
1736
1713
|
errors?: CarrierError[];
|
|
1737
1714
|
}
|
|
1738
|
-
|
|
1715
|
+
interface CarrierError {
|
|
1739
1716
|
/** Carrier ID. */
|
|
1740
1717
|
carrierId?: string;
|
|
1741
1718
|
/** Error details. */
|
|
1742
1719
|
error?: Details;
|
|
1743
1720
|
}
|
|
1744
|
-
|
|
1721
|
+
interface CreateEmptyDraftOrderRequest {
|
|
1745
1722
|
}
|
|
1746
|
-
|
|
1723
|
+
interface CreateEmptyDraftOrderResponse {
|
|
1747
1724
|
/** The draft order details calculated with latest content */
|
|
1748
1725
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1749
1726
|
}
|
|
1750
|
-
|
|
1727
|
+
interface AddLineItemsToDraftOrderRequest {
|
|
1751
1728
|
/**
|
|
1752
1729
|
* The draft order id
|
|
1753
1730
|
* @format GUID
|
|
@@ -1764,7 +1741,7 @@ export interface AddLineItemsToDraftOrderRequest {
|
|
|
1764
1741
|
*/
|
|
1765
1742
|
customLineItems?: CustomLineItem[];
|
|
1766
1743
|
}
|
|
1767
|
-
|
|
1744
|
+
interface CatalogReferenceLineItem {
|
|
1768
1745
|
/** 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. */
|
|
1769
1746
|
catalogReference?: CatalogReference;
|
|
1770
1747
|
/**
|
|
@@ -1783,12 +1760,12 @@ export interface CatalogReferenceLineItem {
|
|
|
1783
1760
|
*/
|
|
1784
1761
|
locations?: LocationAndQuantity[];
|
|
1785
1762
|
}
|
|
1786
|
-
|
|
1763
|
+
interface CustomLineItem {
|
|
1787
1764
|
/**
|
|
1788
1765
|
* Line item ID.
|
|
1789
1766
|
* @format GUID
|
|
1790
1767
|
*/
|
|
1791
|
-
|
|
1768
|
+
_id?: string | null;
|
|
1792
1769
|
/**
|
|
1793
1770
|
* Item quantity.
|
|
1794
1771
|
*
|
|
@@ -1808,7 +1785,7 @@ export interface CustomLineItem {
|
|
|
1808
1785
|
*/
|
|
1809
1786
|
productName?: ProductName;
|
|
1810
1787
|
/** URL to the item's page on the site. */
|
|
1811
|
-
url?:
|
|
1788
|
+
url?: string;
|
|
1812
1789
|
/** Item price **after** catalog-defined discount and line item discounts. */
|
|
1813
1790
|
price?: Price;
|
|
1814
1791
|
/** Total line item price **after** catalog-defined discount and line item discounts. */
|
|
@@ -1820,7 +1797,7 @@ export interface CustomLineItem {
|
|
|
1820
1797
|
/** Line item description lines. Used for display purposes for order. */
|
|
1821
1798
|
descriptionLines?: DescriptionLine[];
|
|
1822
1799
|
/** Line item image details. */
|
|
1823
|
-
media?:
|
|
1800
|
+
media?: string;
|
|
1824
1801
|
/** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
|
|
1825
1802
|
physicalProperties?: PhysicalProperties;
|
|
1826
1803
|
/** Item type. Either a preset type or custom. */
|
|
@@ -1840,19 +1817,13 @@ export interface CustomLineItem {
|
|
|
1840
1817
|
*/
|
|
1841
1818
|
locations?: LocationAndQuantity[];
|
|
1842
1819
|
}
|
|
1843
|
-
|
|
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 {
|
|
1820
|
+
interface SecuredMedia {
|
|
1850
1821
|
/**
|
|
1851
1822
|
* Media ID in Wix Media Manager.
|
|
1852
1823
|
* @minLength 1
|
|
1853
1824
|
* @maxLength 100
|
|
1854
1825
|
*/
|
|
1855
|
-
|
|
1826
|
+
_id?: string;
|
|
1856
1827
|
/**
|
|
1857
1828
|
* Original filename.
|
|
1858
1829
|
* @minLength 1
|
|
@@ -1862,7 +1833,7 @@ export interface SecuredMedia {
|
|
|
1862
1833
|
/** File type. */
|
|
1863
1834
|
fileType?: FileType;
|
|
1864
1835
|
}
|
|
1865
|
-
|
|
1836
|
+
declare enum FileType {
|
|
1866
1837
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1867
1838
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
1868
1839
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -1870,11 +1841,11 @@ export declare enum FileType {
|
|
|
1870
1841
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
1871
1842
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
1872
1843
|
}
|
|
1873
|
-
|
|
1844
|
+
interface AddLineItemsToDraftOrderResponse {
|
|
1874
1845
|
/** The draft order details calculated with latest content */
|
|
1875
1846
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1876
1847
|
}
|
|
1877
|
-
|
|
1848
|
+
interface UpdateLineItemsRequest {
|
|
1878
1849
|
/**
|
|
1879
1850
|
* The draft order id
|
|
1880
1851
|
* @format GUID
|
|
@@ -1887,7 +1858,7 @@ export interface UpdateLineItemsRequest {
|
|
|
1887
1858
|
*/
|
|
1888
1859
|
lineItemChanges?: LineItemChangeDetails[];
|
|
1889
1860
|
}
|
|
1890
|
-
|
|
1861
|
+
interface LineItemChangeDetails {
|
|
1891
1862
|
/**
|
|
1892
1863
|
* The line item id to change
|
|
1893
1864
|
* @format GUID
|
|
@@ -1906,11 +1877,11 @@ export interface LineItemChangeDetails {
|
|
|
1906
1877
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1907
1878
|
newPriceDescription?: PriceDescription;
|
|
1908
1879
|
}
|
|
1909
|
-
|
|
1880
|
+
interface UpdateLineItemsResponse {
|
|
1910
1881
|
/** The draft order details calculated with latest content */
|
|
1911
1882
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1912
1883
|
}
|
|
1913
|
-
|
|
1884
|
+
interface SetDiscountsRequest {
|
|
1914
1885
|
/**
|
|
1915
1886
|
* The draft order id
|
|
1916
1887
|
* @format GUID
|
|
@@ -1922,17 +1893,17 @@ export interface SetDiscountsRequest {
|
|
|
1922
1893
|
*/
|
|
1923
1894
|
discounts: IdAndApplied[];
|
|
1924
1895
|
}
|
|
1925
|
-
|
|
1896
|
+
interface IdAndApplied {
|
|
1926
1897
|
/** Discount ID. */
|
|
1927
|
-
|
|
1898
|
+
_id?: string;
|
|
1928
1899
|
/** Whether to apply the discount to the draft order. */
|
|
1929
1900
|
applied?: boolean;
|
|
1930
1901
|
}
|
|
1931
|
-
|
|
1902
|
+
interface SetDiscountsResponse {
|
|
1932
1903
|
/** The draft order details calculated with latest content */
|
|
1933
1904
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1934
1905
|
}
|
|
1935
|
-
|
|
1906
|
+
interface CreateCustomDiscountsRequest {
|
|
1936
1907
|
/**
|
|
1937
1908
|
* The draft order id
|
|
1938
1909
|
* @format GUID
|
|
@@ -1945,7 +1916,7 @@ export interface CreateCustomDiscountsRequest {
|
|
|
1945
1916
|
*/
|
|
1946
1917
|
discounts?: DiscountOption[];
|
|
1947
1918
|
}
|
|
1948
|
-
|
|
1919
|
+
interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
1949
1920
|
/**
|
|
1950
1921
|
* Discount type.
|
|
1951
1922
|
* * `"GLOBAL"` - discount applies to entire order.
|
|
@@ -1980,19 +1951,19 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1980
1951
|
applyToDraftOrder?: boolean | null;
|
|
1981
1952
|
}
|
|
1982
1953
|
/** @oneof */
|
|
1983
|
-
|
|
1954
|
+
interface DiscountOptionDiscountAmountOneOf {
|
|
1984
1955
|
}
|
|
1985
|
-
|
|
1956
|
+
declare enum DiscountType {
|
|
1986
1957
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
1987
1958
|
GLOBAL = "GLOBAL",
|
|
1988
1959
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1989
1960
|
SHIPPING = "SHIPPING"
|
|
1990
1961
|
}
|
|
1991
|
-
|
|
1962
|
+
interface CreateCustomDiscountsResponse {
|
|
1992
1963
|
/** The draft order details with the added discounts */
|
|
1993
1964
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1994
1965
|
}
|
|
1995
|
-
|
|
1966
|
+
interface DeleteCustomDiscountsRequest {
|
|
1996
1967
|
/**
|
|
1997
1968
|
* The draft order id
|
|
1998
1969
|
* @format GUID
|
|
@@ -2006,11 +1977,11 @@ export interface DeleteCustomDiscountsRequest {
|
|
|
2006
1977
|
*/
|
|
2007
1978
|
discountIds: string[];
|
|
2008
1979
|
}
|
|
2009
|
-
|
|
1980
|
+
interface DeleteCustomDiscountsResponse {
|
|
2010
1981
|
/** The draft order details calculated with latest content */
|
|
2011
1982
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2012
1983
|
}
|
|
2013
|
-
|
|
1984
|
+
interface SetAdditionalFeesRequest {
|
|
2014
1985
|
/**
|
|
2015
1986
|
* The draft order id
|
|
2016
1987
|
* @format GUID
|
|
@@ -2023,11 +1994,11 @@ export interface SetAdditionalFeesRequest {
|
|
|
2023
1994
|
*/
|
|
2024
1995
|
additionalFees: IdAndApplied[];
|
|
2025
1996
|
}
|
|
2026
|
-
|
|
1997
|
+
interface SetAdditionalFeesResponse {
|
|
2027
1998
|
/** The draft order details calculated with modified additional fees */
|
|
2028
1999
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2029
2000
|
}
|
|
2030
|
-
|
|
2001
|
+
interface CreateCustomAdditionalFeesRequest {
|
|
2031
2002
|
/**
|
|
2032
2003
|
* The draft order id
|
|
2033
2004
|
* @format GUID
|
|
@@ -2040,7 +2011,7 @@ export interface CreateCustomAdditionalFeesRequest {
|
|
|
2040
2011
|
*/
|
|
2041
2012
|
customAdditionalFees?: AdditionalFeeOption[];
|
|
2042
2013
|
}
|
|
2043
|
-
|
|
2014
|
+
interface AdditionalFeeOption {
|
|
2044
2015
|
/**
|
|
2045
2016
|
* Translated additional fee's name
|
|
2046
2017
|
* @minLength 1
|
|
@@ -2063,11 +2034,11 @@ export interface AdditionalFeeOption {
|
|
|
2063
2034
|
*/
|
|
2064
2035
|
code?: string | null;
|
|
2065
2036
|
}
|
|
2066
|
-
|
|
2037
|
+
interface CreateCustomAdditionalFeesResponse {
|
|
2067
2038
|
/** The draft order details with added custom additional fees */
|
|
2068
2039
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2069
2040
|
}
|
|
2070
|
-
|
|
2041
|
+
interface DeleteCustomAdditionalFeesRequest {
|
|
2071
2042
|
/**
|
|
2072
2043
|
* The draft order id
|
|
2073
2044
|
* @format GUID
|
|
@@ -2081,27 +2052,27 @@ export interface DeleteCustomAdditionalFeesRequest {
|
|
|
2081
2052
|
*/
|
|
2082
2053
|
customAdditionalFees: string[];
|
|
2083
2054
|
}
|
|
2084
|
-
|
|
2055
|
+
interface DeleteCustomAdditionalFeesResponse {
|
|
2085
2056
|
/** The draft order details calculated with latest content */
|
|
2086
2057
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2087
2058
|
}
|
|
2088
|
-
|
|
2059
|
+
interface SetShippingInfoRequest {
|
|
2089
2060
|
}
|
|
2090
|
-
|
|
2061
|
+
interface SetShippingInfoResponse {
|
|
2091
2062
|
}
|
|
2092
|
-
|
|
2063
|
+
interface SetBuyerInfoRequest {
|
|
2093
2064
|
}
|
|
2094
|
-
|
|
2065
|
+
interface SetBuyerInfoResponse {
|
|
2095
2066
|
}
|
|
2096
|
-
|
|
2067
|
+
interface SetRecipientInfoRequest {
|
|
2097
2068
|
}
|
|
2098
|
-
|
|
2069
|
+
interface SetRecipientInfoResponse {
|
|
2099
2070
|
}
|
|
2100
|
-
|
|
2071
|
+
interface SetBillingInfoRequest {
|
|
2101
2072
|
}
|
|
2102
|
-
|
|
2073
|
+
interface SetBillingInfoResponse {
|
|
2103
2074
|
}
|
|
2104
|
-
|
|
2075
|
+
interface UpdateShippingInfoRequest {
|
|
2105
2076
|
/**
|
|
2106
2077
|
* The draft order id
|
|
2107
2078
|
* @format GUID
|
|
@@ -2110,22 +2081,22 @@ export interface UpdateShippingInfoRequest {
|
|
|
2110
2081
|
/** update the shipping option on the order. if not set then the selected shipping is removed */
|
|
2111
2082
|
shippingOption?: ShippingOption;
|
|
2112
2083
|
}
|
|
2113
|
-
|
|
2084
|
+
interface UpdateShippingInfoResponse {
|
|
2114
2085
|
/** The draft order details calculated with de/selected shipping info */
|
|
2115
2086
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2116
2087
|
}
|
|
2117
|
-
|
|
2088
|
+
interface GetDraftOrderRequest {
|
|
2118
2089
|
/**
|
|
2119
2090
|
* The draft order id
|
|
2120
2091
|
* @format GUID
|
|
2121
2092
|
*/
|
|
2122
2093
|
draftOrderId: string;
|
|
2123
2094
|
}
|
|
2124
|
-
|
|
2095
|
+
interface GetDraftOrderResponse {
|
|
2125
2096
|
/** The draft order details calculated with latest content */
|
|
2126
2097
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2127
2098
|
}
|
|
2128
|
-
|
|
2099
|
+
interface GetOrderDraftabilityStatusRequest {
|
|
2129
2100
|
/**
|
|
2130
2101
|
* Order ID.
|
|
2131
2102
|
* @minLength 1
|
|
@@ -2133,7 +2104,7 @@ export interface GetOrderDraftabilityStatusRequest {
|
|
|
2133
2104
|
*/
|
|
2134
2105
|
orderId: string;
|
|
2135
2106
|
}
|
|
2136
|
-
|
|
2107
|
+
interface GetOrderDraftabilityStatusResponse {
|
|
2137
2108
|
/**
|
|
2138
2109
|
* Order ID.
|
|
2139
2110
|
* @minLength 1
|
|
@@ -2148,7 +2119,7 @@ export interface GetOrderDraftabilityStatusResponse {
|
|
|
2148
2119
|
*/
|
|
2149
2120
|
nonDraftableReasons?: NonDraftableReason[];
|
|
2150
2121
|
}
|
|
2151
|
-
|
|
2122
|
+
declare enum NonDraftableReason {
|
|
2152
2123
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2153
2124
|
PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
|
|
2154
2125
|
UNSUPPORTED_CHANNEL_TYPE = "UNSUPPORTED_CHANNEL_TYPE",
|
|
@@ -2162,7 +2133,7 @@ export declare enum NonDraftableReason {
|
|
|
2162
2133
|
UNSUPPORTED_CATALOG_ITEM = "UNSUPPORTED_CATALOG_ITEM",
|
|
2163
2134
|
TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
|
|
2164
2135
|
}
|
|
2165
|
-
|
|
2136
|
+
interface CommitDraftOrderRequest {
|
|
2166
2137
|
/**
|
|
2167
2138
|
* The draft order id
|
|
2168
2139
|
* @format GUID
|
|
@@ -2176,19 +2147,19 @@ export interface CommitDraftOrderRequest {
|
|
|
2176
2147
|
*/
|
|
2177
2148
|
reason?: string | null;
|
|
2178
2149
|
}
|
|
2179
|
-
|
|
2150
|
+
interface CommitDraftOrderResponse {
|
|
2180
2151
|
/** The draft order after commit. */
|
|
2181
2152
|
committedDraftOrder?: DraftOrder;
|
|
2182
2153
|
/** The updated order after commit. */
|
|
2183
2154
|
orderAfterCommit?: Order;
|
|
2184
2155
|
}
|
|
2185
|
-
|
|
2156
|
+
interface Order {
|
|
2186
2157
|
/**
|
|
2187
2158
|
* Order ID.
|
|
2188
2159
|
* @format GUID
|
|
2189
2160
|
* @readonly
|
|
2190
2161
|
*/
|
|
2191
|
-
|
|
2162
|
+
_id?: string | null;
|
|
2192
2163
|
/**
|
|
2193
2164
|
* Order number displayed in the site owner's dashboard (auto-generated).
|
|
2194
2165
|
* @readonly
|
|
@@ -2199,12 +2170,12 @@ export interface Order {
|
|
|
2199
2170
|
* @readonly
|
|
2200
2171
|
* @immutable
|
|
2201
2172
|
*/
|
|
2202
|
-
|
|
2173
|
+
_createdDate?: Date | null;
|
|
2203
2174
|
/**
|
|
2204
2175
|
* Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2205
2176
|
* @readonly
|
|
2206
2177
|
*/
|
|
2207
|
-
|
|
2178
|
+
_updatedDate?: Date | null;
|
|
2208
2179
|
/**
|
|
2209
2180
|
* Order line items.
|
|
2210
2181
|
* @minSize 1
|
|
@@ -2350,7 +2321,7 @@ export interface Order {
|
|
|
2350
2321
|
/** Order Location */
|
|
2351
2322
|
businessLocation?: Location;
|
|
2352
2323
|
}
|
|
2353
|
-
|
|
2324
|
+
declare enum PaymentStatus {
|
|
2354
2325
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2355
2326
|
/**
|
|
2356
2327
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -2391,7 +2362,7 @@ export declare enum PaymentStatus {
|
|
|
2391
2362
|
*/
|
|
2392
2363
|
DECLINED = "DECLINED"
|
|
2393
2364
|
}
|
|
2394
|
-
|
|
2365
|
+
declare enum FulfillmentStatus {
|
|
2395
2366
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
2396
2367
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
2397
2368
|
/**
|
|
@@ -2402,7 +2373,7 @@ export declare enum FulfillmentStatus {
|
|
|
2402
2373
|
/** Some, but not all, of the order items are fulfilled. */
|
|
2403
2374
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
2404
2375
|
}
|
|
2405
|
-
|
|
2376
|
+
interface CurrencyConversionDetails {
|
|
2406
2377
|
/**
|
|
2407
2378
|
* 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.
|
|
2408
2379
|
* @readonly
|
|
@@ -2418,7 +2389,7 @@ export interface CurrencyConversionDetails {
|
|
|
2418
2389
|
*/
|
|
2419
2390
|
conversionRate?: string | null;
|
|
2420
2391
|
}
|
|
2421
|
-
|
|
2392
|
+
declare enum OrderStatus {
|
|
2422
2393
|
/** Order created, but not yet approved or canceled. */
|
|
2423
2394
|
INITIALIZED = "INITIALIZED",
|
|
2424
2395
|
/**
|
|
@@ -2443,7 +2414,7 @@ export declare enum OrderStatus {
|
|
|
2443
2414
|
*/
|
|
2444
2415
|
REJECTED = "REJECTED"
|
|
2445
2416
|
}
|
|
2446
|
-
|
|
2417
|
+
interface Activity extends ActivityContentOneOf {
|
|
2447
2418
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2448
2419
|
customActivity?: CustomActivity;
|
|
2449
2420
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -2455,7 +2426,7 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2455
2426
|
* @format GUID
|
|
2456
2427
|
* @readonly
|
|
2457
2428
|
*/
|
|
2458
|
-
|
|
2429
|
+
_id?: string | null;
|
|
2459
2430
|
/**
|
|
2460
2431
|
* Activity author's email.
|
|
2461
2432
|
* @format EMAIL
|
|
@@ -2466,12 +2437,12 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2466
2437
|
* Activity creation date and time.
|
|
2467
2438
|
* @readonly
|
|
2468
2439
|
*/
|
|
2469
|
-
|
|
2440
|
+
_createdDate?: Date | null;
|
|
2470
2441
|
/** Activity type. */
|
|
2471
2442
|
type?: ActivityType;
|
|
2472
2443
|
}
|
|
2473
2444
|
/** @oneof */
|
|
2474
|
-
|
|
2445
|
+
interface ActivityContentOneOf {
|
|
2475
2446
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2476
2447
|
customActivity?: CustomActivity;
|
|
2477
2448
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -2479,7 +2450,7 @@ export interface ActivityContentOneOf {
|
|
|
2479
2450
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
2480
2451
|
orderRefunded?: OrderRefunded;
|
|
2481
2452
|
}
|
|
2482
|
-
|
|
2453
|
+
interface CustomActivity {
|
|
2483
2454
|
/**
|
|
2484
2455
|
* ID of the app that created the custom activity.
|
|
2485
2456
|
* @format GUID
|
|
@@ -2494,7 +2465,7 @@ export interface CustomActivity {
|
|
|
2494
2465
|
additionalData?: Record<string, string>;
|
|
2495
2466
|
}
|
|
2496
2467
|
/** Store owner added a comment */
|
|
2497
|
-
|
|
2468
|
+
interface MerchantComment {
|
|
2498
2469
|
/**
|
|
2499
2470
|
* Merchant comment message.
|
|
2500
2471
|
* @minLength 1
|
|
@@ -2502,7 +2473,7 @@ export interface MerchantComment {
|
|
|
2502
2473
|
*/
|
|
2503
2474
|
message?: string;
|
|
2504
2475
|
}
|
|
2505
|
-
|
|
2476
|
+
interface OrderRefunded {
|
|
2506
2477
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
2507
2478
|
manual?: boolean;
|
|
2508
2479
|
/** Refund amount. */
|
|
@@ -2513,14 +2484,14 @@ export interface OrderRefunded {
|
|
|
2513
2484
|
*/
|
|
2514
2485
|
reason?: string;
|
|
2515
2486
|
}
|
|
2516
|
-
|
|
2487
|
+
interface OrderCreatedFromExchange {
|
|
2517
2488
|
/**
|
|
2518
2489
|
* ID of the original order for which the exchange happened.
|
|
2519
2490
|
* @format GUID
|
|
2520
2491
|
*/
|
|
2521
2492
|
originalOrderId?: string;
|
|
2522
2493
|
}
|
|
2523
|
-
|
|
2494
|
+
interface NewExchangeOrderCreated {
|
|
2524
2495
|
/**
|
|
2525
2496
|
* ID of the new order created as a result of an exchange of items.
|
|
2526
2497
|
* @format GUID
|
|
@@ -2533,7 +2504,7 @@ export interface NewExchangeOrderCreated {
|
|
|
2533
2504
|
*/
|
|
2534
2505
|
lineItems?: LineItemExchangeData[];
|
|
2535
2506
|
}
|
|
2536
|
-
|
|
2507
|
+
interface LineItemExchangeData {
|
|
2537
2508
|
/**
|
|
2538
2509
|
* ID of the exchanged line item.
|
|
2539
2510
|
* @format GUID
|
|
@@ -2546,7 +2517,7 @@ export interface LineItemExchangeData {
|
|
|
2546
2517
|
*/
|
|
2547
2518
|
quantity?: number;
|
|
2548
2519
|
}
|
|
2549
|
-
|
|
2520
|
+
interface DraftOrderChangesApplied {
|
|
2550
2521
|
/** Draft order id. */
|
|
2551
2522
|
draftOrderId?: string;
|
|
2552
2523
|
/**
|
|
@@ -2557,7 +2528,7 @@ export interface DraftOrderChangesApplied {
|
|
|
2557
2528
|
/** Changes applied to order. */
|
|
2558
2529
|
changes?: OrderChange[];
|
|
2559
2530
|
}
|
|
2560
|
-
|
|
2531
|
+
interface OrderChange extends OrderChangeValueOneOf {
|
|
2561
2532
|
lineItemChanged?: LineItemChanges;
|
|
2562
2533
|
lineItemAdded?: ManagedLineItem;
|
|
2563
2534
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2569,7 +2540,7 @@ export interface OrderChange extends OrderChangeValueOneOf {
|
|
|
2569
2540
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2570
2541
|
}
|
|
2571
2542
|
/** @oneof */
|
|
2572
|
-
|
|
2543
|
+
interface OrderChangeValueOneOf {
|
|
2573
2544
|
lineItemChanged?: LineItemChanges;
|
|
2574
2545
|
lineItemAdded?: ManagedLineItem;
|
|
2575
2546
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -2580,12 +2551,12 @@ export interface OrderChangeValueOneOf {
|
|
|
2580
2551
|
totalPriceChanged?: TotalPriceChange;
|
|
2581
2552
|
shippingInformationChanged?: ShippingInformationChange;
|
|
2582
2553
|
}
|
|
2583
|
-
|
|
2554
|
+
interface LineItemChanges {
|
|
2584
2555
|
/**
|
|
2585
2556
|
* Line item ID.
|
|
2586
2557
|
* @format GUID
|
|
2587
2558
|
*/
|
|
2588
|
-
|
|
2559
|
+
_id?: string;
|
|
2589
2560
|
/** Item name. */
|
|
2590
2561
|
name?: ProductName;
|
|
2591
2562
|
/** Item quantity change. */
|
|
@@ -2593,7 +2564,7 @@ export interface LineItemChanges {
|
|
|
2593
2564
|
/** Item price change. */
|
|
2594
2565
|
price?: LineItemPriceChange;
|
|
2595
2566
|
}
|
|
2596
|
-
|
|
2567
|
+
interface LineItemQuantityChange {
|
|
2597
2568
|
/**
|
|
2598
2569
|
* Item quantity before update.
|
|
2599
2570
|
* @max 1000000
|
|
@@ -2613,24 +2584,24 @@ export interface LineItemQuantityChange {
|
|
|
2613
2584
|
/** Type of quantity change: increase or decrease. */
|
|
2614
2585
|
deltaType?: LineItemQuantityChangeType;
|
|
2615
2586
|
}
|
|
2616
|
-
|
|
2587
|
+
declare enum LineItemQuantityChangeType {
|
|
2617
2588
|
/** Quantity increased. */
|
|
2618
2589
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
2619
2590
|
/** Quantity decreased. */
|
|
2620
2591
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
2621
2592
|
}
|
|
2622
|
-
|
|
2593
|
+
interface LineItemPriceChange {
|
|
2623
2594
|
/** Item price before update. */
|
|
2624
2595
|
originalPrice?: Price;
|
|
2625
2596
|
/** Item price after update. */
|
|
2626
2597
|
newPrice?: Price;
|
|
2627
2598
|
}
|
|
2628
|
-
|
|
2599
|
+
interface ManagedLineItem {
|
|
2629
2600
|
/**
|
|
2630
2601
|
* Line item ID.
|
|
2631
2602
|
* @format GUID
|
|
2632
2603
|
*/
|
|
2633
|
-
|
|
2604
|
+
_id?: string;
|
|
2634
2605
|
/** Item name. */
|
|
2635
2606
|
name?: ProductName;
|
|
2636
2607
|
/**
|
|
@@ -2640,12 +2611,12 @@ export interface ManagedLineItem {
|
|
|
2640
2611
|
*/
|
|
2641
2612
|
quantity?: number;
|
|
2642
2613
|
}
|
|
2643
|
-
|
|
2614
|
+
interface ManagedDiscount {
|
|
2644
2615
|
/**
|
|
2645
2616
|
* Discount id.
|
|
2646
2617
|
* @format GUID
|
|
2647
2618
|
*/
|
|
2648
|
-
|
|
2619
|
+
_id?: string;
|
|
2649
2620
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
2650
2621
|
name?: TranslatedValue;
|
|
2651
2622
|
/** Line items discount applies to. */
|
|
@@ -2653,7 +2624,7 @@ export interface ManagedDiscount {
|
|
|
2653
2624
|
/** Discount amount. */
|
|
2654
2625
|
totalAmount?: Price;
|
|
2655
2626
|
}
|
|
2656
|
-
|
|
2627
|
+
interface TranslatedValue {
|
|
2657
2628
|
/**
|
|
2658
2629
|
* Value in site default language.
|
|
2659
2630
|
* @minLength 1
|
|
@@ -2665,23 +2636,23 @@ export interface TranslatedValue {
|
|
|
2665
2636
|
*/
|
|
2666
2637
|
translated?: string | null;
|
|
2667
2638
|
}
|
|
2668
|
-
|
|
2639
|
+
interface LineItemAmount {
|
|
2669
2640
|
/**
|
|
2670
2641
|
* Order line item id
|
|
2671
2642
|
* @format GUID
|
|
2672
2643
|
*/
|
|
2673
|
-
|
|
2644
|
+
_id?: string;
|
|
2674
2645
|
/** Item name. */
|
|
2675
2646
|
name?: ProductName;
|
|
2676
2647
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
2677
2648
|
amount?: Price;
|
|
2678
2649
|
}
|
|
2679
|
-
|
|
2650
|
+
interface ManagedAdditionalFee {
|
|
2680
2651
|
/**
|
|
2681
2652
|
* Additional fee id.
|
|
2682
2653
|
* @format GUID
|
|
2683
2654
|
*/
|
|
2684
|
-
|
|
2655
|
+
_id?: string;
|
|
2685
2656
|
/** Additional fee name. */
|
|
2686
2657
|
name?: TranslatedValue;
|
|
2687
2658
|
/** Line items additional fee applies to. */
|
|
@@ -2689,19 +2660,19 @@ export interface ManagedAdditionalFee {
|
|
|
2689
2660
|
/** Additional fee amount. */
|
|
2690
2661
|
totalAmount?: Price;
|
|
2691
2662
|
}
|
|
2692
|
-
|
|
2663
|
+
interface TotalPriceChange {
|
|
2693
2664
|
/** Order’s total price after discounts and tax. Before update */
|
|
2694
2665
|
originalTotal?: Price;
|
|
2695
2666
|
/** Order’s total price after discounts and tax. After update */
|
|
2696
2667
|
newTotal?: Price;
|
|
2697
2668
|
}
|
|
2698
|
-
|
|
2669
|
+
interface ShippingInformationChange {
|
|
2699
2670
|
/** Order’s Shipping Information. Before update */
|
|
2700
2671
|
originalShippingInfo?: ShippingInformation;
|
|
2701
2672
|
/** Order’s Shipping Information. After update */
|
|
2702
2673
|
newShippingInfo?: ShippingInformation;
|
|
2703
2674
|
}
|
|
2704
|
-
|
|
2675
|
+
interface ShippingInformation {
|
|
2705
2676
|
/** Order’s shipping price. */
|
|
2706
2677
|
total?: Price;
|
|
2707
2678
|
/**
|
|
@@ -2711,7 +2682,7 @@ export interface ShippingInformation {
|
|
|
2711
2682
|
shippingTitle?: string;
|
|
2712
2683
|
}
|
|
2713
2684
|
/** Payment method is saved for order */
|
|
2714
|
-
|
|
2685
|
+
interface SavedPaymentMethod {
|
|
2715
2686
|
/**
|
|
2716
2687
|
* Payment method name
|
|
2717
2688
|
* @minLength 1
|
|
@@ -2725,7 +2696,7 @@ export interface SavedPaymentMethod {
|
|
|
2725
2696
|
*/
|
|
2726
2697
|
description?: string | null;
|
|
2727
2698
|
}
|
|
2728
|
-
|
|
2699
|
+
interface AuthorizedPaymentCreated {
|
|
2729
2700
|
/**
|
|
2730
2701
|
* Payment ID of payment associated with this activity
|
|
2731
2702
|
* @format GUID
|
|
@@ -2744,7 +2715,7 @@ export interface AuthorizedPaymentCreated {
|
|
|
2744
2715
|
*/
|
|
2745
2716
|
brand?: string | null;
|
|
2746
2717
|
}
|
|
2747
|
-
|
|
2718
|
+
interface AuthorizedPaymentCaptured {
|
|
2748
2719
|
/**
|
|
2749
2720
|
* Payment ID of payment associated with this activity
|
|
2750
2721
|
* @format GUID
|
|
@@ -2763,7 +2734,7 @@ export interface AuthorizedPaymentCaptured {
|
|
|
2763
2734
|
*/
|
|
2764
2735
|
brand?: string | null;
|
|
2765
2736
|
}
|
|
2766
|
-
|
|
2737
|
+
interface AuthorizedPaymentVoided {
|
|
2767
2738
|
/**
|
|
2768
2739
|
* Payment ID of payment associated with this activity
|
|
2769
2740
|
* @format GUID
|
|
@@ -2782,7 +2753,7 @@ export interface AuthorizedPaymentVoided {
|
|
|
2782
2753
|
*/
|
|
2783
2754
|
brand?: string | null;
|
|
2784
2755
|
}
|
|
2785
|
-
|
|
2756
|
+
interface RefundInitiated {
|
|
2786
2757
|
/**
|
|
2787
2758
|
* Refund ID.
|
|
2788
2759
|
* @format GUID
|
|
@@ -2802,7 +2773,7 @@ export interface RefundInitiated {
|
|
|
2802
2773
|
*/
|
|
2803
2774
|
reason?: string | null;
|
|
2804
2775
|
}
|
|
2805
|
-
|
|
2776
|
+
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
2806
2777
|
/** Regular payment refund. */
|
|
2807
2778
|
regular?: RegularPaymentRefund;
|
|
2808
2779
|
/** Gift card payment refund. */
|
|
@@ -2818,7 +2789,7 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
2818
2789
|
externalRefund?: boolean;
|
|
2819
2790
|
}
|
|
2820
2791
|
/** @oneof */
|
|
2821
|
-
|
|
2792
|
+
interface RefundedPaymentKindOneOf {
|
|
2822
2793
|
/** Regular payment refund. */
|
|
2823
2794
|
regular?: RegularPaymentRefund;
|
|
2824
2795
|
/** Gift card payment refund. */
|
|
@@ -2826,7 +2797,7 @@ export interface RefundedPaymentKindOneOf {
|
|
|
2826
2797
|
/** Membership payment refund. */
|
|
2827
2798
|
membership?: MembershipPaymentRefund;
|
|
2828
2799
|
}
|
|
2829
|
-
|
|
2800
|
+
interface RegularPaymentRefund {
|
|
2830
2801
|
/** Refund amount */
|
|
2831
2802
|
amount?: Price;
|
|
2832
2803
|
/**
|
|
@@ -2840,7 +2811,7 @@ export interface RegularPaymentRefund {
|
|
|
2840
2811
|
*/
|
|
2841
2812
|
brand?: string | null;
|
|
2842
2813
|
}
|
|
2843
|
-
|
|
2814
|
+
interface GiftCardPaymentRefund {
|
|
2844
2815
|
/**
|
|
2845
2816
|
* Gift card payment ID
|
|
2846
2817
|
* @minLength 1
|
|
@@ -2850,7 +2821,7 @@ export interface GiftCardPaymentRefund {
|
|
|
2850
2821
|
/** Refund amount */
|
|
2851
2822
|
amount?: Price;
|
|
2852
2823
|
}
|
|
2853
|
-
|
|
2824
|
+
interface MembershipPaymentRefund {
|
|
2854
2825
|
/**
|
|
2855
2826
|
* Membership ID
|
|
2856
2827
|
* @minLength 1
|
|
@@ -2858,7 +2829,7 @@ export interface MembershipPaymentRefund {
|
|
|
2858
2829
|
*/
|
|
2859
2830
|
membershipId?: string | null;
|
|
2860
2831
|
}
|
|
2861
|
-
|
|
2832
|
+
interface PaymentRefunded {
|
|
2862
2833
|
/**
|
|
2863
2834
|
* Refund ID.
|
|
2864
2835
|
* @format GUID
|
|
@@ -2867,7 +2838,7 @@ export interface PaymentRefunded {
|
|
|
2867
2838
|
/** Details about the refunded payment. */
|
|
2868
2839
|
payment?: RefundedPayment;
|
|
2869
2840
|
}
|
|
2870
|
-
|
|
2841
|
+
interface PaymentRefundFailed {
|
|
2871
2842
|
/**
|
|
2872
2843
|
* Refund ID.
|
|
2873
2844
|
* @format GUID
|
|
@@ -2876,7 +2847,7 @@ export interface PaymentRefundFailed {
|
|
|
2876
2847
|
/** Details about the failed payment refund. */
|
|
2877
2848
|
payment?: RefundedPayment;
|
|
2878
2849
|
}
|
|
2879
|
-
|
|
2850
|
+
interface RefundedAsStoreCredit {
|
|
2880
2851
|
/** Refund amount */
|
|
2881
2852
|
amount?: Price;
|
|
2882
2853
|
/**
|
|
@@ -2885,7 +2856,7 @@ export interface RefundedAsStoreCredit {
|
|
|
2885
2856
|
*/
|
|
2886
2857
|
reason?: string | null;
|
|
2887
2858
|
}
|
|
2888
|
-
|
|
2859
|
+
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
2889
2860
|
/** Regular payment. */
|
|
2890
2861
|
regular?: RegularPayment;
|
|
2891
2862
|
/**
|
|
@@ -2895,22 +2866,22 @@ export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
2895
2866
|
paymentId?: string;
|
|
2896
2867
|
}
|
|
2897
2868
|
/** @oneof */
|
|
2898
|
-
|
|
2869
|
+
interface PaymentPendingPaymentDetailsOneOf {
|
|
2899
2870
|
/** Regular payment. */
|
|
2900
2871
|
regular?: RegularPayment;
|
|
2901
2872
|
}
|
|
2902
|
-
|
|
2873
|
+
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
2903
2874
|
/** Whether regular card used */
|
|
2904
2875
|
creditCardDetails?: CreditCardDetails;
|
|
2905
2876
|
/** Payment amount */
|
|
2906
2877
|
amount?: Price;
|
|
2907
2878
|
}
|
|
2908
2879
|
/** @oneof */
|
|
2909
|
-
|
|
2880
|
+
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
2910
2881
|
/** Whether regular card used */
|
|
2911
2882
|
creditCardDetails?: CreditCardDetails;
|
|
2912
2883
|
}
|
|
2913
|
-
|
|
2884
|
+
interface CreditCardDetails {
|
|
2914
2885
|
/**
|
|
2915
2886
|
* The last 4 digits of the card number.
|
|
2916
2887
|
* @maxLength 4
|
|
@@ -2922,7 +2893,7 @@ export interface CreditCardDetails {
|
|
|
2922
2893
|
*/
|
|
2923
2894
|
brand?: string | null;
|
|
2924
2895
|
}
|
|
2925
|
-
|
|
2896
|
+
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
2926
2897
|
/** Regular payment. */
|
|
2927
2898
|
regular?: RegularPayment;
|
|
2928
2899
|
/**
|
|
@@ -2932,11 +2903,11 @@ export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
2932
2903
|
paymentId?: string;
|
|
2933
2904
|
}
|
|
2934
2905
|
/** @oneof */
|
|
2935
|
-
|
|
2906
|
+
interface PaymentCanceledPaymentDetailsOneOf {
|
|
2936
2907
|
/** Regular payment. */
|
|
2937
2908
|
regular?: RegularPayment;
|
|
2938
2909
|
}
|
|
2939
|
-
|
|
2910
|
+
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
2940
2911
|
/** Regular payment. */
|
|
2941
2912
|
regular?: RegularPayment;
|
|
2942
2913
|
/**
|
|
@@ -2946,11 +2917,11 @@ export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
2946
2917
|
paymentId?: string;
|
|
2947
2918
|
}
|
|
2948
2919
|
/** @oneof */
|
|
2949
|
-
|
|
2920
|
+
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
2950
2921
|
/** Regular payment. */
|
|
2951
2922
|
regular?: RegularPayment;
|
|
2952
2923
|
}
|
|
2953
|
-
|
|
2924
|
+
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
2954
2925
|
/** Receipt created by Wix */
|
|
2955
2926
|
wixReceipt?: WixReceipt;
|
|
2956
2927
|
/** Receipt created by an external system. */
|
|
@@ -2962,13 +2933,13 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
2962
2933
|
paymentId?: string;
|
|
2963
2934
|
}
|
|
2964
2935
|
/** @oneof */
|
|
2965
|
-
|
|
2936
|
+
interface ReceiptCreatedReceiptInfoOneOf {
|
|
2966
2937
|
/** Receipt created by Wix */
|
|
2967
2938
|
wixReceipt?: WixReceipt;
|
|
2968
2939
|
/** Receipt created by an external system. */
|
|
2969
2940
|
externalReceipt?: ExternalReceipt;
|
|
2970
2941
|
}
|
|
2971
|
-
|
|
2942
|
+
interface WixReceipt {
|
|
2972
2943
|
/**
|
|
2973
2944
|
* Receipt ID
|
|
2974
2945
|
* @format GUID
|
|
@@ -2981,7 +2952,7 @@ export interface WixReceipt {
|
|
|
2981
2952
|
*/
|
|
2982
2953
|
displayNumber?: string | null;
|
|
2983
2954
|
}
|
|
2984
|
-
|
|
2955
|
+
interface ExternalReceipt {
|
|
2985
2956
|
/**
|
|
2986
2957
|
* Receipt ID
|
|
2987
2958
|
* @maxLength 100
|
|
@@ -2994,7 +2965,7 @@ export interface ExternalReceipt {
|
|
|
2994
2965
|
*/
|
|
2995
2966
|
displayNumber?: string | null;
|
|
2996
2967
|
}
|
|
2997
|
-
|
|
2968
|
+
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
2998
2969
|
/** Receipt created by Wix */
|
|
2999
2970
|
wixReceipt?: WixReceipt;
|
|
3000
2971
|
/** Receipt created by an external system. */
|
|
@@ -3006,13 +2977,13 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
3006
2977
|
paymentId?: string;
|
|
3007
2978
|
}
|
|
3008
2979
|
/** @oneof */
|
|
3009
|
-
|
|
2980
|
+
interface ReceiptSentReceiptInfoOneOf {
|
|
3010
2981
|
/** Receipt created by Wix */
|
|
3011
2982
|
wixReceipt?: WixReceipt;
|
|
3012
2983
|
/** Receipt created by an external system. */
|
|
3013
2984
|
externalReceipt?: ExternalReceipt;
|
|
3014
2985
|
}
|
|
3015
|
-
|
|
2986
|
+
declare enum ActivityType {
|
|
3016
2987
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
3017
2988
|
ORDER_PLACED = "ORDER_PLACED",
|
|
3018
2989
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -3049,11 +3020,11 @@ export declare enum ActivityType {
|
|
|
3049
3020
|
/** @documentationMaturity preview */
|
|
3050
3021
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
3051
3022
|
}
|
|
3052
|
-
|
|
3023
|
+
declare enum AttributionSource {
|
|
3053
3024
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3054
3025
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
3055
3026
|
}
|
|
3056
|
-
|
|
3027
|
+
interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3057
3028
|
/**
|
|
3058
3029
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3059
3030
|
* For example, via POS (point of service).
|
|
@@ -3077,7 +3048,7 @@ export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
|
3077
3048
|
appId?: string;
|
|
3078
3049
|
}
|
|
3079
3050
|
/** @oneof */
|
|
3080
|
-
|
|
3051
|
+
interface V1CreatedByStringOneOf {
|
|
3081
3052
|
/**
|
|
3082
3053
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
3083
3054
|
* For example, via POS (point of service).
|
|
@@ -3100,7 +3071,7 @@ export interface V1CreatedByStringOneOf {
|
|
|
3100
3071
|
*/
|
|
3101
3072
|
appId?: string;
|
|
3102
3073
|
}
|
|
3103
|
-
|
|
3074
|
+
interface ChannelInfo {
|
|
3104
3075
|
/** Sales channel that submitted the order. */
|
|
3105
3076
|
type?: ChannelType;
|
|
3106
3077
|
/**
|
|
@@ -3114,7 +3085,7 @@ export interface ChannelInfo {
|
|
|
3114
3085
|
*/
|
|
3115
3086
|
externalOrderUrl?: string | null;
|
|
3116
3087
|
}
|
|
3117
|
-
|
|
3088
|
+
declare enum ChannelType {
|
|
3118
3089
|
/** Unspecified sales channel. This value is not supported. */
|
|
3119
3090
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3120
3091
|
/** A web client. */
|
|
@@ -3148,7 +3119,7 @@ export declare enum ChannelType {
|
|
|
3148
3119
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
3149
3120
|
FAIRE_COM = "FAIRE_COM"
|
|
3150
3121
|
}
|
|
3151
|
-
|
|
3122
|
+
interface CustomField {
|
|
3152
3123
|
/** Custom field value. */
|
|
3153
3124
|
value?: any;
|
|
3154
3125
|
/**
|
|
@@ -3164,7 +3135,7 @@ export interface CustomField {
|
|
|
3164
3135
|
*/
|
|
3165
3136
|
translatedTitle?: string | null;
|
|
3166
3137
|
}
|
|
3167
|
-
|
|
3138
|
+
interface V1BalanceSummary {
|
|
3168
3139
|
/**
|
|
3169
3140
|
* Current amount left to pay.
|
|
3170
3141
|
* @readonly
|
|
@@ -3193,7 +3164,7 @@ export interface V1BalanceSummary {
|
|
|
3193
3164
|
*/
|
|
3194
3165
|
pending?: Price;
|
|
3195
3166
|
}
|
|
3196
|
-
|
|
3167
|
+
interface FulfillmentStatusesAggregate {
|
|
3197
3168
|
/** Unique string values based on Fulfillment entities statuses */
|
|
3198
3169
|
statuses?: string[] | null;
|
|
3199
3170
|
}
|
|
@@ -3219,13 +3190,13 @@ export interface FulfillmentStatusesAggregate {
|
|
|
3219
3190
|
* }
|
|
3220
3191
|
* }
|
|
3221
3192
|
*/
|
|
3222
|
-
|
|
3193
|
+
interface Tags {
|
|
3223
3194
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
3224
3195
|
privateTags?: TagList;
|
|
3225
3196
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
3226
3197
|
tags?: TagList;
|
|
3227
3198
|
}
|
|
3228
|
-
|
|
3199
|
+
interface TagList {
|
|
3229
3200
|
/**
|
|
3230
3201
|
* List of tag IDs
|
|
3231
3202
|
* @maxSize 100
|
|
@@ -3233,28 +3204,28 @@ export interface TagList {
|
|
|
3233
3204
|
*/
|
|
3234
3205
|
tagIds?: string[];
|
|
3235
3206
|
}
|
|
3236
|
-
|
|
3207
|
+
interface CreateOrderFromDraftRequest {
|
|
3237
3208
|
}
|
|
3238
|
-
|
|
3209
|
+
interface OrderCreateSettings {
|
|
3239
3210
|
}
|
|
3240
|
-
|
|
3211
|
+
interface OrderCreateNotifications {
|
|
3241
3212
|
}
|
|
3242
|
-
|
|
3213
|
+
interface CreateOrderFromDraftResponse {
|
|
3243
3214
|
}
|
|
3244
|
-
|
|
3215
|
+
interface DeleteDraftOrderRequest {
|
|
3245
3216
|
/**
|
|
3246
3217
|
* The draft order id
|
|
3247
3218
|
* @format GUID
|
|
3248
3219
|
*/
|
|
3249
3220
|
draftOrderId: string;
|
|
3250
3221
|
}
|
|
3251
|
-
|
|
3222
|
+
interface DeleteDraftOrderResponse {
|
|
3252
3223
|
}
|
|
3253
|
-
|
|
3224
|
+
interface QueryDraftOrdersRequest {
|
|
3254
3225
|
/** WQL expression */
|
|
3255
3226
|
query?: CursorQuery;
|
|
3256
3227
|
}
|
|
3257
|
-
|
|
3228
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3258
3229
|
/**
|
|
3259
3230
|
* Cursor paging options.
|
|
3260
3231
|
*
|
|
@@ -3276,7 +3247,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3276
3247
|
sort?: Sorting[];
|
|
3277
3248
|
}
|
|
3278
3249
|
/** @oneof */
|
|
3279
|
-
|
|
3250
|
+
interface CursorQueryPagingMethodOneOf {
|
|
3280
3251
|
/**
|
|
3281
3252
|
* Cursor paging options.
|
|
3282
3253
|
*
|
|
@@ -3284,7 +3255,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
3284
3255
|
*/
|
|
3285
3256
|
cursorPaging?: CursorPaging;
|
|
3286
3257
|
}
|
|
3287
|
-
|
|
3258
|
+
interface Sorting {
|
|
3288
3259
|
/**
|
|
3289
3260
|
* Name of the field to sort by.
|
|
3290
3261
|
* @maxLength 512
|
|
@@ -3293,11 +3264,11 @@ export interface Sorting {
|
|
|
3293
3264
|
/** Sort order. */
|
|
3294
3265
|
order?: SortOrder;
|
|
3295
3266
|
}
|
|
3296
|
-
|
|
3267
|
+
declare enum SortOrder {
|
|
3297
3268
|
ASC = "ASC",
|
|
3298
3269
|
DESC = "DESC"
|
|
3299
3270
|
}
|
|
3300
|
-
|
|
3271
|
+
interface CursorPaging {
|
|
3301
3272
|
/**
|
|
3302
3273
|
* Maximum number of items to return in the results.
|
|
3303
3274
|
* @max 100
|
|
@@ -3312,13 +3283,13 @@ export interface CursorPaging {
|
|
|
3312
3283
|
*/
|
|
3313
3284
|
cursor?: string | null;
|
|
3314
3285
|
}
|
|
3315
|
-
|
|
3286
|
+
interface QueryDraftOrdersResponse {
|
|
3316
3287
|
/** list of edits per order */
|
|
3317
3288
|
draftOrders?: DraftOrder[];
|
|
3318
3289
|
/** Paging metadata. */
|
|
3319
3290
|
pagingMetadata?: CursorPagingMetadata;
|
|
3320
3291
|
}
|
|
3321
|
-
|
|
3292
|
+
interface CursorPagingMetadata {
|
|
3322
3293
|
/** Number of items returned in current page. */
|
|
3323
3294
|
count?: number | null;
|
|
3324
3295
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -3331,7 +3302,7 @@ export interface CursorPagingMetadata {
|
|
|
3331
3302
|
*/
|
|
3332
3303
|
hasNext?: boolean | null;
|
|
3333
3304
|
}
|
|
3334
|
-
|
|
3305
|
+
interface Cursors {
|
|
3335
3306
|
/**
|
|
3336
3307
|
* Cursor string pointing to the next page in the list of results.
|
|
3337
3308
|
* @maxLength 16000
|
|
@@ -3343,30 +3314,30 @@ export interface Cursors {
|
|
|
3343
3314
|
*/
|
|
3344
3315
|
prev?: string | null;
|
|
3345
3316
|
}
|
|
3346
|
-
|
|
3317
|
+
interface UpdateExtendedFieldsRequest {
|
|
3347
3318
|
/** ID of the entity to update. */
|
|
3348
|
-
|
|
3319
|
+
_id?: string;
|
|
3349
3320
|
/** Identifier for the app whose extended fields are being updated. */
|
|
3350
3321
|
namespace?: string;
|
|
3351
3322
|
/** 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. */
|
|
3352
3323
|
namespaceData?: Record<string, any> | null;
|
|
3353
3324
|
}
|
|
3354
|
-
|
|
3325
|
+
interface UpdateExtendedFieldsResponse {
|
|
3355
3326
|
/** Updated DraftOrder */
|
|
3356
3327
|
draftOrder?: DraftOrder;
|
|
3357
3328
|
}
|
|
3358
|
-
|
|
3329
|
+
interface SetTaxExemptionRequest {
|
|
3359
3330
|
}
|
|
3360
|
-
|
|
3331
|
+
interface SetTaxExemptionResponse {
|
|
3361
3332
|
}
|
|
3362
|
-
|
|
3333
|
+
interface GetDraftEditabilityStatusRequest {
|
|
3363
3334
|
/**
|
|
3364
3335
|
* Draft order ID.
|
|
3365
3336
|
* @format GUID
|
|
3366
3337
|
*/
|
|
3367
3338
|
draftOrderId?: string | null;
|
|
3368
3339
|
}
|
|
3369
|
-
|
|
3340
|
+
interface GetDraftEditabilityStatusResponse {
|
|
3370
3341
|
/**
|
|
3371
3342
|
* Draft order ID.
|
|
3372
3343
|
* @format GUID
|
|
@@ -3378,11 +3349,11 @@ export interface GetDraftEditabilityStatusResponse {
|
|
|
3378
3349
|
*/
|
|
3379
3350
|
status?: EditingStatus;
|
|
3380
3351
|
}
|
|
3381
|
-
|
|
3352
|
+
interface SetBusinessLocationRequest {
|
|
3382
3353
|
}
|
|
3383
|
-
|
|
3354
|
+
interface SetBusinessLocationResponse {
|
|
3384
3355
|
}
|
|
3385
|
-
|
|
3356
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3386
3357
|
createdEvent?: EntityCreatedEvent;
|
|
3387
3358
|
updatedEvent?: EntityUpdatedEvent;
|
|
3388
3359
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3391,7 +3362,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3391
3362
|
* Unique event ID.
|
|
3392
3363
|
* Allows clients to ignore duplicate webhooks.
|
|
3393
3364
|
*/
|
|
3394
|
-
|
|
3365
|
+
_id?: string;
|
|
3395
3366
|
/**
|
|
3396
3367
|
* Assumes actions are also always typed to an entity_type
|
|
3397
3368
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -3425,36 +3396,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3425
3396
|
entityEventSequence?: string | null;
|
|
3426
3397
|
}
|
|
3427
3398
|
/** @oneof */
|
|
3428
|
-
|
|
3399
|
+
interface DomainEventBodyOneOf {
|
|
3429
3400
|
createdEvent?: EntityCreatedEvent;
|
|
3430
3401
|
updatedEvent?: EntityUpdatedEvent;
|
|
3431
3402
|
deletedEvent?: EntityDeletedEvent;
|
|
3432
3403
|
actionEvent?: ActionEvent;
|
|
3433
3404
|
}
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3437
|
-
restoreInfo?: RestoreInfo;
|
|
3405
|
+
interface EntityCreatedEvent {
|
|
3406
|
+
entity?: string;
|
|
3438
3407
|
}
|
|
3439
|
-
|
|
3408
|
+
interface RestoreInfo {
|
|
3440
3409
|
deletedDate?: Date | null;
|
|
3441
3410
|
}
|
|
3442
|
-
|
|
3411
|
+
interface EntityUpdatedEvent {
|
|
3443
3412
|
/**
|
|
3444
3413
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3445
3414
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3446
3415
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3447
3416
|
*/
|
|
3448
|
-
|
|
3417
|
+
currentEntity?: string;
|
|
3449
3418
|
}
|
|
3450
|
-
|
|
3419
|
+
interface EntityDeletedEvent {
|
|
3451
3420
|
/** Entity that was deleted */
|
|
3452
|
-
|
|
3421
|
+
deletedEntity?: string | null;
|
|
3453
3422
|
}
|
|
3454
|
-
|
|
3455
|
-
|
|
3423
|
+
interface ActionEvent {
|
|
3424
|
+
body?: string;
|
|
3456
3425
|
}
|
|
3457
|
-
|
|
3426
|
+
interface MessageEnvelope {
|
|
3458
3427
|
/**
|
|
3459
3428
|
* App instance ID.
|
|
3460
3429
|
* @format GUID
|
|
@@ -3470,7 +3439,7 @@ export interface MessageEnvelope {
|
|
|
3470
3439
|
/** Stringify payload. */
|
|
3471
3440
|
data?: string;
|
|
3472
3441
|
}
|
|
3473
|
-
|
|
3442
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3474
3443
|
/**
|
|
3475
3444
|
* ID of a site visitor that has not logged in to the site.
|
|
3476
3445
|
* @format GUID
|
|
@@ -3495,7 +3464,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3495
3464
|
identityType?: WebhookIdentityType;
|
|
3496
3465
|
}
|
|
3497
3466
|
/** @oneof */
|
|
3498
|
-
|
|
3467
|
+
interface IdentificationDataIdOneOf {
|
|
3499
3468
|
/**
|
|
3500
3469
|
* ID of a site visitor that has not logged in to the site.
|
|
3501
3470
|
* @format GUID
|
|
@@ -3517,511 +3486,134 @@ export interface IdentificationDataIdOneOf {
|
|
|
3517
3486
|
*/
|
|
3518
3487
|
appId?: string;
|
|
3519
3488
|
}
|
|
3520
|
-
|
|
3489
|
+
declare enum WebhookIdentityType {
|
|
3521
3490
|
UNKNOWN = "UNKNOWN",
|
|
3522
3491
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3523
3492
|
MEMBER = "MEMBER",
|
|
3524
3493
|
WIX_USER = "WIX_USER",
|
|
3525
3494
|
APP = "APP"
|
|
3526
3495
|
}
|
|
3527
|
-
interface
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
interface ProductNameNonNullableFields {
|
|
3539
|
-
original: string;
|
|
3540
|
-
}
|
|
3541
|
-
interface CatalogReferenceNonNullableFields {
|
|
3542
|
-
catalogItemId: string;
|
|
3543
|
-
appId: string;
|
|
3544
|
-
}
|
|
3545
|
-
interface PlainTextValueNonNullableFields {
|
|
3546
|
-
original: string;
|
|
3547
|
-
}
|
|
3548
|
-
interface ColorNonNullableFields {
|
|
3549
|
-
original: string;
|
|
3550
|
-
}
|
|
3551
|
-
interface DescriptionLineNameNonNullableFields {
|
|
3552
|
-
original: string;
|
|
3553
|
-
}
|
|
3554
|
-
interface DescriptionLineNonNullableFields {
|
|
3555
|
-
plainText?: PlainTextValueNonNullableFields;
|
|
3556
|
-
colorInfo?: ColorNonNullableFields;
|
|
3557
|
-
plainTextValue?: PlainTextValueNonNullableFields;
|
|
3558
|
-
color: string;
|
|
3559
|
-
name?: DescriptionLineNameNonNullableFields;
|
|
3560
|
-
lineType: DescriptionLineType;
|
|
3561
|
-
}
|
|
3562
|
-
interface FocalPointNonNullableFields {
|
|
3563
|
-
x: number;
|
|
3564
|
-
y: number;
|
|
3565
|
-
}
|
|
3566
|
-
interface ImageNonNullableFields {
|
|
3567
|
-
id: string;
|
|
3568
|
-
url: string;
|
|
3569
|
-
height: number;
|
|
3570
|
-
width: number;
|
|
3571
|
-
focalPoint?: FocalPointNonNullableFields;
|
|
3572
|
-
}
|
|
3573
|
-
interface PhysicalPropertiesNonNullableFields {
|
|
3574
|
-
shippable: boolean;
|
|
3575
|
-
}
|
|
3576
|
-
interface ItemTypeNonNullableFields {
|
|
3577
|
-
preset: ItemTypeItemType;
|
|
3578
|
-
custom: string;
|
|
3579
|
-
}
|
|
3580
|
-
interface ItemTaxFullDetailsNonNullableFields {
|
|
3581
|
-
taxableAmount?: PriceNonNullableFields;
|
|
3582
|
-
taxRate: string;
|
|
3583
|
-
totalTax?: PriceNonNullableFields;
|
|
3584
|
-
}
|
|
3585
|
-
interface LineItemTaxBreakdownNonNullableFields {
|
|
3586
|
-
taxAmount?: PriceNonNullableFields;
|
|
3587
|
-
jurisdictionType: JurisdictionType;
|
|
3588
|
-
nonTaxableAmount?: PriceNonNullableFields;
|
|
3589
|
-
taxableAmount?: PriceNonNullableFields;
|
|
3590
|
-
}
|
|
3591
|
-
interface LineItemTaxInfoNonNullableFields {
|
|
3592
|
-
taxAmount?: PriceNonNullableFields;
|
|
3593
|
-
taxableAmount?: PriceNonNullableFields;
|
|
3594
|
-
taxIncludedInPrice: boolean;
|
|
3595
|
-
taxBreakdown: LineItemTaxBreakdownNonNullableFields[];
|
|
3596
|
-
}
|
|
3597
|
-
interface DigitalFileNonNullableFields {
|
|
3598
|
-
fileId: string;
|
|
3599
|
-
}
|
|
3600
|
-
interface SubscriptionSettingsNonNullableFields {
|
|
3601
|
-
frequency: SubscriptionFrequency;
|
|
3602
|
-
autoRenewal: boolean;
|
|
3603
|
-
}
|
|
3604
|
-
interface SubscriptionInfoNonNullableFields {
|
|
3605
|
-
cycleNumber: number;
|
|
3606
|
-
subscriptionOptionTitle: string;
|
|
3607
|
-
subscriptionSettings?: SubscriptionSettingsNonNullableFields;
|
|
3608
|
-
}
|
|
3609
|
-
interface LocationAndQuantityNonNullableFields {
|
|
3610
|
-
id: string;
|
|
3611
|
-
quantity: number;
|
|
3612
|
-
}
|
|
3613
|
-
interface OrderLineItemNonNullableFields {
|
|
3614
|
-
id: string;
|
|
3615
|
-
productName?: ProductNameNonNullableFields;
|
|
3616
|
-
catalogReference?: CatalogReferenceNonNullableFields;
|
|
3617
|
-
quantity: number;
|
|
3618
|
-
totalDiscount?: PriceNonNullableFields;
|
|
3619
|
-
descriptionLines: DescriptionLineNonNullableFields[];
|
|
3620
|
-
image?: ImageNonNullableFields;
|
|
3621
|
-
physicalProperties?: PhysicalPropertiesNonNullableFields;
|
|
3622
|
-
itemType?: ItemTypeNonNullableFields;
|
|
3623
|
-
price?: PriceNonNullableFields;
|
|
3624
|
-
priceBeforeDiscounts?: PriceNonNullableFields;
|
|
3625
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
3626
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
3627
|
-
paymentOption: PaymentOptionType;
|
|
3628
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
3629
|
-
taxInfo?: LineItemTaxInfoNonNullableFields;
|
|
3630
|
-
digitalFile?: DigitalFileNonNullableFields;
|
|
3631
|
-
subscriptionInfo?: SubscriptionInfoNonNullableFields;
|
|
3632
|
-
priceDescription?: PriceDescriptionNonNullableFields;
|
|
3633
|
-
depositAmount?: PriceNonNullableFields;
|
|
3634
|
-
locations: LocationAndQuantityNonNullableFields[];
|
|
3635
|
-
lineItemPrice?: PriceNonNullableFields;
|
|
3636
|
-
}
|
|
3637
|
-
interface ItemDetailsNonNullableFields {
|
|
3638
|
-
added: boolean;
|
|
3639
|
-
changedDetails?: ItemChangedDetailsNonNullableFields;
|
|
3640
|
-
removed: boolean;
|
|
3641
|
-
lineItem?: OrderLineItemNonNullableFields;
|
|
3642
|
-
}
|
|
3643
|
-
interface StreetAddressNonNullableFields {
|
|
3644
|
-
number: string;
|
|
3645
|
-
name: string;
|
|
3646
|
-
apt: string;
|
|
3647
|
-
}
|
|
3648
|
-
interface AddressNonNullableFields {
|
|
3649
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
3650
|
-
}
|
|
3651
|
-
interface VatIdNonNullableFields {
|
|
3652
|
-
id: string;
|
|
3653
|
-
type: VatType;
|
|
3654
|
-
}
|
|
3655
|
-
interface FullAddressContactDetailsNonNullableFields {
|
|
3656
|
-
vatId?: VatIdNonNullableFields;
|
|
3657
|
-
}
|
|
3658
|
-
interface AddressWithContactNonNullableFields {
|
|
3659
|
-
address?: AddressNonNullableFields;
|
|
3660
|
-
contactDetails?: FullAddressContactDetailsNonNullableFields;
|
|
3661
|
-
}
|
|
3662
|
-
interface PickupAddressNonNullableFields {
|
|
3663
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
3664
|
-
}
|
|
3665
|
-
interface V1PickupDetailsNonNullableFields {
|
|
3666
|
-
address?: PickupAddressNonNullableFields;
|
|
3667
|
-
pickupMethod: PickupDetailsPickupMethod;
|
|
3668
|
-
}
|
|
3669
|
-
interface V1DeliveryLogisticsNonNullableFields {
|
|
3670
|
-
shippingDestination?: AddressWithContactNonNullableFields;
|
|
3671
|
-
pickupDetails?: V1PickupDetailsNonNullableFields;
|
|
3672
|
-
}
|
|
3673
|
-
interface V1ShippingPriceNonNullableFields {
|
|
3674
|
-
price?: PriceNonNullableFields;
|
|
3675
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
3676
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
3677
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
3678
|
-
discount?: PriceNonNullableFields;
|
|
3679
|
-
}
|
|
3680
|
-
interface V1ShippingInformationNonNullableFields {
|
|
3681
|
-
title: string;
|
|
3682
|
-
logistics?: V1DeliveryLogisticsNonNullableFields;
|
|
3683
|
-
cost?: V1ShippingPriceNonNullableFields;
|
|
3684
|
-
}
|
|
3685
|
-
interface ShippingChangedDetailsNonNullableFields {
|
|
3686
|
-
shippingInfoBeforeChange?: V1ShippingInformationNonNullableFields;
|
|
3687
|
-
}
|
|
3688
|
-
interface ShippingDetailsNonNullableFields {
|
|
3689
|
-
added: boolean;
|
|
3690
|
-
changedDetails?: ShippingChangedDetailsNonNullableFields;
|
|
3691
|
-
removed: boolean;
|
|
3692
|
-
shippingInfo?: V1ShippingInformationNonNullableFields;
|
|
3693
|
-
}
|
|
3694
|
-
interface BuyerInfoNonNullableFields {
|
|
3695
|
-
visitorId: string;
|
|
3696
|
-
memberId: string;
|
|
3697
|
-
}
|
|
3698
|
-
interface AdditionalFeeNonNullableFields {
|
|
3699
|
-
name: string;
|
|
3700
|
-
price?: PriceNonNullableFields;
|
|
3701
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
3702
|
-
priceBeforeTax?: PriceNonNullableFields;
|
|
3703
|
-
priceAfterTax?: PriceNonNullableFields;
|
|
3704
|
-
id: string;
|
|
3705
|
-
lineItemIds: string[];
|
|
3706
|
-
}
|
|
3707
|
-
interface TaxDetailsNonNullableFields {
|
|
3708
|
-
taxable: boolean;
|
|
3709
|
-
}
|
|
3710
|
-
interface AdditionalFeeDetailsNonNullableFields {
|
|
3711
|
-
additionalFee?: AdditionalFeeNonNullableFields;
|
|
3712
|
-
taxDetails?: TaxDetailsNonNullableFields;
|
|
3713
|
-
source: SourceType;
|
|
3714
|
-
applied: boolean;
|
|
3715
|
-
}
|
|
3716
|
-
interface CouponNonNullableFields {
|
|
3717
|
-
id: string;
|
|
3718
|
-
code: string;
|
|
3719
|
-
name: string;
|
|
3720
|
-
amount?: PriceNonNullableFields;
|
|
3721
|
-
}
|
|
3722
|
-
interface MerchantDiscountNonNullableFields {
|
|
3723
|
-
discountReason: DiscountReason;
|
|
3724
|
-
amount?: PriceNonNullableFields;
|
|
3725
|
-
}
|
|
3726
|
-
interface DiscountRuleNameNonNullableFields {
|
|
3727
|
-
original: string;
|
|
3728
|
-
}
|
|
3729
|
-
interface DiscountRuleNonNullableFields {
|
|
3730
|
-
id: string;
|
|
3731
|
-
name?: DiscountRuleNameNonNullableFields;
|
|
3732
|
-
amount?: PriceNonNullableFields;
|
|
3733
|
-
}
|
|
3734
|
-
interface AppliedDiscountNonNullableFields {
|
|
3735
|
-
coupon?: CouponNonNullableFields;
|
|
3736
|
-
merchantDiscount?: MerchantDiscountNonNullableFields;
|
|
3737
|
-
discountRule?: DiscountRuleNonNullableFields;
|
|
3738
|
-
discountType: AppliedDiscountDiscountType;
|
|
3739
|
-
lineItemIds: string[];
|
|
3740
|
-
}
|
|
3741
|
-
interface DiscountDetailsNonNullableFields {
|
|
3742
|
-
discount?: AppliedDiscountNonNullableFields;
|
|
3743
|
-
source: SourceType;
|
|
3744
|
-
applied: boolean;
|
|
3745
|
-
}
|
|
3746
|
-
interface CreatedByNonNullableFields {
|
|
3747
|
-
userId: string;
|
|
3748
|
-
appId: string;
|
|
3749
|
-
}
|
|
3750
|
-
interface PriceSummaryNonNullableFields {
|
|
3751
|
-
subtotal?: PriceNonNullableFields;
|
|
3752
|
-
shipping?: PriceNonNullableFields;
|
|
3753
|
-
tax?: PriceNonNullableFields;
|
|
3754
|
-
discount?: PriceNonNullableFields;
|
|
3755
|
-
totalPrice?: PriceNonNullableFields;
|
|
3756
|
-
total?: PriceNonNullableFields;
|
|
3757
|
-
totalWithGiftCard?: PriceNonNullableFields;
|
|
3758
|
-
totalWithoutGiftCard?: PriceNonNullableFields;
|
|
3759
|
-
totalAdditionalFees?: PriceNonNullableFields;
|
|
3760
|
-
}
|
|
3761
|
-
interface TaxSummaryNonNullableFields {
|
|
3762
|
-
totalTax?: PriceNonNullableFields;
|
|
3763
|
-
}
|
|
3764
|
-
interface BalanceNonNullableFields {
|
|
3765
|
-
amount: string;
|
|
3766
|
-
formattedAmount: string;
|
|
3767
|
-
}
|
|
3768
|
-
interface BalanceSummaryNonNullableFields {
|
|
3769
|
-
balance?: BalanceNonNullableFields;
|
|
3770
|
-
paid?: PriceNonNullableFields;
|
|
3771
|
-
refunded?: PriceNonNullableFields;
|
|
3772
|
-
authorized?: PriceNonNullableFields;
|
|
3773
|
-
}
|
|
3774
|
-
interface InventoryUpdateNonNullableFields {
|
|
3775
|
-
lineItemId: string;
|
|
3776
|
-
}
|
|
3777
|
-
interface DraftOrderCommitSettingsNonNullableFields {
|
|
3778
|
-
updateInventory: InventoryUpdateNonNullableFields[];
|
|
3779
|
-
}
|
|
3780
|
-
interface RecipientInfoChangedDetailsNonNullableFields {
|
|
3781
|
-
recipientInfoBeforeChange?: AddressWithContactNonNullableFields;
|
|
3782
|
-
}
|
|
3783
|
-
interface RecipientInfoDetailsNonNullableFields {
|
|
3784
|
-
added: boolean;
|
|
3785
|
-
changedDetails?: RecipientInfoChangedDetailsNonNullableFields;
|
|
3786
|
-
removed: boolean;
|
|
3787
|
-
recipientInfo?: AddressWithContactNonNullableFields;
|
|
3788
|
-
}
|
|
3789
|
-
interface OrderTaxBreakdownNonNullableFields {
|
|
3790
|
-
taxName: string;
|
|
3791
|
-
taxType: string;
|
|
3792
|
-
jurisdiction: string;
|
|
3793
|
-
jurisdictionType: JurisdictionType;
|
|
3794
|
-
rate: string;
|
|
3795
|
-
aggregatedTaxAmount?: PriceNonNullableFields;
|
|
3796
|
-
aggregatedTaxableAmount?: PriceNonNullableFields;
|
|
3797
|
-
}
|
|
3798
|
-
interface OrderTaxInfoNonNullableFields {
|
|
3799
|
-
totalTax?: PriceNonNullableFields;
|
|
3800
|
-
taxBreakdown: OrderTaxBreakdownNonNullableFields[];
|
|
3801
|
-
}
|
|
3802
|
-
interface LocationNonNullableFields {
|
|
3803
|
-
id: string;
|
|
3804
|
-
name: string;
|
|
3805
|
-
}
|
|
3806
|
-
interface BusinessLocationChangedDetailsNonNullableFields {
|
|
3807
|
-
businessLocationBeforeChange?: LocationNonNullableFields;
|
|
3808
|
-
}
|
|
3809
|
-
interface BusinessLocationDetailsNonNullableFields {
|
|
3810
|
-
added: boolean;
|
|
3811
|
-
changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
|
|
3812
|
-
removed: boolean;
|
|
3813
|
-
businessLocation?: LocationNonNullableFields;
|
|
3814
|
-
}
|
|
3815
|
-
interface DraftOrderNonNullableFields {
|
|
3816
|
-
lineItems: ItemDetailsNonNullableFields[];
|
|
3817
|
-
shippingInfo?: ShippingDetailsNonNullableFields;
|
|
3818
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
3819
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
3820
|
-
additionalFees: AdditionalFeeDetailsNonNullableFields[];
|
|
3821
|
-
discounts: DiscountDetailsNonNullableFields[];
|
|
3822
|
-
createdBy?: CreatedByNonNullableFields;
|
|
3823
|
-
status: EditingStatus;
|
|
3824
|
-
weightUnit: WeightUnit;
|
|
3825
|
-
priceSummary?: PriceSummaryNonNullableFields;
|
|
3826
|
-
taxSummary?: TaxSummaryNonNullableFields;
|
|
3827
|
-
balanceSummary?: BalanceSummaryNonNullableFields;
|
|
3828
|
-
commitSettings?: DraftOrderCommitSettingsNonNullableFields;
|
|
3829
|
-
recipientInfo?: RecipientInfoDetailsNonNullableFields;
|
|
3830
|
-
businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
|
|
3831
|
-
}
|
|
3832
|
-
interface PickupDetailsNonNullableFields {
|
|
3833
|
-
address?: AddressNonNullableFields;
|
|
3834
|
-
pickupMethod: PickupMethod;
|
|
3835
|
-
}
|
|
3836
|
-
interface DeliveryLogisticsNonNullableFields {
|
|
3837
|
-
pickupDetails?: PickupDetailsNonNullableFields;
|
|
3838
|
-
}
|
|
3839
|
-
interface ShippingPriceNonNullableFields {
|
|
3840
|
-
price?: PriceNonNullableFields;
|
|
3841
|
-
currency: string;
|
|
3842
|
-
}
|
|
3843
|
-
interface ShippingOptionNonNullableFields {
|
|
3844
|
-
code: string;
|
|
3845
|
-
title: string;
|
|
3846
|
-
logistics?: DeliveryLogisticsNonNullableFields;
|
|
3847
|
-
cost?: ShippingPriceNonNullableFields;
|
|
3848
|
-
}
|
|
3849
|
-
interface ApplicationErrorNonNullableFields {
|
|
3850
|
-
code: string;
|
|
3851
|
-
description: string;
|
|
3852
|
-
}
|
|
3853
|
-
interface FieldViolationNonNullableFields {
|
|
3854
|
-
field: string;
|
|
3855
|
-
description: string;
|
|
3856
|
-
violatedRule: RuleType;
|
|
3857
|
-
}
|
|
3858
|
-
interface ValidationErrorNonNullableFields {
|
|
3859
|
-
fieldViolations: FieldViolationNonNullableFields[];
|
|
3860
|
-
}
|
|
3861
|
-
interface DetailsNonNullableFields {
|
|
3862
|
-
applicationError?: ApplicationErrorNonNullableFields;
|
|
3863
|
-
validationError?: ValidationErrorNonNullableFields;
|
|
3864
|
-
}
|
|
3865
|
-
interface CarrierErrorNonNullableFields {
|
|
3866
|
-
carrierId: string;
|
|
3867
|
-
error?: DetailsNonNullableFields;
|
|
3868
|
-
}
|
|
3869
|
-
interface CarrierErrorsNonNullableFields {
|
|
3870
|
-
errors: CarrierErrorNonNullableFields[];
|
|
3871
|
-
}
|
|
3872
|
-
interface CalculationErrorsNonNullableFields {
|
|
3873
|
-
generalShippingCalculationError?: DetailsNonNullableFields;
|
|
3874
|
-
carrierErrors?: CarrierErrorsNonNullableFields;
|
|
3875
|
-
taxCalculationError?: DetailsNonNullableFields;
|
|
3876
|
-
orderValidationErrors: ApplicationErrorNonNullableFields[];
|
|
3877
|
-
}
|
|
3878
|
-
interface CalculatedDraftOrderNonNullableFields {
|
|
3879
|
-
draftOrder?: DraftOrderNonNullableFields;
|
|
3880
|
-
shippingOptions: ShippingOptionNonNullableFields[];
|
|
3881
|
-
calculationErrors?: CalculationErrorsNonNullableFields;
|
|
3882
|
-
}
|
|
3883
|
-
export interface CreateDraftOrderResponseNonNullableFields {
|
|
3884
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3885
|
-
}
|
|
3886
|
-
export interface CreateEmptyDraftOrderResponseNonNullableFields {
|
|
3887
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3888
|
-
}
|
|
3889
|
-
export interface AddLineItemsToDraftOrderResponseNonNullableFields {
|
|
3890
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3891
|
-
}
|
|
3892
|
-
export interface UpdateLineItemsResponseNonNullableFields {
|
|
3893
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3894
|
-
}
|
|
3895
|
-
export interface SetDiscountsResponseNonNullableFields {
|
|
3896
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3897
|
-
}
|
|
3898
|
-
export interface CreateCustomDiscountsResponseNonNullableFields {
|
|
3899
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3900
|
-
}
|
|
3901
|
-
export interface DeleteCustomDiscountsResponseNonNullableFields {
|
|
3902
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3903
|
-
}
|
|
3904
|
-
export interface SetAdditionalFeesResponseNonNullableFields {
|
|
3905
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3906
|
-
}
|
|
3907
|
-
export interface CreateCustomAdditionalFeesResponseNonNullableFields {
|
|
3908
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
3909
|
-
}
|
|
3910
|
-
export interface DeleteCustomAdditionalFeesResponseNonNullableFields {
|
|
3911
|
-
calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
|
|
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[];
|
|
3912
3507
|
}
|
|
3913
|
-
|
|
3508
|
+
interface UpdateLineItemsOptions {
|
|
3509
|
+
/**
|
|
3510
|
+
* Details of changes to apply per line item
|
|
3511
|
+
* @minSize 1
|
|
3512
|
+
* @maxSize 300
|
|
3513
|
+
*/
|
|
3514
|
+
lineItemChanges?: LineItemChangeDetails[];
|
|
3914
3515
|
}
|
|
3915
|
-
|
|
3516
|
+
interface CreateCustomDiscountsOptions {
|
|
3517
|
+
/**
|
|
3518
|
+
* The discounts to add.
|
|
3519
|
+
* @minSize 1
|
|
3520
|
+
* @maxSize 100
|
|
3521
|
+
*/
|
|
3522
|
+
discounts?: DiscountOption[];
|
|
3916
3523
|
}
|
|
3917
|
-
|
|
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[];
|
|
3918
3531
|
}
|
|
3919
|
-
|
|
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;
|
|
3920
3540
|
}
|
|
3921
|
-
|
|
3922
|
-
|
|
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>;
|
|
3923
3617
|
}
|
|
3924
|
-
|
|
3925
|
-
|
|
3926
|
-
orderDraftable: boolean;
|
|
3927
|
-
nonDraftableReasons: NonDraftableReason[];
|
|
3928
|
-
}
|
|
3929
|
-
interface CustomActivityNonNullableFields {
|
|
3930
|
-
appId: string;
|
|
3931
|
-
type: string;
|
|
3932
|
-
}
|
|
3933
|
-
interface MerchantCommentNonNullableFields {
|
|
3934
|
-
message: string;
|
|
3935
|
-
}
|
|
3936
|
-
interface OrderRefundedNonNullableFields {
|
|
3937
|
-
manual: boolean;
|
|
3938
|
-
amount?: PriceNonNullableFields;
|
|
3939
|
-
reason: string;
|
|
3940
|
-
}
|
|
3941
|
-
interface OrderCreatedFromExchangeNonNullableFields {
|
|
3942
|
-
originalOrderId: string;
|
|
3943
|
-
}
|
|
3944
|
-
interface LineItemExchangeDataNonNullableFields {
|
|
3945
|
-
lineItemId: string;
|
|
3946
|
-
quantity: number;
|
|
3947
|
-
}
|
|
3948
|
-
interface NewExchangeOrderCreatedNonNullableFields {
|
|
3949
|
-
exchangeOrderId: string;
|
|
3950
|
-
lineItems: LineItemExchangeDataNonNullableFields[];
|
|
3951
|
-
}
|
|
3952
|
-
interface ActivityNonNullableFields {
|
|
3953
|
-
customActivity?: CustomActivityNonNullableFields;
|
|
3954
|
-
merchantComment?: MerchantCommentNonNullableFields;
|
|
3955
|
-
orderRefunded?: OrderRefundedNonNullableFields;
|
|
3956
|
-
orderCreatedFromExchange?: OrderCreatedFromExchangeNonNullableFields;
|
|
3957
|
-
newExchangeOrderCreated?: NewExchangeOrderCreatedNonNullableFields;
|
|
3958
|
-
type: ActivityType;
|
|
3959
|
-
}
|
|
3960
|
-
interface V1CreatedByNonNullableFields {
|
|
3961
|
-
userId: string;
|
|
3962
|
-
memberId: string;
|
|
3963
|
-
visitorId: string;
|
|
3964
|
-
appId: string;
|
|
3965
|
-
}
|
|
3966
|
-
interface ChannelInfoNonNullableFields {
|
|
3967
|
-
type: ChannelType;
|
|
3968
|
-
}
|
|
3969
|
-
interface CustomFieldNonNullableFields {
|
|
3970
|
-
title: string;
|
|
3971
|
-
}
|
|
3972
|
-
interface V1BalanceSummaryNonNullableFields {
|
|
3973
|
-
balance?: BalanceNonNullableFields;
|
|
3974
|
-
paid?: PriceNonNullableFields;
|
|
3975
|
-
refunded?: PriceNonNullableFields;
|
|
3976
|
-
authorized?: PriceNonNullableFields;
|
|
3977
|
-
pending?: PriceNonNullableFields;
|
|
3978
|
-
}
|
|
3979
|
-
interface TagListNonNullableFields {
|
|
3980
|
-
tagIds: string[];
|
|
3981
|
-
}
|
|
3982
|
-
interface TagsNonNullableFields {
|
|
3983
|
-
privateTags?: TagListNonNullableFields;
|
|
3984
|
-
tags?: TagListNonNullableFields;
|
|
3985
|
-
}
|
|
3986
|
-
interface OrderNonNullableFields {
|
|
3987
|
-
number: string;
|
|
3988
|
-
lineItems: OrderLineItemNonNullableFields[];
|
|
3989
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
3990
|
-
paymentStatus: PaymentStatus;
|
|
3991
|
-
fulfillmentStatus: FulfillmentStatus;
|
|
3992
|
-
weightUnit: WeightUnit;
|
|
3993
|
-
taxIncludedInPrices: boolean;
|
|
3994
|
-
priceSummary?: PriceSummaryNonNullableFields;
|
|
3995
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
3996
|
-
shippingInfo?: V1ShippingInformationNonNullableFields;
|
|
3997
|
-
status: OrderStatus;
|
|
3998
|
-
taxSummary?: TaxSummaryNonNullableFields;
|
|
3999
|
-
taxInfo?: OrderTaxInfoNonNullableFields;
|
|
4000
|
-
appliedDiscounts: AppliedDiscountNonNullableFields[];
|
|
4001
|
-
activities: ActivityNonNullableFields[];
|
|
4002
|
-
attributionSource: AttributionSource;
|
|
4003
|
-
createdBy?: V1CreatedByNonNullableFields;
|
|
4004
|
-
channelInfo?: ChannelInfoNonNullableFields;
|
|
4005
|
-
customFields: CustomFieldNonNullableFields[];
|
|
4006
|
-
isInternalOrderCreate: boolean;
|
|
4007
|
-
payNow?: PriceSummaryNonNullableFields;
|
|
4008
|
-
balanceSummary?: V1BalanceSummaryNonNullableFields;
|
|
4009
|
-
additionalFees: AdditionalFeeNonNullableFields[];
|
|
4010
|
-
recipientInfo?: AddressWithContactNonNullableFields;
|
|
4011
|
-
tags?: TagsNonNullableFields;
|
|
4012
|
-
businessLocation?: LocationNonNullableFields;
|
|
4013
|
-
}
|
|
4014
|
-
export interface CommitDraftOrderResponseNonNullableFields {
|
|
4015
|
-
committedDraftOrder?: DraftOrderNonNullableFields;
|
|
4016
|
-
orderAfterCommit?: OrderNonNullableFields;
|
|
4017
|
-
}
|
|
4018
|
-
export interface CreateOrderFromDraftResponseNonNullableFields {
|
|
4019
|
-
}
|
|
4020
|
-
export interface QueryDraftOrdersResponseNonNullableFields {
|
|
4021
|
-
draftOrders: DraftOrderNonNullableFields[];
|
|
4022
|
-
}
|
|
4023
|
-
export interface SetTaxExemptionResponseNonNullableFields {
|
|
4024
|
-
}
|
|
4025
|
-
export interface SetBusinessLocationResponseNonNullableFields {
|
|
4026
|
-
}
|
|
4027
|
-
export {};
|
|
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 };
|