@wix/auto_sdk_ecom_orders 1.0.34 → 1.0.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-order-orders.context.d.ts +34 -0
- package/build/cjs/src/ecom-v1-order-orders.context.js +117 -0
- package/build/cjs/src/ecom-v1-order-orders.context.js.map +1 -0
- package/build/cjs/src/ecom-v1-order-orders.http.d.ts +200 -0
- package/build/cjs/src/ecom-v1-order-orders.http.js +1610 -0
- package/build/cjs/src/ecom-v1-order-orders.http.js.map +1 -0
- package/build/cjs/src/ecom-v1-order-orders.meta.d.ts +78 -0
- package/build/cjs/src/ecom-v1-order-orders.meta.js +503 -0
- package/build/cjs/src/ecom-v1-order-orders.meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-order-orders.public.d.ts +189 -0
- package/build/cjs/src/ecom-v1-order-orders.public.js +382 -0
- package/build/cjs/src/ecom-v1-order-orders.public.js.map +1 -0
- package/build/{ecom-v1-order-orders.universal-UflOyGzD.d.mts → cjs/src/ecom-v1-order-orders.types.d.ts} +637 -1109
- package/build/cjs/src/ecom-v1-order-orders.types.js +652 -0
- package/build/cjs/src/ecom-v1-order-orders.types.js.map +1 -0
- package/build/{internal/ecom-v1-order-orders.universal-DkzM7BQ-.d.ts → cjs/src/ecom-v1-order-orders.universal.d.ts} +985 -957
- package/build/cjs/src/ecom-v1-order-orders.universal.js +2294 -0
- package/build/cjs/src/ecom-v1-order-orders.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/ecom-v1-order-orders.context.d.ts +34 -0
- package/build/es/src/ecom-v1-order-orders.context.js +62 -0
- package/build/es/src/ecom-v1-order-orders.context.js.map +1 -0
- package/build/es/src/ecom-v1-order-orders.http.d.ts +200 -0
- package/build/es/src/ecom-v1-order-orders.http.js +1582 -0
- package/build/es/src/ecom-v1-order-orders.http.js.map +1 -0
- package/build/es/src/ecom-v1-order-orders.meta.d.ts +78 -0
- package/build/es/src/ecom-v1-order-orders.meta.js +452 -0
- package/build/es/src/ecom-v1-order-orders.meta.js.map +1 -0
- package/build/es/src/ecom-v1-order-orders.public.d.ts +189 -0
- package/build/es/src/ecom-v1-order-orders.public.js +302 -0
- package/build/es/src/ecom-v1-order-orders.public.js.map +1 -0
- package/build/{ecom-v1-order-orders.universal-UflOyGzD.d.ts → es/src/ecom-v1-order-orders.types.d.ts} +637 -1109
- package/build/es/src/ecom-v1-order-orders.types.js +648 -0
- package/build/es/src/ecom-v1-order-orders.types.js.map +1 -0
- package/build/{internal/ecom-v1-order-orders.universal-DkzM7BQ-.d.mts → es/src/ecom-v1-order-orders.universal.d.ts} +985 -957
- package/build/es/src/ecom-v1-order-orders.universal.js +2242 -0
- package/build/es/src/ecom-v1-order-orders.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +62 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.context.js +117 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.context.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.http.d.ts +200 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.http.js +1610 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.http.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.d.ts +78 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.js +503 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +340 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js +382 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +6096 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.types.js +652 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.types.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +7750 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +2294 -0
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +62 -0
- package/build/internal/es/src/ecom-v1-order-orders.context.js +62 -0
- package/build/internal/es/src/ecom-v1-order-orders.context.js.map +1 -0
- package/build/internal/es/src/ecom-v1-order-orders.http.d.ts +200 -0
- package/build/internal/es/src/ecom-v1-order-orders.http.js +1582 -0
- package/build/internal/es/src/ecom-v1-order-orders.http.js.map +1 -0
- package/build/internal/es/src/ecom-v1-order-orders.meta.d.ts +78 -0
- package/build/internal/es/src/ecom-v1-order-orders.meta.js +452 -0
- package/build/internal/es/src/ecom-v1-order-orders.meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +340 -0
- package/build/internal/es/src/ecom-v1-order-orders.public.js +302 -0
- package/build/internal/es/src/ecom-v1-order-orders.public.js.map +1 -0
- package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +6096 -0
- package/build/internal/es/src/ecom-v1-order-orders.types.js +648 -0
- package/build/internal/es/src/ecom-v1-order-orders.types.js.map +1 -0
- package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +7750 -0
- package/build/internal/es/src/ecom-v1-order-orders.universal.js +2242 -0
- package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -212
- package/build/index.d.ts +0 -212
- package/build/index.js +0 -3504
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -3401
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -391
- package/build/internal/index.d.ts +0 -391
- package/build/internal/index.js +0 -3504
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -3401
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -3192
- package/build/internal/meta.d.ts +0 -3192
- package/build/internal/meta.js +0 -1941
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -1890
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -3192
- package/build/meta.d.ts +0 -3192
- package/build/meta.js +0 -1941
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -1890
- package/build/meta.mjs.map +0 -1
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
interface Order {
|
|
1
|
+
export interface Order {
|
|
2
2
|
/**
|
|
3
3
|
* Order ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
id?: string | null;
|
|
8
8
|
/**
|
|
9
9
|
* Order number displayed in the site owner's dashboard (auto-generated).
|
|
10
10
|
* @readonly
|
|
11
11
|
*/
|
|
12
12
|
number?: string;
|
|
13
13
|
/**
|
|
14
|
-
* Date and time the order was created.
|
|
14
|
+
* Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
15
15
|
* @readonly
|
|
16
16
|
* @immutable
|
|
17
17
|
*/
|
|
18
|
-
|
|
18
|
+
createdDate?: Date | null;
|
|
19
19
|
/**
|
|
20
20
|
* Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
21
21
|
* @readonly
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
updatedDate?: Date | null;
|
|
24
24
|
/**
|
|
25
25
|
* Order line items.
|
|
26
26
|
* @minSize 1
|
|
@@ -166,12 +166,12 @@ interface Order {
|
|
|
166
166
|
/** Order Location */
|
|
167
167
|
businessLocation?: Location;
|
|
168
168
|
}
|
|
169
|
-
interface OrderLineItem {
|
|
169
|
+
export interface OrderLineItem {
|
|
170
170
|
/**
|
|
171
171
|
* Line item ID.
|
|
172
172
|
* @immutable
|
|
173
173
|
*/
|
|
174
|
-
|
|
174
|
+
id?: string;
|
|
175
175
|
/**
|
|
176
176
|
* Item name.
|
|
177
177
|
* + Stores - `product.name`
|
|
@@ -179,7 +179,10 @@ interface OrderLineItem {
|
|
|
179
179
|
* + Events - `ticket.name`
|
|
180
180
|
*/
|
|
181
181
|
productName?: ProductName;
|
|
182
|
-
/**
|
|
182
|
+
/**
|
|
183
|
+
* References to the line item's origin catalog.
|
|
184
|
+
* This field may be empty in the case of a custom line item.
|
|
185
|
+
*/
|
|
183
186
|
catalogReference?: CatalogReference;
|
|
184
187
|
/**
|
|
185
188
|
* Line item quantity.
|
|
@@ -198,15 +201,14 @@ interface OrderLineItem {
|
|
|
198
201
|
*/
|
|
199
202
|
descriptionLines?: DescriptionLine[];
|
|
200
203
|
/** Line item image. */
|
|
201
|
-
image?:
|
|
204
|
+
image?: Image;
|
|
202
205
|
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
203
206
|
physicalProperties?: PhysicalProperties;
|
|
204
207
|
/** Item type. Either a preset type or custom. */
|
|
205
208
|
itemType?: ItemType;
|
|
206
209
|
/**
|
|
207
210
|
* Fulfiller ID. Field is empty when the line item is self-fulfilled.
|
|
208
|
-
*
|
|
209
|
-
* To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).
|
|
211
|
+
* To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
|
|
210
212
|
* @format GUID
|
|
211
213
|
*/
|
|
212
214
|
fulfillerId?: string | null;
|
|
@@ -281,7 +283,7 @@ interface OrderLineItem {
|
|
|
281
283
|
*/
|
|
282
284
|
extendedFields?: ExtendedFields;
|
|
283
285
|
}
|
|
284
|
-
interface ProductName {
|
|
286
|
+
export interface ProductName {
|
|
285
287
|
/**
|
|
286
288
|
* __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).
|
|
287
289
|
*
|
|
@@ -303,7 +305,7 @@ interface ProductName {
|
|
|
303
305
|
translated?: string | null;
|
|
304
306
|
}
|
|
305
307
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
306
|
-
interface CatalogReference {
|
|
308
|
+
export interface CatalogReference {
|
|
307
309
|
/**
|
|
308
310
|
* ID of the item within the catalog it belongs to.
|
|
309
311
|
* @minLength 1
|
|
@@ -323,15 +325,13 @@ interface CatalogReference {
|
|
|
323
325
|
*/
|
|
324
326
|
appId?: string;
|
|
325
327
|
/**
|
|
326
|
-
* Additional item details in key:value pairs.
|
|
327
|
-
*
|
|
328
|
-
* Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
328
|
+
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
329
329
|
*
|
|
330
|
-
* For products and variants from
|
|
330
|
+
* For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
|
|
331
331
|
*/
|
|
332
332
|
options?: Record<string, any> | null;
|
|
333
333
|
}
|
|
334
|
-
interface Price {
|
|
334
|
+
export interface Price {
|
|
335
335
|
/**
|
|
336
336
|
* Amount.
|
|
337
337
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -343,7 +343,7 @@ interface Price {
|
|
|
343
343
|
*/
|
|
344
344
|
formattedAmount?: string;
|
|
345
345
|
}
|
|
346
|
-
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
346
|
+
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
347
347
|
/** Description line plain text value. */
|
|
348
348
|
plainText?: PlainTextValue;
|
|
349
349
|
/** Description line color value. */
|
|
@@ -352,16 +352,16 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
352
352
|
name?: DescriptionLineName;
|
|
353
353
|
}
|
|
354
354
|
/** @oneof */
|
|
355
|
-
interface DescriptionLineValueOneOf {
|
|
355
|
+
export interface DescriptionLineValueOneOf {
|
|
356
356
|
/** Description line plain text value. */
|
|
357
357
|
plainText?: PlainTextValue;
|
|
358
358
|
/** Description line color value. */
|
|
359
359
|
colorInfo?: Color;
|
|
360
360
|
}
|
|
361
361
|
/** @oneof */
|
|
362
|
-
interface DescriptionLineDescriptionLineValueOneOf {
|
|
362
|
+
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
363
363
|
}
|
|
364
|
-
interface DescriptionLineName {
|
|
364
|
+
export interface DescriptionLineName {
|
|
365
365
|
/**
|
|
366
366
|
* 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).
|
|
367
367
|
* @maxLength 100
|
|
@@ -375,7 +375,7 @@ interface DescriptionLineName {
|
|
|
375
375
|
*/
|
|
376
376
|
translated?: string | null;
|
|
377
377
|
}
|
|
378
|
-
interface PlainTextValue {
|
|
378
|
+
export interface PlainTextValue {
|
|
379
379
|
/**
|
|
380
380
|
* 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).
|
|
381
381
|
* @maxLength 600
|
|
@@ -389,7 +389,7 @@ interface PlainTextValue {
|
|
|
389
389
|
*/
|
|
390
390
|
translated?: string | null;
|
|
391
391
|
}
|
|
392
|
-
interface Color {
|
|
392
|
+
export interface Color {
|
|
393
393
|
/**
|
|
394
394
|
* 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).
|
|
395
395
|
* @maxLength 500
|
|
@@ -405,7 +405,7 @@ interface Color {
|
|
|
405
405
|
/** HEX or RGB color code for display. */
|
|
406
406
|
code?: string | null;
|
|
407
407
|
}
|
|
408
|
-
declare enum DescriptionLineType {
|
|
408
|
+
export declare enum DescriptionLineType {
|
|
409
409
|
/** Unrecognized type. */
|
|
410
410
|
UNRECOGNISED = "UNRECOGNISED",
|
|
411
411
|
/** Plain text type. */
|
|
@@ -413,7 +413,30 @@ declare enum DescriptionLineType {
|
|
|
413
413
|
/** Color type. */
|
|
414
414
|
COLOR = "COLOR"
|
|
415
415
|
}
|
|
416
|
-
interface
|
|
416
|
+
export interface Image {
|
|
417
|
+
/** WixMedia image ID. */
|
|
418
|
+
id?: string;
|
|
419
|
+
/** Image URL. */
|
|
420
|
+
url?: string;
|
|
421
|
+
/**
|
|
422
|
+
* Original image height.
|
|
423
|
+
* @readonly
|
|
424
|
+
*/
|
|
425
|
+
height?: number;
|
|
426
|
+
/**
|
|
427
|
+
* Original image width.
|
|
428
|
+
* @readonly
|
|
429
|
+
*/
|
|
430
|
+
width?: number;
|
|
431
|
+
/** Image alt text. */
|
|
432
|
+
altText?: string | null;
|
|
433
|
+
/**
|
|
434
|
+
* Image filename.
|
|
435
|
+
* @readonly
|
|
436
|
+
*/
|
|
437
|
+
filename?: string | null;
|
|
438
|
+
}
|
|
439
|
+
export interface FocalPoint {
|
|
417
440
|
/** X-coordinate of the focal point. */
|
|
418
441
|
x?: number;
|
|
419
442
|
/** Y-coordinate of the focal point. */
|
|
@@ -423,7 +446,7 @@ interface FocalPoint {
|
|
|
423
446
|
/** crop by width */
|
|
424
447
|
width?: number | null;
|
|
425
448
|
}
|
|
426
|
-
interface PhysicalProperties {
|
|
449
|
+
export interface PhysicalProperties {
|
|
427
450
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
428
451
|
weight?: number | null;
|
|
429
452
|
/**
|
|
@@ -434,20 +457,20 @@ interface PhysicalProperties {
|
|
|
434
457
|
/** Whether this line item is shippable. */
|
|
435
458
|
shippable?: boolean;
|
|
436
459
|
}
|
|
437
|
-
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
460
|
+
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
438
461
|
/** Preset item type. */
|
|
439
462
|
preset?: ItemTypeItemType;
|
|
440
463
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
441
464
|
custom?: string;
|
|
442
465
|
}
|
|
443
466
|
/** @oneof */
|
|
444
|
-
interface ItemTypeItemTypeDataOneOf {
|
|
467
|
+
export interface ItemTypeItemTypeDataOneOf {
|
|
445
468
|
/** Preset item type. */
|
|
446
469
|
preset?: ItemTypeItemType;
|
|
447
470
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
448
471
|
custom?: string;
|
|
449
472
|
}
|
|
450
|
-
declare enum ItemTypeItemType {
|
|
473
|
+
export declare enum ItemTypeItemType {
|
|
451
474
|
UNRECOGNISED = "UNRECOGNISED",
|
|
452
475
|
PHYSICAL = "PHYSICAL",
|
|
453
476
|
DIGITAL = "DIGITAL",
|
|
@@ -455,7 +478,7 @@ declare enum ItemTypeItemType {
|
|
|
455
478
|
SERVICE = "SERVICE"
|
|
456
479
|
}
|
|
457
480
|
/** Type of selected payment option for catalog item */
|
|
458
|
-
declare enum PaymentOptionType {
|
|
481
|
+
export declare enum PaymentOptionType {
|
|
459
482
|
/** The entire payment for this item happens as part of the checkout. */
|
|
460
483
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
461
484
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -467,7 +490,7 @@ declare enum PaymentOptionType {
|
|
|
467
490
|
/** 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`. */
|
|
468
491
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
469
492
|
}
|
|
470
|
-
interface ItemTaxFullDetails {
|
|
493
|
+
export interface ItemTaxFullDetails {
|
|
471
494
|
/** Taxable amount of this line item. */
|
|
472
495
|
taxableAmount?: Price;
|
|
473
496
|
/**
|
|
@@ -478,7 +501,7 @@ interface ItemTaxFullDetails {
|
|
|
478
501
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
479
502
|
totalTax?: Price;
|
|
480
503
|
}
|
|
481
|
-
interface LineItemTaxInfo {
|
|
504
|
+
export interface LineItemTaxInfo {
|
|
482
505
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
483
506
|
taxAmount?: Price;
|
|
484
507
|
/** Amount for which tax is calculated. */
|
|
@@ -506,7 +529,7 @@ interface LineItemTaxInfo {
|
|
|
506
529
|
* TaxBreakdown represents tax information for a line item.
|
|
507
530
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
508
531
|
*/
|
|
509
|
-
interface LineItemTaxBreakdown {
|
|
532
|
+
export interface LineItemTaxBreakdown {
|
|
510
533
|
/**
|
|
511
534
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
512
535
|
* @maxLength 200
|
|
@@ -539,7 +562,7 @@ interface LineItemTaxBreakdown {
|
|
|
539
562
|
taxableAmount?: Price;
|
|
540
563
|
}
|
|
541
564
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
542
|
-
declare enum JurisdictionType {
|
|
565
|
+
export declare enum JurisdictionType {
|
|
543
566
|
UNDEFINED = "UNDEFINED",
|
|
544
567
|
COUNTRY = "COUNTRY",
|
|
545
568
|
STATE = "STATE",
|
|
@@ -547,7 +570,7 @@ declare enum JurisdictionType {
|
|
|
547
570
|
CITY = "CITY",
|
|
548
571
|
SPECIAL = "SPECIAL"
|
|
549
572
|
}
|
|
550
|
-
interface DigitalFile {
|
|
573
|
+
export interface DigitalFile {
|
|
551
574
|
/**
|
|
552
575
|
* ID of the secure file in media.
|
|
553
576
|
* @minLength 1
|
|
@@ -567,12 +590,12 @@ interface DigitalFile {
|
|
|
567
590
|
*/
|
|
568
591
|
expirationDate?: Date | null;
|
|
569
592
|
}
|
|
570
|
-
interface SubscriptionInfo {
|
|
593
|
+
export interface SubscriptionInfo {
|
|
571
594
|
/**
|
|
572
595
|
* Subscription ID.
|
|
573
596
|
* @format GUID
|
|
574
597
|
*/
|
|
575
|
-
|
|
598
|
+
id?: string | null;
|
|
576
599
|
/**
|
|
577
600
|
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
578
601
|
* @min 1
|
|
@@ -600,7 +623,7 @@ interface SubscriptionInfo {
|
|
|
600
623
|
*/
|
|
601
624
|
subscriptionSettings?: SubscriptionSettings;
|
|
602
625
|
}
|
|
603
|
-
interface SubscriptionTitle {
|
|
626
|
+
export interface SubscriptionTitle {
|
|
604
627
|
/**
|
|
605
628
|
* 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).
|
|
606
629
|
* @minLength 1
|
|
@@ -616,7 +639,7 @@ interface SubscriptionTitle {
|
|
|
616
639
|
*/
|
|
617
640
|
translated?: string | null;
|
|
618
641
|
}
|
|
619
|
-
interface SubscriptionDescription {
|
|
642
|
+
export interface SubscriptionDescription {
|
|
620
643
|
/**
|
|
621
644
|
* Subscription option description.
|
|
622
645
|
* @maxLength 500
|
|
@@ -628,7 +651,7 @@ interface SubscriptionDescription {
|
|
|
628
651
|
*/
|
|
629
652
|
translated?: string | null;
|
|
630
653
|
}
|
|
631
|
-
interface SubscriptionSettings {
|
|
654
|
+
export interface SubscriptionSettings {
|
|
632
655
|
/** Frequency of recurring payment. */
|
|
633
656
|
frequency?: SubscriptionFrequency;
|
|
634
657
|
/**
|
|
@@ -646,14 +669,14 @@ interface SubscriptionSettings {
|
|
|
646
669
|
billingCycles?: number | null;
|
|
647
670
|
}
|
|
648
671
|
/** Frequency unit of recurring payment */
|
|
649
|
-
declare enum SubscriptionFrequency {
|
|
672
|
+
export declare enum SubscriptionFrequency {
|
|
650
673
|
UNDEFINED = "UNDEFINED",
|
|
651
674
|
DAY = "DAY",
|
|
652
675
|
WEEK = "WEEK",
|
|
653
676
|
MONTH = "MONTH",
|
|
654
677
|
YEAR = "YEAR"
|
|
655
678
|
}
|
|
656
|
-
interface FreeTrialPeriod {
|
|
679
|
+
export interface FreeTrialPeriod {
|
|
657
680
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
658
681
|
frequency?: SubscriptionFrequency;
|
|
659
682
|
/**
|
|
@@ -663,20 +686,20 @@ interface FreeTrialPeriod {
|
|
|
663
686
|
*/
|
|
664
687
|
interval?: number;
|
|
665
688
|
}
|
|
666
|
-
interface BillingAdjustment {
|
|
689
|
+
export interface BillingAdjustment {
|
|
667
690
|
/** The type of adjustment. */
|
|
668
691
|
type?: AdjustmentType;
|
|
669
692
|
/** Summary of the prorated adjustment amount. */
|
|
670
693
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
671
694
|
}
|
|
672
|
-
declare enum AdjustmentType {
|
|
695
|
+
export declare enum AdjustmentType {
|
|
673
696
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
674
697
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
675
698
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
676
699
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
677
700
|
CREDIT = "CREDIT"
|
|
678
701
|
}
|
|
679
|
-
interface BillingAdjustmentPriceSummary {
|
|
702
|
+
export interface BillingAdjustmentPriceSummary {
|
|
680
703
|
/** Subtotal of adjustment, before tax. */
|
|
681
704
|
subtotal?: Price;
|
|
682
705
|
/** Tax on adjustment. */
|
|
@@ -684,7 +707,7 @@ interface BillingAdjustmentPriceSummary {
|
|
|
684
707
|
/** Total price after tax. */
|
|
685
708
|
total?: Price;
|
|
686
709
|
}
|
|
687
|
-
interface PriceDescription {
|
|
710
|
+
export interface PriceDescription {
|
|
688
711
|
/**
|
|
689
712
|
* __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).
|
|
690
713
|
* @minLength 1
|
|
@@ -700,12 +723,12 @@ interface PriceDescription {
|
|
|
700
723
|
*/
|
|
701
724
|
translated?: string | null;
|
|
702
725
|
}
|
|
703
|
-
interface LocationAndQuantity {
|
|
726
|
+
export interface LocationAndQuantity {
|
|
704
727
|
/**
|
|
705
728
|
* Location id in the associated owner app.
|
|
706
729
|
* @format GUID
|
|
707
730
|
*/
|
|
708
|
-
|
|
731
|
+
id?: string;
|
|
709
732
|
/**
|
|
710
733
|
* Location owner app, if not provided then the site business info locations will be used.
|
|
711
734
|
* @format GUID
|
|
@@ -726,22 +749,22 @@ interface LocationAndQuantity {
|
|
|
726
749
|
*/
|
|
727
750
|
name?: string | null;
|
|
728
751
|
}
|
|
729
|
-
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
752
|
+
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
730
753
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
731
754
|
addressType?: TaxableAddressType;
|
|
732
755
|
}
|
|
733
756
|
/** @oneof */
|
|
734
|
-
interface TaxableAddressTaxableAddressDataOneOf {
|
|
757
|
+
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
735
758
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
736
759
|
addressType?: TaxableAddressType;
|
|
737
760
|
}
|
|
738
|
-
declare enum TaxableAddressType {
|
|
761
|
+
export declare enum TaxableAddressType {
|
|
739
762
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
740
763
|
BUSINESS = "BUSINESS",
|
|
741
764
|
BILLING = "BILLING",
|
|
742
765
|
SHIPPING = "SHIPPING"
|
|
743
766
|
}
|
|
744
|
-
interface ExtendedFields {
|
|
767
|
+
export interface ExtendedFields {
|
|
745
768
|
/**
|
|
746
769
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
747
770
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -753,7 +776,7 @@ interface ExtendedFields {
|
|
|
753
776
|
namespaces?: Record<string, Record<string, any>>;
|
|
754
777
|
}
|
|
755
778
|
/** Buyer Info */
|
|
756
|
-
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
779
|
+
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
757
780
|
/**
|
|
758
781
|
* Visitor ID (if site visitor is not a member).
|
|
759
782
|
* @format GUID
|
|
@@ -765,7 +788,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
765
788
|
*/
|
|
766
789
|
memberId?: string;
|
|
767
790
|
/**
|
|
768
|
-
* Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://
|
|
791
|
+
* Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
|
|
769
792
|
* @format GUID
|
|
770
793
|
*/
|
|
771
794
|
contactId?: string | null;
|
|
@@ -776,7 +799,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
776
799
|
email?: string | null;
|
|
777
800
|
}
|
|
778
801
|
/** @oneof */
|
|
779
|
-
interface BuyerInfoIdOneOf {
|
|
802
|
+
export interface BuyerInfoIdOneOf {
|
|
780
803
|
/**
|
|
781
804
|
* Visitor ID (if site visitor is not a member).
|
|
782
805
|
* @format GUID
|
|
@@ -788,7 +811,7 @@ interface BuyerInfoIdOneOf {
|
|
|
788
811
|
*/
|
|
789
812
|
memberId?: string;
|
|
790
813
|
}
|
|
791
|
-
declare enum PaymentStatus {
|
|
814
|
+
export declare enum PaymentStatus {
|
|
792
815
|
UNSPECIFIED = "UNSPECIFIED",
|
|
793
816
|
/**
|
|
794
817
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -829,7 +852,7 @@ declare enum PaymentStatus {
|
|
|
829
852
|
*/
|
|
830
853
|
DECLINED = "DECLINED"
|
|
831
854
|
}
|
|
832
|
-
declare enum FulfillmentStatus {
|
|
855
|
+
export declare enum FulfillmentStatus {
|
|
833
856
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
834
857
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
835
858
|
/**
|
|
@@ -840,7 +863,7 @@ declare enum FulfillmentStatus {
|
|
|
840
863
|
/** Some, but not all, of the order items are fulfilled. */
|
|
841
864
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
842
865
|
}
|
|
843
|
-
declare enum WeightUnit {
|
|
866
|
+
export declare enum WeightUnit {
|
|
844
867
|
/** Weight unit can't be classified due to an error. */
|
|
845
868
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
846
869
|
/** Kilograms. */
|
|
@@ -848,7 +871,7 @@ declare enum WeightUnit {
|
|
|
848
871
|
/** Pounds. */
|
|
849
872
|
LB = "LB"
|
|
850
873
|
}
|
|
851
|
-
interface CurrencyConversionDetails {
|
|
874
|
+
export interface CurrencyConversionDetails {
|
|
852
875
|
/**
|
|
853
876
|
* 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.
|
|
854
877
|
* @readonly
|
|
@@ -864,7 +887,7 @@ interface CurrencyConversionDetails {
|
|
|
864
887
|
*/
|
|
865
888
|
conversionRate?: string | null;
|
|
866
889
|
}
|
|
867
|
-
interface PriceSummary {
|
|
890
|
+
export interface PriceSummary {
|
|
868
891
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
869
892
|
subtotal?: Price;
|
|
870
893
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -879,14 +902,14 @@ interface PriceSummary {
|
|
|
879
902
|
totalAdditionalFees?: Price;
|
|
880
903
|
}
|
|
881
904
|
/** Billing Info and shipping details */
|
|
882
|
-
interface AddressWithContact {
|
|
905
|
+
export interface AddressWithContact {
|
|
883
906
|
/** Address. */
|
|
884
907
|
address?: Address;
|
|
885
908
|
/** Contact details. */
|
|
886
909
|
contactDetails?: FullAddressContactDetails;
|
|
887
910
|
}
|
|
888
911
|
/** Physical address */
|
|
889
|
-
interface Address {
|
|
912
|
+
export interface Address {
|
|
890
913
|
/**
|
|
891
914
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
892
915
|
* @format COUNTRY
|
|
@@ -913,7 +936,7 @@ interface Address {
|
|
|
913
936
|
* Main address line (usually street name and number).
|
|
914
937
|
* @maxLength 150
|
|
915
938
|
*/
|
|
916
|
-
|
|
939
|
+
addressLine?: string | null;
|
|
917
940
|
/**
|
|
918
941
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
919
942
|
* @maxLength 100
|
|
@@ -930,20 +953,20 @@ interface Address {
|
|
|
930
953
|
*/
|
|
931
954
|
subdivisionFullname?: string | null;
|
|
932
955
|
}
|
|
933
|
-
interface StreetAddress {
|
|
956
|
+
export interface StreetAddress {
|
|
934
957
|
/** Street number. */
|
|
935
958
|
number?: string;
|
|
936
959
|
/** Street name. */
|
|
937
960
|
name?: string;
|
|
938
961
|
}
|
|
939
|
-
interface AddressLocation {
|
|
962
|
+
export interface AddressLocation {
|
|
940
963
|
/** Address latitude. */
|
|
941
964
|
latitude?: number | null;
|
|
942
965
|
/** Address longitude. */
|
|
943
966
|
longitude?: number | null;
|
|
944
967
|
}
|
|
945
968
|
/** Full contact details for an address */
|
|
946
|
-
interface FullAddressContactDetails {
|
|
969
|
+
export interface FullAddressContactDetails {
|
|
947
970
|
/**
|
|
948
971
|
* First name.
|
|
949
972
|
* @maxLength 100
|
|
@@ -967,9 +990,9 @@ interface FullAddressContactDetails {
|
|
|
967
990
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
968
991
|
vatId?: VatId;
|
|
969
992
|
}
|
|
970
|
-
interface VatId {
|
|
993
|
+
export interface VatId {
|
|
971
994
|
/** Customer's tax ID. */
|
|
972
|
-
|
|
995
|
+
id?: string;
|
|
973
996
|
/**
|
|
974
997
|
* Tax type.
|
|
975
998
|
*
|
|
@@ -980,14 +1003,14 @@ interface VatId {
|
|
|
980
1003
|
type?: VatType;
|
|
981
1004
|
}
|
|
982
1005
|
/** tax info types */
|
|
983
|
-
declare enum VatType {
|
|
1006
|
+
export declare enum VatType {
|
|
984
1007
|
UNSPECIFIED = "UNSPECIFIED",
|
|
985
1008
|
/** CPF - for individual tax payers. */
|
|
986
1009
|
CPF = "CPF",
|
|
987
1010
|
/** CNPJ - for corporations */
|
|
988
1011
|
CNPJ = "CNPJ"
|
|
989
1012
|
}
|
|
990
|
-
interface V1ShippingInformation {
|
|
1013
|
+
export interface V1ShippingInformation {
|
|
991
1014
|
/**
|
|
992
1015
|
* App Def Id of external provider which was a source of shipping info
|
|
993
1016
|
* @minLength 1
|
|
@@ -1013,7 +1036,7 @@ interface V1ShippingInformation {
|
|
|
1013
1036
|
/** Shipping region. */
|
|
1014
1037
|
region?: ShippingRegion;
|
|
1015
1038
|
}
|
|
1016
|
-
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1039
|
+
export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1017
1040
|
/** Shipping address and contact details. */
|
|
1018
1041
|
shippingDestination?: AddressWithContact;
|
|
1019
1042
|
/** Pickup details. */
|
|
@@ -1037,20 +1060,20 @@ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
1037
1060
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1038
1061
|
}
|
|
1039
1062
|
/** @oneof */
|
|
1040
|
-
interface DeliveryLogisticsAddressOneOf {
|
|
1063
|
+
export interface DeliveryLogisticsAddressOneOf {
|
|
1041
1064
|
/** Shipping address and contact details. */
|
|
1042
1065
|
shippingDestination?: AddressWithContact;
|
|
1043
1066
|
/** Pickup details. */
|
|
1044
1067
|
pickupDetails?: PickupDetails;
|
|
1045
1068
|
}
|
|
1046
|
-
interface PickupDetails {
|
|
1069
|
+
export interface PickupDetails {
|
|
1047
1070
|
/** Pickup address. */
|
|
1048
1071
|
address?: PickupAddress;
|
|
1049
1072
|
/** Pickup method */
|
|
1050
1073
|
pickupMethod?: PickupMethod;
|
|
1051
1074
|
}
|
|
1052
1075
|
/** Physical address */
|
|
1053
|
-
interface PickupAddress {
|
|
1076
|
+
export interface PickupAddress {
|
|
1054
1077
|
/**
|
|
1055
1078
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1056
1079
|
* @format COUNTRY
|
|
@@ -1077,7 +1100,7 @@ interface PickupAddress {
|
|
|
1077
1100
|
* Main address line (usually street name and number).
|
|
1078
1101
|
* @maxLength 1000
|
|
1079
1102
|
*/
|
|
1080
|
-
|
|
1103
|
+
addressLine?: string | null;
|
|
1081
1104
|
/**
|
|
1082
1105
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
1083
1106
|
* @maxLength 1000
|
|
@@ -1094,18 +1117,18 @@ interface PickupAddress {
|
|
|
1094
1117
|
*/
|
|
1095
1118
|
subdivisionFullname?: string | null;
|
|
1096
1119
|
}
|
|
1097
|
-
declare enum PickupMethod {
|
|
1120
|
+
export declare enum PickupMethod {
|
|
1098
1121
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1099
1122
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1100
1123
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1101
1124
|
}
|
|
1102
|
-
interface DeliveryTimeSlot {
|
|
1125
|
+
export interface DeliveryTimeSlot {
|
|
1103
1126
|
/** Delivery slot starting time. */
|
|
1104
1127
|
from?: Date | null;
|
|
1105
1128
|
/** Delivery slot ending time. */
|
|
1106
1129
|
to?: Date | null;
|
|
1107
1130
|
}
|
|
1108
|
-
interface ShippingPrice {
|
|
1131
|
+
export interface ShippingPrice {
|
|
1109
1132
|
/** Shipping price for display purposes. */
|
|
1110
1133
|
price?: Price;
|
|
1111
1134
|
/**
|
|
@@ -1126,14 +1149,14 @@ interface ShippingPrice {
|
|
|
1126
1149
|
*/
|
|
1127
1150
|
discount?: Price;
|
|
1128
1151
|
}
|
|
1129
|
-
interface ShippingRegion {
|
|
1152
|
+
export interface ShippingRegion {
|
|
1130
1153
|
/**
|
|
1131
1154
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1132
1155
|
* @maxLength 100
|
|
1133
1156
|
*/
|
|
1134
1157
|
name?: string | null;
|
|
1135
1158
|
}
|
|
1136
|
-
declare enum OrderStatus {
|
|
1159
|
+
export declare enum OrderStatus {
|
|
1137
1160
|
/** Order created, but not yet approved or canceled. */
|
|
1138
1161
|
INITIALIZED = "INITIALIZED",
|
|
1139
1162
|
/**
|
|
@@ -1158,14 +1181,14 @@ declare enum OrderStatus {
|
|
|
1158
1181
|
*/
|
|
1159
1182
|
REJECTED = "REJECTED"
|
|
1160
1183
|
}
|
|
1161
|
-
interface TaxSummary {
|
|
1184
|
+
export interface TaxSummary {
|
|
1162
1185
|
/**
|
|
1163
1186
|
* Total tax.
|
|
1164
1187
|
* @readonly
|
|
1165
1188
|
*/
|
|
1166
1189
|
totalTax?: Price;
|
|
1167
1190
|
}
|
|
1168
|
-
interface OrderTaxInfo {
|
|
1191
|
+
export interface OrderTaxInfo {
|
|
1169
1192
|
/** Calculated tax, added from line items. */
|
|
1170
1193
|
totalTax?: Price;
|
|
1171
1194
|
/**
|
|
@@ -1185,7 +1208,7 @@ interface OrderTaxInfo {
|
|
|
1185
1208
|
* 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.
|
|
1186
1209
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1187
1210
|
*/
|
|
1188
|
-
interface OrderTaxBreakdown {
|
|
1211
|
+
export interface OrderTaxBreakdown {
|
|
1189
1212
|
/**
|
|
1190
1213
|
* The name of the tax against which this tax amount was calculated.
|
|
1191
1214
|
* @maxLength 200
|
|
@@ -1212,7 +1235,7 @@ interface OrderTaxBreakdown {
|
|
|
1212
1235
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1213
1236
|
aggregatedTaxAmount?: Price;
|
|
1214
1237
|
}
|
|
1215
|
-
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1238
|
+
export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1216
1239
|
/** Applied coupon info. */
|
|
1217
1240
|
coupon?: Coupon;
|
|
1218
1241
|
/** Merchant discount. */
|
|
@@ -1242,10 +1265,10 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1242
1265
|
* @format GUID
|
|
1243
1266
|
* @immutable
|
|
1244
1267
|
*/
|
|
1245
|
-
|
|
1268
|
+
id?: string | null;
|
|
1246
1269
|
}
|
|
1247
1270
|
/** @oneof */
|
|
1248
|
-
interface AppliedDiscountDiscountSourceOneOf {
|
|
1271
|
+
export interface AppliedDiscountDiscountSourceOneOf {
|
|
1249
1272
|
/** Applied coupon info. */
|
|
1250
1273
|
coupon?: Coupon;
|
|
1251
1274
|
/** Merchant discount. */
|
|
@@ -1253,15 +1276,15 @@ interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1253
1276
|
/** Automatic Discount */
|
|
1254
1277
|
discountRule?: DiscountRule;
|
|
1255
1278
|
}
|
|
1256
|
-
declare enum DiscountType {
|
|
1279
|
+
export declare enum DiscountType {
|
|
1257
1280
|
GLOBAL = "GLOBAL",
|
|
1258
1281
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1259
1282
|
SHIPPING = "SHIPPING"
|
|
1260
1283
|
}
|
|
1261
1284
|
/** Coupon */
|
|
1262
|
-
interface Coupon {
|
|
1285
|
+
export interface Coupon {
|
|
1263
1286
|
/** Coupon ID. */
|
|
1264
|
-
|
|
1287
|
+
id?: string;
|
|
1265
1288
|
/** Coupon code. */
|
|
1266
1289
|
code?: string;
|
|
1267
1290
|
/** Coupon name. */
|
|
@@ -1269,7 +1292,7 @@ interface Coupon {
|
|
|
1269
1292
|
/** Coupon value. */
|
|
1270
1293
|
amount?: Price;
|
|
1271
1294
|
}
|
|
1272
|
-
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1295
|
+
export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1273
1296
|
/**
|
|
1274
1297
|
* Pre-defined discount reason (optional).
|
|
1275
1298
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1284,7 +1307,7 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1284
1307
|
amount?: Price;
|
|
1285
1308
|
}
|
|
1286
1309
|
/** @oneof */
|
|
1287
|
-
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1310
|
+
export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1288
1311
|
/**
|
|
1289
1312
|
* Pre-defined discount reason (optional).
|
|
1290
1313
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1296,23 +1319,23 @@ interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1296
1319
|
*/
|
|
1297
1320
|
description?: string | null;
|
|
1298
1321
|
}
|
|
1299
|
-
declare enum DiscountReason {
|
|
1322
|
+
export declare enum DiscountReason {
|
|
1300
1323
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1301
1324
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1302
1325
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1303
1326
|
}
|
|
1304
|
-
interface DiscountRule {
|
|
1327
|
+
export interface DiscountRule {
|
|
1305
1328
|
/**
|
|
1306
1329
|
* Discount rule ID
|
|
1307
1330
|
* @format GUID
|
|
1308
1331
|
*/
|
|
1309
|
-
|
|
1332
|
+
id?: string;
|
|
1310
1333
|
/** Discount rule name */
|
|
1311
1334
|
name?: DiscountRuleName;
|
|
1312
1335
|
/** Discount value. */
|
|
1313
1336
|
amount?: Price;
|
|
1314
1337
|
}
|
|
1315
|
-
interface DiscountRuleName {
|
|
1338
|
+
export interface DiscountRuleName {
|
|
1316
1339
|
/**
|
|
1317
1340
|
* Original discount rule name (in site's default language).
|
|
1318
1341
|
* @minLength 1
|
|
@@ -1326,16 +1349,16 @@ interface DiscountRuleName {
|
|
|
1326
1349
|
*/
|
|
1327
1350
|
translated?: string | null;
|
|
1328
1351
|
}
|
|
1329
|
-
interface LineItemDiscount {
|
|
1352
|
+
export interface LineItemDiscount {
|
|
1330
1353
|
/**
|
|
1331
1354
|
* ID of line item the discount applies to.
|
|
1332
1355
|
* @format GUID
|
|
1333
1356
|
*/
|
|
1334
|
-
|
|
1357
|
+
id?: string;
|
|
1335
1358
|
/** Total discount for this line item. */
|
|
1336
1359
|
totalDiscount?: Price;
|
|
1337
1360
|
}
|
|
1338
|
-
interface Activity extends ActivityContentOneOf {
|
|
1361
|
+
export interface Activity extends ActivityContentOneOf {
|
|
1339
1362
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1340
1363
|
customActivity?: CustomActivity;
|
|
1341
1364
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -1347,7 +1370,7 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1347
1370
|
* @format GUID
|
|
1348
1371
|
* @readonly
|
|
1349
1372
|
*/
|
|
1350
|
-
|
|
1373
|
+
id?: string | null;
|
|
1351
1374
|
/**
|
|
1352
1375
|
* Activity author's email.
|
|
1353
1376
|
* @format EMAIL
|
|
@@ -1358,12 +1381,12 @@ interface Activity extends ActivityContentOneOf {
|
|
|
1358
1381
|
* Activity creation date and time.
|
|
1359
1382
|
* @readonly
|
|
1360
1383
|
*/
|
|
1361
|
-
|
|
1384
|
+
createdDate?: Date | null;
|
|
1362
1385
|
/** Activity type. */
|
|
1363
1386
|
type?: ActivityType;
|
|
1364
1387
|
}
|
|
1365
1388
|
/** @oneof */
|
|
1366
|
-
interface ActivityContentOneOf {
|
|
1389
|
+
export interface ActivityContentOneOf {
|
|
1367
1390
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1368
1391
|
customActivity?: CustomActivity;
|
|
1369
1392
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -1371,7 +1394,7 @@ interface ActivityContentOneOf {
|
|
|
1371
1394
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1372
1395
|
orderRefunded?: OrderRefunded;
|
|
1373
1396
|
}
|
|
1374
|
-
interface CustomActivity {
|
|
1397
|
+
export interface CustomActivity {
|
|
1375
1398
|
/**
|
|
1376
1399
|
* ID of the app that created the custom activity.
|
|
1377
1400
|
* @format GUID
|
|
@@ -1386,7 +1409,7 @@ interface CustomActivity {
|
|
|
1386
1409
|
additionalData?: Record<string, string>;
|
|
1387
1410
|
}
|
|
1388
1411
|
/** Store owner added a comment */
|
|
1389
|
-
interface MerchantComment {
|
|
1412
|
+
export interface MerchantComment {
|
|
1390
1413
|
/**
|
|
1391
1414
|
* Merchant comment message.
|
|
1392
1415
|
* @minLength 1
|
|
@@ -1394,7 +1417,7 @@ interface MerchantComment {
|
|
|
1394
1417
|
*/
|
|
1395
1418
|
message?: string;
|
|
1396
1419
|
}
|
|
1397
|
-
interface OrderRefunded {
|
|
1420
|
+
export interface OrderRefunded {
|
|
1398
1421
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
1399
1422
|
manual?: boolean;
|
|
1400
1423
|
/** Refund amount. */
|
|
@@ -1405,14 +1428,14 @@ interface OrderRefunded {
|
|
|
1405
1428
|
*/
|
|
1406
1429
|
reason?: string;
|
|
1407
1430
|
}
|
|
1408
|
-
interface OrderCreatedFromExchange {
|
|
1431
|
+
export interface OrderCreatedFromExchange {
|
|
1409
1432
|
/**
|
|
1410
1433
|
* ID of the original order for which the exchange happened.
|
|
1411
1434
|
* @format GUID
|
|
1412
1435
|
*/
|
|
1413
1436
|
originalOrderId?: string;
|
|
1414
1437
|
}
|
|
1415
|
-
interface NewExchangeOrderCreated {
|
|
1438
|
+
export interface NewExchangeOrderCreated {
|
|
1416
1439
|
/**
|
|
1417
1440
|
* ID of the new order created as a result of an exchange of items.
|
|
1418
1441
|
* @format GUID
|
|
@@ -1425,7 +1448,7 @@ interface NewExchangeOrderCreated {
|
|
|
1425
1448
|
*/
|
|
1426
1449
|
lineItems?: LineItemExchangeData[];
|
|
1427
1450
|
}
|
|
1428
|
-
interface LineItemExchangeData {
|
|
1451
|
+
export interface LineItemExchangeData {
|
|
1429
1452
|
/**
|
|
1430
1453
|
* ID of the exchanged line item.
|
|
1431
1454
|
* @format GUID
|
|
@@ -1438,7 +1461,7 @@ interface LineItemExchangeData {
|
|
|
1438
1461
|
*/
|
|
1439
1462
|
quantity?: number;
|
|
1440
1463
|
}
|
|
1441
|
-
interface DraftOrderChangesApplied {
|
|
1464
|
+
export interface DraftOrderChangesApplied {
|
|
1442
1465
|
/** Draft order id. */
|
|
1443
1466
|
draftOrderId?: string;
|
|
1444
1467
|
/**
|
|
@@ -1449,7 +1472,7 @@ interface DraftOrderChangesApplied {
|
|
|
1449
1472
|
/** Changes applied to order. */
|
|
1450
1473
|
changes?: OrderChange[];
|
|
1451
1474
|
}
|
|
1452
|
-
interface OrderChange extends OrderChangeValueOneOf {
|
|
1475
|
+
export interface OrderChange extends OrderChangeValueOneOf {
|
|
1453
1476
|
lineItemChanged?: LineItemChanges;
|
|
1454
1477
|
lineItemAdded?: ManagedLineItem;
|
|
1455
1478
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -1461,7 +1484,7 @@ interface OrderChange extends OrderChangeValueOneOf {
|
|
|
1461
1484
|
shippingInformationChanged?: ShippingInformationChange;
|
|
1462
1485
|
}
|
|
1463
1486
|
/** @oneof */
|
|
1464
|
-
interface OrderChangeValueOneOf {
|
|
1487
|
+
export interface OrderChangeValueOneOf {
|
|
1465
1488
|
lineItemChanged?: LineItemChanges;
|
|
1466
1489
|
lineItemAdded?: ManagedLineItem;
|
|
1467
1490
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -1472,12 +1495,12 @@ interface OrderChangeValueOneOf {
|
|
|
1472
1495
|
totalPriceChanged?: TotalPriceChange;
|
|
1473
1496
|
shippingInformationChanged?: ShippingInformationChange;
|
|
1474
1497
|
}
|
|
1475
|
-
interface LineItemChanges {
|
|
1498
|
+
export interface LineItemChanges {
|
|
1476
1499
|
/**
|
|
1477
1500
|
* Line item ID.
|
|
1478
1501
|
* @format GUID
|
|
1479
1502
|
*/
|
|
1480
|
-
|
|
1503
|
+
id?: string;
|
|
1481
1504
|
/** Item name. */
|
|
1482
1505
|
name?: ProductName;
|
|
1483
1506
|
/** Item quantity change. */
|
|
@@ -1485,7 +1508,7 @@ interface LineItemChanges {
|
|
|
1485
1508
|
/** Item price change. */
|
|
1486
1509
|
price?: LineItemPriceChange;
|
|
1487
1510
|
}
|
|
1488
|
-
interface LineItemQuantityChange {
|
|
1511
|
+
export interface LineItemQuantityChange {
|
|
1489
1512
|
/**
|
|
1490
1513
|
* Item quantity before update.
|
|
1491
1514
|
* @max 1000000
|
|
@@ -1505,24 +1528,24 @@ interface LineItemQuantityChange {
|
|
|
1505
1528
|
/** Type of quantity change: increase or decrease. */
|
|
1506
1529
|
deltaType?: LineItemQuantityChangeType;
|
|
1507
1530
|
}
|
|
1508
|
-
declare enum LineItemQuantityChangeType {
|
|
1531
|
+
export declare enum LineItemQuantityChangeType {
|
|
1509
1532
|
/** Quantity increased. */
|
|
1510
1533
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
1511
1534
|
/** Quantity decreased. */
|
|
1512
1535
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
1513
1536
|
}
|
|
1514
|
-
interface LineItemPriceChange {
|
|
1537
|
+
export interface LineItemPriceChange {
|
|
1515
1538
|
/** Item price before update. */
|
|
1516
1539
|
originalPrice?: Price;
|
|
1517
1540
|
/** Item price after update. */
|
|
1518
1541
|
newPrice?: Price;
|
|
1519
1542
|
}
|
|
1520
|
-
interface ManagedLineItem {
|
|
1543
|
+
export interface ManagedLineItem {
|
|
1521
1544
|
/**
|
|
1522
1545
|
* Line item ID.
|
|
1523
1546
|
* @format GUID
|
|
1524
1547
|
*/
|
|
1525
|
-
|
|
1548
|
+
id?: string;
|
|
1526
1549
|
/** Item name. */
|
|
1527
1550
|
name?: ProductName;
|
|
1528
1551
|
/**
|
|
@@ -1532,12 +1555,12 @@ interface ManagedLineItem {
|
|
|
1532
1555
|
*/
|
|
1533
1556
|
quantity?: number;
|
|
1534
1557
|
}
|
|
1535
|
-
interface ManagedDiscount {
|
|
1558
|
+
export interface ManagedDiscount {
|
|
1536
1559
|
/**
|
|
1537
1560
|
* Discount id.
|
|
1538
1561
|
* @format GUID
|
|
1539
1562
|
*/
|
|
1540
|
-
|
|
1563
|
+
id?: string;
|
|
1541
1564
|
/** Discount name: coupon name / discount rule name / merchant discount description. */
|
|
1542
1565
|
name?: TranslatedValue;
|
|
1543
1566
|
/** Line items discount applies to. */
|
|
@@ -1545,7 +1568,7 @@ interface ManagedDiscount {
|
|
|
1545
1568
|
/** Discount amount. */
|
|
1546
1569
|
totalAmount?: Price;
|
|
1547
1570
|
}
|
|
1548
|
-
interface TranslatedValue {
|
|
1571
|
+
export interface TranslatedValue {
|
|
1549
1572
|
/**
|
|
1550
1573
|
* Value in site default language.
|
|
1551
1574
|
* @minLength 1
|
|
@@ -1557,23 +1580,23 @@ interface TranslatedValue {
|
|
|
1557
1580
|
*/
|
|
1558
1581
|
translated?: string | null;
|
|
1559
1582
|
}
|
|
1560
|
-
interface LineItemAmount {
|
|
1583
|
+
export interface LineItemAmount {
|
|
1561
1584
|
/**
|
|
1562
1585
|
* Order line item id
|
|
1563
1586
|
* @format GUID
|
|
1564
1587
|
*/
|
|
1565
|
-
|
|
1588
|
+
id?: string;
|
|
1566
1589
|
/** Item name. */
|
|
1567
1590
|
name?: ProductName;
|
|
1568
1591
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
1569
1592
|
amount?: Price;
|
|
1570
1593
|
}
|
|
1571
|
-
interface ManagedAdditionalFee {
|
|
1594
|
+
export interface ManagedAdditionalFee {
|
|
1572
1595
|
/**
|
|
1573
1596
|
* Additional fee id.
|
|
1574
1597
|
* @format GUID
|
|
1575
1598
|
*/
|
|
1576
|
-
|
|
1599
|
+
id?: string;
|
|
1577
1600
|
/** Additional fee name. */
|
|
1578
1601
|
name?: TranslatedValue;
|
|
1579
1602
|
/** Line items additional fee applies to. */
|
|
@@ -1581,19 +1604,19 @@ interface ManagedAdditionalFee {
|
|
|
1581
1604
|
/** Additional fee amount. */
|
|
1582
1605
|
totalAmount?: Price;
|
|
1583
1606
|
}
|
|
1584
|
-
interface TotalPriceChange {
|
|
1607
|
+
export interface TotalPriceChange {
|
|
1585
1608
|
/** Order’s total price after discounts and tax. Before update */
|
|
1586
1609
|
originalTotal?: Price;
|
|
1587
1610
|
/** Order’s total price after discounts and tax. After update */
|
|
1588
1611
|
newTotal?: Price;
|
|
1589
1612
|
}
|
|
1590
|
-
interface ShippingInformationChange {
|
|
1613
|
+
export interface ShippingInformationChange {
|
|
1591
1614
|
/** Order’s Shipping Information. Before update */
|
|
1592
1615
|
originalShippingInfo?: ShippingInformation;
|
|
1593
1616
|
/** Order’s Shipping Information. After update */
|
|
1594
1617
|
newShippingInfo?: ShippingInformation;
|
|
1595
1618
|
}
|
|
1596
|
-
interface ShippingInformation {
|
|
1619
|
+
export interface ShippingInformation {
|
|
1597
1620
|
/** Order’s shipping price. */
|
|
1598
1621
|
total?: Price;
|
|
1599
1622
|
/**
|
|
@@ -1603,7 +1626,7 @@ interface ShippingInformation {
|
|
|
1603
1626
|
shippingTitle?: string;
|
|
1604
1627
|
}
|
|
1605
1628
|
/** Payment method is saved for order */
|
|
1606
|
-
interface SavedPaymentMethod {
|
|
1629
|
+
export interface SavedPaymentMethod {
|
|
1607
1630
|
/**
|
|
1608
1631
|
* Payment method name
|
|
1609
1632
|
* @minLength 1
|
|
@@ -1617,7 +1640,7 @@ interface SavedPaymentMethod {
|
|
|
1617
1640
|
*/
|
|
1618
1641
|
description?: string | null;
|
|
1619
1642
|
}
|
|
1620
|
-
interface AuthorizedPaymentCreated {
|
|
1643
|
+
export interface AuthorizedPaymentCreated {
|
|
1621
1644
|
/**
|
|
1622
1645
|
* Payment ID of payment associated with this activity
|
|
1623
1646
|
* @format GUID
|
|
@@ -1636,7 +1659,7 @@ interface AuthorizedPaymentCreated {
|
|
|
1636
1659
|
*/
|
|
1637
1660
|
brand?: string | null;
|
|
1638
1661
|
}
|
|
1639
|
-
interface AuthorizedPaymentCaptured {
|
|
1662
|
+
export interface AuthorizedPaymentCaptured {
|
|
1640
1663
|
/**
|
|
1641
1664
|
* Payment ID of payment associated with this activity
|
|
1642
1665
|
* @format GUID
|
|
@@ -1655,7 +1678,7 @@ interface AuthorizedPaymentCaptured {
|
|
|
1655
1678
|
*/
|
|
1656
1679
|
brand?: string | null;
|
|
1657
1680
|
}
|
|
1658
|
-
interface AuthorizedPaymentVoided {
|
|
1681
|
+
export interface AuthorizedPaymentVoided {
|
|
1659
1682
|
/**
|
|
1660
1683
|
* Payment ID of payment associated with this activity
|
|
1661
1684
|
* @format GUID
|
|
@@ -1674,7 +1697,7 @@ interface AuthorizedPaymentVoided {
|
|
|
1674
1697
|
*/
|
|
1675
1698
|
brand?: string | null;
|
|
1676
1699
|
}
|
|
1677
|
-
interface RefundInitiated {
|
|
1700
|
+
export interface RefundInitiated {
|
|
1678
1701
|
/**
|
|
1679
1702
|
* Refund ID.
|
|
1680
1703
|
* @format GUID
|
|
@@ -1694,7 +1717,7 @@ interface RefundInitiated {
|
|
|
1694
1717
|
*/
|
|
1695
1718
|
reason?: string | null;
|
|
1696
1719
|
}
|
|
1697
|
-
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
1720
|
+
export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
1698
1721
|
/** Regular payment refund. */
|
|
1699
1722
|
regular?: RegularPaymentRefund;
|
|
1700
1723
|
/** Gift card payment refund. */
|
|
@@ -1710,7 +1733,7 @@ interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
1710
1733
|
externalRefund?: boolean;
|
|
1711
1734
|
}
|
|
1712
1735
|
/** @oneof */
|
|
1713
|
-
interface RefundedPaymentKindOneOf {
|
|
1736
|
+
export interface RefundedPaymentKindOneOf {
|
|
1714
1737
|
/** Regular payment refund. */
|
|
1715
1738
|
regular?: RegularPaymentRefund;
|
|
1716
1739
|
/** Gift card payment refund. */
|
|
@@ -1718,7 +1741,7 @@ interface RefundedPaymentKindOneOf {
|
|
|
1718
1741
|
/** Membership payment refund. */
|
|
1719
1742
|
membership?: MembershipPaymentRefund;
|
|
1720
1743
|
}
|
|
1721
|
-
interface RegularPaymentRefund {
|
|
1744
|
+
export interface RegularPaymentRefund {
|
|
1722
1745
|
/** Refund amount */
|
|
1723
1746
|
amount?: Price;
|
|
1724
1747
|
/**
|
|
@@ -1732,7 +1755,7 @@ interface RegularPaymentRefund {
|
|
|
1732
1755
|
*/
|
|
1733
1756
|
brand?: string | null;
|
|
1734
1757
|
}
|
|
1735
|
-
interface GiftCardPaymentRefund {
|
|
1758
|
+
export interface GiftCardPaymentRefund {
|
|
1736
1759
|
/**
|
|
1737
1760
|
* Gift card payment ID
|
|
1738
1761
|
* @minLength 1
|
|
@@ -1742,7 +1765,7 @@ interface GiftCardPaymentRefund {
|
|
|
1742
1765
|
/** Refund amount */
|
|
1743
1766
|
amount?: Price;
|
|
1744
1767
|
}
|
|
1745
|
-
interface MembershipPaymentRefund {
|
|
1768
|
+
export interface MembershipPaymentRefund {
|
|
1746
1769
|
/**
|
|
1747
1770
|
* Membership ID
|
|
1748
1771
|
* @minLength 1
|
|
@@ -1750,7 +1773,7 @@ interface MembershipPaymentRefund {
|
|
|
1750
1773
|
*/
|
|
1751
1774
|
membershipId?: string | null;
|
|
1752
1775
|
}
|
|
1753
|
-
interface PaymentRefunded {
|
|
1776
|
+
export interface PaymentRefunded {
|
|
1754
1777
|
/**
|
|
1755
1778
|
* Refund ID.
|
|
1756
1779
|
* @format GUID
|
|
@@ -1759,7 +1782,7 @@ interface PaymentRefunded {
|
|
|
1759
1782
|
/** Details about the refunded payment. */
|
|
1760
1783
|
payment?: RefundedPayment;
|
|
1761
1784
|
}
|
|
1762
|
-
interface PaymentRefundFailed {
|
|
1785
|
+
export interface PaymentRefundFailed {
|
|
1763
1786
|
/**
|
|
1764
1787
|
* Refund ID.
|
|
1765
1788
|
* @format GUID
|
|
@@ -1768,7 +1791,7 @@ interface PaymentRefundFailed {
|
|
|
1768
1791
|
/** Details about the failed payment refund. */
|
|
1769
1792
|
payment?: RefundedPayment;
|
|
1770
1793
|
}
|
|
1771
|
-
interface RefundedAsStoreCredit {
|
|
1794
|
+
export interface RefundedAsStoreCredit {
|
|
1772
1795
|
/** Refund amount */
|
|
1773
1796
|
amount?: Price;
|
|
1774
1797
|
/**
|
|
@@ -1777,7 +1800,7 @@ interface RefundedAsStoreCredit {
|
|
|
1777
1800
|
*/
|
|
1778
1801
|
reason?: string | null;
|
|
1779
1802
|
}
|
|
1780
|
-
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
1803
|
+
export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
1781
1804
|
/** Regular payment. */
|
|
1782
1805
|
regular?: RegularPayment;
|
|
1783
1806
|
/**
|
|
@@ -1787,22 +1810,22 @@ interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
1787
1810
|
paymentId?: string;
|
|
1788
1811
|
}
|
|
1789
1812
|
/** @oneof */
|
|
1790
|
-
interface PaymentPendingPaymentDetailsOneOf {
|
|
1813
|
+
export interface PaymentPendingPaymentDetailsOneOf {
|
|
1791
1814
|
/** Regular payment. */
|
|
1792
1815
|
regular?: RegularPayment;
|
|
1793
1816
|
}
|
|
1794
|
-
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
1817
|
+
export interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
1795
1818
|
/** Whether regular card used */
|
|
1796
1819
|
creditCardDetails?: CreditCardDetails;
|
|
1797
1820
|
/** Payment amount */
|
|
1798
1821
|
amount?: Price;
|
|
1799
1822
|
}
|
|
1800
1823
|
/** @oneof */
|
|
1801
|
-
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
1824
|
+
export interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
1802
1825
|
/** Whether regular card used */
|
|
1803
1826
|
creditCardDetails?: CreditCardDetails;
|
|
1804
1827
|
}
|
|
1805
|
-
interface CreditCardDetails {
|
|
1828
|
+
export interface CreditCardDetails {
|
|
1806
1829
|
/**
|
|
1807
1830
|
* The last 4 digits of the card number.
|
|
1808
1831
|
* @maxLength 4
|
|
@@ -1814,7 +1837,7 @@ interface CreditCardDetails {
|
|
|
1814
1837
|
*/
|
|
1815
1838
|
brand?: string | null;
|
|
1816
1839
|
}
|
|
1817
|
-
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
1840
|
+
export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
1818
1841
|
/** Regular payment. */
|
|
1819
1842
|
regular?: RegularPayment;
|
|
1820
1843
|
/**
|
|
@@ -1824,11 +1847,11 @@ interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
1824
1847
|
paymentId?: string;
|
|
1825
1848
|
}
|
|
1826
1849
|
/** @oneof */
|
|
1827
|
-
interface PaymentCanceledPaymentDetailsOneOf {
|
|
1850
|
+
export interface PaymentCanceledPaymentDetailsOneOf {
|
|
1828
1851
|
/** Regular payment. */
|
|
1829
1852
|
regular?: RegularPayment;
|
|
1830
1853
|
}
|
|
1831
|
-
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
1854
|
+
export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
1832
1855
|
/** Regular payment. */
|
|
1833
1856
|
regular?: RegularPayment;
|
|
1834
1857
|
/**
|
|
@@ -1838,11 +1861,11 @@ interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
1838
1861
|
paymentId?: string;
|
|
1839
1862
|
}
|
|
1840
1863
|
/** @oneof */
|
|
1841
|
-
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
1864
|
+
export interface PaymentDeclinedPaymentDetailsOneOf {
|
|
1842
1865
|
/** Regular payment. */
|
|
1843
1866
|
regular?: RegularPayment;
|
|
1844
1867
|
}
|
|
1845
|
-
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
1868
|
+
export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
1846
1869
|
/** Receipt created by Wix */
|
|
1847
1870
|
wixReceipt?: WixReceipt;
|
|
1848
1871
|
/** Receipt created by an external system. */
|
|
@@ -1854,13 +1877,13 @@ interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
1854
1877
|
paymentId?: string;
|
|
1855
1878
|
}
|
|
1856
1879
|
/** @oneof */
|
|
1857
|
-
interface ReceiptCreatedReceiptInfoOneOf {
|
|
1880
|
+
export interface ReceiptCreatedReceiptInfoOneOf {
|
|
1858
1881
|
/** Receipt created by Wix */
|
|
1859
1882
|
wixReceipt?: WixReceipt;
|
|
1860
1883
|
/** Receipt created by an external system. */
|
|
1861
1884
|
externalReceipt?: ExternalReceipt;
|
|
1862
1885
|
}
|
|
1863
|
-
interface WixReceipt {
|
|
1886
|
+
export interface WixReceipt {
|
|
1864
1887
|
/**
|
|
1865
1888
|
* Receipt ID
|
|
1866
1889
|
* @format GUID
|
|
@@ -1873,7 +1896,7 @@ interface WixReceipt {
|
|
|
1873
1896
|
*/
|
|
1874
1897
|
displayNumber?: string | null;
|
|
1875
1898
|
}
|
|
1876
|
-
interface ExternalReceipt {
|
|
1899
|
+
export interface ExternalReceipt {
|
|
1877
1900
|
/**
|
|
1878
1901
|
* Receipt ID
|
|
1879
1902
|
* @maxLength 100
|
|
@@ -1886,7 +1909,7 @@ interface ExternalReceipt {
|
|
|
1886
1909
|
*/
|
|
1887
1910
|
displayNumber?: string | null;
|
|
1888
1911
|
}
|
|
1889
|
-
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
1912
|
+
export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
1890
1913
|
/** Receipt created by Wix */
|
|
1891
1914
|
wixReceipt?: WixReceipt;
|
|
1892
1915
|
/** Receipt created by an external system. */
|
|
@@ -1898,13 +1921,13 @@ interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
1898
1921
|
paymentId?: string;
|
|
1899
1922
|
}
|
|
1900
1923
|
/** @oneof */
|
|
1901
|
-
interface ReceiptSentReceiptInfoOneOf {
|
|
1924
|
+
export interface ReceiptSentReceiptInfoOneOf {
|
|
1902
1925
|
/** Receipt created by Wix */
|
|
1903
1926
|
wixReceipt?: WixReceipt;
|
|
1904
1927
|
/** Receipt created by an external system. */
|
|
1905
1928
|
externalReceipt?: ExternalReceipt;
|
|
1906
1929
|
}
|
|
1907
|
-
declare enum ActivityType {
|
|
1930
|
+
export declare enum ActivityType {
|
|
1908
1931
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
1909
1932
|
ORDER_PLACED = "ORDER_PLACED",
|
|
1910
1933
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -1941,11 +1964,11 @@ declare enum ActivityType {
|
|
|
1941
1964
|
/** @documentationMaturity preview */
|
|
1942
1965
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
1943
1966
|
}
|
|
1944
|
-
declare enum AttributionSource {
|
|
1967
|
+
export declare enum AttributionSource {
|
|
1945
1968
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1946
1969
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
1947
1970
|
}
|
|
1948
|
-
interface CreatedBy extends CreatedByStringOneOf {
|
|
1971
|
+
export interface CreatedBy extends CreatedByStringOneOf {
|
|
1949
1972
|
/**
|
|
1950
1973
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1951
1974
|
* For example, via POS (point of service).
|
|
@@ -1969,7 +1992,7 @@ interface CreatedBy extends CreatedByStringOneOf {
|
|
|
1969
1992
|
appId?: string;
|
|
1970
1993
|
}
|
|
1971
1994
|
/** @oneof */
|
|
1972
|
-
interface CreatedByStringOneOf {
|
|
1995
|
+
export interface CreatedByStringOneOf {
|
|
1973
1996
|
/**
|
|
1974
1997
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1975
1998
|
* For example, via POS (point of service).
|
|
@@ -1992,7 +2015,7 @@ interface CreatedByStringOneOf {
|
|
|
1992
2015
|
*/
|
|
1993
2016
|
appId?: string;
|
|
1994
2017
|
}
|
|
1995
|
-
interface ChannelInfo {
|
|
2018
|
+
export interface ChannelInfo {
|
|
1996
2019
|
/** Sales channel that submitted the order. */
|
|
1997
2020
|
type?: ChannelType;
|
|
1998
2021
|
/**
|
|
@@ -2006,7 +2029,7 @@ interface ChannelInfo {
|
|
|
2006
2029
|
*/
|
|
2007
2030
|
externalOrderUrl?: string | null;
|
|
2008
2031
|
}
|
|
2009
|
-
declare enum ChannelType {
|
|
2032
|
+
export declare enum ChannelType {
|
|
2010
2033
|
/** Unspecified sales channel. This value is not supported. */
|
|
2011
2034
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2012
2035
|
/** A web client. */
|
|
@@ -2040,7 +2063,7 @@ declare enum ChannelType {
|
|
|
2040
2063
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2041
2064
|
FAIRE_COM = "FAIRE_COM"
|
|
2042
2065
|
}
|
|
2043
|
-
interface CustomField {
|
|
2066
|
+
export interface CustomField {
|
|
2044
2067
|
/** Custom field value. */
|
|
2045
2068
|
value?: any;
|
|
2046
2069
|
/**
|
|
@@ -2056,7 +2079,7 @@ interface CustomField {
|
|
|
2056
2079
|
*/
|
|
2057
2080
|
translatedTitle?: string | null;
|
|
2058
2081
|
}
|
|
2059
|
-
interface BalanceSummary {
|
|
2082
|
+
export interface BalanceSummary {
|
|
2060
2083
|
/**
|
|
2061
2084
|
* Current amount left to pay.
|
|
2062
2085
|
* @readonly
|
|
@@ -2092,7 +2115,7 @@ interface BalanceSummary {
|
|
|
2092
2115
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
2093
2116
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
2094
2117
|
*/
|
|
2095
|
-
interface Balance {
|
|
2118
|
+
export interface Balance {
|
|
2096
2119
|
/**
|
|
2097
2120
|
* Balance amount.
|
|
2098
2121
|
*
|
|
@@ -2107,7 +2130,7 @@ interface Balance {
|
|
|
2107
2130
|
*/
|
|
2108
2131
|
formattedAmount?: string;
|
|
2109
2132
|
}
|
|
2110
|
-
interface AdditionalFee {
|
|
2133
|
+
export interface AdditionalFee {
|
|
2111
2134
|
/**
|
|
2112
2135
|
* Additional fee's unique code for future processing.
|
|
2113
2136
|
* @minLength 1
|
|
@@ -2138,7 +2161,7 @@ interface AdditionalFee {
|
|
|
2138
2161
|
* @format GUID
|
|
2139
2162
|
* @immutable
|
|
2140
2163
|
*/
|
|
2141
|
-
|
|
2164
|
+
id?: string;
|
|
2142
2165
|
/**
|
|
2143
2166
|
* Optional - Line items associated with this additional fee.
|
|
2144
2167
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
@@ -2146,7 +2169,7 @@ interface AdditionalFee {
|
|
|
2146
2169
|
*/
|
|
2147
2170
|
lineItemIds?: string[];
|
|
2148
2171
|
}
|
|
2149
|
-
interface FulfillmentStatusesAggregate {
|
|
2172
|
+
export interface FulfillmentStatusesAggregate {
|
|
2150
2173
|
/** Unique string values based on Fulfillment entities statuses */
|
|
2151
2174
|
statuses?: string[] | null;
|
|
2152
2175
|
}
|
|
@@ -2172,13 +2195,13 @@ interface FulfillmentStatusesAggregate {
|
|
|
2172
2195
|
* }
|
|
2173
2196
|
* }
|
|
2174
2197
|
*/
|
|
2175
|
-
interface Tags {
|
|
2198
|
+
export interface Tags {
|
|
2176
2199
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
2177
2200
|
privateTags?: TagList;
|
|
2178
2201
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
2179
2202
|
tags?: TagList;
|
|
2180
2203
|
}
|
|
2181
|
-
interface TagList {
|
|
2204
|
+
export interface TagList {
|
|
2182
2205
|
/**
|
|
2183
2206
|
* List of tag IDs
|
|
2184
2207
|
* @maxSize 100
|
|
@@ -2186,13 +2209,13 @@ interface TagList {
|
|
|
2186
2209
|
*/
|
|
2187
2210
|
tagIds?: string[];
|
|
2188
2211
|
}
|
|
2189
|
-
interface Location {
|
|
2212
|
+
export interface Location {
|
|
2190
2213
|
/**
|
|
2191
2214
|
* Location ID.
|
|
2192
2215
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
2193
2216
|
* @format GUID
|
|
2194
2217
|
*/
|
|
2195
|
-
|
|
2218
|
+
id?: string;
|
|
2196
2219
|
/**
|
|
2197
2220
|
* Location name.
|
|
2198
2221
|
* @minLength 1
|
|
@@ -2202,29 +2225,29 @@ interface Location {
|
|
|
2202
2225
|
name?: string;
|
|
2203
2226
|
}
|
|
2204
2227
|
/** Triggered when the order status changes to approved */
|
|
2205
|
-
interface OrderApproved {
|
|
2228
|
+
export interface OrderApproved {
|
|
2206
2229
|
/** The order that was updated */
|
|
2207
2230
|
order?: Order;
|
|
2208
2231
|
}
|
|
2209
|
-
interface OrdersExperiments {
|
|
2232
|
+
export interface OrdersExperiments {
|
|
2210
2233
|
epCommitTax?: boolean;
|
|
2211
2234
|
moveMerchantEmailToEp?: boolean;
|
|
2212
2235
|
moveBuyerOrderConfirmationEmailToEp?: boolean;
|
|
2213
2236
|
producedByEpBridge?: boolean;
|
|
2214
2237
|
enableRewrittenSideEffects?: boolean;
|
|
2215
2238
|
}
|
|
2216
|
-
interface OrderRejectedEventOrderRejected {
|
|
2239
|
+
export interface OrderRejectedEventOrderRejected {
|
|
2217
2240
|
/** The order that was rejected */
|
|
2218
2241
|
order?: Order;
|
|
2219
2242
|
}
|
|
2220
2243
|
/** Triggered when order items are marked as restocked */
|
|
2221
|
-
interface OrderItemsRestocked {
|
|
2244
|
+
export interface OrderItemsRestocked {
|
|
2222
2245
|
/** The order which items were restocked */
|
|
2223
2246
|
order?: Order;
|
|
2224
2247
|
/** Restocked items and quantities */
|
|
2225
2248
|
restockItems?: V1RestockItem[];
|
|
2226
2249
|
}
|
|
2227
|
-
interface V1RestockItem {
|
|
2250
|
+
export interface V1RestockItem {
|
|
2228
2251
|
/**
|
|
2229
2252
|
* ID of the line item being restocked.
|
|
2230
2253
|
* @format GUID
|
|
@@ -2237,7 +2260,7 @@ interface V1RestockItem {
|
|
|
2237
2260
|
*/
|
|
2238
2261
|
quantity?: number;
|
|
2239
2262
|
}
|
|
2240
|
-
interface PreparePaymentCollectionRequest {
|
|
2263
|
+
export interface PreparePaymentCollectionRequest {
|
|
2241
2264
|
/**
|
|
2242
2265
|
* Ecom order ID.
|
|
2243
2266
|
* @minLength 1
|
|
@@ -2264,7 +2287,7 @@ interface PreparePaymentCollectionRequest {
|
|
|
2264
2287
|
/** Delayed capture payment settings */
|
|
2265
2288
|
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
2266
2289
|
}
|
|
2267
|
-
interface RedirectUrls {
|
|
2290
|
+
export interface RedirectUrls {
|
|
2268
2291
|
/**
|
|
2269
2292
|
* URL to redirect buyer in case of approved (successful) transaction
|
|
2270
2293
|
* @format WEB_URL
|
|
@@ -2286,20 +2309,20 @@ interface RedirectUrls {
|
|
|
2286
2309
|
*/
|
|
2287
2310
|
pendingUrl?: string | null;
|
|
2288
2311
|
}
|
|
2289
|
-
interface DelayedCaptureSettings {
|
|
2312
|
+
export interface DelayedCaptureSettings {
|
|
2290
2313
|
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
2291
2314
|
scheduledAction?: ScheduledAction;
|
|
2292
2315
|
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2293
2316
|
delayDuration?: Duration;
|
|
2294
2317
|
}
|
|
2295
|
-
declare enum ScheduledAction {
|
|
2318
|
+
export declare enum ScheduledAction {
|
|
2296
2319
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2297
2320
|
/** Whether payment will be auto-voided when duration passes */
|
|
2298
2321
|
VOID = "VOID",
|
|
2299
2322
|
/** Whether payment will be auto-captured when duration passes */
|
|
2300
2323
|
CAPTURE = "CAPTURE"
|
|
2301
2324
|
}
|
|
2302
|
-
interface Duration {
|
|
2325
|
+
export interface Duration {
|
|
2303
2326
|
/**
|
|
2304
2327
|
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
2305
2328
|
* @min 1
|
|
@@ -2308,17 +2331,17 @@ interface Duration {
|
|
|
2308
2331
|
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
2309
2332
|
unit?: DurationUnit;
|
|
2310
2333
|
}
|
|
2311
|
-
declare enum DurationUnit {
|
|
2334
|
+
export declare enum DurationUnit {
|
|
2312
2335
|
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
2313
2336
|
MINUTES = "MINUTES",
|
|
2314
2337
|
HOURS = "HOURS",
|
|
2315
2338
|
DAYS = "DAYS"
|
|
2316
2339
|
}
|
|
2317
|
-
interface PreparePaymentCollectionResponse {
|
|
2340
|
+
export interface PreparePaymentCollectionResponse {
|
|
2318
2341
|
/** Payment gateway order id which is associated with given payment */
|
|
2319
2342
|
paymentGatewayOrderId?: string;
|
|
2320
2343
|
}
|
|
2321
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
2344
|
+
export interface GetPaymentCollectabilityStatusRequest {
|
|
2322
2345
|
/**
|
|
2323
2346
|
* Ecom order ID.
|
|
2324
2347
|
* @minLength 1
|
|
@@ -2326,13 +2349,13 @@ interface GetPaymentCollectabilityStatusRequest {
|
|
|
2326
2349
|
*/
|
|
2327
2350
|
ecomOrderId: string;
|
|
2328
2351
|
}
|
|
2329
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
2352
|
+
export interface GetPaymentCollectabilityStatusResponse {
|
|
2330
2353
|
/** Payment collectability status */
|
|
2331
2354
|
status?: PaymentCollectabilityStatus;
|
|
2332
2355
|
/** Collectable order amount */
|
|
2333
2356
|
amount?: Price;
|
|
2334
2357
|
}
|
|
2335
|
-
declare enum PaymentCollectabilityStatus {
|
|
2358
|
+
export declare enum PaymentCollectabilityStatus {
|
|
2336
2359
|
UNKNOWN = "UNKNOWN",
|
|
2337
2360
|
COLLECTABLE = "COLLECTABLE",
|
|
2338
2361
|
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
@@ -2342,7 +2365,7 @@ declare enum PaymentCollectabilityStatus {
|
|
|
2342
2365
|
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
2343
2366
|
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2344
2367
|
}
|
|
2345
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
2368
|
+
export interface RecordManuallyCollectedPaymentRequest {
|
|
2346
2369
|
/**
|
|
2347
2370
|
* Order ID.
|
|
2348
2371
|
* @minLength 1
|
|
@@ -2352,9 +2375,9 @@ interface RecordManuallyCollectedPaymentRequest {
|
|
|
2352
2375
|
/** Amount to be recorded as approved manual payment for given order */
|
|
2353
2376
|
amount: Price;
|
|
2354
2377
|
}
|
|
2355
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
2378
|
+
export interface RecordManuallyCollectedPaymentResponse {
|
|
2356
2379
|
}
|
|
2357
|
-
interface MarkOrderAsPaidRequest {
|
|
2380
|
+
export interface MarkOrderAsPaidRequest {
|
|
2358
2381
|
/**
|
|
2359
2382
|
* Ecom order ID.
|
|
2360
2383
|
* @minLength 1
|
|
@@ -2362,18 +2385,18 @@ interface MarkOrderAsPaidRequest {
|
|
|
2362
2385
|
*/
|
|
2363
2386
|
ecomOrderId: string;
|
|
2364
2387
|
}
|
|
2365
|
-
interface MarkOrderAsPaidResponse {
|
|
2388
|
+
export interface MarkOrderAsPaidResponse {
|
|
2366
2389
|
/** Updated order. */
|
|
2367
2390
|
order?: Order;
|
|
2368
2391
|
}
|
|
2369
2392
|
/** Triggered when the payment status of an order is updated */
|
|
2370
|
-
interface PaymentStatusUpdated {
|
|
2393
|
+
export interface PaymentStatusUpdated {
|
|
2371
2394
|
/** The order that was updated */
|
|
2372
2395
|
order?: Order;
|
|
2373
2396
|
/** The previous status (before the update) */
|
|
2374
2397
|
previousPaymentStatus?: PaymentStatus;
|
|
2375
2398
|
}
|
|
2376
|
-
interface BulkMarkOrdersAsPaidRequest {
|
|
2399
|
+
export interface BulkMarkOrdersAsPaidRequest {
|
|
2377
2400
|
/**
|
|
2378
2401
|
* IDs of orders to mark as paid.
|
|
2379
2402
|
* @minSize 1
|
|
@@ -2383,7 +2406,7 @@ interface BulkMarkOrdersAsPaidRequest {
|
|
|
2383
2406
|
*/
|
|
2384
2407
|
ecomOrderIds: string[];
|
|
2385
2408
|
}
|
|
2386
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
2409
|
+
export interface BulkMarkOrdersAsPaidResponse {
|
|
2387
2410
|
/**
|
|
2388
2411
|
* Items updated by the bulk action.
|
|
2389
2412
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -2392,7 +2415,7 @@ interface BulkMarkOrdersAsPaidResponse {
|
|
|
2392
2415
|
/** Bulk action metadata. */
|
|
2393
2416
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2394
2417
|
}
|
|
2395
|
-
interface BulkOrderResult {
|
|
2418
|
+
export interface BulkOrderResult {
|
|
2396
2419
|
/** Item metadata. */
|
|
2397
2420
|
itemMetadata?: ItemMetadata;
|
|
2398
2421
|
/**
|
|
@@ -2402,9 +2425,9 @@ interface BulkOrderResult {
|
|
|
2402
2425
|
*/
|
|
2403
2426
|
item?: Order;
|
|
2404
2427
|
}
|
|
2405
|
-
interface ItemMetadata {
|
|
2428
|
+
export interface ItemMetadata {
|
|
2406
2429
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2407
|
-
|
|
2430
|
+
id?: string | null;
|
|
2408
2431
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2409
2432
|
originalIndex?: number;
|
|
2410
2433
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -2412,7 +2435,7 @@ interface ItemMetadata {
|
|
|
2412
2435
|
/** Details about the error in case of failure. */
|
|
2413
2436
|
error?: ApplicationError;
|
|
2414
2437
|
}
|
|
2415
|
-
interface ApplicationError {
|
|
2438
|
+
export interface ApplicationError {
|
|
2416
2439
|
/** Error code. */
|
|
2417
2440
|
code?: string;
|
|
2418
2441
|
/** Description of the error. */
|
|
@@ -2420,7 +2443,7 @@ interface ApplicationError {
|
|
|
2420
2443
|
/** Data related to the error. */
|
|
2421
2444
|
data?: Record<string, any> | null;
|
|
2422
2445
|
}
|
|
2423
|
-
interface BulkActionMetadata {
|
|
2446
|
+
export interface BulkActionMetadata {
|
|
2424
2447
|
/** Number of items that were successfully processed. */
|
|
2425
2448
|
totalSuccesses?: number;
|
|
2426
2449
|
/** Number of items that couldn't be processed. */
|
|
@@ -2428,7 +2451,7 @@ interface BulkActionMetadata {
|
|
|
2428
2451
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2429
2452
|
undetailedFailures?: number;
|
|
2430
2453
|
}
|
|
2431
|
-
interface GetRefundabilityStatusRequest {
|
|
2454
|
+
export interface GetRefundabilityStatusRequest {
|
|
2432
2455
|
/**
|
|
2433
2456
|
* Order ID.
|
|
2434
2457
|
* @minLength 1
|
|
@@ -2436,7 +2459,7 @@ interface GetRefundabilityStatusRequest {
|
|
|
2436
2459
|
*/
|
|
2437
2460
|
ecomOrderId: string;
|
|
2438
2461
|
}
|
|
2439
|
-
interface GetRefundabilityStatusResponse {
|
|
2462
|
+
export interface GetRefundabilityStatusResponse {
|
|
2440
2463
|
/**
|
|
2441
2464
|
* Refundability details.
|
|
2442
2465
|
* @maxSize 300
|
|
@@ -2448,7 +2471,7 @@ interface GetRefundabilityStatusResponse {
|
|
|
2448
2471
|
*/
|
|
2449
2472
|
refundablePerItem?: boolean;
|
|
2450
2473
|
}
|
|
2451
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2474
|
+
export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2452
2475
|
/** Reason why payment is not refundable. */
|
|
2453
2476
|
nonRefundableReason?: NonRefundableReason;
|
|
2454
2477
|
/** Reason why payment is only refundable manually. */
|
|
@@ -2461,18 +2484,18 @@ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
|
2461
2484
|
providerLink?: string | null;
|
|
2462
2485
|
}
|
|
2463
2486
|
/** @oneof */
|
|
2464
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2487
|
+
export interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2465
2488
|
/** Reason why payment is not refundable. */
|
|
2466
2489
|
nonRefundableReason?: NonRefundableReason;
|
|
2467
2490
|
/** Reason why payment is only refundable manually. */
|
|
2468
2491
|
manuallyRefundableReason?: ManuallyRefundableReason;
|
|
2469
2492
|
}
|
|
2470
|
-
declare enum RefundableStatus {
|
|
2493
|
+
export declare enum RefundableStatus {
|
|
2471
2494
|
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2472
2495
|
MANUAL = "MANUAL",
|
|
2473
2496
|
REFUNDABLE = "REFUNDABLE"
|
|
2474
2497
|
}
|
|
2475
|
-
declare enum NonRefundableReason {
|
|
2498
|
+
export declare enum NonRefundableReason {
|
|
2476
2499
|
NONE = "NONE",
|
|
2477
2500
|
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
2478
2501
|
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
@@ -2487,13 +2510,13 @@ declare enum NonRefundableReason {
|
|
|
2487
2510
|
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
2488
2511
|
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
2489
2512
|
}
|
|
2490
|
-
declare enum ManuallyRefundableReason {
|
|
2513
|
+
export declare enum ManuallyRefundableReason {
|
|
2491
2514
|
EXPIRED = "EXPIRED",
|
|
2492
2515
|
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
2493
2516
|
OFFLINE = "OFFLINE",
|
|
2494
2517
|
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2495
2518
|
}
|
|
2496
|
-
interface CreatePaymentGatewayOrderRequest {
|
|
2519
|
+
export interface CreatePaymentGatewayOrderRequest {
|
|
2497
2520
|
/**
|
|
2498
2521
|
* Ecom order ID.
|
|
2499
2522
|
* @minLength 1
|
|
@@ -2503,12 +2526,12 @@ interface CreatePaymentGatewayOrderRequest {
|
|
|
2503
2526
|
/** Information about the user who initiated the payment. */
|
|
2504
2527
|
chargedBy?: ChargedBy;
|
|
2505
2528
|
}
|
|
2506
|
-
interface ChargedBy {
|
|
2529
|
+
export interface ChargedBy {
|
|
2507
2530
|
/**
|
|
2508
2531
|
* ID - id of the user who initiated the payment
|
|
2509
2532
|
* @format GUID
|
|
2510
2533
|
*/
|
|
2511
|
-
|
|
2534
|
+
id?: string;
|
|
2512
2535
|
/**
|
|
2513
2536
|
* Full name - name of the user who initiated the payment
|
|
2514
2537
|
* @minLength 1
|
|
@@ -2516,11 +2539,11 @@ interface ChargedBy {
|
|
|
2516
2539
|
*/
|
|
2517
2540
|
fullName?: string | null;
|
|
2518
2541
|
}
|
|
2519
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
2542
|
+
export interface CreatePaymentGatewayOrderResponse {
|
|
2520
2543
|
/** ID of the order created in the payment gateway */
|
|
2521
2544
|
paymentGatewayOrderId?: string;
|
|
2522
2545
|
}
|
|
2523
|
-
interface ChargeMembershipsRequest {
|
|
2546
|
+
export interface ChargeMembershipsRequest {
|
|
2524
2547
|
/**
|
|
2525
2548
|
* Order ID.
|
|
2526
2549
|
* @minLength 1
|
|
@@ -2540,7 +2563,7 @@ interface ChargeMembershipsRequest {
|
|
|
2540
2563
|
*/
|
|
2541
2564
|
membershipCharges?: MembershipChargeItem[];
|
|
2542
2565
|
}
|
|
2543
|
-
interface MembershipChargeItem {
|
|
2566
|
+
export interface MembershipChargeItem {
|
|
2544
2567
|
/**
|
|
2545
2568
|
* The id of used membership
|
|
2546
2569
|
* @minLength 1
|
|
@@ -2575,7 +2598,7 @@ interface MembershipChargeItem {
|
|
|
2575
2598
|
*/
|
|
2576
2599
|
lineItemId?: string;
|
|
2577
2600
|
}
|
|
2578
|
-
interface MembershipName {
|
|
2601
|
+
export interface MembershipName {
|
|
2579
2602
|
/**
|
|
2580
2603
|
* Membership name.
|
|
2581
2604
|
* @maxLength 100
|
|
@@ -2587,7 +2610,7 @@ interface MembershipName {
|
|
|
2587
2610
|
*/
|
|
2588
2611
|
translated?: string | null;
|
|
2589
2612
|
}
|
|
2590
|
-
interface ServiceProperties {
|
|
2613
|
+
export interface ServiceProperties {
|
|
2591
2614
|
/**
|
|
2592
2615
|
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2593
2616
|
* For example, the start time of a class.
|
|
@@ -2600,9 +2623,9 @@ interface ServiceProperties {
|
|
|
2600
2623
|
*/
|
|
2601
2624
|
numberOfParticipants?: number | null;
|
|
2602
2625
|
}
|
|
2603
|
-
interface ChargeMembershipsResponse {
|
|
2626
|
+
export interface ChargeMembershipsResponse {
|
|
2604
2627
|
}
|
|
2605
|
-
interface TriggerRefundRequest {
|
|
2628
|
+
export interface TriggerRefundRequest {
|
|
2606
2629
|
/**
|
|
2607
2630
|
* The order this refund related to
|
|
2608
2631
|
* @minLength 1
|
|
@@ -2620,7 +2643,7 @@ interface TriggerRefundRequest {
|
|
|
2620
2643
|
/** Side effect details related to refund */
|
|
2621
2644
|
sideEffects?: RefundSideEffects;
|
|
2622
2645
|
}
|
|
2623
|
-
interface PaymentRefund {
|
|
2646
|
+
export interface PaymentRefund {
|
|
2624
2647
|
/**
|
|
2625
2648
|
* Specific payment within the order to refund
|
|
2626
2649
|
* @format GUID
|
|
@@ -2636,7 +2659,7 @@ interface PaymentRefund {
|
|
|
2636
2659
|
externalRefund?: boolean;
|
|
2637
2660
|
}
|
|
2638
2661
|
/** Business model of a refund request */
|
|
2639
|
-
interface RefundDetails {
|
|
2662
|
+
export interface RefundDetails {
|
|
2640
2663
|
/**
|
|
2641
2664
|
* Order line item IDs and quantities that were refunded.
|
|
2642
2665
|
* @maxSize 300
|
|
@@ -2662,7 +2685,7 @@ interface RefundDetails {
|
|
|
2662
2685
|
/** Shipping amount that was refunded. */
|
|
2663
2686
|
shipping?: ShippingRefund;
|
|
2664
2687
|
}
|
|
2665
|
-
interface RefundItem {
|
|
2688
|
+
export interface RefundItem {
|
|
2666
2689
|
/**
|
|
2667
2690
|
* Line item ID the refunded line item.
|
|
2668
2691
|
* @format GUID
|
|
@@ -2675,7 +2698,7 @@ interface RefundItem {
|
|
|
2675
2698
|
*/
|
|
2676
2699
|
quantity?: number;
|
|
2677
2700
|
}
|
|
2678
|
-
interface LineItemRefund {
|
|
2701
|
+
export interface LineItemRefund {
|
|
2679
2702
|
/**
|
|
2680
2703
|
* Line item ID.
|
|
2681
2704
|
* @format GUID
|
|
@@ -2690,7 +2713,7 @@ interface LineItemRefund {
|
|
|
2690
2713
|
*/
|
|
2691
2714
|
quantity?: number;
|
|
2692
2715
|
}
|
|
2693
|
-
interface AdditionalFeeRefund {
|
|
2716
|
+
export interface AdditionalFeeRefund {
|
|
2694
2717
|
/**
|
|
2695
2718
|
* Additional fee ID.
|
|
2696
2719
|
* @format GUID
|
|
@@ -2703,14 +2726,14 @@ interface AdditionalFeeRefund {
|
|
|
2703
2726
|
*/
|
|
2704
2727
|
amount?: Price;
|
|
2705
2728
|
}
|
|
2706
|
-
interface ShippingRefund {
|
|
2729
|
+
export interface ShippingRefund {
|
|
2707
2730
|
/**
|
|
2708
2731
|
* Refund amount.
|
|
2709
2732
|
* @immutable
|
|
2710
2733
|
*/
|
|
2711
2734
|
amount?: Price;
|
|
2712
2735
|
}
|
|
2713
|
-
interface RefundSideEffects {
|
|
2736
|
+
export interface RefundSideEffects {
|
|
2714
2737
|
/** Inventory restock details as part of this refund. */
|
|
2715
2738
|
restockInfo?: RestockInfo;
|
|
2716
2739
|
/** Whether to send a refund confirmation email to the customer. */
|
|
@@ -2722,7 +2745,7 @@ interface RefundSideEffects {
|
|
|
2722
2745
|
*/
|
|
2723
2746
|
customMessage?: string | null;
|
|
2724
2747
|
}
|
|
2725
|
-
interface RestockInfo {
|
|
2748
|
+
export interface RestockInfo {
|
|
2726
2749
|
/** Restock type. */
|
|
2727
2750
|
type?: RestockType;
|
|
2728
2751
|
/**
|
|
@@ -2731,12 +2754,12 @@ interface RestockInfo {
|
|
|
2731
2754
|
*/
|
|
2732
2755
|
items?: RestockItem[];
|
|
2733
2756
|
}
|
|
2734
|
-
declare enum RestockType {
|
|
2757
|
+
export declare enum RestockType {
|
|
2735
2758
|
NO_ITEMS = "NO_ITEMS",
|
|
2736
2759
|
ALL_ITEMS = "ALL_ITEMS",
|
|
2737
2760
|
SOME_ITEMS = "SOME_ITEMS"
|
|
2738
2761
|
}
|
|
2739
|
-
interface RestockItem {
|
|
2762
|
+
export interface RestockItem {
|
|
2740
2763
|
/**
|
|
2741
2764
|
* ID of the line item being restocked.
|
|
2742
2765
|
* @format GUID
|
|
@@ -2749,7 +2772,7 @@ interface RestockItem {
|
|
|
2749
2772
|
*/
|
|
2750
2773
|
quantity?: number;
|
|
2751
2774
|
}
|
|
2752
|
-
interface TriggerRefundResponse {
|
|
2775
|
+
export interface TriggerRefundResponse {
|
|
2753
2776
|
/** All order's transactions after the refunds were added */
|
|
2754
2777
|
orderTransactions?: OrderTransactions;
|
|
2755
2778
|
/** Created refund ID */
|
|
@@ -2757,7 +2780,7 @@ interface TriggerRefundResponse {
|
|
|
2757
2780
|
/** Payment ID's that the refund execution had failed for */
|
|
2758
2781
|
failedPaymentIds?: ItemMetadata[];
|
|
2759
2782
|
}
|
|
2760
|
-
interface OrderTransactions {
|
|
2783
|
+
export interface OrderTransactions {
|
|
2761
2784
|
/**
|
|
2762
2785
|
* Order ID.
|
|
2763
2786
|
* @format GUID
|
|
@@ -2774,7 +2797,7 @@ interface OrderTransactions {
|
|
|
2774
2797
|
*/
|
|
2775
2798
|
refunds?: Refund[];
|
|
2776
2799
|
}
|
|
2777
|
-
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
2800
|
+
export interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
2778
2801
|
/** Regular payment details. */
|
|
2779
2802
|
regularPaymentDetails?: RegularPaymentDetails;
|
|
2780
2803
|
/** Gift card payment details. */
|
|
@@ -2784,14 +2807,14 @@ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
|
2784
2807
|
* @format GUID
|
|
2785
2808
|
* @readonly
|
|
2786
2809
|
*/
|
|
2787
|
-
|
|
2810
|
+
id?: string | null;
|
|
2788
2811
|
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
2789
|
-
|
|
2812
|
+
createdDate?: Date | null;
|
|
2790
2813
|
/**
|
|
2791
2814
|
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2792
2815
|
* @readonly
|
|
2793
2816
|
*/
|
|
2794
|
-
|
|
2817
|
+
updatedDate?: Date | null;
|
|
2795
2818
|
/** Payment amount. */
|
|
2796
2819
|
amount?: Price;
|
|
2797
2820
|
/**
|
|
@@ -2802,16 +2825,16 @@ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
|
2802
2825
|
refundDisabled?: boolean;
|
|
2803
2826
|
}
|
|
2804
2827
|
/** @oneof */
|
|
2805
|
-
interface PaymentPaymentDetailsOneOf {
|
|
2828
|
+
export interface PaymentPaymentDetailsOneOf {
|
|
2806
2829
|
/** Regular payment details. */
|
|
2807
2830
|
regularPaymentDetails?: RegularPaymentDetails;
|
|
2808
2831
|
/** Gift card payment details. */
|
|
2809
2832
|
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2810
2833
|
}
|
|
2811
2834
|
/** @oneof */
|
|
2812
|
-
interface PaymentReceiptInfoOneOf {
|
|
2835
|
+
export interface PaymentReceiptInfoOneOf {
|
|
2813
2836
|
}
|
|
2814
|
-
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2837
|
+
export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2815
2838
|
/** Whether regular card used */
|
|
2816
2839
|
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2817
2840
|
/**
|
|
@@ -2849,11 +2872,11 @@ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetail
|
|
|
2849
2872
|
authorizationDetails?: AuthorizationDetails;
|
|
2850
2873
|
}
|
|
2851
2874
|
/** @oneof */
|
|
2852
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2875
|
+
export interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2853
2876
|
/** Whether regular card used */
|
|
2854
2877
|
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2855
2878
|
}
|
|
2856
|
-
declare enum TransactionStatus {
|
|
2879
|
+
export declare enum TransactionStatus {
|
|
2857
2880
|
UNDEFINED = "UNDEFINED",
|
|
2858
2881
|
APPROVED = "APPROVED",
|
|
2859
2882
|
PENDING = "PENDING",
|
|
@@ -2865,7 +2888,7 @@ declare enum TransactionStatus {
|
|
|
2865
2888
|
AUTHORIZED = "AUTHORIZED",
|
|
2866
2889
|
VOIDED = "VOIDED"
|
|
2867
2890
|
}
|
|
2868
|
-
interface CreditCardPaymentMethodDetails {
|
|
2891
|
+
export interface CreditCardPaymentMethodDetails {
|
|
2869
2892
|
/**
|
|
2870
2893
|
* The last 4 digits of the card number.
|
|
2871
2894
|
* @maxLength 4
|
|
@@ -2877,7 +2900,7 @@ interface CreditCardPaymentMethodDetails {
|
|
|
2877
2900
|
*/
|
|
2878
2901
|
brand?: string | null;
|
|
2879
2902
|
}
|
|
2880
|
-
interface AuthorizationDetails {
|
|
2903
|
+
export interface AuthorizationDetails {
|
|
2881
2904
|
/**
|
|
2882
2905
|
* Whether the authorized payment is of a delayed capture.
|
|
2883
2906
|
* @readonly
|
|
@@ -2896,13 +2919,13 @@ interface AuthorizationDetails {
|
|
|
2896
2919
|
/** Scheduled action for this transaction */
|
|
2897
2920
|
scheduledAction?: V1ScheduledAction;
|
|
2898
2921
|
}
|
|
2899
|
-
interface AuthorizationCapture {
|
|
2922
|
+
export interface AuthorizationCapture {
|
|
2900
2923
|
/**
|
|
2901
2924
|
* Capture ID.
|
|
2902
2925
|
* @format GUID
|
|
2903
2926
|
* @readonly
|
|
2904
2927
|
*/
|
|
2905
|
-
|
|
2928
|
+
id?: string | null;
|
|
2906
2929
|
/** Status of this capture action */
|
|
2907
2930
|
status?: AuthorizationCaptureStatus;
|
|
2908
2931
|
/**
|
|
@@ -2911,11 +2934,11 @@ interface AuthorizationCapture {
|
|
|
2911
2934
|
*/
|
|
2912
2935
|
amount?: Price;
|
|
2913
2936
|
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
2914
|
-
|
|
2937
|
+
createdDate?: Date | null;
|
|
2915
2938
|
/** In case of status is FAILED may contain failure details */
|
|
2916
2939
|
failureDetails?: AuthorizationActionFailureDetails;
|
|
2917
2940
|
}
|
|
2918
|
-
declare enum AuthorizationCaptureStatus {
|
|
2941
|
+
export declare enum AuthorizationCaptureStatus {
|
|
2919
2942
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2920
2943
|
/** Capture operation still in progress. */
|
|
2921
2944
|
PENDING = "PENDING",
|
|
@@ -2924,11 +2947,11 @@ declare enum AuthorizationCaptureStatus {
|
|
|
2924
2947
|
/** Capture operation failed. */
|
|
2925
2948
|
FAILED = "FAILED"
|
|
2926
2949
|
}
|
|
2927
|
-
interface AuthorizationActionFailureDetails {
|
|
2950
|
+
export interface AuthorizationActionFailureDetails {
|
|
2928
2951
|
/** @maxLength 100 */
|
|
2929
2952
|
failureCode?: string;
|
|
2930
2953
|
}
|
|
2931
|
-
interface AuthorizationVoid {
|
|
2954
|
+
export interface AuthorizationVoid {
|
|
2932
2955
|
/** Status of this void action */
|
|
2933
2956
|
status?: AuthorizationVoidStatus;
|
|
2934
2957
|
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
@@ -2938,7 +2961,7 @@ interface AuthorizationVoid {
|
|
|
2938
2961
|
/** Reason of void action */
|
|
2939
2962
|
reason?: Reason;
|
|
2940
2963
|
}
|
|
2941
|
-
declare enum AuthorizationVoidStatus {
|
|
2964
|
+
export declare enum AuthorizationVoidStatus {
|
|
2942
2965
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2943
2966
|
/** Void operation still in progress. */
|
|
2944
2967
|
PENDING = "PENDING",
|
|
@@ -2948,25 +2971,25 @@ declare enum AuthorizationVoidStatus {
|
|
|
2948
2971
|
FAILED = "FAILED"
|
|
2949
2972
|
}
|
|
2950
2973
|
/** Reason the authorization was voided. */
|
|
2951
|
-
declare enum Reason {
|
|
2974
|
+
export declare enum Reason {
|
|
2952
2975
|
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
2953
2976
|
/** Authorization was voided by user. */
|
|
2954
2977
|
MANUAL = "MANUAL",
|
|
2955
2978
|
/** Authorization passed execution date. */
|
|
2956
2979
|
SCHEDULED = "SCHEDULED"
|
|
2957
2980
|
}
|
|
2958
|
-
interface V1ScheduledAction {
|
|
2981
|
+
export interface V1ScheduledAction {
|
|
2959
2982
|
/** Type of the action. */
|
|
2960
2983
|
actionType?: ActionType;
|
|
2961
2984
|
/** The date and time of the action. */
|
|
2962
2985
|
executionDate?: Date | null;
|
|
2963
2986
|
}
|
|
2964
|
-
declare enum ActionType {
|
|
2987
|
+
export declare enum ActionType {
|
|
2965
2988
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
2966
2989
|
VOID = "VOID",
|
|
2967
2990
|
CAPTURE = "CAPTURE"
|
|
2968
2991
|
}
|
|
2969
|
-
interface GiftCardPaymentDetails {
|
|
2992
|
+
export interface GiftCardPaymentDetails {
|
|
2970
2993
|
/**
|
|
2971
2994
|
* Gift card payment ID.
|
|
2972
2995
|
* @minLength 1
|
|
@@ -2984,7 +3007,7 @@ interface GiftCardPaymentDetails {
|
|
|
2984
3007
|
*/
|
|
2985
3008
|
voided?: boolean;
|
|
2986
3009
|
}
|
|
2987
|
-
interface MembershipPaymentDetails {
|
|
3010
|
+
export interface MembershipPaymentDetails {
|
|
2988
3011
|
/**
|
|
2989
3012
|
* Membership ID.
|
|
2990
3013
|
* @minLength 1
|
|
@@ -3018,13 +3041,13 @@ interface MembershipPaymentDetails {
|
|
|
3018
3041
|
*/
|
|
3019
3042
|
providerAppId?: string;
|
|
3020
3043
|
}
|
|
3021
|
-
declare enum MembershipPaymentStatus {
|
|
3044
|
+
export declare enum MembershipPaymentStatus {
|
|
3022
3045
|
/** Payment was charged. */
|
|
3023
3046
|
CHARGED = "CHARGED",
|
|
3024
3047
|
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3025
3048
|
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3026
3049
|
}
|
|
3027
|
-
interface WixReceiptInfo {
|
|
3050
|
+
export interface WixReceiptInfo {
|
|
3028
3051
|
/**
|
|
3029
3052
|
* Receipt ID
|
|
3030
3053
|
* @format GUID
|
|
@@ -3037,7 +3060,7 @@ interface WixReceiptInfo {
|
|
|
3037
3060
|
*/
|
|
3038
3061
|
displayNumber?: string | null;
|
|
3039
3062
|
}
|
|
3040
|
-
interface ExternalReceiptInfo {
|
|
3063
|
+
export interface ExternalReceiptInfo {
|
|
3041
3064
|
/**
|
|
3042
3065
|
* External receipt ID
|
|
3043
3066
|
* @maxLength 100
|
|
@@ -3055,13 +3078,13 @@ interface ExternalReceiptInfo {
|
|
|
3055
3078
|
*/
|
|
3056
3079
|
displayNumber?: string | null;
|
|
3057
3080
|
}
|
|
3058
|
-
interface Refund {
|
|
3081
|
+
export interface Refund {
|
|
3059
3082
|
/**
|
|
3060
3083
|
* Refund ID.
|
|
3061
3084
|
* @format GUID
|
|
3062
3085
|
* @readonly
|
|
3063
3086
|
*/
|
|
3064
|
-
|
|
3087
|
+
id?: string;
|
|
3065
3088
|
/**
|
|
3066
3089
|
* List of transactions.
|
|
3067
3090
|
* @maxSize 50
|
|
@@ -3074,7 +3097,7 @@ interface Refund {
|
|
|
3074
3097
|
* @readonly
|
|
3075
3098
|
* @immutable
|
|
3076
3099
|
*/
|
|
3077
|
-
|
|
3100
|
+
createdDate?: Date | null;
|
|
3078
3101
|
/**
|
|
3079
3102
|
* Aggregated refund summary.
|
|
3080
3103
|
* @readonly
|
|
@@ -3088,7 +3111,7 @@ interface Refund {
|
|
|
3088
3111
|
*/
|
|
3089
3112
|
requestingServiceAppId?: string | null;
|
|
3090
3113
|
}
|
|
3091
|
-
interface RefundTransaction {
|
|
3114
|
+
export interface RefundTransaction {
|
|
3092
3115
|
/**
|
|
3093
3116
|
* ID of the payment associated with this refund.
|
|
3094
3117
|
* @format GUID
|
|
@@ -3119,7 +3142,7 @@ interface RefundTransaction {
|
|
|
3119
3142
|
externalRefund?: boolean;
|
|
3120
3143
|
}
|
|
3121
3144
|
/** Refund transaction status. */
|
|
3122
|
-
declare enum RefundStatus {
|
|
3145
|
+
export declare enum RefundStatus {
|
|
3123
3146
|
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
3124
3147
|
PENDING = "PENDING",
|
|
3125
3148
|
/** Refund transaction succeeded. */
|
|
@@ -3131,7 +3154,7 @@ declare enum RefundStatus {
|
|
|
3131
3154
|
/** Refund was initiated on payment provider side. */
|
|
3132
3155
|
STARTED = "STARTED"
|
|
3133
3156
|
}
|
|
3134
|
-
interface RefundStatusInfo {
|
|
3157
|
+
export interface RefundStatusInfo {
|
|
3135
3158
|
/**
|
|
3136
3159
|
* Reason code for the refund's current status.
|
|
3137
3160
|
*
|
|
@@ -3147,7 +3170,7 @@ interface RefundStatusInfo {
|
|
|
3147
3170
|
*/
|
|
3148
3171
|
description?: string | null;
|
|
3149
3172
|
}
|
|
3150
|
-
interface AggregatedRefundSummary {
|
|
3173
|
+
export interface AggregatedRefundSummary {
|
|
3151
3174
|
/** Total amount requested for refund. */
|
|
3152
3175
|
requestedRefund?: Price;
|
|
3153
3176
|
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
@@ -3161,14 +3184,14 @@ interface AggregatedRefundSummary {
|
|
|
3161
3184
|
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
3162
3185
|
breakdown?: RefundItemsBreakdown;
|
|
3163
3186
|
}
|
|
3164
|
-
interface RefundItemsBreakdown {
|
|
3187
|
+
export interface RefundItemsBreakdown {
|
|
3165
3188
|
/**
|
|
3166
3189
|
* Refunded line items and the amount refunded for each.
|
|
3167
3190
|
* @maxSize 300
|
|
3168
3191
|
*/
|
|
3169
3192
|
lineItems?: LineItemRefundSummary[];
|
|
3170
3193
|
}
|
|
3171
|
-
interface LineItemRefundSummary {
|
|
3194
|
+
export interface LineItemRefundSummary {
|
|
3172
3195
|
/**
|
|
3173
3196
|
* ID of the refunded line item.
|
|
3174
3197
|
* @format GUID
|
|
@@ -3177,7 +3200,7 @@ interface LineItemRefundSummary {
|
|
|
3177
3200
|
/** Total refunded amount for the line item. */
|
|
3178
3201
|
totalRefundedAmount?: Price;
|
|
3179
3202
|
}
|
|
3180
|
-
interface CalculateRefundRequest {
|
|
3203
|
+
export interface CalculateRefundRequest {
|
|
3181
3204
|
/**
|
|
3182
3205
|
* Order ID
|
|
3183
3206
|
* @minLength 1
|
|
@@ -3192,12 +3215,12 @@ interface CalculateRefundRequest {
|
|
|
3192
3215
|
/** Should include shipping in refund calculation */
|
|
3193
3216
|
refundShipping?: boolean;
|
|
3194
3217
|
}
|
|
3195
|
-
interface CalculateRefundItemRequest {
|
|
3218
|
+
export interface CalculateRefundItemRequest {
|
|
3196
3219
|
/**
|
|
3197
3220
|
* ID of the line item being refunded
|
|
3198
3221
|
* @format GUID
|
|
3199
3222
|
*/
|
|
3200
|
-
|
|
3223
|
+
id?: string;
|
|
3201
3224
|
/**
|
|
3202
3225
|
* How much of that line item is being refunded
|
|
3203
3226
|
* @min 1
|
|
@@ -3205,7 +3228,7 @@ interface CalculateRefundItemRequest {
|
|
|
3205
3228
|
*/
|
|
3206
3229
|
quantity?: number;
|
|
3207
3230
|
}
|
|
3208
|
-
interface CalculateRefundResponse {
|
|
3231
|
+
export interface CalculateRefundResponse {
|
|
3209
3232
|
/** Total refundable amount */
|
|
3210
3233
|
total?: Price;
|
|
3211
3234
|
/** Tax cost of the order */
|
|
@@ -3224,16 +3247,16 @@ interface CalculateRefundResponse {
|
|
|
3224
3247
|
*/
|
|
3225
3248
|
items?: CalculateRefundItemResponse[];
|
|
3226
3249
|
}
|
|
3227
|
-
interface CalculateRefundItemResponse {
|
|
3250
|
+
export interface CalculateRefundItemResponse {
|
|
3228
3251
|
/**
|
|
3229
3252
|
* Line item ID
|
|
3230
3253
|
* @format GUID
|
|
3231
3254
|
*/
|
|
3232
|
-
|
|
3255
|
+
id?: string;
|
|
3233
3256
|
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
3234
3257
|
price?: Price;
|
|
3235
3258
|
}
|
|
3236
|
-
interface VoidAuthorizedPaymentsRequest {
|
|
3259
|
+
export interface VoidAuthorizedPaymentsRequest {
|
|
3237
3260
|
/**
|
|
3238
3261
|
* Wix eCommerce order ID
|
|
3239
3262
|
* @minLength 1
|
|
@@ -3248,11 +3271,11 @@ interface VoidAuthorizedPaymentsRequest {
|
|
|
3248
3271
|
*/
|
|
3249
3272
|
paymentIds: string[];
|
|
3250
3273
|
}
|
|
3251
|
-
interface VoidAuthorizedPaymentsResponse {
|
|
3274
|
+
export interface VoidAuthorizedPaymentsResponse {
|
|
3252
3275
|
/** All order's transactions after the void was triggered */
|
|
3253
3276
|
orderTransactions?: OrderTransactions;
|
|
3254
3277
|
}
|
|
3255
|
-
interface CaptureAuthorizedPaymentsRequest {
|
|
3278
|
+
export interface CaptureAuthorizedPaymentsRequest {
|
|
3256
3279
|
/**
|
|
3257
3280
|
* Wix eCommerce order ID
|
|
3258
3281
|
* @minLength 1
|
|
@@ -3266,7 +3289,7 @@ interface CaptureAuthorizedPaymentsRequest {
|
|
|
3266
3289
|
*/
|
|
3267
3290
|
payments: PaymentCapture[];
|
|
3268
3291
|
}
|
|
3269
|
-
interface PaymentCapture {
|
|
3292
|
+
export interface PaymentCapture {
|
|
3270
3293
|
/**
|
|
3271
3294
|
* Payment ID
|
|
3272
3295
|
* @format GUID
|
|
@@ -3278,11 +3301,11 @@ interface PaymentCapture {
|
|
|
3278
3301
|
*/
|
|
3279
3302
|
amount?: Price;
|
|
3280
3303
|
}
|
|
3281
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
3304
|
+
export interface CaptureAuthorizedPaymentsResponse {
|
|
3282
3305
|
/** All order's transactions after the capture was triggered */
|
|
3283
3306
|
orderTransactions?: OrderTransactions;
|
|
3284
3307
|
}
|
|
3285
|
-
interface ChargeSavedPaymentMethodRequest {
|
|
3308
|
+
export interface ChargeSavedPaymentMethodRequest {
|
|
3286
3309
|
/**
|
|
3287
3310
|
* Ecom Order ID.
|
|
3288
3311
|
* @minLength 1
|
|
@@ -3292,11 +3315,11 @@ interface ChargeSavedPaymentMethodRequest {
|
|
|
3292
3315
|
/** Amount to be charged */
|
|
3293
3316
|
amount?: Price;
|
|
3294
3317
|
}
|
|
3295
|
-
interface ChargeSavedPaymentMethodResponse {
|
|
3318
|
+
export interface ChargeSavedPaymentMethodResponse {
|
|
3296
3319
|
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
3297
3320
|
paymentGatewayOrderId?: string;
|
|
3298
3321
|
}
|
|
3299
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3322
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3300
3323
|
createdEvent?: EntityCreatedEvent;
|
|
3301
3324
|
updatedEvent?: EntityUpdatedEvent;
|
|
3302
3325
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3305,7 +3328,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3305
3328
|
* Unique event ID.
|
|
3306
3329
|
* Allows clients to ignore duplicate webhooks.
|
|
3307
3330
|
*/
|
|
3308
|
-
|
|
3331
|
+
id?: string;
|
|
3309
3332
|
/**
|
|
3310
3333
|
* Assumes actions are also always typed to an entity_type
|
|
3311
3334
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -3339,36 +3362,38 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3339
3362
|
entityEventSequence?: string | null;
|
|
3340
3363
|
}
|
|
3341
3364
|
/** @oneof */
|
|
3342
|
-
interface DomainEventBodyOneOf {
|
|
3365
|
+
export interface DomainEventBodyOneOf {
|
|
3343
3366
|
createdEvent?: EntityCreatedEvent;
|
|
3344
3367
|
updatedEvent?: EntityUpdatedEvent;
|
|
3345
3368
|
deletedEvent?: EntityDeletedEvent;
|
|
3346
3369
|
actionEvent?: ActionEvent;
|
|
3347
3370
|
}
|
|
3348
|
-
interface EntityCreatedEvent {
|
|
3349
|
-
|
|
3371
|
+
export interface EntityCreatedEvent {
|
|
3372
|
+
entityAsJson?: string;
|
|
3373
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3374
|
+
restoreInfo?: RestoreInfo;
|
|
3350
3375
|
}
|
|
3351
|
-
interface RestoreInfo {
|
|
3376
|
+
export interface RestoreInfo {
|
|
3352
3377
|
deletedDate?: Date | null;
|
|
3353
3378
|
}
|
|
3354
|
-
interface EntityUpdatedEvent {
|
|
3379
|
+
export interface EntityUpdatedEvent {
|
|
3355
3380
|
/**
|
|
3356
3381
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3357
3382
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3358
3383
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3359
3384
|
*/
|
|
3360
|
-
|
|
3385
|
+
currentEntityAsJson?: string;
|
|
3361
3386
|
}
|
|
3362
|
-
interface EntityDeletedEvent {
|
|
3387
|
+
export interface EntityDeletedEvent {
|
|
3363
3388
|
/** Entity that was deleted */
|
|
3364
|
-
|
|
3389
|
+
deletedEntityAsJson?: string | null;
|
|
3365
3390
|
}
|
|
3366
|
-
interface ActionEvent {
|
|
3367
|
-
|
|
3391
|
+
export interface ActionEvent {
|
|
3392
|
+
bodyAsJson?: string;
|
|
3368
3393
|
}
|
|
3369
|
-
interface Empty {
|
|
3394
|
+
export interface Empty {
|
|
3370
3395
|
}
|
|
3371
|
-
interface MessageEnvelope {
|
|
3396
|
+
export interface MessageEnvelope {
|
|
3372
3397
|
/**
|
|
3373
3398
|
* App instance ID.
|
|
3374
3399
|
* @format GUID
|
|
@@ -3384,7 +3409,7 @@ interface MessageEnvelope {
|
|
|
3384
3409
|
/** Stringify payload. */
|
|
3385
3410
|
data?: string;
|
|
3386
3411
|
}
|
|
3387
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3412
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3388
3413
|
/**
|
|
3389
3414
|
* ID of a site visitor that has not logged in to the site.
|
|
3390
3415
|
* @format GUID
|
|
@@ -3409,7 +3434,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3409
3434
|
identityType?: WebhookIdentityType;
|
|
3410
3435
|
}
|
|
3411
3436
|
/** @oneof */
|
|
3412
|
-
interface IdentificationDataIdOneOf {
|
|
3437
|
+
export interface IdentificationDataIdOneOf {
|
|
3413
3438
|
/**
|
|
3414
3439
|
* ID of a site visitor that has not logged in to the site.
|
|
3415
3440
|
* @format GUID
|
|
@@ -3431,14 +3456,14 @@ interface IdentificationDataIdOneOf {
|
|
|
3431
3456
|
*/
|
|
3432
3457
|
appId?: string;
|
|
3433
3458
|
}
|
|
3434
|
-
declare enum WebhookIdentityType {
|
|
3459
|
+
export declare enum WebhookIdentityType {
|
|
3435
3460
|
UNKNOWN = "UNKNOWN",
|
|
3436
3461
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3437
3462
|
MEMBER = "MEMBER",
|
|
3438
3463
|
WIX_USER = "WIX_USER",
|
|
3439
3464
|
APP = "APP"
|
|
3440
3465
|
}
|
|
3441
|
-
declare enum TextDetection {
|
|
3466
|
+
export declare enum TextDetection {
|
|
3442
3467
|
/** No detection was made */
|
|
3443
3468
|
UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
|
|
3444
3469
|
/** The image contains text */
|
|
@@ -3446,7 +3471,7 @@ declare enum TextDetection {
|
|
|
3446
3471
|
/** The image does not contain text */
|
|
3447
3472
|
NO_TEXT = "NO_TEXT"
|
|
3448
3473
|
}
|
|
3449
|
-
declare enum AnimationDetection {
|
|
3474
|
+
export declare enum AnimationDetection {
|
|
3450
3475
|
/** No detection was made */
|
|
3451
3476
|
UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
|
|
3452
3477
|
/** The image contains animation */
|
|
@@ -3454,37 +3479,37 @@ declare enum AnimationDetection {
|
|
|
3454
3479
|
/** The image does not contain animation */
|
|
3455
3480
|
NO_ANIMATION = "NO_ANIMATION"
|
|
3456
3481
|
}
|
|
3457
|
-
interface ImageContent {
|
|
3482
|
+
export interface ImageContent {
|
|
3458
3483
|
/** Text detection */
|
|
3459
3484
|
text?: TextDetection;
|
|
3460
3485
|
/** Animation detection */
|
|
3461
3486
|
animation?: AnimationDetection;
|
|
3462
3487
|
}
|
|
3463
|
-
interface SendBuyerConfirmationEmailRequest {
|
|
3488
|
+
export interface SendBuyerConfirmationEmailRequest {
|
|
3464
3489
|
/** @format GUID */
|
|
3465
3490
|
orderId?: string;
|
|
3466
3491
|
}
|
|
3467
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
3492
|
+
export interface SendBuyerConfirmationEmailResponse {
|
|
3468
3493
|
}
|
|
3469
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3494
|
+
export interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3470
3495
|
/**
|
|
3471
3496
|
* @minLength 1
|
|
3472
3497
|
* @maxLength 100
|
|
3473
3498
|
*/
|
|
3474
3499
|
orderId?: string;
|
|
3475
3500
|
}
|
|
3476
|
-
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
3501
|
+
export interface SendBuyerPaymentsReceivedEmailResponse {
|
|
3477
3502
|
}
|
|
3478
|
-
interface SendBuyerPickupConfirmationEmailRequest {
|
|
3503
|
+
export interface SendBuyerPickupConfirmationEmailRequest {
|
|
3479
3504
|
/**
|
|
3480
3505
|
* @minLength 1
|
|
3481
3506
|
* @maxLength 100
|
|
3482
3507
|
*/
|
|
3483
3508
|
orderId?: string;
|
|
3484
3509
|
}
|
|
3485
|
-
interface SendBuyerPickupConfirmationEmailResponse {
|
|
3510
|
+
export interface SendBuyerPickupConfirmationEmailResponse {
|
|
3486
3511
|
}
|
|
3487
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3512
|
+
export interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3488
3513
|
/**
|
|
3489
3514
|
* IDs of orders to send pickup emails for.
|
|
3490
3515
|
* @minSize 1
|
|
@@ -3492,18 +3517,18 @@ interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
|
3492
3517
|
*/
|
|
3493
3518
|
orderIds?: string[];
|
|
3494
3519
|
}
|
|
3495
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3520
|
+
export interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3496
3521
|
}
|
|
3497
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
3522
|
+
export interface SendBuyerShippingConfirmationEmailRequest {
|
|
3498
3523
|
/**
|
|
3499
3524
|
* @minLength 1
|
|
3500
3525
|
* @maxLength 100
|
|
3501
3526
|
*/
|
|
3502
3527
|
orderId?: string;
|
|
3503
3528
|
}
|
|
3504
|
-
interface SendBuyerShippingConfirmationEmailResponse {
|
|
3529
|
+
export interface SendBuyerShippingConfirmationEmailResponse {
|
|
3505
3530
|
}
|
|
3506
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3531
|
+
export interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3507
3532
|
/**
|
|
3508
3533
|
* IDs of orders to send pickup emails for.
|
|
3509
3534
|
* @minSize 1
|
|
@@ -3511,18 +3536,18 @@ interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
|
3511
3536
|
*/
|
|
3512
3537
|
orderIds?: string[];
|
|
3513
3538
|
}
|
|
3514
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3539
|
+
export interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3515
3540
|
}
|
|
3516
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
3541
|
+
export interface SendMerchantOrderReceivedNotificationRequest {
|
|
3517
3542
|
/**
|
|
3518
3543
|
* @minLength 1
|
|
3519
3544
|
* @maxLength 100
|
|
3520
3545
|
*/
|
|
3521
3546
|
orderId?: string;
|
|
3522
3547
|
}
|
|
3523
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
3548
|
+
export interface SendMerchantOrderReceivedNotificationResponse {
|
|
3524
3549
|
}
|
|
3525
|
-
interface SendCancelRefundEmailRequest {
|
|
3550
|
+
export interface SendCancelRefundEmailRequest {
|
|
3526
3551
|
/**
|
|
3527
3552
|
* The ID of order that is canceled/refunded
|
|
3528
3553
|
* @minLength 1
|
|
@@ -3543,9 +3568,9 @@ interface SendCancelRefundEmailRequest {
|
|
|
3543
3568
|
*/
|
|
3544
3569
|
refundId?: string | null;
|
|
3545
3570
|
}
|
|
3546
|
-
interface SendCancelRefundEmailResponse {
|
|
3571
|
+
export interface SendCancelRefundEmailResponse {
|
|
3547
3572
|
}
|
|
3548
|
-
interface SendRefundEmailRequest {
|
|
3573
|
+
export interface SendRefundEmailRequest {
|
|
3549
3574
|
/**
|
|
3550
3575
|
* The ID of order that is refunded
|
|
3551
3576
|
* @format GUID
|
|
@@ -3563,30 +3588,30 @@ interface SendRefundEmailRequest {
|
|
|
3563
3588
|
*/
|
|
3564
3589
|
customMessage?: string | null;
|
|
3565
3590
|
}
|
|
3566
|
-
interface SendRefundEmailResponse {
|
|
3591
|
+
export interface SendRefundEmailResponse {
|
|
3567
3592
|
}
|
|
3568
|
-
interface SendMerchantOrderReceivedPushRequest {
|
|
3593
|
+
export interface SendMerchantOrderReceivedPushRequest {
|
|
3569
3594
|
/**
|
|
3570
3595
|
* @minLength 1
|
|
3571
3596
|
* @maxLength 100
|
|
3572
3597
|
*/
|
|
3573
3598
|
orderId?: string;
|
|
3574
3599
|
}
|
|
3575
|
-
interface SendMerchantOrderReceivedPushResponse {
|
|
3600
|
+
export interface SendMerchantOrderReceivedPushResponse {
|
|
3576
3601
|
}
|
|
3577
|
-
interface PreviewEmailByTypeRequest {
|
|
3602
|
+
export interface PreviewEmailByTypeRequest {
|
|
3578
3603
|
emailType?: PreviewEmailType;
|
|
3579
3604
|
}
|
|
3580
|
-
declare enum PreviewEmailType {
|
|
3605
|
+
export declare enum PreviewEmailType {
|
|
3581
3606
|
ORDER_PLACED = "ORDER_PLACED",
|
|
3582
3607
|
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
3583
3608
|
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
3584
3609
|
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
3585
3610
|
}
|
|
3586
|
-
interface PreviewEmailByTypeResponse {
|
|
3611
|
+
export interface PreviewEmailByTypeResponse {
|
|
3587
3612
|
emailPreview?: string;
|
|
3588
3613
|
}
|
|
3589
|
-
interface PreviewRefundEmailRequest {
|
|
3614
|
+
export interface PreviewRefundEmailRequest {
|
|
3590
3615
|
/**
|
|
3591
3616
|
* @minLength 1
|
|
3592
3617
|
* @maxLength 100
|
|
@@ -3608,10 +3633,10 @@ interface PreviewRefundEmailRequest {
|
|
|
3608
3633
|
*/
|
|
3609
3634
|
refundId?: string | null;
|
|
3610
3635
|
}
|
|
3611
|
-
interface PreviewRefundEmailResponse {
|
|
3636
|
+
export interface PreviewRefundEmailResponse {
|
|
3612
3637
|
emailPreview?: string;
|
|
3613
3638
|
}
|
|
3614
|
-
interface PreviewCancelEmailRequest {
|
|
3639
|
+
export interface PreviewCancelEmailRequest {
|
|
3615
3640
|
/**
|
|
3616
3641
|
* @minLength 1
|
|
3617
3642
|
* @maxLength 100
|
|
@@ -3624,10 +3649,10 @@ interface PreviewCancelEmailRequest {
|
|
|
3624
3649
|
*/
|
|
3625
3650
|
customMessage?: string | null;
|
|
3626
3651
|
}
|
|
3627
|
-
interface PreviewCancelEmailResponse {
|
|
3652
|
+
export interface PreviewCancelEmailResponse {
|
|
3628
3653
|
emailPreview?: string;
|
|
3629
3654
|
}
|
|
3630
|
-
interface PreviewCancelRefundEmailRequest {
|
|
3655
|
+
export interface PreviewCancelRefundEmailRequest {
|
|
3631
3656
|
/**
|
|
3632
3657
|
* @minLength 1
|
|
3633
3658
|
* @maxLength 100
|
|
@@ -3647,35 +3672,35 @@ interface PreviewCancelRefundEmailRequest {
|
|
|
3647
3672
|
*/
|
|
3648
3673
|
refundId?: string | null;
|
|
3649
3674
|
}
|
|
3650
|
-
interface PreviewCancelRefundEmailResponse {
|
|
3675
|
+
export interface PreviewCancelRefundEmailResponse {
|
|
3651
3676
|
emailPreview?: string;
|
|
3652
3677
|
}
|
|
3653
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
3678
|
+
export interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
3654
3679
|
}
|
|
3655
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
3680
|
+
export interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
3656
3681
|
emailPreview?: string;
|
|
3657
3682
|
}
|
|
3658
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
3683
|
+
export interface PreviewBuyerConfirmationEmailRequest {
|
|
3659
3684
|
}
|
|
3660
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
3685
|
+
export interface PreviewBuyerConfirmationEmailResponse {
|
|
3661
3686
|
emailPreview?: string;
|
|
3662
3687
|
}
|
|
3663
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
3688
|
+
export interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
3664
3689
|
}
|
|
3665
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
3690
|
+
export interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
3666
3691
|
emailPreview?: string;
|
|
3667
3692
|
}
|
|
3668
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
3693
|
+
export interface PreviewShippingConfirmationEmailRequest {
|
|
3669
3694
|
}
|
|
3670
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
3695
|
+
export interface PreviewShippingConfirmationEmailResponse {
|
|
3671
3696
|
emailPreview?: string;
|
|
3672
3697
|
}
|
|
3673
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
3698
|
+
export interface PreviewResendDownloadLinksEmailRequest {
|
|
3674
3699
|
}
|
|
3675
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
3700
|
+
export interface PreviewResendDownloadLinksEmailResponse {
|
|
3676
3701
|
emailPreview?: string;
|
|
3677
3702
|
}
|
|
3678
|
-
interface TriggerReindexOrderRequest {
|
|
3703
|
+
export interface TriggerReindexOrderRequest {
|
|
3679
3704
|
/** @format GUID */
|
|
3680
3705
|
metasiteId?: string;
|
|
3681
3706
|
/**
|
|
@@ -3684,18 +3709,18 @@ interface TriggerReindexOrderRequest {
|
|
|
3684
3709
|
*/
|
|
3685
3710
|
orderId?: string;
|
|
3686
3711
|
}
|
|
3687
|
-
interface SnapshotMessage {
|
|
3688
|
-
|
|
3712
|
+
export interface SnapshotMessage {
|
|
3713
|
+
id?: string;
|
|
3689
3714
|
opType?: number;
|
|
3690
3715
|
}
|
|
3691
|
-
interface GetMetasiteDataRequest {
|
|
3716
|
+
export interface GetMetasiteDataRequest {
|
|
3692
3717
|
/**
|
|
3693
3718
|
* meta site Id for data to retrieve
|
|
3694
3719
|
* @format GUID
|
|
3695
3720
|
*/
|
|
3696
3721
|
metasiteId?: string;
|
|
3697
3722
|
}
|
|
3698
|
-
interface GetMetasiteDataResponse {
|
|
3723
|
+
export interface GetMetasiteDataResponse {
|
|
3699
3724
|
/** meta site data */
|
|
3700
3725
|
metasite?: MetaSite;
|
|
3701
3726
|
/** is metasite added to new SDL population via population manager */
|
|
@@ -3713,7 +3738,7 @@ interface GetMetasiteDataResponse {
|
|
|
3713
3738
|
*
|
|
3714
3739
|
* We prefer to pronounce it as 2 separate words, therefore we use terms "meta site" or "metaSite" or "meta_site" in code.
|
|
3715
3740
|
*/
|
|
3716
|
-
interface MetaSite {
|
|
3741
|
+
export interface MetaSite {
|
|
3717
3742
|
/**
|
|
3718
3743
|
* Identifier of meta site.
|
|
3719
3744
|
* @format GUID
|
|
@@ -3834,7 +3859,7 @@ interface MetaSite {
|
|
|
3834
3859
|
*/
|
|
3835
3860
|
accountCreatedDate?: Date | null;
|
|
3836
3861
|
}
|
|
3837
|
-
interface App {
|
|
3862
|
+
export interface App {
|
|
3838
3863
|
/**
|
|
3839
3864
|
* Identifier of application type (application definition id).
|
|
3840
3865
|
*
|
|
@@ -3869,7 +3894,7 @@ interface App {
|
|
|
3869
3894
|
* Represents the actual state of the application on site. Do not confuse with the State in the old MetaSiteDTO,
|
|
3870
3895
|
* which has less values and doesn't have 1-to-1 correspondence with this one (this one is exact and correct!)
|
|
3871
3896
|
*/
|
|
3872
|
-
declare enum State {
|
|
3897
|
+
export declare enum State {
|
|
3873
3898
|
UNKNOWN = "UNKNOWN",
|
|
3874
3899
|
/** App is installed on a site. */
|
|
3875
3900
|
ENABLED = "ENABLED",
|
|
@@ -3880,7 +3905,7 @@ declare enum State {
|
|
|
3880
3905
|
/** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
|
|
3881
3906
|
PENDING = "PENDING"
|
|
3882
3907
|
}
|
|
3883
|
-
declare enum Namespace {
|
|
3908
|
+
export declare enum Namespace {
|
|
3884
3909
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
3885
3910
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
3886
3911
|
WIX = "WIX",
|
|
@@ -3962,7 +3987,7 @@ declare enum Namespace {
|
|
|
3962
3987
|
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
3963
3988
|
MIMIR = "MIMIR"
|
|
3964
3989
|
}
|
|
3965
|
-
interface SeoData {
|
|
3990
|
+
export interface SeoData {
|
|
3966
3991
|
/**
|
|
3967
3992
|
* A title.
|
|
3968
3993
|
* @maxLength 255
|
|
@@ -3988,7 +4013,7 @@ interface SeoData {
|
|
|
3988
4013
|
*/
|
|
3989
4014
|
canonicalUrl?: string | null;
|
|
3990
4015
|
}
|
|
3991
|
-
interface MetaTag {
|
|
4016
|
+
export interface MetaTag {
|
|
3992
4017
|
/**
|
|
3993
4018
|
* A name.
|
|
3994
4019
|
* @maxLength 50
|
|
@@ -4003,7 +4028,7 @@ interface MetaTag {
|
|
|
4003
4028
|
property?: boolean;
|
|
4004
4029
|
}
|
|
4005
4030
|
/** Represents an HTML application (HTML site). */
|
|
4006
|
-
interface HtmlApplication {
|
|
4031
|
+
export interface HtmlApplication {
|
|
4007
4032
|
/** Legacy, don't use it if you can. */
|
|
4008
4033
|
intId?: number;
|
|
4009
4034
|
/** Identifier of the instance. */
|
|
@@ -4018,7 +4043,7 @@ interface HtmlApplication {
|
|
|
4018
4043
|
/** Indicates whether this site is managed by Wix Studio. */
|
|
4019
4044
|
studio?: boolean;
|
|
4020
4045
|
}
|
|
4021
|
-
interface ExternalUriMapping {
|
|
4046
|
+
export interface ExternalUriMapping {
|
|
4022
4047
|
/**
|
|
4023
4048
|
* Deprecated.
|
|
4024
4049
|
* @maxLength 255
|
|
@@ -4037,7 +4062,7 @@ interface ExternalUriMapping {
|
|
|
4037
4062
|
/** Deprecated. */
|
|
4038
4063
|
requireDomain?: boolean | null;
|
|
4039
4064
|
}
|
|
4040
|
-
interface UserDataResponse {
|
|
4065
|
+
export interface UserDataResponse {
|
|
4041
4066
|
userEmail?: string;
|
|
4042
4067
|
/** owner name */
|
|
4043
4068
|
userName?: string;
|
|
@@ -4046,7 +4071,7 @@ interface UserDataResponse {
|
|
|
4046
4071
|
/** owner language */
|
|
4047
4072
|
userLanguage?: string;
|
|
4048
4073
|
}
|
|
4049
|
-
interface QueryOrdersForMetasiteRequest {
|
|
4074
|
+
export interface QueryOrdersForMetasiteRequest {
|
|
4050
4075
|
/**
|
|
4051
4076
|
* meta site Id for EP orders to retrieve
|
|
4052
4077
|
* @format GUID
|
|
@@ -4055,11 +4080,11 @@ interface QueryOrdersForMetasiteRequest {
|
|
|
4055
4080
|
/** paginated internal orders query request */
|
|
4056
4081
|
internalQueryOrdersRequest?: InternalQueryOrdersRequest;
|
|
4057
4082
|
}
|
|
4058
|
-
interface InternalQueryOrdersRequest {
|
|
4083
|
+
export interface InternalQueryOrdersRequest {
|
|
4059
4084
|
/** Query options. */
|
|
4060
4085
|
query?: PlatformQuery;
|
|
4061
4086
|
}
|
|
4062
|
-
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
4087
|
+
export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
4063
4088
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4064
4089
|
paging?: PlatformPaging;
|
|
4065
4090
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
@@ -4070,13 +4095,13 @@ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
4070
4095
|
sort?: Sorting[];
|
|
4071
4096
|
}
|
|
4072
4097
|
/** @oneof */
|
|
4073
|
-
interface PlatformQueryPagingMethodOneOf {
|
|
4098
|
+
export interface PlatformQueryPagingMethodOneOf {
|
|
4074
4099
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4075
4100
|
paging?: PlatformPaging;
|
|
4076
4101
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
4077
4102
|
cursorPaging?: CursorPaging;
|
|
4078
4103
|
}
|
|
4079
|
-
interface Sorting {
|
|
4104
|
+
export interface Sorting {
|
|
4080
4105
|
/**
|
|
4081
4106
|
* Name of the field to sort by.
|
|
4082
4107
|
* @maxLength 512
|
|
@@ -4085,11 +4110,11 @@ interface Sorting {
|
|
|
4085
4110
|
/** Sort order. */
|
|
4086
4111
|
order?: SortOrder;
|
|
4087
4112
|
}
|
|
4088
|
-
declare enum SortOrder {
|
|
4113
|
+
export declare enum SortOrder {
|
|
4089
4114
|
ASC = "ASC",
|
|
4090
4115
|
DESC = "DESC"
|
|
4091
4116
|
}
|
|
4092
|
-
interface PlatformPaging {
|
|
4117
|
+
export interface PlatformPaging {
|
|
4093
4118
|
/**
|
|
4094
4119
|
* Number of items to load.
|
|
4095
4120
|
* @max 100
|
|
@@ -4098,7 +4123,7 @@ interface PlatformPaging {
|
|
|
4098
4123
|
/** Number of items to skip in the current sort order. */
|
|
4099
4124
|
offset?: number | null;
|
|
4100
4125
|
}
|
|
4101
|
-
interface CursorPaging {
|
|
4126
|
+
export interface CursorPaging {
|
|
4102
4127
|
/**
|
|
4103
4128
|
* Maximum number of items to return in the results.
|
|
4104
4129
|
* @max 100
|
|
@@ -4113,13 +4138,13 @@ interface CursorPaging {
|
|
|
4113
4138
|
*/
|
|
4114
4139
|
cursor?: string | null;
|
|
4115
4140
|
}
|
|
4116
|
-
interface QueryOrdersForMetasiteResponse {
|
|
4141
|
+
export interface QueryOrdersForMetasiteResponse {
|
|
4117
4142
|
/** found exisitng orders according to pagination and query provided. */
|
|
4118
4143
|
orders?: Order[];
|
|
4119
4144
|
/** Details on the paged set of results returned. */
|
|
4120
4145
|
pagingMetadata?: PlatformPagingMetadata;
|
|
4121
4146
|
}
|
|
4122
|
-
interface PlatformPagingMetadata {
|
|
4147
|
+
export interface PlatformPagingMetadata {
|
|
4123
4148
|
/** The number of items returned in this response. */
|
|
4124
4149
|
count?: number | null;
|
|
4125
4150
|
/** The offset which was requested. Returned if offset paging was used. */
|
|
@@ -4129,7 +4154,7 @@ interface PlatformPagingMetadata {
|
|
|
4129
4154
|
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
4130
4155
|
cursors?: Cursors;
|
|
4131
4156
|
}
|
|
4132
|
-
interface Cursors {
|
|
4157
|
+
export interface Cursors {
|
|
4133
4158
|
/**
|
|
4134
4159
|
* Cursor string pointing to the next page in the list of results.
|
|
4135
4160
|
* @maxLength 16000
|
|
@@ -4141,7 +4166,7 @@ interface Cursors {
|
|
|
4141
4166
|
*/
|
|
4142
4167
|
prev?: string | null;
|
|
4143
4168
|
}
|
|
4144
|
-
interface GetOrderForMetasiteRequest {
|
|
4169
|
+
export interface GetOrderForMetasiteRequest {
|
|
4145
4170
|
/**
|
|
4146
4171
|
* meta site Id for EP order to retrieve
|
|
4147
4172
|
* @format GUID
|
|
@@ -4154,11 +4179,11 @@ interface GetOrderForMetasiteRequest {
|
|
|
4154
4179
|
*/
|
|
4155
4180
|
orderId?: string;
|
|
4156
4181
|
}
|
|
4157
|
-
interface GetOrderForMetasiteResponse {
|
|
4182
|
+
export interface GetOrderForMetasiteResponse {
|
|
4158
4183
|
/** Existing EP order */
|
|
4159
4184
|
order?: Order;
|
|
4160
4185
|
}
|
|
4161
|
-
interface ListOrderTransactionsForMetasiteRequest {
|
|
4186
|
+
export interface ListOrderTransactionsForMetasiteRequest {
|
|
4162
4187
|
/**
|
|
4163
4188
|
* meta site Id for EP order transactions to retrieve
|
|
4164
4189
|
* @format GUID
|
|
@@ -4170,11 +4195,11 @@ interface ListOrderTransactionsForMetasiteRequest {
|
|
|
4170
4195
|
*/
|
|
4171
4196
|
orderId?: string;
|
|
4172
4197
|
}
|
|
4173
|
-
interface ListOrderTransactionsForMetasiteResponse {
|
|
4198
|
+
export interface ListOrderTransactionsForMetasiteResponse {
|
|
4174
4199
|
/** Order ID and its associated transactions. */
|
|
4175
4200
|
orderTransactions?: OrderTransactions;
|
|
4176
4201
|
}
|
|
4177
|
-
interface UpsertRefundRequest {
|
|
4202
|
+
export interface UpsertRefundRequest {
|
|
4178
4203
|
/**
|
|
4179
4204
|
* Meta site ID.
|
|
4180
4205
|
* @format GUID
|
|
@@ -4188,11 +4213,11 @@ interface UpsertRefundRequest {
|
|
|
4188
4213
|
/** Refund to upsert. */
|
|
4189
4214
|
refund?: Refund;
|
|
4190
4215
|
}
|
|
4191
|
-
interface UpsertRefundResponse {
|
|
4216
|
+
export interface UpsertRefundResponse {
|
|
4192
4217
|
/** Updated order transactions. */
|
|
4193
4218
|
orderTransactions?: OrderTransactions;
|
|
4194
4219
|
}
|
|
4195
|
-
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
4220
|
+
export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
4196
4221
|
/** insert/update documents */
|
|
4197
4222
|
update?: InternalDocumentUpdateOperation;
|
|
4198
4223
|
/** delete by document ids */
|
|
@@ -4233,7 +4258,7 @@ interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOpera
|
|
|
4233
4258
|
issuedAt?: Date | null;
|
|
4234
4259
|
}
|
|
4235
4260
|
/** @oneof */
|
|
4236
|
-
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
4261
|
+
export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
4237
4262
|
/** insert/update documents */
|
|
4238
4263
|
update?: InternalDocumentUpdateOperation;
|
|
4239
4264
|
/** delete by document ids */
|
|
@@ -4249,39 +4274,39 @@ interface UpdateInternalDocumentsEventOperationOneOf {
|
|
|
4249
4274
|
/** delete by document ids with versioning */
|
|
4250
4275
|
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
4251
4276
|
}
|
|
4252
|
-
interface InternalDocument {
|
|
4277
|
+
export interface InternalDocument {
|
|
4253
4278
|
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
4254
4279
|
document?: Record<string, any> | null;
|
|
4255
4280
|
}
|
|
4256
|
-
interface InternalDocumentUpdateOperation {
|
|
4281
|
+
export interface InternalDocumentUpdateOperation {
|
|
4257
4282
|
/** documents to index or update */
|
|
4258
4283
|
documents?: InternalDocument[];
|
|
4259
4284
|
}
|
|
4260
|
-
interface DeleteByIdsOperation {
|
|
4285
|
+
export interface DeleteByIdsOperation {
|
|
4261
4286
|
/** ids of the documents to delete */
|
|
4262
4287
|
documentIds?: string[];
|
|
4263
4288
|
}
|
|
4264
|
-
interface DeleteByFilterOperation {
|
|
4289
|
+
export interface DeleteByFilterOperation {
|
|
4265
4290
|
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
4266
4291
|
filter?: Record<string, any> | null;
|
|
4267
4292
|
}
|
|
4268
|
-
interface InternalDocumentUpdateByFilterOperation {
|
|
4293
|
+
export interface InternalDocumentUpdateByFilterOperation {
|
|
4269
4294
|
/** documents matching this filter will be updated */
|
|
4270
4295
|
filter?: Record<string, any> | null;
|
|
4271
4296
|
/** partial document to apply */
|
|
4272
4297
|
document?: InternalDocument;
|
|
4273
4298
|
}
|
|
4274
|
-
interface InternalUpdateExistingOperation {
|
|
4299
|
+
export interface InternalUpdateExistingOperation {
|
|
4275
4300
|
/** documents to update */
|
|
4276
4301
|
documents?: InternalDocument[];
|
|
4277
4302
|
}
|
|
4278
|
-
interface VersionedDocumentUpdateOperation {
|
|
4303
|
+
export interface VersionedDocumentUpdateOperation {
|
|
4279
4304
|
/** documents to create or overwrite */
|
|
4280
4305
|
documents?: InternalDocument[];
|
|
4281
4306
|
/** versioning mode to use instead of default */
|
|
4282
4307
|
versioningMode?: VersioningMode;
|
|
4283
4308
|
}
|
|
4284
|
-
declare enum VersioningMode {
|
|
4309
|
+
export declare enum VersioningMode {
|
|
4285
4310
|
/** use default versioning mode agreed with search team */
|
|
4286
4311
|
DEFAULT = "DEFAULT",
|
|
4287
4312
|
/** execute only if version is greater than existing */
|
|
@@ -4289,11 +4314,11 @@ declare enum VersioningMode {
|
|
|
4289
4314
|
/** execute only if version is greater or equal to existing */
|
|
4290
4315
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
4291
4316
|
}
|
|
4292
|
-
interface VersionedDeleteByIdsOperation {
|
|
4317
|
+
export interface VersionedDeleteByIdsOperation {
|
|
4293
4318
|
/** ids with version of the documents to delete */
|
|
4294
4319
|
documentIds?: VersionedDocumentId[];
|
|
4295
4320
|
}
|
|
4296
|
-
interface VersionedDocumentId {
|
|
4321
|
+
export interface VersionedDocumentId {
|
|
4297
4322
|
/** document id */
|
|
4298
4323
|
documentId?: string;
|
|
4299
4324
|
/** document version */
|
|
@@ -4301,7 +4326,7 @@ interface VersionedDocumentId {
|
|
|
4301
4326
|
/** versioning mode to use instead of default */
|
|
4302
4327
|
versioningMode?: VersioningMode;
|
|
4303
4328
|
}
|
|
4304
|
-
interface TriggerReindexRequest {
|
|
4329
|
+
export interface TriggerReindexRequest {
|
|
4305
4330
|
/** @format GUID */
|
|
4306
4331
|
metasiteId?: string;
|
|
4307
4332
|
/**
|
|
@@ -4311,13 +4336,13 @@ interface TriggerReindexRequest {
|
|
|
4311
4336
|
*/
|
|
4312
4337
|
orderIds?: string[];
|
|
4313
4338
|
}
|
|
4314
|
-
interface TriggerReindexResponse {
|
|
4339
|
+
export interface TriggerReindexResponse {
|
|
4315
4340
|
}
|
|
4316
|
-
interface BatchOfTriggerReindexOrderRequest {
|
|
4341
|
+
export interface BatchOfTriggerReindexOrderRequest {
|
|
4317
4342
|
/** @maxSize 25 */
|
|
4318
4343
|
requests?: TriggerReindexOrderRequest[];
|
|
4319
4344
|
}
|
|
4320
|
-
interface DiffmatokyPayload {
|
|
4345
|
+
export interface DiffmatokyPayload {
|
|
4321
4346
|
left?: string;
|
|
4322
4347
|
right?: string;
|
|
4323
4348
|
compareChannel?: string;
|
|
@@ -4325,52 +4350,52 @@ interface DiffmatokyPayload {
|
|
|
4325
4350
|
errorInformation?: ErrorInformation;
|
|
4326
4351
|
tags?: string[];
|
|
4327
4352
|
}
|
|
4328
|
-
interface ErrorInformation {
|
|
4353
|
+
export interface ErrorInformation {
|
|
4329
4354
|
stackTrace?: string;
|
|
4330
4355
|
}
|
|
4331
|
-
interface ContinueSideEffectsFlowInLegacyData {
|
|
4356
|
+
export interface ContinueSideEffectsFlowInLegacyData {
|
|
4332
4357
|
storeId?: string;
|
|
4333
4358
|
orderId?: string;
|
|
4334
4359
|
ordersExperiments?: OrdersExperiments;
|
|
4335
4360
|
}
|
|
4336
|
-
interface IndexingMessage {
|
|
4337
|
-
|
|
4361
|
+
export interface IndexingMessage {
|
|
4362
|
+
id?: string;
|
|
4338
4363
|
opType?: number;
|
|
4339
4364
|
requiredVersions?: string[];
|
|
4340
4365
|
}
|
|
4341
|
-
interface GetOrderRequest {
|
|
4366
|
+
export interface GetOrderRequest {
|
|
4342
4367
|
/**
|
|
4343
4368
|
* ID of the order to retrieve.
|
|
4344
4369
|
* @minLength 1
|
|
4345
4370
|
* @maxLength 100
|
|
4346
4371
|
*/
|
|
4347
|
-
|
|
4372
|
+
id: string;
|
|
4348
4373
|
}
|
|
4349
|
-
interface GetOrderResponse {
|
|
4374
|
+
export interface GetOrderResponse {
|
|
4350
4375
|
/** The requested order. */
|
|
4351
4376
|
order?: Order;
|
|
4352
4377
|
}
|
|
4353
|
-
interface InternalQueryOrdersResponse {
|
|
4378
|
+
export interface InternalQueryOrdersResponse {
|
|
4354
4379
|
/** List of orders. */
|
|
4355
4380
|
orders?: Order[];
|
|
4356
4381
|
/** Details on the paged set of results returned. */
|
|
4357
4382
|
metadata?: PlatformPagingMetadata;
|
|
4358
4383
|
}
|
|
4359
|
-
interface QueryOrderRequest {
|
|
4384
|
+
export interface QueryOrderRequest {
|
|
4360
4385
|
/** Query options. */
|
|
4361
4386
|
query?: PlatformQuery;
|
|
4362
4387
|
}
|
|
4363
|
-
interface QueryOrderResponse {
|
|
4388
|
+
export interface QueryOrderResponse {
|
|
4364
4389
|
/** List of orders. */
|
|
4365
4390
|
orders?: Order[];
|
|
4366
4391
|
/** Details on the paged set of results returned. */
|
|
4367
4392
|
metadata?: PlatformPagingMetadata;
|
|
4368
4393
|
}
|
|
4369
|
-
interface SearchOrdersRequest {
|
|
4394
|
+
export interface SearchOrdersRequest {
|
|
4370
4395
|
/** Search options. */
|
|
4371
4396
|
search?: CursorSearch;
|
|
4372
4397
|
}
|
|
4373
|
-
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
4398
|
+
export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
4374
4399
|
/**
|
|
4375
4400
|
* Cursor paging options.
|
|
4376
4401
|
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
@@ -4399,20 +4424,20 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
4399
4424
|
sort?: Sorting[];
|
|
4400
4425
|
}
|
|
4401
4426
|
/** @oneof */
|
|
4402
|
-
interface CursorSearchPagingMethodOneOf {
|
|
4427
|
+
export interface CursorSearchPagingMethodOneOf {
|
|
4403
4428
|
/**
|
|
4404
4429
|
* Cursor paging options.
|
|
4405
4430
|
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
4406
4431
|
*/
|
|
4407
4432
|
cursorPaging?: CursorPaging;
|
|
4408
4433
|
}
|
|
4409
|
-
interface SearchOrdersResponse {
|
|
4434
|
+
export interface SearchOrdersResponse {
|
|
4410
4435
|
/** List of orders. */
|
|
4411
4436
|
orders?: Order[];
|
|
4412
4437
|
/** Details on the paged set of results returned. */
|
|
4413
4438
|
metadata?: CursorPagingMetadata;
|
|
4414
4439
|
}
|
|
4415
|
-
interface CursorPagingMetadata {
|
|
4440
|
+
export interface CursorPagingMetadata {
|
|
4416
4441
|
/** Number of items returned in current page. */
|
|
4417
4442
|
count?: number | null;
|
|
4418
4443
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -4425,13 +4450,13 @@ interface CursorPagingMetadata {
|
|
|
4425
4450
|
*/
|
|
4426
4451
|
hasNext?: boolean | null;
|
|
4427
4452
|
}
|
|
4428
|
-
interface CreateOrderRequest {
|
|
4453
|
+
export interface CreateOrderRequest {
|
|
4429
4454
|
/** Order info. */
|
|
4430
4455
|
order: Order;
|
|
4431
4456
|
/** Determine order lifecycle */
|
|
4432
4457
|
settings?: OrderCreationSettings;
|
|
4433
4458
|
}
|
|
4434
|
-
interface OrderCreationSettings {
|
|
4459
|
+
export interface OrderCreationSettings {
|
|
4435
4460
|
/**
|
|
4436
4461
|
* Condition for the order to be approved.
|
|
4437
4462
|
* Default: `DEFAULT`
|
|
@@ -4440,7 +4465,7 @@ interface OrderCreationSettings {
|
|
|
4440
4465
|
/** Notification settings to be applied on order creation */
|
|
4441
4466
|
notifications?: OrderCreateNotifications;
|
|
4442
4467
|
}
|
|
4443
|
-
declare enum OrderApprovalStrategy {
|
|
4468
|
+
export declare enum OrderApprovalStrategy {
|
|
4444
4469
|
/** Order is automatically approved when `order.priceSummary.total = 0`, **or** after receiving payment. */
|
|
4445
4470
|
DEFAULT = "DEFAULT",
|
|
4446
4471
|
/** Order is automatically approved **only** after receiving payment. */
|
|
@@ -4448,7 +4473,7 @@ declare enum OrderApprovalStrategy {
|
|
|
4448
4473
|
/** Order is automatically approved when payment method is saved for it. */
|
|
4449
4474
|
PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
|
|
4450
4475
|
}
|
|
4451
|
-
interface OrderCreateNotifications {
|
|
4476
|
+
export interface OrderCreateNotifications {
|
|
4452
4477
|
/**
|
|
4453
4478
|
* Whether to send notification to the buyer.
|
|
4454
4479
|
*
|
|
@@ -4462,19 +4487,19 @@ interface OrderCreateNotifications {
|
|
|
4462
4487
|
*/
|
|
4463
4488
|
sendNotificationsToBusiness?: boolean | null;
|
|
4464
4489
|
}
|
|
4465
|
-
interface CreateOrderResponse {
|
|
4490
|
+
export interface CreateOrderResponse {
|
|
4466
4491
|
/** Newly created order. */
|
|
4467
4492
|
order?: Order;
|
|
4468
4493
|
}
|
|
4469
|
-
interface UpdateOrderRequest {
|
|
4494
|
+
export interface UpdateOrderRequest {
|
|
4470
4495
|
/** Order to be updated. */
|
|
4471
4496
|
order: Order;
|
|
4472
4497
|
}
|
|
4473
|
-
interface UpdateOrderResponse {
|
|
4498
|
+
export interface UpdateOrderResponse {
|
|
4474
4499
|
/** Newly created order. */
|
|
4475
4500
|
order?: Order;
|
|
4476
4501
|
}
|
|
4477
|
-
interface BulkUpdateOrdersRequest {
|
|
4502
|
+
export interface BulkUpdateOrdersRequest {
|
|
4478
4503
|
/**
|
|
4479
4504
|
* Orders to update.
|
|
4480
4505
|
* @minSize 1
|
|
@@ -4488,11 +4513,11 @@ interface BulkUpdateOrdersRequest {
|
|
|
4488
4513
|
*/
|
|
4489
4514
|
returnEntity?: boolean;
|
|
4490
4515
|
}
|
|
4491
|
-
interface MaskedOrder {
|
|
4516
|
+
export interface MaskedOrder {
|
|
4492
4517
|
/** Order to be updated. */
|
|
4493
4518
|
order?: Order;
|
|
4494
4519
|
}
|
|
4495
|
-
interface BulkUpdateOrdersResponse {
|
|
4520
|
+
export interface BulkUpdateOrdersResponse {
|
|
4496
4521
|
/**
|
|
4497
4522
|
* Bulk action results.
|
|
4498
4523
|
* @minSize 1
|
|
@@ -4502,9 +4527,9 @@ interface BulkUpdateOrdersResponse {
|
|
|
4502
4527
|
/** Bulk action metadata. */
|
|
4503
4528
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4504
4529
|
}
|
|
4505
|
-
interface CommitDeltasRequest {
|
|
4530
|
+
export interface CommitDeltasRequest {
|
|
4506
4531
|
/** Order id to be updated */
|
|
4507
|
-
|
|
4532
|
+
id: string;
|
|
4508
4533
|
/**
|
|
4509
4534
|
* Draft order Id representing this change.
|
|
4510
4535
|
* Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
|
|
@@ -4521,7 +4546,7 @@ interface CommitDeltasRequest {
|
|
|
4521
4546
|
*/
|
|
4522
4547
|
reason?: string | null;
|
|
4523
4548
|
}
|
|
4524
|
-
interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftOrderDiffsBuyerUpdateInfoOneOf, DraftOrderDiffsBillingUpdateInfoOneOf, DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4549
|
+
export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftOrderDiffsBuyerUpdateInfoOneOf, DraftOrderDiffsBillingUpdateInfoOneOf, DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4525
4550
|
/** Shipping info and selected shipping option details. */
|
|
4526
4551
|
changedShippingInfo?: V1ShippingInformation;
|
|
4527
4552
|
/** Remove existing shipping info. */
|
|
@@ -4559,22 +4584,22 @@ interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftO
|
|
|
4559
4584
|
priceSummary?: PriceSummary;
|
|
4560
4585
|
}
|
|
4561
4586
|
/** @oneof */
|
|
4562
|
-
interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
4587
|
+
export interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
4563
4588
|
/** Shipping info and selected shipping option details. */
|
|
4564
4589
|
changedShippingInfo?: V1ShippingInformation;
|
|
4565
4590
|
/** Remove existing shipping info. */
|
|
4566
4591
|
shippingInfoRemoved?: boolean;
|
|
4567
4592
|
}
|
|
4568
4593
|
/** @oneof */
|
|
4569
|
-
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
4594
|
+
export interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
4570
4595
|
}
|
|
4571
4596
|
/** @oneof */
|
|
4572
|
-
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
4597
|
+
export interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
4573
4598
|
}
|
|
4574
4599
|
/** @oneof */
|
|
4575
|
-
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4600
|
+
export interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4576
4601
|
}
|
|
4577
|
-
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
4602
|
+
export interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
4578
4603
|
/** The line item was added. */
|
|
4579
4604
|
lineItemAdded?: boolean;
|
|
4580
4605
|
/** The line item was modified. */
|
|
@@ -4589,7 +4614,7 @@ interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
|
4589
4614
|
lineItem?: OrderLineItemChangedDetails;
|
|
4590
4615
|
}
|
|
4591
4616
|
/** @oneof */
|
|
4592
|
-
interface V1LineItemDeltaDeltaOneOf {
|
|
4617
|
+
export interface V1LineItemDeltaDeltaOneOf {
|
|
4593
4618
|
/** The line item was added. */
|
|
4594
4619
|
lineItemAdded?: boolean;
|
|
4595
4620
|
/** The line item was modified. */
|
|
@@ -4597,7 +4622,7 @@ interface V1LineItemDeltaDeltaOneOf {
|
|
|
4597
4622
|
/** The line item was added. */
|
|
4598
4623
|
lineItemRemoved?: boolean;
|
|
4599
4624
|
}
|
|
4600
|
-
interface OrderLineItemChangedDetails {
|
|
4625
|
+
export interface OrderLineItemChangedDetails {
|
|
4601
4626
|
/**
|
|
4602
4627
|
* Item name.
|
|
4603
4628
|
* + Stores - `product.name`
|
|
@@ -4624,15 +4649,14 @@ interface OrderLineItemChangedDetails {
|
|
|
4624
4649
|
*/
|
|
4625
4650
|
descriptionLines?: DescriptionLine[];
|
|
4626
4651
|
/** Line item image. */
|
|
4627
|
-
image?:
|
|
4652
|
+
image?: Image;
|
|
4628
4653
|
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
4629
4654
|
physicalProperties?: PhysicalProperties;
|
|
4630
4655
|
/** Item type. Either a preset type or custom. */
|
|
4631
4656
|
itemType?: ItemType;
|
|
4632
4657
|
/**
|
|
4633
4658
|
* Fulfiller ID. Field is empty when the line item is self-fulfilled.
|
|
4634
|
-
*
|
|
4635
|
-
* To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).
|
|
4659
|
+
* To get fulfillment information, pass this order's ID to [List Fulfillments For Single Order](https://bo.wix.com/wix-docs/rest/ecommerce/order-fulfillments/list-fulfillments-for-single-order).
|
|
4636
4660
|
* @format GUID
|
|
4637
4661
|
*/
|
|
4638
4662
|
fulfillerId?: string | null;
|
|
@@ -4676,7 +4700,7 @@ interface OrderLineItemChangedDetails {
|
|
|
4676
4700
|
subscriptionInfo?: SubscriptionInfo;
|
|
4677
4701
|
}
|
|
4678
4702
|
/** Type of selected payment option for catalog item */
|
|
4679
|
-
declare enum DeltaPaymentOptionType {
|
|
4703
|
+
export declare enum DeltaPaymentOptionType {
|
|
4680
4704
|
/** Irrelevant */
|
|
4681
4705
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
4682
4706
|
/** The entire payment for the given item will happen after checkout. */
|
|
@@ -4687,7 +4711,7 @@ declare enum DeltaPaymentOptionType {
|
|
|
4687
4711
|
*/
|
|
4688
4712
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
4689
4713
|
}
|
|
4690
|
-
interface ItemChangedDetails {
|
|
4714
|
+
export interface ItemChangedDetails {
|
|
4691
4715
|
/**
|
|
4692
4716
|
* The quantity before the change.
|
|
4693
4717
|
* @min 1
|
|
@@ -4699,7 +4723,7 @@ interface ItemChangedDetails {
|
|
|
4699
4723
|
/** The price description before the change */
|
|
4700
4724
|
priceDescriptionBeforeChange?: PriceDescription;
|
|
4701
4725
|
}
|
|
4702
|
-
interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
|
|
4726
|
+
export interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
|
|
4703
4727
|
editedDiscount?: AppliedDiscount;
|
|
4704
4728
|
discountRemoved?: boolean;
|
|
4705
4729
|
/**
|
|
@@ -4709,11 +4733,11 @@ interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
|
|
|
4709
4733
|
discountId?: string;
|
|
4710
4734
|
}
|
|
4711
4735
|
/** @oneof */
|
|
4712
|
-
interface AppliedDiscountDeltaDeltaOneOf {
|
|
4736
|
+
export interface AppliedDiscountDeltaDeltaOneOf {
|
|
4713
4737
|
editedDiscount?: AppliedDiscount;
|
|
4714
4738
|
discountRemoved?: boolean;
|
|
4715
4739
|
}
|
|
4716
|
-
interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
|
|
4740
|
+
export interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
|
|
4717
4741
|
editedAdditionalFee?: AdditionalFee;
|
|
4718
4742
|
additionalFeeRemoved?: boolean;
|
|
4719
4743
|
/**
|
|
@@ -4723,11 +4747,11 @@ interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
|
|
|
4723
4747
|
additionalFeeId?: string;
|
|
4724
4748
|
}
|
|
4725
4749
|
/** @oneof */
|
|
4726
|
-
interface AdditionalFeeDeltaDeltaOneOf {
|
|
4750
|
+
export interface AdditionalFeeDeltaDeltaOneOf {
|
|
4727
4751
|
editedAdditionalFee?: AdditionalFee;
|
|
4728
4752
|
additionalFeeRemoved?: boolean;
|
|
4729
4753
|
}
|
|
4730
|
-
interface DraftOrderCommitSettings {
|
|
4754
|
+
export interface DraftOrderCommitSettings {
|
|
4731
4755
|
/** If false, do not send notifications to buyer. Default is true. */
|
|
4732
4756
|
sendNotificationsToBuyer?: boolean | null;
|
|
4733
4757
|
/** If false, do not send notifications to business. Default is true. */
|
|
@@ -4742,7 +4766,7 @@ interface DraftOrderCommitSettings {
|
|
|
4742
4766
|
*/
|
|
4743
4767
|
inventoryUpdates?: InventoryUpdateDetails[];
|
|
4744
4768
|
}
|
|
4745
|
-
interface InventoryUpdateDetails {
|
|
4769
|
+
export interface InventoryUpdateDetails {
|
|
4746
4770
|
/** Action to be applied - decrease or restock */
|
|
4747
4771
|
actionType?: InventoryAction;
|
|
4748
4772
|
/** Order line item id */
|
|
@@ -4750,18 +4774,18 @@ interface InventoryUpdateDetails {
|
|
|
4750
4774
|
/** The amount to be increased or restocked */
|
|
4751
4775
|
quantityChange?: number;
|
|
4752
4776
|
}
|
|
4753
|
-
declare enum InventoryAction {
|
|
4777
|
+
export declare enum InventoryAction {
|
|
4754
4778
|
/** Restock inventory */
|
|
4755
4779
|
RESTOCK = "RESTOCK",
|
|
4756
4780
|
/** Decrease inventory. Without failing on negative inventory. */
|
|
4757
4781
|
DECREASE = "DECREASE"
|
|
4758
4782
|
}
|
|
4759
|
-
interface CommitDeltasResponse {
|
|
4783
|
+
export interface CommitDeltasResponse {
|
|
4760
4784
|
/** Order after deltas are applied */
|
|
4761
4785
|
order?: Order;
|
|
4762
4786
|
}
|
|
4763
4787
|
/** Triggered when order is edited by draftOrders */
|
|
4764
|
-
interface OrderDeltasCommitted {
|
|
4788
|
+
export interface OrderDeltasCommitted {
|
|
4765
4789
|
/** The order after committed changes. */
|
|
4766
4790
|
order?: Order;
|
|
4767
4791
|
/** Draft order Id representing this change. */
|
|
@@ -4776,7 +4800,7 @@ interface OrderDeltasCommitted {
|
|
|
4776
4800
|
*/
|
|
4777
4801
|
commitDate?: Date | null;
|
|
4778
4802
|
}
|
|
4779
|
-
interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
|
|
4803
|
+
export interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
|
|
4780
4804
|
/** Shipping info and selected shipping option details. */
|
|
4781
4805
|
changedShippingInfo?: V1ShippingInformation;
|
|
4782
4806
|
/** Remove existing shipping info. */
|
|
@@ -4798,13 +4822,13 @@ interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
|
|
|
4798
4822
|
additionalFees?: AdditionalFeeDelta[];
|
|
4799
4823
|
}
|
|
4800
4824
|
/** @oneof */
|
|
4801
|
-
interface CommittedDiffsShippingUpdateInfoOneOf {
|
|
4825
|
+
export interface CommittedDiffsShippingUpdateInfoOneOf {
|
|
4802
4826
|
/** Shipping info and selected shipping option details. */
|
|
4803
4827
|
changedShippingInfo?: V1ShippingInformation;
|
|
4804
4828
|
/** Remove existing shipping info. */
|
|
4805
4829
|
shippingInfoRemoved?: boolean;
|
|
4806
4830
|
}
|
|
4807
|
-
interface LineItemDelta extends LineItemDeltaDeltaOneOf {
|
|
4831
|
+
export interface LineItemDelta extends LineItemDeltaDeltaOneOf {
|
|
4808
4832
|
lineItemAdded?: boolean;
|
|
4809
4833
|
changedDetails?: ItemChangedDetails;
|
|
4810
4834
|
lineItemRemoved?: OrderLineItemChangedDetails;
|
|
@@ -4815,24 +4839,24 @@ interface LineItemDelta extends LineItemDeltaDeltaOneOf {
|
|
|
4815
4839
|
lineItemId?: string;
|
|
4816
4840
|
}
|
|
4817
4841
|
/** @oneof */
|
|
4818
|
-
interface LineItemDeltaDeltaOneOf {
|
|
4842
|
+
export interface LineItemDeltaDeltaOneOf {
|
|
4819
4843
|
lineItemAdded?: boolean;
|
|
4820
4844
|
changedDetails?: ItemChangedDetails;
|
|
4821
4845
|
lineItemRemoved?: OrderLineItemChangedDetails;
|
|
4822
4846
|
}
|
|
4823
|
-
interface ArchiveOrderRequest {
|
|
4847
|
+
export interface ArchiveOrderRequest {
|
|
4824
4848
|
/**
|
|
4825
4849
|
* Order ID.
|
|
4826
4850
|
* @minLength 1
|
|
4827
4851
|
* @maxLength 100
|
|
4828
4852
|
*/
|
|
4829
|
-
|
|
4853
|
+
id?: string;
|
|
4830
4854
|
}
|
|
4831
|
-
interface ArchiveOrderResponse {
|
|
4855
|
+
export interface ArchiveOrderResponse {
|
|
4832
4856
|
/** Archived order. */
|
|
4833
4857
|
order?: Order;
|
|
4834
4858
|
}
|
|
4835
|
-
interface BulkArchiveOrdersRequest {
|
|
4859
|
+
export interface BulkArchiveOrdersRequest {
|
|
4836
4860
|
/**
|
|
4837
4861
|
* IDs of orders to archive.
|
|
4838
4862
|
* @minSize 1
|
|
@@ -4842,35 +4866,35 @@ interface BulkArchiveOrdersRequest {
|
|
|
4842
4866
|
/** Whether to return the full updated order entities in the response. */
|
|
4843
4867
|
returnFullEntity?: boolean;
|
|
4844
4868
|
}
|
|
4845
|
-
interface BulkArchiveOrdersResponse {
|
|
4869
|
+
export interface BulkArchiveOrdersResponse {
|
|
4846
4870
|
/** Items updated by bulk action. */
|
|
4847
4871
|
results?: BulkOrderResult[];
|
|
4848
4872
|
/** Bulk action metadata. */
|
|
4849
4873
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4850
4874
|
}
|
|
4851
|
-
interface BulkArchiveOrdersByFilterRequest {
|
|
4875
|
+
export interface BulkArchiveOrdersByFilterRequest {
|
|
4852
4876
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
4853
4877
|
filter?: Record<string, any> | null;
|
|
4854
4878
|
}
|
|
4855
|
-
interface BulkArchiveOrdersByFilterResponse {
|
|
4879
|
+
export interface BulkArchiveOrdersByFilterResponse {
|
|
4856
4880
|
/** Items updated by bulk action. */
|
|
4857
4881
|
results?: BulkOrderResult[];
|
|
4858
4882
|
/** Bulk action metadata. */
|
|
4859
4883
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4860
4884
|
}
|
|
4861
|
-
interface UnArchiveOrderRequest {
|
|
4885
|
+
export interface UnArchiveOrderRequest {
|
|
4862
4886
|
/**
|
|
4863
4887
|
* Order ID.
|
|
4864
4888
|
* @minLength 1
|
|
4865
4889
|
* @maxLength 100
|
|
4866
4890
|
*/
|
|
4867
|
-
|
|
4891
|
+
id?: string;
|
|
4868
4892
|
}
|
|
4869
|
-
interface UnArchiveOrderResponse {
|
|
4893
|
+
export interface UnArchiveOrderResponse {
|
|
4870
4894
|
/** Unarchived order. */
|
|
4871
4895
|
order?: Order;
|
|
4872
4896
|
}
|
|
4873
|
-
interface BulkUnArchiveOrdersRequest {
|
|
4897
|
+
export interface BulkUnArchiveOrdersRequest {
|
|
4874
4898
|
/**
|
|
4875
4899
|
* IDs or orders to unarchive.
|
|
4876
4900
|
* @minSize 1
|
|
@@ -4880,34 +4904,34 @@ interface BulkUnArchiveOrdersRequest {
|
|
|
4880
4904
|
/** Whether to return the full updated order entities in the response. */
|
|
4881
4905
|
returnFullEntity?: boolean;
|
|
4882
4906
|
}
|
|
4883
|
-
interface BulkUnArchiveOrdersResponse {
|
|
4907
|
+
export interface BulkUnArchiveOrdersResponse {
|
|
4884
4908
|
/** Items updated by bulk action. */
|
|
4885
4909
|
results?: BulkOrderResult[];
|
|
4886
4910
|
/** Bulk action metadata. */
|
|
4887
4911
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4888
4912
|
}
|
|
4889
|
-
interface BulkUnArchiveOrdersByFilterRequest {
|
|
4913
|
+
export interface BulkUnArchiveOrdersByFilterRequest {
|
|
4890
4914
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
4891
4915
|
filter?: Record<string, any> | null;
|
|
4892
4916
|
}
|
|
4893
|
-
interface BulkUnArchiveOrdersByFilterResponse {
|
|
4917
|
+
export interface BulkUnArchiveOrdersByFilterResponse {
|
|
4894
4918
|
/** Items updated by bulk action. */
|
|
4895
4919
|
results?: BulkOrderResult[];
|
|
4896
4920
|
/** Bulk action metadata. */
|
|
4897
4921
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4898
4922
|
}
|
|
4899
|
-
interface UpdateBuyerInfoRequest {
|
|
4923
|
+
export interface UpdateBuyerInfoRequest {
|
|
4900
4924
|
/**
|
|
4901
4925
|
* Order ID.
|
|
4902
4926
|
* @minLength 1
|
|
4903
4927
|
* @maxLength 100
|
|
4904
4928
|
* @readonly
|
|
4905
4929
|
*/
|
|
4906
|
-
|
|
4930
|
+
id?: string;
|
|
4907
4931
|
/** Buyer info. */
|
|
4908
4932
|
buyerInfo?: BuyerInfoUpdate;
|
|
4909
4933
|
}
|
|
4910
|
-
interface BuyerInfoUpdate {
|
|
4934
|
+
export interface BuyerInfoUpdate {
|
|
4911
4935
|
/**
|
|
4912
4936
|
* Contact ID.
|
|
4913
4937
|
* @format GUID
|
|
@@ -4919,67 +4943,67 @@ interface BuyerInfoUpdate {
|
|
|
4919
4943
|
*/
|
|
4920
4944
|
email?: string | null;
|
|
4921
4945
|
}
|
|
4922
|
-
interface UpdateBuyerInfoResponse {
|
|
4946
|
+
export interface UpdateBuyerInfoResponse {
|
|
4923
4947
|
/** Updated order. */
|
|
4924
4948
|
order?: Order;
|
|
4925
4949
|
}
|
|
4926
|
-
interface UpdateBuyerEmailRequest {
|
|
4950
|
+
export interface UpdateBuyerEmailRequest {
|
|
4927
4951
|
/**
|
|
4928
4952
|
* @minLength 1
|
|
4929
4953
|
* @maxLength 100
|
|
4930
4954
|
* @readonly
|
|
4931
4955
|
*/
|
|
4932
|
-
|
|
4956
|
+
id?: string;
|
|
4933
4957
|
/** @format EMAIL */
|
|
4934
4958
|
email?: string | null;
|
|
4935
4959
|
}
|
|
4936
|
-
interface UpdateBuyerEmailResponse {
|
|
4960
|
+
export interface UpdateBuyerEmailResponse {
|
|
4937
4961
|
order?: Order;
|
|
4938
4962
|
}
|
|
4939
|
-
interface UpdateOrderShippingAddressRequest {
|
|
4963
|
+
export interface UpdateOrderShippingAddressRequest {
|
|
4940
4964
|
/**
|
|
4941
4965
|
* Order ID.
|
|
4942
4966
|
* @minLength 1
|
|
4943
4967
|
* @maxLength 100
|
|
4944
4968
|
*/
|
|
4945
|
-
|
|
4969
|
+
id?: string;
|
|
4946
4970
|
/** Shipping address and contact details to be updated. */
|
|
4947
4971
|
shippingAddress?: AddressWithContact;
|
|
4948
4972
|
}
|
|
4949
|
-
interface UpdateOrderShippingAddressResponse {
|
|
4973
|
+
export interface UpdateOrderShippingAddressResponse {
|
|
4950
4974
|
/** Updated order. */
|
|
4951
4975
|
order?: Order;
|
|
4952
4976
|
}
|
|
4953
|
-
interface UpdateBillingContactDetailsRequest {
|
|
4977
|
+
export interface UpdateBillingContactDetailsRequest {
|
|
4954
4978
|
/**
|
|
4955
4979
|
* Order ID.
|
|
4956
4980
|
* @minLength 1
|
|
4957
4981
|
* @maxLength 100
|
|
4958
4982
|
* @readonly
|
|
4959
4983
|
*/
|
|
4960
|
-
|
|
4984
|
+
id?: string;
|
|
4961
4985
|
/** Contact details. */
|
|
4962
4986
|
addressContactDetails?: FullAddressContactDetails;
|
|
4963
4987
|
}
|
|
4964
|
-
interface UpdateBillingContactDetailsResponse {
|
|
4988
|
+
export interface UpdateBillingContactDetailsResponse {
|
|
4965
4989
|
/** Updated order. */
|
|
4966
4990
|
order?: Order;
|
|
4967
4991
|
}
|
|
4968
|
-
interface UpdateOrderLineItemRequest {
|
|
4992
|
+
export interface UpdateOrderLineItemRequest {
|
|
4969
4993
|
/**
|
|
4970
4994
|
* Order ID
|
|
4971
4995
|
* @minLength 1
|
|
4972
4996
|
* @maxLength 100
|
|
4973
4997
|
*/
|
|
4974
|
-
|
|
4998
|
+
id: string;
|
|
4975
4999
|
/** Order line item to update */
|
|
4976
5000
|
lineItem: OrderLineItem;
|
|
4977
5001
|
}
|
|
4978
|
-
interface UpdateOrderLineItemResponse {
|
|
5002
|
+
export interface UpdateOrderLineItemResponse {
|
|
4979
5003
|
/** Updated order data */
|
|
4980
5004
|
order?: Order;
|
|
4981
5005
|
}
|
|
4982
|
-
interface UpdateOrderLineItemsRequest {
|
|
5006
|
+
export interface UpdateOrderLineItemsRequest {
|
|
4983
5007
|
/**
|
|
4984
5008
|
* Order ID
|
|
4985
5009
|
* @minLength 1
|
|
@@ -4993,25 +5017,25 @@ interface UpdateOrderLineItemsRequest {
|
|
|
4993
5017
|
*/
|
|
4994
5018
|
lineItems?: MaskedOrderLineItem[];
|
|
4995
5019
|
}
|
|
4996
|
-
interface MaskedOrderLineItem {
|
|
5020
|
+
export interface MaskedOrderLineItem {
|
|
4997
5021
|
/** Order line item to update */
|
|
4998
5022
|
lineItem?: OrderLineItem;
|
|
4999
5023
|
}
|
|
5000
|
-
interface UpdateOrderLineItemsResponse {
|
|
5024
|
+
export interface UpdateOrderLineItemsResponse {
|
|
5001
5025
|
/** Updated order data */
|
|
5002
5026
|
order?: Order;
|
|
5003
5027
|
}
|
|
5004
|
-
interface AddInternalActivityRequest {
|
|
5028
|
+
export interface AddInternalActivityRequest {
|
|
5005
5029
|
/**
|
|
5006
5030
|
* Order ID.
|
|
5007
5031
|
* @minLength 1
|
|
5008
5032
|
* @maxLength 100
|
|
5009
5033
|
*/
|
|
5010
|
-
|
|
5034
|
+
id?: string;
|
|
5011
5035
|
/** Activity info. */
|
|
5012
5036
|
activity?: InternalActivity;
|
|
5013
5037
|
}
|
|
5014
|
-
interface InternalActivity extends InternalActivityContentOneOf {
|
|
5038
|
+
export interface InternalActivity extends InternalActivityContentOneOf {
|
|
5015
5039
|
/** Order refunded. */
|
|
5016
5040
|
orderRefunded?: OrderRefunded;
|
|
5017
5041
|
/** Order placed. */
|
|
@@ -5071,7 +5095,7 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5071
5095
|
* @format GUID
|
|
5072
5096
|
* @readonly
|
|
5073
5097
|
*/
|
|
5074
|
-
|
|
5098
|
+
id?: string | null;
|
|
5075
5099
|
/**
|
|
5076
5100
|
* Internal activity author's email.
|
|
5077
5101
|
* @format EMAIL
|
|
@@ -5082,10 +5106,10 @@ interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5082
5106
|
* Internal activity creation date and time.
|
|
5083
5107
|
* @readonly
|
|
5084
5108
|
*/
|
|
5085
|
-
|
|
5109
|
+
createdDate?: Date | null;
|
|
5086
5110
|
}
|
|
5087
5111
|
/** @oneof */
|
|
5088
|
-
interface InternalActivityContentOneOf {
|
|
5112
|
+
export interface InternalActivityContentOneOf {
|
|
5089
5113
|
/** Order refunded. */
|
|
5090
5114
|
orderRefunded?: OrderRefunded;
|
|
5091
5115
|
/** Order placed. */
|
|
@@ -5142,63 +5166,63 @@ interface InternalActivityContentOneOf {
|
|
|
5142
5166
|
orderRejected?: OrderRejected;
|
|
5143
5167
|
}
|
|
5144
5168
|
/** Order placed */
|
|
5145
|
-
interface OrderPlaced {
|
|
5169
|
+
export interface OrderPlaced {
|
|
5146
5170
|
}
|
|
5147
5171
|
/** Order marked as paid, either by the store owner (for offline orders), or when an online transaction was confirmed */
|
|
5148
|
-
interface OrderPaid {
|
|
5172
|
+
export interface OrderPaid {
|
|
5149
5173
|
}
|
|
5150
5174
|
/** Order shipping status set as fulfilled */
|
|
5151
|
-
interface OrderFulfilled {
|
|
5175
|
+
export interface OrderFulfilled {
|
|
5152
5176
|
}
|
|
5153
5177
|
/** Order shipping status set as not fulfilled */
|
|
5154
|
-
interface OrderNotFulfilled {
|
|
5178
|
+
export interface OrderNotFulfilled {
|
|
5155
5179
|
}
|
|
5156
5180
|
/** Order canceled */
|
|
5157
|
-
interface OrderCanceled {
|
|
5181
|
+
export interface OrderCanceled {
|
|
5158
5182
|
}
|
|
5159
5183
|
/** A download link was sent (relevant for orders with digital line items) */
|
|
5160
|
-
interface DownloadLinkSent {
|
|
5184
|
+
export interface DownloadLinkSent {
|
|
5161
5185
|
}
|
|
5162
5186
|
/** Shipping tracking number was set */
|
|
5163
|
-
interface TrackingNumberAdded {
|
|
5187
|
+
export interface TrackingNumberAdded {
|
|
5164
5188
|
}
|
|
5165
5189
|
/** Shipping tracking number was edited */
|
|
5166
|
-
interface TrackingNumberEdited {
|
|
5190
|
+
export interface TrackingNumberEdited {
|
|
5167
5191
|
}
|
|
5168
5192
|
/** Shipping tracking link was set */
|
|
5169
|
-
interface TrackingLinkAdded {
|
|
5193
|
+
export interface TrackingLinkAdded {
|
|
5170
5194
|
}
|
|
5171
5195
|
/** An email confirmation of order shipment was sent */
|
|
5172
|
-
interface ShippingConfirmationEmailSent {
|
|
5196
|
+
export interface ShippingConfirmationEmailSent {
|
|
5173
5197
|
}
|
|
5174
5198
|
/** Invoice was set in the order */
|
|
5175
|
-
interface InvoiceAdded {
|
|
5199
|
+
export interface InvoiceAdded {
|
|
5176
5200
|
}
|
|
5177
5201
|
/** Invoice sent to customer via email */
|
|
5178
|
-
interface InvoiceSent {
|
|
5202
|
+
export interface InvoiceSent {
|
|
5179
5203
|
}
|
|
5180
5204
|
/** Email was sent to fulfiller */
|
|
5181
|
-
interface FulfillerEmailSent {
|
|
5205
|
+
export interface FulfillerEmailSent {
|
|
5182
5206
|
}
|
|
5183
5207
|
/** Shipping address was updated */
|
|
5184
|
-
interface ShippingAddressEdited {
|
|
5208
|
+
export interface ShippingAddressEdited {
|
|
5185
5209
|
}
|
|
5186
5210
|
/** Order email was updated */
|
|
5187
|
-
interface EmailEdited {
|
|
5211
|
+
export interface EmailEdited {
|
|
5188
5212
|
}
|
|
5189
5213
|
/** An email notification for pickup was sent */
|
|
5190
|
-
interface PickupReadyEmailSent {
|
|
5214
|
+
export interface PickupReadyEmailSent {
|
|
5191
5215
|
}
|
|
5192
5216
|
/** Order marked as partially paid when an online transaction was confirmed with partial minimal required amount of total sum */
|
|
5193
|
-
interface OrderPartiallyPaid {
|
|
5217
|
+
export interface OrderPartiallyPaid {
|
|
5194
5218
|
}
|
|
5195
5219
|
/** Order reject */
|
|
5196
|
-
interface OrderPending {
|
|
5220
|
+
export interface OrderPending {
|
|
5197
5221
|
}
|
|
5198
5222
|
/** Order reject */
|
|
5199
|
-
interface OrderRejected {
|
|
5223
|
+
export interface OrderRejected {
|
|
5200
5224
|
}
|
|
5201
|
-
interface AddInternalActivityResponse {
|
|
5225
|
+
export interface AddInternalActivityResponse {
|
|
5202
5226
|
/** Updated order. */
|
|
5203
5227
|
order?: Order;
|
|
5204
5228
|
/**
|
|
@@ -5208,30 +5232,30 @@ interface AddInternalActivityResponse {
|
|
|
5208
5232
|
*/
|
|
5209
5233
|
activityId?: string;
|
|
5210
5234
|
}
|
|
5211
|
-
interface AddActivityRequest {
|
|
5235
|
+
export interface AddActivityRequest {
|
|
5212
5236
|
/**
|
|
5213
5237
|
* Order ID.
|
|
5214
5238
|
* @minLength 1
|
|
5215
5239
|
* @maxLength 100
|
|
5216
5240
|
*/
|
|
5217
|
-
|
|
5241
|
+
id: string;
|
|
5218
5242
|
/** Activity info. */
|
|
5219
5243
|
activity: PublicActivity;
|
|
5220
5244
|
}
|
|
5221
|
-
interface PublicActivity extends PublicActivityContentOneOf {
|
|
5245
|
+
export interface PublicActivity extends PublicActivityContentOneOf {
|
|
5222
5246
|
/** Custom activity details. */
|
|
5223
5247
|
customActivity?: CustomActivity;
|
|
5224
5248
|
/** Merchant commment. */
|
|
5225
5249
|
merchantComment?: MerchantComment;
|
|
5226
5250
|
}
|
|
5227
5251
|
/** @oneof */
|
|
5228
|
-
interface PublicActivityContentOneOf {
|
|
5252
|
+
export interface PublicActivityContentOneOf {
|
|
5229
5253
|
/** Custom activity details. */
|
|
5230
5254
|
customActivity?: CustomActivity;
|
|
5231
5255
|
/** Merchant commment. */
|
|
5232
5256
|
merchantComment?: MerchantComment;
|
|
5233
5257
|
}
|
|
5234
|
-
interface AddActivityResponse {
|
|
5258
|
+
export interface AddActivityResponse {
|
|
5235
5259
|
/** Updated order. */
|
|
5236
5260
|
order?: Order;
|
|
5237
5261
|
/**
|
|
@@ -5241,7 +5265,7 @@ interface AddActivityResponse {
|
|
|
5241
5265
|
*/
|
|
5242
5266
|
activityId?: string;
|
|
5243
5267
|
}
|
|
5244
|
-
interface AddActivitiesRequest {
|
|
5268
|
+
export interface AddActivitiesRequest {
|
|
5245
5269
|
/**
|
|
5246
5270
|
* Order ID.
|
|
5247
5271
|
* @format GUID
|
|
@@ -5254,7 +5278,7 @@ interface AddActivitiesRequest {
|
|
|
5254
5278
|
*/
|
|
5255
5279
|
activities?: PublicActivity[];
|
|
5256
5280
|
}
|
|
5257
|
-
interface AddActivitiesResponse {
|
|
5281
|
+
export interface AddActivitiesResponse {
|
|
5258
5282
|
/** Updated order. */
|
|
5259
5283
|
order?: Order;
|
|
5260
5284
|
/**
|
|
@@ -5264,13 +5288,13 @@ interface AddActivitiesResponse {
|
|
|
5264
5288
|
*/
|
|
5265
5289
|
activityIds?: string[];
|
|
5266
5290
|
}
|
|
5267
|
-
interface UpdateActivityRequest {
|
|
5291
|
+
export interface UpdateActivityRequest {
|
|
5268
5292
|
/**
|
|
5269
5293
|
* Order ID.
|
|
5270
5294
|
* @minLength 1
|
|
5271
5295
|
* @maxLength 100
|
|
5272
5296
|
*/
|
|
5273
|
-
|
|
5297
|
+
id: string;
|
|
5274
5298
|
/**
|
|
5275
5299
|
* ID of the activity to update.
|
|
5276
5300
|
* @format GUID
|
|
@@ -5279,34 +5303,34 @@ interface UpdateActivityRequest {
|
|
|
5279
5303
|
/** Activity info. */
|
|
5280
5304
|
activity: PublicActivity;
|
|
5281
5305
|
}
|
|
5282
|
-
interface UpdateActivityResponse {
|
|
5306
|
+
export interface UpdateActivityResponse {
|
|
5283
5307
|
/** Updated order. */
|
|
5284
5308
|
order?: Order;
|
|
5285
5309
|
}
|
|
5286
|
-
interface DeleteActivityRequest {
|
|
5310
|
+
export interface DeleteActivityRequest {
|
|
5287
5311
|
/**
|
|
5288
5312
|
* Order ID.
|
|
5289
5313
|
* @minLength 1
|
|
5290
5314
|
* @maxLength 100
|
|
5291
5315
|
*/
|
|
5292
|
-
|
|
5316
|
+
id: string;
|
|
5293
5317
|
/**
|
|
5294
5318
|
* ID of the activity to delete.
|
|
5295
5319
|
* @format GUID
|
|
5296
5320
|
*/
|
|
5297
5321
|
activityId: string;
|
|
5298
5322
|
}
|
|
5299
|
-
interface DeleteActivityResponse {
|
|
5323
|
+
export interface DeleteActivityResponse {
|
|
5300
5324
|
/** Updated order. */
|
|
5301
5325
|
order?: Order;
|
|
5302
5326
|
}
|
|
5303
|
-
interface UpdateLineItemsDescriptionLinesRequest {
|
|
5327
|
+
export interface UpdateLineItemsDescriptionLinesRequest {
|
|
5304
5328
|
/**
|
|
5305
5329
|
* Order ID.
|
|
5306
5330
|
* @minLength 1
|
|
5307
5331
|
* @maxLength 100
|
|
5308
5332
|
*/
|
|
5309
|
-
|
|
5333
|
+
id?: string;
|
|
5310
5334
|
/**
|
|
5311
5335
|
* Line items.
|
|
5312
5336
|
* @minSize 1
|
|
@@ -5314,7 +5338,7 @@ interface UpdateLineItemsDescriptionLinesRequest {
|
|
|
5314
5338
|
*/
|
|
5315
5339
|
lineItems?: LineItemUpdate[];
|
|
5316
5340
|
}
|
|
5317
|
-
interface LineItemUpdate {
|
|
5341
|
+
export interface LineItemUpdate {
|
|
5318
5342
|
/**
|
|
5319
5343
|
* Line item ID.
|
|
5320
5344
|
* @format GUID
|
|
@@ -5328,29 +5352,29 @@ interface LineItemUpdate {
|
|
|
5328
5352
|
*/
|
|
5329
5353
|
descriptionLines?: DescriptionLine[];
|
|
5330
5354
|
}
|
|
5331
|
-
interface UpdateLineItemsDescriptionLinesResponse {
|
|
5355
|
+
export interface UpdateLineItemsDescriptionLinesResponse {
|
|
5332
5356
|
/** Updated order. */
|
|
5333
5357
|
order?: Order;
|
|
5334
5358
|
}
|
|
5335
|
-
interface MarkOrderAsSeenByHumanRequest {
|
|
5359
|
+
export interface MarkOrderAsSeenByHumanRequest {
|
|
5336
5360
|
/**
|
|
5337
5361
|
* Order ID.
|
|
5338
5362
|
* @minLength 1
|
|
5339
5363
|
* @maxLength 100
|
|
5340
5364
|
*/
|
|
5341
|
-
|
|
5365
|
+
id?: string;
|
|
5342
5366
|
}
|
|
5343
|
-
interface MarkOrderAsSeenByHumanResponse {
|
|
5367
|
+
export interface MarkOrderAsSeenByHumanResponse {
|
|
5344
5368
|
/** Updated order. */
|
|
5345
5369
|
order?: Order;
|
|
5346
5370
|
}
|
|
5347
|
-
interface CancelOrderRequest {
|
|
5371
|
+
export interface CancelOrderRequest {
|
|
5348
5372
|
/**
|
|
5349
5373
|
* Order ID.
|
|
5350
5374
|
* @minLength 1
|
|
5351
5375
|
* @maxLength 100
|
|
5352
5376
|
*/
|
|
5353
|
-
|
|
5377
|
+
id: string;
|
|
5354
5378
|
/** Whether to send an order canceled email to the buyer. */
|
|
5355
5379
|
sendOrderCanceledEmail?: boolean;
|
|
5356
5380
|
/**
|
|
@@ -5362,11 +5386,11 @@ interface CancelOrderRequest {
|
|
|
5362
5386
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
5363
5387
|
restockAllItems?: boolean;
|
|
5364
5388
|
}
|
|
5365
|
-
interface CancelOrderResponse {
|
|
5389
|
+
export interface CancelOrderResponse {
|
|
5366
5390
|
/** Canceled order. */
|
|
5367
5391
|
order?: Order;
|
|
5368
5392
|
}
|
|
5369
|
-
interface OrderCanceledEventOrderCanceled {
|
|
5393
|
+
export interface OrderCanceledEventOrderCanceled {
|
|
5370
5394
|
/** The order that was cancelled */
|
|
5371
5395
|
order?: Order;
|
|
5372
5396
|
/** Should restock all items on that order */
|
|
@@ -5376,7 +5400,7 @@ interface OrderCanceledEventOrderCanceled {
|
|
|
5376
5400
|
/** Personal note added to the email */
|
|
5377
5401
|
customMessage?: string | null;
|
|
5378
5402
|
}
|
|
5379
|
-
interface UpdateOrderStatusRequest {
|
|
5403
|
+
export interface UpdateOrderStatusRequest {
|
|
5380
5404
|
/**
|
|
5381
5405
|
* Order ID.
|
|
5382
5406
|
* @format GUID
|
|
@@ -5385,24 +5409,24 @@ interface UpdateOrderStatusRequest {
|
|
|
5385
5409
|
/** New order status. */
|
|
5386
5410
|
status: OrderStatus;
|
|
5387
5411
|
}
|
|
5388
|
-
interface UpdateOrderStatusResponse {
|
|
5412
|
+
export interface UpdateOrderStatusResponse {
|
|
5389
5413
|
/** Updated order. */
|
|
5390
5414
|
order?: Order;
|
|
5391
5415
|
}
|
|
5392
|
-
interface MarkAsFulfilledRequest {
|
|
5416
|
+
export interface MarkAsFulfilledRequest {
|
|
5393
5417
|
/**
|
|
5394
5418
|
* Order ID.
|
|
5395
5419
|
* @minLength 1
|
|
5396
5420
|
* @maxLength 100
|
|
5397
5421
|
*/
|
|
5398
|
-
|
|
5422
|
+
id?: string;
|
|
5399
5423
|
}
|
|
5400
|
-
interface MarkAsFulfilledResponse {
|
|
5424
|
+
export interface MarkAsFulfilledResponse {
|
|
5401
5425
|
/** Updated order. */
|
|
5402
5426
|
order?: Order;
|
|
5403
5427
|
}
|
|
5404
5428
|
/** Triggered when the fulfillment status of an order is updated */
|
|
5405
|
-
interface FulfillmentStatusUpdated {
|
|
5429
|
+
export interface FulfillmentStatusUpdated {
|
|
5406
5430
|
/** The order that was updated */
|
|
5407
5431
|
order?: Order;
|
|
5408
5432
|
/** The previous status (before the update) */
|
|
@@ -5412,7 +5436,7 @@ interface FulfillmentStatusUpdated {
|
|
|
5412
5436
|
/** the action that caused this update */
|
|
5413
5437
|
action?: string;
|
|
5414
5438
|
}
|
|
5415
|
-
interface BulkMarkAsFulfilledRequest {
|
|
5439
|
+
export interface BulkMarkAsFulfilledRequest {
|
|
5416
5440
|
/**
|
|
5417
5441
|
* IDs of orders to be marked as fulfilled.
|
|
5418
5442
|
* @minSize 1
|
|
@@ -5422,35 +5446,35 @@ interface BulkMarkAsFulfilledRequest {
|
|
|
5422
5446
|
/** Whether to return the full updated order entities in the response. */
|
|
5423
5447
|
returnFullEntity?: boolean;
|
|
5424
5448
|
}
|
|
5425
|
-
interface BulkMarkAsFulfilledResponse {
|
|
5449
|
+
export interface BulkMarkAsFulfilledResponse {
|
|
5426
5450
|
/** Items updated by bulk action. */
|
|
5427
5451
|
results?: BulkOrderResult[];
|
|
5428
5452
|
/** Bulk action metadata. */
|
|
5429
5453
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5430
5454
|
}
|
|
5431
|
-
interface BulkMarkAsFulfilledByFilterRequest {
|
|
5455
|
+
export interface BulkMarkAsFulfilledByFilterRequest {
|
|
5432
5456
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
5433
5457
|
filter?: Record<string, any> | null;
|
|
5434
5458
|
}
|
|
5435
|
-
interface BulkMarkAsFulfilledByFilterResponse {
|
|
5459
|
+
export interface BulkMarkAsFulfilledByFilterResponse {
|
|
5436
5460
|
/** Items updated by bulk action. */
|
|
5437
5461
|
results?: BulkOrderResult[];
|
|
5438
5462
|
/** Bulk action metadata. */
|
|
5439
5463
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5440
5464
|
}
|
|
5441
|
-
interface MarkAsUnfulfilledRequest {
|
|
5465
|
+
export interface MarkAsUnfulfilledRequest {
|
|
5442
5466
|
/**
|
|
5443
5467
|
* Order ID.
|
|
5444
5468
|
* @minLength 1
|
|
5445
5469
|
* @maxLength 100
|
|
5446
5470
|
*/
|
|
5447
|
-
|
|
5471
|
+
id?: string;
|
|
5448
5472
|
}
|
|
5449
|
-
interface MarkAsUnfulfilledResponse {
|
|
5473
|
+
export interface MarkAsUnfulfilledResponse {
|
|
5450
5474
|
/** Updated order. */
|
|
5451
5475
|
order?: Order;
|
|
5452
5476
|
}
|
|
5453
|
-
interface BulkMarkAsUnfulfilledRequest {
|
|
5477
|
+
export interface BulkMarkAsUnfulfilledRequest {
|
|
5454
5478
|
/**
|
|
5455
5479
|
* IDs of orders to be marked as not fulfilled.
|
|
5456
5480
|
* @minSize 1
|
|
@@ -5460,23 +5484,23 @@ interface BulkMarkAsUnfulfilledRequest {
|
|
|
5460
5484
|
/** Whether to return the full updated order entities in the response. */
|
|
5461
5485
|
returnFullEntity?: boolean;
|
|
5462
5486
|
}
|
|
5463
|
-
interface BulkMarkAsUnfulfilledResponse {
|
|
5487
|
+
export interface BulkMarkAsUnfulfilledResponse {
|
|
5464
5488
|
/** Items updated by bulk action. */
|
|
5465
5489
|
results?: BulkOrderResult[];
|
|
5466
5490
|
/** Bulk action metadata. */
|
|
5467
5491
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5468
5492
|
}
|
|
5469
|
-
interface BulkMarkAsUnfulfilledByFilterRequest {
|
|
5493
|
+
export interface BulkMarkAsUnfulfilledByFilterRequest {
|
|
5470
5494
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
5471
5495
|
filter?: Record<string, any> | null;
|
|
5472
5496
|
}
|
|
5473
|
-
interface BulkMarkAsUnfulfilledByFilterResponse {
|
|
5497
|
+
export interface BulkMarkAsUnfulfilledByFilterResponse {
|
|
5474
5498
|
/** Items updated by bulk action. */
|
|
5475
5499
|
results?: BulkOrderResult[];
|
|
5476
5500
|
/** Bulk action metadata. */
|
|
5477
5501
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5478
5502
|
}
|
|
5479
|
-
interface BulkSetBusinessLocationRequest {
|
|
5503
|
+
export interface BulkSetBusinessLocationRequest {
|
|
5480
5504
|
/**
|
|
5481
5505
|
* IDs of orders to update location for.
|
|
5482
5506
|
* @minSize 1
|
|
@@ -5487,7 +5511,7 @@ interface BulkSetBusinessLocationRequest {
|
|
|
5487
5511
|
/** Business location. */
|
|
5488
5512
|
businessLocation?: Location;
|
|
5489
5513
|
}
|
|
5490
|
-
interface BulkSetBusinessLocationResponse {
|
|
5514
|
+
export interface BulkSetBusinessLocationResponse {
|
|
5491
5515
|
/**
|
|
5492
5516
|
* Bulk action results.
|
|
5493
5517
|
* @minSize 1
|
|
@@ -5497,22 +5521,22 @@ interface BulkSetBusinessLocationResponse {
|
|
|
5497
5521
|
/** Bulk action metadata. */
|
|
5498
5522
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5499
5523
|
}
|
|
5500
|
-
interface BulkSetBusinessLocationResult {
|
|
5524
|
+
export interface BulkSetBusinessLocationResult {
|
|
5501
5525
|
itemMetadata?: ItemMetadata;
|
|
5502
5526
|
}
|
|
5503
|
-
interface V1MarkOrderAsPaidRequest {
|
|
5527
|
+
export interface V1MarkOrderAsPaidRequest {
|
|
5504
5528
|
/**
|
|
5505
5529
|
* Order ID.
|
|
5506
5530
|
* @minLength 1
|
|
5507
5531
|
* @maxLength 100
|
|
5508
5532
|
*/
|
|
5509
|
-
|
|
5533
|
+
id?: string;
|
|
5510
5534
|
}
|
|
5511
|
-
interface V1MarkOrderAsPaidResponse {
|
|
5535
|
+
export interface V1MarkOrderAsPaidResponse {
|
|
5512
5536
|
/** Updated order. */
|
|
5513
5537
|
order?: Order;
|
|
5514
5538
|
}
|
|
5515
|
-
interface V1BulkMarkOrdersAsPaidRequest {
|
|
5539
|
+
export interface V1BulkMarkOrdersAsPaidRequest {
|
|
5516
5540
|
/**
|
|
5517
5541
|
* IDs of orders to mark as paid.
|
|
5518
5542
|
* @minSize 1
|
|
@@ -5522,7 +5546,7 @@ interface V1BulkMarkOrdersAsPaidRequest {
|
|
|
5522
5546
|
*/
|
|
5523
5547
|
ids?: string[];
|
|
5524
5548
|
}
|
|
5525
|
-
interface V1BulkMarkOrdersAsPaidResponse {
|
|
5549
|
+
export interface V1BulkMarkOrdersAsPaidResponse {
|
|
5526
5550
|
/**
|
|
5527
5551
|
* Items updated by the bulk action.
|
|
5528
5552
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -5531,7 +5555,7 @@ interface V1BulkMarkOrdersAsPaidResponse {
|
|
|
5531
5555
|
/** Bulk action metadata. */
|
|
5532
5556
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5533
5557
|
}
|
|
5534
|
-
interface V1CreatePaymentGatewayOrderRequest {
|
|
5558
|
+
export interface V1CreatePaymentGatewayOrderRequest {
|
|
5535
5559
|
/**
|
|
5536
5560
|
* eCom Order ID
|
|
5537
5561
|
* @minLength 1
|
|
@@ -5539,21 +5563,21 @@ interface V1CreatePaymentGatewayOrderRequest {
|
|
|
5539
5563
|
*/
|
|
5540
5564
|
ecomOrderId?: string;
|
|
5541
5565
|
}
|
|
5542
|
-
interface V1CreatePaymentGatewayOrderResponse {
|
|
5566
|
+
export interface V1CreatePaymentGatewayOrderResponse {
|
|
5543
5567
|
/** ID of the order created in the payment gateway */
|
|
5544
5568
|
paymentGatewayOrderId?: string;
|
|
5545
5569
|
}
|
|
5546
|
-
interface GetShipmentsRequest {
|
|
5570
|
+
export interface GetShipmentsRequest {
|
|
5547
5571
|
/**
|
|
5548
5572
|
* @minLength 1
|
|
5549
5573
|
* @maxLength 100
|
|
5550
5574
|
*/
|
|
5551
|
-
|
|
5575
|
+
id?: string;
|
|
5552
5576
|
}
|
|
5553
|
-
interface GetShipmentsResponse {
|
|
5577
|
+
export interface GetShipmentsResponse {
|
|
5554
5578
|
shipmentIds?: string[];
|
|
5555
5579
|
}
|
|
5556
|
-
interface AggregateOrdersRequest {
|
|
5580
|
+
export interface AggregateOrdersRequest {
|
|
5557
5581
|
/** Filter applied to original data */
|
|
5558
5582
|
filter?: Record<string, any> | null;
|
|
5559
5583
|
/** This is an object defining aggregation itself */
|
|
@@ -5569,16 +5593,16 @@ interface AggregateOrdersRequest {
|
|
|
5569
5593
|
*/
|
|
5570
5594
|
hierarchySeparatorOverride?: string | null;
|
|
5571
5595
|
}
|
|
5572
|
-
interface AggregateOrdersResponse {
|
|
5596
|
+
export interface AggregateOrdersResponse {
|
|
5573
5597
|
aggregates?: Record<string, any> | null;
|
|
5574
5598
|
}
|
|
5575
|
-
interface DecrementItemsQuantityRequest {
|
|
5599
|
+
export interface DecrementItemsQuantityRequest {
|
|
5576
5600
|
/**
|
|
5577
5601
|
* Order ID
|
|
5578
5602
|
* @minLength 1
|
|
5579
5603
|
* @maxLength 100
|
|
5580
5604
|
*/
|
|
5581
|
-
|
|
5605
|
+
id?: string;
|
|
5582
5606
|
/**
|
|
5583
5607
|
* Which items to decrement, and how much to decrement from each one
|
|
5584
5608
|
* @minSize 1
|
|
@@ -5586,7 +5610,7 @@ interface DecrementItemsQuantityRequest {
|
|
|
5586
5610
|
*/
|
|
5587
5611
|
decrementData?: DecrementData[];
|
|
5588
5612
|
}
|
|
5589
|
-
interface DecrementData {
|
|
5613
|
+
export interface DecrementData {
|
|
5590
5614
|
/**
|
|
5591
5615
|
* ID of the line item being decremented.
|
|
5592
5616
|
* @format GUID
|
|
@@ -5601,11 +5625,11 @@ interface DecrementData {
|
|
|
5601
5625
|
/** Whether to restock the line item (triggers inventory update). */
|
|
5602
5626
|
restock?: boolean;
|
|
5603
5627
|
}
|
|
5604
|
-
interface DecrementItemsQuantityResponse {
|
|
5628
|
+
export interface DecrementItemsQuantityResponse {
|
|
5605
5629
|
/** Updated order data */
|
|
5606
5630
|
order?: Order;
|
|
5607
5631
|
}
|
|
5608
|
-
interface BulkUpdateOrderTagsRequest {
|
|
5632
|
+
export interface BulkUpdateOrderTagsRequest {
|
|
5609
5633
|
/**
|
|
5610
5634
|
* IDs of orders to update tags for.
|
|
5611
5635
|
* @minSize 1
|
|
@@ -5618,7 +5642,7 @@ interface BulkUpdateOrderTagsRequest {
|
|
|
5618
5642
|
/** Tags to be removed from orders */
|
|
5619
5643
|
unassignTags?: Tags;
|
|
5620
5644
|
}
|
|
5621
|
-
interface BulkUpdateOrderTagsResponse {
|
|
5645
|
+
export interface BulkUpdateOrderTagsResponse {
|
|
5622
5646
|
/**
|
|
5623
5647
|
* @minSize 1
|
|
5624
5648
|
* @maxSize 100
|
|
@@ -5626,51 +5650,51 @@ interface BulkUpdateOrderTagsResponse {
|
|
|
5626
5650
|
results?: BulkUpdateOrderTagsResult[];
|
|
5627
5651
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5628
5652
|
}
|
|
5629
|
-
interface BulkUpdateOrderTagsResult {
|
|
5653
|
+
export interface BulkUpdateOrderTagsResult {
|
|
5630
5654
|
itemMetadata?: ItemMetadata;
|
|
5631
5655
|
}
|
|
5632
|
-
interface Task {
|
|
5656
|
+
export interface Task {
|
|
5633
5657
|
key?: TaskKey;
|
|
5634
5658
|
executeAt?: Date | null;
|
|
5635
5659
|
payload?: string | null;
|
|
5636
5660
|
}
|
|
5637
|
-
interface TaskKey {
|
|
5661
|
+
export interface TaskKey {
|
|
5638
5662
|
appId?: string;
|
|
5639
5663
|
instanceId?: string;
|
|
5640
5664
|
subjectId?: string | null;
|
|
5641
5665
|
}
|
|
5642
|
-
interface TaskAction extends TaskActionActionOneOf {
|
|
5666
|
+
export interface TaskAction extends TaskActionActionOneOf {
|
|
5643
5667
|
complete?: Complete;
|
|
5644
5668
|
cancel?: Cancel;
|
|
5645
5669
|
reschedule?: Reschedule;
|
|
5646
5670
|
}
|
|
5647
5671
|
/** @oneof */
|
|
5648
|
-
interface TaskActionActionOneOf {
|
|
5672
|
+
export interface TaskActionActionOneOf {
|
|
5649
5673
|
complete?: Complete;
|
|
5650
5674
|
cancel?: Cancel;
|
|
5651
5675
|
reschedule?: Reschedule;
|
|
5652
5676
|
}
|
|
5653
|
-
interface Complete {
|
|
5677
|
+
export interface Complete {
|
|
5654
5678
|
}
|
|
5655
|
-
interface Cancel {
|
|
5679
|
+
export interface Cancel {
|
|
5656
5680
|
}
|
|
5657
|
-
interface Reschedule {
|
|
5681
|
+
export interface Reschedule {
|
|
5658
5682
|
executeAt?: Date | null;
|
|
5659
5683
|
payload?: string | null;
|
|
5660
5684
|
}
|
|
5661
|
-
interface InvoiceSentEvent {
|
|
5662
|
-
|
|
5685
|
+
export interface InvoiceSentEvent {
|
|
5686
|
+
id?: IdAndVersion;
|
|
5663
5687
|
/** @readonly */
|
|
5664
5688
|
data?: InvoiceFields;
|
|
5665
5689
|
/** @readonly */
|
|
5666
5690
|
status?: InvoiceStatus;
|
|
5667
5691
|
}
|
|
5668
|
-
interface IdAndVersion {
|
|
5692
|
+
export interface IdAndVersion {
|
|
5669
5693
|
/** @format GUID */
|
|
5670
|
-
|
|
5694
|
+
id?: string | null;
|
|
5671
5695
|
version?: number | null;
|
|
5672
5696
|
}
|
|
5673
|
-
interface InvoiceFields {
|
|
5697
|
+
export interface InvoiceFields {
|
|
5674
5698
|
/** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
|
|
5675
5699
|
number?: string | null;
|
|
5676
5700
|
/**
|
|
@@ -5741,7 +5765,7 @@ interface InvoiceFields {
|
|
|
5741
5765
|
/** Associated checkout for this invoice */
|
|
5742
5766
|
ecomCheckoutId?: string | null;
|
|
5743
5767
|
}
|
|
5744
|
-
interface Customer {
|
|
5768
|
+
export interface Customer {
|
|
5745
5769
|
contactId?: string | null;
|
|
5746
5770
|
name?: string | null;
|
|
5747
5771
|
email?: Email;
|
|
@@ -5753,10 +5777,10 @@ interface Customer {
|
|
|
5753
5777
|
billingAddress?: CommonAddress;
|
|
5754
5778
|
shippingAddress?: CommonAddress;
|
|
5755
5779
|
}
|
|
5756
|
-
interface Email {
|
|
5780
|
+
export interface Email {
|
|
5757
5781
|
address?: string;
|
|
5758
5782
|
}
|
|
5759
|
-
interface QuotesAddress {
|
|
5783
|
+
export interface QuotesAddress {
|
|
5760
5784
|
street?: string | null;
|
|
5761
5785
|
city?: string | null;
|
|
5762
5786
|
zip?: string | null;
|
|
@@ -5765,29 +5789,29 @@ interface QuotesAddress {
|
|
|
5765
5789
|
/** @readonly */
|
|
5766
5790
|
description?: AddressDescription;
|
|
5767
5791
|
}
|
|
5768
|
-
interface AddressDescription {
|
|
5792
|
+
export interface AddressDescription {
|
|
5769
5793
|
content?: string;
|
|
5770
5794
|
placement?: Placement;
|
|
5771
5795
|
}
|
|
5772
|
-
declare enum Placement {
|
|
5796
|
+
export declare enum Placement {
|
|
5773
5797
|
Unknown = "Unknown",
|
|
5774
5798
|
Replace = "Replace",
|
|
5775
5799
|
Before = "Before",
|
|
5776
5800
|
After = "After"
|
|
5777
5801
|
}
|
|
5778
|
-
interface Phone {
|
|
5802
|
+
export interface Phone {
|
|
5779
5803
|
number?: string;
|
|
5780
5804
|
}
|
|
5781
|
-
interface Company {
|
|
5805
|
+
export interface Company {
|
|
5782
5806
|
name?: string;
|
|
5783
|
-
|
|
5807
|
+
id?: string | null;
|
|
5784
5808
|
}
|
|
5785
5809
|
/** Physical address */
|
|
5786
|
-
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
5810
|
+
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
5787
5811
|
/** Street name and number. */
|
|
5788
5812
|
streetAddress?: StreetAddress;
|
|
5789
5813
|
/** Main address line, usually street and number as free text. */
|
|
5790
|
-
|
|
5814
|
+
addressLine?: string | null;
|
|
5791
5815
|
/**
|
|
5792
5816
|
* Country code.
|
|
5793
5817
|
* @format COUNTRY
|
|
@@ -5803,19 +5827,19 @@ interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
5803
5827
|
addressLine2?: string | null;
|
|
5804
5828
|
}
|
|
5805
5829
|
/** @oneof */
|
|
5806
|
-
interface CommonAddressStreetOneOf {
|
|
5830
|
+
export interface CommonAddressStreetOneOf {
|
|
5807
5831
|
/** Street name and number. */
|
|
5808
5832
|
streetAddress?: StreetAddress;
|
|
5809
5833
|
/** Main address line, usually street and number as free text. */
|
|
5810
5834
|
addressLine?: string | null;
|
|
5811
5835
|
}
|
|
5812
|
-
interface Subdivision {
|
|
5836
|
+
export interface Subdivision {
|
|
5813
5837
|
/** Short subdivision code. */
|
|
5814
5838
|
code?: string;
|
|
5815
5839
|
/** Subdivision full name. */
|
|
5816
5840
|
name?: string;
|
|
5817
5841
|
}
|
|
5818
|
-
declare enum SubdivisionType {
|
|
5842
|
+
export declare enum SubdivisionType {
|
|
5819
5843
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
5820
5844
|
/** State */
|
|
5821
5845
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -5831,14 +5855,14 @@ declare enum SubdivisionType {
|
|
|
5831
5855
|
COUNTRY = "COUNTRY"
|
|
5832
5856
|
}
|
|
5833
5857
|
/** Subdivision Concordance values */
|
|
5834
|
-
interface StandardDetails {
|
|
5858
|
+
export interface StandardDetails {
|
|
5835
5859
|
/**
|
|
5836
5860
|
* subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
|
|
5837
5861
|
* @maxLength 20
|
|
5838
5862
|
*/
|
|
5839
5863
|
iso31662?: string | null;
|
|
5840
5864
|
}
|
|
5841
|
-
interface InvoiceDates {
|
|
5865
|
+
export interface InvoiceDates {
|
|
5842
5866
|
/** use UTC midnight date to set the issue date according to the site time zone */
|
|
5843
5867
|
issueDate?: Date | null;
|
|
5844
5868
|
/** use UTC midnight date to set the due date according to the site time zone */
|
|
@@ -5851,12 +5875,12 @@ interface InvoiceDates {
|
|
|
5851
5875
|
*/
|
|
5852
5876
|
lastSeenDate?: Date | null;
|
|
5853
5877
|
}
|
|
5854
|
-
interface LineItems {
|
|
5878
|
+
export interface LineItems {
|
|
5855
5879
|
lineItems?: LineItem[];
|
|
5856
5880
|
}
|
|
5857
|
-
interface LineItem {
|
|
5881
|
+
export interface LineItem {
|
|
5858
5882
|
/** @format GUID */
|
|
5859
|
-
|
|
5883
|
+
id?: string;
|
|
5860
5884
|
name?: string;
|
|
5861
5885
|
description?: string | null;
|
|
5862
5886
|
price?: BigDecimalWrapper;
|
|
@@ -5868,15 +5892,15 @@ interface LineItem {
|
|
|
5868
5892
|
/** The line-item level metadata. */
|
|
5869
5893
|
metadata?: LineItemMetaData;
|
|
5870
5894
|
}
|
|
5871
|
-
interface BigDecimalWrapper {
|
|
5895
|
+
export interface BigDecimalWrapper {
|
|
5872
5896
|
serializedValue?: number;
|
|
5873
5897
|
}
|
|
5874
|
-
interface LineItemTax {
|
|
5898
|
+
export interface LineItemTax {
|
|
5875
5899
|
name?: string;
|
|
5876
5900
|
rate?: BigDecimalWrapper;
|
|
5877
5901
|
code?: string | null;
|
|
5878
5902
|
}
|
|
5879
|
-
interface Source {
|
|
5903
|
+
export interface Source {
|
|
5880
5904
|
/**
|
|
5881
5905
|
* Source app or service ID.
|
|
5882
5906
|
* @readonly
|
|
@@ -5888,24 +5912,24 @@ interface Source {
|
|
|
5888
5912
|
*/
|
|
5889
5913
|
sourceType?: SourceType;
|
|
5890
5914
|
}
|
|
5891
|
-
declare enum SourceType {
|
|
5915
|
+
export declare enum SourceType {
|
|
5892
5916
|
UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
|
|
5893
5917
|
WIX_APP = "WIX_APP",
|
|
5894
5918
|
EXTERNAL = "EXTERNAL",
|
|
5895
5919
|
ADMIN = "ADMIN",
|
|
5896
5920
|
OTHER = "OTHER"
|
|
5897
5921
|
}
|
|
5898
|
-
interface LineItemMetaData {
|
|
5922
|
+
export interface LineItemMetaData {
|
|
5899
5923
|
metadata?: Record<string, string>;
|
|
5900
5924
|
}
|
|
5901
|
-
interface Locale {
|
|
5925
|
+
export interface Locale {
|
|
5902
5926
|
/** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
|
|
5903
5927
|
language?: string;
|
|
5904
5928
|
/** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
|
|
5905
5929
|
country?: string | null;
|
|
5906
5930
|
invariant?: string | null;
|
|
5907
5931
|
}
|
|
5908
|
-
interface TotalPrice {
|
|
5932
|
+
export interface TotalPrice {
|
|
5909
5933
|
/** the subtotal of the line items without the tax reduction */
|
|
5910
5934
|
subtotal?: BigDecimalWrapper;
|
|
5911
5935
|
/** the total price taking into account the itemized fees and the taxes */
|
|
@@ -5914,24 +5938,24 @@ interface TotalPrice {
|
|
|
5914
5938
|
discountAmount?: BigDecimalWrapper;
|
|
5915
5939
|
taxedAmount?: BigDecimalWrapper;
|
|
5916
5940
|
}
|
|
5917
|
-
interface ItemizedFee {
|
|
5941
|
+
export interface ItemizedFee {
|
|
5918
5942
|
name?: string;
|
|
5919
5943
|
price?: BigDecimalWrapper;
|
|
5920
5944
|
}
|
|
5921
|
-
interface Discount extends DiscountOneDiscountTypeOneOf {
|
|
5945
|
+
export interface Discount extends DiscountOneDiscountTypeOneOf {
|
|
5922
5946
|
/** Discount as percentage value. */
|
|
5923
5947
|
percentage?: BigDecimalWrapper;
|
|
5924
5948
|
}
|
|
5925
5949
|
/** @oneof */
|
|
5926
|
-
interface DiscountOneDiscountTypeOneOf {
|
|
5950
|
+
export interface DiscountOneDiscountTypeOneOf {
|
|
5927
5951
|
/** Discount as percentage value. */
|
|
5928
5952
|
percentage?: BigDecimalWrapper;
|
|
5929
5953
|
}
|
|
5930
|
-
interface CalculatedTaxes {
|
|
5954
|
+
export interface CalculatedTaxes {
|
|
5931
5955
|
/** consider calculated or not - cannot enforce set */
|
|
5932
5956
|
taxes?: CalculatedTax[];
|
|
5933
5957
|
}
|
|
5934
|
-
interface CalculatedTax {
|
|
5958
|
+
export interface CalculatedTax {
|
|
5935
5959
|
name?: string;
|
|
5936
5960
|
rate?: BigDecimalWrapper;
|
|
5937
5961
|
/** the costs on which the taxes are applied */
|
|
@@ -5940,12 +5964,12 @@ interface CalculatedTax {
|
|
|
5940
5964
|
taxed?: BigDecimalWrapper;
|
|
5941
5965
|
code?: string | null;
|
|
5942
5966
|
}
|
|
5943
|
-
interface Payments {
|
|
5967
|
+
export interface Payments {
|
|
5944
5968
|
payments?: InvoicesPayment[];
|
|
5945
5969
|
}
|
|
5946
|
-
interface InvoicesPayment {
|
|
5970
|
+
export interface InvoicesPayment {
|
|
5947
5971
|
/** document */
|
|
5948
|
-
|
|
5972
|
+
id?: string;
|
|
5949
5973
|
type?: string;
|
|
5950
5974
|
amount?: BigDecimalWrapper;
|
|
5951
5975
|
date?: Date | null;
|
|
@@ -5960,7 +5984,7 @@ interface InvoicesPayment {
|
|
|
5960
5984
|
*/
|
|
5961
5985
|
transactionId?: string | null;
|
|
5962
5986
|
}
|
|
5963
|
-
interface MetaData {
|
|
5987
|
+
export interface MetaData {
|
|
5964
5988
|
notes?: string | null;
|
|
5965
5989
|
legalTerms?: string | null;
|
|
5966
5990
|
sourceUrl?: string | null;
|
|
@@ -5970,7 +5994,7 @@ interface MetaData {
|
|
|
5970
5994
|
/** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
|
|
5971
5995
|
allowEditByOthers?: boolean | null;
|
|
5972
5996
|
}
|
|
5973
|
-
interface InvoiceDynamicPriceTotals {
|
|
5997
|
+
export interface InvoiceDynamicPriceTotals {
|
|
5974
5998
|
paidAmount?: BigDecimalWrapper;
|
|
5975
5999
|
balance?: BigDecimalWrapper;
|
|
5976
6000
|
}
|
|
@@ -5978,13 +6002,13 @@ interface InvoiceDynamicPriceTotals {
|
|
|
5978
6002
|
* A custom field value is used to add additional data to a financial document or to a financial document template.
|
|
5979
6003
|
* The custom field value may be based on a custom field definition.
|
|
5980
6004
|
*/
|
|
5981
|
-
interface CustomFieldValue {
|
|
6005
|
+
export interface CustomFieldValue {
|
|
5982
6006
|
/**
|
|
5983
6007
|
* The unique id of the custom field value
|
|
5984
6008
|
* @format GUID
|
|
5985
6009
|
* @readonly
|
|
5986
6010
|
*/
|
|
5987
|
-
|
|
6011
|
+
id?: string | null;
|
|
5988
6012
|
/**
|
|
5989
6013
|
* The display name of the custom field value
|
|
5990
6014
|
* @maxLength 50
|
|
@@ -6002,7 +6026,7 @@ interface CustomFieldValue {
|
|
|
6002
6026
|
*/
|
|
6003
6027
|
originCustomFieldKey?: string | null;
|
|
6004
6028
|
}
|
|
6005
|
-
declare enum CustomFieldGroup {
|
|
6029
|
+
export declare enum CustomFieldGroup {
|
|
6006
6030
|
UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
|
|
6007
6031
|
BUSINESS_DETAILS = "BUSINESS_DETAILS",
|
|
6008
6032
|
CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
|
|
@@ -6010,18 +6034,18 @@ declare enum CustomFieldGroup {
|
|
|
6010
6034
|
FOOTER = "FOOTER",
|
|
6011
6035
|
OTHER = "OTHER"
|
|
6012
6036
|
}
|
|
6013
|
-
interface Value {
|
|
6037
|
+
export interface Value {
|
|
6014
6038
|
value?: string;
|
|
6015
6039
|
valueType?: ValueType;
|
|
6016
6040
|
}
|
|
6017
|
-
declare enum ValueType {
|
|
6041
|
+
export declare enum ValueType {
|
|
6018
6042
|
UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
|
|
6019
6043
|
STRING = "STRING",
|
|
6020
6044
|
DATE = "DATE",
|
|
6021
6045
|
BOOLEAN = "BOOLEAN",
|
|
6022
6046
|
NUMBER = "NUMBER"
|
|
6023
6047
|
}
|
|
6024
|
-
interface Deposit {
|
|
6048
|
+
export interface Deposit {
|
|
6025
6049
|
/**
|
|
6026
6050
|
* The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total.
|
|
6027
6051
|
* @format DECIMAL_VALUE
|
|
@@ -6039,7 +6063,7 @@ interface Deposit {
|
|
|
6039
6063
|
/** The type of the deposit. The default is FLAT. */
|
|
6040
6064
|
type?: DepositType;
|
|
6041
6065
|
}
|
|
6042
|
-
declare enum DepositType {
|
|
6066
|
+
export declare enum DepositType {
|
|
6043
6067
|
UNKNOWN = "UNKNOWN",
|
|
6044
6068
|
FLAT = "FLAT",
|
|
6045
6069
|
PERCENTAGE = "PERCENTAGE"
|
|
@@ -6054,7 +6078,7 @@ declare enum DepositType {
|
|
|
6054
6078
|
* Void -> Deleted
|
|
6055
6079
|
* Deleted
|
|
6056
6080
|
*/
|
|
6057
|
-
declare enum InvoiceStatus {
|
|
6081
|
+
export declare enum InvoiceStatus {
|
|
6058
6082
|
Draft = "Draft",
|
|
6059
6083
|
Sent = "Sent",
|
|
6060
6084
|
Processing = "Processing",
|
|
@@ -6065,504 +6089,8 @@ declare enum InvoiceStatus {
|
|
|
6065
6089
|
PartiallyPaid = "PartiallyPaid",
|
|
6066
6090
|
PartialAndOverdue = "PartialAndOverdue"
|
|
6067
6091
|
}
|
|
6068
|
-
interface TriggerSideEffectsFromLegacyData {
|
|
6092
|
+
export interface TriggerSideEffectsFromLegacyData {
|
|
6069
6093
|
storeId?: string;
|
|
6070
6094
|
orderId?: string;
|
|
6071
6095
|
ordersExperiments?: OrdersExperiments;
|
|
6072
6096
|
}
|
|
6073
|
-
interface BaseEventMetadata {
|
|
6074
|
-
/**
|
|
6075
|
-
* App instance ID.
|
|
6076
|
-
* @format GUID
|
|
6077
|
-
*/
|
|
6078
|
-
instanceId?: string | null;
|
|
6079
|
-
/**
|
|
6080
|
-
* Event type.
|
|
6081
|
-
* @maxLength 150
|
|
6082
|
-
*/
|
|
6083
|
-
eventType?: string;
|
|
6084
|
-
/** The identification type and identity data. */
|
|
6085
|
-
identity?: IdentificationData;
|
|
6086
|
-
}
|
|
6087
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
6088
|
-
/**
|
|
6089
|
-
* Unique event ID.
|
|
6090
|
-
* Allows clients to ignore duplicate webhooks.
|
|
6091
|
-
*/
|
|
6092
|
-
_id?: string;
|
|
6093
|
-
/**
|
|
6094
|
-
* Assumes actions are also always typed to an entity_type
|
|
6095
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
6096
|
-
*/
|
|
6097
|
-
entityFqdn?: string;
|
|
6098
|
-
/**
|
|
6099
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
6100
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
6101
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
6102
|
-
*/
|
|
6103
|
-
slug?: string;
|
|
6104
|
-
/** ID of the entity associated with the event. */
|
|
6105
|
-
entityId?: string;
|
|
6106
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
6107
|
-
eventTime?: Date | null;
|
|
6108
|
-
/**
|
|
6109
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
6110
|
-
* (for example, GDPR).
|
|
6111
|
-
*/
|
|
6112
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
6113
|
-
/** If present, indicates the action that triggered the event. */
|
|
6114
|
-
originatedFrom?: string | null;
|
|
6115
|
-
/**
|
|
6116
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
6117
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
6118
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
6119
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
6120
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
6121
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
6122
|
-
*/
|
|
6123
|
-
entityEventSequence?: string | null;
|
|
6124
|
-
}
|
|
6125
|
-
interface OrderApprovedEnvelope {
|
|
6126
|
-
data: OrderApproved;
|
|
6127
|
-
metadata: EventMetadata;
|
|
6128
|
-
}
|
|
6129
|
-
interface OrderUpdatedEnvelope {
|
|
6130
|
-
entity: Order;
|
|
6131
|
-
metadata: EventMetadata;
|
|
6132
|
-
}
|
|
6133
|
-
interface OrderCanceledEnvelope {
|
|
6134
|
-
data: OrderCanceledEventOrderCanceled;
|
|
6135
|
-
metadata: EventMetadata;
|
|
6136
|
-
}
|
|
6137
|
-
interface OrderCreatedEnvelope {
|
|
6138
|
-
entity: Order;
|
|
6139
|
-
metadata: EventMetadata;
|
|
6140
|
-
}
|
|
6141
|
-
interface PreparePaymentCollectionOptions {
|
|
6142
|
-
/**
|
|
6143
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
6144
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
6145
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
6146
|
-
*/
|
|
6147
|
-
paymentGatewayOrderId?: string | null;
|
|
6148
|
-
/**
|
|
6149
|
-
* Whether to delay capture of the payment.
|
|
6150
|
-
* Default: false
|
|
6151
|
-
* @deprecated Whether to delay capture of the payment.
|
|
6152
|
-
* Default: false
|
|
6153
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
6154
|
-
* @targetRemovalDate 2024-09-30
|
|
6155
|
-
*/
|
|
6156
|
-
delayedCapture?: boolean;
|
|
6157
|
-
/** Delayed capture payment settings */
|
|
6158
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
6159
|
-
}
|
|
6160
|
-
interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6161
|
-
/** Information about the user who initiated the payment. */
|
|
6162
|
-
chargedBy?: ChargedBy;
|
|
6163
|
-
}
|
|
6164
|
-
interface ChargeMembershipsOptions {
|
|
6165
|
-
/**
|
|
6166
|
-
* List of items to be paid by memberships
|
|
6167
|
-
* @minSize 1
|
|
6168
|
-
* @maxSize 300
|
|
6169
|
-
*/
|
|
6170
|
-
membershipCharges?: MembershipChargeItem[];
|
|
6171
|
-
}
|
|
6172
|
-
interface TriggerRefundOptions {
|
|
6173
|
-
/** Business model of a refund */
|
|
6174
|
-
details?: RefundDetails;
|
|
6175
|
-
/** Side effect details related to refund */
|
|
6176
|
-
sideEffects?: RefundSideEffects;
|
|
6177
|
-
}
|
|
6178
|
-
interface SearchOrdersOptions {
|
|
6179
|
-
/** Search options. */
|
|
6180
|
-
search?: CursorSearch;
|
|
6181
|
-
}
|
|
6182
|
-
interface CreateOrderOptions {
|
|
6183
|
-
/** Determine order lifecycle */
|
|
6184
|
-
settings?: OrderCreationSettings;
|
|
6185
|
-
}
|
|
6186
|
-
interface UpdateOrder {
|
|
6187
|
-
/**
|
|
6188
|
-
* Order ID.
|
|
6189
|
-
* @format GUID
|
|
6190
|
-
* @readonly
|
|
6191
|
-
*/
|
|
6192
|
-
_id?: string | null;
|
|
6193
|
-
/**
|
|
6194
|
-
* Order number displayed in the site owner's dashboard (auto-generated).
|
|
6195
|
-
* @readonly
|
|
6196
|
-
*/
|
|
6197
|
-
number?: string;
|
|
6198
|
-
/**
|
|
6199
|
-
* Date and time the order was created.
|
|
6200
|
-
* @readonly
|
|
6201
|
-
* @immutable
|
|
6202
|
-
*/
|
|
6203
|
-
_createdDate?: Date | null;
|
|
6204
|
-
/**
|
|
6205
|
-
* Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
6206
|
-
* @readonly
|
|
6207
|
-
*/
|
|
6208
|
-
_updatedDate?: Date | null;
|
|
6209
|
-
/**
|
|
6210
|
-
* Order line items.
|
|
6211
|
-
* @minSize 1
|
|
6212
|
-
* @maxSize 300
|
|
6213
|
-
* @readonly
|
|
6214
|
-
*/
|
|
6215
|
-
lineItems?: OrderLineItem[];
|
|
6216
|
-
/** Buyer information. */
|
|
6217
|
-
buyerInfo?: BuyerInfo;
|
|
6218
|
-
/** Order payment status. */
|
|
6219
|
-
paymentStatus?: PaymentStatus;
|
|
6220
|
-
/**
|
|
6221
|
-
* Order fulfillment status.
|
|
6222
|
-
* @readonly
|
|
6223
|
-
*/
|
|
6224
|
-
fulfillmentStatus?: FulfillmentStatus;
|
|
6225
|
-
/**
|
|
6226
|
-
* Language for communication with the buyer. Defaults to the site language.
|
|
6227
|
-
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
6228
|
-
*/
|
|
6229
|
-
buyerLanguage?: string | null;
|
|
6230
|
-
/** Weight measurement unit - defaults to site's weight unit. */
|
|
6231
|
-
weightUnit?: WeightUnit;
|
|
6232
|
-
/**
|
|
6233
|
-
* Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
6234
|
-
* @format CURRENCY
|
|
6235
|
-
*/
|
|
6236
|
-
currency?: string | null;
|
|
6237
|
-
/** Multi-currency information of the order. */
|
|
6238
|
-
currencyConversionDetails?: CurrencyConversionDetails;
|
|
6239
|
-
/**
|
|
6240
|
-
* Whether tax is included in line item prices.
|
|
6241
|
-
* @immutable
|
|
6242
|
-
*/
|
|
6243
|
-
taxIncludedInPrices?: boolean;
|
|
6244
|
-
/**
|
|
6245
|
-
* Site language in which original values are shown.
|
|
6246
|
-
* @readonly
|
|
6247
|
-
* @immutable
|
|
6248
|
-
*/
|
|
6249
|
-
siteLanguage?: string | null;
|
|
6250
|
-
/**
|
|
6251
|
-
* Order price summary.
|
|
6252
|
-
* @readonly
|
|
6253
|
-
*/
|
|
6254
|
-
priceSummary?: PriceSummary;
|
|
6255
|
-
/** Billing address and contact details. */
|
|
6256
|
-
billingInfo?: AddressWithContact;
|
|
6257
|
-
/** Shipping info and selected shipping option details. */
|
|
6258
|
-
shippingInfo?: V1ShippingInformation;
|
|
6259
|
-
/**
|
|
6260
|
-
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
6261
|
-
* @maxLength 1000
|
|
6262
|
-
*/
|
|
6263
|
-
buyerNote?: string | null;
|
|
6264
|
-
/** Order status. */
|
|
6265
|
-
status?: OrderStatus;
|
|
6266
|
-
/** Whether order is archived. */
|
|
6267
|
-
archived?: boolean | null;
|
|
6268
|
-
/**
|
|
6269
|
-
* Tax summary.
|
|
6270
|
-
* Deprecated. Use `taxInfo` instead.
|
|
6271
|
-
* This field will be removed on September 30, 2024.
|
|
6272
|
-
* @deprecated Tax summary.
|
|
6273
|
-
* Deprecated. Use `taxInfo` instead.
|
|
6274
|
-
* This field will be removed on September 30, 2024.
|
|
6275
|
-
* @replacedBy tax_info
|
|
6276
|
-
* @targetRemovalDate 2024-09-30
|
|
6277
|
-
*/
|
|
6278
|
-
taxSummary?: TaxSummary;
|
|
6279
|
-
/** Tax information. */
|
|
6280
|
-
taxInfo?: OrderTaxInfo;
|
|
6281
|
-
/**
|
|
6282
|
-
* Applied discounts.
|
|
6283
|
-
* @maxSize 320
|
|
6284
|
-
*/
|
|
6285
|
-
appliedDiscounts?: AppliedDiscount[];
|
|
6286
|
-
/**
|
|
6287
|
-
* Order activities.
|
|
6288
|
-
* @readonly
|
|
6289
|
-
* @maxSize 1000
|
|
6290
|
-
*/
|
|
6291
|
-
activities?: Activity[];
|
|
6292
|
-
/** Order attribution source. */
|
|
6293
|
-
attributionSource?: AttributionSource;
|
|
6294
|
-
/**
|
|
6295
|
-
* ID of the order's initiator.
|
|
6296
|
-
* @readonly
|
|
6297
|
-
*/
|
|
6298
|
-
createdBy?: CreatedBy;
|
|
6299
|
-
/** Information about the sales channel that submitted this order. */
|
|
6300
|
-
channelInfo?: ChannelInfo;
|
|
6301
|
-
/** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
|
|
6302
|
-
seenByAHuman?: boolean | null;
|
|
6303
|
-
/**
|
|
6304
|
-
* Checkout ID.
|
|
6305
|
-
* @format GUID
|
|
6306
|
-
*/
|
|
6307
|
-
checkoutId?: string | null;
|
|
6308
|
-
/** Custom fields. */
|
|
6309
|
-
customFields?: CustomField[];
|
|
6310
|
-
/**
|
|
6311
|
-
* Balance summary.
|
|
6312
|
-
* @readonly
|
|
6313
|
-
*/
|
|
6314
|
-
balanceSummary?: BalanceSummary;
|
|
6315
|
-
/**
|
|
6316
|
-
* Additional fees applied to the order.
|
|
6317
|
-
* @maxSize 100
|
|
6318
|
-
*/
|
|
6319
|
-
additionalFees?: AdditionalFee[];
|
|
6320
|
-
/**
|
|
6321
|
-
* Custom field data for the order object.
|
|
6322
|
-
*
|
|
6323
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
6324
|
-
*/
|
|
6325
|
-
extendedFields?: ExtendedFields;
|
|
6326
|
-
/**
|
|
6327
|
-
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
6328
|
-
* @format GUID
|
|
6329
|
-
*/
|
|
6330
|
-
purchaseFlowId?: string | null;
|
|
6331
|
-
/**
|
|
6332
|
-
* Order recipient address and contact details.
|
|
6333
|
-
*
|
|
6334
|
-
* This field may differ from the address in `shippingInfo.logistics` when:
|
|
6335
|
-
* + The chosen shipping option is pickup point or store pickup.
|
|
6336
|
-
* + No shipping option is selected.
|
|
6337
|
-
*/
|
|
6338
|
-
recipientInfo?: AddressWithContact;
|
|
6339
|
-
/**
|
|
6340
|
-
* Order tags.
|
|
6341
|
-
*
|
|
6342
|
-
* [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management.
|
|
6343
|
-
*/
|
|
6344
|
-
tags?: Tags;
|
|
6345
|
-
/**
|
|
6346
|
-
* Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
6347
|
-
* Used for migration from external systems.
|
|
6348
|
-
* @immutable
|
|
6349
|
-
*/
|
|
6350
|
-
purchasedDate?: Date | null;
|
|
6351
|
-
/** Order Location */
|
|
6352
|
-
businessLocation?: Location;
|
|
6353
|
-
}
|
|
6354
|
-
interface BulkUpdateOrdersOptions {
|
|
6355
|
-
/**
|
|
6356
|
-
* Whether to return the full order entities.
|
|
6357
|
-
*
|
|
6358
|
-
* Default: `false`
|
|
6359
|
-
*/
|
|
6360
|
-
returnEntity?: boolean;
|
|
6361
|
-
}
|
|
6362
|
-
interface CommitDeltasOptions {
|
|
6363
|
-
/**
|
|
6364
|
-
* Draft order Id representing this change.
|
|
6365
|
-
* Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
|
|
6366
|
-
* @format GUID
|
|
6367
|
-
*/
|
|
6368
|
-
draftOrderId?: string;
|
|
6369
|
-
/** Draft order changes to be applied */
|
|
6370
|
-
changes: DraftOrderDiffs;
|
|
6371
|
-
/** Side-effects to happen after order is updated */
|
|
6372
|
-
commitSettings?: DraftOrderCommitSettings;
|
|
6373
|
-
/**
|
|
6374
|
-
* Reason for edit, given by user (optional).
|
|
6375
|
-
* @maxLength 200
|
|
6376
|
-
*/
|
|
6377
|
-
reason?: string | null;
|
|
6378
|
-
}
|
|
6379
|
-
interface UpdateOrderLineItemIdentifiers {
|
|
6380
|
-
/**
|
|
6381
|
-
* Order ID
|
|
6382
|
-
* @minLength 1
|
|
6383
|
-
* @maxLength 100
|
|
6384
|
-
*/
|
|
6385
|
-
_id: string;
|
|
6386
|
-
/**
|
|
6387
|
-
* Line item ID.
|
|
6388
|
-
* @immutable
|
|
6389
|
-
*/
|
|
6390
|
-
lineItemId?: string;
|
|
6391
|
-
}
|
|
6392
|
-
interface UpdateOrderLineItem {
|
|
6393
|
-
/**
|
|
6394
|
-
* Line item ID.
|
|
6395
|
-
* @immutable
|
|
6396
|
-
*/
|
|
6397
|
-
_id?: string;
|
|
6398
|
-
/**
|
|
6399
|
-
* Item name.
|
|
6400
|
-
* + Stores - `product.name`
|
|
6401
|
-
* + Bookings - `service.info.name`
|
|
6402
|
-
* + Events - `ticket.name`
|
|
6403
|
-
*/
|
|
6404
|
-
productName?: ProductName;
|
|
6405
|
-
/** Catalog and item reference. Holds 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. */
|
|
6406
|
-
catalogReference?: CatalogReference;
|
|
6407
|
-
/**
|
|
6408
|
-
* Line item quantity.
|
|
6409
|
-
* @min 1
|
|
6410
|
-
* @max 100000
|
|
6411
|
-
*/
|
|
6412
|
-
quantity?: number;
|
|
6413
|
-
/**
|
|
6414
|
-
* Total discount for this line item's entire quantity.
|
|
6415
|
-
* @readonly
|
|
6416
|
-
*/
|
|
6417
|
-
totalDiscount?: Price;
|
|
6418
|
-
/**
|
|
6419
|
-
* Line item description lines. Used for display purposes for the cart, checkout and order.
|
|
6420
|
-
* @maxSize 20
|
|
6421
|
-
*/
|
|
6422
|
-
descriptionLines?: DescriptionLine[];
|
|
6423
|
-
/** Line item image. */
|
|
6424
|
-
image?: string;
|
|
6425
|
-
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
6426
|
-
physicalProperties?: PhysicalProperties;
|
|
6427
|
-
/** Item type. Either a preset type or custom. */
|
|
6428
|
-
itemType?: ItemType;
|
|
6429
|
-
/**
|
|
6430
|
-
* Fulfiller ID. Field is empty when the line item is self-fulfilled.
|
|
6431
|
-
*
|
|
6432
|
-
* To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).
|
|
6433
|
-
* @format GUID
|
|
6434
|
-
*/
|
|
6435
|
-
fulfillerId?: string | null;
|
|
6436
|
-
/**
|
|
6437
|
-
* Number of items that were refunded.
|
|
6438
|
-
* @max 100000
|
|
6439
|
-
*/
|
|
6440
|
-
refundQuantity?: number | null;
|
|
6441
|
-
/**
|
|
6442
|
-
* Number of items restocked.
|
|
6443
|
-
* @max 100000
|
|
6444
|
-
*/
|
|
6445
|
-
restockQuantity?: number | null;
|
|
6446
|
-
/** Line item price after line item discounts for display purposes. */
|
|
6447
|
-
price?: Price;
|
|
6448
|
-
/**
|
|
6449
|
-
* Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
|
|
6450
|
-
* @readonly
|
|
6451
|
-
*/
|
|
6452
|
-
priceBeforeDiscounts?: Price;
|
|
6453
|
-
/**
|
|
6454
|
-
* Total price after discounts, and before tax.
|
|
6455
|
-
* @readonly
|
|
6456
|
-
*/
|
|
6457
|
-
totalPriceBeforeTax?: Price;
|
|
6458
|
-
/**
|
|
6459
|
-
* Total price after all discounts and tax.
|
|
6460
|
-
* @readonly
|
|
6461
|
-
*/
|
|
6462
|
-
totalPriceAfterTax?: Price;
|
|
6463
|
-
/**
|
|
6464
|
-
* Type of selected payment option for current item.
|
|
6465
|
-
*
|
|
6466
|
-
* Default: `FULL_PAYMENT_ONLINE`
|
|
6467
|
-
*/
|
|
6468
|
-
paymentOption?: PaymentOptionType;
|
|
6469
|
-
/**
|
|
6470
|
-
* Deprecated. Use `taxInfo` instead.
|
|
6471
|
-
* This field will be removed on September 30, 2024.
|
|
6472
|
-
* Tax details for this line item.
|
|
6473
|
-
* @deprecated Deprecated. Use `taxInfo` instead.
|
|
6474
|
-
* This field will be removed on September 30, 2024.
|
|
6475
|
-
* Tax details for this line item.
|
|
6476
|
-
* @replacedBy tax_info
|
|
6477
|
-
* @targetRemovalDate 2024-09-30
|
|
6478
|
-
*/
|
|
6479
|
-
taxDetails?: ItemTaxFullDetails;
|
|
6480
|
-
/** Represents all the relevant tax details for a specific line item. */
|
|
6481
|
-
taxInfo?: LineItemTaxInfo;
|
|
6482
|
-
/** Digital file identifier, relevant only for items with type DIGITAL. */
|
|
6483
|
-
digitalFile?: DigitalFile;
|
|
6484
|
-
/** Subscription info. */
|
|
6485
|
-
subscriptionInfo?: SubscriptionInfo;
|
|
6486
|
-
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
6487
|
-
priceDescription?: PriceDescription;
|
|
6488
|
-
/**
|
|
6489
|
-
* Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
|
|
6490
|
-
* @readonly
|
|
6491
|
-
*/
|
|
6492
|
-
depositAmount?: Price;
|
|
6493
|
-
/**
|
|
6494
|
-
* Line item locations.
|
|
6495
|
-
*
|
|
6496
|
-
* The location's total quantity must not exceed the line item quantity.
|
|
6497
|
-
* @maxSize 5
|
|
6498
|
-
*/
|
|
6499
|
-
locations?: LocationAndQuantity[];
|
|
6500
|
-
/**
|
|
6501
|
-
* Custom extended fields for the line item object.
|
|
6502
|
-
*
|
|
6503
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
6504
|
-
*/
|
|
6505
|
-
extendedFields?: ExtendedFields;
|
|
6506
|
-
}
|
|
6507
|
-
interface UpdateActivityIdentifiers {
|
|
6508
|
-
/**
|
|
6509
|
-
* Order ID.
|
|
6510
|
-
* @minLength 1
|
|
6511
|
-
* @maxLength 100
|
|
6512
|
-
*/
|
|
6513
|
-
_id: string;
|
|
6514
|
-
/**
|
|
6515
|
-
* ID of the activity to update.
|
|
6516
|
-
* @format GUID
|
|
6517
|
-
*/
|
|
6518
|
-
activityId: string;
|
|
6519
|
-
}
|
|
6520
|
-
interface DeleteActivityIdentifiers {
|
|
6521
|
-
/**
|
|
6522
|
-
* Order ID.
|
|
6523
|
-
* @minLength 1
|
|
6524
|
-
* @maxLength 100
|
|
6525
|
-
*/
|
|
6526
|
-
_id: string;
|
|
6527
|
-
/**
|
|
6528
|
-
* ID of the activity to delete.
|
|
6529
|
-
* @format GUID
|
|
6530
|
-
*/
|
|
6531
|
-
activityId: string;
|
|
6532
|
-
}
|
|
6533
|
-
interface CancelOrderOptions {
|
|
6534
|
-
/** Whether to send an order canceled email to the buyer. */
|
|
6535
|
-
sendOrderCanceledEmail?: boolean;
|
|
6536
|
-
/**
|
|
6537
|
-
* Custom note to be added to the email (optional).
|
|
6538
|
-
* @minLength 1
|
|
6539
|
-
* @maxLength 1000
|
|
6540
|
-
*/
|
|
6541
|
-
customMessage?: string | null;
|
|
6542
|
-
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
6543
|
-
restockAllItems?: boolean;
|
|
6544
|
-
}
|
|
6545
|
-
interface AggregateOrdersOptions {
|
|
6546
|
-
/** Filter applied to original data */
|
|
6547
|
-
filter?: Record<string, any> | null;
|
|
6548
|
-
/** This is an object defining aggregation itself */
|
|
6549
|
-
aggregation: Record<string, any> | null;
|
|
6550
|
-
/**
|
|
6551
|
-
* Optional custom separator string that can be used to override default separator value '|'
|
|
6552
|
-
* for hierarchical responses of multifaceted aggregation requests like:
|
|
6553
|
-
* '{"aggregation": {"example_request_key": {"$count" : ["deliveryMethod", "shippingRegion"]}}}'
|
|
6554
|
-
* with example response for default '|' separator like:
|
|
6555
|
-
* '{"aggregates" :{"example_request_key": {"(Mail|Region 1)": 5, "(Pickup|Region 2)": 10}}}'
|
|
6556
|
-
* @minLength 1
|
|
6557
|
-
* @maxLength 100
|
|
6558
|
-
*/
|
|
6559
|
-
hierarchySeparatorOverride?: string | null;
|
|
6560
|
-
}
|
|
6561
|
-
interface BulkUpdateOrderTagsOptions {
|
|
6562
|
-
/** Tags to be added to orders */
|
|
6563
|
-
assignTags?: Tags;
|
|
6564
|
-
/** Tags to be removed from orders */
|
|
6565
|
-
unassignTags?: Tags;
|
|
6566
|
-
}
|
|
6567
|
-
|
|
6568
|
-
export { TextDetection as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, TransactionStatus as E, FulfillmentStatus as F, type GetPaymentCollectabilityStatusResponse as G, AuthorizationCaptureStatus as H, ItemTypeItemType as I, JurisdictionType as J, AuthorizationVoidStatus as K, LineItemQuantityChangeType as L, type MaskedOrder as M, NonRefundableReason as N, type Order as O, type Price as P, Reason as Q, RefundableStatus as R, type SearchOrdersOptions as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, ActionType as X, MembershipPaymentStatus as Y, RefundStatus as Z, WebhookIdentityType as _, type PreparePaymentCollectionOptions as a, type TaxSummary as a$, AnimationDetection as a0, PreviewEmailType as a1, State as a2, Namespace as a3, SortOrder as a4, VersioningMode as a5, OrderApprovalStrategy as a6, DeltaPaymentOptionType as a7, InventoryAction as a8, Placement as a9, type SubscriptionSettings as aA, type FreeTrialPeriod as aB, type BillingAdjustment as aC, type BillingAdjustmentPriceSummary as aD, type PriceDescription as aE, type LocationAndQuantity as aF, type TaxableAddress as aG, type TaxableAddressTaxableAddressDataOneOf as aH, type ExtendedFields as aI, type BuyerInfo as aJ, type BuyerInfoIdOneOf as aK, type CurrencyConversionDetails as aL, type PriceSummary as aM, type AddressWithContact as aN, type Address as aO, type StreetAddress as aP, type AddressLocation as aQ, type FullAddressContactDetails as aR, type VatId as aS, type V1ShippingInformation as aT, type DeliveryLogistics as aU, type DeliveryLogisticsAddressOneOf as aV, type PickupDetails as aW, type PickupAddress as aX, type DeliveryTimeSlot as aY, type ShippingPrice as aZ, type ShippingRegion as a_, SubdivisionType as aa, SourceType as ab, CustomFieldGroup as ac, ValueType as ad, DepositType as ae, InvoiceStatus as af, type OrderLineItem as ag, type ProductName as ah, type CatalogReference as ai, type DescriptionLine as aj, type DescriptionLineValueOneOf as ak, type DescriptionLineDescriptionLineValueOneOf as al, type DescriptionLineName as am, type PlainTextValue as an, type Color as ao, type FocalPoint as ap, type PhysicalProperties as aq, type ItemType as ar, type ItemTypeItemTypeDataOneOf as as, type ItemTaxFullDetails as at, type LineItemTaxInfo as au, type LineItemTaxBreakdown as av, type DigitalFile as aw, type SubscriptionInfo as ax, type SubscriptionTitle as ay, type SubscriptionDescription as az, type PreparePaymentCollectionResponse as b, type CustomField as b$, type OrderTaxInfo as b0, type OrderTaxBreakdown as b1, type AppliedDiscount as b2, type AppliedDiscountDiscountSourceOneOf as b3, type Coupon as b4, type MerchantDiscount as b5, type MerchantDiscountMerchantDiscountReasonOneOf as b6, type DiscountRule as b7, type DiscountRuleName as b8, type LineItemDiscount as b9, type RefundInitiated as bA, type RefundedPayment as bB, type RefundedPaymentKindOneOf as bC, type RegularPaymentRefund as bD, type GiftCardPaymentRefund as bE, type MembershipPaymentRefund as bF, type PaymentRefunded as bG, type PaymentRefundFailed as bH, type RefundedAsStoreCredit as bI, type PaymentPending as bJ, type PaymentPendingPaymentDetailsOneOf as bK, type RegularPayment as bL, type RegularPaymentPaymentMethodDetailsOneOf as bM, type CreditCardDetails as bN, type PaymentCanceled as bO, type PaymentCanceledPaymentDetailsOneOf as bP, type PaymentDeclined as bQ, type PaymentDeclinedPaymentDetailsOneOf as bR, type ReceiptCreated as bS, type ReceiptCreatedReceiptInfoOneOf as bT, type WixReceipt as bU, type ExternalReceipt as bV, type ReceiptSent as bW, type ReceiptSentReceiptInfoOneOf as bX, type CreatedBy as bY, type CreatedByStringOneOf as bZ, type ChannelInfo as b_, type Activity as ba, type ActivityContentOneOf as bb, type CustomActivity as bc, type MerchantComment as bd, type OrderRefunded as be, type OrderCreatedFromExchange as bf, type NewExchangeOrderCreated as bg, type LineItemExchangeData as bh, type DraftOrderChangesApplied as bi, type OrderChange as bj, type OrderChangeValueOneOf as bk, type LineItemChanges as bl, type LineItemQuantityChange as bm, type LineItemPriceChange as bn, type ManagedLineItem as bo, type ManagedDiscount as bp, type TranslatedValue as bq, type LineItemAmount as br, type ManagedAdditionalFee as bs, type TotalPriceChange as bt, type ShippingInformationChange as bu, type ShippingInformation as bv, type SavedPaymentMethod as bw, type AuthorizedPaymentCreated as bx, type AuthorizedPaymentCaptured as by, type AuthorizedPaymentVoided as bz, type PaymentCapture as c, type GiftCardPaymentDetails as c$, type BalanceSummary as c0, type Balance as c1, type AdditionalFee as c2, type FulfillmentStatusesAggregate as c3, type Tags as c4, type TagList as c5, type Location as c6, type OrderApproved as c7, type OrdersExperiments as c8, type OrderRejectedEventOrderRejected as c9, type MembershipChargeItem as cA, type MembershipName as cB, type ServiceProperties as cC, type ChargeMembershipsResponse as cD, type TriggerRefundRequest as cE, type PaymentRefund as cF, type RefundDetails as cG, type RefundItem as cH, type LineItemRefund as cI, type AdditionalFeeRefund as cJ, type ShippingRefund as cK, type RefundSideEffects as cL, type RestockInfo as cM, type RestockItem as cN, type TriggerRefundResponse as cO, type OrderTransactions as cP, type Payment as cQ, type PaymentPaymentDetailsOneOf as cR, type PaymentReceiptInfoOneOf as cS, type RegularPaymentDetails as cT, type RegularPaymentDetailsPaymentMethodDetailsOneOf as cU, type CreditCardPaymentMethodDetails as cV, type AuthorizationDetails as cW, type AuthorizationCapture as cX, type AuthorizationActionFailureDetails as cY, type AuthorizationVoid as cZ, type V1ScheduledAction as c_, type OrderItemsRestocked as ca, type V1RestockItem as cb, type PreparePaymentCollectionRequest as cc, type RedirectUrls as cd, type DelayedCaptureSettings as ce, type Duration as cf, type GetPaymentCollectabilityStatusRequest as cg, type RecordManuallyCollectedPaymentRequest as ch, type RecordManuallyCollectedPaymentResponse as ci, type MarkOrderAsPaidRequest as cj, type MarkOrderAsPaidResponse as ck, type PaymentStatusUpdated as cl, type BulkMarkOrdersAsPaidRequest as cm, type BulkMarkOrdersAsPaidResponse as cn, type BulkOrderResult as co, type ItemMetadata as cp, type ApplicationError as cq, type BulkActionMetadata as cr, type GetRefundabilityStatusRequest as cs, type GetRefundabilityStatusResponse as ct, type Refundability as cu, type RefundabilityAdditionalRefundabilityInfoOneOf as cv, type CreatePaymentGatewayOrderRequest as cw, type ChargedBy as cx, type CreatePaymentGatewayOrderResponse as cy, type ChargeMembershipsRequest as cz, type SearchOrdersResponse as d, type PreviewBuyerPickupConfirmationEmailResponse as d$, type MembershipPaymentDetails as d0, type WixReceiptInfo as d1, type ExternalReceiptInfo as d2, type Refund as d3, type RefundTransaction as d4, type RefundStatusInfo as d5, type AggregatedRefundSummary as d6, type RefundItemsBreakdown as d7, type LineItemRefundSummary as d8, type CalculateRefundRequest as d9, type BulkSendBuyerPickupConfirmationEmailsRequest as dA, type BulkSendBuyerPickupConfirmationEmailsResponse as dB, type SendBuyerShippingConfirmationEmailRequest as dC, type SendBuyerShippingConfirmationEmailResponse as dD, type BulkSendBuyerShippingConfirmationEmailsRequest as dE, type BulkSendBuyerShippingConfirmationEmailsResponse as dF, type SendMerchantOrderReceivedNotificationRequest as dG, type SendMerchantOrderReceivedNotificationResponse as dH, type SendCancelRefundEmailRequest as dI, type SendCancelRefundEmailResponse as dJ, type SendRefundEmailRequest as dK, type SendRefundEmailResponse as dL, type SendMerchantOrderReceivedPushRequest as dM, type SendMerchantOrderReceivedPushResponse as dN, type PreviewEmailByTypeRequest as dO, type PreviewEmailByTypeResponse as dP, type PreviewRefundEmailRequest as dQ, type PreviewRefundEmailResponse as dR, type PreviewCancelEmailRequest as dS, type PreviewCancelEmailResponse as dT, type PreviewCancelRefundEmailRequest as dU, type PreviewCancelRefundEmailResponse as dV, type PreviewBuyerPaymentsReceivedEmailRequest as dW, type PreviewBuyerPaymentsReceivedEmailResponse as dX, type PreviewBuyerConfirmationEmailRequest as dY, type PreviewBuyerConfirmationEmailResponse as dZ, type PreviewBuyerPickupConfirmationEmailRequest as d_, type CalculateRefundItemRequest as da, type CalculateRefundResponse as db, type CalculateRefundItemResponse as dc, type VoidAuthorizedPaymentsRequest as dd, type CaptureAuthorizedPaymentsRequest as de, type ChargeSavedPaymentMethodRequest as df, type ChargeSavedPaymentMethodResponse as dg, type DomainEvent as dh, type DomainEventBodyOneOf as di, type EntityCreatedEvent as dj, type RestoreInfo as dk, type EntityUpdatedEvent as dl, type EntityDeletedEvent as dm, type ActionEvent as dn, type Empty as dp, type MessageEnvelope as dq, type IdentificationData as dr, type IdentificationDataIdOneOf as ds, type ImageContent as dt, type SendBuyerConfirmationEmailRequest as du, type SendBuyerConfirmationEmailResponse as dv, type SendBuyerPaymentsReceivedEmailRequest as dw, type SendBuyerPaymentsReceivedEmailResponse as dx, type SendBuyerPickupConfirmationEmailRequest as dy, type SendBuyerPickupConfirmationEmailResponse as dz, type CreateOrderOptions as e, type UpdateOrderResponse as e$, type PreviewShippingConfirmationEmailRequest as e0, type PreviewShippingConfirmationEmailResponse as e1, type PreviewResendDownloadLinksEmailRequest as e2, type PreviewResendDownloadLinksEmailResponse as e3, type TriggerReindexOrderRequest as e4, type SnapshotMessage as e5, type GetMetasiteDataRequest as e6, type GetMetasiteDataResponse as e7, type MetaSite as e8, type App as e9, type DeleteByFilterOperation as eA, type InternalDocumentUpdateByFilterOperation as eB, type InternalUpdateExistingOperation as eC, type VersionedDocumentUpdateOperation as eD, type VersionedDeleteByIdsOperation as eE, type VersionedDocumentId as eF, type TriggerReindexRequest as eG, type TriggerReindexResponse as eH, type BatchOfTriggerReindexOrderRequest as eI, type DiffmatokyPayload as eJ, type ErrorInformation as eK, type ContinueSideEffectsFlowInLegacyData as eL, type IndexingMessage as eM, type GetOrderRequest as eN, type GetOrderResponse as eO, type InternalQueryOrdersResponse as eP, type QueryOrderRequest as eQ, type QueryOrderResponse as eR, type SearchOrdersRequest as eS, type CursorSearch as eT, type CursorSearchPagingMethodOneOf as eU, type CursorPagingMetadata as eV, type CreateOrderRequest as eW, type OrderCreationSettings as eX, type OrderCreateNotifications as eY, type CreateOrderResponse as eZ, type UpdateOrderRequest as e_, type SeoData as ea, type MetaTag as eb, type HtmlApplication as ec, type ExternalUriMapping as ed, type UserDataResponse as ee, type QueryOrdersForMetasiteRequest as ef, type InternalQueryOrdersRequest as eg, type PlatformQuery as eh, type PlatformQueryPagingMethodOneOf as ei, type Sorting as ej, type PlatformPaging as ek, type CursorPaging as el, type QueryOrdersForMetasiteResponse as em, type PlatformPagingMetadata as en, type Cursors as eo, type GetOrderForMetasiteRequest as ep, type GetOrderForMetasiteResponse as eq, type ListOrderTransactionsForMetasiteRequest as er, type ListOrderTransactionsForMetasiteResponse as es, type UpsertRefundRequest as et, type UpsertRefundResponse as eu, type UpdateInternalDocumentsEvent as ev, type UpdateInternalDocumentsEventOperationOneOf as ew, type InternalDocument as ex, type InternalDocumentUpdateOperation as ey, type DeleteByIdsOperation as ez, type BulkUpdateOrdersResponse as f, type InvoiceSent as f$, type BulkUpdateOrdersRequest as f0, type CommitDeltasRequest as f1, type DraftOrderDiffs as f2, type DraftOrderDiffsShippingUpdateInfoOneOf as f3, type DraftOrderDiffsBuyerUpdateInfoOneOf as f4, type DraftOrderDiffsBillingUpdateInfoOneOf as f5, type DraftOrderDiffsRecipientUpdateInfoOneOf as f6, type V1LineItemDelta as f7, type V1LineItemDeltaDeltaOneOf as f8, type OrderLineItemChangedDetails as f9, type BuyerInfoUpdate as fA, type UpdateBuyerInfoResponse as fB, type UpdateBuyerEmailRequest as fC, type UpdateBuyerEmailResponse as fD, type UpdateOrderShippingAddressRequest as fE, type UpdateOrderShippingAddressResponse as fF, type UpdateBillingContactDetailsRequest as fG, type UpdateBillingContactDetailsResponse as fH, type UpdateOrderLineItemRequest as fI, type UpdateOrderLineItemResponse as fJ, type UpdateOrderLineItemsRequest as fK, type MaskedOrderLineItem as fL, type UpdateOrderLineItemsResponse as fM, type AddInternalActivityRequest as fN, type InternalActivity as fO, type InternalActivityContentOneOf as fP, type OrderPlaced as fQ, type OrderPaid as fR, type OrderFulfilled as fS, type OrderNotFulfilled as fT, type OrderCanceled as fU, type DownloadLinkSent as fV, type TrackingNumberAdded as fW, type TrackingNumberEdited as fX, type TrackingLinkAdded as fY, type ShippingConfirmationEmailSent as fZ, type InvoiceAdded as f_, type ItemChangedDetails as fa, type AppliedDiscountDelta as fb, type AppliedDiscountDeltaDeltaOneOf as fc, type AdditionalFeeDelta as fd, type AdditionalFeeDeltaDeltaOneOf as fe, type DraftOrderCommitSettings as ff, type InventoryUpdateDetails as fg, type CommitDeltasResponse as fh, type OrderDeltasCommitted as fi, type CommittedDiffs as fj, type CommittedDiffsShippingUpdateInfoOneOf as fk, type LineItemDelta as fl, type LineItemDeltaDeltaOneOf as fm, type ArchiveOrderRequest as fn, type ArchiveOrderResponse as fo, type BulkArchiveOrdersRequest as fp, type BulkArchiveOrdersResponse as fq, type BulkArchiveOrdersByFilterRequest as fr, type BulkArchiveOrdersByFilterResponse as fs, type UnArchiveOrderRequest as ft, type UnArchiveOrderResponse as fu, type BulkUnArchiveOrdersRequest as fv, type BulkUnArchiveOrdersResponse as fw, type BulkUnArchiveOrdersByFilterRequest as fx, type BulkUnArchiveOrdersByFilterResponse as fy, type UpdateBuyerInfoRequest as fz, type CancelOrderOptions as g, type Cancel as g$, type FulfillerEmailSent as g0, type ShippingAddressEdited as g1, type EmailEdited as g2, type PickupReadyEmailSent as g3, type OrderPartiallyPaid as g4, type OrderPending as g5, type OrderRejected as g6, type AddInternalActivityResponse as g7, type AddActivityRequest as g8, type PublicActivity as g9, type BulkMarkAsUnfulfilledRequest as gA, type BulkMarkAsUnfulfilledResponse as gB, type BulkMarkAsUnfulfilledByFilterRequest as gC, type BulkMarkAsUnfulfilledByFilterResponse as gD, type BulkSetBusinessLocationRequest as gE, type BulkSetBusinessLocationResponse as gF, type BulkSetBusinessLocationResult as gG, type V1MarkOrderAsPaidRequest as gH, type V1MarkOrderAsPaidResponse as gI, type V1BulkMarkOrdersAsPaidRequest as gJ, type V1BulkMarkOrdersAsPaidResponse as gK, type V1CreatePaymentGatewayOrderRequest as gL, type V1CreatePaymentGatewayOrderResponse as gM, type GetShipmentsRequest as gN, type GetShipmentsResponse as gO, type AggregateOrdersRequest as gP, type AggregateOrdersResponse as gQ, type DecrementItemsQuantityRequest as gR, type DecrementData as gS, type DecrementItemsQuantityResponse as gT, type BulkUpdateOrderTagsRequest as gU, type BulkUpdateOrderTagsResult as gV, type Task as gW, type TaskKey as gX, type TaskAction as gY, type TaskActionActionOneOf as gZ, type Complete as g_, type PublicActivityContentOneOf as ga, type AddActivityResponse as gb, type AddActivitiesRequest as gc, type AddActivitiesResponse as gd, type UpdateActivityRequest as ge, type UpdateActivityResponse as gf, type DeleteActivityRequest as gg, type DeleteActivityResponse as gh, type UpdateLineItemsDescriptionLinesRequest as gi, type LineItemUpdate as gj, type UpdateLineItemsDescriptionLinesResponse as gk, type MarkOrderAsSeenByHumanRequest as gl, type MarkOrderAsSeenByHumanResponse as gm, type CancelOrderRequest as gn, type OrderCanceledEventOrderCanceled as go, type UpdateOrderStatusRequest as gp, type UpdateOrderStatusResponse as gq, type MarkAsFulfilledRequest as gr, type MarkAsFulfilledResponse as gs, type FulfillmentStatusUpdated as gt, type BulkMarkAsFulfilledRequest as gu, type BulkMarkAsFulfilledResponse as gv, type BulkMarkAsFulfilledByFilterRequest as gw, type BulkMarkAsFulfilledByFilterResponse as gx, type MarkAsUnfulfilledRequest as gy, type MarkAsUnfulfilledResponse as gz, type CancelOrderResponse as h, type Reschedule as h0, type InvoiceSentEvent as h1, type IdAndVersion as h2, type InvoiceFields as h3, type Customer as h4, type Email as h5, type QuotesAddress as h6, type AddressDescription as h7, type Phone as h8, type Company as h9, type BaseEventMetadata as hA, type EventMetadata as hB, type OrderApprovedEnvelope as hC, type OrderUpdatedEnvelope as hD, type OrderCanceledEnvelope as hE, type OrderCreatedEnvelope as hF, type PaymentCollectionCreatePaymentGatewayOrderOptions as hG, type ChargeMembershipsOptions as hH, type TriggerRefundOptions as hI, type CommitDeltasOptions as hJ, type UpdateOrderLineItemIdentifiers as hK, type UpdateOrderLineItem as hL, type UpdateActivityIdentifiers as hM, type DeleteActivityIdentifiers as hN, type AggregateOrdersOptions as hO, type CommonAddress as ha, type CommonAddressStreetOneOf as hb, type Subdivision as hc, type StandardDetails as hd, type InvoiceDates as he, type LineItems as hf, type LineItem as hg, type BigDecimalWrapper as hh, type LineItemTax as hi, type Source as hj, type LineItemMetaData as hk, type Locale as hl, type TotalPrice as hm, type ItemizedFee as hn, type Discount as ho, type DiscountOneDiscountTypeOneOf as hp, type CalculatedTaxes as hq, type CalculatedTax as hr, type Payments as hs, type InvoicesPayment as ht, type MetaData as hu, type InvoiceDynamicPriceTotals as hv, type CustomFieldValue as hw, type Value as hx, type Deposit as hy, type TriggerSideEffectsFromLegacyData as hz, type BulkUpdateOrderTagsOptions as i, type BulkUpdateOrderTagsResponse as j, PaymentOptionType as k, SubscriptionFrequency as l, PaymentStatus as m, VatType as n, PickupMethod as o, OrderStatus as p, DiscountType as q, DiscountReason as r, ActivityType as s, AttributionSource as t, ChannelType as u, ScheduledAction as v, DurationUnit as w, PaymentCollectabilityStatus as x, ManuallyRefundableReason as y, RestockType as z };
|