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