@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,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface Order {
|
|
1
|
+
interface Order {
|
|
3
2
|
/**
|
|
4
3
|
* Order ID.
|
|
5
4
|
* @format GUID
|
|
@@ -166,8 +165,14 @@ export interface Order {
|
|
|
166
165
|
purchasedDate?: Date | null;
|
|
167
166
|
/** Order Location */
|
|
168
167
|
businessLocation?: Location;
|
|
168
|
+
/**
|
|
169
|
+
* Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
|
|
170
|
+
* @internal
|
|
171
|
+
* @readonly
|
|
172
|
+
*/
|
|
173
|
+
payAfterFreeTrial?: PriceSummary;
|
|
169
174
|
}
|
|
170
|
-
|
|
175
|
+
interface OrderLineItem {
|
|
171
176
|
/**
|
|
172
177
|
* Line item ID.
|
|
173
178
|
* @immutable
|
|
@@ -275,6 +280,17 @@ export interface OrderLineItem {
|
|
|
275
280
|
* @maxSize 5
|
|
276
281
|
*/
|
|
277
282
|
locations?: LocationAndQuantity[];
|
|
283
|
+
/**
|
|
284
|
+
* Address used for tax calculation.
|
|
285
|
+
* @internal
|
|
286
|
+
*/
|
|
287
|
+
taxableAddress?: TaxableAddress;
|
|
288
|
+
/**
|
|
289
|
+
* ID of the app managing the inventory.
|
|
290
|
+
* @internal
|
|
291
|
+
* @format GUID
|
|
292
|
+
*/
|
|
293
|
+
inventoryAppId?: string | null;
|
|
278
294
|
/**
|
|
279
295
|
* Custom extended fields for the line item object.
|
|
280
296
|
*
|
|
@@ -282,7 +298,7 @@ export interface OrderLineItem {
|
|
|
282
298
|
*/
|
|
283
299
|
extendedFields?: ExtendedFields;
|
|
284
300
|
}
|
|
285
|
-
|
|
301
|
+
interface ProductName {
|
|
286
302
|
/**
|
|
287
303
|
* __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).
|
|
288
304
|
*
|
|
@@ -304,7 +320,7 @@ export interface ProductName {
|
|
|
304
320
|
translated?: string | null;
|
|
305
321
|
}
|
|
306
322
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
307
|
-
|
|
323
|
+
interface CatalogReference {
|
|
308
324
|
/**
|
|
309
325
|
* ID of the item within the catalog it belongs to.
|
|
310
326
|
* @minLength 1
|
|
@@ -332,7 +348,7 @@ export interface CatalogReference {
|
|
|
332
348
|
*/
|
|
333
349
|
options?: Record<string, any> | null;
|
|
334
350
|
}
|
|
335
|
-
|
|
351
|
+
interface Price {
|
|
336
352
|
/**
|
|
337
353
|
* Amount.
|
|
338
354
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -344,7 +360,7 @@ export interface Price {
|
|
|
344
360
|
*/
|
|
345
361
|
formattedAmount?: string;
|
|
346
362
|
}
|
|
347
|
-
|
|
363
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
348
364
|
/** Description line plain text value. */
|
|
349
365
|
plainText?: PlainTextValue;
|
|
350
366
|
/** Description line color value. */
|
|
@@ -353,16 +369,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
353
369
|
name?: DescriptionLineName;
|
|
354
370
|
}
|
|
355
371
|
/** @oneof */
|
|
356
|
-
|
|
372
|
+
interface DescriptionLineValueOneOf {
|
|
357
373
|
/** Description line plain text value. */
|
|
358
374
|
plainText?: PlainTextValue;
|
|
359
375
|
/** Description line color value. */
|
|
360
376
|
colorInfo?: Color;
|
|
361
377
|
}
|
|
362
378
|
/** @oneof */
|
|
363
|
-
|
|
379
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
364
380
|
}
|
|
365
|
-
|
|
381
|
+
interface DescriptionLineName {
|
|
366
382
|
/**
|
|
367
383
|
* 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).
|
|
368
384
|
* @maxLength 100
|
|
@@ -376,7 +392,7 @@ export interface DescriptionLineName {
|
|
|
376
392
|
*/
|
|
377
393
|
translated?: string | null;
|
|
378
394
|
}
|
|
379
|
-
|
|
395
|
+
interface PlainTextValue {
|
|
380
396
|
/**
|
|
381
397
|
* 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).
|
|
382
398
|
* @maxLength 600
|
|
@@ -390,7 +406,7 @@ export interface PlainTextValue {
|
|
|
390
406
|
*/
|
|
391
407
|
translated?: string | null;
|
|
392
408
|
}
|
|
393
|
-
|
|
409
|
+
interface Color {
|
|
394
410
|
/**
|
|
395
411
|
* 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).
|
|
396
412
|
* @maxLength 500
|
|
@@ -406,7 +422,7 @@ export interface Color {
|
|
|
406
422
|
/** HEX or RGB color code for display. */
|
|
407
423
|
code?: string | null;
|
|
408
424
|
}
|
|
409
|
-
|
|
425
|
+
declare enum DescriptionLineType {
|
|
410
426
|
/** Unrecognized type. */
|
|
411
427
|
UNRECOGNISED = "UNRECOGNISED",
|
|
412
428
|
/** Plain text type. */
|
|
@@ -414,7 +430,7 @@ export declare enum DescriptionLineType {
|
|
|
414
430
|
/** Color type. */
|
|
415
431
|
COLOR = "COLOR"
|
|
416
432
|
}
|
|
417
|
-
|
|
433
|
+
interface FocalPoint {
|
|
418
434
|
/** X-coordinate of the focal point. */
|
|
419
435
|
x?: number;
|
|
420
436
|
/** Y-coordinate of the focal point. */
|
|
@@ -424,7 +440,7 @@ export interface FocalPoint {
|
|
|
424
440
|
/** crop by width */
|
|
425
441
|
width?: number | null;
|
|
426
442
|
}
|
|
427
|
-
|
|
443
|
+
interface PhysicalProperties {
|
|
428
444
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
429
445
|
weight?: number | null;
|
|
430
446
|
/**
|
|
@@ -435,20 +451,20 @@ export interface PhysicalProperties {
|
|
|
435
451
|
/** Whether this line item is shippable. */
|
|
436
452
|
shippable?: boolean;
|
|
437
453
|
}
|
|
438
|
-
|
|
454
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
439
455
|
/** Preset item type. */
|
|
440
456
|
preset?: ItemTypeItemType;
|
|
441
457
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
442
458
|
custom?: string;
|
|
443
459
|
}
|
|
444
460
|
/** @oneof */
|
|
445
|
-
|
|
461
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
446
462
|
/** Preset item type. */
|
|
447
463
|
preset?: ItemTypeItemType;
|
|
448
464
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
449
465
|
custom?: string;
|
|
450
466
|
}
|
|
451
|
-
|
|
467
|
+
declare enum ItemTypeItemType {
|
|
452
468
|
UNRECOGNISED = "UNRECOGNISED",
|
|
453
469
|
PHYSICAL = "PHYSICAL",
|
|
454
470
|
DIGITAL = "DIGITAL",
|
|
@@ -456,7 +472,7 @@ export declare enum ItemTypeItemType {
|
|
|
456
472
|
SERVICE = "SERVICE"
|
|
457
473
|
}
|
|
458
474
|
/** Type of selected payment option for catalog item */
|
|
459
|
-
|
|
475
|
+
declare enum PaymentOptionType {
|
|
460
476
|
/** The entire payment for this item happens as part of the checkout. */
|
|
461
477
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
462
478
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -468,7 +484,7 @@ export declare enum PaymentOptionType {
|
|
|
468
484
|
/** 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`. */
|
|
469
485
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
470
486
|
}
|
|
471
|
-
|
|
487
|
+
interface ItemTaxFullDetails {
|
|
472
488
|
/** Taxable amount of this line item. */
|
|
473
489
|
taxableAmount?: Price;
|
|
474
490
|
/**
|
|
@@ -479,7 +495,7 @@ export interface ItemTaxFullDetails {
|
|
|
479
495
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
480
496
|
totalTax?: Price;
|
|
481
497
|
}
|
|
482
|
-
|
|
498
|
+
interface LineItemTaxInfo {
|
|
483
499
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
484
500
|
taxAmount?: Price;
|
|
485
501
|
/** Amount for which tax is calculated. */
|
|
@@ -507,7 +523,7 @@ export interface LineItemTaxInfo {
|
|
|
507
523
|
* TaxBreakdown represents tax information for a line item.
|
|
508
524
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
509
525
|
*/
|
|
510
|
-
|
|
526
|
+
interface LineItemTaxBreakdown {
|
|
511
527
|
/**
|
|
512
528
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
513
529
|
* @maxLength 200
|
|
@@ -540,7 +556,7 @@ export interface LineItemTaxBreakdown {
|
|
|
540
556
|
taxableAmount?: Price;
|
|
541
557
|
}
|
|
542
558
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
543
|
-
|
|
559
|
+
declare enum JurisdictionType {
|
|
544
560
|
UNDEFINED = "UNDEFINED",
|
|
545
561
|
COUNTRY = "COUNTRY",
|
|
546
562
|
STATE = "STATE",
|
|
@@ -548,7 +564,7 @@ export declare enum JurisdictionType {
|
|
|
548
564
|
CITY = "CITY",
|
|
549
565
|
SPECIAL = "SPECIAL"
|
|
550
566
|
}
|
|
551
|
-
|
|
567
|
+
interface DigitalFile {
|
|
552
568
|
/**
|
|
553
569
|
* ID of the secure file in media.
|
|
554
570
|
* @minLength 1
|
|
@@ -568,7 +584,7 @@ export interface DigitalFile {
|
|
|
568
584
|
*/
|
|
569
585
|
expirationDate?: Date | null;
|
|
570
586
|
}
|
|
571
|
-
|
|
587
|
+
interface SubscriptionInfo {
|
|
572
588
|
/**
|
|
573
589
|
* Subscription ID.
|
|
574
590
|
* @format GUID
|
|
@@ -587,6 +603,11 @@ export interface SubscriptionInfo {
|
|
|
587
603
|
* @targetRemovalDate 2025-10-01
|
|
588
604
|
*/
|
|
589
605
|
subscriptionOptionTitle?: string;
|
|
606
|
+
/**
|
|
607
|
+
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
608
|
+
* @internal
|
|
609
|
+
*/
|
|
610
|
+
title?: SubscriptionTitle;
|
|
590
611
|
/**
|
|
591
612
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
592
613
|
* @maxLength 60
|
|
@@ -595,13 +616,29 @@ export interface SubscriptionInfo {
|
|
|
595
616
|
* @targetRemovalDate 2025-10-01
|
|
596
617
|
*/
|
|
597
618
|
subscriptionOptionDescription?: string | null;
|
|
619
|
+
/**
|
|
620
|
+
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
621
|
+
* @internal
|
|
622
|
+
*/
|
|
623
|
+
description?: SubscriptionDescription;
|
|
598
624
|
/**
|
|
599
625
|
* Subscription detailed information.
|
|
600
626
|
* @immutable
|
|
601
627
|
*/
|
|
602
628
|
subscriptionSettings?: SubscriptionSettings;
|
|
629
|
+
/**
|
|
630
|
+
* Description of the charges that will be applied for subscription.
|
|
631
|
+
* @internal
|
|
632
|
+
* @maxLength 1000
|
|
633
|
+
*/
|
|
634
|
+
chargesDescription?: string | null;
|
|
635
|
+
/**
|
|
636
|
+
* Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
|
|
637
|
+
* @internal
|
|
638
|
+
*/
|
|
639
|
+
billingAdjustment?: BillingAdjustment;
|
|
603
640
|
}
|
|
604
|
-
|
|
641
|
+
interface SubscriptionTitle {
|
|
605
642
|
/**
|
|
606
643
|
* 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).
|
|
607
644
|
* @minLength 1
|
|
@@ -617,7 +654,7 @@ export interface SubscriptionTitle {
|
|
|
617
654
|
*/
|
|
618
655
|
translated?: string | null;
|
|
619
656
|
}
|
|
620
|
-
|
|
657
|
+
interface SubscriptionDescription {
|
|
621
658
|
/**
|
|
622
659
|
* Subscription option description.
|
|
623
660
|
* @maxLength 500
|
|
@@ -629,7 +666,7 @@ export interface SubscriptionDescription {
|
|
|
629
666
|
*/
|
|
630
667
|
translated?: string | null;
|
|
631
668
|
}
|
|
632
|
-
|
|
669
|
+
interface SubscriptionSettings {
|
|
633
670
|
/** Frequency of recurring payment. */
|
|
634
671
|
frequency?: SubscriptionFrequency;
|
|
635
672
|
/**
|
|
@@ -645,16 +682,31 @@ export interface SubscriptionSettings {
|
|
|
645
682
|
* @min 1
|
|
646
683
|
*/
|
|
647
684
|
billingCycles?: number | null;
|
|
685
|
+
/**
|
|
686
|
+
* Whether to allow the customer to cancel the subscription.
|
|
687
|
+
* @internal
|
|
688
|
+
*/
|
|
689
|
+
enableCustomerCancellation?: boolean;
|
|
690
|
+
/**
|
|
691
|
+
* Period until first cycle starts. If None => no free trial
|
|
692
|
+
* @internal
|
|
693
|
+
*/
|
|
694
|
+
freeTrialPeriod?: FreeTrialPeriod;
|
|
695
|
+
/**
|
|
696
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
697
|
+
* @internal
|
|
698
|
+
*/
|
|
699
|
+
startDate?: Date | null;
|
|
648
700
|
}
|
|
649
701
|
/** Frequency unit of recurring payment */
|
|
650
|
-
|
|
702
|
+
declare enum SubscriptionFrequency {
|
|
651
703
|
UNDEFINED = "UNDEFINED",
|
|
652
704
|
DAY = "DAY",
|
|
653
705
|
WEEK = "WEEK",
|
|
654
706
|
MONTH = "MONTH",
|
|
655
707
|
YEAR = "YEAR"
|
|
656
708
|
}
|
|
657
|
-
|
|
709
|
+
interface FreeTrialPeriod {
|
|
658
710
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
659
711
|
frequency?: SubscriptionFrequency;
|
|
660
712
|
/**
|
|
@@ -664,20 +716,20 @@ export interface FreeTrialPeriod {
|
|
|
664
716
|
*/
|
|
665
717
|
interval?: number;
|
|
666
718
|
}
|
|
667
|
-
|
|
719
|
+
interface BillingAdjustment {
|
|
668
720
|
/** The type of adjustment. */
|
|
669
721
|
type?: AdjustmentType;
|
|
670
722
|
/** Summary of the prorated adjustment amount. */
|
|
671
723
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
672
724
|
}
|
|
673
|
-
|
|
725
|
+
declare enum AdjustmentType {
|
|
674
726
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
675
727
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
676
728
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
677
729
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
678
730
|
CREDIT = "CREDIT"
|
|
679
731
|
}
|
|
680
|
-
|
|
732
|
+
interface BillingAdjustmentPriceSummary {
|
|
681
733
|
/** Subtotal of adjustment, before tax. */
|
|
682
734
|
subtotal?: Price;
|
|
683
735
|
/** Tax on adjustment. */
|
|
@@ -685,7 +737,7 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
685
737
|
/** Total price after tax. */
|
|
686
738
|
total?: Price;
|
|
687
739
|
}
|
|
688
|
-
|
|
740
|
+
interface PriceDescription {
|
|
689
741
|
/**
|
|
690
742
|
* __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).
|
|
691
743
|
* @minLength 1
|
|
@@ -701,7 +753,7 @@ export interface PriceDescription {
|
|
|
701
753
|
*/
|
|
702
754
|
translated?: string | null;
|
|
703
755
|
}
|
|
704
|
-
|
|
756
|
+
interface LocationAndQuantity {
|
|
705
757
|
/**
|
|
706
758
|
* Location id in the associated owner app.
|
|
707
759
|
* @format GUID
|
|
@@ -727,22 +779,22 @@ export interface LocationAndQuantity {
|
|
|
727
779
|
*/
|
|
728
780
|
name?: string | null;
|
|
729
781
|
}
|
|
730
|
-
|
|
782
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
731
783
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
732
784
|
addressType?: TaxableAddressType;
|
|
733
785
|
}
|
|
734
786
|
/** @oneof */
|
|
735
|
-
|
|
787
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
736
788
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
737
789
|
addressType?: TaxableAddressType;
|
|
738
790
|
}
|
|
739
|
-
|
|
791
|
+
declare enum TaxableAddressType {
|
|
740
792
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
741
793
|
BUSINESS = "BUSINESS",
|
|
742
794
|
BILLING = "BILLING",
|
|
743
795
|
SHIPPING = "SHIPPING"
|
|
744
796
|
}
|
|
745
|
-
|
|
797
|
+
interface ExtendedFields {
|
|
746
798
|
/**
|
|
747
799
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
748
800
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -754,7 +806,7 @@ export interface ExtendedFields {
|
|
|
754
806
|
namespaces?: Record<string, Record<string, any>>;
|
|
755
807
|
}
|
|
756
808
|
/** Buyer Info */
|
|
757
|
-
|
|
809
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
758
810
|
/**
|
|
759
811
|
* Visitor ID (if site visitor is not a member).
|
|
760
812
|
* @format GUID
|
|
@@ -777,7 +829,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
777
829
|
email?: string | null;
|
|
778
830
|
}
|
|
779
831
|
/** @oneof */
|
|
780
|
-
|
|
832
|
+
interface BuyerInfoIdOneOf {
|
|
781
833
|
/**
|
|
782
834
|
* Visitor ID (if site visitor is not a member).
|
|
783
835
|
* @format GUID
|
|
@@ -789,7 +841,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
789
841
|
*/
|
|
790
842
|
memberId?: string;
|
|
791
843
|
}
|
|
792
|
-
|
|
844
|
+
declare enum PaymentStatus {
|
|
793
845
|
UNSPECIFIED = "UNSPECIFIED",
|
|
794
846
|
/**
|
|
795
847
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -830,7 +882,7 @@ export declare enum PaymentStatus {
|
|
|
830
882
|
*/
|
|
831
883
|
DECLINED = "DECLINED"
|
|
832
884
|
}
|
|
833
|
-
|
|
885
|
+
declare enum FulfillmentStatus {
|
|
834
886
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
835
887
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
836
888
|
/**
|
|
@@ -841,7 +893,7 @@ export declare enum FulfillmentStatus {
|
|
|
841
893
|
/** Some, but not all, of the order items are fulfilled. */
|
|
842
894
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
843
895
|
}
|
|
844
|
-
|
|
896
|
+
declare enum WeightUnit {
|
|
845
897
|
/** Weight unit can't be classified due to an error. */
|
|
846
898
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
847
899
|
/** Kilograms. */
|
|
@@ -849,7 +901,7 @@ export declare enum WeightUnit {
|
|
|
849
901
|
/** Pounds. */
|
|
850
902
|
LB = "LB"
|
|
851
903
|
}
|
|
852
|
-
|
|
904
|
+
interface CurrencyConversionDetails {
|
|
853
905
|
/**
|
|
854
906
|
* 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.
|
|
855
907
|
* @readonly
|
|
@@ -865,7 +917,7 @@ export interface CurrencyConversionDetails {
|
|
|
865
917
|
*/
|
|
866
918
|
conversionRate?: string | null;
|
|
867
919
|
}
|
|
868
|
-
|
|
920
|
+
interface PriceSummary {
|
|
869
921
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
870
922
|
subtotal?: Price;
|
|
871
923
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -880,14 +932,14 @@ export interface PriceSummary {
|
|
|
880
932
|
totalAdditionalFees?: Price;
|
|
881
933
|
}
|
|
882
934
|
/** Billing Info and shipping details */
|
|
883
|
-
|
|
935
|
+
interface AddressWithContact {
|
|
884
936
|
/** Address. */
|
|
885
937
|
address?: Address;
|
|
886
938
|
/** Contact details. */
|
|
887
939
|
contactDetails?: FullAddressContactDetails;
|
|
888
940
|
}
|
|
889
941
|
/** Physical address */
|
|
890
|
-
|
|
942
|
+
interface Address {
|
|
891
943
|
/**
|
|
892
944
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
893
945
|
* @format COUNTRY
|
|
@@ -931,20 +983,20 @@ export interface Address {
|
|
|
931
983
|
*/
|
|
932
984
|
subdivisionFullname?: string | null;
|
|
933
985
|
}
|
|
934
|
-
|
|
986
|
+
interface StreetAddress {
|
|
935
987
|
/** Street number. */
|
|
936
988
|
number?: string;
|
|
937
989
|
/** Street name. */
|
|
938
990
|
name?: string;
|
|
939
991
|
}
|
|
940
|
-
|
|
992
|
+
interface AddressLocation {
|
|
941
993
|
/** Address latitude. */
|
|
942
994
|
latitude?: number | null;
|
|
943
995
|
/** Address longitude. */
|
|
944
996
|
longitude?: number | null;
|
|
945
997
|
}
|
|
946
998
|
/** Full contact details for an address */
|
|
947
|
-
|
|
999
|
+
interface FullAddressContactDetails {
|
|
948
1000
|
/**
|
|
949
1001
|
* First name.
|
|
950
1002
|
* @maxLength 100
|
|
@@ -968,7 +1020,7 @@ export interface FullAddressContactDetails {
|
|
|
968
1020
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
969
1021
|
vatId?: VatId;
|
|
970
1022
|
}
|
|
971
|
-
|
|
1023
|
+
interface VatId {
|
|
972
1024
|
/** Customer's tax ID. */
|
|
973
1025
|
_id?: string;
|
|
974
1026
|
/**
|
|
@@ -981,14 +1033,14 @@ export interface VatId {
|
|
|
981
1033
|
type?: VatType;
|
|
982
1034
|
}
|
|
983
1035
|
/** tax info types */
|
|
984
|
-
|
|
1036
|
+
declare enum VatType {
|
|
985
1037
|
UNSPECIFIED = "UNSPECIFIED",
|
|
986
1038
|
/** CPF - for individual tax payers. */
|
|
987
1039
|
CPF = "CPF",
|
|
988
1040
|
/** CNPJ - for corporations */
|
|
989
1041
|
CNPJ = "CNPJ"
|
|
990
1042
|
}
|
|
991
|
-
|
|
1043
|
+
interface V1ShippingInformation {
|
|
992
1044
|
/**
|
|
993
1045
|
* App Def Id of external provider which was a source of shipping info
|
|
994
1046
|
* @minLength 1
|
|
@@ -1014,7 +1066,7 @@ export interface V1ShippingInformation {
|
|
|
1014
1066
|
/** Shipping region. */
|
|
1015
1067
|
region?: ShippingRegion;
|
|
1016
1068
|
}
|
|
1017
|
-
|
|
1069
|
+
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1018
1070
|
/** Shipping address and contact details. */
|
|
1019
1071
|
shippingDestination?: AddressWithContact;
|
|
1020
1072
|
/** Pickup details. */
|
|
@@ -1038,20 +1090,20 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
1038
1090
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1039
1091
|
}
|
|
1040
1092
|
/** @oneof */
|
|
1041
|
-
|
|
1093
|
+
interface DeliveryLogisticsAddressOneOf {
|
|
1042
1094
|
/** Shipping address and contact details. */
|
|
1043
1095
|
shippingDestination?: AddressWithContact;
|
|
1044
1096
|
/** Pickup details. */
|
|
1045
1097
|
pickupDetails?: PickupDetails;
|
|
1046
1098
|
}
|
|
1047
|
-
|
|
1099
|
+
interface PickupDetails {
|
|
1048
1100
|
/** Pickup address. */
|
|
1049
1101
|
address?: PickupAddress;
|
|
1050
1102
|
/** Pickup method */
|
|
1051
1103
|
pickupMethod?: PickupMethod;
|
|
1052
1104
|
}
|
|
1053
1105
|
/** Physical address */
|
|
1054
|
-
|
|
1106
|
+
interface PickupAddress {
|
|
1055
1107
|
/**
|
|
1056
1108
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1057
1109
|
* @format COUNTRY
|
|
@@ -1095,18 +1147,18 @@ export interface PickupAddress {
|
|
|
1095
1147
|
*/
|
|
1096
1148
|
subdivisionFullname?: string | null;
|
|
1097
1149
|
}
|
|
1098
|
-
|
|
1150
|
+
declare enum PickupMethod {
|
|
1099
1151
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1100
1152
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1101
1153
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1102
1154
|
}
|
|
1103
|
-
|
|
1155
|
+
interface DeliveryTimeSlot {
|
|
1104
1156
|
/** Delivery slot starting time. */
|
|
1105
1157
|
from?: Date | null;
|
|
1106
1158
|
/** Delivery slot ending time. */
|
|
1107
1159
|
to?: Date | null;
|
|
1108
1160
|
}
|
|
1109
|
-
|
|
1161
|
+
interface ShippingPrice {
|
|
1110
1162
|
/** Shipping price for display purposes. */
|
|
1111
1163
|
price?: Price;
|
|
1112
1164
|
/**
|
|
@@ -1127,14 +1179,14 @@ export interface ShippingPrice {
|
|
|
1127
1179
|
*/
|
|
1128
1180
|
discount?: Price;
|
|
1129
1181
|
}
|
|
1130
|
-
|
|
1182
|
+
interface ShippingRegion {
|
|
1131
1183
|
/**
|
|
1132
1184
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1133
1185
|
* @maxLength 100
|
|
1134
1186
|
*/
|
|
1135
1187
|
name?: string | null;
|
|
1136
1188
|
}
|
|
1137
|
-
|
|
1189
|
+
declare enum OrderStatus {
|
|
1138
1190
|
/** Order created, but not yet approved or canceled. */
|
|
1139
1191
|
INITIALIZED = "INITIALIZED",
|
|
1140
1192
|
/**
|
|
@@ -1159,14 +1211,14 @@ export declare enum OrderStatus {
|
|
|
1159
1211
|
*/
|
|
1160
1212
|
REJECTED = "REJECTED"
|
|
1161
1213
|
}
|
|
1162
|
-
|
|
1214
|
+
interface TaxSummary {
|
|
1163
1215
|
/**
|
|
1164
1216
|
* Total tax.
|
|
1165
1217
|
* @readonly
|
|
1166
1218
|
*/
|
|
1167
1219
|
totalTax?: Price;
|
|
1168
1220
|
}
|
|
1169
|
-
|
|
1221
|
+
interface OrderTaxInfo {
|
|
1170
1222
|
/** Calculated tax, added from line items. */
|
|
1171
1223
|
totalTax?: Price;
|
|
1172
1224
|
/**
|
|
@@ -1186,7 +1238,7 @@ export interface OrderTaxInfo {
|
|
|
1186
1238
|
* 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.
|
|
1187
1239
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1188
1240
|
*/
|
|
1189
|
-
|
|
1241
|
+
interface OrderTaxBreakdown {
|
|
1190
1242
|
/**
|
|
1191
1243
|
* The name of the tax against which this tax amount was calculated.
|
|
1192
1244
|
* @maxLength 200
|
|
@@ -1213,7 +1265,7 @@ export interface OrderTaxBreakdown {
|
|
|
1213
1265
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1214
1266
|
aggregatedTaxAmount?: Price;
|
|
1215
1267
|
}
|
|
1216
|
-
|
|
1268
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1217
1269
|
/** Applied coupon info. */
|
|
1218
1270
|
coupon?: Coupon;
|
|
1219
1271
|
/** Merchant discount. */
|
|
@@ -1244,9 +1296,17 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1244
1296
|
* @immutable
|
|
1245
1297
|
*/
|
|
1246
1298
|
_id?: string | null;
|
|
1299
|
+
/**
|
|
1300
|
+
* Number of subscription billing cycles the discount applies to.
|
|
1301
|
+
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
1302
|
+
* @internal
|
|
1303
|
+
* @min 1
|
|
1304
|
+
* @max 999
|
|
1305
|
+
*/
|
|
1306
|
+
subscriptionCycles?: number | null;
|
|
1247
1307
|
}
|
|
1248
1308
|
/** @oneof */
|
|
1249
|
-
|
|
1309
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1250
1310
|
/** Applied coupon info. */
|
|
1251
1311
|
coupon?: Coupon;
|
|
1252
1312
|
/** Merchant discount. */
|
|
@@ -1254,13 +1314,13 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1254
1314
|
/** Automatic Discount */
|
|
1255
1315
|
discountRule?: DiscountRule;
|
|
1256
1316
|
}
|
|
1257
|
-
|
|
1317
|
+
declare enum DiscountType {
|
|
1258
1318
|
GLOBAL = "GLOBAL",
|
|
1259
1319
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1260
1320
|
SHIPPING = "SHIPPING"
|
|
1261
1321
|
}
|
|
1262
1322
|
/** Coupon */
|
|
1263
|
-
|
|
1323
|
+
interface Coupon {
|
|
1264
1324
|
/** Coupon ID. */
|
|
1265
1325
|
_id?: string;
|
|
1266
1326
|
/** Coupon code. */
|
|
@@ -1270,7 +1330,7 @@ export interface Coupon {
|
|
|
1270
1330
|
/** Coupon value. */
|
|
1271
1331
|
amount?: Price;
|
|
1272
1332
|
}
|
|
1273
|
-
|
|
1333
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1274
1334
|
/**
|
|
1275
1335
|
* Pre-defined discount reason (optional).
|
|
1276
1336
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1283,9 +1343,16 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1283
1343
|
description?: string | null;
|
|
1284
1344
|
/** Discount amount. */
|
|
1285
1345
|
amount?: Price;
|
|
1346
|
+
/**
|
|
1347
|
+
* Discount percentage.
|
|
1348
|
+
* @internal
|
|
1349
|
+
* @format DECIMAL_VALUE
|
|
1350
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1351
|
+
*/
|
|
1352
|
+
percentage?: string | null;
|
|
1286
1353
|
}
|
|
1287
1354
|
/** @oneof */
|
|
1288
|
-
|
|
1355
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1289
1356
|
/**
|
|
1290
1357
|
* Pre-defined discount reason (optional).
|
|
1291
1358
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1297,12 +1364,12 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1297
1364
|
*/
|
|
1298
1365
|
description?: string | null;
|
|
1299
1366
|
}
|
|
1300
|
-
|
|
1367
|
+
declare enum DiscountReason {
|
|
1301
1368
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1302
1369
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1303
1370
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1304
1371
|
}
|
|
1305
|
-
|
|
1372
|
+
interface DiscountRule {
|
|
1306
1373
|
/**
|
|
1307
1374
|
* Discount rule ID
|
|
1308
1375
|
* @format GUID
|
|
@@ -1313,7 +1380,7 @@ export interface DiscountRule {
|
|
|
1313
1380
|
/** Discount value. */
|
|
1314
1381
|
amount?: Price;
|
|
1315
1382
|
}
|
|
1316
|
-
|
|
1383
|
+
interface DiscountRuleName {
|
|
1317
1384
|
/**
|
|
1318
1385
|
* Original discount rule name (in site's default language).
|
|
1319
1386
|
* @minLength 1
|
|
@@ -1327,7 +1394,7 @@ export interface DiscountRuleName {
|
|
|
1327
1394
|
*/
|
|
1328
1395
|
translated?: string | null;
|
|
1329
1396
|
}
|
|
1330
|
-
|
|
1397
|
+
interface LineItemDiscount {
|
|
1331
1398
|
/**
|
|
1332
1399
|
* ID of line item the discount applies to.
|
|
1333
1400
|
* @format GUID
|
|
@@ -1336,13 +1403,67 @@ export interface LineItemDiscount {
|
|
|
1336
1403
|
/** Total discount for this line item. */
|
|
1337
1404
|
totalDiscount?: Price;
|
|
1338
1405
|
}
|
|
1339
|
-
|
|
1406
|
+
interface Activity extends ActivityContentOneOf {
|
|
1340
1407
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1341
1408
|
customActivity?: CustomActivity;
|
|
1342
1409
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
1343
1410
|
merchantComment?: MerchantComment;
|
|
1344
1411
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1345
1412
|
orderRefunded?: OrderRefunded;
|
|
1413
|
+
/**
|
|
1414
|
+
* Details of an initiated refund process.
|
|
1415
|
+
*
|
|
1416
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1417
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1418
|
+
* @internal
|
|
1419
|
+
*/
|
|
1420
|
+
refundInitiated?: RefundInitiated;
|
|
1421
|
+
/**
|
|
1422
|
+
* Details of a refunded payment.
|
|
1423
|
+
*
|
|
1424
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1425
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1426
|
+
* @internal
|
|
1427
|
+
*/
|
|
1428
|
+
paymentRefunded?: PaymentRefunded;
|
|
1429
|
+
/**
|
|
1430
|
+
* Details of a failed payment refund.
|
|
1431
|
+
*
|
|
1432
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1433
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1434
|
+
* @internal
|
|
1435
|
+
*/
|
|
1436
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1437
|
+
/**
|
|
1438
|
+
* Details of refund to store credit.
|
|
1439
|
+
* @internal
|
|
1440
|
+
*/
|
|
1441
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1442
|
+
/**
|
|
1443
|
+
* Details of a pending payment
|
|
1444
|
+
* @internal
|
|
1445
|
+
*/
|
|
1446
|
+
paymentPending?: PaymentPending;
|
|
1447
|
+
/**
|
|
1448
|
+
* Details of a canceled payment
|
|
1449
|
+
* @internal
|
|
1450
|
+
*/
|
|
1451
|
+
paymentCanceled?: PaymentCanceled;
|
|
1452
|
+
/**
|
|
1453
|
+
* Details of a declined payment
|
|
1454
|
+
* @internal
|
|
1455
|
+
*/
|
|
1456
|
+
paymentDeclined?: PaymentDeclined;
|
|
1457
|
+
/**
|
|
1458
|
+
* Receipt was added for associated payment
|
|
1459
|
+
* @internal
|
|
1460
|
+
*/
|
|
1461
|
+
receiptCreated?: ReceiptCreated;
|
|
1462
|
+
/**
|
|
1463
|
+
* Receipt sent to customer
|
|
1464
|
+
* @internal
|
|
1465
|
+
*/
|
|
1466
|
+
receiptSent?: ReceiptSent;
|
|
1346
1467
|
/**
|
|
1347
1468
|
* Activity ID.
|
|
1348
1469
|
* @format GUID
|
|
@@ -1364,15 +1485,69 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
1364
1485
|
type?: ActivityType;
|
|
1365
1486
|
}
|
|
1366
1487
|
/** @oneof */
|
|
1367
|
-
|
|
1488
|
+
interface ActivityContentOneOf {
|
|
1368
1489
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1369
1490
|
customActivity?: CustomActivity;
|
|
1370
1491
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
1371
1492
|
merchantComment?: MerchantComment;
|
|
1372
1493
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1373
1494
|
orderRefunded?: OrderRefunded;
|
|
1495
|
+
/**
|
|
1496
|
+
* Details of an initiated refund process.
|
|
1497
|
+
*
|
|
1498
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1499
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1500
|
+
* @internal
|
|
1501
|
+
*/
|
|
1502
|
+
refundInitiated?: RefundInitiated;
|
|
1503
|
+
/**
|
|
1504
|
+
* Details of a refunded payment.
|
|
1505
|
+
*
|
|
1506
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1507
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1508
|
+
* @internal
|
|
1509
|
+
*/
|
|
1510
|
+
paymentRefunded?: PaymentRefunded;
|
|
1511
|
+
/**
|
|
1512
|
+
* Details of a failed payment refund.
|
|
1513
|
+
*
|
|
1514
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
1515
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
1516
|
+
* @internal
|
|
1517
|
+
*/
|
|
1518
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
1519
|
+
/**
|
|
1520
|
+
* Details of refund to store credit.
|
|
1521
|
+
* @internal
|
|
1522
|
+
*/
|
|
1523
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
1524
|
+
/**
|
|
1525
|
+
* Details of a pending payment
|
|
1526
|
+
* @internal
|
|
1527
|
+
*/
|
|
1528
|
+
paymentPending?: PaymentPending;
|
|
1529
|
+
/**
|
|
1530
|
+
* Details of a canceled payment
|
|
1531
|
+
* @internal
|
|
1532
|
+
*/
|
|
1533
|
+
paymentCanceled?: PaymentCanceled;
|
|
1534
|
+
/**
|
|
1535
|
+
* Details of a declined payment
|
|
1536
|
+
* @internal
|
|
1537
|
+
*/
|
|
1538
|
+
paymentDeclined?: PaymentDeclined;
|
|
1539
|
+
/**
|
|
1540
|
+
* Receipt was added for associated payment
|
|
1541
|
+
* @internal
|
|
1542
|
+
*/
|
|
1543
|
+
receiptCreated?: ReceiptCreated;
|
|
1544
|
+
/**
|
|
1545
|
+
* Receipt sent to customer
|
|
1546
|
+
* @internal
|
|
1547
|
+
*/
|
|
1548
|
+
receiptSent?: ReceiptSent;
|
|
1374
1549
|
}
|
|
1375
|
-
|
|
1550
|
+
interface CustomActivity {
|
|
1376
1551
|
/**
|
|
1377
1552
|
* ID of the app that created the custom activity.
|
|
1378
1553
|
* @format GUID
|
|
@@ -1387,7 +1562,7 @@ export interface CustomActivity {
|
|
|
1387
1562
|
additionalData?: Record<string, string>;
|
|
1388
1563
|
}
|
|
1389
1564
|
/** Store owner added a comment */
|
|
1390
|
-
|
|
1565
|
+
interface MerchantComment {
|
|
1391
1566
|
/**
|
|
1392
1567
|
* Merchant comment message.
|
|
1393
1568
|
* @minLength 1
|
|
@@ -1395,7 +1570,7 @@ export interface MerchantComment {
|
|
|
1395
1570
|
*/
|
|
1396
1571
|
message?: string;
|
|
1397
1572
|
}
|
|
1398
|
-
|
|
1573
|
+
interface OrderRefunded {
|
|
1399
1574
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
1400
1575
|
manual?: boolean;
|
|
1401
1576
|
/** Refund amount. */
|
|
@@ -1406,14 +1581,14 @@ export interface OrderRefunded {
|
|
|
1406
1581
|
*/
|
|
1407
1582
|
reason?: string;
|
|
1408
1583
|
}
|
|
1409
|
-
|
|
1584
|
+
interface OrderCreatedFromExchange {
|
|
1410
1585
|
/**
|
|
1411
1586
|
* ID of the original order for which the exchange happened.
|
|
1412
1587
|
* @format GUID
|
|
1413
1588
|
*/
|
|
1414
1589
|
originalOrderId?: string;
|
|
1415
1590
|
}
|
|
1416
|
-
|
|
1591
|
+
interface NewExchangeOrderCreated {
|
|
1417
1592
|
/**
|
|
1418
1593
|
* ID of the new order created as a result of an exchange of items.
|
|
1419
1594
|
* @format GUID
|
|
@@ -1426,7 +1601,7 @@ export interface NewExchangeOrderCreated {
|
|
|
1426
1601
|
*/
|
|
1427
1602
|
lineItems?: LineItemExchangeData[];
|
|
1428
1603
|
}
|
|
1429
|
-
|
|
1604
|
+
interface LineItemExchangeData {
|
|
1430
1605
|
/**
|
|
1431
1606
|
* ID of the exchanged line item.
|
|
1432
1607
|
* @format GUID
|
|
@@ -1439,7 +1614,7 @@ export interface LineItemExchangeData {
|
|
|
1439
1614
|
*/
|
|
1440
1615
|
quantity?: number;
|
|
1441
1616
|
}
|
|
1442
|
-
|
|
1617
|
+
interface DraftOrderChangesApplied {
|
|
1443
1618
|
/** Draft order id. */
|
|
1444
1619
|
draftOrderId?: string;
|
|
1445
1620
|
/**
|
|
@@ -1450,7 +1625,7 @@ export interface DraftOrderChangesApplied {
|
|
|
1450
1625
|
/** Changes applied to order. */
|
|
1451
1626
|
changes?: OrderChange[];
|
|
1452
1627
|
}
|
|
1453
|
-
|
|
1628
|
+
interface OrderChange extends OrderChangeValueOneOf {
|
|
1454
1629
|
lineItemChanged?: LineItemChanges;
|
|
1455
1630
|
lineItemAdded?: ManagedLineItem;
|
|
1456
1631
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -1462,7 +1637,7 @@ export interface OrderChange extends OrderChangeValueOneOf {
|
|
|
1462
1637
|
shippingInformationChanged?: ShippingInformationChange;
|
|
1463
1638
|
}
|
|
1464
1639
|
/** @oneof */
|
|
1465
|
-
|
|
1640
|
+
interface OrderChangeValueOneOf {
|
|
1466
1641
|
lineItemChanged?: LineItemChanges;
|
|
1467
1642
|
lineItemAdded?: ManagedLineItem;
|
|
1468
1643
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -1473,7 +1648,7 @@ export interface OrderChangeValueOneOf {
|
|
|
1473
1648
|
totalPriceChanged?: TotalPriceChange;
|
|
1474
1649
|
shippingInformationChanged?: ShippingInformationChange;
|
|
1475
1650
|
}
|
|
1476
|
-
|
|
1651
|
+
interface LineItemChanges {
|
|
1477
1652
|
/**
|
|
1478
1653
|
* Line item ID.
|
|
1479
1654
|
* @format GUID
|
|
@@ -1486,7 +1661,7 @@ export interface LineItemChanges {
|
|
|
1486
1661
|
/** Item price change. */
|
|
1487
1662
|
price?: LineItemPriceChange;
|
|
1488
1663
|
}
|
|
1489
|
-
|
|
1664
|
+
interface LineItemQuantityChange {
|
|
1490
1665
|
/**
|
|
1491
1666
|
* Item quantity before update.
|
|
1492
1667
|
* @max 1000000
|
|
@@ -1506,19 +1681,19 @@ export interface LineItemQuantityChange {
|
|
|
1506
1681
|
/** Type of quantity change: increase or decrease. */
|
|
1507
1682
|
deltaType?: LineItemQuantityChangeType;
|
|
1508
1683
|
}
|
|
1509
|
-
|
|
1684
|
+
declare enum LineItemQuantityChangeType {
|
|
1510
1685
|
/** Quantity increased. */
|
|
1511
1686
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
1512
1687
|
/** Quantity decreased. */
|
|
1513
1688
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
1514
1689
|
}
|
|
1515
|
-
|
|
1690
|
+
interface LineItemPriceChange {
|
|
1516
1691
|
/** Item price before update. */
|
|
1517
1692
|
originalPrice?: Price;
|
|
1518
1693
|
/** Item price after update. */
|
|
1519
1694
|
newPrice?: Price;
|
|
1520
1695
|
}
|
|
1521
|
-
|
|
1696
|
+
interface ManagedLineItem {
|
|
1522
1697
|
/**
|
|
1523
1698
|
* Line item ID.
|
|
1524
1699
|
* @format GUID
|
|
@@ -1533,7 +1708,7 @@ export interface ManagedLineItem {
|
|
|
1533
1708
|
*/
|
|
1534
1709
|
quantity?: number;
|
|
1535
1710
|
}
|
|
1536
|
-
|
|
1711
|
+
interface ManagedDiscount {
|
|
1537
1712
|
/**
|
|
1538
1713
|
* Discount id.
|
|
1539
1714
|
* @format GUID
|
|
@@ -1546,7 +1721,7 @@ export interface ManagedDiscount {
|
|
|
1546
1721
|
/** Discount amount. */
|
|
1547
1722
|
totalAmount?: Price;
|
|
1548
1723
|
}
|
|
1549
|
-
|
|
1724
|
+
interface TranslatedValue {
|
|
1550
1725
|
/**
|
|
1551
1726
|
* Value in site default language.
|
|
1552
1727
|
* @minLength 1
|
|
@@ -1558,7 +1733,7 @@ export interface TranslatedValue {
|
|
|
1558
1733
|
*/
|
|
1559
1734
|
translated?: string | null;
|
|
1560
1735
|
}
|
|
1561
|
-
|
|
1736
|
+
interface LineItemAmount {
|
|
1562
1737
|
/**
|
|
1563
1738
|
* Order line item id
|
|
1564
1739
|
* @format GUID
|
|
@@ -1569,7 +1744,7 @@ export interface LineItemAmount {
|
|
|
1569
1744
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
1570
1745
|
amount?: Price;
|
|
1571
1746
|
}
|
|
1572
|
-
|
|
1747
|
+
interface ManagedAdditionalFee {
|
|
1573
1748
|
/**
|
|
1574
1749
|
* Additional fee id.
|
|
1575
1750
|
* @format GUID
|
|
@@ -1582,19 +1757,19 @@ export interface ManagedAdditionalFee {
|
|
|
1582
1757
|
/** Additional fee amount. */
|
|
1583
1758
|
totalAmount?: Price;
|
|
1584
1759
|
}
|
|
1585
|
-
|
|
1760
|
+
interface TotalPriceChange {
|
|
1586
1761
|
/** Order’s total price after discounts and tax. Before update */
|
|
1587
1762
|
originalTotal?: Price;
|
|
1588
1763
|
/** Order’s total price after discounts and tax. After update */
|
|
1589
1764
|
newTotal?: Price;
|
|
1590
1765
|
}
|
|
1591
|
-
|
|
1766
|
+
interface ShippingInformationChange {
|
|
1592
1767
|
/** Order’s Shipping Information. Before update */
|
|
1593
1768
|
originalShippingInfo?: ShippingInformation;
|
|
1594
1769
|
/** Order’s Shipping Information. After update */
|
|
1595
1770
|
newShippingInfo?: ShippingInformation;
|
|
1596
1771
|
}
|
|
1597
|
-
|
|
1772
|
+
interface ShippingInformation {
|
|
1598
1773
|
/** Order’s shipping price. */
|
|
1599
1774
|
total?: Price;
|
|
1600
1775
|
/**
|
|
@@ -1604,7 +1779,7 @@ export interface ShippingInformation {
|
|
|
1604
1779
|
shippingTitle?: string;
|
|
1605
1780
|
}
|
|
1606
1781
|
/** Payment method is saved for order */
|
|
1607
|
-
|
|
1782
|
+
interface SavedPaymentMethod {
|
|
1608
1783
|
/**
|
|
1609
1784
|
* Payment method name
|
|
1610
1785
|
* @minLength 1
|
|
@@ -1618,7 +1793,7 @@ export interface SavedPaymentMethod {
|
|
|
1618
1793
|
*/
|
|
1619
1794
|
description?: string | null;
|
|
1620
1795
|
}
|
|
1621
|
-
|
|
1796
|
+
interface AuthorizedPaymentCreated {
|
|
1622
1797
|
/**
|
|
1623
1798
|
* Payment ID of payment associated with this activity
|
|
1624
1799
|
* @format GUID
|
|
@@ -1637,7 +1812,7 @@ export interface AuthorizedPaymentCreated {
|
|
|
1637
1812
|
*/
|
|
1638
1813
|
brand?: string | null;
|
|
1639
1814
|
}
|
|
1640
|
-
|
|
1815
|
+
interface AuthorizedPaymentCaptured {
|
|
1641
1816
|
/**
|
|
1642
1817
|
* Payment ID of payment associated with this activity
|
|
1643
1818
|
* @format GUID
|
|
@@ -1656,7 +1831,7 @@ export interface AuthorizedPaymentCaptured {
|
|
|
1656
1831
|
*/
|
|
1657
1832
|
brand?: string | null;
|
|
1658
1833
|
}
|
|
1659
|
-
|
|
1834
|
+
interface AuthorizedPaymentVoided {
|
|
1660
1835
|
/**
|
|
1661
1836
|
* Payment ID of payment associated with this activity
|
|
1662
1837
|
* @format GUID
|
|
@@ -1675,7 +1850,7 @@ export interface AuthorizedPaymentVoided {
|
|
|
1675
1850
|
*/
|
|
1676
1851
|
brand?: string | null;
|
|
1677
1852
|
}
|
|
1678
|
-
|
|
1853
|
+
interface RefundInitiated {
|
|
1679
1854
|
/**
|
|
1680
1855
|
* Refund ID.
|
|
1681
1856
|
* @format GUID
|
|
@@ -1695,7 +1870,7 @@ export interface RefundInitiated {
|
|
|
1695
1870
|
*/
|
|
1696
1871
|
reason?: string | null;
|
|
1697
1872
|
}
|
|
1698
|
-
|
|
1873
|
+
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
1699
1874
|
/** Regular payment refund. */
|
|
1700
1875
|
regular?: RegularPaymentRefund;
|
|
1701
1876
|
/** Gift card payment refund. */
|
|
@@ -1711,7 +1886,7 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
1711
1886
|
externalRefund?: boolean;
|
|
1712
1887
|
}
|
|
1713
1888
|
/** @oneof */
|
|
1714
|
-
|
|
1889
|
+
interface RefundedPaymentKindOneOf {
|
|
1715
1890
|
/** Regular payment refund. */
|
|
1716
1891
|
regular?: RegularPaymentRefund;
|
|
1717
1892
|
/** Gift card payment refund. */
|
|
@@ -1719,7 +1894,7 @@ export interface RefundedPaymentKindOneOf {
|
|
|
1719
1894
|
/** Membership payment refund. */
|
|
1720
1895
|
membership?: MembershipPaymentRefund;
|
|
1721
1896
|
}
|
|
1722
|
-
|
|
1897
|
+
interface RegularPaymentRefund {
|
|
1723
1898
|
/** Refund amount */
|
|
1724
1899
|
amount?: Price;
|
|
1725
1900
|
/**
|
|
@@ -1733,7 +1908,7 @@ export interface RegularPaymentRefund {
|
|
|
1733
1908
|
*/
|
|
1734
1909
|
brand?: string | null;
|
|
1735
1910
|
}
|
|
1736
|
-
|
|
1911
|
+
interface GiftCardPaymentRefund {
|
|
1737
1912
|
/**
|
|
1738
1913
|
* Gift card payment ID
|
|
1739
1914
|
* @minLength 1
|
|
@@ -1743,7 +1918,7 @@ export interface GiftCardPaymentRefund {
|
|
|
1743
1918
|
/** Refund amount */
|
|
1744
1919
|
amount?: Price;
|
|
1745
1920
|
}
|
|
1746
|
-
|
|
1921
|
+
interface MembershipPaymentRefund {
|
|
1747
1922
|
/**
|
|
1748
1923
|
* Membership ID
|
|
1749
1924
|
* @minLength 1
|
|
@@ -1751,7 +1926,7 @@ export interface MembershipPaymentRefund {
|
|
|
1751
1926
|
*/
|
|
1752
1927
|
membershipId?: string | null;
|
|
1753
1928
|
}
|
|
1754
|
-
|
|
1929
|
+
interface PaymentRefunded {
|
|
1755
1930
|
/**
|
|
1756
1931
|
* Refund ID.
|
|
1757
1932
|
* @format GUID
|
|
@@ -1760,7 +1935,7 @@ export interface PaymentRefunded {
|
|
|
1760
1935
|
/** Details about the refunded payment. */
|
|
1761
1936
|
payment?: RefundedPayment;
|
|
1762
1937
|
}
|
|
1763
|
-
|
|
1938
|
+
interface PaymentRefundFailed {
|
|
1764
1939
|
/**
|
|
1765
1940
|
* Refund ID.
|
|
1766
1941
|
* @format GUID
|
|
@@ -1769,7 +1944,7 @@ export interface PaymentRefundFailed {
|
|
|
1769
1944
|
/** Details about the failed payment refund. */
|
|
1770
1945
|
payment?: RefundedPayment;
|
|
1771
1946
|
}
|
|
1772
|
-
|
|
1947
|
+
interface RefundedAsStoreCredit {
|
|
1773
1948
|
/** Refund amount */
|
|
1774
1949
|
amount?: Price;
|
|
1775
1950
|
/**
|
|
@@ -1778,7 +1953,7 @@ export interface RefundedAsStoreCredit {
|
|
|
1778
1953
|
*/
|
|
1779
1954
|
reason?: string | null;
|
|
1780
1955
|
}
|
|
1781
|
-
|
|
1956
|
+
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
1782
1957
|
/** Regular payment. */
|
|
1783
1958
|
regular?: RegularPayment;
|
|
1784
1959
|
/**
|
|
@@ -1788,22 +1963,22 @@ export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
1788
1963
|
paymentId?: string;
|
|
1789
1964
|
}
|
|
1790
1965
|
/** @oneof */
|
|
1791
|
-
|
|
1966
|
+
interface PaymentPendingPaymentDetailsOneOf {
|
|
1792
1967
|
/** Regular payment. */
|
|
1793
1968
|
regular?: RegularPayment;
|
|
1794
1969
|
}
|
|
1795
|
-
|
|
1970
|
+
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
1796
1971
|
/** Whether regular card used */
|
|
1797
1972
|
creditCardDetails?: CreditCardDetails;
|
|
1798
1973
|
/** Payment amount */
|
|
1799
1974
|
amount?: Price;
|
|
1800
1975
|
}
|
|
1801
1976
|
/** @oneof */
|
|
1802
|
-
|
|
1977
|
+
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
1803
1978
|
/** Whether regular card used */
|
|
1804
1979
|
creditCardDetails?: CreditCardDetails;
|
|
1805
1980
|
}
|
|
1806
|
-
|
|
1981
|
+
interface CreditCardDetails {
|
|
1807
1982
|
/**
|
|
1808
1983
|
* The last 4 digits of the card number.
|
|
1809
1984
|
* @maxLength 4
|
|
@@ -1815,7 +1990,7 @@ export interface CreditCardDetails {
|
|
|
1815
1990
|
*/
|
|
1816
1991
|
brand?: string | null;
|
|
1817
1992
|
}
|
|
1818
|
-
|
|
1993
|
+
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
1819
1994
|
/** Regular payment. */
|
|
1820
1995
|
regular?: RegularPayment;
|
|
1821
1996
|
/**
|
|
@@ -1825,11 +2000,11 @@ export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
1825
2000
|
paymentId?: string;
|
|
1826
2001
|
}
|
|
1827
2002
|
/** @oneof */
|
|
1828
|
-
|
|
2003
|
+
interface PaymentCanceledPaymentDetailsOneOf {
|
|
1829
2004
|
/** Regular payment. */
|
|
1830
2005
|
regular?: RegularPayment;
|
|
1831
2006
|
}
|
|
1832
|
-
|
|
2007
|
+
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
1833
2008
|
/** Regular payment. */
|
|
1834
2009
|
regular?: RegularPayment;
|
|
1835
2010
|
/**
|
|
@@ -1839,11 +2014,11 @@ export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
1839
2014
|
paymentId?: string;
|
|
1840
2015
|
}
|
|
1841
2016
|
/** @oneof */
|
|
1842
|
-
|
|
2017
|
+
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
1843
2018
|
/** Regular payment. */
|
|
1844
2019
|
regular?: RegularPayment;
|
|
1845
2020
|
}
|
|
1846
|
-
|
|
2021
|
+
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
1847
2022
|
/** Receipt created by Wix */
|
|
1848
2023
|
wixReceipt?: WixReceipt;
|
|
1849
2024
|
/** Receipt created by an external system. */
|
|
@@ -1855,13 +2030,13 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
1855
2030
|
paymentId?: string;
|
|
1856
2031
|
}
|
|
1857
2032
|
/** @oneof */
|
|
1858
|
-
|
|
2033
|
+
interface ReceiptCreatedReceiptInfoOneOf {
|
|
1859
2034
|
/** Receipt created by Wix */
|
|
1860
2035
|
wixReceipt?: WixReceipt;
|
|
1861
2036
|
/** Receipt created by an external system. */
|
|
1862
2037
|
externalReceipt?: ExternalReceipt;
|
|
1863
2038
|
}
|
|
1864
|
-
|
|
2039
|
+
interface WixReceipt {
|
|
1865
2040
|
/**
|
|
1866
2041
|
* Receipt ID
|
|
1867
2042
|
* @format GUID
|
|
@@ -1874,7 +2049,7 @@ export interface WixReceipt {
|
|
|
1874
2049
|
*/
|
|
1875
2050
|
displayNumber?: string | null;
|
|
1876
2051
|
}
|
|
1877
|
-
|
|
2052
|
+
interface ExternalReceipt {
|
|
1878
2053
|
/**
|
|
1879
2054
|
* Receipt ID
|
|
1880
2055
|
* @maxLength 100
|
|
@@ -1887,7 +2062,7 @@ export interface ExternalReceipt {
|
|
|
1887
2062
|
*/
|
|
1888
2063
|
displayNumber?: string | null;
|
|
1889
2064
|
}
|
|
1890
|
-
|
|
2065
|
+
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
1891
2066
|
/** Receipt created by Wix */
|
|
1892
2067
|
wixReceipt?: WixReceipt;
|
|
1893
2068
|
/** Receipt created by an external system. */
|
|
@@ -1899,13 +2074,13 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
1899
2074
|
paymentId?: string;
|
|
1900
2075
|
}
|
|
1901
2076
|
/** @oneof */
|
|
1902
|
-
|
|
2077
|
+
interface ReceiptSentReceiptInfoOneOf {
|
|
1903
2078
|
/** Receipt created by Wix */
|
|
1904
2079
|
wixReceipt?: WixReceipt;
|
|
1905
2080
|
/** Receipt created by an external system. */
|
|
1906
2081
|
externalReceipt?: ExternalReceipt;
|
|
1907
2082
|
}
|
|
1908
|
-
|
|
2083
|
+
declare enum ActivityType {
|
|
1909
2084
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
1910
2085
|
ORDER_PLACED = "ORDER_PLACED",
|
|
1911
2086
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -1942,11 +2117,11 @@ export declare enum ActivityType {
|
|
|
1942
2117
|
/** @documentationMaturity preview */
|
|
1943
2118
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
1944
2119
|
}
|
|
1945
|
-
|
|
2120
|
+
declare enum AttributionSource {
|
|
1946
2121
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1947
2122
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
1948
2123
|
}
|
|
1949
|
-
|
|
2124
|
+
interface CreatedBy extends CreatedByStringOneOf {
|
|
1950
2125
|
/**
|
|
1951
2126
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1952
2127
|
* For example, via POS (point of service).
|
|
@@ -1970,7 +2145,7 @@ export interface CreatedBy extends CreatedByStringOneOf {
|
|
|
1970
2145
|
appId?: string;
|
|
1971
2146
|
}
|
|
1972
2147
|
/** @oneof */
|
|
1973
|
-
|
|
2148
|
+
interface CreatedByStringOneOf {
|
|
1974
2149
|
/**
|
|
1975
2150
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1976
2151
|
* For example, via POS (point of service).
|
|
@@ -1993,7 +2168,7 @@ export interface CreatedByStringOneOf {
|
|
|
1993
2168
|
*/
|
|
1994
2169
|
appId?: string;
|
|
1995
2170
|
}
|
|
1996
|
-
|
|
2171
|
+
interface ChannelInfo {
|
|
1997
2172
|
/** Sales channel that submitted the order. */
|
|
1998
2173
|
type?: ChannelType;
|
|
1999
2174
|
/**
|
|
@@ -2007,7 +2182,7 @@ export interface ChannelInfo {
|
|
|
2007
2182
|
*/
|
|
2008
2183
|
externalOrderUrl?: string | null;
|
|
2009
2184
|
}
|
|
2010
|
-
|
|
2185
|
+
declare enum ChannelType {
|
|
2011
2186
|
/** Unspecified sales channel. This value is not supported. */
|
|
2012
2187
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2013
2188
|
/** A web client. */
|
|
@@ -2041,7 +2216,7 @@ export declare enum ChannelType {
|
|
|
2041
2216
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2042
2217
|
FAIRE_COM = "FAIRE_COM"
|
|
2043
2218
|
}
|
|
2044
|
-
|
|
2219
|
+
interface CustomField {
|
|
2045
2220
|
/** Custom field value. */
|
|
2046
2221
|
value?: any;
|
|
2047
2222
|
/**
|
|
@@ -2057,7 +2232,7 @@ export interface CustomField {
|
|
|
2057
2232
|
*/
|
|
2058
2233
|
translatedTitle?: string | null;
|
|
2059
2234
|
}
|
|
2060
|
-
|
|
2235
|
+
interface BalanceSummary {
|
|
2061
2236
|
/**
|
|
2062
2237
|
* Current amount left to pay.
|
|
2063
2238
|
* @readonly
|
|
@@ -2080,6 +2255,12 @@ export interface BalanceSummary {
|
|
|
2080
2255
|
* @readonly
|
|
2081
2256
|
*/
|
|
2082
2257
|
authorized?: Price;
|
|
2258
|
+
/**
|
|
2259
|
+
* Sum of all pending refund transactions.
|
|
2260
|
+
* @internal
|
|
2261
|
+
* @readonly
|
|
2262
|
+
*/
|
|
2263
|
+
pendingRefund?: Price;
|
|
2083
2264
|
/**
|
|
2084
2265
|
* Sum of all pending transactions.
|
|
2085
2266
|
* @readonly
|
|
@@ -2093,7 +2274,7 @@ export interface BalanceSummary {
|
|
|
2093
2274
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
2094
2275
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
2095
2276
|
*/
|
|
2096
|
-
|
|
2277
|
+
interface Balance {
|
|
2097
2278
|
/**
|
|
2098
2279
|
* Balance amount.
|
|
2099
2280
|
*
|
|
@@ -2108,7 +2289,7 @@ export interface Balance {
|
|
|
2108
2289
|
*/
|
|
2109
2290
|
formattedAmount?: string;
|
|
2110
2291
|
}
|
|
2111
|
-
|
|
2292
|
+
interface AdditionalFee {
|
|
2112
2293
|
/**
|
|
2113
2294
|
* Additional fee's unique code for future processing.
|
|
2114
2295
|
* @minLength 1
|
|
@@ -2146,8 +2327,16 @@ export interface AdditionalFee {
|
|
|
2146
2327
|
* @format GUID
|
|
2147
2328
|
*/
|
|
2148
2329
|
lineItemIds?: string[];
|
|
2330
|
+
/**
|
|
2331
|
+
* Number of subscription billing cycles the additional fee applies to.
|
|
2332
|
+
* If None and additional fee is linked to subscription line item, it applies to all cycles.
|
|
2333
|
+
* @internal
|
|
2334
|
+
* @min 1
|
|
2335
|
+
* @max 999
|
|
2336
|
+
*/
|
|
2337
|
+
subscriptionCycles?: number | null;
|
|
2149
2338
|
}
|
|
2150
|
-
|
|
2339
|
+
interface FulfillmentStatusesAggregate {
|
|
2151
2340
|
/** Unique string values based on Fulfillment entities statuses */
|
|
2152
2341
|
statuses?: string[] | null;
|
|
2153
2342
|
}
|
|
@@ -2173,13 +2362,13 @@ export interface FulfillmentStatusesAggregate {
|
|
|
2173
2362
|
* }
|
|
2174
2363
|
* }
|
|
2175
2364
|
*/
|
|
2176
|
-
|
|
2365
|
+
interface Tags {
|
|
2177
2366
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
2178
2367
|
privateTags?: TagList;
|
|
2179
2368
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
2180
2369
|
tags?: TagList;
|
|
2181
2370
|
}
|
|
2182
|
-
|
|
2371
|
+
interface TagList {
|
|
2183
2372
|
/**
|
|
2184
2373
|
* List of tag IDs
|
|
2185
2374
|
* @maxSize 100
|
|
@@ -2187,7 +2376,7 @@ export interface TagList {
|
|
|
2187
2376
|
*/
|
|
2188
2377
|
tagIds?: string[];
|
|
2189
2378
|
}
|
|
2190
|
-
|
|
2379
|
+
interface Location {
|
|
2191
2380
|
/**
|
|
2192
2381
|
* Location ID.
|
|
2193
2382
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
@@ -2203,29 +2392,29 @@ export interface Location {
|
|
|
2203
2392
|
name?: string;
|
|
2204
2393
|
}
|
|
2205
2394
|
/** Triggered when the order status changes to approved */
|
|
2206
|
-
|
|
2395
|
+
interface OrderApproved {
|
|
2207
2396
|
/** The order that was updated */
|
|
2208
2397
|
order?: Order;
|
|
2209
2398
|
}
|
|
2210
|
-
|
|
2399
|
+
interface OrdersExperiments {
|
|
2211
2400
|
epCommitTax?: boolean;
|
|
2212
2401
|
moveMerchantEmailToEp?: boolean;
|
|
2213
2402
|
moveBuyerOrderConfirmationEmailToEp?: boolean;
|
|
2214
2403
|
producedByEpBridge?: boolean;
|
|
2215
2404
|
enableRewrittenSideEffects?: boolean;
|
|
2216
2405
|
}
|
|
2217
|
-
|
|
2406
|
+
interface OrderRejectedEventOrderRejected {
|
|
2218
2407
|
/** The order that was rejected */
|
|
2219
2408
|
order?: Order;
|
|
2220
2409
|
}
|
|
2221
2410
|
/** Triggered when order items are marked as restocked */
|
|
2222
|
-
|
|
2411
|
+
interface OrderItemsRestocked {
|
|
2223
2412
|
/** The order which items were restocked */
|
|
2224
2413
|
order?: Order;
|
|
2225
2414
|
/** Restocked items and quantities */
|
|
2226
2415
|
restockItems?: V1RestockItem[];
|
|
2227
2416
|
}
|
|
2228
|
-
|
|
2417
|
+
interface V1RestockItem {
|
|
2229
2418
|
/**
|
|
2230
2419
|
* ID of the line item being restocked.
|
|
2231
2420
|
* @format GUID
|
|
@@ -2238,7 +2427,7 @@ export interface V1RestockItem {
|
|
|
2238
2427
|
*/
|
|
2239
2428
|
quantity?: number;
|
|
2240
2429
|
}
|
|
2241
|
-
|
|
2430
|
+
interface PreparePaymentCollectionRequest {
|
|
2242
2431
|
/**
|
|
2243
2432
|
* Ecom order ID.
|
|
2244
2433
|
* @minLength 1
|
|
@@ -2262,10 +2451,21 @@ export interface PreparePaymentCollectionRequest {
|
|
|
2262
2451
|
* @targetRemovalDate 2024-09-30
|
|
2263
2452
|
*/
|
|
2264
2453
|
delayedCapture?: boolean;
|
|
2454
|
+
/**
|
|
2455
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
2456
|
+
* Default: `true`
|
|
2457
|
+
* @internal
|
|
2458
|
+
*/
|
|
2459
|
+
merchantInitiated?: boolean | null;
|
|
2460
|
+
/**
|
|
2461
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
2462
|
+
* @internal
|
|
2463
|
+
*/
|
|
2464
|
+
redirectUrls?: RedirectUrls;
|
|
2265
2465
|
/** Delayed capture payment settings */
|
|
2266
2466
|
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
2267
2467
|
}
|
|
2268
|
-
|
|
2468
|
+
interface RedirectUrls {
|
|
2269
2469
|
/**
|
|
2270
2470
|
* URL to redirect buyer in case of approved (successful) transaction
|
|
2271
2471
|
* @format WEB_URL
|
|
@@ -2287,20 +2487,20 @@ export interface RedirectUrls {
|
|
|
2287
2487
|
*/
|
|
2288
2488
|
pendingUrl?: string | null;
|
|
2289
2489
|
}
|
|
2290
|
-
|
|
2490
|
+
interface DelayedCaptureSettings {
|
|
2291
2491
|
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
2292
2492
|
scheduledAction?: ScheduledAction;
|
|
2293
2493
|
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2294
2494
|
delayDuration?: Duration;
|
|
2295
2495
|
}
|
|
2296
|
-
|
|
2496
|
+
declare enum ScheduledAction {
|
|
2297
2497
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2298
2498
|
/** Whether payment will be auto-voided when duration passes */
|
|
2299
2499
|
VOID = "VOID",
|
|
2300
2500
|
/** Whether payment will be auto-captured when duration passes */
|
|
2301
2501
|
CAPTURE = "CAPTURE"
|
|
2302
2502
|
}
|
|
2303
|
-
|
|
2503
|
+
interface Duration {
|
|
2304
2504
|
/**
|
|
2305
2505
|
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
2306
2506
|
* @min 1
|
|
@@ -2309,17 +2509,17 @@ export interface Duration {
|
|
|
2309
2509
|
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
2310
2510
|
unit?: DurationUnit;
|
|
2311
2511
|
}
|
|
2312
|
-
|
|
2512
|
+
declare enum DurationUnit {
|
|
2313
2513
|
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
2314
2514
|
MINUTES = "MINUTES",
|
|
2315
2515
|
HOURS = "HOURS",
|
|
2316
2516
|
DAYS = "DAYS"
|
|
2317
2517
|
}
|
|
2318
|
-
|
|
2518
|
+
interface PreparePaymentCollectionResponse {
|
|
2319
2519
|
/** Payment gateway order id which is associated with given payment */
|
|
2320
2520
|
paymentGatewayOrderId?: string;
|
|
2321
2521
|
}
|
|
2322
|
-
|
|
2522
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
2323
2523
|
/**
|
|
2324
2524
|
* Ecom order ID.
|
|
2325
2525
|
* @minLength 1
|
|
@@ -2327,13 +2527,13 @@ export interface GetPaymentCollectabilityStatusRequest {
|
|
|
2327
2527
|
*/
|
|
2328
2528
|
ecomOrderId: string;
|
|
2329
2529
|
}
|
|
2330
|
-
|
|
2530
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
2331
2531
|
/** Payment collectability status */
|
|
2332
2532
|
status?: PaymentCollectabilityStatus;
|
|
2333
2533
|
/** Collectable order amount */
|
|
2334
2534
|
amount?: Price;
|
|
2335
2535
|
}
|
|
2336
|
-
|
|
2536
|
+
declare enum PaymentCollectabilityStatus {
|
|
2337
2537
|
UNKNOWN = "UNKNOWN",
|
|
2338
2538
|
COLLECTABLE = "COLLECTABLE",
|
|
2339
2539
|
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
@@ -2343,7 +2543,7 @@ export declare enum PaymentCollectabilityStatus {
|
|
|
2343
2543
|
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
2344
2544
|
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2345
2545
|
}
|
|
2346
|
-
|
|
2546
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
2347
2547
|
/**
|
|
2348
2548
|
* Order ID.
|
|
2349
2549
|
* @minLength 1
|
|
@@ -2353,9 +2553,9 @@ export interface RecordManuallyCollectedPaymentRequest {
|
|
|
2353
2553
|
/** Amount to be recorded as approved manual payment for given order */
|
|
2354
2554
|
amount: Price;
|
|
2355
2555
|
}
|
|
2356
|
-
|
|
2556
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
2357
2557
|
}
|
|
2358
|
-
|
|
2558
|
+
interface MarkOrderAsPaidRequest {
|
|
2359
2559
|
/**
|
|
2360
2560
|
* Ecom order ID.
|
|
2361
2561
|
* @minLength 1
|
|
@@ -2363,18 +2563,18 @@ export interface MarkOrderAsPaidRequest {
|
|
|
2363
2563
|
*/
|
|
2364
2564
|
ecomOrderId: string;
|
|
2365
2565
|
}
|
|
2366
|
-
|
|
2566
|
+
interface MarkOrderAsPaidResponse {
|
|
2367
2567
|
/** Updated order. */
|
|
2368
2568
|
order?: Order;
|
|
2369
2569
|
}
|
|
2370
2570
|
/** Triggered when the payment status of an order is updated */
|
|
2371
|
-
|
|
2571
|
+
interface PaymentStatusUpdated {
|
|
2372
2572
|
/** The order that was updated */
|
|
2373
2573
|
order?: Order;
|
|
2374
2574
|
/** The previous status (before the update) */
|
|
2375
2575
|
previousPaymentStatus?: PaymentStatus;
|
|
2376
2576
|
}
|
|
2377
|
-
|
|
2577
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
2378
2578
|
/**
|
|
2379
2579
|
* IDs of orders to mark as paid.
|
|
2380
2580
|
* @minSize 1
|
|
@@ -2384,7 +2584,7 @@ export interface BulkMarkOrdersAsPaidRequest {
|
|
|
2384
2584
|
*/
|
|
2385
2585
|
ecomOrderIds: string[];
|
|
2386
2586
|
}
|
|
2387
|
-
|
|
2587
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
2388
2588
|
/**
|
|
2389
2589
|
* Items updated by the bulk action.
|
|
2390
2590
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -2393,7 +2593,7 @@ export interface BulkMarkOrdersAsPaidResponse {
|
|
|
2393
2593
|
/** Bulk action metadata. */
|
|
2394
2594
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2395
2595
|
}
|
|
2396
|
-
|
|
2596
|
+
interface BulkOrderResult {
|
|
2397
2597
|
/** Item metadata. */
|
|
2398
2598
|
itemMetadata?: ItemMetadata;
|
|
2399
2599
|
/**
|
|
@@ -2403,7 +2603,7 @@ export interface BulkOrderResult {
|
|
|
2403
2603
|
*/
|
|
2404
2604
|
item?: Order;
|
|
2405
2605
|
}
|
|
2406
|
-
|
|
2606
|
+
interface ItemMetadata {
|
|
2407
2607
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2408
2608
|
_id?: string | null;
|
|
2409
2609
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -2413,7 +2613,7 @@ export interface ItemMetadata {
|
|
|
2413
2613
|
/** Details about the error in case of failure. */
|
|
2414
2614
|
error?: ApplicationError;
|
|
2415
2615
|
}
|
|
2416
|
-
|
|
2616
|
+
interface ApplicationError {
|
|
2417
2617
|
/** Error code. */
|
|
2418
2618
|
code?: string;
|
|
2419
2619
|
/** Description of the error. */
|
|
@@ -2421,7 +2621,7 @@ export interface ApplicationError {
|
|
|
2421
2621
|
/** Data related to the error. */
|
|
2422
2622
|
data?: Record<string, any> | null;
|
|
2423
2623
|
}
|
|
2424
|
-
|
|
2624
|
+
interface BulkActionMetadata {
|
|
2425
2625
|
/** Number of items that were successfully processed. */
|
|
2426
2626
|
totalSuccesses?: number;
|
|
2427
2627
|
/** Number of items that couldn't be processed. */
|
|
@@ -2429,7 +2629,7 @@ export interface BulkActionMetadata {
|
|
|
2429
2629
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2430
2630
|
undetailedFailures?: number;
|
|
2431
2631
|
}
|
|
2432
|
-
|
|
2632
|
+
interface GetRefundabilityStatusRequest {
|
|
2433
2633
|
/**
|
|
2434
2634
|
* Order ID.
|
|
2435
2635
|
* @minLength 1
|
|
@@ -2437,7 +2637,7 @@ export interface GetRefundabilityStatusRequest {
|
|
|
2437
2637
|
*/
|
|
2438
2638
|
ecomOrderId: string;
|
|
2439
2639
|
}
|
|
2440
|
-
|
|
2640
|
+
interface GetRefundabilityStatusResponse {
|
|
2441
2641
|
/**
|
|
2442
2642
|
* Refundability details.
|
|
2443
2643
|
* @maxSize 300
|
|
@@ -2449,7 +2649,7 @@ export interface GetRefundabilityStatusResponse {
|
|
|
2449
2649
|
*/
|
|
2450
2650
|
refundablePerItem?: boolean;
|
|
2451
2651
|
}
|
|
2452
|
-
|
|
2652
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2453
2653
|
/** Reason why payment is not refundable. */
|
|
2454
2654
|
nonRefundableReason?: NonRefundableReason;
|
|
2455
2655
|
/** Reason why payment is only refundable manually. */
|
|
@@ -2462,18 +2662,18 @@ export interface Refundability extends RefundabilityAdditionalRefundabilityInfoO
|
|
|
2462
2662
|
providerLink?: string | null;
|
|
2463
2663
|
}
|
|
2464
2664
|
/** @oneof */
|
|
2465
|
-
|
|
2665
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2466
2666
|
/** Reason why payment is not refundable. */
|
|
2467
2667
|
nonRefundableReason?: NonRefundableReason;
|
|
2468
2668
|
/** Reason why payment is only refundable manually. */
|
|
2469
2669
|
manuallyRefundableReason?: ManuallyRefundableReason;
|
|
2470
2670
|
}
|
|
2471
|
-
|
|
2671
|
+
declare enum RefundableStatus {
|
|
2472
2672
|
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2473
2673
|
MANUAL = "MANUAL",
|
|
2474
2674
|
REFUNDABLE = "REFUNDABLE"
|
|
2475
2675
|
}
|
|
2476
|
-
|
|
2676
|
+
declare enum NonRefundableReason {
|
|
2477
2677
|
NONE = "NONE",
|
|
2478
2678
|
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
2479
2679
|
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
@@ -2488,13 +2688,13 @@ export declare enum NonRefundableReason {
|
|
|
2488
2688
|
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
2489
2689
|
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
2490
2690
|
}
|
|
2491
|
-
|
|
2691
|
+
declare enum ManuallyRefundableReason {
|
|
2492
2692
|
EXPIRED = "EXPIRED",
|
|
2493
2693
|
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
2494
2694
|
OFFLINE = "OFFLINE",
|
|
2495
2695
|
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2496
2696
|
}
|
|
2497
|
-
|
|
2697
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
2498
2698
|
/**
|
|
2499
2699
|
* Ecom order ID.
|
|
2500
2700
|
* @minLength 1
|
|
@@ -2504,7 +2704,7 @@ export interface CreatePaymentGatewayOrderRequest {
|
|
|
2504
2704
|
/** Information about the user who initiated the payment. */
|
|
2505
2705
|
chargedBy?: ChargedBy;
|
|
2506
2706
|
}
|
|
2507
|
-
|
|
2707
|
+
interface ChargedBy {
|
|
2508
2708
|
/**
|
|
2509
2709
|
* ID - id of the user who initiated the payment
|
|
2510
2710
|
* @format GUID
|
|
@@ -2517,11 +2717,11 @@ export interface ChargedBy {
|
|
|
2517
2717
|
*/
|
|
2518
2718
|
fullName?: string | null;
|
|
2519
2719
|
}
|
|
2520
|
-
|
|
2720
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
2521
2721
|
/** ID of the order created in the payment gateway */
|
|
2522
2722
|
paymentGatewayOrderId?: string;
|
|
2523
2723
|
}
|
|
2524
|
-
|
|
2724
|
+
interface ChargeMembershipsRequest {
|
|
2525
2725
|
/**
|
|
2526
2726
|
* Order ID.
|
|
2527
2727
|
* @minLength 1
|
|
@@ -2541,7 +2741,7 @@ export interface ChargeMembershipsRequest {
|
|
|
2541
2741
|
*/
|
|
2542
2742
|
membershipCharges?: MembershipChargeItem[];
|
|
2543
2743
|
}
|
|
2544
|
-
|
|
2744
|
+
interface MembershipChargeItem {
|
|
2545
2745
|
/**
|
|
2546
2746
|
* The id of used membership
|
|
2547
2747
|
* @minLength 1
|
|
@@ -2576,7 +2776,7 @@ export interface MembershipChargeItem {
|
|
|
2576
2776
|
*/
|
|
2577
2777
|
lineItemId?: string;
|
|
2578
2778
|
}
|
|
2579
|
-
|
|
2779
|
+
interface MembershipName {
|
|
2580
2780
|
/**
|
|
2581
2781
|
* Membership name.
|
|
2582
2782
|
* @maxLength 100
|
|
@@ -2588,7 +2788,7 @@ export interface MembershipName {
|
|
|
2588
2788
|
*/
|
|
2589
2789
|
translated?: string | null;
|
|
2590
2790
|
}
|
|
2591
|
-
|
|
2791
|
+
interface ServiceProperties {
|
|
2592
2792
|
/**
|
|
2593
2793
|
* 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.
|
|
2594
2794
|
* For example, the start time of a class.
|
|
@@ -2601,9 +2801,9 @@ export interface ServiceProperties {
|
|
|
2601
2801
|
*/
|
|
2602
2802
|
numberOfParticipants?: number | null;
|
|
2603
2803
|
}
|
|
2604
|
-
|
|
2804
|
+
interface ChargeMembershipsResponse {
|
|
2605
2805
|
}
|
|
2606
|
-
|
|
2806
|
+
interface TriggerRefundRequest {
|
|
2607
2807
|
/**
|
|
2608
2808
|
* The order this refund related to
|
|
2609
2809
|
* @minLength 1
|
|
@@ -2621,7 +2821,7 @@ export interface TriggerRefundRequest {
|
|
|
2621
2821
|
/** Side effect details related to refund */
|
|
2622
2822
|
sideEffects?: RefundSideEffects;
|
|
2623
2823
|
}
|
|
2624
|
-
|
|
2824
|
+
interface PaymentRefund {
|
|
2625
2825
|
/**
|
|
2626
2826
|
* Specific payment within the order to refund
|
|
2627
2827
|
* @format GUID
|
|
@@ -2637,7 +2837,7 @@ export interface PaymentRefund {
|
|
|
2637
2837
|
externalRefund?: boolean;
|
|
2638
2838
|
}
|
|
2639
2839
|
/** Business model of a refund request */
|
|
2640
|
-
|
|
2840
|
+
interface RefundDetails {
|
|
2641
2841
|
/**
|
|
2642
2842
|
* Order line item IDs and quantities that were refunded.
|
|
2643
2843
|
* @maxSize 300
|
|
@@ -2663,7 +2863,7 @@ export interface RefundDetails {
|
|
|
2663
2863
|
/** Shipping amount that was refunded. */
|
|
2664
2864
|
shipping?: ShippingRefund;
|
|
2665
2865
|
}
|
|
2666
|
-
|
|
2866
|
+
interface RefundItem {
|
|
2667
2867
|
/**
|
|
2668
2868
|
* Line item ID the refunded line item.
|
|
2669
2869
|
* @format GUID
|
|
@@ -2676,7 +2876,7 @@ export interface RefundItem {
|
|
|
2676
2876
|
*/
|
|
2677
2877
|
quantity?: number;
|
|
2678
2878
|
}
|
|
2679
|
-
|
|
2879
|
+
interface LineItemRefund {
|
|
2680
2880
|
/**
|
|
2681
2881
|
* Line item ID.
|
|
2682
2882
|
* @format GUID
|
|
@@ -2691,7 +2891,7 @@ export interface LineItemRefund {
|
|
|
2691
2891
|
*/
|
|
2692
2892
|
quantity?: number;
|
|
2693
2893
|
}
|
|
2694
|
-
|
|
2894
|
+
interface AdditionalFeeRefund {
|
|
2695
2895
|
/**
|
|
2696
2896
|
* Additional fee ID.
|
|
2697
2897
|
* @format GUID
|
|
@@ -2704,14 +2904,14 @@ export interface AdditionalFeeRefund {
|
|
|
2704
2904
|
*/
|
|
2705
2905
|
amount?: Price;
|
|
2706
2906
|
}
|
|
2707
|
-
|
|
2907
|
+
interface ShippingRefund {
|
|
2708
2908
|
/**
|
|
2709
2909
|
* Refund amount.
|
|
2710
2910
|
* @immutable
|
|
2711
2911
|
*/
|
|
2712
2912
|
amount?: Price;
|
|
2713
2913
|
}
|
|
2714
|
-
|
|
2914
|
+
interface RefundSideEffects {
|
|
2715
2915
|
/** Inventory restock details as part of this refund. */
|
|
2716
2916
|
restockInfo?: RestockInfo;
|
|
2717
2917
|
/** Whether to send a refund confirmation email to the customer. */
|
|
@@ -2723,7 +2923,7 @@ export interface RefundSideEffects {
|
|
|
2723
2923
|
*/
|
|
2724
2924
|
customMessage?: string | null;
|
|
2725
2925
|
}
|
|
2726
|
-
|
|
2926
|
+
interface RestockInfo {
|
|
2727
2927
|
/** Restock type. */
|
|
2728
2928
|
type?: RestockType;
|
|
2729
2929
|
/**
|
|
@@ -2732,12 +2932,12 @@ export interface RestockInfo {
|
|
|
2732
2932
|
*/
|
|
2733
2933
|
items?: RestockItem[];
|
|
2734
2934
|
}
|
|
2735
|
-
|
|
2935
|
+
declare enum RestockType {
|
|
2736
2936
|
NO_ITEMS = "NO_ITEMS",
|
|
2737
2937
|
ALL_ITEMS = "ALL_ITEMS",
|
|
2738
2938
|
SOME_ITEMS = "SOME_ITEMS"
|
|
2739
2939
|
}
|
|
2740
|
-
|
|
2940
|
+
interface RestockItem {
|
|
2741
2941
|
/**
|
|
2742
2942
|
* ID of the line item being restocked.
|
|
2743
2943
|
* @format GUID
|
|
@@ -2750,7 +2950,7 @@ export interface RestockItem {
|
|
|
2750
2950
|
*/
|
|
2751
2951
|
quantity?: number;
|
|
2752
2952
|
}
|
|
2753
|
-
|
|
2953
|
+
interface TriggerRefundResponse {
|
|
2754
2954
|
/** All order's transactions after the refunds were added */
|
|
2755
2955
|
orderTransactions?: OrderTransactions;
|
|
2756
2956
|
/** Created refund ID */
|
|
@@ -2758,7 +2958,7 @@ export interface TriggerRefundResponse {
|
|
|
2758
2958
|
/** Payment ID's that the refund execution had failed for */
|
|
2759
2959
|
failedPaymentIds?: ItemMetadata[];
|
|
2760
2960
|
}
|
|
2761
|
-
|
|
2961
|
+
interface OrderTransactions {
|
|
2762
2962
|
/**
|
|
2763
2963
|
* Order ID.
|
|
2764
2964
|
* @format GUID
|
|
@@ -2775,11 +2975,21 @@ export interface OrderTransactions {
|
|
|
2775
2975
|
*/
|
|
2776
2976
|
refunds?: Refund[];
|
|
2777
2977
|
}
|
|
2778
|
-
|
|
2978
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
2779
2979
|
/** Regular payment details. */
|
|
2780
2980
|
regularPaymentDetails?: RegularPaymentDetails;
|
|
2781
2981
|
/** Gift card payment details. */
|
|
2782
2982
|
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2983
|
+
/**
|
|
2984
|
+
* Receipt created by Wix
|
|
2985
|
+
* @internal
|
|
2986
|
+
*/
|
|
2987
|
+
wixReceipt?: WixReceiptInfo;
|
|
2988
|
+
/**
|
|
2989
|
+
* Receipt created by an external system.
|
|
2990
|
+
* @internal
|
|
2991
|
+
*/
|
|
2992
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
2783
2993
|
/**
|
|
2784
2994
|
* Payment ID.
|
|
2785
2995
|
* @format GUID
|
|
@@ -2801,18 +3011,36 @@ export interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoO
|
|
|
2801
3011
|
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
2802
3012
|
*/
|
|
2803
3013
|
refundDisabled?: boolean;
|
|
3014
|
+
/**
|
|
3015
|
+
* Whether receipt generation for this payment are allowed.
|
|
3016
|
+
* + `true`: This payment supports receipt generation.
|
|
3017
|
+
* + `false`: This payment not supports receipt generation, or receipt already generated
|
|
3018
|
+
* @internal
|
|
3019
|
+
* @readonly
|
|
3020
|
+
*/
|
|
3021
|
+
supportReceiptGeneration?: boolean;
|
|
2804
3022
|
}
|
|
2805
3023
|
/** @oneof */
|
|
2806
|
-
|
|
3024
|
+
interface PaymentPaymentDetailsOneOf {
|
|
2807
3025
|
/** Regular payment details. */
|
|
2808
3026
|
regularPaymentDetails?: RegularPaymentDetails;
|
|
2809
3027
|
/** Gift card payment details. */
|
|
2810
3028
|
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2811
3029
|
}
|
|
2812
3030
|
/** @oneof */
|
|
2813
|
-
|
|
3031
|
+
interface PaymentReceiptInfoOneOf {
|
|
3032
|
+
/**
|
|
3033
|
+
* Receipt created by Wix
|
|
3034
|
+
* @internal
|
|
3035
|
+
*/
|
|
3036
|
+
wixReceipt?: WixReceiptInfo;
|
|
3037
|
+
/**
|
|
3038
|
+
* Receipt created by an external system.
|
|
3039
|
+
* @internal
|
|
3040
|
+
*/
|
|
3041
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
2814
3042
|
}
|
|
2815
|
-
|
|
3043
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2816
3044
|
/** Whether regular card used */
|
|
2817
3045
|
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2818
3046
|
/**
|
|
@@ -2848,13 +3076,19 @@ export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMetho
|
|
|
2848
3076
|
savedPaymentMethod?: boolean;
|
|
2849
3077
|
/** Authorization details. */
|
|
2850
3078
|
authorizationDetails?: AuthorizationDetails;
|
|
3079
|
+
/**
|
|
3080
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
3081
|
+
* @internal
|
|
3082
|
+
* @maxLength 300
|
|
3083
|
+
*/
|
|
3084
|
+
paymentProvider?: string | null;
|
|
2851
3085
|
}
|
|
2852
3086
|
/** @oneof */
|
|
2853
|
-
|
|
3087
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2854
3088
|
/** Whether regular card used */
|
|
2855
3089
|
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2856
3090
|
}
|
|
2857
|
-
|
|
3091
|
+
declare enum TransactionStatus {
|
|
2858
3092
|
UNDEFINED = "UNDEFINED",
|
|
2859
3093
|
APPROVED = "APPROVED",
|
|
2860
3094
|
PENDING = "PENDING",
|
|
@@ -2866,7 +3100,7 @@ export declare enum TransactionStatus {
|
|
|
2866
3100
|
AUTHORIZED = "AUTHORIZED",
|
|
2867
3101
|
VOIDED = "VOIDED"
|
|
2868
3102
|
}
|
|
2869
|
-
|
|
3103
|
+
interface CreditCardPaymentMethodDetails {
|
|
2870
3104
|
/**
|
|
2871
3105
|
* The last 4 digits of the card number.
|
|
2872
3106
|
* @maxLength 4
|
|
@@ -2878,7 +3112,7 @@ export interface CreditCardPaymentMethodDetails {
|
|
|
2878
3112
|
*/
|
|
2879
3113
|
brand?: string | null;
|
|
2880
3114
|
}
|
|
2881
|
-
|
|
3115
|
+
interface AuthorizationDetails {
|
|
2882
3116
|
/**
|
|
2883
3117
|
* Whether the authorized payment is of a delayed capture.
|
|
2884
3118
|
* @readonly
|
|
@@ -2897,7 +3131,7 @@ export interface AuthorizationDetails {
|
|
|
2897
3131
|
/** Scheduled action for this transaction */
|
|
2898
3132
|
scheduledAction?: V1ScheduledAction;
|
|
2899
3133
|
}
|
|
2900
|
-
|
|
3134
|
+
interface AuthorizationCapture {
|
|
2901
3135
|
/**
|
|
2902
3136
|
* Capture ID.
|
|
2903
3137
|
* @format GUID
|
|
@@ -2916,7 +3150,7 @@ export interface AuthorizationCapture {
|
|
|
2916
3150
|
/** In case of status is FAILED may contain failure details */
|
|
2917
3151
|
failureDetails?: AuthorizationActionFailureDetails;
|
|
2918
3152
|
}
|
|
2919
|
-
|
|
3153
|
+
declare enum AuthorizationCaptureStatus {
|
|
2920
3154
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2921
3155
|
/** Capture operation still in progress. */
|
|
2922
3156
|
PENDING = "PENDING",
|
|
@@ -2925,11 +3159,11 @@ export declare enum AuthorizationCaptureStatus {
|
|
|
2925
3159
|
/** Capture operation failed. */
|
|
2926
3160
|
FAILED = "FAILED"
|
|
2927
3161
|
}
|
|
2928
|
-
|
|
3162
|
+
interface AuthorizationActionFailureDetails {
|
|
2929
3163
|
/** @maxLength 100 */
|
|
2930
3164
|
failureCode?: string;
|
|
2931
3165
|
}
|
|
2932
|
-
|
|
3166
|
+
interface AuthorizationVoid {
|
|
2933
3167
|
/** Status of this void action */
|
|
2934
3168
|
status?: AuthorizationVoidStatus;
|
|
2935
3169
|
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
@@ -2939,7 +3173,7 @@ export interface AuthorizationVoid {
|
|
|
2939
3173
|
/** Reason of void action */
|
|
2940
3174
|
reason?: Reason;
|
|
2941
3175
|
}
|
|
2942
|
-
|
|
3176
|
+
declare enum AuthorizationVoidStatus {
|
|
2943
3177
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2944
3178
|
/** Void operation still in progress. */
|
|
2945
3179
|
PENDING = "PENDING",
|
|
@@ -2949,25 +3183,25 @@ export declare enum AuthorizationVoidStatus {
|
|
|
2949
3183
|
FAILED = "FAILED"
|
|
2950
3184
|
}
|
|
2951
3185
|
/** Reason the authorization was voided. */
|
|
2952
|
-
|
|
3186
|
+
declare enum Reason {
|
|
2953
3187
|
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
2954
3188
|
/** Authorization was voided by user. */
|
|
2955
3189
|
MANUAL = "MANUAL",
|
|
2956
3190
|
/** Authorization passed execution date. */
|
|
2957
3191
|
SCHEDULED = "SCHEDULED"
|
|
2958
3192
|
}
|
|
2959
|
-
|
|
3193
|
+
interface V1ScheduledAction {
|
|
2960
3194
|
/** Type of the action. */
|
|
2961
3195
|
actionType?: ActionType;
|
|
2962
3196
|
/** The date and time of the action. */
|
|
2963
3197
|
executionDate?: Date | null;
|
|
2964
3198
|
}
|
|
2965
|
-
|
|
3199
|
+
declare enum ActionType {
|
|
2966
3200
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
2967
3201
|
VOID = "VOID",
|
|
2968
3202
|
CAPTURE = "CAPTURE"
|
|
2969
3203
|
}
|
|
2970
|
-
|
|
3204
|
+
interface GiftCardPaymentDetails {
|
|
2971
3205
|
/**
|
|
2972
3206
|
* Gift card payment ID.
|
|
2973
3207
|
* @minLength 1
|
|
@@ -2984,8 +3218,15 @@ export interface GiftCardPaymentDetails {
|
|
|
2984
3218
|
* @readonly
|
|
2985
3219
|
*/
|
|
2986
3220
|
voided?: boolean;
|
|
3221
|
+
/**
|
|
3222
|
+
* Gift card obfuscated code.
|
|
3223
|
+
* @internal
|
|
3224
|
+
* @maxLength 30
|
|
3225
|
+
* @immutable
|
|
3226
|
+
*/
|
|
3227
|
+
obfuscatedCode?: string | null;
|
|
2987
3228
|
}
|
|
2988
|
-
|
|
3229
|
+
interface MembershipPaymentDetails {
|
|
2989
3230
|
/**
|
|
2990
3231
|
* Membership ID.
|
|
2991
3232
|
* @minLength 1
|
|
@@ -3019,13 +3260,13 @@ export interface MembershipPaymentDetails {
|
|
|
3019
3260
|
*/
|
|
3020
3261
|
providerAppId?: string;
|
|
3021
3262
|
}
|
|
3022
|
-
|
|
3263
|
+
declare enum MembershipPaymentStatus {
|
|
3023
3264
|
/** Payment was charged. */
|
|
3024
3265
|
CHARGED = "CHARGED",
|
|
3025
3266
|
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3026
3267
|
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3027
3268
|
}
|
|
3028
|
-
|
|
3269
|
+
interface WixReceiptInfo {
|
|
3029
3270
|
/**
|
|
3030
3271
|
* Receipt ID
|
|
3031
3272
|
* @format GUID
|
|
@@ -3038,7 +3279,7 @@ export interface WixReceiptInfo {
|
|
|
3038
3279
|
*/
|
|
3039
3280
|
displayNumber?: string | null;
|
|
3040
3281
|
}
|
|
3041
|
-
|
|
3282
|
+
interface ExternalReceiptInfo {
|
|
3042
3283
|
/**
|
|
3043
3284
|
* External receipt ID
|
|
3044
3285
|
* @maxLength 100
|
|
@@ -3056,7 +3297,7 @@ export interface ExternalReceiptInfo {
|
|
|
3056
3297
|
*/
|
|
3057
3298
|
displayNumber?: string | null;
|
|
3058
3299
|
}
|
|
3059
|
-
|
|
3300
|
+
interface Refund {
|
|
3060
3301
|
/**
|
|
3061
3302
|
* Refund ID.
|
|
3062
3303
|
* @format GUID
|
|
@@ -3089,7 +3330,7 @@ export interface Refund {
|
|
|
3089
3330
|
*/
|
|
3090
3331
|
requestingServiceAppId?: string | null;
|
|
3091
3332
|
}
|
|
3092
|
-
|
|
3333
|
+
interface RefundTransaction {
|
|
3093
3334
|
/**
|
|
3094
3335
|
* ID of the payment associated with this refund.
|
|
3095
3336
|
* @format GUID
|
|
@@ -3120,7 +3361,7 @@ export interface RefundTransaction {
|
|
|
3120
3361
|
externalRefund?: boolean;
|
|
3121
3362
|
}
|
|
3122
3363
|
/** Refund transaction status. */
|
|
3123
|
-
|
|
3364
|
+
declare enum RefundStatus {
|
|
3124
3365
|
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
3125
3366
|
PENDING = "PENDING",
|
|
3126
3367
|
/** Refund transaction succeeded. */
|
|
@@ -3132,7 +3373,7 @@ export declare enum RefundStatus {
|
|
|
3132
3373
|
/** Refund was initiated on payment provider side. */
|
|
3133
3374
|
STARTED = "STARTED"
|
|
3134
3375
|
}
|
|
3135
|
-
|
|
3376
|
+
interface RefundStatusInfo {
|
|
3136
3377
|
/**
|
|
3137
3378
|
* Reason code for the refund's current status.
|
|
3138
3379
|
*
|
|
@@ -3148,7 +3389,7 @@ export interface RefundStatusInfo {
|
|
|
3148
3389
|
*/
|
|
3149
3390
|
description?: string | null;
|
|
3150
3391
|
}
|
|
3151
|
-
|
|
3392
|
+
interface AggregatedRefundSummary {
|
|
3152
3393
|
/** Total amount requested for refund. */
|
|
3153
3394
|
requestedRefund?: Price;
|
|
3154
3395
|
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
@@ -3162,14 +3403,14 @@ export interface AggregatedRefundSummary {
|
|
|
3162
3403
|
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
3163
3404
|
breakdown?: RefundItemsBreakdown;
|
|
3164
3405
|
}
|
|
3165
|
-
|
|
3406
|
+
interface RefundItemsBreakdown {
|
|
3166
3407
|
/**
|
|
3167
3408
|
* Refunded line items and the amount refunded for each.
|
|
3168
3409
|
* @maxSize 300
|
|
3169
3410
|
*/
|
|
3170
3411
|
lineItems?: LineItemRefundSummary[];
|
|
3171
3412
|
}
|
|
3172
|
-
|
|
3413
|
+
interface LineItemRefundSummary {
|
|
3173
3414
|
/**
|
|
3174
3415
|
* ID of the refunded line item.
|
|
3175
3416
|
* @format GUID
|
|
@@ -3178,7 +3419,7 @@ export interface LineItemRefundSummary {
|
|
|
3178
3419
|
/** Total refunded amount for the line item. */
|
|
3179
3420
|
totalRefundedAmount?: Price;
|
|
3180
3421
|
}
|
|
3181
|
-
|
|
3422
|
+
interface CalculateRefundRequest {
|
|
3182
3423
|
/**
|
|
3183
3424
|
* Order ID
|
|
3184
3425
|
* @minLength 1
|
|
@@ -3193,7 +3434,7 @@ export interface CalculateRefundRequest {
|
|
|
3193
3434
|
/** Should include shipping in refund calculation */
|
|
3194
3435
|
refundShipping?: boolean;
|
|
3195
3436
|
}
|
|
3196
|
-
|
|
3437
|
+
interface CalculateRefundItemRequest {
|
|
3197
3438
|
/**
|
|
3198
3439
|
* ID of the line item being refunded
|
|
3199
3440
|
* @format GUID
|
|
@@ -3206,7 +3447,7 @@ export interface CalculateRefundItemRequest {
|
|
|
3206
3447
|
*/
|
|
3207
3448
|
quantity?: number;
|
|
3208
3449
|
}
|
|
3209
|
-
|
|
3450
|
+
interface CalculateRefundResponse {
|
|
3210
3451
|
/** Total refundable amount */
|
|
3211
3452
|
total?: Price;
|
|
3212
3453
|
/** Tax cost of the order */
|
|
@@ -3225,7 +3466,7 @@ export interface CalculateRefundResponse {
|
|
|
3225
3466
|
*/
|
|
3226
3467
|
items?: CalculateRefundItemResponse[];
|
|
3227
3468
|
}
|
|
3228
|
-
|
|
3469
|
+
interface CalculateRefundItemResponse {
|
|
3229
3470
|
/**
|
|
3230
3471
|
* Line item ID
|
|
3231
3472
|
* @format GUID
|
|
@@ -3234,7 +3475,7 @@ export interface CalculateRefundItemResponse {
|
|
|
3234
3475
|
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
3235
3476
|
price?: Price;
|
|
3236
3477
|
}
|
|
3237
|
-
|
|
3478
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
3238
3479
|
/**
|
|
3239
3480
|
* Wix eCommerce order ID
|
|
3240
3481
|
* @minLength 1
|
|
@@ -3249,11 +3490,11 @@ export interface VoidAuthorizedPaymentsRequest {
|
|
|
3249
3490
|
*/
|
|
3250
3491
|
paymentIds: string[];
|
|
3251
3492
|
}
|
|
3252
|
-
|
|
3493
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
3253
3494
|
/** All order's transactions after the void was triggered */
|
|
3254
3495
|
orderTransactions?: OrderTransactions;
|
|
3255
3496
|
}
|
|
3256
|
-
|
|
3497
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
3257
3498
|
/**
|
|
3258
3499
|
* Wix eCommerce order ID
|
|
3259
3500
|
* @minLength 1
|
|
@@ -3267,7 +3508,7 @@ export interface CaptureAuthorizedPaymentsRequest {
|
|
|
3267
3508
|
*/
|
|
3268
3509
|
payments: PaymentCapture[];
|
|
3269
3510
|
}
|
|
3270
|
-
|
|
3511
|
+
interface PaymentCapture {
|
|
3271
3512
|
/**
|
|
3272
3513
|
* Payment ID
|
|
3273
3514
|
* @format GUID
|
|
@@ -3279,11 +3520,11 @@ export interface PaymentCapture {
|
|
|
3279
3520
|
*/
|
|
3280
3521
|
amount?: Price;
|
|
3281
3522
|
}
|
|
3282
|
-
|
|
3523
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
3283
3524
|
/** All order's transactions after the capture was triggered */
|
|
3284
3525
|
orderTransactions?: OrderTransactions;
|
|
3285
3526
|
}
|
|
3286
|
-
|
|
3527
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
3287
3528
|
/**
|
|
3288
3529
|
* Ecom Order ID.
|
|
3289
3530
|
* @minLength 1
|
|
@@ -3293,11 +3534,11 @@ export interface ChargeSavedPaymentMethodRequest {
|
|
|
3293
3534
|
/** Amount to be charged */
|
|
3294
3535
|
amount?: Price;
|
|
3295
3536
|
}
|
|
3296
|
-
|
|
3537
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
3297
3538
|
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
3298
3539
|
paymentGatewayOrderId?: string;
|
|
3299
3540
|
}
|
|
3300
|
-
|
|
3541
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3301
3542
|
createdEvent?: EntityCreatedEvent;
|
|
3302
3543
|
updatedEvent?: EntityUpdatedEvent;
|
|
3303
3544
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3340,19 +3581,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3340
3581
|
entityEventSequence?: string | null;
|
|
3341
3582
|
}
|
|
3342
3583
|
/** @oneof */
|
|
3343
|
-
|
|
3584
|
+
interface DomainEventBodyOneOf {
|
|
3344
3585
|
createdEvent?: EntityCreatedEvent;
|
|
3345
3586
|
updatedEvent?: EntityUpdatedEvent;
|
|
3346
3587
|
deletedEvent?: EntityDeletedEvent;
|
|
3347
3588
|
actionEvent?: ActionEvent;
|
|
3348
3589
|
}
|
|
3349
|
-
|
|
3590
|
+
interface EntityCreatedEvent {
|
|
3350
3591
|
entity?: string;
|
|
3351
3592
|
}
|
|
3352
|
-
|
|
3593
|
+
interface RestoreInfo {
|
|
3353
3594
|
deletedDate?: Date | null;
|
|
3354
3595
|
}
|
|
3355
|
-
|
|
3596
|
+
interface EntityUpdatedEvent {
|
|
3356
3597
|
/**
|
|
3357
3598
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3358
3599
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -3360,16 +3601,16 @@ export interface EntityUpdatedEvent {
|
|
|
3360
3601
|
*/
|
|
3361
3602
|
currentEntity?: string;
|
|
3362
3603
|
}
|
|
3363
|
-
|
|
3604
|
+
interface EntityDeletedEvent {
|
|
3364
3605
|
/** Entity that was deleted */
|
|
3365
3606
|
deletedEntity?: string | null;
|
|
3366
3607
|
}
|
|
3367
|
-
|
|
3608
|
+
interface ActionEvent {
|
|
3368
3609
|
body?: string;
|
|
3369
3610
|
}
|
|
3370
|
-
|
|
3611
|
+
interface Empty {
|
|
3371
3612
|
}
|
|
3372
|
-
|
|
3613
|
+
interface MessageEnvelope {
|
|
3373
3614
|
/**
|
|
3374
3615
|
* App instance ID.
|
|
3375
3616
|
* @format GUID
|
|
@@ -3385,7 +3626,7 @@ export interface MessageEnvelope {
|
|
|
3385
3626
|
/** Stringify payload. */
|
|
3386
3627
|
data?: string;
|
|
3387
3628
|
}
|
|
3388
|
-
|
|
3629
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3389
3630
|
/**
|
|
3390
3631
|
* ID of a site visitor that has not logged in to the site.
|
|
3391
3632
|
* @format GUID
|
|
@@ -3410,7 +3651,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3410
3651
|
identityType?: WebhookIdentityType;
|
|
3411
3652
|
}
|
|
3412
3653
|
/** @oneof */
|
|
3413
|
-
|
|
3654
|
+
interface IdentificationDataIdOneOf {
|
|
3414
3655
|
/**
|
|
3415
3656
|
* ID of a site visitor that has not logged in to the site.
|
|
3416
3657
|
* @format GUID
|
|
@@ -3432,14 +3673,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
3432
3673
|
*/
|
|
3433
3674
|
appId?: string;
|
|
3434
3675
|
}
|
|
3435
|
-
|
|
3676
|
+
declare enum WebhookIdentityType {
|
|
3436
3677
|
UNKNOWN = "UNKNOWN",
|
|
3437
3678
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3438
3679
|
MEMBER = "MEMBER",
|
|
3439
3680
|
WIX_USER = "WIX_USER",
|
|
3440
3681
|
APP = "APP"
|
|
3441
3682
|
}
|
|
3442
|
-
|
|
3683
|
+
declare enum TextDetection {
|
|
3443
3684
|
/** No detection was made */
|
|
3444
3685
|
UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
|
|
3445
3686
|
/** The image contains text */
|
|
@@ -3447,7 +3688,7 @@ export declare enum TextDetection {
|
|
|
3447
3688
|
/** The image does not contain text */
|
|
3448
3689
|
NO_TEXT = "NO_TEXT"
|
|
3449
3690
|
}
|
|
3450
|
-
|
|
3691
|
+
declare enum AnimationDetection {
|
|
3451
3692
|
/** No detection was made */
|
|
3452
3693
|
UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
|
|
3453
3694
|
/** The image contains animation */
|
|
@@ -3455,37 +3696,37 @@ export declare enum AnimationDetection {
|
|
|
3455
3696
|
/** The image does not contain animation */
|
|
3456
3697
|
NO_ANIMATION = "NO_ANIMATION"
|
|
3457
3698
|
}
|
|
3458
|
-
|
|
3699
|
+
interface ImageContent {
|
|
3459
3700
|
/** Text detection */
|
|
3460
3701
|
text?: TextDetection;
|
|
3461
3702
|
/** Animation detection */
|
|
3462
3703
|
animation?: AnimationDetection;
|
|
3463
3704
|
}
|
|
3464
|
-
|
|
3705
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
3465
3706
|
/** @format GUID */
|
|
3466
3707
|
orderId?: string;
|
|
3467
3708
|
}
|
|
3468
|
-
|
|
3709
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
3469
3710
|
}
|
|
3470
|
-
|
|
3711
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3471
3712
|
/**
|
|
3472
3713
|
* @minLength 1
|
|
3473
3714
|
* @maxLength 100
|
|
3474
3715
|
*/
|
|
3475
3716
|
orderId?: string;
|
|
3476
3717
|
}
|
|
3477
|
-
|
|
3718
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
3478
3719
|
}
|
|
3479
|
-
|
|
3720
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
3480
3721
|
/**
|
|
3481
3722
|
* @minLength 1
|
|
3482
3723
|
* @maxLength 100
|
|
3483
3724
|
*/
|
|
3484
3725
|
orderId?: string;
|
|
3485
3726
|
}
|
|
3486
|
-
|
|
3727
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
3487
3728
|
}
|
|
3488
|
-
|
|
3729
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3489
3730
|
/**
|
|
3490
3731
|
* IDs of orders to send pickup emails for.
|
|
3491
3732
|
* @minSize 1
|
|
@@ -3493,18 +3734,18 @@ export interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
|
3493
3734
|
*/
|
|
3494
3735
|
orderIds?: string[];
|
|
3495
3736
|
}
|
|
3496
|
-
|
|
3737
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3497
3738
|
}
|
|
3498
|
-
|
|
3739
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
3499
3740
|
/**
|
|
3500
3741
|
* @minLength 1
|
|
3501
3742
|
* @maxLength 100
|
|
3502
3743
|
*/
|
|
3503
3744
|
orderId?: string;
|
|
3504
3745
|
}
|
|
3505
|
-
|
|
3746
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
3506
3747
|
}
|
|
3507
|
-
|
|
3748
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3508
3749
|
/**
|
|
3509
3750
|
* IDs of orders to send pickup emails for.
|
|
3510
3751
|
* @minSize 1
|
|
@@ -3512,18 +3753,18 @@ export interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
|
3512
3753
|
*/
|
|
3513
3754
|
orderIds?: string[];
|
|
3514
3755
|
}
|
|
3515
|
-
|
|
3756
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3516
3757
|
}
|
|
3517
|
-
|
|
3758
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
3518
3759
|
/**
|
|
3519
3760
|
* @minLength 1
|
|
3520
3761
|
* @maxLength 100
|
|
3521
3762
|
*/
|
|
3522
3763
|
orderId?: string;
|
|
3523
3764
|
}
|
|
3524
|
-
|
|
3765
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
3525
3766
|
}
|
|
3526
|
-
|
|
3767
|
+
interface SendCancelRefundEmailRequest {
|
|
3527
3768
|
/**
|
|
3528
3769
|
* The ID of order that is canceled/refunded
|
|
3529
3770
|
* @minLength 1
|
|
@@ -3544,9 +3785,9 @@ export interface SendCancelRefundEmailRequest {
|
|
|
3544
3785
|
*/
|
|
3545
3786
|
refundId?: string | null;
|
|
3546
3787
|
}
|
|
3547
|
-
|
|
3788
|
+
interface SendCancelRefundEmailResponse {
|
|
3548
3789
|
}
|
|
3549
|
-
|
|
3790
|
+
interface SendRefundEmailRequest {
|
|
3550
3791
|
/**
|
|
3551
3792
|
* The ID of order that is refunded
|
|
3552
3793
|
* @format GUID
|
|
@@ -3564,30 +3805,30 @@ export interface SendRefundEmailRequest {
|
|
|
3564
3805
|
*/
|
|
3565
3806
|
customMessage?: string | null;
|
|
3566
3807
|
}
|
|
3567
|
-
|
|
3808
|
+
interface SendRefundEmailResponse {
|
|
3568
3809
|
}
|
|
3569
|
-
|
|
3810
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
3570
3811
|
/**
|
|
3571
3812
|
* @minLength 1
|
|
3572
3813
|
* @maxLength 100
|
|
3573
3814
|
*/
|
|
3574
3815
|
orderId?: string;
|
|
3575
3816
|
}
|
|
3576
|
-
|
|
3817
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
3577
3818
|
}
|
|
3578
|
-
|
|
3819
|
+
interface PreviewEmailByTypeRequest {
|
|
3579
3820
|
emailType?: PreviewEmailType;
|
|
3580
3821
|
}
|
|
3581
|
-
|
|
3822
|
+
declare enum PreviewEmailType {
|
|
3582
3823
|
ORDER_PLACED = "ORDER_PLACED",
|
|
3583
3824
|
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
3584
3825
|
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
3585
3826
|
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
3586
3827
|
}
|
|
3587
|
-
|
|
3828
|
+
interface PreviewEmailByTypeResponse {
|
|
3588
3829
|
emailPreview?: string;
|
|
3589
3830
|
}
|
|
3590
|
-
|
|
3831
|
+
interface PreviewRefundEmailRequest {
|
|
3591
3832
|
/**
|
|
3592
3833
|
* @minLength 1
|
|
3593
3834
|
* @maxLength 100
|
|
@@ -3609,10 +3850,10 @@ export interface PreviewRefundEmailRequest {
|
|
|
3609
3850
|
*/
|
|
3610
3851
|
refundId?: string | null;
|
|
3611
3852
|
}
|
|
3612
|
-
|
|
3853
|
+
interface PreviewRefundEmailResponse {
|
|
3613
3854
|
emailPreview?: string;
|
|
3614
3855
|
}
|
|
3615
|
-
|
|
3856
|
+
interface PreviewCancelEmailRequest {
|
|
3616
3857
|
/**
|
|
3617
3858
|
* @minLength 1
|
|
3618
3859
|
* @maxLength 100
|
|
@@ -3625,10 +3866,10 @@ export interface PreviewCancelEmailRequest {
|
|
|
3625
3866
|
*/
|
|
3626
3867
|
customMessage?: string | null;
|
|
3627
3868
|
}
|
|
3628
|
-
|
|
3869
|
+
interface PreviewCancelEmailResponse {
|
|
3629
3870
|
emailPreview?: string;
|
|
3630
3871
|
}
|
|
3631
|
-
|
|
3872
|
+
interface PreviewCancelRefundEmailRequest {
|
|
3632
3873
|
/**
|
|
3633
3874
|
* @minLength 1
|
|
3634
3875
|
* @maxLength 100
|
|
@@ -3648,35 +3889,35 @@ export interface PreviewCancelRefundEmailRequest {
|
|
|
3648
3889
|
*/
|
|
3649
3890
|
refundId?: string | null;
|
|
3650
3891
|
}
|
|
3651
|
-
|
|
3892
|
+
interface PreviewCancelRefundEmailResponse {
|
|
3652
3893
|
emailPreview?: string;
|
|
3653
3894
|
}
|
|
3654
|
-
|
|
3895
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
3655
3896
|
}
|
|
3656
|
-
|
|
3897
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
3657
3898
|
emailPreview?: string;
|
|
3658
3899
|
}
|
|
3659
|
-
|
|
3900
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
3660
3901
|
}
|
|
3661
|
-
|
|
3902
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
3662
3903
|
emailPreview?: string;
|
|
3663
3904
|
}
|
|
3664
|
-
|
|
3905
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
3665
3906
|
}
|
|
3666
|
-
|
|
3907
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
3667
3908
|
emailPreview?: string;
|
|
3668
3909
|
}
|
|
3669
|
-
|
|
3910
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
3670
3911
|
}
|
|
3671
|
-
|
|
3912
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
3672
3913
|
emailPreview?: string;
|
|
3673
3914
|
}
|
|
3674
|
-
|
|
3915
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
3675
3916
|
}
|
|
3676
|
-
|
|
3917
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
3677
3918
|
emailPreview?: string;
|
|
3678
3919
|
}
|
|
3679
|
-
|
|
3920
|
+
interface TriggerReindexOrderRequest {
|
|
3680
3921
|
/** @format GUID */
|
|
3681
3922
|
metasiteId?: string;
|
|
3682
3923
|
/**
|
|
@@ -3685,18 +3926,18 @@ export interface TriggerReindexOrderRequest {
|
|
|
3685
3926
|
*/
|
|
3686
3927
|
orderId?: string;
|
|
3687
3928
|
}
|
|
3688
|
-
|
|
3929
|
+
interface SnapshotMessage {
|
|
3689
3930
|
_id?: string;
|
|
3690
3931
|
opType?: number;
|
|
3691
3932
|
}
|
|
3692
|
-
|
|
3933
|
+
interface GetMetasiteDataRequest {
|
|
3693
3934
|
/**
|
|
3694
3935
|
* meta site Id for data to retrieve
|
|
3695
3936
|
* @format GUID
|
|
3696
3937
|
*/
|
|
3697
3938
|
metasiteId?: string;
|
|
3698
3939
|
}
|
|
3699
|
-
|
|
3940
|
+
interface GetMetasiteDataResponse {
|
|
3700
3941
|
/** meta site data */
|
|
3701
3942
|
metasite?: MetaSite;
|
|
3702
3943
|
/** is metasite added to new SDL population via population manager */
|
|
@@ -3714,7 +3955,7 @@ export interface GetMetasiteDataResponse {
|
|
|
3714
3955
|
*
|
|
3715
3956
|
* We prefer to pronounce it as 2 separate words, therefore we use terms "meta site" or "metaSite" or "meta_site" in code.
|
|
3716
3957
|
*/
|
|
3717
|
-
|
|
3958
|
+
interface MetaSite {
|
|
3718
3959
|
/**
|
|
3719
3960
|
* Identifier of meta site.
|
|
3720
3961
|
* @format GUID
|
|
@@ -3835,7 +4076,7 @@ export interface MetaSite {
|
|
|
3835
4076
|
*/
|
|
3836
4077
|
accountCreatedDate?: Date | null;
|
|
3837
4078
|
}
|
|
3838
|
-
|
|
4079
|
+
interface App {
|
|
3839
4080
|
/**
|
|
3840
4081
|
* Identifier of application type (application definition id).
|
|
3841
4082
|
*
|
|
@@ -3870,7 +4111,7 @@ export interface App {
|
|
|
3870
4111
|
* Represents the actual state of the application on site. Do not confuse with the State in the old MetaSiteDTO,
|
|
3871
4112
|
* which has less values and doesn't have 1-to-1 correspondence with this one (this one is exact and correct!)
|
|
3872
4113
|
*/
|
|
3873
|
-
|
|
4114
|
+
declare enum State {
|
|
3874
4115
|
UNKNOWN = "UNKNOWN",
|
|
3875
4116
|
/** App is installed on a site. */
|
|
3876
4117
|
ENABLED = "ENABLED",
|
|
@@ -3881,7 +4122,7 @@ export declare enum State {
|
|
|
3881
4122
|
/** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
|
|
3882
4123
|
PENDING = "PENDING"
|
|
3883
4124
|
}
|
|
3884
|
-
|
|
4125
|
+
declare enum Namespace {
|
|
3885
4126
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
3886
4127
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
3887
4128
|
WIX = "WIX",
|
|
@@ -3963,7 +4204,7 @@ export declare enum Namespace {
|
|
|
3963
4204
|
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
3964
4205
|
MIMIR = "MIMIR"
|
|
3965
4206
|
}
|
|
3966
|
-
|
|
4207
|
+
interface SeoData {
|
|
3967
4208
|
/**
|
|
3968
4209
|
* A title.
|
|
3969
4210
|
* @maxLength 255
|
|
@@ -3989,7 +4230,7 @@ export interface SeoData {
|
|
|
3989
4230
|
*/
|
|
3990
4231
|
canonicalUrl?: string | null;
|
|
3991
4232
|
}
|
|
3992
|
-
|
|
4233
|
+
interface MetaTag {
|
|
3993
4234
|
/**
|
|
3994
4235
|
* A name.
|
|
3995
4236
|
* @maxLength 50
|
|
@@ -4004,7 +4245,7 @@ export interface MetaTag {
|
|
|
4004
4245
|
property?: boolean;
|
|
4005
4246
|
}
|
|
4006
4247
|
/** Represents an HTML application (HTML site). */
|
|
4007
|
-
|
|
4248
|
+
interface HtmlApplication {
|
|
4008
4249
|
/** Legacy, don't use it if you can. */
|
|
4009
4250
|
intId?: number;
|
|
4010
4251
|
/** Identifier of the instance. */
|
|
@@ -4019,7 +4260,7 @@ export interface HtmlApplication {
|
|
|
4019
4260
|
/** Indicates whether this site is managed by Wix Studio. */
|
|
4020
4261
|
studio?: boolean;
|
|
4021
4262
|
}
|
|
4022
|
-
|
|
4263
|
+
interface ExternalUriMapping {
|
|
4023
4264
|
/**
|
|
4024
4265
|
* Deprecated.
|
|
4025
4266
|
* @maxLength 255
|
|
@@ -4038,7 +4279,7 @@ export interface ExternalUriMapping {
|
|
|
4038
4279
|
/** Deprecated. */
|
|
4039
4280
|
requireDomain?: boolean | null;
|
|
4040
4281
|
}
|
|
4041
|
-
|
|
4282
|
+
interface UserDataResponse {
|
|
4042
4283
|
userEmail?: string;
|
|
4043
4284
|
/** owner name */
|
|
4044
4285
|
userName?: string;
|
|
@@ -4047,7 +4288,7 @@ export interface UserDataResponse {
|
|
|
4047
4288
|
/** owner language */
|
|
4048
4289
|
userLanguage?: string;
|
|
4049
4290
|
}
|
|
4050
|
-
|
|
4291
|
+
interface QueryOrdersForMetasiteRequest {
|
|
4051
4292
|
/**
|
|
4052
4293
|
* meta site Id for EP orders to retrieve
|
|
4053
4294
|
* @format GUID
|
|
@@ -4056,11 +4297,11 @@ export interface QueryOrdersForMetasiteRequest {
|
|
|
4056
4297
|
/** paginated internal orders query request */
|
|
4057
4298
|
internalQueryOrdersRequest?: InternalQueryOrdersRequest;
|
|
4058
4299
|
}
|
|
4059
|
-
|
|
4300
|
+
interface InternalQueryOrdersRequest {
|
|
4060
4301
|
/** Query options. */
|
|
4061
4302
|
query?: PlatformQuery;
|
|
4062
4303
|
}
|
|
4063
|
-
|
|
4304
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
4064
4305
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4065
4306
|
paging?: PlatformPaging;
|
|
4066
4307
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
@@ -4071,13 +4312,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
4071
4312
|
sort?: Sorting[];
|
|
4072
4313
|
}
|
|
4073
4314
|
/** @oneof */
|
|
4074
|
-
|
|
4315
|
+
interface PlatformQueryPagingMethodOneOf {
|
|
4075
4316
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4076
4317
|
paging?: PlatformPaging;
|
|
4077
4318
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
4078
4319
|
cursorPaging?: CursorPaging;
|
|
4079
4320
|
}
|
|
4080
|
-
|
|
4321
|
+
interface Sorting {
|
|
4081
4322
|
/**
|
|
4082
4323
|
* Name of the field to sort by.
|
|
4083
4324
|
* @maxLength 512
|
|
@@ -4086,11 +4327,11 @@ export interface Sorting {
|
|
|
4086
4327
|
/** Sort order. */
|
|
4087
4328
|
order?: SortOrder;
|
|
4088
4329
|
}
|
|
4089
|
-
|
|
4330
|
+
declare enum SortOrder {
|
|
4090
4331
|
ASC = "ASC",
|
|
4091
4332
|
DESC = "DESC"
|
|
4092
4333
|
}
|
|
4093
|
-
|
|
4334
|
+
interface PlatformPaging {
|
|
4094
4335
|
/**
|
|
4095
4336
|
* Number of items to load.
|
|
4096
4337
|
* @max 100
|
|
@@ -4099,7 +4340,7 @@ export interface PlatformPaging {
|
|
|
4099
4340
|
/** Number of items to skip in the current sort order. */
|
|
4100
4341
|
offset?: number | null;
|
|
4101
4342
|
}
|
|
4102
|
-
|
|
4343
|
+
interface CursorPaging {
|
|
4103
4344
|
/**
|
|
4104
4345
|
* Maximum number of items to return in the results.
|
|
4105
4346
|
* @max 100
|
|
@@ -4114,13 +4355,13 @@ export interface CursorPaging {
|
|
|
4114
4355
|
*/
|
|
4115
4356
|
cursor?: string | null;
|
|
4116
4357
|
}
|
|
4117
|
-
|
|
4358
|
+
interface QueryOrdersForMetasiteResponse {
|
|
4118
4359
|
/** found exisitng orders according to pagination and query provided. */
|
|
4119
4360
|
orders?: Order[];
|
|
4120
4361
|
/** Details on the paged set of results returned. */
|
|
4121
4362
|
pagingMetadata?: PlatformPagingMetadata;
|
|
4122
4363
|
}
|
|
4123
|
-
|
|
4364
|
+
interface PlatformPagingMetadata {
|
|
4124
4365
|
/** The number of items returned in this response. */
|
|
4125
4366
|
count?: number | null;
|
|
4126
4367
|
/** The offset which was requested. Returned if offset paging was used. */
|
|
@@ -4130,7 +4371,7 @@ export interface PlatformPagingMetadata {
|
|
|
4130
4371
|
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
4131
4372
|
cursors?: Cursors;
|
|
4132
4373
|
}
|
|
4133
|
-
|
|
4374
|
+
interface Cursors {
|
|
4134
4375
|
/**
|
|
4135
4376
|
* Cursor string pointing to the next page in the list of results.
|
|
4136
4377
|
* @maxLength 16000
|
|
@@ -4142,7 +4383,7 @@ export interface Cursors {
|
|
|
4142
4383
|
*/
|
|
4143
4384
|
prev?: string | null;
|
|
4144
4385
|
}
|
|
4145
|
-
|
|
4386
|
+
interface GetOrderForMetasiteRequest {
|
|
4146
4387
|
/**
|
|
4147
4388
|
* meta site Id for EP order to retrieve
|
|
4148
4389
|
* @format GUID
|
|
@@ -4155,11 +4396,11 @@ export interface GetOrderForMetasiteRequest {
|
|
|
4155
4396
|
*/
|
|
4156
4397
|
orderId?: string;
|
|
4157
4398
|
}
|
|
4158
|
-
|
|
4399
|
+
interface GetOrderForMetasiteResponse {
|
|
4159
4400
|
/** Existing EP order */
|
|
4160
4401
|
order?: Order;
|
|
4161
4402
|
}
|
|
4162
|
-
|
|
4403
|
+
interface ListOrderTransactionsForMetasiteRequest {
|
|
4163
4404
|
/**
|
|
4164
4405
|
* meta site Id for EP order transactions to retrieve
|
|
4165
4406
|
* @format GUID
|
|
@@ -4171,11 +4412,11 @@ export interface ListOrderTransactionsForMetasiteRequest {
|
|
|
4171
4412
|
*/
|
|
4172
4413
|
orderId?: string;
|
|
4173
4414
|
}
|
|
4174
|
-
|
|
4415
|
+
interface ListOrderTransactionsForMetasiteResponse {
|
|
4175
4416
|
/** Order ID and its associated transactions. */
|
|
4176
4417
|
orderTransactions?: OrderTransactions;
|
|
4177
4418
|
}
|
|
4178
|
-
|
|
4419
|
+
interface UpsertRefundRequest {
|
|
4179
4420
|
/**
|
|
4180
4421
|
* Meta site ID.
|
|
4181
4422
|
* @format GUID
|
|
@@ -4189,11 +4430,11 @@ export interface UpsertRefundRequest {
|
|
|
4189
4430
|
/** Refund to upsert. */
|
|
4190
4431
|
refund?: Refund;
|
|
4191
4432
|
}
|
|
4192
|
-
|
|
4433
|
+
interface UpsertRefundResponse {
|
|
4193
4434
|
/** Updated order transactions. */
|
|
4194
4435
|
orderTransactions?: OrderTransactions;
|
|
4195
4436
|
}
|
|
4196
|
-
|
|
4437
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
4197
4438
|
/** insert/update documents */
|
|
4198
4439
|
update?: InternalDocumentUpdateOperation;
|
|
4199
4440
|
/** delete by document ids */
|
|
@@ -4234,7 +4475,7 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
|
|
|
4234
4475
|
issuedAt?: Date | null;
|
|
4235
4476
|
}
|
|
4236
4477
|
/** @oneof */
|
|
4237
|
-
|
|
4478
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
4238
4479
|
/** insert/update documents */
|
|
4239
4480
|
update?: InternalDocumentUpdateOperation;
|
|
4240
4481
|
/** delete by document ids */
|
|
@@ -4250,39 +4491,39 @@ export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
|
4250
4491
|
/** delete by document ids with versioning */
|
|
4251
4492
|
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
4252
4493
|
}
|
|
4253
|
-
|
|
4494
|
+
interface InternalDocument {
|
|
4254
4495
|
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
4255
4496
|
document?: Record<string, any> | null;
|
|
4256
4497
|
}
|
|
4257
|
-
|
|
4498
|
+
interface InternalDocumentUpdateOperation {
|
|
4258
4499
|
/** documents to index or update */
|
|
4259
4500
|
documents?: InternalDocument[];
|
|
4260
4501
|
}
|
|
4261
|
-
|
|
4502
|
+
interface DeleteByIdsOperation {
|
|
4262
4503
|
/** ids of the documents to delete */
|
|
4263
4504
|
documentIds?: string[];
|
|
4264
4505
|
}
|
|
4265
|
-
|
|
4506
|
+
interface DeleteByFilterOperation {
|
|
4266
4507
|
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
4267
4508
|
filter?: Record<string, any> | null;
|
|
4268
4509
|
}
|
|
4269
|
-
|
|
4510
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
4270
4511
|
/** documents matching this filter will be updated */
|
|
4271
4512
|
filter?: Record<string, any> | null;
|
|
4272
4513
|
/** partial document to apply */
|
|
4273
4514
|
document?: InternalDocument;
|
|
4274
4515
|
}
|
|
4275
|
-
|
|
4516
|
+
interface InternalUpdateExistingOperation {
|
|
4276
4517
|
/** documents to update */
|
|
4277
4518
|
documents?: InternalDocument[];
|
|
4278
4519
|
}
|
|
4279
|
-
|
|
4520
|
+
interface VersionedDocumentUpdateOperation {
|
|
4280
4521
|
/** documents to create or overwrite */
|
|
4281
4522
|
documents?: InternalDocument[];
|
|
4282
4523
|
/** versioning mode to use instead of default */
|
|
4283
4524
|
versioningMode?: VersioningMode;
|
|
4284
4525
|
}
|
|
4285
|
-
|
|
4526
|
+
declare enum VersioningMode {
|
|
4286
4527
|
/** use default versioning mode agreed with search team */
|
|
4287
4528
|
DEFAULT = "DEFAULT",
|
|
4288
4529
|
/** execute only if version is greater than existing */
|
|
@@ -4290,11 +4531,11 @@ export declare enum VersioningMode {
|
|
|
4290
4531
|
/** execute only if version is greater or equal to existing */
|
|
4291
4532
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
4292
4533
|
}
|
|
4293
|
-
|
|
4534
|
+
interface VersionedDeleteByIdsOperation {
|
|
4294
4535
|
/** ids with version of the documents to delete */
|
|
4295
4536
|
documentIds?: VersionedDocumentId[];
|
|
4296
4537
|
}
|
|
4297
|
-
|
|
4538
|
+
interface VersionedDocumentId {
|
|
4298
4539
|
/** document id */
|
|
4299
4540
|
documentId?: string;
|
|
4300
4541
|
/** document version */
|
|
@@ -4302,7 +4543,7 @@ export interface VersionedDocumentId {
|
|
|
4302
4543
|
/** versioning mode to use instead of default */
|
|
4303
4544
|
versioningMode?: VersioningMode;
|
|
4304
4545
|
}
|
|
4305
|
-
|
|
4546
|
+
interface TriggerReindexRequest {
|
|
4306
4547
|
/** @format GUID */
|
|
4307
4548
|
metasiteId?: string;
|
|
4308
4549
|
/**
|
|
@@ -4312,13 +4553,13 @@ export interface TriggerReindexRequest {
|
|
|
4312
4553
|
*/
|
|
4313
4554
|
orderIds?: string[];
|
|
4314
4555
|
}
|
|
4315
|
-
|
|
4556
|
+
interface TriggerReindexResponse {
|
|
4316
4557
|
}
|
|
4317
|
-
|
|
4558
|
+
interface BatchOfTriggerReindexOrderRequest {
|
|
4318
4559
|
/** @maxSize 25 */
|
|
4319
4560
|
requests?: TriggerReindexOrderRequest[];
|
|
4320
4561
|
}
|
|
4321
|
-
|
|
4562
|
+
interface DiffmatokyPayload {
|
|
4322
4563
|
left?: string;
|
|
4323
4564
|
right?: string;
|
|
4324
4565
|
compareChannel?: string;
|
|
@@ -4326,20 +4567,20 @@ export interface DiffmatokyPayload {
|
|
|
4326
4567
|
errorInformation?: ErrorInformation;
|
|
4327
4568
|
tags?: string[];
|
|
4328
4569
|
}
|
|
4329
|
-
|
|
4570
|
+
interface ErrorInformation {
|
|
4330
4571
|
stackTrace?: string;
|
|
4331
4572
|
}
|
|
4332
|
-
|
|
4573
|
+
interface ContinueSideEffectsFlowInLegacyData {
|
|
4333
4574
|
storeId?: string;
|
|
4334
4575
|
orderId?: string;
|
|
4335
4576
|
ordersExperiments?: OrdersExperiments;
|
|
4336
4577
|
}
|
|
4337
|
-
|
|
4578
|
+
interface IndexingMessage {
|
|
4338
4579
|
_id?: string;
|
|
4339
4580
|
opType?: number;
|
|
4340
4581
|
requiredVersions?: string[];
|
|
4341
4582
|
}
|
|
4342
|
-
|
|
4583
|
+
interface GetOrderRequest {
|
|
4343
4584
|
/**
|
|
4344
4585
|
* ID of the order to retrieve.
|
|
4345
4586
|
* @minLength 1
|
|
@@ -4347,31 +4588,31 @@ export interface GetOrderRequest {
|
|
|
4347
4588
|
*/
|
|
4348
4589
|
_id: string;
|
|
4349
4590
|
}
|
|
4350
|
-
|
|
4591
|
+
interface GetOrderResponse {
|
|
4351
4592
|
/** The requested order. */
|
|
4352
4593
|
order?: Order;
|
|
4353
4594
|
}
|
|
4354
|
-
|
|
4595
|
+
interface InternalQueryOrdersResponse {
|
|
4355
4596
|
/** List of orders. */
|
|
4356
4597
|
orders?: Order[];
|
|
4357
4598
|
/** Details on the paged set of results returned. */
|
|
4358
4599
|
metadata?: PlatformPagingMetadata;
|
|
4359
4600
|
}
|
|
4360
|
-
|
|
4601
|
+
interface QueryOrderRequest {
|
|
4361
4602
|
/** Query options. */
|
|
4362
4603
|
query?: PlatformQuery;
|
|
4363
4604
|
}
|
|
4364
|
-
|
|
4605
|
+
interface QueryOrderResponse {
|
|
4365
4606
|
/** List of orders. */
|
|
4366
4607
|
orders?: Order[];
|
|
4367
4608
|
/** Details on the paged set of results returned. */
|
|
4368
4609
|
metadata?: PlatformPagingMetadata;
|
|
4369
4610
|
}
|
|
4370
|
-
|
|
4611
|
+
interface SearchOrdersRequest {
|
|
4371
4612
|
/** Search options. */
|
|
4372
4613
|
search?: CursorSearch;
|
|
4373
4614
|
}
|
|
4374
|
-
|
|
4615
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
4375
4616
|
/**
|
|
4376
4617
|
* Cursor paging options.
|
|
4377
4618
|
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
@@ -4400,20 +4641,20 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
4400
4641
|
sort?: Sorting[];
|
|
4401
4642
|
}
|
|
4402
4643
|
/** @oneof */
|
|
4403
|
-
|
|
4644
|
+
interface CursorSearchPagingMethodOneOf {
|
|
4404
4645
|
/**
|
|
4405
4646
|
* Cursor paging options.
|
|
4406
4647
|
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
4407
4648
|
*/
|
|
4408
4649
|
cursorPaging?: CursorPaging;
|
|
4409
4650
|
}
|
|
4410
|
-
|
|
4651
|
+
interface SearchOrdersResponse {
|
|
4411
4652
|
/** List of orders. */
|
|
4412
4653
|
orders?: Order[];
|
|
4413
4654
|
/** Details on the paged set of results returned. */
|
|
4414
4655
|
metadata?: CursorPagingMetadata;
|
|
4415
4656
|
}
|
|
4416
|
-
|
|
4657
|
+
interface CursorPagingMetadata {
|
|
4417
4658
|
/** Number of items returned in current page. */
|
|
4418
4659
|
count?: number | null;
|
|
4419
4660
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -4426,13 +4667,13 @@ export interface CursorPagingMetadata {
|
|
|
4426
4667
|
*/
|
|
4427
4668
|
hasNext?: boolean | null;
|
|
4428
4669
|
}
|
|
4429
|
-
|
|
4670
|
+
interface CreateOrderRequest {
|
|
4430
4671
|
/** Order info. */
|
|
4431
4672
|
order: Order;
|
|
4432
4673
|
/** Determine order lifecycle */
|
|
4433
4674
|
settings?: OrderCreationSettings;
|
|
4434
4675
|
}
|
|
4435
|
-
|
|
4676
|
+
interface OrderCreationSettings {
|
|
4436
4677
|
/**
|
|
4437
4678
|
* Condition for the order to be approved.
|
|
4438
4679
|
* Default: `DEFAULT`
|
|
@@ -4441,7 +4682,7 @@ export interface OrderCreationSettings {
|
|
|
4441
4682
|
/** Notification settings to be applied on order creation */
|
|
4442
4683
|
notifications?: OrderCreateNotifications;
|
|
4443
4684
|
}
|
|
4444
|
-
|
|
4685
|
+
declare enum OrderApprovalStrategy {
|
|
4445
4686
|
/** Order is automatically approved when `order.priceSummary.total = 0`, **or** after receiving payment. */
|
|
4446
4687
|
DEFAULT = "DEFAULT",
|
|
4447
4688
|
/** Order is automatically approved **only** after receiving payment. */
|
|
@@ -4449,7 +4690,7 @@ export declare enum OrderApprovalStrategy {
|
|
|
4449
4690
|
/** Order is automatically approved when payment method is saved for it. */
|
|
4450
4691
|
PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
|
|
4451
4692
|
}
|
|
4452
|
-
|
|
4693
|
+
interface OrderCreateNotifications {
|
|
4453
4694
|
/**
|
|
4454
4695
|
* Whether to send notification to the buyer.
|
|
4455
4696
|
*
|
|
@@ -4463,19 +4704,19 @@ export interface OrderCreateNotifications {
|
|
|
4463
4704
|
*/
|
|
4464
4705
|
sendNotificationsToBusiness?: boolean | null;
|
|
4465
4706
|
}
|
|
4466
|
-
|
|
4707
|
+
interface CreateOrderResponse {
|
|
4467
4708
|
/** Newly created order. */
|
|
4468
4709
|
order?: Order;
|
|
4469
4710
|
}
|
|
4470
|
-
|
|
4711
|
+
interface UpdateOrderRequest {
|
|
4471
4712
|
/** Order to be updated. */
|
|
4472
4713
|
order: Order;
|
|
4473
4714
|
}
|
|
4474
|
-
|
|
4715
|
+
interface UpdateOrderResponse {
|
|
4475
4716
|
/** Newly created order. */
|
|
4476
4717
|
order?: Order;
|
|
4477
4718
|
}
|
|
4478
|
-
|
|
4719
|
+
interface BulkUpdateOrdersRequest {
|
|
4479
4720
|
/**
|
|
4480
4721
|
* Orders to update.
|
|
4481
4722
|
* @minSize 1
|
|
@@ -4489,11 +4730,11 @@ export interface BulkUpdateOrdersRequest {
|
|
|
4489
4730
|
*/
|
|
4490
4731
|
returnEntity?: boolean;
|
|
4491
4732
|
}
|
|
4492
|
-
|
|
4733
|
+
interface MaskedOrder {
|
|
4493
4734
|
/** Order to be updated. */
|
|
4494
4735
|
order?: Order;
|
|
4495
4736
|
}
|
|
4496
|
-
|
|
4737
|
+
interface BulkUpdateOrdersResponse {
|
|
4497
4738
|
/**
|
|
4498
4739
|
* Bulk action results.
|
|
4499
4740
|
* @minSize 1
|
|
@@ -4503,7 +4744,7 @@ export interface BulkUpdateOrdersResponse {
|
|
|
4503
4744
|
/** Bulk action metadata. */
|
|
4504
4745
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4505
4746
|
}
|
|
4506
|
-
|
|
4747
|
+
interface CommitDeltasRequest {
|
|
4507
4748
|
/** Order id to be updated */
|
|
4508
4749
|
_id: string;
|
|
4509
4750
|
/**
|
|
@@ -4522,11 +4763,41 @@ export interface CommitDeltasRequest {
|
|
|
4522
4763
|
*/
|
|
4523
4764
|
reason?: string | null;
|
|
4524
4765
|
}
|
|
4525
|
-
|
|
4766
|
+
interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftOrderDiffsBuyerUpdateInfoOneOf, DraftOrderDiffsBillingUpdateInfoOneOf, DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4526
4767
|
/** Shipping info and selected shipping option details. */
|
|
4527
4768
|
changedShippingInfo?: V1ShippingInformation;
|
|
4528
4769
|
/** Remove existing shipping info. */
|
|
4529
4770
|
shippingInfoRemoved?: boolean;
|
|
4771
|
+
/**
|
|
4772
|
+
* Buyer info and selected buyer option details.
|
|
4773
|
+
* @internal
|
|
4774
|
+
*/
|
|
4775
|
+
changedBuyerInfo?: BuyerInfo;
|
|
4776
|
+
/**
|
|
4777
|
+
* Remove existing buyer info.
|
|
4778
|
+
* @internal
|
|
4779
|
+
*/
|
|
4780
|
+
buyerInfoRemoved?: boolean;
|
|
4781
|
+
/**
|
|
4782
|
+
* Updated billing info.
|
|
4783
|
+
* @internal
|
|
4784
|
+
*/
|
|
4785
|
+
changedBillingInfo?: AddressWithContact;
|
|
4786
|
+
/**
|
|
4787
|
+
* Remove existing billing info.
|
|
4788
|
+
* @internal
|
|
4789
|
+
*/
|
|
4790
|
+
billingInfoRemoved?: boolean;
|
|
4791
|
+
/**
|
|
4792
|
+
* Updated recipient info.
|
|
4793
|
+
* @internal
|
|
4794
|
+
*/
|
|
4795
|
+
changedRecipientInfo?: AddressWithContact;
|
|
4796
|
+
/**
|
|
4797
|
+
* Remove existing recipient info.
|
|
4798
|
+
* @internal
|
|
4799
|
+
*/
|
|
4800
|
+
recipientInfoRemoved?: boolean;
|
|
4530
4801
|
/**
|
|
4531
4802
|
* Added/updated/removed order line items.
|
|
4532
4803
|
* @maxSize 300
|
|
@@ -4560,22 +4831,52 @@ export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf,
|
|
|
4560
4831
|
priceSummary?: PriceSummary;
|
|
4561
4832
|
}
|
|
4562
4833
|
/** @oneof */
|
|
4563
|
-
|
|
4834
|
+
interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
4564
4835
|
/** Shipping info and selected shipping option details. */
|
|
4565
4836
|
changedShippingInfo?: V1ShippingInformation;
|
|
4566
4837
|
/** Remove existing shipping info. */
|
|
4567
4838
|
shippingInfoRemoved?: boolean;
|
|
4568
4839
|
}
|
|
4569
4840
|
/** @oneof */
|
|
4570
|
-
|
|
4841
|
+
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
4842
|
+
/**
|
|
4843
|
+
* Buyer info and selected buyer option details.
|
|
4844
|
+
* @internal
|
|
4845
|
+
*/
|
|
4846
|
+
changedBuyerInfo?: BuyerInfo;
|
|
4847
|
+
/**
|
|
4848
|
+
* Remove existing buyer info.
|
|
4849
|
+
* @internal
|
|
4850
|
+
*/
|
|
4851
|
+
buyerInfoRemoved?: boolean;
|
|
4571
4852
|
}
|
|
4572
4853
|
/** @oneof */
|
|
4573
|
-
|
|
4854
|
+
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
4855
|
+
/**
|
|
4856
|
+
* Updated billing info.
|
|
4857
|
+
* @internal
|
|
4858
|
+
*/
|
|
4859
|
+
changedBillingInfo?: AddressWithContact;
|
|
4860
|
+
/**
|
|
4861
|
+
* Remove existing billing info.
|
|
4862
|
+
* @internal
|
|
4863
|
+
*/
|
|
4864
|
+
billingInfoRemoved?: boolean;
|
|
4574
4865
|
}
|
|
4575
4866
|
/** @oneof */
|
|
4576
|
-
|
|
4867
|
+
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4868
|
+
/**
|
|
4869
|
+
* Updated recipient info.
|
|
4870
|
+
* @internal
|
|
4871
|
+
*/
|
|
4872
|
+
changedRecipientInfo?: AddressWithContact;
|
|
4873
|
+
/**
|
|
4874
|
+
* Remove existing recipient info.
|
|
4875
|
+
* @internal
|
|
4876
|
+
*/
|
|
4877
|
+
recipientInfoRemoved?: boolean;
|
|
4577
4878
|
}
|
|
4578
|
-
|
|
4879
|
+
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
4579
4880
|
/** The line item was added. */
|
|
4580
4881
|
lineItemAdded?: boolean;
|
|
4581
4882
|
/** The line item was modified. */
|
|
@@ -4590,7 +4891,7 @@ export interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
|
4590
4891
|
lineItem?: OrderLineItemChangedDetails;
|
|
4591
4892
|
}
|
|
4592
4893
|
/** @oneof */
|
|
4593
|
-
|
|
4894
|
+
interface V1LineItemDeltaDeltaOneOf {
|
|
4594
4895
|
/** The line item was added. */
|
|
4595
4896
|
lineItemAdded?: boolean;
|
|
4596
4897
|
/** The line item was modified. */
|
|
@@ -4598,7 +4899,7 @@ export interface V1LineItemDeltaDeltaOneOf {
|
|
|
4598
4899
|
/** The line item was added. */
|
|
4599
4900
|
lineItemRemoved?: boolean;
|
|
4600
4901
|
}
|
|
4601
|
-
|
|
4902
|
+
interface OrderLineItemChangedDetails {
|
|
4602
4903
|
/**
|
|
4603
4904
|
* Item name.
|
|
4604
4905
|
* + Stores - `product.name`
|
|
@@ -4673,11 +4974,17 @@ export interface OrderLineItemChangedDetails {
|
|
|
4673
4974
|
* @maxSize 5
|
|
4674
4975
|
*/
|
|
4675
4976
|
locations?: LocationAndQuantity[];
|
|
4977
|
+
/**
|
|
4978
|
+
* ID of the app managing the inventory.
|
|
4979
|
+
* @internal
|
|
4980
|
+
* @format GUID
|
|
4981
|
+
*/
|
|
4982
|
+
inventoryAppId?: string | null;
|
|
4676
4983
|
/** Subscription info. */
|
|
4677
4984
|
subscriptionInfo?: SubscriptionInfo;
|
|
4678
4985
|
}
|
|
4679
4986
|
/** Type of selected payment option for catalog item */
|
|
4680
|
-
|
|
4987
|
+
declare enum DeltaPaymentOptionType {
|
|
4681
4988
|
/** Irrelevant */
|
|
4682
4989
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
4683
4990
|
/** The entire payment for the given item will happen after checkout. */
|
|
@@ -4688,7 +4995,7 @@ export declare enum DeltaPaymentOptionType {
|
|
|
4688
4995
|
*/
|
|
4689
4996
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
4690
4997
|
}
|
|
4691
|
-
|
|
4998
|
+
interface ItemChangedDetails {
|
|
4692
4999
|
/**
|
|
4693
5000
|
* The quantity before the change.
|
|
4694
5001
|
* @min 1
|
|
@@ -4700,7 +5007,7 @@ export interface ItemChangedDetails {
|
|
|
4700
5007
|
/** The price description before the change */
|
|
4701
5008
|
priceDescriptionBeforeChange?: PriceDescription;
|
|
4702
5009
|
}
|
|
4703
|
-
|
|
5010
|
+
interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
|
|
4704
5011
|
editedDiscount?: AppliedDiscount;
|
|
4705
5012
|
discountRemoved?: boolean;
|
|
4706
5013
|
/**
|
|
@@ -4710,11 +5017,11 @@ export interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
|
|
|
4710
5017
|
discountId?: string;
|
|
4711
5018
|
}
|
|
4712
5019
|
/** @oneof */
|
|
4713
|
-
|
|
5020
|
+
interface AppliedDiscountDeltaDeltaOneOf {
|
|
4714
5021
|
editedDiscount?: AppliedDiscount;
|
|
4715
5022
|
discountRemoved?: boolean;
|
|
4716
5023
|
}
|
|
4717
|
-
|
|
5024
|
+
interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
|
|
4718
5025
|
editedAdditionalFee?: AdditionalFee;
|
|
4719
5026
|
additionalFeeRemoved?: boolean;
|
|
4720
5027
|
/**
|
|
@@ -4724,11 +5031,11 @@ export interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
|
|
|
4724
5031
|
additionalFeeId?: string;
|
|
4725
5032
|
}
|
|
4726
5033
|
/** @oneof */
|
|
4727
|
-
|
|
5034
|
+
interface AdditionalFeeDeltaDeltaOneOf {
|
|
4728
5035
|
editedAdditionalFee?: AdditionalFee;
|
|
4729
5036
|
additionalFeeRemoved?: boolean;
|
|
4730
5037
|
}
|
|
4731
|
-
|
|
5038
|
+
interface DraftOrderCommitSettings {
|
|
4732
5039
|
/** If false, do not send notifications to buyer. Default is true. */
|
|
4733
5040
|
sendNotificationsToBuyer?: boolean | null;
|
|
4734
5041
|
/** If false, do not send notifications to business. Default is true. */
|
|
@@ -4743,7 +5050,7 @@ export interface DraftOrderCommitSettings {
|
|
|
4743
5050
|
*/
|
|
4744
5051
|
inventoryUpdates?: InventoryUpdateDetails[];
|
|
4745
5052
|
}
|
|
4746
|
-
|
|
5053
|
+
interface InventoryUpdateDetails {
|
|
4747
5054
|
/** Action to be applied - decrease or restock */
|
|
4748
5055
|
actionType?: InventoryAction;
|
|
4749
5056
|
/** Order line item id */
|
|
@@ -4751,18 +5058,18 @@ export interface InventoryUpdateDetails {
|
|
|
4751
5058
|
/** The amount to be increased or restocked */
|
|
4752
5059
|
quantityChange?: number;
|
|
4753
5060
|
}
|
|
4754
|
-
|
|
5061
|
+
declare enum InventoryAction {
|
|
4755
5062
|
/** Restock inventory */
|
|
4756
5063
|
RESTOCK = "RESTOCK",
|
|
4757
5064
|
/** Decrease inventory. Without failing on negative inventory. */
|
|
4758
5065
|
DECREASE = "DECREASE"
|
|
4759
5066
|
}
|
|
4760
|
-
|
|
5067
|
+
interface CommitDeltasResponse {
|
|
4761
5068
|
/** Order after deltas are applied */
|
|
4762
5069
|
order?: Order;
|
|
4763
5070
|
}
|
|
4764
5071
|
/** Triggered when order is edited by draftOrders */
|
|
4765
|
-
|
|
5072
|
+
interface OrderDeltasCommitted {
|
|
4766
5073
|
/** The order after committed changes. */
|
|
4767
5074
|
order?: Order;
|
|
4768
5075
|
/** Draft order Id representing this change. */
|
|
@@ -4777,7 +5084,7 @@ export interface OrderDeltasCommitted {
|
|
|
4777
5084
|
*/
|
|
4778
5085
|
commitDate?: Date | null;
|
|
4779
5086
|
}
|
|
4780
|
-
|
|
5087
|
+
interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
|
|
4781
5088
|
/** Shipping info and selected shipping option details. */
|
|
4782
5089
|
changedShippingInfo?: V1ShippingInformation;
|
|
4783
5090
|
/** Remove existing shipping info. */
|
|
@@ -4799,13 +5106,13 @@ export interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
|
|
|
4799
5106
|
additionalFees?: AdditionalFeeDelta[];
|
|
4800
5107
|
}
|
|
4801
5108
|
/** @oneof */
|
|
4802
|
-
|
|
5109
|
+
interface CommittedDiffsShippingUpdateInfoOneOf {
|
|
4803
5110
|
/** Shipping info and selected shipping option details. */
|
|
4804
5111
|
changedShippingInfo?: V1ShippingInformation;
|
|
4805
5112
|
/** Remove existing shipping info. */
|
|
4806
5113
|
shippingInfoRemoved?: boolean;
|
|
4807
5114
|
}
|
|
4808
|
-
|
|
5115
|
+
interface LineItemDelta extends LineItemDeltaDeltaOneOf {
|
|
4809
5116
|
lineItemAdded?: boolean;
|
|
4810
5117
|
changedDetails?: ItemChangedDetails;
|
|
4811
5118
|
lineItemRemoved?: OrderLineItemChangedDetails;
|
|
@@ -4816,12 +5123,12 @@ export interface LineItemDelta extends LineItemDeltaDeltaOneOf {
|
|
|
4816
5123
|
lineItemId?: string;
|
|
4817
5124
|
}
|
|
4818
5125
|
/** @oneof */
|
|
4819
|
-
|
|
5126
|
+
interface LineItemDeltaDeltaOneOf {
|
|
4820
5127
|
lineItemAdded?: boolean;
|
|
4821
5128
|
changedDetails?: ItemChangedDetails;
|
|
4822
5129
|
lineItemRemoved?: OrderLineItemChangedDetails;
|
|
4823
5130
|
}
|
|
4824
|
-
|
|
5131
|
+
interface ArchiveOrderRequest {
|
|
4825
5132
|
/**
|
|
4826
5133
|
* Order ID.
|
|
4827
5134
|
* @minLength 1
|
|
@@ -4829,11 +5136,11 @@ export interface ArchiveOrderRequest {
|
|
|
4829
5136
|
*/
|
|
4830
5137
|
_id?: string;
|
|
4831
5138
|
}
|
|
4832
|
-
|
|
5139
|
+
interface ArchiveOrderResponse {
|
|
4833
5140
|
/** Archived order. */
|
|
4834
5141
|
order?: Order;
|
|
4835
5142
|
}
|
|
4836
|
-
|
|
5143
|
+
interface BulkArchiveOrdersRequest {
|
|
4837
5144
|
/**
|
|
4838
5145
|
* IDs of orders to archive.
|
|
4839
5146
|
* @minSize 1
|
|
@@ -4843,23 +5150,23 @@ export interface BulkArchiveOrdersRequest {
|
|
|
4843
5150
|
/** Whether to return the full updated order entities in the response. */
|
|
4844
5151
|
returnFullEntity?: boolean;
|
|
4845
5152
|
}
|
|
4846
|
-
|
|
5153
|
+
interface BulkArchiveOrdersResponse {
|
|
4847
5154
|
/** Items updated by bulk action. */
|
|
4848
5155
|
results?: BulkOrderResult[];
|
|
4849
5156
|
/** Bulk action metadata. */
|
|
4850
5157
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4851
5158
|
}
|
|
4852
|
-
|
|
5159
|
+
interface BulkArchiveOrdersByFilterRequest {
|
|
4853
5160
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
4854
5161
|
filter?: Record<string, any> | null;
|
|
4855
5162
|
}
|
|
4856
|
-
|
|
5163
|
+
interface BulkArchiveOrdersByFilterResponse {
|
|
4857
5164
|
/** Items updated by bulk action. */
|
|
4858
5165
|
results?: BulkOrderResult[];
|
|
4859
5166
|
/** Bulk action metadata. */
|
|
4860
5167
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4861
5168
|
}
|
|
4862
|
-
|
|
5169
|
+
interface UnArchiveOrderRequest {
|
|
4863
5170
|
/**
|
|
4864
5171
|
* Order ID.
|
|
4865
5172
|
* @minLength 1
|
|
@@ -4867,11 +5174,11 @@ export interface UnArchiveOrderRequest {
|
|
|
4867
5174
|
*/
|
|
4868
5175
|
_id?: string;
|
|
4869
5176
|
}
|
|
4870
|
-
|
|
5177
|
+
interface UnArchiveOrderResponse {
|
|
4871
5178
|
/** Unarchived order. */
|
|
4872
5179
|
order?: Order;
|
|
4873
5180
|
}
|
|
4874
|
-
|
|
5181
|
+
interface BulkUnArchiveOrdersRequest {
|
|
4875
5182
|
/**
|
|
4876
5183
|
* IDs or orders to unarchive.
|
|
4877
5184
|
* @minSize 1
|
|
@@ -4881,23 +5188,23 @@ export interface BulkUnArchiveOrdersRequest {
|
|
|
4881
5188
|
/** Whether to return the full updated order entities in the response. */
|
|
4882
5189
|
returnFullEntity?: boolean;
|
|
4883
5190
|
}
|
|
4884
|
-
|
|
5191
|
+
interface BulkUnArchiveOrdersResponse {
|
|
4885
5192
|
/** Items updated by bulk action. */
|
|
4886
5193
|
results?: BulkOrderResult[];
|
|
4887
5194
|
/** Bulk action metadata. */
|
|
4888
5195
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4889
5196
|
}
|
|
4890
|
-
|
|
5197
|
+
interface BulkUnArchiveOrdersByFilterRequest {
|
|
4891
5198
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
4892
5199
|
filter?: Record<string, any> | null;
|
|
4893
5200
|
}
|
|
4894
|
-
|
|
5201
|
+
interface BulkUnArchiveOrdersByFilterResponse {
|
|
4895
5202
|
/** Items updated by bulk action. */
|
|
4896
5203
|
results?: BulkOrderResult[];
|
|
4897
5204
|
/** Bulk action metadata. */
|
|
4898
5205
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4899
5206
|
}
|
|
4900
|
-
|
|
5207
|
+
interface UpdateBuyerInfoRequest {
|
|
4901
5208
|
/**
|
|
4902
5209
|
* Order ID.
|
|
4903
5210
|
* @minLength 1
|
|
@@ -4908,7 +5215,7 @@ export interface UpdateBuyerInfoRequest {
|
|
|
4908
5215
|
/** Buyer info. */
|
|
4909
5216
|
buyerInfo?: BuyerInfoUpdate;
|
|
4910
5217
|
}
|
|
4911
|
-
|
|
5218
|
+
interface BuyerInfoUpdate {
|
|
4912
5219
|
/**
|
|
4913
5220
|
* Contact ID.
|
|
4914
5221
|
* @format GUID
|
|
@@ -4920,11 +5227,11 @@ export interface BuyerInfoUpdate {
|
|
|
4920
5227
|
*/
|
|
4921
5228
|
email?: string | null;
|
|
4922
5229
|
}
|
|
4923
|
-
|
|
5230
|
+
interface UpdateBuyerInfoResponse {
|
|
4924
5231
|
/** Updated order. */
|
|
4925
5232
|
order?: Order;
|
|
4926
5233
|
}
|
|
4927
|
-
|
|
5234
|
+
interface UpdateBuyerEmailRequest {
|
|
4928
5235
|
/**
|
|
4929
5236
|
* @minLength 1
|
|
4930
5237
|
* @maxLength 100
|
|
@@ -4934,10 +5241,10 @@ export interface UpdateBuyerEmailRequest {
|
|
|
4934
5241
|
/** @format EMAIL */
|
|
4935
5242
|
email?: string | null;
|
|
4936
5243
|
}
|
|
4937
|
-
|
|
5244
|
+
interface UpdateBuyerEmailResponse {
|
|
4938
5245
|
order?: Order;
|
|
4939
5246
|
}
|
|
4940
|
-
|
|
5247
|
+
interface UpdateOrderShippingAddressRequest {
|
|
4941
5248
|
/**
|
|
4942
5249
|
* Order ID.
|
|
4943
5250
|
* @minLength 1
|
|
@@ -4947,11 +5254,11 @@ export interface UpdateOrderShippingAddressRequest {
|
|
|
4947
5254
|
/** Shipping address and contact details to be updated. */
|
|
4948
5255
|
shippingAddress?: AddressWithContact;
|
|
4949
5256
|
}
|
|
4950
|
-
|
|
5257
|
+
interface UpdateOrderShippingAddressResponse {
|
|
4951
5258
|
/** Updated order. */
|
|
4952
5259
|
order?: Order;
|
|
4953
5260
|
}
|
|
4954
|
-
|
|
5261
|
+
interface UpdateBillingContactDetailsRequest {
|
|
4955
5262
|
/**
|
|
4956
5263
|
* Order ID.
|
|
4957
5264
|
* @minLength 1
|
|
@@ -4962,11 +5269,11 @@ export interface UpdateBillingContactDetailsRequest {
|
|
|
4962
5269
|
/** Contact details. */
|
|
4963
5270
|
addressContactDetails?: FullAddressContactDetails;
|
|
4964
5271
|
}
|
|
4965
|
-
|
|
5272
|
+
interface UpdateBillingContactDetailsResponse {
|
|
4966
5273
|
/** Updated order. */
|
|
4967
5274
|
order?: Order;
|
|
4968
5275
|
}
|
|
4969
|
-
|
|
5276
|
+
interface UpdateOrderLineItemRequest {
|
|
4970
5277
|
/**
|
|
4971
5278
|
* Order ID
|
|
4972
5279
|
* @minLength 1
|
|
@@ -4976,11 +5283,11 @@ export interface UpdateOrderLineItemRequest {
|
|
|
4976
5283
|
/** Order line item to update */
|
|
4977
5284
|
lineItem: OrderLineItem;
|
|
4978
5285
|
}
|
|
4979
|
-
|
|
5286
|
+
interface UpdateOrderLineItemResponse {
|
|
4980
5287
|
/** Updated order data */
|
|
4981
5288
|
order?: Order;
|
|
4982
5289
|
}
|
|
4983
|
-
|
|
5290
|
+
interface UpdateOrderLineItemsRequest {
|
|
4984
5291
|
/**
|
|
4985
5292
|
* Order ID
|
|
4986
5293
|
* @minLength 1
|
|
@@ -4994,15 +5301,15 @@ export interface UpdateOrderLineItemsRequest {
|
|
|
4994
5301
|
*/
|
|
4995
5302
|
lineItems?: MaskedOrderLineItem[];
|
|
4996
5303
|
}
|
|
4997
|
-
|
|
5304
|
+
interface MaskedOrderLineItem {
|
|
4998
5305
|
/** Order line item to update */
|
|
4999
5306
|
lineItem?: OrderLineItem;
|
|
5000
5307
|
}
|
|
5001
|
-
|
|
5308
|
+
interface UpdateOrderLineItemsResponse {
|
|
5002
5309
|
/** Updated order data */
|
|
5003
5310
|
order?: Order;
|
|
5004
5311
|
}
|
|
5005
|
-
|
|
5312
|
+
interface AddInternalActivityRequest {
|
|
5006
5313
|
/**
|
|
5007
5314
|
* Order ID.
|
|
5008
5315
|
* @minLength 1
|
|
@@ -5012,7 +5319,7 @@ export interface AddInternalActivityRequest {
|
|
|
5012
5319
|
/** Activity info. */
|
|
5013
5320
|
activity?: InternalActivity;
|
|
5014
5321
|
}
|
|
5015
|
-
|
|
5322
|
+
interface InternalActivity extends InternalActivityContentOneOf {
|
|
5016
5323
|
/** Order refunded. */
|
|
5017
5324
|
orderRefunded?: OrderRefunded;
|
|
5018
5325
|
/** Order placed. */
|
|
@@ -5057,6 +5364,35 @@ export interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5057
5364
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5058
5365
|
/** Payment method is saved for order */
|
|
5059
5366
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5367
|
+
/**
|
|
5368
|
+
* Details of an initiated refund process.
|
|
5369
|
+
*
|
|
5370
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5371
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5372
|
+
* @internal
|
|
5373
|
+
*/
|
|
5374
|
+
refundInitiated?: RefundInitiated;
|
|
5375
|
+
/**
|
|
5376
|
+
* Details of a refunded payment.
|
|
5377
|
+
*
|
|
5378
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5379
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5380
|
+
* @internal
|
|
5381
|
+
*/
|
|
5382
|
+
paymentRefunded?: PaymentRefunded;
|
|
5383
|
+
/**
|
|
5384
|
+
* Details of a failed payment refund.
|
|
5385
|
+
*
|
|
5386
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5387
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5388
|
+
* @internal
|
|
5389
|
+
*/
|
|
5390
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5391
|
+
/**
|
|
5392
|
+
* Details of refund to store credit.
|
|
5393
|
+
* @internal
|
|
5394
|
+
*/
|
|
5395
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5060
5396
|
/** Details of a pending payment */
|
|
5061
5397
|
paymentPending?: PaymentPending;
|
|
5062
5398
|
/** Details of a canceled payment */
|
|
@@ -5067,6 +5403,16 @@ export interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5067
5403
|
orderPending?: OrderPending;
|
|
5068
5404
|
/** Order rejected */
|
|
5069
5405
|
orderRejected?: OrderRejected;
|
|
5406
|
+
/**
|
|
5407
|
+
* Receipt was added for associated payment
|
|
5408
|
+
* @internal
|
|
5409
|
+
*/
|
|
5410
|
+
receiptCreated?: ReceiptCreated;
|
|
5411
|
+
/**
|
|
5412
|
+
* Receipt sent to customer
|
|
5413
|
+
* @internal
|
|
5414
|
+
*/
|
|
5415
|
+
receiptSent?: ReceiptSent;
|
|
5070
5416
|
/**
|
|
5071
5417
|
* Internal activity ID.
|
|
5072
5418
|
* @format GUID
|
|
@@ -5086,7 +5432,7 @@ export interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5086
5432
|
_createdDate?: Date | null;
|
|
5087
5433
|
}
|
|
5088
5434
|
/** @oneof */
|
|
5089
|
-
|
|
5435
|
+
interface InternalActivityContentOneOf {
|
|
5090
5436
|
/** Order refunded. */
|
|
5091
5437
|
orderRefunded?: OrderRefunded;
|
|
5092
5438
|
/** Order placed. */
|
|
@@ -5131,6 +5477,35 @@ export interface InternalActivityContentOneOf {
|
|
|
5131
5477
|
draftOrderChangesApplied?: DraftOrderChangesApplied;
|
|
5132
5478
|
/** Payment method is saved for order */
|
|
5133
5479
|
savedPaymentMethod?: SavedPaymentMethod;
|
|
5480
|
+
/**
|
|
5481
|
+
* Details of an initiated refund process.
|
|
5482
|
+
*
|
|
5483
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5484
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5485
|
+
* @internal
|
|
5486
|
+
*/
|
|
5487
|
+
refundInitiated?: RefundInitiated;
|
|
5488
|
+
/**
|
|
5489
|
+
* Details of a refunded payment.
|
|
5490
|
+
*
|
|
5491
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5492
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5493
|
+
* @internal
|
|
5494
|
+
*/
|
|
5495
|
+
paymentRefunded?: PaymentRefunded;
|
|
5496
|
+
/**
|
|
5497
|
+
* Details of a failed payment refund.
|
|
5498
|
+
*
|
|
5499
|
+
* > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.
|
|
5500
|
+
* > In these cases, the `refund_id` will be identical across the activities.
|
|
5501
|
+
* @internal
|
|
5502
|
+
*/
|
|
5503
|
+
paymentRefundFailed?: PaymentRefundFailed;
|
|
5504
|
+
/**
|
|
5505
|
+
* Details of refund to store credit.
|
|
5506
|
+
* @internal
|
|
5507
|
+
*/
|
|
5508
|
+
refundedAsStoreCredit?: RefundedAsStoreCredit;
|
|
5134
5509
|
/** Details of a pending payment */
|
|
5135
5510
|
paymentPending?: PaymentPending;
|
|
5136
5511
|
/** Details of a canceled payment */
|
|
@@ -5141,65 +5516,75 @@ export interface InternalActivityContentOneOf {
|
|
|
5141
5516
|
orderPending?: OrderPending;
|
|
5142
5517
|
/** Order rejected */
|
|
5143
5518
|
orderRejected?: OrderRejected;
|
|
5519
|
+
/**
|
|
5520
|
+
* Receipt was added for associated payment
|
|
5521
|
+
* @internal
|
|
5522
|
+
*/
|
|
5523
|
+
receiptCreated?: ReceiptCreated;
|
|
5524
|
+
/**
|
|
5525
|
+
* Receipt sent to customer
|
|
5526
|
+
* @internal
|
|
5527
|
+
*/
|
|
5528
|
+
receiptSent?: ReceiptSent;
|
|
5144
5529
|
}
|
|
5145
5530
|
/** Order placed */
|
|
5146
|
-
|
|
5531
|
+
interface OrderPlaced {
|
|
5147
5532
|
}
|
|
5148
5533
|
/** Order marked as paid, either by the store owner (for offline orders), or when an online transaction was confirmed */
|
|
5149
|
-
|
|
5534
|
+
interface OrderPaid {
|
|
5150
5535
|
}
|
|
5151
5536
|
/** Order shipping status set as fulfilled */
|
|
5152
|
-
|
|
5537
|
+
interface OrderFulfilled {
|
|
5153
5538
|
}
|
|
5154
5539
|
/** Order shipping status set as not fulfilled */
|
|
5155
|
-
|
|
5540
|
+
interface OrderNotFulfilled {
|
|
5156
5541
|
}
|
|
5157
5542
|
/** Order canceled */
|
|
5158
|
-
|
|
5543
|
+
interface OrderCanceled {
|
|
5159
5544
|
}
|
|
5160
5545
|
/** A download link was sent (relevant for orders with digital line items) */
|
|
5161
|
-
|
|
5546
|
+
interface DownloadLinkSent {
|
|
5162
5547
|
}
|
|
5163
5548
|
/** Shipping tracking number was set */
|
|
5164
|
-
|
|
5549
|
+
interface TrackingNumberAdded {
|
|
5165
5550
|
}
|
|
5166
5551
|
/** Shipping tracking number was edited */
|
|
5167
|
-
|
|
5552
|
+
interface TrackingNumberEdited {
|
|
5168
5553
|
}
|
|
5169
5554
|
/** Shipping tracking link was set */
|
|
5170
|
-
|
|
5555
|
+
interface TrackingLinkAdded {
|
|
5171
5556
|
}
|
|
5172
5557
|
/** An email confirmation of order shipment was sent */
|
|
5173
|
-
|
|
5558
|
+
interface ShippingConfirmationEmailSent {
|
|
5174
5559
|
}
|
|
5175
5560
|
/** Invoice was set in the order */
|
|
5176
|
-
|
|
5561
|
+
interface InvoiceAdded {
|
|
5177
5562
|
}
|
|
5178
5563
|
/** Invoice sent to customer via email */
|
|
5179
|
-
|
|
5564
|
+
interface InvoiceSent {
|
|
5180
5565
|
}
|
|
5181
5566
|
/** Email was sent to fulfiller */
|
|
5182
|
-
|
|
5567
|
+
interface FulfillerEmailSent {
|
|
5183
5568
|
}
|
|
5184
5569
|
/** Shipping address was updated */
|
|
5185
|
-
|
|
5570
|
+
interface ShippingAddressEdited {
|
|
5186
5571
|
}
|
|
5187
5572
|
/** Order email was updated */
|
|
5188
|
-
|
|
5573
|
+
interface EmailEdited {
|
|
5189
5574
|
}
|
|
5190
5575
|
/** An email notification for pickup was sent */
|
|
5191
|
-
|
|
5576
|
+
interface PickupReadyEmailSent {
|
|
5192
5577
|
}
|
|
5193
5578
|
/** Order marked as partially paid when an online transaction was confirmed with partial minimal required amount of total sum */
|
|
5194
|
-
|
|
5579
|
+
interface OrderPartiallyPaid {
|
|
5195
5580
|
}
|
|
5196
5581
|
/** Order reject */
|
|
5197
|
-
|
|
5582
|
+
interface OrderPending {
|
|
5198
5583
|
}
|
|
5199
5584
|
/** Order reject */
|
|
5200
|
-
|
|
5585
|
+
interface OrderRejected {
|
|
5201
5586
|
}
|
|
5202
|
-
|
|
5587
|
+
interface AddInternalActivityResponse {
|
|
5203
5588
|
/** Updated order. */
|
|
5204
5589
|
order?: Order;
|
|
5205
5590
|
/**
|
|
@@ -5209,7 +5594,7 @@ export interface AddInternalActivityResponse {
|
|
|
5209
5594
|
*/
|
|
5210
5595
|
activityId?: string;
|
|
5211
5596
|
}
|
|
5212
|
-
|
|
5597
|
+
interface AddActivityRequest {
|
|
5213
5598
|
/**
|
|
5214
5599
|
* Order ID.
|
|
5215
5600
|
* @minLength 1
|
|
@@ -5219,20 +5604,20 @@ export interface AddActivityRequest {
|
|
|
5219
5604
|
/** Activity info. */
|
|
5220
5605
|
activity: PublicActivity;
|
|
5221
5606
|
}
|
|
5222
|
-
|
|
5607
|
+
interface PublicActivity extends PublicActivityContentOneOf {
|
|
5223
5608
|
/** Custom activity details. */
|
|
5224
5609
|
customActivity?: CustomActivity;
|
|
5225
5610
|
/** Merchant commment. */
|
|
5226
5611
|
merchantComment?: MerchantComment;
|
|
5227
5612
|
}
|
|
5228
5613
|
/** @oneof */
|
|
5229
|
-
|
|
5614
|
+
interface PublicActivityContentOneOf {
|
|
5230
5615
|
/** Custom activity details. */
|
|
5231
5616
|
customActivity?: CustomActivity;
|
|
5232
5617
|
/** Merchant commment. */
|
|
5233
5618
|
merchantComment?: MerchantComment;
|
|
5234
5619
|
}
|
|
5235
|
-
|
|
5620
|
+
interface AddActivityResponse {
|
|
5236
5621
|
/** Updated order. */
|
|
5237
5622
|
order?: Order;
|
|
5238
5623
|
/**
|
|
@@ -5242,7 +5627,7 @@ export interface AddActivityResponse {
|
|
|
5242
5627
|
*/
|
|
5243
5628
|
activityId?: string;
|
|
5244
5629
|
}
|
|
5245
|
-
|
|
5630
|
+
interface AddActivitiesRequest {
|
|
5246
5631
|
/**
|
|
5247
5632
|
* Order ID.
|
|
5248
5633
|
* @format GUID
|
|
@@ -5255,7 +5640,7 @@ export interface AddActivitiesRequest {
|
|
|
5255
5640
|
*/
|
|
5256
5641
|
activities?: PublicActivity[];
|
|
5257
5642
|
}
|
|
5258
|
-
|
|
5643
|
+
interface AddActivitiesResponse {
|
|
5259
5644
|
/** Updated order. */
|
|
5260
5645
|
order?: Order;
|
|
5261
5646
|
/**
|
|
@@ -5265,7 +5650,7 @@ export interface AddActivitiesResponse {
|
|
|
5265
5650
|
*/
|
|
5266
5651
|
activityIds?: string[];
|
|
5267
5652
|
}
|
|
5268
|
-
|
|
5653
|
+
interface UpdateActivityRequest {
|
|
5269
5654
|
/**
|
|
5270
5655
|
* Order ID.
|
|
5271
5656
|
* @minLength 1
|
|
@@ -5280,11 +5665,11 @@ export interface UpdateActivityRequest {
|
|
|
5280
5665
|
/** Activity info. */
|
|
5281
5666
|
activity: PublicActivity;
|
|
5282
5667
|
}
|
|
5283
|
-
|
|
5668
|
+
interface UpdateActivityResponse {
|
|
5284
5669
|
/** Updated order. */
|
|
5285
5670
|
order?: Order;
|
|
5286
5671
|
}
|
|
5287
|
-
|
|
5672
|
+
interface DeleteActivityRequest {
|
|
5288
5673
|
/**
|
|
5289
5674
|
* Order ID.
|
|
5290
5675
|
* @minLength 1
|
|
@@ -5297,11 +5682,11 @@ export interface DeleteActivityRequest {
|
|
|
5297
5682
|
*/
|
|
5298
5683
|
activityId: string;
|
|
5299
5684
|
}
|
|
5300
|
-
|
|
5685
|
+
interface DeleteActivityResponse {
|
|
5301
5686
|
/** Updated order. */
|
|
5302
5687
|
order?: Order;
|
|
5303
5688
|
}
|
|
5304
|
-
|
|
5689
|
+
interface UpdateLineItemsDescriptionLinesRequest {
|
|
5305
5690
|
/**
|
|
5306
5691
|
* Order ID.
|
|
5307
5692
|
* @minLength 1
|
|
@@ -5315,7 +5700,7 @@ export interface UpdateLineItemsDescriptionLinesRequest {
|
|
|
5315
5700
|
*/
|
|
5316
5701
|
lineItems?: LineItemUpdate[];
|
|
5317
5702
|
}
|
|
5318
|
-
|
|
5703
|
+
interface LineItemUpdate {
|
|
5319
5704
|
/**
|
|
5320
5705
|
* Line item ID.
|
|
5321
5706
|
* @format GUID
|
|
@@ -5329,11 +5714,11 @@ export interface LineItemUpdate {
|
|
|
5329
5714
|
*/
|
|
5330
5715
|
descriptionLines?: DescriptionLine[];
|
|
5331
5716
|
}
|
|
5332
|
-
|
|
5717
|
+
interface UpdateLineItemsDescriptionLinesResponse {
|
|
5333
5718
|
/** Updated order. */
|
|
5334
5719
|
order?: Order;
|
|
5335
5720
|
}
|
|
5336
|
-
|
|
5721
|
+
interface MarkOrderAsSeenByHumanRequest {
|
|
5337
5722
|
/**
|
|
5338
5723
|
* Order ID.
|
|
5339
5724
|
* @minLength 1
|
|
@@ -5341,11 +5726,11 @@ export interface MarkOrderAsSeenByHumanRequest {
|
|
|
5341
5726
|
*/
|
|
5342
5727
|
_id?: string;
|
|
5343
5728
|
}
|
|
5344
|
-
|
|
5729
|
+
interface MarkOrderAsSeenByHumanResponse {
|
|
5345
5730
|
/** Updated order. */
|
|
5346
5731
|
order?: Order;
|
|
5347
5732
|
}
|
|
5348
|
-
|
|
5733
|
+
interface CancelOrderRequest {
|
|
5349
5734
|
/**
|
|
5350
5735
|
* Order ID.
|
|
5351
5736
|
* @minLength 1
|
|
@@ -5363,11 +5748,11 @@ export interface CancelOrderRequest {
|
|
|
5363
5748
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
5364
5749
|
restockAllItems?: boolean;
|
|
5365
5750
|
}
|
|
5366
|
-
|
|
5751
|
+
interface CancelOrderResponse {
|
|
5367
5752
|
/** Canceled order. */
|
|
5368
5753
|
order?: Order;
|
|
5369
5754
|
}
|
|
5370
|
-
|
|
5755
|
+
interface OrderCanceledEventOrderCanceled {
|
|
5371
5756
|
/** The order that was cancelled */
|
|
5372
5757
|
order?: Order;
|
|
5373
5758
|
/** Should restock all items on that order */
|
|
@@ -5377,7 +5762,7 @@ export interface OrderCanceledEventOrderCanceled {
|
|
|
5377
5762
|
/** Personal note added to the email */
|
|
5378
5763
|
customMessage?: string | null;
|
|
5379
5764
|
}
|
|
5380
|
-
|
|
5765
|
+
interface UpdateOrderStatusRequest {
|
|
5381
5766
|
/**
|
|
5382
5767
|
* Order ID.
|
|
5383
5768
|
* @format GUID
|
|
@@ -5386,11 +5771,11 @@ export interface UpdateOrderStatusRequest {
|
|
|
5386
5771
|
/** New order status. */
|
|
5387
5772
|
status: OrderStatus;
|
|
5388
5773
|
}
|
|
5389
|
-
|
|
5774
|
+
interface UpdateOrderStatusResponse {
|
|
5390
5775
|
/** Updated order. */
|
|
5391
5776
|
order?: Order;
|
|
5392
5777
|
}
|
|
5393
|
-
|
|
5778
|
+
interface MarkAsFulfilledRequest {
|
|
5394
5779
|
/**
|
|
5395
5780
|
* Order ID.
|
|
5396
5781
|
* @minLength 1
|
|
@@ -5398,12 +5783,12 @@ export interface MarkAsFulfilledRequest {
|
|
|
5398
5783
|
*/
|
|
5399
5784
|
_id?: string;
|
|
5400
5785
|
}
|
|
5401
|
-
|
|
5786
|
+
interface MarkAsFulfilledResponse {
|
|
5402
5787
|
/** Updated order. */
|
|
5403
5788
|
order?: Order;
|
|
5404
5789
|
}
|
|
5405
5790
|
/** Triggered when the fulfillment status of an order is updated */
|
|
5406
|
-
|
|
5791
|
+
interface FulfillmentStatusUpdated {
|
|
5407
5792
|
/** The order that was updated */
|
|
5408
5793
|
order?: Order;
|
|
5409
5794
|
/** The previous status (before the update) */
|
|
@@ -5413,7 +5798,7 @@ export interface FulfillmentStatusUpdated {
|
|
|
5413
5798
|
/** the action that caused this update */
|
|
5414
5799
|
action?: string;
|
|
5415
5800
|
}
|
|
5416
|
-
|
|
5801
|
+
interface BulkMarkAsFulfilledRequest {
|
|
5417
5802
|
/**
|
|
5418
5803
|
* IDs of orders to be marked as fulfilled.
|
|
5419
5804
|
* @minSize 1
|
|
@@ -5423,23 +5808,23 @@ export interface BulkMarkAsFulfilledRequest {
|
|
|
5423
5808
|
/** Whether to return the full updated order entities in the response. */
|
|
5424
5809
|
returnFullEntity?: boolean;
|
|
5425
5810
|
}
|
|
5426
|
-
|
|
5811
|
+
interface BulkMarkAsFulfilledResponse {
|
|
5427
5812
|
/** Items updated by bulk action. */
|
|
5428
5813
|
results?: BulkOrderResult[];
|
|
5429
5814
|
/** Bulk action metadata. */
|
|
5430
5815
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5431
5816
|
}
|
|
5432
|
-
|
|
5817
|
+
interface BulkMarkAsFulfilledByFilterRequest {
|
|
5433
5818
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
5434
5819
|
filter?: Record<string, any> | null;
|
|
5435
5820
|
}
|
|
5436
|
-
|
|
5821
|
+
interface BulkMarkAsFulfilledByFilterResponse {
|
|
5437
5822
|
/** Items updated by bulk action. */
|
|
5438
5823
|
results?: BulkOrderResult[];
|
|
5439
5824
|
/** Bulk action metadata. */
|
|
5440
5825
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5441
5826
|
}
|
|
5442
|
-
|
|
5827
|
+
interface MarkAsUnfulfilledRequest {
|
|
5443
5828
|
/**
|
|
5444
5829
|
* Order ID.
|
|
5445
5830
|
* @minLength 1
|
|
@@ -5447,11 +5832,11 @@ export interface MarkAsUnfulfilledRequest {
|
|
|
5447
5832
|
*/
|
|
5448
5833
|
_id?: string;
|
|
5449
5834
|
}
|
|
5450
|
-
|
|
5835
|
+
interface MarkAsUnfulfilledResponse {
|
|
5451
5836
|
/** Updated order. */
|
|
5452
5837
|
order?: Order;
|
|
5453
5838
|
}
|
|
5454
|
-
|
|
5839
|
+
interface BulkMarkAsUnfulfilledRequest {
|
|
5455
5840
|
/**
|
|
5456
5841
|
* IDs of orders to be marked as not fulfilled.
|
|
5457
5842
|
* @minSize 1
|
|
@@ -5461,23 +5846,23 @@ export interface BulkMarkAsUnfulfilledRequest {
|
|
|
5461
5846
|
/** Whether to return the full updated order entities in the response. */
|
|
5462
5847
|
returnFullEntity?: boolean;
|
|
5463
5848
|
}
|
|
5464
|
-
|
|
5849
|
+
interface BulkMarkAsUnfulfilledResponse {
|
|
5465
5850
|
/** Items updated by bulk action. */
|
|
5466
5851
|
results?: BulkOrderResult[];
|
|
5467
5852
|
/** Bulk action metadata. */
|
|
5468
5853
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5469
5854
|
}
|
|
5470
|
-
|
|
5855
|
+
interface BulkMarkAsUnfulfilledByFilterRequest {
|
|
5471
5856
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
5472
5857
|
filter?: Record<string, any> | null;
|
|
5473
5858
|
}
|
|
5474
|
-
|
|
5859
|
+
interface BulkMarkAsUnfulfilledByFilterResponse {
|
|
5475
5860
|
/** Items updated by bulk action. */
|
|
5476
5861
|
results?: BulkOrderResult[];
|
|
5477
5862
|
/** Bulk action metadata. */
|
|
5478
5863
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5479
5864
|
}
|
|
5480
|
-
|
|
5865
|
+
interface BulkSetBusinessLocationRequest {
|
|
5481
5866
|
/**
|
|
5482
5867
|
* IDs of orders to update location for.
|
|
5483
5868
|
* @minSize 1
|
|
@@ -5488,7 +5873,7 @@ export interface BulkSetBusinessLocationRequest {
|
|
|
5488
5873
|
/** Business location. */
|
|
5489
5874
|
businessLocation?: Location;
|
|
5490
5875
|
}
|
|
5491
|
-
|
|
5876
|
+
interface BulkSetBusinessLocationResponse {
|
|
5492
5877
|
/**
|
|
5493
5878
|
* Bulk action results.
|
|
5494
5879
|
* @minSize 1
|
|
@@ -5498,10 +5883,10 @@ export interface BulkSetBusinessLocationResponse {
|
|
|
5498
5883
|
/** Bulk action metadata. */
|
|
5499
5884
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5500
5885
|
}
|
|
5501
|
-
|
|
5886
|
+
interface BulkSetBusinessLocationResult {
|
|
5502
5887
|
itemMetadata?: ItemMetadata;
|
|
5503
5888
|
}
|
|
5504
|
-
|
|
5889
|
+
interface V1MarkOrderAsPaidRequest {
|
|
5505
5890
|
/**
|
|
5506
5891
|
* Order ID.
|
|
5507
5892
|
* @minLength 1
|
|
@@ -5509,11 +5894,11 @@ export interface V1MarkOrderAsPaidRequest {
|
|
|
5509
5894
|
*/
|
|
5510
5895
|
_id?: string;
|
|
5511
5896
|
}
|
|
5512
|
-
|
|
5897
|
+
interface V1MarkOrderAsPaidResponse {
|
|
5513
5898
|
/** Updated order. */
|
|
5514
5899
|
order?: Order;
|
|
5515
5900
|
}
|
|
5516
|
-
|
|
5901
|
+
interface V1BulkMarkOrdersAsPaidRequest {
|
|
5517
5902
|
/**
|
|
5518
5903
|
* IDs of orders to mark as paid.
|
|
5519
5904
|
* @minSize 1
|
|
@@ -5523,7 +5908,7 @@ export interface V1BulkMarkOrdersAsPaidRequest {
|
|
|
5523
5908
|
*/
|
|
5524
5909
|
ids?: string[];
|
|
5525
5910
|
}
|
|
5526
|
-
|
|
5911
|
+
interface V1BulkMarkOrdersAsPaidResponse {
|
|
5527
5912
|
/**
|
|
5528
5913
|
* Items updated by the bulk action.
|
|
5529
5914
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -5532,7 +5917,7 @@ export interface V1BulkMarkOrdersAsPaidResponse {
|
|
|
5532
5917
|
/** Bulk action metadata. */
|
|
5533
5918
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5534
5919
|
}
|
|
5535
|
-
|
|
5920
|
+
interface V1CreatePaymentGatewayOrderRequest {
|
|
5536
5921
|
/**
|
|
5537
5922
|
* eCom Order ID
|
|
5538
5923
|
* @minLength 1
|
|
@@ -5540,21 +5925,21 @@ export interface V1CreatePaymentGatewayOrderRequest {
|
|
|
5540
5925
|
*/
|
|
5541
5926
|
ecomOrderId?: string;
|
|
5542
5927
|
}
|
|
5543
|
-
|
|
5928
|
+
interface V1CreatePaymentGatewayOrderResponse {
|
|
5544
5929
|
/** ID of the order created in the payment gateway */
|
|
5545
5930
|
paymentGatewayOrderId?: string;
|
|
5546
5931
|
}
|
|
5547
|
-
|
|
5932
|
+
interface GetShipmentsRequest {
|
|
5548
5933
|
/**
|
|
5549
5934
|
* @minLength 1
|
|
5550
5935
|
* @maxLength 100
|
|
5551
5936
|
*/
|
|
5552
5937
|
_id?: string;
|
|
5553
5938
|
}
|
|
5554
|
-
|
|
5939
|
+
interface GetShipmentsResponse {
|
|
5555
5940
|
shipmentIds?: string[];
|
|
5556
5941
|
}
|
|
5557
|
-
|
|
5942
|
+
interface AggregateOrdersRequest {
|
|
5558
5943
|
/** Filter applied to original data */
|
|
5559
5944
|
filter?: Record<string, any> | null;
|
|
5560
5945
|
/** This is an object defining aggregation itself */
|
|
@@ -5570,10 +5955,10 @@ export interface AggregateOrdersRequest {
|
|
|
5570
5955
|
*/
|
|
5571
5956
|
hierarchySeparatorOverride?: string | null;
|
|
5572
5957
|
}
|
|
5573
|
-
|
|
5958
|
+
interface AggregateOrdersResponse {
|
|
5574
5959
|
aggregates?: Record<string, any> | null;
|
|
5575
5960
|
}
|
|
5576
|
-
|
|
5961
|
+
interface DecrementItemsQuantityRequest {
|
|
5577
5962
|
/**
|
|
5578
5963
|
* Order ID
|
|
5579
5964
|
* @minLength 1
|
|
@@ -5587,7 +5972,7 @@ export interface DecrementItemsQuantityRequest {
|
|
|
5587
5972
|
*/
|
|
5588
5973
|
decrementData?: DecrementData[];
|
|
5589
5974
|
}
|
|
5590
|
-
|
|
5975
|
+
interface DecrementData {
|
|
5591
5976
|
/**
|
|
5592
5977
|
* ID of the line item being decremented.
|
|
5593
5978
|
* @format GUID
|
|
@@ -5602,11 +5987,11 @@ export interface DecrementData {
|
|
|
5602
5987
|
/** Whether to restock the line item (triggers inventory update). */
|
|
5603
5988
|
restock?: boolean;
|
|
5604
5989
|
}
|
|
5605
|
-
|
|
5990
|
+
interface DecrementItemsQuantityResponse {
|
|
5606
5991
|
/** Updated order data */
|
|
5607
5992
|
order?: Order;
|
|
5608
5993
|
}
|
|
5609
|
-
|
|
5994
|
+
interface BulkUpdateOrderTagsRequest {
|
|
5610
5995
|
/**
|
|
5611
5996
|
* IDs of orders to update tags for.
|
|
5612
5997
|
* @minSize 1
|
|
@@ -5619,7 +6004,7 @@ export interface BulkUpdateOrderTagsRequest {
|
|
|
5619
6004
|
/** Tags to be removed from orders */
|
|
5620
6005
|
unassignTags?: Tags;
|
|
5621
6006
|
}
|
|
5622
|
-
|
|
6007
|
+
interface BulkUpdateOrderTagsResponse {
|
|
5623
6008
|
/**
|
|
5624
6009
|
* @minSize 1
|
|
5625
6010
|
* @maxSize 100
|
|
@@ -5627,51 +6012,51 @@ export interface BulkUpdateOrderTagsResponse {
|
|
|
5627
6012
|
results?: BulkUpdateOrderTagsResult[];
|
|
5628
6013
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5629
6014
|
}
|
|
5630
|
-
|
|
6015
|
+
interface BulkUpdateOrderTagsResult {
|
|
5631
6016
|
itemMetadata?: ItemMetadata;
|
|
5632
6017
|
}
|
|
5633
|
-
|
|
6018
|
+
interface Task {
|
|
5634
6019
|
key?: TaskKey;
|
|
5635
6020
|
executeAt?: Date | null;
|
|
5636
6021
|
payload?: string | null;
|
|
5637
6022
|
}
|
|
5638
|
-
|
|
6023
|
+
interface TaskKey {
|
|
5639
6024
|
appId?: string;
|
|
5640
6025
|
instanceId?: string;
|
|
5641
6026
|
subjectId?: string | null;
|
|
5642
6027
|
}
|
|
5643
|
-
|
|
6028
|
+
interface TaskAction extends TaskActionActionOneOf {
|
|
5644
6029
|
complete?: Complete;
|
|
5645
6030
|
cancel?: Cancel;
|
|
5646
6031
|
reschedule?: Reschedule;
|
|
5647
6032
|
}
|
|
5648
6033
|
/** @oneof */
|
|
5649
|
-
|
|
6034
|
+
interface TaskActionActionOneOf {
|
|
5650
6035
|
complete?: Complete;
|
|
5651
6036
|
cancel?: Cancel;
|
|
5652
6037
|
reschedule?: Reschedule;
|
|
5653
6038
|
}
|
|
5654
|
-
|
|
6039
|
+
interface Complete {
|
|
5655
6040
|
}
|
|
5656
|
-
|
|
6041
|
+
interface Cancel {
|
|
5657
6042
|
}
|
|
5658
|
-
|
|
6043
|
+
interface Reschedule {
|
|
5659
6044
|
executeAt?: Date | null;
|
|
5660
6045
|
payload?: string | null;
|
|
5661
6046
|
}
|
|
5662
|
-
|
|
6047
|
+
interface InvoiceSentEvent {
|
|
5663
6048
|
_id?: IdAndVersion;
|
|
5664
6049
|
/** @readonly */
|
|
5665
6050
|
data?: InvoiceFields;
|
|
5666
6051
|
/** @readonly */
|
|
5667
6052
|
status?: InvoiceStatus;
|
|
5668
6053
|
}
|
|
5669
|
-
|
|
6054
|
+
interface IdAndVersion {
|
|
5670
6055
|
/** @format GUID */
|
|
5671
6056
|
_id?: string | null;
|
|
5672
6057
|
version?: number | null;
|
|
5673
6058
|
}
|
|
5674
|
-
|
|
6059
|
+
interface InvoiceFields {
|
|
5675
6060
|
/** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
|
|
5676
6061
|
number?: string | null;
|
|
5677
6062
|
/**
|
|
@@ -5742,7 +6127,7 @@ export interface InvoiceFields {
|
|
|
5742
6127
|
/** Associated checkout for this invoice */
|
|
5743
6128
|
ecomCheckoutId?: string | null;
|
|
5744
6129
|
}
|
|
5745
|
-
|
|
6130
|
+
interface Customer {
|
|
5746
6131
|
contactId?: string | null;
|
|
5747
6132
|
name?: string | null;
|
|
5748
6133
|
email?: Email;
|
|
@@ -5754,10 +6139,10 @@ export interface Customer {
|
|
|
5754
6139
|
billingAddress?: CommonAddress;
|
|
5755
6140
|
shippingAddress?: CommonAddress;
|
|
5756
6141
|
}
|
|
5757
|
-
|
|
6142
|
+
interface Email {
|
|
5758
6143
|
address?: string;
|
|
5759
6144
|
}
|
|
5760
|
-
|
|
6145
|
+
interface QuotesAddress {
|
|
5761
6146
|
street?: string | null;
|
|
5762
6147
|
city?: string | null;
|
|
5763
6148
|
zip?: string | null;
|
|
@@ -5766,25 +6151,25 @@ export interface QuotesAddress {
|
|
|
5766
6151
|
/** @readonly */
|
|
5767
6152
|
description?: AddressDescription;
|
|
5768
6153
|
}
|
|
5769
|
-
|
|
6154
|
+
interface AddressDescription {
|
|
5770
6155
|
content?: string;
|
|
5771
6156
|
placement?: Placement;
|
|
5772
6157
|
}
|
|
5773
|
-
|
|
6158
|
+
declare enum Placement {
|
|
5774
6159
|
Unknown = "Unknown",
|
|
5775
6160
|
Replace = "Replace",
|
|
5776
6161
|
Before = "Before",
|
|
5777
6162
|
After = "After"
|
|
5778
6163
|
}
|
|
5779
|
-
|
|
6164
|
+
interface Phone {
|
|
5780
6165
|
number?: string;
|
|
5781
6166
|
}
|
|
5782
|
-
|
|
6167
|
+
interface Company {
|
|
5783
6168
|
name?: string;
|
|
5784
6169
|
_id?: string | null;
|
|
5785
6170
|
}
|
|
5786
6171
|
/** Physical address */
|
|
5787
|
-
|
|
6172
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
5788
6173
|
/** Street name and number. */
|
|
5789
6174
|
streetAddress?: StreetAddress;
|
|
5790
6175
|
/** Main address line, usually street and number as free text. */
|
|
@@ -5804,19 +6189,19 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
5804
6189
|
addressLine2?: string | null;
|
|
5805
6190
|
}
|
|
5806
6191
|
/** @oneof */
|
|
5807
|
-
|
|
6192
|
+
interface CommonAddressStreetOneOf {
|
|
5808
6193
|
/** Street name and number. */
|
|
5809
6194
|
streetAddress?: StreetAddress;
|
|
5810
6195
|
/** Main address line, usually street and number as free text. */
|
|
5811
6196
|
addressLine?: string | null;
|
|
5812
6197
|
}
|
|
5813
|
-
|
|
6198
|
+
interface Subdivision {
|
|
5814
6199
|
/** Short subdivision code. */
|
|
5815
6200
|
code?: string;
|
|
5816
6201
|
/** Subdivision full name. */
|
|
5817
6202
|
name?: string;
|
|
5818
6203
|
}
|
|
5819
|
-
|
|
6204
|
+
declare enum SubdivisionType {
|
|
5820
6205
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
5821
6206
|
/** State */
|
|
5822
6207
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -5832,14 +6217,14 @@ export declare enum SubdivisionType {
|
|
|
5832
6217
|
COUNTRY = "COUNTRY"
|
|
5833
6218
|
}
|
|
5834
6219
|
/** Subdivision Concordance values */
|
|
5835
|
-
|
|
6220
|
+
interface StandardDetails {
|
|
5836
6221
|
/**
|
|
5837
6222
|
* 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
|
|
5838
6223
|
* @maxLength 20
|
|
5839
6224
|
*/
|
|
5840
6225
|
iso31662?: string | null;
|
|
5841
6226
|
}
|
|
5842
|
-
|
|
6227
|
+
interface InvoiceDates {
|
|
5843
6228
|
/** use UTC midnight date to set the issue date according to the site time zone */
|
|
5844
6229
|
issueDate?: Date | null;
|
|
5845
6230
|
/** use UTC midnight date to set the due date according to the site time zone */
|
|
@@ -5852,10 +6237,10 @@ export interface InvoiceDates {
|
|
|
5852
6237
|
*/
|
|
5853
6238
|
lastSeenDate?: Date | null;
|
|
5854
6239
|
}
|
|
5855
|
-
|
|
6240
|
+
interface LineItems {
|
|
5856
6241
|
lineItems?: LineItem[];
|
|
5857
6242
|
}
|
|
5858
|
-
|
|
6243
|
+
interface LineItem {
|
|
5859
6244
|
/** @format GUID */
|
|
5860
6245
|
_id?: string;
|
|
5861
6246
|
name?: string;
|
|
@@ -5869,15 +6254,15 @@ export interface LineItem {
|
|
|
5869
6254
|
/** The line-item level metadata. */
|
|
5870
6255
|
metadata?: LineItemMetaData;
|
|
5871
6256
|
}
|
|
5872
|
-
|
|
6257
|
+
interface BigDecimalWrapper {
|
|
5873
6258
|
serializedValue?: number;
|
|
5874
6259
|
}
|
|
5875
|
-
|
|
6260
|
+
interface LineItemTax {
|
|
5876
6261
|
name?: string;
|
|
5877
6262
|
rate?: BigDecimalWrapper;
|
|
5878
6263
|
code?: string | null;
|
|
5879
6264
|
}
|
|
5880
|
-
|
|
6265
|
+
interface Source {
|
|
5881
6266
|
/**
|
|
5882
6267
|
* Source app or service ID.
|
|
5883
6268
|
* @readonly
|
|
@@ -5889,24 +6274,24 @@ export interface Source {
|
|
|
5889
6274
|
*/
|
|
5890
6275
|
sourceType?: SourceType;
|
|
5891
6276
|
}
|
|
5892
|
-
|
|
6277
|
+
declare enum SourceType {
|
|
5893
6278
|
UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
|
|
5894
6279
|
WIX_APP = "WIX_APP",
|
|
5895
6280
|
EXTERNAL = "EXTERNAL",
|
|
5896
6281
|
ADMIN = "ADMIN",
|
|
5897
6282
|
OTHER = "OTHER"
|
|
5898
6283
|
}
|
|
5899
|
-
|
|
6284
|
+
interface LineItemMetaData {
|
|
5900
6285
|
metadata?: Record<string, string>;
|
|
5901
6286
|
}
|
|
5902
|
-
|
|
6287
|
+
interface Locale {
|
|
5903
6288
|
/** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
|
|
5904
6289
|
language?: string;
|
|
5905
6290
|
/** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
|
|
5906
6291
|
country?: string | null;
|
|
5907
6292
|
invariant?: string | null;
|
|
5908
6293
|
}
|
|
5909
|
-
|
|
6294
|
+
interface TotalPrice {
|
|
5910
6295
|
/** the subtotal of the line items without the tax reduction */
|
|
5911
6296
|
subtotal?: BigDecimalWrapper;
|
|
5912
6297
|
/** the total price taking into account the itemized fees and the taxes */
|
|
@@ -5915,24 +6300,24 @@ export interface TotalPrice {
|
|
|
5915
6300
|
discountAmount?: BigDecimalWrapper;
|
|
5916
6301
|
taxedAmount?: BigDecimalWrapper;
|
|
5917
6302
|
}
|
|
5918
|
-
|
|
6303
|
+
interface ItemizedFee {
|
|
5919
6304
|
name?: string;
|
|
5920
6305
|
price?: BigDecimalWrapper;
|
|
5921
6306
|
}
|
|
5922
|
-
|
|
6307
|
+
interface Discount extends DiscountOneDiscountTypeOneOf {
|
|
5923
6308
|
/** Discount as percentage value. */
|
|
5924
6309
|
percentage?: BigDecimalWrapper;
|
|
5925
6310
|
}
|
|
5926
6311
|
/** @oneof */
|
|
5927
|
-
|
|
6312
|
+
interface DiscountOneDiscountTypeOneOf {
|
|
5928
6313
|
/** Discount as percentage value. */
|
|
5929
6314
|
percentage?: BigDecimalWrapper;
|
|
5930
6315
|
}
|
|
5931
|
-
|
|
6316
|
+
interface CalculatedTaxes {
|
|
5932
6317
|
/** consider calculated or not - cannot enforce set */
|
|
5933
6318
|
taxes?: CalculatedTax[];
|
|
5934
6319
|
}
|
|
5935
|
-
|
|
6320
|
+
interface CalculatedTax {
|
|
5936
6321
|
name?: string;
|
|
5937
6322
|
rate?: BigDecimalWrapper;
|
|
5938
6323
|
/** the costs on which the taxes are applied */
|
|
@@ -5941,10 +6326,10 @@ export interface CalculatedTax {
|
|
|
5941
6326
|
taxed?: BigDecimalWrapper;
|
|
5942
6327
|
code?: string | null;
|
|
5943
6328
|
}
|
|
5944
|
-
|
|
6329
|
+
interface Payments {
|
|
5945
6330
|
payments?: InvoicesPayment[];
|
|
5946
6331
|
}
|
|
5947
|
-
|
|
6332
|
+
interface InvoicesPayment {
|
|
5948
6333
|
/** document */
|
|
5949
6334
|
_id?: string;
|
|
5950
6335
|
type?: string;
|
|
@@ -5961,7 +6346,7 @@ export interface InvoicesPayment {
|
|
|
5961
6346
|
*/
|
|
5962
6347
|
transactionId?: string | null;
|
|
5963
6348
|
}
|
|
5964
|
-
|
|
6349
|
+
interface MetaData {
|
|
5965
6350
|
notes?: string | null;
|
|
5966
6351
|
legalTerms?: string | null;
|
|
5967
6352
|
sourceUrl?: string | null;
|
|
@@ -5971,7 +6356,7 @@ export interface MetaData {
|
|
|
5971
6356
|
/** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
|
|
5972
6357
|
allowEditByOthers?: boolean | null;
|
|
5973
6358
|
}
|
|
5974
|
-
|
|
6359
|
+
interface InvoiceDynamicPriceTotals {
|
|
5975
6360
|
paidAmount?: BigDecimalWrapper;
|
|
5976
6361
|
balance?: BigDecimalWrapper;
|
|
5977
6362
|
}
|
|
@@ -5979,7 +6364,7 @@ export interface InvoiceDynamicPriceTotals {
|
|
|
5979
6364
|
* A custom field value is used to add additional data to a financial document or to a financial document template.
|
|
5980
6365
|
* The custom field value may be based on a custom field definition.
|
|
5981
6366
|
*/
|
|
5982
|
-
|
|
6367
|
+
interface CustomFieldValue {
|
|
5983
6368
|
/**
|
|
5984
6369
|
* The unique id of the custom field value
|
|
5985
6370
|
* @format GUID
|
|
@@ -6003,7 +6388,7 @@ export interface CustomFieldValue {
|
|
|
6003
6388
|
*/
|
|
6004
6389
|
originCustomFieldKey?: string | null;
|
|
6005
6390
|
}
|
|
6006
|
-
|
|
6391
|
+
declare enum CustomFieldGroup {
|
|
6007
6392
|
UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
|
|
6008
6393
|
BUSINESS_DETAILS = "BUSINESS_DETAILS",
|
|
6009
6394
|
CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
|
|
@@ -6011,18 +6396,18 @@ export declare enum CustomFieldGroup {
|
|
|
6011
6396
|
FOOTER = "FOOTER",
|
|
6012
6397
|
OTHER = "OTHER"
|
|
6013
6398
|
}
|
|
6014
|
-
|
|
6399
|
+
interface Value {
|
|
6015
6400
|
value?: string;
|
|
6016
6401
|
valueType?: ValueType;
|
|
6017
6402
|
}
|
|
6018
|
-
|
|
6403
|
+
declare enum ValueType {
|
|
6019
6404
|
UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
|
|
6020
6405
|
STRING = "STRING",
|
|
6021
6406
|
DATE = "DATE",
|
|
6022
6407
|
BOOLEAN = "BOOLEAN",
|
|
6023
6408
|
NUMBER = "NUMBER"
|
|
6024
6409
|
}
|
|
6025
|
-
|
|
6410
|
+
interface Deposit {
|
|
6026
6411
|
/**
|
|
6027
6412
|
* The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total.
|
|
6028
6413
|
* @format DECIMAL_VALUE
|
|
@@ -6040,7 +6425,7 @@ export interface Deposit {
|
|
|
6040
6425
|
/** The type of the deposit. The default is FLAT. */
|
|
6041
6426
|
type?: DepositType;
|
|
6042
6427
|
}
|
|
6043
|
-
|
|
6428
|
+
declare enum DepositType {
|
|
6044
6429
|
UNKNOWN = "UNKNOWN",
|
|
6045
6430
|
FLAT = "FLAT",
|
|
6046
6431
|
PERCENTAGE = "PERCENTAGE"
|
|
@@ -6055,7 +6440,7 @@ export declare enum DepositType {
|
|
|
6055
6440
|
* Void -> Deleted
|
|
6056
6441
|
* Deleted
|
|
6057
6442
|
*/
|
|
6058
|
-
|
|
6443
|
+
declare enum InvoiceStatus {
|
|
6059
6444
|
Draft = "Draft",
|
|
6060
6445
|
Sent = "Sent",
|
|
6061
6446
|
Processing = "Processing",
|
|
@@ -6066,12 +6451,12 @@ export declare enum InvoiceStatus {
|
|
|
6066
6451
|
PartiallyPaid = "PartiallyPaid",
|
|
6067
6452
|
PartialAndOverdue = "PartialAndOverdue"
|
|
6068
6453
|
}
|
|
6069
|
-
|
|
6454
|
+
interface TriggerSideEffectsFromLegacyData {
|
|
6070
6455
|
storeId?: string;
|
|
6071
6456
|
orderId?: string;
|
|
6072
6457
|
ordersExperiments?: OrdersExperiments;
|
|
6073
6458
|
}
|
|
6074
|
-
|
|
6459
|
+
interface BaseEventMetadata {
|
|
6075
6460
|
/**
|
|
6076
6461
|
* App instance ID.
|
|
6077
6462
|
* @format GUID
|
|
@@ -6085,7 +6470,7 @@ export interface BaseEventMetadata {
|
|
|
6085
6470
|
/** The identification type and identity data. */
|
|
6086
6471
|
identity?: IdentificationData;
|
|
6087
6472
|
}
|
|
6088
|
-
|
|
6473
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
6089
6474
|
/**
|
|
6090
6475
|
* Unique event ID.
|
|
6091
6476
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -6123,141 +6508,23 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
6123
6508
|
*/
|
|
6124
6509
|
entityEventSequence?: string | null;
|
|
6125
6510
|
}
|
|
6126
|
-
|
|
6511
|
+
interface OrderApprovedEnvelope {
|
|
6127
6512
|
data: OrderApproved;
|
|
6128
6513
|
metadata: EventMetadata;
|
|
6129
6514
|
}
|
|
6130
|
-
|
|
6131
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6132
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6133
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6134
|
-
* @permissionScope Read Orders
|
|
6135
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6136
|
-
* @permissionScope Read Stores - all read permissions
|
|
6137
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6138
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6139
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6140
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6141
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6142
|
-
* @permissionScope Picasso private app mega scope
|
|
6143
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6144
|
-
* @permissionScope Manage Orders
|
|
6145
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6146
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6147
|
-
* @webhook
|
|
6148
|
-
* @eventType wix.ecom.v1.order_approved
|
|
6149
|
-
* @slug approved
|
|
6150
|
-
*/
|
|
6151
|
-
export declare function onOrderApproved(handler: (event: OrderApprovedEnvelope) => void | Promise<void>): void;
|
|
6152
|
-
export interface OrderUpdatedEnvelope {
|
|
6515
|
+
interface OrderUpdatedEnvelope {
|
|
6153
6516
|
entity: Order;
|
|
6154
6517
|
metadata: EventMetadata;
|
|
6155
6518
|
}
|
|
6156
|
-
|
|
6157
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6158
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6159
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6160
|
-
* @permissionScope Read Orders
|
|
6161
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6162
|
-
* @permissionScope Read Stores - all read permissions
|
|
6163
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6164
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6165
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6166
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6167
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6168
|
-
* @permissionScope Picasso private app mega scope
|
|
6169
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6170
|
-
* @permissionScope Manage Orders
|
|
6171
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6172
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6173
|
-
* @webhook
|
|
6174
|
-
* @eventType wix.ecom.v1.order_updated
|
|
6175
|
-
* @slug updated
|
|
6176
|
-
*/
|
|
6177
|
-
export declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
6178
|
-
export interface OrderCanceledEnvelope {
|
|
6519
|
+
interface OrderCanceledEnvelope {
|
|
6179
6520
|
data: OrderCanceledEventOrderCanceled;
|
|
6180
6521
|
metadata: EventMetadata;
|
|
6181
6522
|
}
|
|
6182
|
-
|
|
6183
|
-
* Triggered when an order is canceled.
|
|
6184
|
-
* Learn more about [eCommerce webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
6185
|
-
* @permissionScope Manage Stores - all permissions
|
|
6186
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6187
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6188
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6189
|
-
* @permissionScope Read Orders
|
|
6190
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6191
|
-
* @permissionScope Read Stores - all read permissions
|
|
6192
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6193
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6194
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6195
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6196
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6197
|
-
* @permissionScope Picasso private app mega scope
|
|
6198
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6199
|
-
* @permissionScope Manage Orders
|
|
6200
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6201
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6202
|
-
* @webhook
|
|
6203
|
-
* @eventType wix.ecom.v1.order_canceled
|
|
6204
|
-
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
6205
|
-
* @slug canceled
|
|
6206
|
-
*/
|
|
6207
|
-
export declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
6208
|
-
export interface OrderCreatedEnvelope {
|
|
6523
|
+
interface OrderCreatedEnvelope {
|
|
6209
6524
|
entity: Order;
|
|
6210
6525
|
metadata: EventMetadata;
|
|
6211
6526
|
}
|
|
6212
|
-
|
|
6213
|
-
* Triggered when an order is created.
|
|
6214
|
-
* Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
6215
|
-
* @permissionScope Manage Stores - all permissions
|
|
6216
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6217
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6218
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6219
|
-
* @permissionScope Read Orders
|
|
6220
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6221
|
-
* @permissionScope Read Stores - all read permissions
|
|
6222
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6223
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6224
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6225
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6226
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6227
|
-
* @permissionScope Picasso private app mega scope
|
|
6228
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6229
|
-
* @permissionScope Manage Orders
|
|
6230
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6231
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6232
|
-
* @webhook
|
|
6233
|
-
* @eventType wix.ecom.v1.order_created
|
|
6234
|
-
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
6235
|
-
* @slug created
|
|
6236
|
-
*/
|
|
6237
|
-
export declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
6238
|
-
type OrderNonNullablePaths = `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.descriptionLines` | `lineItems.${number}.descriptionLines.${number}.plainText.original` | `lineItems.${number}.descriptionLines.${number}.colorInfo.original` | `lineItems.${number}.descriptionLines.${number}.name.original` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.taxInfo.taxBreakdown` | `lineItems.${number}.taxInfo.taxBreakdown.${number}.jurisdictionType` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.locations` | `lineItems.${number}.locations.${number}._id` | `lineItems.${number}.locations.${number}.quantity` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `status` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `appliedDiscounts.${number}.lineItemIds` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.amount.amount` | `activities.${number}.orderRefunded.amount.formattedAmount` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `additionalFees.${number}.lineItemIds` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`;
|
|
6239
|
-
/**
|
|
6240
|
-
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
6241
|
-
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
6242
|
-
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
6243
|
-
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
6244
|
-
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
6245
|
-
* @param ecomOrderId - Ecom order ID.
|
|
6246
|
-
* @param amount - Amount to collect
|
|
6247
|
-
* @public
|
|
6248
|
-
* @documentationMaturity preview
|
|
6249
|
-
* @requiredField amount
|
|
6250
|
-
* @requiredField ecomOrderId
|
|
6251
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6252
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6253
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6254
|
-
* @permissionScope Picasso private app mega scope
|
|
6255
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6256
|
-
* @applicableIdentity APP
|
|
6257
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
6258
|
-
*/
|
|
6259
|
-
export declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`>>;
|
|
6260
|
-
export interface PreparePaymentCollectionOptions {
|
|
6527
|
+
interface PreparePaymentCollectionOptions {
|
|
6261
6528
|
/**
|
|
6262
6529
|
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
6263
6530
|
* Existing payment gateway order will be updated with a new amount.
|
|
@@ -6276,28 +6543,11 @@ export interface PreparePaymentCollectionOptions {
|
|
|
6276
6543
|
/** Delayed capture payment settings */
|
|
6277
6544
|
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
6278
6545
|
}
|
|
6279
|
-
|
|
6280
|
-
* Provides payment collectability status for given order. If payment collection is possible
|
|
6281
|
-
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
6282
|
-
* reason why payment collection is not possible.
|
|
6283
|
-
* @param ecomOrderId - Ecom order ID.
|
|
6284
|
-
* @public
|
|
6285
|
-
* @documentationMaturity preview
|
|
6286
|
-
* @requiredField ecomOrderId
|
|
6287
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6288
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6289
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6290
|
-
* @permissionScope Picasso private app mega scope
|
|
6291
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6292
|
-
* @applicableIdentity APP
|
|
6293
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
6294
|
-
*/
|
|
6295
|
-
export declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
6296
|
-
export interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6546
|
+
interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6297
6547
|
/** Information about the user who initiated the payment. */
|
|
6298
6548
|
chargedBy?: ChargedBy;
|
|
6299
6549
|
}
|
|
6300
|
-
|
|
6550
|
+
interface ChargeMembershipsOptions {
|
|
6301
6551
|
/**
|
|
6302
6552
|
* List of items to be paid by memberships
|
|
6303
6553
|
* @minSize 1
|
|
@@ -6305,231 +6555,21 @@ export interface ChargeMembershipsOptions {
|
|
|
6305
6555
|
*/
|
|
6306
6556
|
membershipCharges?: MembershipChargeItem[];
|
|
6307
6557
|
}
|
|
6308
|
-
|
|
6558
|
+
interface TriggerRefundOptions {
|
|
6309
6559
|
/** Business model of a refund */
|
|
6310
6560
|
details?: RefundDetails;
|
|
6311
6561
|
/** Side effect details related to refund */
|
|
6312
6562
|
sideEffects?: RefundSideEffects;
|
|
6313
6563
|
}
|
|
6314
|
-
|
|
6315
|
-
* Void authorized payments
|
|
6316
|
-
* Transaction statuses for related payments will be updated in async way
|
|
6317
|
-
* @param ecomOrderId - Wix eCommerce order ID
|
|
6318
|
-
* @param paymentIds - Payment IDs
|
|
6319
|
-
* @public
|
|
6320
|
-
* @documentationMaturity preview
|
|
6321
|
-
* @requiredField ecomOrderId
|
|
6322
|
-
* @requiredField paymentIds
|
|
6323
|
-
* @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
|
|
6324
|
-
* @permissionScope Manage Stores - all permissions
|
|
6325
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6326
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6327
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6328
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6329
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6330
|
-
* @permissionScope Picasso private app mega scope
|
|
6331
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6332
|
-
* @permissionScope Manage Orders
|
|
6333
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6334
|
-
* @applicableIdentity APP
|
|
6335
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
6336
|
-
*/
|
|
6337
|
-
export declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.formattedAmount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.failureDetails.failureCode` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.transactions` | `orderTransactions.refunds.${number}.transactions.${number}.paymentId` | `orderTransactions.refunds.${number}.transactions.${number}.refundStatus` | `orderTransactions.refunds.${number}.transactions.${number}.externalRefund` | `orderTransactions.refunds.${number}.details.items` | `orderTransactions.refunds.${number}.details.items.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.items.${number}.quantity` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.details.lineItems` | `orderTransactions.refunds.${number}.details.lineItems.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.lineItems.${number}.quantity` | `orderTransactions.refunds.${number}.details.additionalFees` | `orderTransactions.refunds.${number}.details.additionalFees.${number}.additionalFeeId` | `orderTransactions.refunds.${number}.summary.pending` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems.${number}.lineItemId`>>;
|
|
6338
|
-
/**
|
|
6339
|
-
* Capture authorized payments
|
|
6340
|
-
* Transaction statuses for related payments will be updated in async way
|
|
6341
|
-
* @param ecomOrderId - Wix eCommerce order ID
|
|
6342
|
-
* @param payments - Capture payments information
|
|
6343
|
-
* @public
|
|
6344
|
-
* @documentationMaturity preview
|
|
6345
|
-
* @requiredField ecomOrderId
|
|
6346
|
-
* @requiredField payments
|
|
6347
|
-
* @requiredField payments.paymentId
|
|
6348
|
-
* @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
|
|
6349
|
-
* @permissionScope Manage Stores - all permissions
|
|
6350
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6351
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6352
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6353
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6354
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6355
|
-
* @permissionScope Picasso private app mega scope
|
|
6356
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6357
|
-
* @permissionScope Manage Orders
|
|
6358
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6359
|
-
* @applicableIdentity APP
|
|
6360
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
6361
|
-
*/
|
|
6362
|
-
export declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.formattedAmount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.failureDetails.failureCode` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.transactions` | `orderTransactions.refunds.${number}.transactions.${number}.paymentId` | `orderTransactions.refunds.${number}.transactions.${number}.refundStatus` | `orderTransactions.refunds.${number}.transactions.${number}.externalRefund` | `orderTransactions.refunds.${number}.details.items` | `orderTransactions.refunds.${number}.details.items.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.items.${number}.quantity` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.details.lineItems` | `orderTransactions.refunds.${number}.details.lineItems.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.lineItems.${number}.quantity` | `orderTransactions.refunds.${number}.details.additionalFees` | `orderTransactions.refunds.${number}.details.additionalFees.${number}.additionalFeeId` | `orderTransactions.refunds.${number}.summary.pending` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems.${number}.lineItemId`>>;
|
|
6363
|
-
/**
|
|
6364
|
-
* Retrieves an order.
|
|
6365
|
-
*
|
|
6366
|
-
*
|
|
6367
|
-
* The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.
|
|
6368
|
-
*
|
|
6369
|
-
* To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to [`listTransactionsForSingleOrder( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/listtransactionsforsingleorder).
|
|
6370
|
-
* @param _id - ID of the order to retrieve.
|
|
6371
|
-
* @public
|
|
6372
|
-
* @requiredField _id
|
|
6373
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6374
|
-
* @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS
|
|
6375
|
-
* @permissionScope Manage Stores - all permissions
|
|
6376
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6377
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6378
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6379
|
-
* @permissionScope Read Orders
|
|
6380
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6381
|
-
* @permissionScope Read Stores - all read permissions
|
|
6382
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6383
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6384
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6385
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6386
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6387
|
-
* @permissionScope Picasso private app mega scope
|
|
6388
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6389
|
-
* @permissionScope Manage Orders
|
|
6390
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6391
|
-
* @applicableIdentity APP
|
|
6392
|
-
* @returns Fulfilled - The requested order.
|
|
6393
|
-
* @fqn com.wix.ecom.orders.v1.Orders.GetOrder
|
|
6394
|
-
*/
|
|
6395
|
-
export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
6396
|
-
/**
|
|
6397
|
-
* Retrieves a list of orders, given the provided paging, filtering, and sorting.
|
|
6398
|
-
*
|
|
6399
|
-
*
|
|
6400
|
-
* Search Orders runs with these defaults, which you can override:
|
|
6401
|
-
*
|
|
6402
|
-
* - `createdDate` is sorted in `DESC` order
|
|
6403
|
-
* - `cursorPaging.limit` is `100`
|
|
6404
|
-
* - `filter: {"status": {"$ne": "INITIALIZED"}}` - other order statuses can be queried, but orders with `status: "INITIALIZED"` are never returned
|
|
6405
|
-
*
|
|
6406
|
-
* For field support for filters and sorting, see [Orders: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/supported-filters-and-sorting).
|
|
6407
|
-
*
|
|
6408
|
-
* To learn about working with _Search_ endpoints, see
|
|
6409
|
-
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
|
|
6410
|
-
* [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
6411
|
-
* @public
|
|
6412
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6413
|
-
* @permissionScope Manage Stores - all permissions
|
|
6414
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6415
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6416
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6417
|
-
* @permissionScope Read Orders
|
|
6418
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6419
|
-
* @permissionScope Read Stores - all read permissions
|
|
6420
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6421
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6422
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6423
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6424
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6425
|
-
* @permissionScope Picasso private app mega scope
|
|
6426
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6427
|
-
* @permissionScope Manage Orders
|
|
6428
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6429
|
-
* @applicableIdentity APP
|
|
6430
|
-
* @fqn com.wix.ecom.orders.v1.Orders.SearchOrders
|
|
6431
|
-
*/
|
|
6432
|
-
export declare function searchOrders(options?: SearchOrdersOptions): Promise<NonNullablePaths<SearchOrdersResponse, {
|
|
6433
|
-
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
6434
|
-
}[OrderNonNullablePaths]>>;
|
|
6435
|
-
export interface SearchOrdersOptions {
|
|
6564
|
+
interface SearchOrdersOptions {
|
|
6436
6565
|
/** Search options. */
|
|
6437
6566
|
search?: CursorSearch;
|
|
6438
6567
|
}
|
|
6439
|
-
|
|
6440
|
-
* Creates an order.
|
|
6441
|
-
*
|
|
6442
|
-
*
|
|
6443
|
-
* The `createOrder()` function returns a Promise that resolves when the order is created.
|
|
6444
|
-
*
|
|
6445
|
-
* > **Notes:**
|
|
6446
|
-
* > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.
|
|
6447
|
-
* > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.
|
|
6448
|
-
* @param order - Order info.
|
|
6449
|
-
* @public
|
|
6450
|
-
* @requiredField order
|
|
6451
|
-
* @requiredField order.billingInfo.contactDetails
|
|
6452
|
-
* @requiredField order.channelInfo
|
|
6453
|
-
* @requiredField order.currencyConversionDetails.conversionRate
|
|
6454
|
-
* @requiredField order.currencyConversionDetails.originalCurrency
|
|
6455
|
-
* @requiredField order.lineItems
|
|
6456
|
-
* @requiredField order.lineItems.catalogReference.appId
|
|
6457
|
-
* @requiredField order.lineItems.catalogReference.catalogItemId
|
|
6458
|
-
* @requiredField order.lineItems.itemType
|
|
6459
|
-
* @requiredField order.lineItems.price
|
|
6460
|
-
* @requiredField order.lineItems.productName
|
|
6461
|
-
* @requiredField order.lineItems.productName.original
|
|
6462
|
-
* @requiredField order.lineItems.quantity
|
|
6463
|
-
* @requiredField order.priceSummary
|
|
6464
|
-
* @permissionId ECOM.CREATE_ORDERS
|
|
6465
|
-
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
6466
|
-
* @permissionScope Manage Stores - all permissions
|
|
6467
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6468
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6469
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6470
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6471
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6472
|
-
* @permissionScope Picasso private app mega scope
|
|
6473
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6474
|
-
* @permissionScope Manage Orders
|
|
6475
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6476
|
-
* @applicableIdentity APP
|
|
6477
|
-
* @returns Newly created order.
|
|
6478
|
-
* @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
|
|
6479
|
-
*/
|
|
6480
|
-
export declare function createOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
6481
|
-
export interface CreateOrderOptions {
|
|
6568
|
+
interface CreateOrderOptions {
|
|
6482
6569
|
/** Determine order lifecycle */
|
|
6483
6570
|
settings?: OrderCreationSettings;
|
|
6484
6571
|
}
|
|
6485
|
-
|
|
6486
|
-
* Updates an order.
|
|
6487
|
-
*
|
|
6488
|
-
*
|
|
6489
|
-
* The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.
|
|
6490
|
-
*
|
|
6491
|
-
* Currently, the following fields can be updated:
|
|
6492
|
-
* + `order.buyerInfo.email`
|
|
6493
|
-
* + `order.buyerLanguage`
|
|
6494
|
-
* + `order.weightUnit`
|
|
6495
|
-
* + `order.billingInfo.address`
|
|
6496
|
-
* + `order.billingInfo.contactDetails`
|
|
6497
|
-
* + `order.archived`
|
|
6498
|
-
* + `order.attributionSource`
|
|
6499
|
-
* + `order.seenByAHuman`
|
|
6500
|
-
* + `order.recipientInfo.address`
|
|
6501
|
-
* + `order.recipientInfo.contactDetails`
|
|
6502
|
-
* + `order.shippingInfo.logistics.shippingDestination.address`
|
|
6503
|
-
* + `order.shippingInfo.logistics.shippingDestination.contactDetails`
|
|
6504
|
-
*
|
|
6505
|
-
* To update a field's value, include the new value in the `order` object in the method parameters.
|
|
6506
|
-
* To remove a field's value, pass `null`.
|
|
6507
|
-
*
|
|
6508
|
-
* > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
|
|
6509
|
-
*
|
|
6510
|
-
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
6511
|
-
* @param _id - Order ID.
|
|
6512
|
-
* @public
|
|
6513
|
-
* @requiredField _id
|
|
6514
|
-
* @requiredField order
|
|
6515
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
6516
|
-
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
6517
|
-
* @permissionScope Manage Stores - all permissions
|
|
6518
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6519
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6520
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6521
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6522
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6523
|
-
* @permissionScope Picasso private app mega scope
|
|
6524
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6525
|
-
* @permissionScope Manage Orders
|
|
6526
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6527
|
-
* @applicableIdentity APP
|
|
6528
|
-
* @returns Newly created order.
|
|
6529
|
-
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
|
|
6530
|
-
*/
|
|
6531
|
-
export declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
6532
|
-
export interface UpdateOrder {
|
|
6572
|
+
interface UpdateOrder {
|
|
6533
6573
|
/**
|
|
6534
6574
|
* Order ID.
|
|
6535
6575
|
* @format GUID
|
|
@@ -6696,56 +6736,14 @@ export interface UpdateOrder {
|
|
|
6696
6736
|
purchasedDate?: Date | null;
|
|
6697
6737
|
/** Order Location */
|
|
6698
6738
|
businessLocation?: Location;
|
|
6739
|
+
/**
|
|
6740
|
+
* Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
|
|
6741
|
+
* @internal
|
|
6742
|
+
* @readonly
|
|
6743
|
+
*/
|
|
6744
|
+
payAfterFreeTrial?: PriceSummary;
|
|
6699
6745
|
}
|
|
6700
|
-
|
|
6701
|
-
* Updates up to 100 orders.
|
|
6702
|
-
*
|
|
6703
|
-
*
|
|
6704
|
-
* The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
|
|
6705
|
-
*
|
|
6706
|
-
* Currently, the following fields can be updated:
|
|
6707
|
-
* + `order.buyerInfo.email`
|
|
6708
|
-
* + `order.buyerLanguage`
|
|
6709
|
-
* + `order.weightUnit`
|
|
6710
|
-
* + `order.billingInfo.address`
|
|
6711
|
-
* + `order.billingInfo.contactDetails`
|
|
6712
|
-
* + `order.archived`
|
|
6713
|
-
* + `order.attributionSource`
|
|
6714
|
-
* + `order.seenByAHuman`
|
|
6715
|
-
* + `order.recipientInfo.address`
|
|
6716
|
-
* + `order.recipientInfo.contactDetails`
|
|
6717
|
-
* + `order.shippingInfo.logistics.shippingDestination.address`
|
|
6718
|
-
* + `order.shippingInfo.logistics.shippingDestination.contactDetails`
|
|
6719
|
-
*
|
|
6720
|
-
* To update a field's value, include the new value in the `orders.order` object in the method parameters.
|
|
6721
|
-
* To remove a field's value, pass `null`.
|
|
6722
|
-
*
|
|
6723
|
-
* > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
|
|
6724
|
-
*
|
|
6725
|
-
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
6726
|
-
* @param orders - Orders to update.
|
|
6727
|
-
* @public
|
|
6728
|
-
* @requiredField orders
|
|
6729
|
-
* @requiredField orders.order
|
|
6730
|
-
* @requiredField orders.order._id
|
|
6731
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
6732
|
-
* @permissionScope Manage Stores - all permissions
|
|
6733
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6734
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6735
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6736
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6737
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6738
|
-
* @permissionScope Picasso private app mega scope
|
|
6739
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6740
|
-
* @permissionScope Manage Orders
|
|
6741
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6742
|
-
* @applicableIdentity APP
|
|
6743
|
-
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
|
|
6744
|
-
*/
|
|
6745
|
-
export declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
6746
|
-
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
6747
|
-
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
6748
|
-
export interface BulkUpdateOrdersOptions {
|
|
6746
|
+
interface BulkUpdateOrdersOptions {
|
|
6749
6747
|
/**
|
|
6750
6748
|
* Whether to return the full order entities.
|
|
6751
6749
|
*
|
|
@@ -6753,7 +6751,7 @@ export interface BulkUpdateOrdersOptions {
|
|
|
6753
6751
|
*/
|
|
6754
6752
|
returnEntity?: boolean;
|
|
6755
6753
|
}
|
|
6756
|
-
|
|
6754
|
+
interface CommitDeltasOptions {
|
|
6757
6755
|
/**
|
|
6758
6756
|
* Draft order Id representing this change.
|
|
6759
6757
|
* Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
|
|
@@ -6770,7 +6768,7 @@ export interface CommitDeltasOptions {
|
|
|
6770
6768
|
*/
|
|
6771
6769
|
reason?: string | null;
|
|
6772
6770
|
}
|
|
6773
|
-
|
|
6771
|
+
interface UpdateOrderLineItemIdentifiers {
|
|
6774
6772
|
/**
|
|
6775
6773
|
* Order ID
|
|
6776
6774
|
* @minLength 1
|
|
@@ -6783,7 +6781,7 @@ export interface UpdateOrderLineItemIdentifiers {
|
|
|
6783
6781
|
*/
|
|
6784
6782
|
lineItemId?: string;
|
|
6785
6783
|
}
|
|
6786
|
-
|
|
6784
|
+
interface UpdateOrderLineItem {
|
|
6787
6785
|
/**
|
|
6788
6786
|
* Line item ID.
|
|
6789
6787
|
* @immutable
|
|
@@ -6891,6 +6889,17 @@ export interface UpdateOrderLineItem {
|
|
|
6891
6889
|
* @maxSize 5
|
|
6892
6890
|
*/
|
|
6893
6891
|
locations?: LocationAndQuantity[];
|
|
6892
|
+
/**
|
|
6893
|
+
* Address used for tax calculation.
|
|
6894
|
+
* @internal
|
|
6895
|
+
*/
|
|
6896
|
+
taxableAddress?: TaxableAddress;
|
|
6897
|
+
/**
|
|
6898
|
+
* ID of the app managing the inventory.
|
|
6899
|
+
* @internal
|
|
6900
|
+
* @format GUID
|
|
6901
|
+
*/
|
|
6902
|
+
inventoryAppId?: string | null;
|
|
6894
6903
|
/**
|
|
6895
6904
|
* Custom extended fields for the line item object.
|
|
6896
6905
|
*
|
|
@@ -6898,7 +6907,7 @@ export interface UpdateOrderLineItem {
|
|
|
6898
6907
|
*/
|
|
6899
6908
|
extendedFields?: ExtendedFields;
|
|
6900
6909
|
}
|
|
6901
|
-
|
|
6910
|
+
interface UpdateActivityIdentifiers {
|
|
6902
6911
|
/**
|
|
6903
6912
|
* Order ID.
|
|
6904
6913
|
* @minLength 1
|
|
@@ -6911,7 +6920,7 @@ export interface UpdateActivityIdentifiers {
|
|
|
6911
6920
|
*/
|
|
6912
6921
|
activityId: string;
|
|
6913
6922
|
}
|
|
6914
|
-
|
|
6923
|
+
interface DeleteActivityIdentifiers {
|
|
6915
6924
|
/**
|
|
6916
6925
|
* Order ID.
|
|
6917
6926
|
* @minLength 1
|
|
@@ -6924,32 +6933,7 @@ export interface DeleteActivityIdentifiers {
|
|
|
6924
6933
|
*/
|
|
6925
6934
|
activityId: string;
|
|
6926
6935
|
}
|
|
6927
|
-
|
|
6928
|
-
* Cancels an order.
|
|
6929
|
-
*
|
|
6930
|
-
*
|
|
6931
|
-
* The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
|
|
6932
|
-
* @param _id - Order ID.
|
|
6933
|
-
* @public
|
|
6934
|
-
* @requiredField _id
|
|
6935
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
6936
|
-
* @permissionScope Manage Stores - all permissions
|
|
6937
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6938
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6939
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6940
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6941
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6942
|
-
* @permissionScope Picasso private app mega scope
|
|
6943
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6944
|
-
* @permissionScope Manage Orders
|
|
6945
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6946
|
-
* @applicableIdentity APP
|
|
6947
|
-
* @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
|
|
6948
|
-
*/
|
|
6949
|
-
export declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, {
|
|
6950
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
6951
|
-
}[OrderNonNullablePaths]>>;
|
|
6952
|
-
export interface CancelOrderOptions {
|
|
6936
|
+
interface CancelOrderOptions {
|
|
6953
6937
|
/** Whether to send an order canceled email to the buyer. */
|
|
6954
6938
|
sendOrderCanceledEmail?: boolean;
|
|
6955
6939
|
/**
|
|
@@ -6961,7 +6945,7 @@ export interface CancelOrderOptions {
|
|
|
6961
6945
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
6962
6946
|
restockAllItems?: boolean;
|
|
6963
6947
|
}
|
|
6964
|
-
|
|
6948
|
+
interface AggregateOrdersOptions {
|
|
6965
6949
|
/** Filter applied to original data */
|
|
6966
6950
|
filter?: Record<string, any> | null;
|
|
6967
6951
|
/** This is an object defining aggregation itself */
|
|
@@ -6977,43 +6961,11 @@ export interface AggregateOrdersOptions {
|
|
|
6977
6961
|
*/
|
|
6978
6962
|
hierarchySeparatorOverride?: string | null;
|
|
6979
6963
|
}
|
|
6980
|
-
|
|
6981
|
-
* Synchronously update tags on multiple orders, by list of order IDs.
|
|
6982
|
-
*
|
|
6983
|
-
* > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
|
|
6984
|
-
* @param orderIds - IDs of orders to update tags for.
|
|
6985
|
-
* @public
|
|
6986
|
-
* @requiredField orderIds
|
|
6987
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
6988
|
-
* @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS
|
|
6989
|
-
* @permissionScope Manage Stores - all permissions
|
|
6990
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6991
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6992
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6993
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6994
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6995
|
-
* @permissionScope Picasso private app mega scope
|
|
6996
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
6997
|
-
* @permissionScope Manage Orders
|
|
6998
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6999
|
-
* @permissionScope Manage Stores - all permissions
|
|
7000
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7001
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
7002
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7003
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
7004
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
7005
|
-
* @permissionScope Picasso private app mega scope
|
|
7006
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
7007
|
-
* @permissionScope Manage Orders
|
|
7008
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7009
|
-
* @applicableIdentity APP
|
|
7010
|
-
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
|
|
7011
|
-
*/
|
|
7012
|
-
export declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
7013
|
-
export interface BulkUpdateOrderTagsOptions {
|
|
6964
|
+
interface BulkUpdateOrderTagsOptions {
|
|
7014
6965
|
/** Tags to be added to orders */
|
|
7015
6966
|
assignTags?: Tags;
|
|
7016
6967
|
/** Tags to be removed from orders */
|
|
7017
6968
|
unassignTags?: Tags;
|
|
7018
6969
|
}
|
|
7019
|
-
|
|
6970
|
+
|
|
6971
|
+
export { VatType as $, type AddActivityResponse as A, type BulkMarkOrdersAsPaidResponse as B, type CreatePaymentGatewayOrderResponse as C, type DeleteActivityIdentifiers as D, type UpdateOrderStatusResponse as E, type AggregateOrdersOptions as F, type GetPaymentCollectabilityStatusResponse as G, type AggregateOrdersResponse as H, type BulkUpdateOrderTagsOptions as I, type BulkUpdateOrderTagsResponse as J, DescriptionLineType as K, ItemTypeItemType as L, type MarkOrderAsPaidResponse as M, PaymentOptionType as N, type Order as O, type Price as P, JurisdictionType as Q, SubscriptionFrequency as R, type SearchOrdersOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, AdjustmentType as W, TaxableAddressType as X, PaymentStatus as Y, FulfillmentStatus as Z, WeightUnit as _, type PreparePaymentCollectionOptions as a, type PriceDescription as a$, PickupMethod as a0, DiscountType as a1, DiscountReason as a2, LineItemQuantityChangeType as a3, ActivityType as a4, AttributionSource as a5, ChannelType as a6, ScheduledAction as a7, DurationUnit as a8, PaymentCollectabilityStatus as a9, ValueType as aA, DepositType as aB, InvoiceStatus as aC, type OrderLineItem as aD, type ProductName as aE, type CatalogReference as aF, type DescriptionLine as aG, type DescriptionLineValueOneOf as aH, type DescriptionLineDescriptionLineValueOneOf as aI, type DescriptionLineName as aJ, type PlainTextValue as aK, type Color as aL, type FocalPoint as aM, type PhysicalProperties as aN, type ItemType as aO, type ItemTypeItemTypeDataOneOf as aP, type ItemTaxFullDetails as aQ, type LineItemTaxInfo as aR, type LineItemTaxBreakdown as aS, type DigitalFile as aT, type SubscriptionInfo as aU, type SubscriptionTitle as aV, type SubscriptionDescription as aW, type SubscriptionSettings as aX, type FreeTrialPeriod as aY, type BillingAdjustment as aZ, type BillingAdjustmentPriceSummary as a_, RefundableStatus as aa, NonRefundableReason as ab, ManuallyRefundableReason as ac, RestockType as ad, TransactionStatus as ae, AuthorizationCaptureStatus as af, AuthorizationVoidStatus as ag, Reason as ah, ActionType as ai, MembershipPaymentStatus as aj, RefundStatus as ak, WebhookIdentityType as al, TextDetection as am, AnimationDetection as an, PreviewEmailType as ao, State as ap, Namespace as aq, SortOrder as ar, VersioningMode as as, OrderApprovalStrategy as at, DeltaPaymentOptionType as au, InventoryAction as av, Placement as aw, SubdivisionType as ax, SourceType as ay, CustomFieldGroup as az, type PreparePaymentCollectionResponse as b, type GiftCardPaymentRefund as b$, type LocationAndQuantity as b0, type TaxableAddress as b1, type TaxableAddressTaxableAddressDataOneOf as b2, type ExtendedFields as b3, type BuyerInfo as b4, type BuyerInfoIdOneOf as b5, type CurrencyConversionDetails as b6, type PriceSummary as b7, type AddressWithContact as b8, type Address as b9, type MerchantComment as bA, type OrderRefunded as bB, type OrderCreatedFromExchange as bC, type NewExchangeOrderCreated as bD, type LineItemExchangeData as bE, type DraftOrderChangesApplied as bF, type OrderChange as bG, type OrderChangeValueOneOf as bH, type LineItemChanges as bI, type LineItemQuantityChange as bJ, type LineItemPriceChange as bK, type ManagedLineItem as bL, type ManagedDiscount as bM, type TranslatedValue as bN, type LineItemAmount as bO, type ManagedAdditionalFee as bP, type TotalPriceChange as bQ, type ShippingInformationChange as bR, type ShippingInformation as bS, type SavedPaymentMethod as bT, type AuthorizedPaymentCreated as bU, type AuthorizedPaymentCaptured as bV, type AuthorizedPaymentVoided as bW, type RefundInitiated as bX, type RefundedPayment as bY, type RefundedPaymentKindOneOf as bZ, type RegularPaymentRefund as b_, type StreetAddress as ba, type AddressLocation as bb, type FullAddressContactDetails as bc, type VatId as bd, type V1ShippingInformation as be, type DeliveryLogistics as bf, type DeliveryLogisticsAddressOneOf as bg, type PickupDetails as bh, type PickupAddress as bi, type DeliveryTimeSlot as bj, type ShippingPrice as bk, type ShippingRegion as bl, type TaxSummary as bm, type OrderTaxInfo as bn, type OrderTaxBreakdown as bo, type AppliedDiscount as bp, type AppliedDiscountDiscountSourceOneOf as bq, type Coupon as br, type MerchantDiscount as bs, type MerchantDiscountMerchantDiscountReasonOneOf as bt, type DiscountRule as bu, type DiscountRuleName as bv, type LineItemDiscount as bw, type Activity as bx, type ActivityContentOneOf as by, type CustomActivity as bz, type GetRefundabilityStatusResponse as c, type AdditionalFeeRefund as c$, type MembershipPaymentRefund as c0, type PaymentRefunded as c1, type PaymentRefundFailed as c2, type RefundedAsStoreCredit as c3, type PaymentPending as c4, type PaymentPendingPaymentDetailsOneOf as c5, type RegularPayment as c6, type RegularPaymentPaymentMethodDetailsOneOf as c7, type CreditCardDetails as c8, type PaymentCanceled as c9, type RedirectUrls as cA, type DelayedCaptureSettings as cB, type Duration as cC, type GetPaymentCollectabilityStatusRequest as cD, type RecordManuallyCollectedPaymentRequest as cE, type RecordManuallyCollectedPaymentResponse as cF, type MarkOrderAsPaidRequest as cG, type PaymentStatusUpdated as cH, type BulkMarkOrdersAsPaidRequest as cI, type BulkOrderResult as cJ, type ItemMetadata as cK, type ApplicationError as cL, type BulkActionMetadata as cM, type GetRefundabilityStatusRequest as cN, type Refundability as cO, type RefundabilityAdditionalRefundabilityInfoOneOf as cP, type CreatePaymentGatewayOrderRequest as cQ, type ChargedBy as cR, type ChargeMembershipsRequest as cS, type MembershipChargeItem as cT, type MembershipName as cU, type ServiceProperties as cV, type ChargeMembershipsResponse as cW, type TriggerRefundRequest as cX, type RefundDetails as cY, type RefundItem as cZ, type LineItemRefund as c_, type PaymentCanceledPaymentDetailsOneOf as ca, type PaymentDeclined as cb, type PaymentDeclinedPaymentDetailsOneOf as cc, type ReceiptCreated as cd, type ReceiptCreatedReceiptInfoOneOf as ce, type WixReceipt as cf, type ExternalReceipt as cg, type ReceiptSent as ch, type ReceiptSentReceiptInfoOneOf as ci, type CreatedBy as cj, type CreatedByStringOneOf as ck, type ChannelInfo as cl, type CustomField as cm, type BalanceSummary as cn, type Balance as co, type AdditionalFee as cp, type FulfillmentStatusesAggregate as cq, type Tags as cr, type TagList as cs, type Location as ct, type OrderApproved as cu, type OrdersExperiments as cv, type OrderRejectedEventOrderRejected as cw, type OrderItemsRestocked as cx, type V1RestockItem as cy, type PreparePaymentCollectionRequest as cz, type PaymentCollectionCreatePaymentGatewayOrderOptions as d, type SendRefundEmailRequest as d$, type ShippingRefund as d0, type RefundSideEffects as d1, type RestockInfo as d2, type RestockItem as d3, type OrderTransactions as d4, type Payment as d5, type PaymentPaymentDetailsOneOf as d6, type PaymentReceiptInfoOneOf as d7, type RegularPaymentDetails as d8, type RegularPaymentDetailsPaymentMethodDetailsOneOf as d9, type DomainEventBodyOneOf as dA, type EntityCreatedEvent as dB, type RestoreInfo as dC, type EntityUpdatedEvent as dD, type EntityDeletedEvent as dE, type ActionEvent as dF, type Empty as dG, type MessageEnvelope as dH, type IdentificationData as dI, type IdentificationDataIdOneOf as dJ, type ImageContent as dK, type SendBuyerConfirmationEmailRequest as dL, type SendBuyerConfirmationEmailResponse as dM, type SendBuyerPaymentsReceivedEmailRequest as dN, type SendBuyerPaymentsReceivedEmailResponse as dO, type SendBuyerPickupConfirmationEmailRequest as dP, type SendBuyerPickupConfirmationEmailResponse as dQ, type BulkSendBuyerPickupConfirmationEmailsRequest as dR, type BulkSendBuyerPickupConfirmationEmailsResponse as dS, type SendBuyerShippingConfirmationEmailRequest as dT, type SendBuyerShippingConfirmationEmailResponse as dU, type BulkSendBuyerShippingConfirmationEmailsRequest as dV, type BulkSendBuyerShippingConfirmationEmailsResponse as dW, type SendMerchantOrderReceivedNotificationRequest as dX, type SendMerchantOrderReceivedNotificationResponse as dY, type SendCancelRefundEmailRequest as dZ, type SendCancelRefundEmailResponse as d_, type CreditCardPaymentMethodDetails as da, type AuthorizationDetails as db, type AuthorizationCapture as dc, type AuthorizationActionFailureDetails as dd, type AuthorizationVoid as de, type V1ScheduledAction as df, type GiftCardPaymentDetails as dg, type MembershipPaymentDetails as dh, type WixReceiptInfo as di, type ExternalReceiptInfo as dj, type Refund as dk, type RefundTransaction as dl, type RefundStatusInfo as dm, type AggregatedRefundSummary as dn, type RefundItemsBreakdown as dp, type LineItemRefundSummary as dq, type CalculateRefundRequest as dr, type CalculateRefundItemRequest as ds, type CalculateRefundResponse as dt, type CalculateRefundItemResponse as du, type VoidAuthorizedPaymentsRequest as dv, type CaptureAuthorizedPaymentsRequest as dw, type ChargeSavedPaymentMethodRequest as dx, type ChargeSavedPaymentMethodResponse as dy, type DomainEvent as dz, type ChargeMembershipsOptions as e, type ErrorInformation as e$, type SendRefundEmailResponse as e0, type SendMerchantOrderReceivedPushRequest as e1, type SendMerchantOrderReceivedPushResponse as e2, type PreviewEmailByTypeRequest as e3, type PreviewEmailByTypeResponse as e4, type PreviewRefundEmailRequest as e5, type PreviewRefundEmailResponse as e6, type PreviewCancelEmailRequest as e7, type PreviewCancelEmailResponse as e8, type PreviewCancelRefundEmailRequest as e9, type Sorting as eA, type PlatformPaging as eB, type CursorPaging as eC, type QueryOrdersForMetasiteResponse as eD, type PlatformPagingMetadata as eE, type Cursors as eF, type GetOrderForMetasiteRequest as eG, type GetOrderForMetasiteResponse as eH, type ListOrderTransactionsForMetasiteRequest as eI, type ListOrderTransactionsForMetasiteResponse as eJ, type UpsertRefundRequest as eK, type UpsertRefundResponse as eL, type UpdateInternalDocumentsEvent as eM, type UpdateInternalDocumentsEventOperationOneOf as eN, type InternalDocument as eO, type InternalDocumentUpdateOperation as eP, type DeleteByIdsOperation as eQ, type DeleteByFilterOperation as eR, type InternalDocumentUpdateByFilterOperation as eS, type InternalUpdateExistingOperation as eT, type VersionedDocumentUpdateOperation as eU, type VersionedDeleteByIdsOperation as eV, type VersionedDocumentId as eW, type TriggerReindexRequest as eX, type TriggerReindexResponse as eY, type BatchOfTriggerReindexOrderRequest as eZ, type DiffmatokyPayload as e_, type PreviewCancelRefundEmailResponse as ea, type PreviewBuyerPaymentsReceivedEmailRequest as eb, type PreviewBuyerPaymentsReceivedEmailResponse as ec, type PreviewBuyerConfirmationEmailRequest as ed, type PreviewBuyerConfirmationEmailResponse as ee, type PreviewBuyerPickupConfirmationEmailRequest as ef, type PreviewBuyerPickupConfirmationEmailResponse as eg, type PreviewShippingConfirmationEmailRequest as eh, type PreviewShippingConfirmationEmailResponse as ei, type PreviewResendDownloadLinksEmailRequest as ej, type PreviewResendDownloadLinksEmailResponse as ek, type TriggerReindexOrderRequest as el, type SnapshotMessage as em, type GetMetasiteDataRequest as en, type GetMetasiteDataResponse as eo, type MetaSite as ep, type App as eq, type SeoData as er, type MetaTag as es, type HtmlApplication as et, type ExternalUriMapping as eu, type UserDataResponse as ev, type QueryOrdersForMetasiteRequest as ew, type InternalQueryOrdersRequest as ex, type PlatformQuery as ey, type PlatformQueryPagingMethodOneOf as ez, type PaymentRefund as f, type UpdateOrderLineItemsResponse as f$, type ContinueSideEffectsFlowInLegacyData as f0, type IndexingMessage as f1, type GetOrderRequest as f2, type GetOrderResponse as f3, type InternalQueryOrdersResponse as f4, type QueryOrderRequest as f5, type QueryOrderResponse as f6, type SearchOrdersRequest as f7, type CursorSearch as f8, type CursorSearchPagingMethodOneOf as f9, type CommittedDiffsShippingUpdateInfoOneOf as fA, type LineItemDelta as fB, type LineItemDeltaDeltaOneOf as fC, type ArchiveOrderRequest as fD, type ArchiveOrderResponse as fE, type BulkArchiveOrdersRequest as fF, type BulkArchiveOrdersResponse as fG, type BulkArchiveOrdersByFilterRequest as fH, type BulkArchiveOrdersByFilterResponse as fI, type UnArchiveOrderRequest as fJ, type UnArchiveOrderResponse as fK, type BulkUnArchiveOrdersRequest as fL, type BulkUnArchiveOrdersResponse as fM, type BulkUnArchiveOrdersByFilterRequest as fN, type BulkUnArchiveOrdersByFilterResponse as fO, type UpdateBuyerInfoRequest as fP, type BuyerInfoUpdate as fQ, type UpdateBuyerInfoResponse as fR, type UpdateBuyerEmailRequest as fS, type UpdateBuyerEmailResponse as fT, type UpdateOrderShippingAddressRequest as fU, type UpdateOrderShippingAddressResponse as fV, type UpdateBillingContactDetailsRequest as fW, type UpdateBillingContactDetailsResponse as fX, type UpdateOrderLineItemRequest as fY, type UpdateOrderLineItemsRequest as fZ, type MaskedOrderLineItem as f_, type CursorPagingMetadata as fa, type CreateOrderRequest as fb, type OrderCreationSettings as fc, type OrderCreateNotifications as fd, type CreateOrderResponse as fe, type UpdateOrderRequest as ff, type UpdateOrderResponse as fg, type BulkUpdateOrdersRequest as fh, type CommitDeltasRequest as fi, type DraftOrderDiffs as fj, type DraftOrderDiffsShippingUpdateInfoOneOf as fk, type DraftOrderDiffsBuyerUpdateInfoOneOf as fl, type DraftOrderDiffsBillingUpdateInfoOneOf as fm, type DraftOrderDiffsRecipientUpdateInfoOneOf as fn, type V1LineItemDelta as fo, type V1LineItemDeltaDeltaOneOf as fp, type OrderLineItemChangedDetails as fq, type ItemChangedDetails as fr, type AppliedDiscountDelta as fs, type AppliedDiscountDeltaDeltaOneOf as ft, type AdditionalFeeDelta as fu, type AdditionalFeeDeltaDeltaOneOf as fv, type DraftOrderCommitSettings as fw, type InventoryUpdateDetails as fx, type OrderDeltasCommitted as fy, type CommittedDiffs as fz, type TriggerRefundResponse as g, type DecrementData as g$, type AddInternalActivityRequest as g0, type InternalActivity as g1, type InternalActivityContentOneOf as g2, type OrderPlaced as g3, type OrderPaid as g4, type OrderFulfilled as g5, type OrderNotFulfilled as g6, type OrderCanceled as g7, type DownloadLinkSent as g8, type TrackingNumberAdded as g9, type UpdateOrderStatusRequest as gA, type MarkAsFulfilledRequest as gB, type MarkAsFulfilledResponse as gC, type FulfillmentStatusUpdated as gD, type BulkMarkAsFulfilledRequest as gE, type BulkMarkAsFulfilledResponse as gF, type BulkMarkAsFulfilledByFilterRequest as gG, type BulkMarkAsFulfilledByFilterResponse as gH, type MarkAsUnfulfilledRequest as gI, type MarkAsUnfulfilledResponse as gJ, type BulkMarkAsUnfulfilledRequest as gK, type BulkMarkAsUnfulfilledResponse as gL, type BulkMarkAsUnfulfilledByFilterRequest as gM, type BulkMarkAsUnfulfilledByFilterResponse as gN, type BulkSetBusinessLocationRequest as gO, type BulkSetBusinessLocationResponse as gP, type BulkSetBusinessLocationResult as gQ, type V1MarkOrderAsPaidRequest as gR, type V1MarkOrderAsPaidResponse as gS, type V1BulkMarkOrdersAsPaidRequest as gT, type V1BulkMarkOrdersAsPaidResponse as gU, type V1CreatePaymentGatewayOrderRequest as gV, type V1CreatePaymentGatewayOrderResponse as gW, type GetShipmentsRequest as gX, type GetShipmentsResponse as gY, type AggregateOrdersRequest as gZ, type DecrementItemsQuantityRequest as g_, type TrackingNumberEdited as ga, type TrackingLinkAdded as gb, type ShippingConfirmationEmailSent as gc, type InvoiceAdded as gd, type InvoiceSent as ge, type FulfillerEmailSent as gf, type ShippingAddressEdited as gg, type EmailEdited as gh, type PickupReadyEmailSent as gi, type OrderPartiallyPaid as gj, type OrderPending as gk, type OrderRejected as gl, type AddInternalActivityResponse as gm, type AddActivityRequest as gn, type PublicActivityContentOneOf as go, type AddActivitiesRequest as gp, type AddActivitiesResponse as gq, type UpdateActivityRequest as gr, type DeleteActivityRequest as gs, type UpdateLineItemsDescriptionLinesRequest as gt, type LineItemUpdate as gu, type UpdateLineItemsDescriptionLinesResponse as gv, type MarkOrderAsSeenByHumanRequest as gw, type MarkOrderAsSeenByHumanResponse as gx, type CancelOrderRequest as gy, type OrderCanceledEventOrderCanceled as gz, type PaymentCapture as h, type DecrementItemsQuantityResponse as h0, type BulkUpdateOrderTagsRequest as h1, type BulkUpdateOrderTagsResult as h2, type Task as h3, type TaskKey as h4, type TaskAction as h5, type TaskActionActionOneOf as h6, type Complete as h7, type Cancel as h8, type Reschedule as h9, type CalculatedTax as hA, type Payments as hB, type InvoicesPayment as hC, type MetaData as hD, type InvoiceDynamicPriceTotals as hE, type CustomFieldValue as hF, type Value as hG, type Deposit as hH, type TriggerSideEffectsFromLegacyData as hI, type BaseEventMetadata as hJ, type EventMetadata as hK, type OrderApprovedEnvelope as hL, type OrderUpdatedEnvelope as hM, type OrderCanceledEnvelope as hN, type OrderCreatedEnvelope as hO, type InvoiceSentEvent as ha, type IdAndVersion as hb, type InvoiceFields as hc, type Customer as hd, type Email as he, type QuotesAddress as hf, type AddressDescription as hg, type Phone as hh, type Company as hi, type CommonAddress as hj, type CommonAddressStreetOneOf as hk, type Subdivision as hl, type StandardDetails as hm, type InvoiceDates as hn, type LineItems as ho, type LineItem as hp, type BigDecimalWrapper as hq, type LineItemTax as hr, type Source as hs, type LineItemMetaData as ht, type Locale as hu, type TotalPrice as hv, type ItemizedFee as hw, type Discount as hx, type DiscountOneDiscountTypeOneOf as hy, type CalculatedTaxes as hz, type CaptureAuthorizedPaymentsResponse as i, type SearchOrdersResponse as j, type CreateOrderOptions as k, type MaskedOrder as l, type BulkUpdateOrdersOptions as m, type BulkUpdateOrdersResponse as n, type CommitDeltasOptions as o, type CommitDeltasResponse as p, type UpdateOrderLineItemIdentifiers as q, type UpdateOrderLineItem as r, type UpdateOrderLineItemResponse as s, type PublicActivity as t, type UpdateActivityIdentifiers as u, type UpdateActivityResponse as v, type DeleteActivityResponse as w, type CancelOrderOptions as x, type CancelOrderResponse as y, OrderStatus as z };
|