@wix/auto_sdk_ecom_orders 1.0.53 → 1.0.54
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.universal.d.ts → ecom-v1-order-orders.universal-CO-UuLIK.d.mts} +640 -1079
- package/build/{es/src/ecom-v1-order-orders.universal.d.ts → ecom-v1-order-orders.universal-CO-UuLIK.d.ts} +640 -1079
- package/build/index.d.mts +216 -0
- package/build/index.d.ts +216 -0
- package/build/index.js +3502 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +3399 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-order-orders.universal.d.ts → ecom-v1-order-orders.universal-DrkwwhMV.d.mts} +640 -1446
- package/build/internal/{es/src/ecom-v1-order-orders.universal.d.ts → ecom-v1-order-orders.universal-DrkwwhMV.d.ts} +640 -1446
- package/build/internal/index.d.mts +395 -0
- package/build/internal/index.d.ts +395 -0
- package/build/internal/index.js +3502 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +3399 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +3302 -0
- package/build/internal/meta.d.ts +3302 -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 +3302 -0
- package/build/meta.d.ts +3302 -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 +12 -11
- 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 -43
- 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 -190
- 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.d.ts +0 -6317
- 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 -2337
- 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 -43
- 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 -190
- 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.d.ts +0 -6317
- 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 -2285
- 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 -43
- 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 -341
- 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 -6317
- 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.js +0 -2337
- 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 -43
- 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 -341
- 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 -6317
- 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.js +0 -2285
- package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +0 -1
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import { SearchSpec, Search } from '@wix/sdk-types';
|
|
2
|
+
|
|
3
|
+
interface Order {
|
|
3
4
|
/**
|
|
4
5
|
* Order ID.
|
|
5
6
|
* @format GUID
|
|
@@ -172,7 +173,7 @@ export interface Order {
|
|
|
172
173
|
*/
|
|
173
174
|
payAfterFreeTrial?: PriceSummary;
|
|
174
175
|
}
|
|
175
|
-
|
|
176
|
+
interface OrderLineItem {
|
|
176
177
|
/**
|
|
177
178
|
* Line item ID.
|
|
178
179
|
* @immutable
|
|
@@ -289,7 +290,7 @@ export interface OrderLineItem {
|
|
|
289
290
|
*/
|
|
290
291
|
extendedFields?: ExtendedFields;
|
|
291
292
|
}
|
|
292
|
-
|
|
293
|
+
interface ProductName {
|
|
293
294
|
/**
|
|
294
295
|
* __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).
|
|
295
296
|
*
|
|
@@ -311,7 +312,7 @@ export interface ProductName {
|
|
|
311
312
|
translated?: string | null;
|
|
312
313
|
}
|
|
313
314
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
314
|
-
|
|
315
|
+
interface CatalogReference {
|
|
315
316
|
/**
|
|
316
317
|
* ID of the item within the catalog it belongs to.
|
|
317
318
|
* @minLength 1
|
|
@@ -339,7 +340,7 @@ export interface CatalogReference {
|
|
|
339
340
|
*/
|
|
340
341
|
options?: Record<string, any> | null;
|
|
341
342
|
}
|
|
342
|
-
|
|
343
|
+
interface Price {
|
|
343
344
|
/**
|
|
344
345
|
* Amount.
|
|
345
346
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -351,7 +352,7 @@ export interface Price {
|
|
|
351
352
|
*/
|
|
352
353
|
formattedAmount?: string;
|
|
353
354
|
}
|
|
354
|
-
|
|
355
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
355
356
|
/** Description line plain text value. */
|
|
356
357
|
plainText?: PlainTextValue;
|
|
357
358
|
/** Description line color value. */
|
|
@@ -360,16 +361,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
360
361
|
name?: DescriptionLineName;
|
|
361
362
|
}
|
|
362
363
|
/** @oneof */
|
|
363
|
-
|
|
364
|
+
interface DescriptionLineValueOneOf {
|
|
364
365
|
/** Description line plain text value. */
|
|
365
366
|
plainText?: PlainTextValue;
|
|
366
367
|
/** Description line color value. */
|
|
367
368
|
colorInfo?: Color;
|
|
368
369
|
}
|
|
369
370
|
/** @oneof */
|
|
370
|
-
|
|
371
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
371
372
|
}
|
|
372
|
-
|
|
373
|
+
interface DescriptionLineName {
|
|
373
374
|
/**
|
|
374
375
|
* 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).
|
|
375
376
|
* @maxLength 100
|
|
@@ -383,7 +384,7 @@ export interface DescriptionLineName {
|
|
|
383
384
|
*/
|
|
384
385
|
translated?: string | null;
|
|
385
386
|
}
|
|
386
|
-
|
|
387
|
+
interface PlainTextValue {
|
|
387
388
|
/**
|
|
388
389
|
* 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).
|
|
389
390
|
* @maxLength 600
|
|
@@ -397,7 +398,7 @@ export interface PlainTextValue {
|
|
|
397
398
|
*/
|
|
398
399
|
translated?: string | null;
|
|
399
400
|
}
|
|
400
|
-
|
|
401
|
+
interface Color {
|
|
401
402
|
/**
|
|
402
403
|
* 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).
|
|
403
404
|
* @maxLength 500
|
|
@@ -413,7 +414,7 @@ export interface Color {
|
|
|
413
414
|
/** HEX or RGB color code for display. */
|
|
414
415
|
code?: string | null;
|
|
415
416
|
}
|
|
416
|
-
|
|
417
|
+
declare enum DescriptionLineType {
|
|
417
418
|
/** Unrecognized type. */
|
|
418
419
|
UNRECOGNISED = "UNRECOGNISED",
|
|
419
420
|
/** Plain text type. */
|
|
@@ -421,9 +422,7 @@ export declare enum DescriptionLineType {
|
|
|
421
422
|
/** Color type. */
|
|
422
423
|
COLOR = "COLOR"
|
|
423
424
|
}
|
|
424
|
-
|
|
425
|
-
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
426
|
-
export interface FocalPoint {
|
|
425
|
+
interface FocalPoint {
|
|
427
426
|
/** X-coordinate of the focal point. */
|
|
428
427
|
x?: number;
|
|
429
428
|
/** Y-coordinate of the focal point. */
|
|
@@ -433,7 +432,7 @@ export interface FocalPoint {
|
|
|
433
432
|
/** crop by width */
|
|
434
433
|
width?: number | null;
|
|
435
434
|
}
|
|
436
|
-
|
|
435
|
+
interface PhysicalProperties {
|
|
437
436
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
438
437
|
weight?: number | null;
|
|
439
438
|
/**
|
|
@@ -444,20 +443,20 @@ export interface PhysicalProperties {
|
|
|
444
443
|
/** Whether this line item is shippable. */
|
|
445
444
|
shippable?: boolean;
|
|
446
445
|
}
|
|
447
|
-
|
|
446
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
448
447
|
/** Preset item type. */
|
|
449
448
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
450
449
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
451
450
|
custom?: string;
|
|
452
451
|
}
|
|
453
452
|
/** @oneof */
|
|
454
|
-
|
|
453
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
455
454
|
/** Preset item type. */
|
|
456
455
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
457
456
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
458
457
|
custom?: string;
|
|
459
458
|
}
|
|
460
|
-
|
|
459
|
+
declare enum ItemTypeItemType {
|
|
461
460
|
UNRECOGNISED = "UNRECOGNISED",
|
|
462
461
|
PHYSICAL = "PHYSICAL",
|
|
463
462
|
DIGITAL = "DIGITAL",
|
|
@@ -465,9 +464,9 @@ export declare enum ItemTypeItemType {
|
|
|
465
464
|
SERVICE = "SERVICE"
|
|
466
465
|
}
|
|
467
466
|
/** @enumType */
|
|
468
|
-
|
|
467
|
+
type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
469
468
|
/** Type of selected payment option for catalog item */
|
|
470
|
-
|
|
469
|
+
declare enum PaymentOptionType {
|
|
471
470
|
/** The entire payment for this item happens as part of the checkout. */
|
|
472
471
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
473
472
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -480,8 +479,8 @@ export declare enum PaymentOptionType {
|
|
|
480
479
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
481
480
|
}
|
|
482
481
|
/** @enumType */
|
|
483
|
-
|
|
484
|
-
|
|
482
|
+
type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
483
|
+
interface ItemTaxFullDetails {
|
|
485
484
|
/** Taxable amount of this line item. */
|
|
486
485
|
taxableAmount?: Price;
|
|
487
486
|
/**
|
|
@@ -492,7 +491,7 @@ export interface ItemTaxFullDetails {
|
|
|
492
491
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
493
492
|
totalTax?: Price;
|
|
494
493
|
}
|
|
495
|
-
|
|
494
|
+
interface LineItemTaxInfo {
|
|
496
495
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
497
496
|
taxAmount?: Price;
|
|
498
497
|
/** Amount for which tax is calculated. */
|
|
@@ -520,7 +519,7 @@ export interface LineItemTaxInfo {
|
|
|
520
519
|
* TaxBreakdown represents tax information for a line item.
|
|
521
520
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
522
521
|
*/
|
|
523
|
-
|
|
522
|
+
interface LineItemTaxBreakdown {
|
|
524
523
|
/**
|
|
525
524
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
526
525
|
* @maxLength 200
|
|
@@ -553,7 +552,7 @@ export interface LineItemTaxBreakdown {
|
|
|
553
552
|
taxableAmount?: Price;
|
|
554
553
|
}
|
|
555
554
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
556
|
-
|
|
555
|
+
declare enum JurisdictionType {
|
|
557
556
|
UNDEFINED = "UNDEFINED",
|
|
558
557
|
COUNTRY = "COUNTRY",
|
|
559
558
|
STATE = "STATE",
|
|
@@ -562,8 +561,8 @@ export declare enum JurisdictionType {
|
|
|
562
561
|
SPECIAL = "SPECIAL"
|
|
563
562
|
}
|
|
564
563
|
/** @enumType */
|
|
565
|
-
|
|
566
|
-
|
|
564
|
+
type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
565
|
+
interface DigitalFile {
|
|
567
566
|
/**
|
|
568
567
|
* ID of the secure file in media.
|
|
569
568
|
* @minLength 1
|
|
@@ -583,7 +582,7 @@ export interface DigitalFile {
|
|
|
583
582
|
*/
|
|
584
583
|
expirationDate?: Date | null;
|
|
585
584
|
}
|
|
586
|
-
|
|
585
|
+
interface SubscriptionInfo {
|
|
587
586
|
/**
|
|
588
587
|
* Subscription ID.
|
|
589
588
|
* @format GUID
|
|
@@ -621,7 +620,7 @@ export interface SubscriptionInfo {
|
|
|
621
620
|
*/
|
|
622
621
|
chargesDescription?: string | null;
|
|
623
622
|
}
|
|
624
|
-
|
|
623
|
+
interface SubscriptionTitle {
|
|
625
624
|
/**
|
|
626
625
|
* 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).
|
|
627
626
|
* @minLength 1
|
|
@@ -637,7 +636,7 @@ export interface SubscriptionTitle {
|
|
|
637
636
|
*/
|
|
638
637
|
translated?: string | null;
|
|
639
638
|
}
|
|
640
|
-
|
|
639
|
+
interface SubscriptionDescription {
|
|
641
640
|
/**
|
|
642
641
|
* Subscription option description.
|
|
643
642
|
* @maxLength 500
|
|
@@ -649,7 +648,7 @@ export interface SubscriptionDescription {
|
|
|
649
648
|
*/
|
|
650
649
|
translated?: string | null;
|
|
651
650
|
}
|
|
652
|
-
|
|
651
|
+
interface SubscriptionSettings {
|
|
653
652
|
/** Frequency of recurring payment. */
|
|
654
653
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
655
654
|
/**
|
|
@@ -671,7 +670,7 @@ export interface SubscriptionSettings {
|
|
|
671
670
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
672
671
|
}
|
|
673
672
|
/** Frequency unit of recurring payment */
|
|
674
|
-
|
|
673
|
+
declare enum SubscriptionFrequency {
|
|
675
674
|
UNDEFINED = "UNDEFINED",
|
|
676
675
|
DAY = "DAY",
|
|
677
676
|
WEEK = "WEEK",
|
|
@@ -679,8 +678,8 @@ export declare enum SubscriptionFrequency {
|
|
|
679
678
|
YEAR = "YEAR"
|
|
680
679
|
}
|
|
681
680
|
/** @enumType */
|
|
682
|
-
|
|
683
|
-
|
|
681
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
682
|
+
interface FreeTrialPeriod {
|
|
684
683
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
685
684
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
686
685
|
/**
|
|
@@ -690,13 +689,13 @@ export interface FreeTrialPeriod {
|
|
|
690
689
|
*/
|
|
691
690
|
interval?: number;
|
|
692
691
|
}
|
|
693
|
-
|
|
692
|
+
interface BillingAdjustment {
|
|
694
693
|
/** The type of adjustment. */
|
|
695
694
|
type?: AdjustmentTypeWithLiterals;
|
|
696
695
|
/** Summary of the prorated adjustment amount. */
|
|
697
696
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
698
697
|
}
|
|
699
|
-
|
|
698
|
+
declare enum AdjustmentType {
|
|
700
699
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
701
700
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
702
701
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
@@ -704,8 +703,8 @@ export declare enum AdjustmentType {
|
|
|
704
703
|
CREDIT = "CREDIT"
|
|
705
704
|
}
|
|
706
705
|
/** @enumType */
|
|
707
|
-
|
|
708
|
-
|
|
706
|
+
type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
707
|
+
interface BillingAdjustmentPriceSummary {
|
|
709
708
|
/** Subtotal of adjustment, before tax. */
|
|
710
709
|
subtotal?: Price;
|
|
711
710
|
/** Tax on adjustment. */
|
|
@@ -713,7 +712,7 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
713
712
|
/** Total price after tax. */
|
|
714
713
|
total?: Price;
|
|
715
714
|
}
|
|
716
|
-
|
|
715
|
+
interface PriceDescription {
|
|
717
716
|
/**
|
|
718
717
|
* __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).
|
|
719
718
|
* @minLength 1
|
|
@@ -729,7 +728,7 @@ export interface PriceDescription {
|
|
|
729
728
|
*/
|
|
730
729
|
translated?: string | null;
|
|
731
730
|
}
|
|
732
|
-
|
|
731
|
+
interface LocationAndQuantity {
|
|
733
732
|
/**
|
|
734
733
|
* Location id in the associated owner app.
|
|
735
734
|
* @format GUID
|
|
@@ -755,24 +754,24 @@ export interface LocationAndQuantity {
|
|
|
755
754
|
*/
|
|
756
755
|
name?: string | null;
|
|
757
756
|
}
|
|
758
|
-
|
|
757
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
759
758
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
760
759
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
761
760
|
}
|
|
762
761
|
/** @oneof */
|
|
763
|
-
|
|
762
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
764
763
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
765
764
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
766
765
|
}
|
|
767
|
-
|
|
766
|
+
declare enum TaxableAddressType {
|
|
768
767
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
769
768
|
BUSINESS = "BUSINESS",
|
|
770
769
|
BILLING = "BILLING",
|
|
771
770
|
SHIPPING = "SHIPPING"
|
|
772
771
|
}
|
|
773
772
|
/** @enumType */
|
|
774
|
-
|
|
775
|
-
|
|
773
|
+
type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
774
|
+
interface ExtendedFields {
|
|
776
775
|
/**
|
|
777
776
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
778
777
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -783,7 +782,7 @@ export interface ExtendedFields {
|
|
|
783
782
|
*/
|
|
784
783
|
namespaces?: Record<string, Record<string, any>>;
|
|
785
784
|
}
|
|
786
|
-
|
|
785
|
+
interface ModifierGroup {
|
|
787
786
|
/**
|
|
788
787
|
* Modifier group id.
|
|
789
788
|
* @minLength 1
|
|
@@ -799,7 +798,7 @@ export interface ModifierGroup {
|
|
|
799
798
|
*/
|
|
800
799
|
modifiers?: ItemModifier[];
|
|
801
800
|
}
|
|
802
|
-
|
|
801
|
+
interface TranslatableString {
|
|
803
802
|
/**
|
|
804
803
|
* __Required.__ String 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).
|
|
805
804
|
*
|
|
@@ -820,7 +819,7 @@ export interface TranslatableString {
|
|
|
820
819
|
*/
|
|
821
820
|
translated?: string | null;
|
|
822
821
|
}
|
|
823
|
-
|
|
822
|
+
interface ItemModifier {
|
|
824
823
|
/**
|
|
825
824
|
* Modifier ID.
|
|
826
825
|
* @minLength 1
|
|
@@ -841,7 +840,7 @@ export interface ItemModifier {
|
|
|
841
840
|
price?: Price;
|
|
842
841
|
}
|
|
843
842
|
/** Buyer Info */
|
|
844
|
-
|
|
843
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
845
844
|
/**
|
|
846
845
|
* Visitor ID (if site visitor is not a member).
|
|
847
846
|
* @format GUID
|
|
@@ -864,7 +863,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
864
863
|
email?: string | null;
|
|
865
864
|
}
|
|
866
865
|
/** @oneof */
|
|
867
|
-
|
|
866
|
+
interface BuyerInfoIdOneOf {
|
|
868
867
|
/**
|
|
869
868
|
* Visitor ID (if site visitor is not a member).
|
|
870
869
|
* @format GUID
|
|
@@ -876,7 +875,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
876
875
|
*/
|
|
877
876
|
memberId?: string;
|
|
878
877
|
}
|
|
879
|
-
|
|
878
|
+
declare enum PaymentStatus {
|
|
880
879
|
UNSPECIFIED = "UNSPECIFIED",
|
|
881
880
|
/**
|
|
882
881
|
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
@@ -918,8 +917,8 @@ export declare enum PaymentStatus {
|
|
|
918
917
|
DECLINED = "DECLINED"
|
|
919
918
|
}
|
|
920
919
|
/** @enumType */
|
|
921
|
-
|
|
922
|
-
|
|
920
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
|
|
921
|
+
declare enum FulfillmentStatus {
|
|
923
922
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
924
923
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
925
924
|
/**
|
|
@@ -931,8 +930,8 @@ export declare enum FulfillmentStatus {
|
|
|
931
930
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
932
931
|
}
|
|
933
932
|
/** @enumType */
|
|
934
|
-
|
|
935
|
-
|
|
933
|
+
type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
|
|
934
|
+
declare enum WeightUnit {
|
|
936
935
|
/** Weight unit can't be classified due to an error. */
|
|
937
936
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
938
937
|
/** Kilograms. */
|
|
@@ -941,8 +940,8 @@ export declare enum WeightUnit {
|
|
|
941
940
|
LB = "LB"
|
|
942
941
|
}
|
|
943
942
|
/** @enumType */
|
|
944
|
-
|
|
945
|
-
|
|
943
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
944
|
+
interface CurrencyConversionDetails {
|
|
946
945
|
/**
|
|
947
946
|
* Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
948
947
|
*
|
|
@@ -960,7 +959,7 @@ export interface CurrencyConversionDetails {
|
|
|
960
959
|
*/
|
|
961
960
|
conversionRate?: string | null;
|
|
962
961
|
}
|
|
963
|
-
|
|
962
|
+
interface PriceSummary {
|
|
964
963
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
965
964
|
subtotal?: Price;
|
|
966
965
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -975,14 +974,14 @@ export interface PriceSummary {
|
|
|
975
974
|
totalAdditionalFees?: Price;
|
|
976
975
|
}
|
|
977
976
|
/** Billing Info and shipping details */
|
|
978
|
-
|
|
977
|
+
interface AddressWithContact {
|
|
979
978
|
/** Address. */
|
|
980
979
|
address?: Address;
|
|
981
980
|
/** Contact details. */
|
|
982
981
|
contactDetails?: FullAddressContactDetails;
|
|
983
982
|
}
|
|
984
983
|
/** Physical address */
|
|
985
|
-
|
|
984
|
+
interface Address {
|
|
986
985
|
/**
|
|
987
986
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
988
987
|
* @format COUNTRY
|
|
@@ -1026,20 +1025,20 @@ export interface Address {
|
|
|
1026
1025
|
*/
|
|
1027
1026
|
subdivisionFullname?: string | null;
|
|
1028
1027
|
}
|
|
1029
|
-
|
|
1028
|
+
interface StreetAddress {
|
|
1030
1029
|
/** Street number. */
|
|
1031
1030
|
number?: string;
|
|
1032
1031
|
/** Street name. */
|
|
1033
1032
|
name?: string;
|
|
1034
1033
|
}
|
|
1035
|
-
|
|
1034
|
+
interface AddressLocation {
|
|
1036
1035
|
/** Address latitude. */
|
|
1037
1036
|
latitude?: number | null;
|
|
1038
1037
|
/** Address longitude. */
|
|
1039
1038
|
longitude?: number | null;
|
|
1040
1039
|
}
|
|
1041
1040
|
/** Full contact details for an address */
|
|
1042
|
-
|
|
1041
|
+
interface FullAddressContactDetails {
|
|
1043
1042
|
/**
|
|
1044
1043
|
* First name.
|
|
1045
1044
|
* @maxLength 100
|
|
@@ -1063,7 +1062,7 @@ export interface FullAddressContactDetails {
|
|
|
1063
1062
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1064
1063
|
vatId?: VatId;
|
|
1065
1064
|
}
|
|
1066
|
-
|
|
1065
|
+
interface VatId {
|
|
1067
1066
|
/** Customer's tax ID. */
|
|
1068
1067
|
_id?: string;
|
|
1069
1068
|
/**
|
|
@@ -1076,7 +1075,7 @@ export interface VatId {
|
|
|
1076
1075
|
type?: VatTypeWithLiterals;
|
|
1077
1076
|
}
|
|
1078
1077
|
/** tax info types */
|
|
1079
|
-
|
|
1078
|
+
declare enum VatType {
|
|
1080
1079
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1081
1080
|
/** CPF - for individual tax payers. */
|
|
1082
1081
|
CPF = "CPF",
|
|
@@ -1084,8 +1083,8 @@ export declare enum VatType {
|
|
|
1084
1083
|
CNPJ = "CNPJ"
|
|
1085
1084
|
}
|
|
1086
1085
|
/** @enumType */
|
|
1087
|
-
|
|
1088
|
-
|
|
1086
|
+
type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1087
|
+
interface V1ShippingInformation {
|
|
1089
1088
|
/**
|
|
1090
1089
|
* App Def Id of external provider which was a source of shipping info
|
|
1091
1090
|
* @minLength 1
|
|
@@ -1111,7 +1110,7 @@ export interface V1ShippingInformation {
|
|
|
1111
1110
|
/** Shipping region. */
|
|
1112
1111
|
region?: ShippingRegion;
|
|
1113
1112
|
}
|
|
1114
|
-
|
|
1113
|
+
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1115
1114
|
/** Shipping address and contact details. */
|
|
1116
1115
|
shippingDestination?: AddressWithContact;
|
|
1117
1116
|
/** Pickup details. */
|
|
@@ -1135,20 +1134,20 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
1135
1134
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1136
1135
|
}
|
|
1137
1136
|
/** @oneof */
|
|
1138
|
-
|
|
1137
|
+
interface DeliveryLogisticsAddressOneOf {
|
|
1139
1138
|
/** Shipping address and contact details. */
|
|
1140
1139
|
shippingDestination?: AddressWithContact;
|
|
1141
1140
|
/** Pickup details. */
|
|
1142
1141
|
pickupDetails?: PickupDetails;
|
|
1143
1142
|
}
|
|
1144
|
-
|
|
1143
|
+
interface PickupDetails {
|
|
1145
1144
|
/** Pickup address. */
|
|
1146
1145
|
address?: PickupAddress;
|
|
1147
1146
|
/** Pickup method */
|
|
1148
1147
|
pickupMethod?: PickupMethodWithLiterals;
|
|
1149
1148
|
}
|
|
1150
1149
|
/** Physical address */
|
|
1151
|
-
|
|
1150
|
+
interface PickupAddress {
|
|
1152
1151
|
/**
|
|
1153
1152
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1154
1153
|
* @format COUNTRY
|
|
@@ -1192,20 +1191,20 @@ export interface PickupAddress {
|
|
|
1192
1191
|
*/
|
|
1193
1192
|
subdivisionFullname?: string | null;
|
|
1194
1193
|
}
|
|
1195
|
-
|
|
1194
|
+
declare enum PickupMethod {
|
|
1196
1195
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1197
1196
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1198
1197
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1199
1198
|
}
|
|
1200
1199
|
/** @enumType */
|
|
1201
|
-
|
|
1202
|
-
|
|
1200
|
+
type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1201
|
+
interface DeliveryTimeSlot {
|
|
1203
1202
|
/** Delivery slot starting time. */
|
|
1204
1203
|
from?: Date | null;
|
|
1205
1204
|
/** Delivery slot ending time. */
|
|
1206
1205
|
to?: Date | null;
|
|
1207
1206
|
}
|
|
1208
|
-
|
|
1207
|
+
interface ShippingPrice {
|
|
1209
1208
|
/** Shipping price for display purposes. */
|
|
1210
1209
|
price?: Price;
|
|
1211
1210
|
/**
|
|
@@ -1226,14 +1225,14 @@ export interface ShippingPrice {
|
|
|
1226
1225
|
*/
|
|
1227
1226
|
discount?: Price;
|
|
1228
1227
|
}
|
|
1229
|
-
|
|
1228
|
+
interface ShippingRegion {
|
|
1230
1229
|
/**
|
|
1231
1230
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1232
1231
|
* @maxLength 100
|
|
1233
1232
|
*/
|
|
1234
1233
|
name?: string | null;
|
|
1235
1234
|
}
|
|
1236
|
-
|
|
1235
|
+
declare enum OrderStatus {
|
|
1237
1236
|
/** Order created, but not yet approved or canceled. */
|
|
1238
1237
|
INITIALIZED = "INITIALIZED",
|
|
1239
1238
|
/**
|
|
@@ -1259,15 +1258,15 @@ export declare enum OrderStatus {
|
|
|
1259
1258
|
REJECTED = "REJECTED"
|
|
1260
1259
|
}
|
|
1261
1260
|
/** @enumType */
|
|
1262
|
-
|
|
1263
|
-
|
|
1261
|
+
type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
|
|
1262
|
+
interface TaxSummary {
|
|
1264
1263
|
/**
|
|
1265
1264
|
* Total tax.
|
|
1266
1265
|
* @readonly
|
|
1267
1266
|
*/
|
|
1268
1267
|
totalTax?: Price;
|
|
1269
1268
|
}
|
|
1270
|
-
|
|
1269
|
+
interface OrderTaxInfo {
|
|
1271
1270
|
/** Calculated tax, added from line items. */
|
|
1272
1271
|
totalTax?: Price;
|
|
1273
1272
|
/**
|
|
@@ -1287,7 +1286,7 @@ export interface OrderTaxInfo {
|
|
|
1287
1286
|
* 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.
|
|
1288
1287
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1289
1288
|
*/
|
|
1290
|
-
|
|
1289
|
+
interface OrderTaxBreakdown {
|
|
1291
1290
|
/**
|
|
1292
1291
|
* The name of the tax against which this tax amount was calculated.
|
|
1293
1292
|
* @maxLength 200
|
|
@@ -1314,7 +1313,7 @@ export interface OrderTaxBreakdown {
|
|
|
1314
1313
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1315
1314
|
aggregatedTaxAmount?: Price;
|
|
1316
1315
|
}
|
|
1317
|
-
|
|
1316
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1318
1317
|
/** Applied coupon info. */
|
|
1319
1318
|
coupon?: Coupon;
|
|
1320
1319
|
/** Merchant discount. */
|
|
@@ -1347,7 +1346,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1347
1346
|
_id?: string | null;
|
|
1348
1347
|
}
|
|
1349
1348
|
/** @oneof */
|
|
1350
|
-
|
|
1349
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1351
1350
|
/** Applied coupon info. */
|
|
1352
1351
|
coupon?: Coupon;
|
|
1353
1352
|
/** Merchant discount. */
|
|
@@ -1355,15 +1354,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1355
1354
|
/** Automatic Discount */
|
|
1356
1355
|
discountRule?: DiscountRule;
|
|
1357
1356
|
}
|
|
1358
|
-
|
|
1357
|
+
declare enum DiscountType {
|
|
1359
1358
|
GLOBAL = "GLOBAL",
|
|
1360
1359
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1361
1360
|
SHIPPING = "SHIPPING"
|
|
1362
1361
|
}
|
|
1363
1362
|
/** @enumType */
|
|
1364
|
-
|
|
1363
|
+
type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1365
1364
|
/** Coupon */
|
|
1366
|
-
|
|
1365
|
+
interface Coupon {
|
|
1367
1366
|
/** Coupon ID. */
|
|
1368
1367
|
_id?: string;
|
|
1369
1368
|
/** Coupon code. */
|
|
@@ -1373,7 +1372,7 @@ export interface Coupon {
|
|
|
1373
1372
|
/** Coupon value. */
|
|
1374
1373
|
amount?: Price;
|
|
1375
1374
|
}
|
|
1376
|
-
|
|
1375
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1377
1376
|
/**
|
|
1378
1377
|
* Pre-defined discount reason (optional).
|
|
1379
1378
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1388,7 +1387,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1388
1387
|
amount?: Price;
|
|
1389
1388
|
}
|
|
1390
1389
|
/** @oneof */
|
|
1391
|
-
|
|
1390
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1392
1391
|
/**
|
|
1393
1392
|
* Pre-defined discount reason (optional).
|
|
1394
1393
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1400,14 +1399,14 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1400
1399
|
*/
|
|
1401
1400
|
description?: string | null;
|
|
1402
1401
|
}
|
|
1403
|
-
|
|
1402
|
+
declare enum DiscountReason {
|
|
1404
1403
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1405
1404
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1406
1405
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1407
1406
|
}
|
|
1408
1407
|
/** @enumType */
|
|
1409
|
-
|
|
1410
|
-
|
|
1408
|
+
type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1409
|
+
interface DiscountRule {
|
|
1411
1410
|
/**
|
|
1412
1411
|
* Discount rule ID
|
|
1413
1412
|
* @format GUID
|
|
@@ -1418,7 +1417,7 @@ export interface DiscountRule {
|
|
|
1418
1417
|
/** Discount value. */
|
|
1419
1418
|
amount?: Price;
|
|
1420
1419
|
}
|
|
1421
|
-
|
|
1420
|
+
interface DiscountRuleName {
|
|
1422
1421
|
/**
|
|
1423
1422
|
* Original discount rule name (in site's default language).
|
|
1424
1423
|
* @minLength 1
|
|
@@ -1432,7 +1431,7 @@ export interface DiscountRuleName {
|
|
|
1432
1431
|
*/
|
|
1433
1432
|
translated?: string | null;
|
|
1434
1433
|
}
|
|
1435
|
-
|
|
1434
|
+
interface LineItemDiscount {
|
|
1436
1435
|
/**
|
|
1437
1436
|
* ID of line item the discount applies to.
|
|
1438
1437
|
* @format GUID
|
|
@@ -1441,7 +1440,7 @@ export interface LineItemDiscount {
|
|
|
1441
1440
|
/** Total discount for this line item. */
|
|
1442
1441
|
totalDiscount?: Price;
|
|
1443
1442
|
}
|
|
1444
|
-
|
|
1443
|
+
interface Activity extends ActivityContentOneOf {
|
|
1445
1444
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1446
1445
|
customActivity?: CustomActivity;
|
|
1447
1446
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -1469,7 +1468,7 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
1469
1468
|
type?: ActivityTypeWithLiterals;
|
|
1470
1469
|
}
|
|
1471
1470
|
/** @oneof */
|
|
1472
|
-
|
|
1471
|
+
interface ActivityContentOneOf {
|
|
1473
1472
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1474
1473
|
customActivity?: CustomActivity;
|
|
1475
1474
|
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
@@ -1477,7 +1476,7 @@ export interface ActivityContentOneOf {
|
|
|
1477
1476
|
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1478
1477
|
orderRefunded?: OrderRefunded;
|
|
1479
1478
|
}
|
|
1480
|
-
|
|
1479
|
+
interface CustomActivity {
|
|
1481
1480
|
/**
|
|
1482
1481
|
* ID of the app that created the custom activity.
|
|
1483
1482
|
* @format GUID
|
|
@@ -1492,7 +1491,7 @@ export interface CustomActivity {
|
|
|
1492
1491
|
additionalData?: Record<string, string>;
|
|
1493
1492
|
}
|
|
1494
1493
|
/** Store owner added a comment */
|
|
1495
|
-
|
|
1494
|
+
interface MerchantComment {
|
|
1496
1495
|
/**
|
|
1497
1496
|
* Merchant comment message.
|
|
1498
1497
|
* @minLength 1
|
|
@@ -1500,7 +1499,7 @@ export interface MerchantComment {
|
|
|
1500
1499
|
*/
|
|
1501
1500
|
message?: string;
|
|
1502
1501
|
}
|
|
1503
|
-
|
|
1502
|
+
interface OrderRefunded {
|
|
1504
1503
|
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
1505
1504
|
manual?: boolean;
|
|
1506
1505
|
/** Refund amount. */
|
|
@@ -1511,14 +1510,14 @@ export interface OrderRefunded {
|
|
|
1511
1510
|
*/
|
|
1512
1511
|
reason?: string;
|
|
1513
1512
|
}
|
|
1514
|
-
|
|
1513
|
+
interface OrderCreatedFromExchange {
|
|
1515
1514
|
/**
|
|
1516
1515
|
* ID of the original order for which the exchange happened.
|
|
1517
1516
|
* @format GUID
|
|
1518
1517
|
*/
|
|
1519
1518
|
originalOrderId?: string;
|
|
1520
1519
|
}
|
|
1521
|
-
|
|
1520
|
+
interface NewExchangeOrderCreated {
|
|
1522
1521
|
/**
|
|
1523
1522
|
* ID of the new order created as a result of an exchange of items.
|
|
1524
1523
|
* @format GUID
|
|
@@ -1531,7 +1530,7 @@ export interface NewExchangeOrderCreated {
|
|
|
1531
1530
|
*/
|
|
1532
1531
|
lineItems?: LineItemExchangeData[];
|
|
1533
1532
|
}
|
|
1534
|
-
|
|
1533
|
+
interface LineItemExchangeData {
|
|
1535
1534
|
/**
|
|
1536
1535
|
* ID of the exchanged line item.
|
|
1537
1536
|
* @format GUID
|
|
@@ -1544,7 +1543,7 @@ export interface LineItemExchangeData {
|
|
|
1544
1543
|
*/
|
|
1545
1544
|
quantity?: number;
|
|
1546
1545
|
}
|
|
1547
|
-
|
|
1546
|
+
interface DraftOrderChangesApplied {
|
|
1548
1547
|
/** Draft order id. */
|
|
1549
1548
|
draftOrderId?: string;
|
|
1550
1549
|
/**
|
|
@@ -1555,7 +1554,7 @@ export interface DraftOrderChangesApplied {
|
|
|
1555
1554
|
/** Changes applied to order. */
|
|
1556
1555
|
changes?: OrderChange[];
|
|
1557
1556
|
}
|
|
1558
|
-
|
|
1557
|
+
interface OrderChange extends OrderChangeValueOneOf {
|
|
1559
1558
|
lineItemChanged?: LineItemChanges;
|
|
1560
1559
|
lineItemAdded?: ManagedLineItem;
|
|
1561
1560
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -1567,7 +1566,7 @@ export interface OrderChange extends OrderChangeValueOneOf {
|
|
|
1567
1566
|
shippingInformationChanged?: ShippingInformationChange;
|
|
1568
1567
|
}
|
|
1569
1568
|
/** @oneof */
|
|
1570
|
-
|
|
1569
|
+
interface OrderChangeValueOneOf {
|
|
1571
1570
|
lineItemChanged?: LineItemChanges;
|
|
1572
1571
|
lineItemAdded?: ManagedLineItem;
|
|
1573
1572
|
lineItemRemoved?: ManagedLineItem;
|
|
@@ -1578,7 +1577,7 @@ export interface OrderChangeValueOneOf {
|
|
|
1578
1577
|
totalPriceChanged?: TotalPriceChange;
|
|
1579
1578
|
shippingInformationChanged?: ShippingInformationChange;
|
|
1580
1579
|
}
|
|
1581
|
-
|
|
1580
|
+
interface LineItemChanges {
|
|
1582
1581
|
/**
|
|
1583
1582
|
* Line item ID.
|
|
1584
1583
|
* @format GUID
|
|
@@ -1591,7 +1590,7 @@ export interface LineItemChanges {
|
|
|
1591
1590
|
/** Item price change. */
|
|
1592
1591
|
price?: LineItemPriceChange;
|
|
1593
1592
|
}
|
|
1594
|
-
|
|
1593
|
+
interface LineItemQuantityChange {
|
|
1595
1594
|
/**
|
|
1596
1595
|
* Item quantity before update.
|
|
1597
1596
|
* @max 1000000
|
|
@@ -1611,21 +1610,21 @@ export interface LineItemQuantityChange {
|
|
|
1611
1610
|
/** Type of quantity change: increase or decrease. */
|
|
1612
1611
|
deltaType?: LineItemQuantityChangeTypeWithLiterals;
|
|
1613
1612
|
}
|
|
1614
|
-
|
|
1613
|
+
declare enum LineItemQuantityChangeType {
|
|
1615
1614
|
/** Quantity increased. */
|
|
1616
1615
|
QUANTITY_INCREASED = "QUANTITY_INCREASED",
|
|
1617
1616
|
/** Quantity decreased. */
|
|
1618
1617
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
1619
1618
|
}
|
|
1620
1619
|
/** @enumType */
|
|
1621
|
-
|
|
1622
|
-
|
|
1620
|
+
type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
|
|
1621
|
+
interface LineItemPriceChange {
|
|
1623
1622
|
/** Item price before update. */
|
|
1624
1623
|
originalPrice?: Price;
|
|
1625
1624
|
/** Item price after update. */
|
|
1626
1625
|
newPrice?: Price;
|
|
1627
1626
|
}
|
|
1628
|
-
|
|
1627
|
+
interface ManagedLineItem {
|
|
1629
1628
|
/**
|
|
1630
1629
|
* Line item ID.
|
|
1631
1630
|
* @format GUID
|
|
@@ -1640,7 +1639,7 @@ export interface ManagedLineItem {
|
|
|
1640
1639
|
*/
|
|
1641
1640
|
quantity?: number;
|
|
1642
1641
|
}
|
|
1643
|
-
|
|
1642
|
+
interface ManagedDiscount {
|
|
1644
1643
|
/**
|
|
1645
1644
|
* Discount id.
|
|
1646
1645
|
* @format GUID
|
|
@@ -1653,7 +1652,7 @@ export interface ManagedDiscount {
|
|
|
1653
1652
|
/** Discount amount. */
|
|
1654
1653
|
totalAmount?: Price;
|
|
1655
1654
|
}
|
|
1656
|
-
|
|
1655
|
+
interface TranslatedValue {
|
|
1657
1656
|
/**
|
|
1658
1657
|
* Value in site default language.
|
|
1659
1658
|
* @minLength 1
|
|
@@ -1665,7 +1664,7 @@ export interface TranslatedValue {
|
|
|
1665
1664
|
*/
|
|
1666
1665
|
translated?: string | null;
|
|
1667
1666
|
}
|
|
1668
|
-
|
|
1667
|
+
interface LineItemAmount {
|
|
1669
1668
|
/**
|
|
1670
1669
|
* Order line item id
|
|
1671
1670
|
* @format GUID
|
|
@@ -1676,7 +1675,7 @@ export interface LineItemAmount {
|
|
|
1676
1675
|
/** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
|
|
1677
1676
|
amount?: Price;
|
|
1678
1677
|
}
|
|
1679
|
-
|
|
1678
|
+
interface ManagedAdditionalFee {
|
|
1680
1679
|
/**
|
|
1681
1680
|
* Additional fee id.
|
|
1682
1681
|
* @format GUID
|
|
@@ -1689,19 +1688,19 @@ export interface ManagedAdditionalFee {
|
|
|
1689
1688
|
/** Additional fee amount. */
|
|
1690
1689
|
totalAmount?: Price;
|
|
1691
1690
|
}
|
|
1692
|
-
|
|
1691
|
+
interface TotalPriceChange {
|
|
1693
1692
|
/** Order’s total price after discounts and tax. Before update */
|
|
1694
1693
|
originalTotal?: Price;
|
|
1695
1694
|
/** Order’s total price after discounts and tax. After update */
|
|
1696
1695
|
newTotal?: Price;
|
|
1697
1696
|
}
|
|
1698
|
-
|
|
1697
|
+
interface ShippingInformationChange {
|
|
1699
1698
|
/** Order’s Shipping Information. Before update */
|
|
1700
1699
|
originalShippingInfo?: ShippingInformation;
|
|
1701
1700
|
/** Order’s Shipping Information. After update */
|
|
1702
1701
|
newShippingInfo?: ShippingInformation;
|
|
1703
1702
|
}
|
|
1704
|
-
|
|
1703
|
+
interface ShippingInformation {
|
|
1705
1704
|
/** Order’s shipping price. */
|
|
1706
1705
|
total?: Price;
|
|
1707
1706
|
/**
|
|
@@ -1711,7 +1710,7 @@ export interface ShippingInformation {
|
|
|
1711
1710
|
shippingTitle?: string;
|
|
1712
1711
|
}
|
|
1713
1712
|
/** Payment method is saved for order */
|
|
1714
|
-
|
|
1713
|
+
interface SavedPaymentMethod {
|
|
1715
1714
|
/**
|
|
1716
1715
|
* Payment method name
|
|
1717
1716
|
* @minLength 1
|
|
@@ -1725,7 +1724,7 @@ export interface SavedPaymentMethod {
|
|
|
1725
1724
|
*/
|
|
1726
1725
|
description?: string | null;
|
|
1727
1726
|
}
|
|
1728
|
-
|
|
1727
|
+
interface AuthorizedPaymentCreated {
|
|
1729
1728
|
/**
|
|
1730
1729
|
* Payment ID of payment associated with this activity
|
|
1731
1730
|
* @format GUID
|
|
@@ -1744,7 +1743,7 @@ export interface AuthorizedPaymentCreated {
|
|
|
1744
1743
|
*/
|
|
1745
1744
|
brand?: string | null;
|
|
1746
1745
|
}
|
|
1747
|
-
|
|
1746
|
+
interface AuthorizedPaymentCaptured {
|
|
1748
1747
|
/**
|
|
1749
1748
|
* Payment ID of payment associated with this activity
|
|
1750
1749
|
* @format GUID
|
|
@@ -1763,7 +1762,7 @@ export interface AuthorizedPaymentCaptured {
|
|
|
1763
1762
|
*/
|
|
1764
1763
|
brand?: string | null;
|
|
1765
1764
|
}
|
|
1766
|
-
|
|
1765
|
+
interface AuthorizedPaymentVoided {
|
|
1767
1766
|
/**
|
|
1768
1767
|
* Payment ID of payment associated with this activity
|
|
1769
1768
|
* @format GUID
|
|
@@ -1782,7 +1781,7 @@ export interface AuthorizedPaymentVoided {
|
|
|
1782
1781
|
*/
|
|
1783
1782
|
brand?: string | null;
|
|
1784
1783
|
}
|
|
1785
|
-
|
|
1784
|
+
interface RefundInitiated {
|
|
1786
1785
|
/**
|
|
1787
1786
|
* Refund ID.
|
|
1788
1787
|
* @format GUID
|
|
@@ -1802,7 +1801,7 @@ export interface RefundInitiated {
|
|
|
1802
1801
|
*/
|
|
1803
1802
|
reason?: string | null;
|
|
1804
1803
|
}
|
|
1805
|
-
|
|
1804
|
+
interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
1806
1805
|
/** Regular payment refund. */
|
|
1807
1806
|
regular?: RegularPaymentRefund;
|
|
1808
1807
|
/** Gift card payment refund. */
|
|
@@ -1818,7 +1817,7 @@ export interface RefundedPayment extends RefundedPaymentKindOneOf {
|
|
|
1818
1817
|
externalRefund?: boolean;
|
|
1819
1818
|
}
|
|
1820
1819
|
/** @oneof */
|
|
1821
|
-
|
|
1820
|
+
interface RefundedPaymentKindOneOf {
|
|
1822
1821
|
/** Regular payment refund. */
|
|
1823
1822
|
regular?: RegularPaymentRefund;
|
|
1824
1823
|
/** Gift card payment refund. */
|
|
@@ -1826,7 +1825,7 @@ export interface RefundedPaymentKindOneOf {
|
|
|
1826
1825
|
/** Membership payment refund. */
|
|
1827
1826
|
membership?: MembershipPaymentRefund;
|
|
1828
1827
|
}
|
|
1829
|
-
|
|
1828
|
+
interface RegularPaymentRefund {
|
|
1830
1829
|
/** Refund amount */
|
|
1831
1830
|
amount?: Price;
|
|
1832
1831
|
/**
|
|
@@ -1840,7 +1839,7 @@ export interface RegularPaymentRefund {
|
|
|
1840
1839
|
*/
|
|
1841
1840
|
brand?: string | null;
|
|
1842
1841
|
}
|
|
1843
|
-
|
|
1842
|
+
interface GiftCardPaymentRefund {
|
|
1844
1843
|
/**
|
|
1845
1844
|
* Gift card payment ID
|
|
1846
1845
|
* @minLength 1
|
|
@@ -1850,7 +1849,7 @@ export interface GiftCardPaymentRefund {
|
|
|
1850
1849
|
/** Refund amount */
|
|
1851
1850
|
amount?: Price;
|
|
1852
1851
|
}
|
|
1853
|
-
|
|
1852
|
+
interface MembershipPaymentRefund {
|
|
1854
1853
|
/**
|
|
1855
1854
|
* Membership ID
|
|
1856
1855
|
* @minLength 1
|
|
@@ -1858,7 +1857,7 @@ export interface MembershipPaymentRefund {
|
|
|
1858
1857
|
*/
|
|
1859
1858
|
membershipId?: string | null;
|
|
1860
1859
|
}
|
|
1861
|
-
|
|
1860
|
+
interface PaymentRefunded {
|
|
1862
1861
|
/**
|
|
1863
1862
|
* Refund ID.
|
|
1864
1863
|
* @format GUID
|
|
@@ -1867,7 +1866,7 @@ export interface PaymentRefunded {
|
|
|
1867
1866
|
/** Details about the refunded payment. */
|
|
1868
1867
|
payment?: RefundedPayment;
|
|
1869
1868
|
}
|
|
1870
|
-
|
|
1869
|
+
interface PaymentRefundFailed {
|
|
1871
1870
|
/**
|
|
1872
1871
|
* Refund ID.
|
|
1873
1872
|
* @format GUID
|
|
@@ -1876,7 +1875,7 @@ export interface PaymentRefundFailed {
|
|
|
1876
1875
|
/** Details about the failed payment refund. */
|
|
1877
1876
|
payment?: RefundedPayment;
|
|
1878
1877
|
}
|
|
1879
|
-
|
|
1878
|
+
interface RefundedAsStoreCredit {
|
|
1880
1879
|
/** Refund amount */
|
|
1881
1880
|
amount?: Price;
|
|
1882
1881
|
/**
|
|
@@ -1885,7 +1884,7 @@ export interface RefundedAsStoreCredit {
|
|
|
1885
1884
|
*/
|
|
1886
1885
|
reason?: string | null;
|
|
1887
1886
|
}
|
|
1888
|
-
|
|
1887
|
+
interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
1889
1888
|
/** Regular payment. */
|
|
1890
1889
|
regular?: RegularPayment;
|
|
1891
1890
|
/**
|
|
@@ -1895,22 +1894,22 @@ export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
|
|
|
1895
1894
|
paymentId?: string;
|
|
1896
1895
|
}
|
|
1897
1896
|
/** @oneof */
|
|
1898
|
-
|
|
1897
|
+
interface PaymentPendingPaymentDetailsOneOf {
|
|
1899
1898
|
/** Regular payment. */
|
|
1900
1899
|
regular?: RegularPayment;
|
|
1901
1900
|
}
|
|
1902
|
-
|
|
1901
|
+
interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
|
|
1903
1902
|
/** Whether regular card used */
|
|
1904
1903
|
creditCardDetails?: CreditCardDetails;
|
|
1905
1904
|
/** Payment amount */
|
|
1906
1905
|
amount?: Price;
|
|
1907
1906
|
}
|
|
1908
1907
|
/** @oneof */
|
|
1909
|
-
|
|
1908
|
+
interface RegularPaymentPaymentMethodDetailsOneOf {
|
|
1910
1909
|
/** Whether regular card used */
|
|
1911
1910
|
creditCardDetails?: CreditCardDetails;
|
|
1912
1911
|
}
|
|
1913
|
-
|
|
1912
|
+
interface CreditCardDetails {
|
|
1914
1913
|
/**
|
|
1915
1914
|
* The last 4 digits of the card number.
|
|
1916
1915
|
* @maxLength 4
|
|
@@ -1922,7 +1921,7 @@ export interface CreditCardDetails {
|
|
|
1922
1921
|
*/
|
|
1923
1922
|
brand?: string | null;
|
|
1924
1923
|
}
|
|
1925
|
-
|
|
1924
|
+
interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
1926
1925
|
/** Regular payment. */
|
|
1927
1926
|
regular?: RegularPayment;
|
|
1928
1927
|
/**
|
|
@@ -1932,11 +1931,11 @@ export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
|
|
|
1932
1931
|
paymentId?: string;
|
|
1933
1932
|
}
|
|
1934
1933
|
/** @oneof */
|
|
1935
|
-
|
|
1934
|
+
interface PaymentCanceledPaymentDetailsOneOf {
|
|
1936
1935
|
/** Regular payment. */
|
|
1937
1936
|
regular?: RegularPayment;
|
|
1938
1937
|
}
|
|
1939
|
-
|
|
1938
|
+
interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
1940
1939
|
/** Regular payment. */
|
|
1941
1940
|
regular?: RegularPayment;
|
|
1942
1941
|
/**
|
|
@@ -1946,11 +1945,11 @@ export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
|
|
|
1946
1945
|
paymentId?: string;
|
|
1947
1946
|
}
|
|
1948
1947
|
/** @oneof */
|
|
1949
|
-
|
|
1948
|
+
interface PaymentDeclinedPaymentDetailsOneOf {
|
|
1950
1949
|
/** Regular payment. */
|
|
1951
1950
|
regular?: RegularPayment;
|
|
1952
1951
|
}
|
|
1953
|
-
|
|
1952
|
+
interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
1954
1953
|
/** Receipt created by Wix */
|
|
1955
1954
|
wixReceipt?: WixReceipt;
|
|
1956
1955
|
/** Receipt created by an external system. */
|
|
@@ -1962,13 +1961,13 @@ export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
|
|
|
1962
1961
|
paymentId?: string;
|
|
1963
1962
|
}
|
|
1964
1963
|
/** @oneof */
|
|
1965
|
-
|
|
1964
|
+
interface ReceiptCreatedReceiptInfoOneOf {
|
|
1966
1965
|
/** Receipt created by Wix */
|
|
1967
1966
|
wixReceipt?: WixReceipt;
|
|
1968
1967
|
/** Receipt created by an external system. */
|
|
1969
1968
|
externalReceipt?: ExternalReceipt;
|
|
1970
1969
|
}
|
|
1971
|
-
|
|
1970
|
+
interface WixReceipt {
|
|
1972
1971
|
/**
|
|
1973
1972
|
* Receipt ID
|
|
1974
1973
|
* @format GUID
|
|
@@ -1981,7 +1980,7 @@ export interface WixReceipt {
|
|
|
1981
1980
|
*/
|
|
1982
1981
|
displayNumber?: string | null;
|
|
1983
1982
|
}
|
|
1984
|
-
|
|
1983
|
+
interface ExternalReceipt {
|
|
1985
1984
|
/**
|
|
1986
1985
|
* Receipt ID
|
|
1987
1986
|
* @maxLength 100
|
|
@@ -1994,7 +1993,7 @@ export interface ExternalReceipt {
|
|
|
1994
1993
|
*/
|
|
1995
1994
|
displayNumber?: string | null;
|
|
1996
1995
|
}
|
|
1997
|
-
|
|
1996
|
+
interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
1998
1997
|
/** Receipt created by Wix */
|
|
1999
1998
|
wixReceipt?: WixReceipt;
|
|
2000
1999
|
/** Receipt created by an external system. */
|
|
@@ -2006,13 +2005,13 @@ export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
|
|
|
2006
2005
|
paymentId?: string;
|
|
2007
2006
|
}
|
|
2008
2007
|
/** @oneof */
|
|
2009
|
-
|
|
2008
|
+
interface ReceiptSentReceiptInfoOneOf {
|
|
2010
2009
|
/** Receipt created by Wix */
|
|
2011
2010
|
wixReceipt?: WixReceipt;
|
|
2012
2011
|
/** Receipt created by an external system. */
|
|
2013
2012
|
externalReceipt?: ExternalReceipt;
|
|
2014
2013
|
}
|
|
2015
|
-
|
|
2014
|
+
declare enum ActivityType {
|
|
2016
2015
|
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
2017
2016
|
ORDER_PLACED = "ORDER_PLACED",
|
|
2018
2017
|
ORDER_PAID = "ORDER_PAID",
|
|
@@ -2050,14 +2049,14 @@ export declare enum ActivityType {
|
|
|
2050
2049
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
2051
2050
|
}
|
|
2052
2051
|
/** @enumType */
|
|
2053
|
-
|
|
2054
|
-
|
|
2052
|
+
type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
|
|
2053
|
+
declare enum AttributionSource {
|
|
2055
2054
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2056
2055
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
2057
2056
|
}
|
|
2058
2057
|
/** @enumType */
|
|
2059
|
-
|
|
2060
|
-
|
|
2058
|
+
type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
|
|
2059
|
+
interface CreatedBy extends CreatedByStringOneOf {
|
|
2061
2060
|
/**
|
|
2062
2061
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
2063
2062
|
* For example, via POS (point of service).
|
|
@@ -2081,7 +2080,7 @@ export interface CreatedBy extends CreatedByStringOneOf {
|
|
|
2081
2080
|
appId?: string;
|
|
2082
2081
|
}
|
|
2083
2082
|
/** @oneof */
|
|
2084
|
-
|
|
2083
|
+
interface CreatedByStringOneOf {
|
|
2085
2084
|
/**
|
|
2086
2085
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
2087
2086
|
* For example, via POS (point of service).
|
|
@@ -2104,7 +2103,7 @@ export interface CreatedByStringOneOf {
|
|
|
2104
2103
|
*/
|
|
2105
2104
|
appId?: string;
|
|
2106
2105
|
}
|
|
2107
|
-
|
|
2106
|
+
interface ChannelInfo {
|
|
2108
2107
|
/** Sales channel that submitted the order. */
|
|
2109
2108
|
type?: ChannelTypeWithLiterals;
|
|
2110
2109
|
/**
|
|
@@ -2118,7 +2117,7 @@ export interface ChannelInfo {
|
|
|
2118
2117
|
*/
|
|
2119
2118
|
externalOrderUrl?: string | null;
|
|
2120
2119
|
}
|
|
2121
|
-
|
|
2120
|
+
declare enum ChannelType {
|
|
2122
2121
|
/** Unspecified sales channel. This value is not supported. */
|
|
2123
2122
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2124
2123
|
/** A web client. */
|
|
@@ -2153,8 +2152,8 @@ export declare enum ChannelType {
|
|
|
2153
2152
|
FAIRE_COM = "FAIRE_COM"
|
|
2154
2153
|
}
|
|
2155
2154
|
/** @enumType */
|
|
2156
|
-
|
|
2157
|
-
|
|
2155
|
+
type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
2156
|
+
interface CustomField {
|
|
2158
2157
|
/** Custom field value. */
|
|
2159
2158
|
value?: any;
|
|
2160
2159
|
/**
|
|
@@ -2170,7 +2169,7 @@ export interface CustomField {
|
|
|
2170
2169
|
*/
|
|
2171
2170
|
translatedTitle?: string | null;
|
|
2172
2171
|
}
|
|
2173
|
-
|
|
2172
|
+
interface BalanceSummary {
|
|
2174
2173
|
/**
|
|
2175
2174
|
* Current amount left to pay.
|
|
2176
2175
|
* @readonly
|
|
@@ -2206,7 +2205,7 @@ export interface BalanceSummary {
|
|
|
2206
2205
|
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
2207
2206
|
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
2208
2207
|
*/
|
|
2209
|
-
|
|
2208
|
+
interface Balance {
|
|
2210
2209
|
/**
|
|
2211
2210
|
* Balance amount.
|
|
2212
2211
|
*
|
|
@@ -2221,7 +2220,7 @@ export interface Balance {
|
|
|
2221
2220
|
*/
|
|
2222
2221
|
formattedAmount?: string;
|
|
2223
2222
|
}
|
|
2224
|
-
|
|
2223
|
+
interface AdditionalFee {
|
|
2225
2224
|
/**
|
|
2226
2225
|
* Additional fee's unique code for future processing.
|
|
2227
2226
|
* @minLength 1
|
|
@@ -2260,7 +2259,7 @@ export interface AdditionalFee {
|
|
|
2260
2259
|
*/
|
|
2261
2260
|
lineItemIds?: string[];
|
|
2262
2261
|
}
|
|
2263
|
-
|
|
2262
|
+
interface FulfillmentStatusesAggregate {
|
|
2264
2263
|
/** Unique string values based on Fulfillment entities statuses */
|
|
2265
2264
|
statuses?: string[] | null;
|
|
2266
2265
|
}
|
|
@@ -2286,13 +2285,13 @@ export interface FulfillmentStatusesAggregate {
|
|
|
2286
2285
|
* }
|
|
2287
2286
|
* }
|
|
2288
2287
|
*/
|
|
2289
|
-
|
|
2288
|
+
interface Tags {
|
|
2290
2289
|
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
2291
2290
|
privateTags?: TagList;
|
|
2292
2291
|
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
2293
2292
|
tags?: TagList;
|
|
2294
2293
|
}
|
|
2295
|
-
|
|
2294
|
+
interface TagList {
|
|
2296
2295
|
/**
|
|
2297
2296
|
* List of tag IDs
|
|
2298
2297
|
* @maxSize 100
|
|
@@ -2300,7 +2299,7 @@ export interface TagList {
|
|
|
2300
2299
|
*/
|
|
2301
2300
|
tagIds?: string[];
|
|
2302
2301
|
}
|
|
2303
|
-
|
|
2302
|
+
interface Location {
|
|
2304
2303
|
/**
|
|
2305
2304
|
* Location ID.
|
|
2306
2305
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
@@ -2316,29 +2315,29 @@ export interface Location {
|
|
|
2316
2315
|
name?: string;
|
|
2317
2316
|
}
|
|
2318
2317
|
/** Triggered when the order status changes to approved */
|
|
2319
|
-
|
|
2318
|
+
interface OrderApproved {
|
|
2320
2319
|
/** The order that was updated */
|
|
2321
2320
|
order?: Order;
|
|
2322
2321
|
}
|
|
2323
|
-
|
|
2322
|
+
interface OrdersExperiments {
|
|
2324
2323
|
epCommitTax?: boolean;
|
|
2325
2324
|
moveMerchantEmailToEp?: boolean;
|
|
2326
2325
|
moveBuyerOrderConfirmationEmailToEp?: boolean;
|
|
2327
2326
|
producedByEpBridge?: boolean;
|
|
2328
2327
|
enableRewrittenSideEffects?: boolean;
|
|
2329
2328
|
}
|
|
2330
|
-
|
|
2329
|
+
interface OrderRejectedEventOrderRejected {
|
|
2331
2330
|
/** The order that was rejected */
|
|
2332
2331
|
order?: Order;
|
|
2333
2332
|
}
|
|
2334
2333
|
/** Triggered when order items are marked as restocked */
|
|
2335
|
-
|
|
2334
|
+
interface OrderItemsRestocked {
|
|
2336
2335
|
/** The order which items were restocked */
|
|
2337
2336
|
order?: Order;
|
|
2338
2337
|
/** Restocked items and quantities */
|
|
2339
2338
|
restockItems?: V1RestockItem[];
|
|
2340
2339
|
}
|
|
2341
|
-
|
|
2340
|
+
interface V1RestockItem {
|
|
2342
2341
|
/**
|
|
2343
2342
|
* ID of the line item being restocked.
|
|
2344
2343
|
* @format GUID
|
|
@@ -2351,7 +2350,7 @@ export interface V1RestockItem {
|
|
|
2351
2350
|
*/
|
|
2352
2351
|
quantity?: number;
|
|
2353
2352
|
}
|
|
2354
|
-
|
|
2353
|
+
interface PreparePaymentCollectionRequest {
|
|
2355
2354
|
/**
|
|
2356
2355
|
* Ecom order ID.
|
|
2357
2356
|
* @minLength 1
|
|
@@ -2378,7 +2377,7 @@ export interface PreparePaymentCollectionRequest {
|
|
|
2378
2377
|
/** Delayed capture payment settings */
|
|
2379
2378
|
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
2380
2379
|
}
|
|
2381
|
-
|
|
2380
|
+
interface RedirectUrls {
|
|
2382
2381
|
/**
|
|
2383
2382
|
* URL to redirect buyer in case of approved (successful) transaction
|
|
2384
2383
|
* @format WEB_URL
|
|
@@ -2400,13 +2399,13 @@ export interface RedirectUrls {
|
|
|
2400
2399
|
*/
|
|
2401
2400
|
pendingUrl?: string | null;
|
|
2402
2401
|
}
|
|
2403
|
-
|
|
2402
|
+
interface DelayedCaptureSettings {
|
|
2404
2403
|
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
2405
2404
|
scheduledAction?: ScheduledActionWithLiterals;
|
|
2406
2405
|
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2407
2406
|
delayDuration?: Duration;
|
|
2408
2407
|
}
|
|
2409
|
-
|
|
2408
|
+
declare enum ScheduledAction {
|
|
2410
2409
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2411
2410
|
/** Whether payment will be auto-voided when duration passes */
|
|
2412
2411
|
VOID = "VOID",
|
|
@@ -2414,8 +2413,8 @@ export declare enum ScheduledAction {
|
|
|
2414
2413
|
CAPTURE = "CAPTURE"
|
|
2415
2414
|
}
|
|
2416
2415
|
/** @enumType */
|
|
2417
|
-
|
|
2418
|
-
|
|
2416
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
|
|
2417
|
+
interface Duration {
|
|
2419
2418
|
/**
|
|
2420
2419
|
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
2421
2420
|
* @min 1
|
|
@@ -2424,19 +2423,19 @@ export interface Duration {
|
|
|
2424
2423
|
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
2425
2424
|
unit?: DurationUnitWithLiterals;
|
|
2426
2425
|
}
|
|
2427
|
-
|
|
2426
|
+
declare enum DurationUnit {
|
|
2428
2427
|
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
2429
2428
|
MINUTES = "MINUTES",
|
|
2430
2429
|
HOURS = "HOURS",
|
|
2431
2430
|
DAYS = "DAYS"
|
|
2432
2431
|
}
|
|
2433
2432
|
/** @enumType */
|
|
2434
|
-
|
|
2435
|
-
|
|
2433
|
+
type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
2434
|
+
interface PreparePaymentCollectionResponse {
|
|
2436
2435
|
/** Payment gateway order id which is associated with given payment */
|
|
2437
2436
|
paymentGatewayOrderId?: string;
|
|
2438
2437
|
}
|
|
2439
|
-
|
|
2438
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
2440
2439
|
/**
|
|
2441
2440
|
* Ecom order ID.
|
|
2442
2441
|
* @minLength 1
|
|
@@ -2444,13 +2443,13 @@ export interface GetPaymentCollectabilityStatusRequest {
|
|
|
2444
2443
|
*/
|
|
2445
2444
|
ecomOrderId: string;
|
|
2446
2445
|
}
|
|
2447
|
-
|
|
2446
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
2448
2447
|
/** Payment collectability status */
|
|
2449
2448
|
status?: PaymentCollectabilityStatusWithLiterals;
|
|
2450
2449
|
/** Collectable order amount */
|
|
2451
2450
|
amount?: Price;
|
|
2452
2451
|
}
|
|
2453
|
-
|
|
2452
|
+
declare enum PaymentCollectabilityStatus {
|
|
2454
2453
|
UNKNOWN = "UNKNOWN",
|
|
2455
2454
|
COLLECTABLE = "COLLECTABLE",
|
|
2456
2455
|
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
@@ -2461,8 +2460,8 @@ export declare enum PaymentCollectabilityStatus {
|
|
|
2461
2460
|
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2462
2461
|
}
|
|
2463
2462
|
/** @enumType */
|
|
2464
|
-
|
|
2465
|
-
|
|
2463
|
+
type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS';
|
|
2464
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
2466
2465
|
/**
|
|
2467
2466
|
* Order ID.
|
|
2468
2467
|
* @minLength 1
|
|
@@ -2472,9 +2471,9 @@ export interface RecordManuallyCollectedPaymentRequest {
|
|
|
2472
2471
|
/** Amount to be recorded as approved manual payment for given order */
|
|
2473
2472
|
amount: Price;
|
|
2474
2473
|
}
|
|
2475
|
-
|
|
2474
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
2476
2475
|
}
|
|
2477
|
-
|
|
2476
|
+
interface MarkOrderAsPaidRequest {
|
|
2478
2477
|
/**
|
|
2479
2478
|
* Ecom order ID.
|
|
2480
2479
|
* @minLength 1
|
|
@@ -2482,18 +2481,18 @@ export interface MarkOrderAsPaidRequest {
|
|
|
2482
2481
|
*/
|
|
2483
2482
|
ecomOrderId: string;
|
|
2484
2483
|
}
|
|
2485
|
-
|
|
2484
|
+
interface MarkOrderAsPaidResponse {
|
|
2486
2485
|
/** Updated order. */
|
|
2487
2486
|
order?: Order;
|
|
2488
2487
|
}
|
|
2489
2488
|
/** Triggered when the payment status of an order is updated */
|
|
2490
|
-
|
|
2489
|
+
interface PaymentStatusUpdated {
|
|
2491
2490
|
/** The order that was updated */
|
|
2492
2491
|
order?: Order;
|
|
2493
2492
|
/** The previous status (before the update) */
|
|
2494
2493
|
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
2495
2494
|
}
|
|
2496
|
-
|
|
2495
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
2497
2496
|
/**
|
|
2498
2497
|
* IDs of orders to mark as paid.
|
|
2499
2498
|
* @minSize 1
|
|
@@ -2503,7 +2502,7 @@ export interface BulkMarkOrdersAsPaidRequest {
|
|
|
2503
2502
|
*/
|
|
2504
2503
|
ecomOrderIds: string[];
|
|
2505
2504
|
}
|
|
2506
|
-
|
|
2505
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
2507
2506
|
/**
|
|
2508
2507
|
* Items updated by the bulk action.
|
|
2509
2508
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -2512,7 +2511,7 @@ export interface BulkMarkOrdersAsPaidResponse {
|
|
|
2512
2511
|
/** Bulk action metadata. */
|
|
2513
2512
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2514
2513
|
}
|
|
2515
|
-
|
|
2514
|
+
interface BulkOrderResult {
|
|
2516
2515
|
/** Item metadata. */
|
|
2517
2516
|
itemMetadata?: ItemMetadata;
|
|
2518
2517
|
/**
|
|
@@ -2522,7 +2521,7 @@ export interface BulkOrderResult {
|
|
|
2522
2521
|
*/
|
|
2523
2522
|
item?: Order;
|
|
2524
2523
|
}
|
|
2525
|
-
|
|
2524
|
+
interface ItemMetadata {
|
|
2526
2525
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2527
2526
|
_id?: string | null;
|
|
2528
2527
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -2532,7 +2531,7 @@ export interface ItemMetadata {
|
|
|
2532
2531
|
/** Details about the error in case of failure. */
|
|
2533
2532
|
error?: ApplicationError;
|
|
2534
2533
|
}
|
|
2535
|
-
|
|
2534
|
+
interface ApplicationError {
|
|
2536
2535
|
/** Error code. */
|
|
2537
2536
|
code?: string;
|
|
2538
2537
|
/** Description of the error. */
|
|
@@ -2540,7 +2539,7 @@ export interface ApplicationError {
|
|
|
2540
2539
|
/** Data related to the error. */
|
|
2541
2540
|
data?: Record<string, any> | null;
|
|
2542
2541
|
}
|
|
2543
|
-
|
|
2542
|
+
interface BulkActionMetadata {
|
|
2544
2543
|
/** Number of items that were successfully processed. */
|
|
2545
2544
|
totalSuccesses?: number;
|
|
2546
2545
|
/** Number of items that couldn't be processed. */
|
|
@@ -2548,7 +2547,7 @@ export interface BulkActionMetadata {
|
|
|
2548
2547
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2549
2548
|
undetailedFailures?: number;
|
|
2550
2549
|
}
|
|
2551
|
-
|
|
2550
|
+
interface GetRefundabilityStatusRequest {
|
|
2552
2551
|
/**
|
|
2553
2552
|
* Order ID.
|
|
2554
2553
|
* @minLength 1
|
|
@@ -2556,7 +2555,7 @@ export interface GetRefundabilityStatusRequest {
|
|
|
2556
2555
|
*/
|
|
2557
2556
|
ecomOrderId: string;
|
|
2558
2557
|
}
|
|
2559
|
-
|
|
2558
|
+
interface GetRefundabilityStatusResponse {
|
|
2560
2559
|
/**
|
|
2561
2560
|
* Refundability details.
|
|
2562
2561
|
* @maxSize 300
|
|
@@ -2568,7 +2567,7 @@ export interface GetRefundabilityStatusResponse {
|
|
|
2568
2567
|
*/
|
|
2569
2568
|
refundablePerItem?: boolean;
|
|
2570
2569
|
}
|
|
2571
|
-
|
|
2570
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2572
2571
|
/** Reason why payment is not refundable. */
|
|
2573
2572
|
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2574
2573
|
/** Reason why payment is only refundable manually. */
|
|
@@ -2581,20 +2580,20 @@ export interface Refundability extends RefundabilityAdditionalRefundabilityInfoO
|
|
|
2581
2580
|
providerLink?: string | null;
|
|
2582
2581
|
}
|
|
2583
2582
|
/** @oneof */
|
|
2584
|
-
|
|
2583
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2585
2584
|
/** Reason why payment is not refundable. */
|
|
2586
2585
|
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2587
2586
|
/** Reason why payment is only refundable manually. */
|
|
2588
2587
|
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2589
2588
|
}
|
|
2590
|
-
|
|
2589
|
+
declare enum RefundableStatus {
|
|
2591
2590
|
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2592
2591
|
MANUAL = "MANUAL",
|
|
2593
2592
|
REFUNDABLE = "REFUNDABLE"
|
|
2594
2593
|
}
|
|
2595
2594
|
/** @enumType */
|
|
2596
|
-
|
|
2597
|
-
|
|
2595
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
2596
|
+
declare enum NonRefundableReason {
|
|
2598
2597
|
NONE = "NONE",
|
|
2599
2598
|
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
2600
2599
|
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
@@ -2610,16 +2609,16 @@ export declare enum NonRefundableReason {
|
|
|
2610
2609
|
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
2611
2610
|
}
|
|
2612
2611
|
/** @enumType */
|
|
2613
|
-
|
|
2614
|
-
|
|
2612
|
+
type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
|
|
2613
|
+
declare enum ManuallyRefundableReason {
|
|
2615
2614
|
EXPIRED = "EXPIRED",
|
|
2616
2615
|
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
2617
2616
|
OFFLINE = "OFFLINE",
|
|
2618
2617
|
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2619
2618
|
}
|
|
2620
2619
|
/** @enumType */
|
|
2621
|
-
|
|
2622
|
-
|
|
2620
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
2621
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
2623
2622
|
/**
|
|
2624
2623
|
* Ecom order ID.
|
|
2625
2624
|
* @minLength 1
|
|
@@ -2629,7 +2628,7 @@ export interface CreatePaymentGatewayOrderRequest {
|
|
|
2629
2628
|
/** Information about the user who initiated the payment. */
|
|
2630
2629
|
chargedBy?: ChargedBy;
|
|
2631
2630
|
}
|
|
2632
|
-
|
|
2631
|
+
interface ChargedBy {
|
|
2633
2632
|
/**
|
|
2634
2633
|
* ID - id of the user who initiated the payment
|
|
2635
2634
|
* @format GUID
|
|
@@ -2642,11 +2641,11 @@ export interface ChargedBy {
|
|
|
2642
2641
|
*/
|
|
2643
2642
|
fullName?: string | null;
|
|
2644
2643
|
}
|
|
2645
|
-
|
|
2644
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
2646
2645
|
/** ID of the order created in the payment gateway */
|
|
2647
2646
|
paymentGatewayOrderId?: string;
|
|
2648
2647
|
}
|
|
2649
|
-
|
|
2648
|
+
interface ChargeMembershipsRequest {
|
|
2650
2649
|
/**
|
|
2651
2650
|
* Order ID.
|
|
2652
2651
|
* @minLength 1
|
|
@@ -2666,7 +2665,7 @@ export interface ChargeMembershipsRequest {
|
|
|
2666
2665
|
*/
|
|
2667
2666
|
membershipCharges?: MembershipChargeItem[];
|
|
2668
2667
|
}
|
|
2669
|
-
|
|
2668
|
+
interface MembershipChargeItem {
|
|
2670
2669
|
/**
|
|
2671
2670
|
* The id of used membership
|
|
2672
2671
|
* @minLength 1
|
|
@@ -2701,7 +2700,7 @@ export interface MembershipChargeItem {
|
|
|
2701
2700
|
*/
|
|
2702
2701
|
lineItemId?: string;
|
|
2703
2702
|
}
|
|
2704
|
-
|
|
2703
|
+
interface MembershipName {
|
|
2705
2704
|
/**
|
|
2706
2705
|
* Membership name.
|
|
2707
2706
|
* @maxLength 100
|
|
@@ -2713,7 +2712,7 @@ export interface MembershipName {
|
|
|
2713
2712
|
*/
|
|
2714
2713
|
translated?: string | null;
|
|
2715
2714
|
}
|
|
2716
|
-
|
|
2715
|
+
interface ServiceProperties {
|
|
2717
2716
|
/**
|
|
2718
2717
|
* 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.
|
|
2719
2718
|
* For example, the start time of a class.
|
|
@@ -2726,9 +2725,9 @@ export interface ServiceProperties {
|
|
|
2726
2725
|
*/
|
|
2727
2726
|
numberOfParticipants?: number | null;
|
|
2728
2727
|
}
|
|
2729
|
-
|
|
2728
|
+
interface ChargeMembershipsResponse {
|
|
2730
2729
|
}
|
|
2731
|
-
|
|
2730
|
+
interface TriggerRefundRequest {
|
|
2732
2731
|
/**
|
|
2733
2732
|
* The order this refund related to
|
|
2734
2733
|
* @minLength 1
|
|
@@ -2746,7 +2745,7 @@ export interface TriggerRefundRequest {
|
|
|
2746
2745
|
/** Side effect details related to refund */
|
|
2747
2746
|
sideEffects?: RefundSideEffects;
|
|
2748
2747
|
}
|
|
2749
|
-
|
|
2748
|
+
interface PaymentRefund {
|
|
2750
2749
|
/**
|
|
2751
2750
|
* Specific payment within the order to refund
|
|
2752
2751
|
* @format GUID
|
|
@@ -2762,7 +2761,7 @@ export interface PaymentRefund {
|
|
|
2762
2761
|
externalRefund?: boolean;
|
|
2763
2762
|
}
|
|
2764
2763
|
/** Business model of a refund request */
|
|
2765
|
-
|
|
2764
|
+
interface RefundDetails {
|
|
2766
2765
|
/**
|
|
2767
2766
|
* Order line item IDs and quantities that were refunded.
|
|
2768
2767
|
* @maxSize 300
|
|
@@ -2788,7 +2787,7 @@ export interface RefundDetails {
|
|
|
2788
2787
|
/** Shipping amount that was refunded. */
|
|
2789
2788
|
shipping?: ShippingRefund;
|
|
2790
2789
|
}
|
|
2791
|
-
|
|
2790
|
+
interface RefundItem {
|
|
2792
2791
|
/**
|
|
2793
2792
|
* Line item ID the refunded line item.
|
|
2794
2793
|
* @format GUID
|
|
@@ -2801,7 +2800,7 @@ export interface RefundItem {
|
|
|
2801
2800
|
*/
|
|
2802
2801
|
quantity?: number;
|
|
2803
2802
|
}
|
|
2804
|
-
|
|
2803
|
+
interface LineItemRefund {
|
|
2805
2804
|
/**
|
|
2806
2805
|
* Line item ID.
|
|
2807
2806
|
* @format GUID
|
|
@@ -2816,7 +2815,7 @@ export interface LineItemRefund {
|
|
|
2816
2815
|
*/
|
|
2817
2816
|
quantity?: number;
|
|
2818
2817
|
}
|
|
2819
|
-
|
|
2818
|
+
interface AdditionalFeeRefund {
|
|
2820
2819
|
/**
|
|
2821
2820
|
* Additional fee ID.
|
|
2822
2821
|
* @format GUID
|
|
@@ -2829,14 +2828,14 @@ export interface AdditionalFeeRefund {
|
|
|
2829
2828
|
*/
|
|
2830
2829
|
amount?: Price;
|
|
2831
2830
|
}
|
|
2832
|
-
|
|
2831
|
+
interface ShippingRefund {
|
|
2833
2832
|
/**
|
|
2834
2833
|
* Refund amount.
|
|
2835
2834
|
* @immutable
|
|
2836
2835
|
*/
|
|
2837
2836
|
amount?: Price;
|
|
2838
2837
|
}
|
|
2839
|
-
|
|
2838
|
+
interface RefundSideEffects {
|
|
2840
2839
|
/** Inventory restock details as part of this refund. */
|
|
2841
2840
|
restockInfo?: RestockInfo;
|
|
2842
2841
|
/** Whether to send a refund confirmation email to the customer. */
|
|
@@ -2848,7 +2847,7 @@ export interface RefundSideEffects {
|
|
|
2848
2847
|
*/
|
|
2849
2848
|
customMessage?: string | null;
|
|
2850
2849
|
}
|
|
2851
|
-
|
|
2850
|
+
interface RestockInfo {
|
|
2852
2851
|
/** Restock type. */
|
|
2853
2852
|
type?: RestockTypeWithLiterals;
|
|
2854
2853
|
/**
|
|
@@ -2857,14 +2856,14 @@ export interface RestockInfo {
|
|
|
2857
2856
|
*/
|
|
2858
2857
|
items?: RestockItem[];
|
|
2859
2858
|
}
|
|
2860
|
-
|
|
2859
|
+
declare enum RestockType {
|
|
2861
2860
|
NO_ITEMS = "NO_ITEMS",
|
|
2862
2861
|
ALL_ITEMS = "ALL_ITEMS",
|
|
2863
2862
|
SOME_ITEMS = "SOME_ITEMS"
|
|
2864
2863
|
}
|
|
2865
2864
|
/** @enumType */
|
|
2866
|
-
|
|
2867
|
-
|
|
2865
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
2866
|
+
interface RestockItem {
|
|
2868
2867
|
/**
|
|
2869
2868
|
* ID of the line item being restocked.
|
|
2870
2869
|
* @format GUID
|
|
@@ -2877,7 +2876,7 @@ export interface RestockItem {
|
|
|
2877
2876
|
*/
|
|
2878
2877
|
quantity?: number;
|
|
2879
2878
|
}
|
|
2880
|
-
|
|
2879
|
+
interface TriggerRefundResponse {
|
|
2881
2880
|
/** All order's transactions after the refunds were added */
|
|
2882
2881
|
orderTransactions?: OrderTransactions;
|
|
2883
2882
|
/** Created refund ID */
|
|
@@ -2885,7 +2884,7 @@ export interface TriggerRefundResponse {
|
|
|
2885
2884
|
/** Payment ID's that the refund execution had failed for */
|
|
2886
2885
|
failedPaymentIds?: ItemMetadata[];
|
|
2887
2886
|
}
|
|
2888
|
-
|
|
2887
|
+
interface OrderTransactions {
|
|
2889
2888
|
/**
|
|
2890
2889
|
* Order ID.
|
|
2891
2890
|
* @format GUID
|
|
@@ -2902,7 +2901,7 @@ export interface OrderTransactions {
|
|
|
2902
2901
|
*/
|
|
2903
2902
|
refunds?: Refund[];
|
|
2904
2903
|
}
|
|
2905
|
-
|
|
2904
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
2906
2905
|
/** Regular payment details. */
|
|
2907
2906
|
regularPaymentDetails?: RegularPaymentDetails;
|
|
2908
2907
|
/** Gift card payment details. */
|
|
@@ -2930,16 +2929,16 @@ export interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoO
|
|
|
2930
2929
|
refundDisabled?: boolean;
|
|
2931
2930
|
}
|
|
2932
2931
|
/** @oneof */
|
|
2933
|
-
|
|
2932
|
+
interface PaymentPaymentDetailsOneOf {
|
|
2934
2933
|
/** Regular payment details. */
|
|
2935
2934
|
regularPaymentDetails?: RegularPaymentDetails;
|
|
2936
2935
|
/** Gift card payment details. */
|
|
2937
2936
|
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2938
2937
|
}
|
|
2939
2938
|
/** @oneof */
|
|
2940
|
-
|
|
2939
|
+
interface PaymentReceiptInfoOneOf {
|
|
2941
2940
|
}
|
|
2942
|
-
|
|
2941
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2943
2942
|
/** Whether regular card used */
|
|
2944
2943
|
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2945
2944
|
/**
|
|
@@ -2977,11 +2976,11 @@ export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMetho
|
|
|
2977
2976
|
authorizationDetails?: AuthorizationDetails;
|
|
2978
2977
|
}
|
|
2979
2978
|
/** @oneof */
|
|
2980
|
-
|
|
2979
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2981
2980
|
/** Whether regular card used */
|
|
2982
2981
|
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2983
2982
|
}
|
|
2984
|
-
|
|
2983
|
+
declare enum TransactionStatus {
|
|
2985
2984
|
UNDEFINED = "UNDEFINED",
|
|
2986
2985
|
APPROVED = "APPROVED",
|
|
2987
2986
|
PENDING = "PENDING",
|
|
@@ -2994,8 +2993,8 @@ export declare enum TransactionStatus {
|
|
|
2994
2993
|
VOIDED = "VOIDED"
|
|
2995
2994
|
}
|
|
2996
2995
|
/** @enumType */
|
|
2997
|
-
|
|
2998
|
-
|
|
2996
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
2997
|
+
interface CreditCardPaymentMethodDetails {
|
|
2999
2998
|
/**
|
|
3000
2999
|
* The last 4 digits of the card number.
|
|
3001
3000
|
* @maxLength 4
|
|
@@ -3007,7 +3006,7 @@ export interface CreditCardPaymentMethodDetails {
|
|
|
3007
3006
|
*/
|
|
3008
3007
|
brand?: string | null;
|
|
3009
3008
|
}
|
|
3010
|
-
|
|
3009
|
+
interface AuthorizationDetails {
|
|
3011
3010
|
/**
|
|
3012
3011
|
* Whether the authorized payment is of a delayed capture.
|
|
3013
3012
|
* @readonly
|
|
@@ -3026,7 +3025,7 @@ export interface AuthorizationDetails {
|
|
|
3026
3025
|
/** Scheduled action for this transaction */
|
|
3027
3026
|
scheduledAction?: V1ScheduledAction;
|
|
3028
3027
|
}
|
|
3029
|
-
|
|
3028
|
+
interface AuthorizationCapture {
|
|
3030
3029
|
/**
|
|
3031
3030
|
* Capture ID.
|
|
3032
3031
|
* @format GUID
|
|
@@ -3045,7 +3044,7 @@ export interface AuthorizationCapture {
|
|
|
3045
3044
|
/** In case of status is FAILED may contain failure details */
|
|
3046
3045
|
failureDetails?: AuthorizationActionFailureDetails;
|
|
3047
3046
|
}
|
|
3048
|
-
|
|
3047
|
+
declare enum AuthorizationCaptureStatus {
|
|
3049
3048
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3050
3049
|
/** Capture operation still in progress. */
|
|
3051
3050
|
PENDING = "PENDING",
|
|
@@ -3055,12 +3054,12 @@ export declare enum AuthorizationCaptureStatus {
|
|
|
3055
3054
|
FAILED = "FAILED"
|
|
3056
3055
|
}
|
|
3057
3056
|
/** @enumType */
|
|
3058
|
-
|
|
3059
|
-
|
|
3057
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3058
|
+
interface AuthorizationActionFailureDetails {
|
|
3060
3059
|
/** @maxLength 100 */
|
|
3061
3060
|
failureCode?: string;
|
|
3062
3061
|
}
|
|
3063
|
-
|
|
3062
|
+
interface AuthorizationVoid {
|
|
3064
3063
|
/** Status of this void action */
|
|
3065
3064
|
status?: AuthorizationVoidStatusWithLiterals;
|
|
3066
3065
|
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
@@ -3070,7 +3069,7 @@ export interface AuthorizationVoid {
|
|
|
3070
3069
|
/** Reason of void action */
|
|
3071
3070
|
reason?: ReasonWithLiterals;
|
|
3072
3071
|
}
|
|
3073
|
-
|
|
3072
|
+
declare enum AuthorizationVoidStatus {
|
|
3074
3073
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3075
3074
|
/** Void operation still in progress. */
|
|
3076
3075
|
PENDING = "PENDING",
|
|
@@ -3080,9 +3079,9 @@ export declare enum AuthorizationVoidStatus {
|
|
|
3080
3079
|
FAILED = "FAILED"
|
|
3081
3080
|
}
|
|
3082
3081
|
/** @enumType */
|
|
3083
|
-
|
|
3082
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3084
3083
|
/** Reason the authorization was voided. */
|
|
3085
|
-
|
|
3084
|
+
declare enum Reason {
|
|
3086
3085
|
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
3087
3086
|
/** Authorization was voided by user. */
|
|
3088
3087
|
MANUAL = "MANUAL",
|
|
@@ -3090,21 +3089,21 @@ export declare enum Reason {
|
|
|
3090
3089
|
SCHEDULED = "SCHEDULED"
|
|
3091
3090
|
}
|
|
3092
3091
|
/** @enumType */
|
|
3093
|
-
|
|
3094
|
-
|
|
3092
|
+
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
3093
|
+
interface V1ScheduledAction {
|
|
3095
3094
|
/** Type of the action. */
|
|
3096
3095
|
actionType?: ActionTypeWithLiterals;
|
|
3097
3096
|
/** The date and time of the action. */
|
|
3098
3097
|
executionDate?: Date | null;
|
|
3099
3098
|
}
|
|
3100
|
-
|
|
3099
|
+
declare enum ActionType {
|
|
3101
3100
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
3102
3101
|
VOID = "VOID",
|
|
3103
3102
|
CAPTURE = "CAPTURE"
|
|
3104
3103
|
}
|
|
3105
3104
|
/** @enumType */
|
|
3106
|
-
|
|
3107
|
-
|
|
3105
|
+
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3106
|
+
interface GiftCardPaymentDetails {
|
|
3108
3107
|
/**
|
|
3109
3108
|
* Gift card payment ID.
|
|
3110
3109
|
* @minLength 1
|
|
@@ -3122,7 +3121,7 @@ export interface GiftCardPaymentDetails {
|
|
|
3122
3121
|
*/
|
|
3123
3122
|
voided?: boolean;
|
|
3124
3123
|
}
|
|
3125
|
-
|
|
3124
|
+
interface MembershipPaymentDetails {
|
|
3126
3125
|
/**
|
|
3127
3126
|
* Membership ID.
|
|
3128
3127
|
* @minLength 1
|
|
@@ -3156,15 +3155,15 @@ export interface MembershipPaymentDetails {
|
|
|
3156
3155
|
*/
|
|
3157
3156
|
providerAppId?: string;
|
|
3158
3157
|
}
|
|
3159
|
-
|
|
3158
|
+
declare enum MembershipPaymentStatus {
|
|
3160
3159
|
/** Payment was charged. */
|
|
3161
3160
|
CHARGED = "CHARGED",
|
|
3162
3161
|
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3163
3162
|
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3164
3163
|
}
|
|
3165
3164
|
/** @enumType */
|
|
3166
|
-
|
|
3167
|
-
|
|
3165
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
3166
|
+
interface WixReceiptInfo {
|
|
3168
3167
|
/**
|
|
3169
3168
|
* Receipt ID
|
|
3170
3169
|
* @format GUID
|
|
@@ -3177,7 +3176,7 @@ export interface WixReceiptInfo {
|
|
|
3177
3176
|
*/
|
|
3178
3177
|
displayNumber?: string | null;
|
|
3179
3178
|
}
|
|
3180
|
-
|
|
3179
|
+
interface ExternalReceiptInfo {
|
|
3181
3180
|
/**
|
|
3182
3181
|
* External receipt ID
|
|
3183
3182
|
* @maxLength 100
|
|
@@ -3195,7 +3194,7 @@ export interface ExternalReceiptInfo {
|
|
|
3195
3194
|
*/
|
|
3196
3195
|
displayNumber?: string | null;
|
|
3197
3196
|
}
|
|
3198
|
-
|
|
3197
|
+
interface Refund {
|
|
3199
3198
|
/**
|
|
3200
3199
|
* Refund ID.
|
|
3201
3200
|
* @format GUID
|
|
@@ -3228,7 +3227,7 @@ export interface Refund {
|
|
|
3228
3227
|
*/
|
|
3229
3228
|
requestingServiceAppId?: string | null;
|
|
3230
3229
|
}
|
|
3231
|
-
|
|
3230
|
+
interface RefundTransaction {
|
|
3232
3231
|
/**
|
|
3233
3232
|
* ID of the payment associated with this refund.
|
|
3234
3233
|
* @format GUID
|
|
@@ -3259,7 +3258,7 @@ export interface RefundTransaction {
|
|
|
3259
3258
|
externalRefund?: boolean;
|
|
3260
3259
|
}
|
|
3261
3260
|
/** Refund transaction status. */
|
|
3262
|
-
|
|
3261
|
+
declare enum RefundStatus {
|
|
3263
3262
|
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
3264
3263
|
PENDING = "PENDING",
|
|
3265
3264
|
/** Refund transaction succeeded. */
|
|
@@ -3272,8 +3271,8 @@ export declare enum RefundStatus {
|
|
|
3272
3271
|
STARTED = "STARTED"
|
|
3273
3272
|
}
|
|
3274
3273
|
/** @enumType */
|
|
3275
|
-
|
|
3276
|
-
|
|
3274
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
3275
|
+
interface RefundStatusInfo {
|
|
3277
3276
|
/**
|
|
3278
3277
|
* Reason code for the refund's current status.
|
|
3279
3278
|
*
|
|
@@ -3289,7 +3288,7 @@ export interface RefundStatusInfo {
|
|
|
3289
3288
|
*/
|
|
3290
3289
|
description?: string | null;
|
|
3291
3290
|
}
|
|
3292
|
-
|
|
3291
|
+
interface AggregatedRefundSummary {
|
|
3293
3292
|
/** Total amount requested for refund. */
|
|
3294
3293
|
requestedRefund?: Price;
|
|
3295
3294
|
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
@@ -3303,14 +3302,14 @@ export interface AggregatedRefundSummary {
|
|
|
3303
3302
|
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
3304
3303
|
breakdown?: RefundItemsBreakdown;
|
|
3305
3304
|
}
|
|
3306
|
-
|
|
3305
|
+
interface RefundItemsBreakdown {
|
|
3307
3306
|
/**
|
|
3308
3307
|
* Refunded line items and the amount refunded for each.
|
|
3309
3308
|
* @maxSize 300
|
|
3310
3309
|
*/
|
|
3311
3310
|
lineItems?: LineItemRefundSummary[];
|
|
3312
3311
|
}
|
|
3313
|
-
|
|
3312
|
+
interface LineItemRefundSummary {
|
|
3314
3313
|
/**
|
|
3315
3314
|
* ID of the refunded line item.
|
|
3316
3315
|
* @format GUID
|
|
@@ -3319,7 +3318,7 @@ export interface LineItemRefundSummary {
|
|
|
3319
3318
|
/** Total refunded amount for the line item. */
|
|
3320
3319
|
totalRefundedAmount?: Price;
|
|
3321
3320
|
}
|
|
3322
|
-
|
|
3321
|
+
interface CalculateRefundRequest {
|
|
3323
3322
|
/**
|
|
3324
3323
|
* Order ID
|
|
3325
3324
|
* @minLength 1
|
|
@@ -3334,7 +3333,7 @@ export interface CalculateRefundRequest {
|
|
|
3334
3333
|
/** Should include shipping in refund calculation */
|
|
3335
3334
|
refundShipping?: boolean;
|
|
3336
3335
|
}
|
|
3337
|
-
|
|
3336
|
+
interface CalculateRefundItemRequest {
|
|
3338
3337
|
/**
|
|
3339
3338
|
* ID of the line item being refunded
|
|
3340
3339
|
* @format GUID
|
|
@@ -3347,7 +3346,7 @@ export interface CalculateRefundItemRequest {
|
|
|
3347
3346
|
*/
|
|
3348
3347
|
quantity?: number;
|
|
3349
3348
|
}
|
|
3350
|
-
|
|
3349
|
+
interface CalculateRefundResponse {
|
|
3351
3350
|
/** Total refundable amount */
|
|
3352
3351
|
total?: Price;
|
|
3353
3352
|
/** Tax cost of the order */
|
|
@@ -3366,7 +3365,7 @@ export interface CalculateRefundResponse {
|
|
|
3366
3365
|
*/
|
|
3367
3366
|
items?: CalculateRefundItemResponse[];
|
|
3368
3367
|
}
|
|
3369
|
-
|
|
3368
|
+
interface CalculateRefundItemResponse {
|
|
3370
3369
|
/**
|
|
3371
3370
|
* Line item ID
|
|
3372
3371
|
* @format GUID
|
|
@@ -3375,7 +3374,7 @@ export interface CalculateRefundItemResponse {
|
|
|
3375
3374
|
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
3376
3375
|
price?: Price;
|
|
3377
3376
|
}
|
|
3378
|
-
|
|
3377
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
3379
3378
|
/**
|
|
3380
3379
|
* Wix eCommerce order ID
|
|
3381
3380
|
* @minLength 1
|
|
@@ -3390,11 +3389,11 @@ export interface VoidAuthorizedPaymentsRequest {
|
|
|
3390
3389
|
*/
|
|
3391
3390
|
paymentIds: string[];
|
|
3392
3391
|
}
|
|
3393
|
-
|
|
3392
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
3394
3393
|
/** All order's transactions after the void was triggered */
|
|
3395
3394
|
orderTransactions?: OrderTransactions;
|
|
3396
3395
|
}
|
|
3397
|
-
|
|
3396
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
3398
3397
|
/**
|
|
3399
3398
|
* Wix eCommerce order ID
|
|
3400
3399
|
* @minLength 1
|
|
@@ -3408,7 +3407,7 @@ export interface CaptureAuthorizedPaymentsRequest {
|
|
|
3408
3407
|
*/
|
|
3409
3408
|
payments: PaymentCapture[];
|
|
3410
3409
|
}
|
|
3411
|
-
|
|
3410
|
+
interface PaymentCapture {
|
|
3412
3411
|
/**
|
|
3413
3412
|
* Payment ID
|
|
3414
3413
|
* @format GUID
|
|
@@ -3420,11 +3419,11 @@ export interface PaymentCapture {
|
|
|
3420
3419
|
*/
|
|
3421
3420
|
amount?: Price;
|
|
3422
3421
|
}
|
|
3423
|
-
|
|
3422
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
3424
3423
|
/** All order's transactions after the capture was triggered */
|
|
3425
3424
|
orderTransactions?: OrderTransactions;
|
|
3426
3425
|
}
|
|
3427
|
-
|
|
3426
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
3428
3427
|
/**
|
|
3429
3428
|
* Ecom Order ID.
|
|
3430
3429
|
* @minLength 1
|
|
@@ -3434,11 +3433,11 @@ export interface ChargeSavedPaymentMethodRequest {
|
|
|
3434
3433
|
/** Amount to be charged */
|
|
3435
3434
|
amount?: Price;
|
|
3436
3435
|
}
|
|
3437
|
-
|
|
3436
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
3438
3437
|
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
3439
3438
|
paymentGatewayOrderId?: string;
|
|
3440
3439
|
}
|
|
3441
|
-
|
|
3440
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3442
3441
|
createdEvent?: EntityCreatedEvent;
|
|
3443
3442
|
updatedEvent?: EntityUpdatedEvent;
|
|
3444
3443
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3473,19 +3472,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3473
3472
|
entityEventSequence?: string | null;
|
|
3474
3473
|
}
|
|
3475
3474
|
/** @oneof */
|
|
3476
|
-
|
|
3475
|
+
interface DomainEventBodyOneOf {
|
|
3477
3476
|
createdEvent?: EntityCreatedEvent;
|
|
3478
3477
|
updatedEvent?: EntityUpdatedEvent;
|
|
3479
3478
|
deletedEvent?: EntityDeletedEvent;
|
|
3480
3479
|
actionEvent?: ActionEvent;
|
|
3481
3480
|
}
|
|
3482
|
-
|
|
3481
|
+
interface EntityCreatedEvent {
|
|
3483
3482
|
entity?: string;
|
|
3484
3483
|
}
|
|
3485
|
-
|
|
3484
|
+
interface RestoreInfo {
|
|
3486
3485
|
deletedDate?: Date | null;
|
|
3487
3486
|
}
|
|
3488
|
-
|
|
3487
|
+
interface EntityUpdatedEvent {
|
|
3489
3488
|
/**
|
|
3490
3489
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3491
3490
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -3493,16 +3492,16 @@ export interface EntityUpdatedEvent {
|
|
|
3493
3492
|
*/
|
|
3494
3493
|
currentEntity?: string;
|
|
3495
3494
|
}
|
|
3496
|
-
|
|
3495
|
+
interface EntityDeletedEvent {
|
|
3497
3496
|
/** Entity that was deleted. */
|
|
3498
3497
|
deletedEntity?: string | null;
|
|
3499
3498
|
}
|
|
3500
|
-
|
|
3499
|
+
interface ActionEvent {
|
|
3501
3500
|
body?: string;
|
|
3502
3501
|
}
|
|
3503
|
-
|
|
3502
|
+
interface Empty {
|
|
3504
3503
|
}
|
|
3505
|
-
|
|
3504
|
+
interface MessageEnvelope {
|
|
3506
3505
|
/**
|
|
3507
3506
|
* App instance ID.
|
|
3508
3507
|
* @format GUID
|
|
@@ -3518,7 +3517,7 @@ export interface MessageEnvelope {
|
|
|
3518
3517
|
/** Stringify payload. */
|
|
3519
3518
|
data?: string;
|
|
3520
3519
|
}
|
|
3521
|
-
|
|
3520
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3522
3521
|
/**
|
|
3523
3522
|
* ID of a site visitor that has not logged in to the site.
|
|
3524
3523
|
* @format GUID
|
|
@@ -3543,7 +3542,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3543
3542
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3544
3543
|
}
|
|
3545
3544
|
/** @oneof */
|
|
3546
|
-
|
|
3545
|
+
interface IdentificationDataIdOneOf {
|
|
3547
3546
|
/**
|
|
3548
3547
|
* ID of a site visitor that has not logged in to the site.
|
|
3549
3548
|
* @format GUID
|
|
@@ -3565,7 +3564,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
3565
3564
|
*/
|
|
3566
3565
|
appId?: string;
|
|
3567
3566
|
}
|
|
3568
|
-
|
|
3567
|
+
declare enum WebhookIdentityType {
|
|
3569
3568
|
UNKNOWN = "UNKNOWN",
|
|
3570
3569
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3571
3570
|
MEMBER = "MEMBER",
|
|
@@ -3573,8 +3572,8 @@ export declare enum WebhookIdentityType {
|
|
|
3573
3572
|
APP = "APP"
|
|
3574
3573
|
}
|
|
3575
3574
|
/** @enumType */
|
|
3576
|
-
|
|
3577
|
-
|
|
3575
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3576
|
+
declare enum TextDetection {
|
|
3578
3577
|
/** No detection was made */
|
|
3579
3578
|
UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
|
|
3580
3579
|
/** The image contains text */
|
|
@@ -3583,8 +3582,8 @@ export declare enum TextDetection {
|
|
|
3583
3582
|
NO_TEXT = "NO_TEXT"
|
|
3584
3583
|
}
|
|
3585
3584
|
/** @enumType */
|
|
3586
|
-
|
|
3587
|
-
|
|
3585
|
+
type TextDetectionWithLiterals = TextDetection | 'UNKNOWN_TEXT_DETECTION' | 'CONTAINS_TEXT' | 'NO_TEXT';
|
|
3586
|
+
declare enum AnimationDetection {
|
|
3588
3587
|
/** No detection was made */
|
|
3589
3588
|
UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
|
|
3590
3589
|
/** The image contains animation */
|
|
@@ -3593,38 +3592,38 @@ export declare enum AnimationDetection {
|
|
|
3593
3592
|
NO_ANIMATION = "NO_ANIMATION"
|
|
3594
3593
|
}
|
|
3595
3594
|
/** @enumType */
|
|
3596
|
-
|
|
3597
|
-
|
|
3595
|
+
type AnimationDetectionWithLiterals = AnimationDetection | 'UNKNOWN_ANIMATION_DETECTION' | 'CONTAINS_ANIMATION' | 'NO_ANIMATION';
|
|
3596
|
+
interface ImageContent {
|
|
3598
3597
|
/** Text detection */
|
|
3599
3598
|
text?: TextDetectionWithLiterals;
|
|
3600
3599
|
/** Animation detection */
|
|
3601
3600
|
animation?: AnimationDetectionWithLiterals;
|
|
3602
3601
|
}
|
|
3603
|
-
|
|
3602
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
3604
3603
|
/** @format GUID */
|
|
3605
3604
|
orderId?: string;
|
|
3606
3605
|
}
|
|
3607
|
-
|
|
3606
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
3608
3607
|
}
|
|
3609
|
-
|
|
3608
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3610
3609
|
/**
|
|
3611
3610
|
* @minLength 1
|
|
3612
3611
|
* @maxLength 100
|
|
3613
3612
|
*/
|
|
3614
3613
|
orderId?: string;
|
|
3615
3614
|
}
|
|
3616
|
-
|
|
3615
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
3617
3616
|
}
|
|
3618
|
-
|
|
3617
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
3619
3618
|
/**
|
|
3620
3619
|
* @minLength 1
|
|
3621
3620
|
* @maxLength 100
|
|
3622
3621
|
*/
|
|
3623
3622
|
orderId?: string;
|
|
3624
3623
|
}
|
|
3625
|
-
|
|
3624
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
3626
3625
|
}
|
|
3627
|
-
|
|
3626
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3628
3627
|
/**
|
|
3629
3628
|
* IDs of orders to send pickup emails for.
|
|
3630
3629
|
* @minSize 1
|
|
@@ -3632,18 +3631,18 @@ export interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
|
3632
3631
|
*/
|
|
3633
3632
|
orderIds?: string[];
|
|
3634
3633
|
}
|
|
3635
|
-
|
|
3634
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3636
3635
|
}
|
|
3637
|
-
|
|
3636
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
3638
3637
|
/**
|
|
3639
3638
|
* @minLength 1
|
|
3640
3639
|
* @maxLength 100
|
|
3641
3640
|
*/
|
|
3642
3641
|
orderId?: string;
|
|
3643
3642
|
}
|
|
3644
|
-
|
|
3643
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
3645
3644
|
}
|
|
3646
|
-
|
|
3645
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3647
3646
|
/**
|
|
3648
3647
|
* IDs of orders to send pickup emails for.
|
|
3649
3648
|
* @minSize 1
|
|
@@ -3651,18 +3650,18 @@ export interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
|
3651
3650
|
*/
|
|
3652
3651
|
orderIds?: string[];
|
|
3653
3652
|
}
|
|
3654
|
-
|
|
3653
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3655
3654
|
}
|
|
3656
|
-
|
|
3655
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
3657
3656
|
/**
|
|
3658
3657
|
* @minLength 1
|
|
3659
3658
|
* @maxLength 100
|
|
3660
3659
|
*/
|
|
3661
3660
|
orderId?: string;
|
|
3662
3661
|
}
|
|
3663
|
-
|
|
3662
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
3664
3663
|
}
|
|
3665
|
-
|
|
3664
|
+
interface SendCancelRefundEmailRequest {
|
|
3666
3665
|
/**
|
|
3667
3666
|
* The ID of order that is canceled/refunded
|
|
3668
3667
|
* @minLength 1
|
|
@@ -3683,9 +3682,9 @@ export interface SendCancelRefundEmailRequest {
|
|
|
3683
3682
|
*/
|
|
3684
3683
|
refundId?: string | null;
|
|
3685
3684
|
}
|
|
3686
|
-
|
|
3685
|
+
interface SendCancelRefundEmailResponse {
|
|
3687
3686
|
}
|
|
3688
|
-
|
|
3687
|
+
interface SendRefundEmailRequest {
|
|
3689
3688
|
/**
|
|
3690
3689
|
* The ID of order that is refunded
|
|
3691
3690
|
* @format GUID
|
|
@@ -3703,32 +3702,32 @@ export interface SendRefundEmailRequest {
|
|
|
3703
3702
|
*/
|
|
3704
3703
|
customMessage?: string | null;
|
|
3705
3704
|
}
|
|
3706
|
-
|
|
3705
|
+
interface SendRefundEmailResponse {
|
|
3707
3706
|
}
|
|
3708
|
-
|
|
3707
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
3709
3708
|
/**
|
|
3710
3709
|
* @minLength 1
|
|
3711
3710
|
* @maxLength 100
|
|
3712
3711
|
*/
|
|
3713
3712
|
orderId?: string;
|
|
3714
3713
|
}
|
|
3715
|
-
|
|
3714
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
3716
3715
|
}
|
|
3717
|
-
|
|
3716
|
+
interface PreviewEmailByTypeRequest {
|
|
3718
3717
|
emailType?: PreviewEmailTypeWithLiterals;
|
|
3719
3718
|
}
|
|
3720
|
-
|
|
3719
|
+
declare enum PreviewEmailType {
|
|
3721
3720
|
ORDER_PLACED = "ORDER_PLACED",
|
|
3722
3721
|
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
3723
3722
|
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
3724
3723
|
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
3725
3724
|
}
|
|
3726
3725
|
/** @enumType */
|
|
3727
|
-
|
|
3728
|
-
|
|
3726
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
3727
|
+
interface PreviewEmailByTypeResponse {
|
|
3729
3728
|
emailPreview?: string;
|
|
3730
3729
|
}
|
|
3731
|
-
|
|
3730
|
+
interface PreviewRefundEmailRequest {
|
|
3732
3731
|
/**
|
|
3733
3732
|
* @minLength 1
|
|
3734
3733
|
* @maxLength 100
|
|
@@ -3750,10 +3749,10 @@ export interface PreviewRefundEmailRequest {
|
|
|
3750
3749
|
*/
|
|
3751
3750
|
refundId?: string | null;
|
|
3752
3751
|
}
|
|
3753
|
-
|
|
3752
|
+
interface PreviewRefundEmailResponse {
|
|
3754
3753
|
emailPreview?: string;
|
|
3755
3754
|
}
|
|
3756
|
-
|
|
3755
|
+
interface PreviewCancelEmailRequest {
|
|
3757
3756
|
/**
|
|
3758
3757
|
* @minLength 1
|
|
3759
3758
|
* @maxLength 100
|
|
@@ -3766,10 +3765,10 @@ export interface PreviewCancelEmailRequest {
|
|
|
3766
3765
|
*/
|
|
3767
3766
|
customMessage?: string | null;
|
|
3768
3767
|
}
|
|
3769
|
-
|
|
3768
|
+
interface PreviewCancelEmailResponse {
|
|
3770
3769
|
emailPreview?: string;
|
|
3771
3770
|
}
|
|
3772
|
-
|
|
3771
|
+
interface PreviewCancelRefundEmailRequest {
|
|
3773
3772
|
/**
|
|
3774
3773
|
* @minLength 1
|
|
3775
3774
|
* @maxLength 100
|
|
@@ -3789,35 +3788,35 @@ export interface PreviewCancelRefundEmailRequest {
|
|
|
3789
3788
|
*/
|
|
3790
3789
|
refundId?: string | null;
|
|
3791
3790
|
}
|
|
3792
|
-
|
|
3791
|
+
interface PreviewCancelRefundEmailResponse {
|
|
3793
3792
|
emailPreview?: string;
|
|
3794
3793
|
}
|
|
3795
|
-
|
|
3794
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
3796
3795
|
}
|
|
3797
|
-
|
|
3796
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
3798
3797
|
emailPreview?: string;
|
|
3799
3798
|
}
|
|
3800
|
-
|
|
3799
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
3801
3800
|
}
|
|
3802
|
-
|
|
3801
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
3803
3802
|
emailPreview?: string;
|
|
3804
3803
|
}
|
|
3805
|
-
|
|
3804
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
3806
3805
|
}
|
|
3807
|
-
|
|
3806
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
3808
3807
|
emailPreview?: string;
|
|
3809
3808
|
}
|
|
3810
|
-
|
|
3809
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
3811
3810
|
}
|
|
3812
|
-
|
|
3811
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
3813
3812
|
emailPreview?: string;
|
|
3814
3813
|
}
|
|
3815
|
-
|
|
3814
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
3816
3815
|
}
|
|
3817
|
-
|
|
3816
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
3818
3817
|
emailPreview?: string;
|
|
3819
3818
|
}
|
|
3820
|
-
|
|
3819
|
+
interface TriggerReindexOrderRequest {
|
|
3821
3820
|
/** @format GUID */
|
|
3822
3821
|
metasiteId?: string;
|
|
3823
3822
|
/**
|
|
@@ -3826,18 +3825,18 @@ export interface TriggerReindexOrderRequest {
|
|
|
3826
3825
|
*/
|
|
3827
3826
|
orderId?: string;
|
|
3828
3827
|
}
|
|
3829
|
-
|
|
3828
|
+
interface SnapshotMessage {
|
|
3830
3829
|
_id?: string;
|
|
3831
3830
|
opType?: number;
|
|
3832
3831
|
}
|
|
3833
|
-
|
|
3832
|
+
interface GetMetasiteDataRequest {
|
|
3834
3833
|
/**
|
|
3835
3834
|
* meta site Id for data to retrieve
|
|
3836
3835
|
* @format GUID
|
|
3837
3836
|
*/
|
|
3838
3837
|
metasiteId?: string;
|
|
3839
3838
|
}
|
|
3840
|
-
|
|
3839
|
+
interface GetMetasiteDataResponse {
|
|
3841
3840
|
/** meta site data */
|
|
3842
3841
|
metasite?: MetaSite;
|
|
3843
3842
|
/** is metasite added to new SDL population via population manager */
|
|
@@ -3855,7 +3854,7 @@ export interface GetMetasiteDataResponse {
|
|
|
3855
3854
|
*
|
|
3856
3855
|
* We prefer to pronounce it as 2 separate words, therefore we use terms "meta site" or "metaSite" or "meta_site" in code.
|
|
3857
3856
|
*/
|
|
3858
|
-
|
|
3857
|
+
interface MetaSite {
|
|
3859
3858
|
/**
|
|
3860
3859
|
* Identifier of meta site.
|
|
3861
3860
|
* @format GUID
|
|
@@ -3976,7 +3975,7 @@ export interface MetaSite {
|
|
|
3976
3975
|
*/
|
|
3977
3976
|
accountCreatedDate?: Date | null;
|
|
3978
3977
|
}
|
|
3979
|
-
|
|
3978
|
+
interface App {
|
|
3980
3979
|
/**
|
|
3981
3980
|
* Identifier of application type (application definition id).
|
|
3982
3981
|
*
|
|
@@ -4011,7 +4010,7 @@ export interface App {
|
|
|
4011
4010
|
* Represents the actual state of the application on site. Do not confuse with the State in the old MetaSiteDTO,
|
|
4012
4011
|
* which has less values and doesn't have 1-to-1 correspondence with this one (this one is exact and correct!)
|
|
4013
4012
|
*/
|
|
4014
|
-
|
|
4013
|
+
declare enum State {
|
|
4015
4014
|
UNKNOWN = "UNKNOWN",
|
|
4016
4015
|
/** App is installed on a site. */
|
|
4017
4016
|
ENABLED = "ENABLED",
|
|
@@ -4023,8 +4022,8 @@ export declare enum State {
|
|
|
4023
4022
|
PENDING = "PENDING"
|
|
4024
4023
|
}
|
|
4025
4024
|
/** @enumType */
|
|
4026
|
-
|
|
4027
|
-
|
|
4025
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'TEMPLATE' | 'PENDING';
|
|
4026
|
+
declare enum Namespace {
|
|
4028
4027
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4029
4028
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4030
4029
|
WIX = "WIX",
|
|
@@ -4107,8 +4106,8 @@ export declare enum Namespace {
|
|
|
4107
4106
|
MIMIR = "MIMIR"
|
|
4108
4107
|
}
|
|
4109
4108
|
/** @enumType */
|
|
4110
|
-
|
|
4111
|
-
|
|
4109
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
4110
|
+
interface SeoData {
|
|
4112
4111
|
/**
|
|
4113
4112
|
* A title.
|
|
4114
4113
|
* @maxLength 255
|
|
@@ -4134,7 +4133,7 @@ export interface SeoData {
|
|
|
4134
4133
|
*/
|
|
4135
4134
|
canonicalUrl?: string | null;
|
|
4136
4135
|
}
|
|
4137
|
-
|
|
4136
|
+
interface MetaTag {
|
|
4138
4137
|
/**
|
|
4139
4138
|
* A name.
|
|
4140
4139
|
* @maxLength 50
|
|
@@ -4149,7 +4148,7 @@ export interface MetaTag {
|
|
|
4149
4148
|
property?: boolean;
|
|
4150
4149
|
}
|
|
4151
4150
|
/** Represents an HTML application (HTML site). */
|
|
4152
|
-
|
|
4151
|
+
interface HtmlApplication {
|
|
4153
4152
|
/** Legacy, don't use it if you can. */
|
|
4154
4153
|
intId?: number;
|
|
4155
4154
|
/** Identifier of the instance. */
|
|
@@ -4168,7 +4167,7 @@ export interface HtmlApplication {
|
|
|
4168
4167
|
/** Indicates that site is managed by Picasso */
|
|
4169
4168
|
picasso?: boolean;
|
|
4170
4169
|
}
|
|
4171
|
-
|
|
4170
|
+
interface ExternalUriMapping {
|
|
4172
4171
|
/**
|
|
4173
4172
|
* Deprecated.
|
|
4174
4173
|
* @maxLength 255
|
|
@@ -4187,7 +4186,7 @@ export interface ExternalUriMapping {
|
|
|
4187
4186
|
/** Deprecated. */
|
|
4188
4187
|
requireDomain?: boolean | null;
|
|
4189
4188
|
}
|
|
4190
|
-
|
|
4189
|
+
interface UserDataResponse {
|
|
4191
4190
|
userEmail?: string;
|
|
4192
4191
|
/** owner name */
|
|
4193
4192
|
userName?: string;
|
|
@@ -4196,7 +4195,7 @@ export interface UserDataResponse {
|
|
|
4196
4195
|
/** owner language */
|
|
4197
4196
|
userLanguage?: string;
|
|
4198
4197
|
}
|
|
4199
|
-
|
|
4198
|
+
interface QueryOrdersForMetasiteRequest {
|
|
4200
4199
|
/**
|
|
4201
4200
|
* meta site Id for EP orders to retrieve
|
|
4202
4201
|
* @format GUID
|
|
@@ -4205,11 +4204,11 @@ export interface QueryOrdersForMetasiteRequest {
|
|
|
4205
4204
|
/** paginated internal orders query request */
|
|
4206
4205
|
internalQueryOrdersRequest?: InternalQueryOrdersRequest;
|
|
4207
4206
|
}
|
|
4208
|
-
|
|
4207
|
+
interface InternalQueryOrdersRequest {
|
|
4209
4208
|
/** Query options. */
|
|
4210
4209
|
query?: PlatformQuery;
|
|
4211
4210
|
}
|
|
4212
|
-
|
|
4211
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
4213
4212
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4214
4213
|
paging?: PlatformPaging;
|
|
4215
4214
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
@@ -4220,13 +4219,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
4220
4219
|
sort?: Sorting[];
|
|
4221
4220
|
}
|
|
4222
4221
|
/** @oneof */
|
|
4223
|
-
|
|
4222
|
+
interface PlatformQueryPagingMethodOneOf {
|
|
4224
4223
|
/** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
|
|
4225
4224
|
paging?: PlatformPaging;
|
|
4226
4225
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
4227
4226
|
cursorPaging?: CursorPaging;
|
|
4228
4227
|
}
|
|
4229
|
-
|
|
4228
|
+
interface Sorting {
|
|
4230
4229
|
/**
|
|
4231
4230
|
* Name of the field to sort by.
|
|
4232
4231
|
* @maxLength 512
|
|
@@ -4235,13 +4234,13 @@ export interface Sorting {
|
|
|
4235
4234
|
/** Sort order. */
|
|
4236
4235
|
order?: SortOrderWithLiterals;
|
|
4237
4236
|
}
|
|
4238
|
-
|
|
4237
|
+
declare enum SortOrder {
|
|
4239
4238
|
ASC = "ASC",
|
|
4240
4239
|
DESC = "DESC"
|
|
4241
4240
|
}
|
|
4242
4241
|
/** @enumType */
|
|
4243
|
-
|
|
4244
|
-
|
|
4242
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
4243
|
+
interface PlatformPaging {
|
|
4245
4244
|
/**
|
|
4246
4245
|
* Number of items to load.
|
|
4247
4246
|
* @max 100
|
|
@@ -4250,7 +4249,7 @@ export interface PlatformPaging {
|
|
|
4250
4249
|
/** Number of items to skip in the current sort order. */
|
|
4251
4250
|
offset?: number | null;
|
|
4252
4251
|
}
|
|
4253
|
-
|
|
4252
|
+
interface CursorPaging {
|
|
4254
4253
|
/**
|
|
4255
4254
|
* Maximum number of items to return in the results.
|
|
4256
4255
|
* @max 100
|
|
@@ -4265,13 +4264,13 @@ export interface CursorPaging {
|
|
|
4265
4264
|
*/
|
|
4266
4265
|
cursor?: string | null;
|
|
4267
4266
|
}
|
|
4268
|
-
|
|
4267
|
+
interface QueryOrdersForMetasiteResponse {
|
|
4269
4268
|
/** found exisitng orders according to pagination and query provided. */
|
|
4270
4269
|
orders?: Order[];
|
|
4271
4270
|
/** Details on the paged set of results returned. */
|
|
4272
4271
|
pagingMetadata?: PlatformPagingMetadata;
|
|
4273
4272
|
}
|
|
4274
|
-
|
|
4273
|
+
interface PlatformPagingMetadata {
|
|
4275
4274
|
/** The number of items returned in this response. */
|
|
4276
4275
|
count?: number | null;
|
|
4277
4276
|
/** The offset which was requested. Returned if offset paging was used. */
|
|
@@ -4281,7 +4280,7 @@ export interface PlatformPagingMetadata {
|
|
|
4281
4280
|
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
4282
4281
|
cursors?: Cursors;
|
|
4283
4282
|
}
|
|
4284
|
-
|
|
4283
|
+
interface Cursors {
|
|
4285
4284
|
/**
|
|
4286
4285
|
* Cursor string pointing to the next page in the list of results.
|
|
4287
4286
|
* @maxLength 16000
|
|
@@ -4293,7 +4292,7 @@ export interface Cursors {
|
|
|
4293
4292
|
*/
|
|
4294
4293
|
prev?: string | null;
|
|
4295
4294
|
}
|
|
4296
|
-
|
|
4295
|
+
interface GetOrderForMetasiteRequest {
|
|
4297
4296
|
/**
|
|
4298
4297
|
* meta site Id for EP order to retrieve
|
|
4299
4298
|
* @format GUID
|
|
@@ -4306,11 +4305,11 @@ export interface GetOrderForMetasiteRequest {
|
|
|
4306
4305
|
*/
|
|
4307
4306
|
orderId?: string;
|
|
4308
4307
|
}
|
|
4309
|
-
|
|
4308
|
+
interface GetOrderForMetasiteResponse {
|
|
4310
4309
|
/** Existing EP order */
|
|
4311
4310
|
order?: Order;
|
|
4312
4311
|
}
|
|
4313
|
-
|
|
4312
|
+
interface ListOrderTransactionsForMetasiteRequest {
|
|
4314
4313
|
/**
|
|
4315
4314
|
* meta site Id for EP order transactions to retrieve
|
|
4316
4315
|
* @format GUID
|
|
@@ -4322,11 +4321,11 @@ export interface ListOrderTransactionsForMetasiteRequest {
|
|
|
4322
4321
|
*/
|
|
4323
4322
|
orderId?: string;
|
|
4324
4323
|
}
|
|
4325
|
-
|
|
4324
|
+
interface ListOrderTransactionsForMetasiteResponse {
|
|
4326
4325
|
/** Order ID and its associated transactions. */
|
|
4327
4326
|
orderTransactions?: OrderTransactions;
|
|
4328
4327
|
}
|
|
4329
|
-
|
|
4328
|
+
interface UpsertRefundRequest {
|
|
4330
4329
|
/**
|
|
4331
4330
|
* Meta site ID.
|
|
4332
4331
|
* @format GUID
|
|
@@ -4340,11 +4339,11 @@ export interface UpsertRefundRequest {
|
|
|
4340
4339
|
/** Refund to upsert. */
|
|
4341
4340
|
refund?: Refund;
|
|
4342
4341
|
}
|
|
4343
|
-
|
|
4342
|
+
interface UpsertRefundResponse {
|
|
4344
4343
|
/** Updated order transactions. */
|
|
4345
4344
|
orderTransactions?: OrderTransactions;
|
|
4346
4345
|
}
|
|
4347
|
-
|
|
4346
|
+
interface GetOrderOutOfBoxRequest {
|
|
4348
4347
|
/**
|
|
4349
4348
|
* Order Id for EP order to retrieve
|
|
4350
4349
|
* @minLength 1
|
|
@@ -4352,7 +4351,7 @@ export interface GetOrderOutOfBoxRequest {
|
|
|
4352
4351
|
*/
|
|
4353
4352
|
_id?: string;
|
|
4354
4353
|
}
|
|
4355
|
-
|
|
4354
|
+
interface GetOrderOutOfBoxResponse {
|
|
4356
4355
|
/**
|
|
4357
4356
|
* Order id if found
|
|
4358
4357
|
* @minLength 1
|
|
@@ -4360,7 +4359,7 @@ export interface GetOrderOutOfBoxResponse {
|
|
|
4360
4359
|
*/
|
|
4361
4360
|
orderId?: string;
|
|
4362
4361
|
}
|
|
4363
|
-
|
|
4362
|
+
interface GetOrderAgcRequest {
|
|
4364
4363
|
/**
|
|
4365
4364
|
* Order Id for EP order to retrieve
|
|
4366
4365
|
* @minLength 1
|
|
@@ -4368,7 +4367,7 @@ export interface GetOrderAgcRequest {
|
|
|
4368
4367
|
*/
|
|
4369
4368
|
_id?: string;
|
|
4370
4369
|
}
|
|
4371
|
-
|
|
4370
|
+
interface GetOrderAgcResponse {
|
|
4372
4371
|
/**
|
|
4373
4372
|
* Order id if found
|
|
4374
4373
|
* @minLength 1
|
|
@@ -4376,7 +4375,7 @@ export interface GetOrderAgcResponse {
|
|
|
4376
4375
|
*/
|
|
4377
4376
|
orderId?: string;
|
|
4378
4377
|
}
|
|
4379
|
-
|
|
4378
|
+
interface GetOrderWithFilterByLocationRequest {
|
|
4380
4379
|
/**
|
|
4381
4380
|
* Order Id for EP order to retrieve
|
|
4382
4381
|
* @minLength 1
|
|
@@ -4384,7 +4383,7 @@ export interface GetOrderWithFilterByLocationRequest {
|
|
|
4384
4383
|
*/
|
|
4385
4384
|
_id?: string;
|
|
4386
4385
|
}
|
|
4387
|
-
|
|
4386
|
+
interface GetOrderWithFilterByLocationResponse {
|
|
4388
4387
|
/**
|
|
4389
4388
|
* Order id if found
|
|
4390
4389
|
* @minLength 1
|
|
@@ -4392,7 +4391,7 @@ export interface GetOrderWithFilterByLocationResponse {
|
|
|
4392
4391
|
*/
|
|
4393
4392
|
orderId?: string;
|
|
4394
4393
|
}
|
|
4395
|
-
|
|
4394
|
+
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
4396
4395
|
/** insert/update documents */
|
|
4397
4396
|
update?: InternalDocumentUpdateOperation;
|
|
4398
4397
|
/** delete by document ids */
|
|
@@ -4433,7 +4432,7 @@ export interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEve
|
|
|
4433
4432
|
issuedAt?: Date | null;
|
|
4434
4433
|
}
|
|
4435
4434
|
/** @oneof */
|
|
4436
|
-
|
|
4435
|
+
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
4437
4436
|
/** insert/update documents */
|
|
4438
4437
|
update?: InternalDocumentUpdateOperation;
|
|
4439
4438
|
/** delete by document ids */
|
|
@@ -4449,39 +4448,57 @@ export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
|
4449
4448
|
/** delete by document ids with versioning */
|
|
4450
4449
|
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
4451
4450
|
}
|
|
4452
|
-
|
|
4451
|
+
interface InternalDocument {
|
|
4453
4452
|
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
4454
4453
|
document?: Record<string, any> | null;
|
|
4455
4454
|
}
|
|
4456
|
-
|
|
4455
|
+
interface InternalDocumentUpdateOperation {
|
|
4457
4456
|
/** documents to index or update */
|
|
4458
4457
|
documents?: InternalDocument[];
|
|
4459
4458
|
}
|
|
4460
|
-
|
|
4459
|
+
interface DeleteByIdsOperation {
|
|
4461
4460
|
/** ids of the documents to delete */
|
|
4462
4461
|
documentIds?: string[];
|
|
4462
|
+
/**
|
|
4463
|
+
* tenant id for custom tenancy strategy
|
|
4464
|
+
* @minLength 2
|
|
4465
|
+
* @maxLength 300
|
|
4466
|
+
*/
|
|
4467
|
+
tenantId?: string | null;
|
|
4463
4468
|
}
|
|
4464
|
-
|
|
4469
|
+
interface DeleteByFilterOperation {
|
|
4465
4470
|
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
4466
4471
|
filter?: Record<string, any> | null;
|
|
4472
|
+
/**
|
|
4473
|
+
* tenant id for custom tenancy strategy
|
|
4474
|
+
* @minLength 2
|
|
4475
|
+
* @maxLength 300
|
|
4476
|
+
*/
|
|
4477
|
+
tenantId?: string | null;
|
|
4467
4478
|
}
|
|
4468
|
-
|
|
4479
|
+
interface InternalDocumentUpdateByFilterOperation {
|
|
4469
4480
|
/** documents matching this filter will be updated */
|
|
4470
4481
|
filter?: Record<string, any> | null;
|
|
4471
4482
|
/** partial document to apply */
|
|
4472
4483
|
document?: InternalDocument;
|
|
4484
|
+
/**
|
|
4485
|
+
* tenant id for custom tenancy strategy
|
|
4486
|
+
* @minLength 2
|
|
4487
|
+
* @maxLength 300
|
|
4488
|
+
*/
|
|
4489
|
+
tenantId?: string | null;
|
|
4473
4490
|
}
|
|
4474
|
-
|
|
4491
|
+
interface InternalUpdateExistingOperation {
|
|
4475
4492
|
/** documents to update */
|
|
4476
4493
|
documents?: InternalDocument[];
|
|
4477
4494
|
}
|
|
4478
|
-
|
|
4495
|
+
interface VersionedDocumentUpdateOperation {
|
|
4479
4496
|
/** documents to create or overwrite */
|
|
4480
4497
|
documents?: InternalDocument[];
|
|
4481
4498
|
/** versioning mode to use instead of default */
|
|
4482
4499
|
versioningMode?: VersioningModeWithLiterals;
|
|
4483
4500
|
}
|
|
4484
|
-
|
|
4501
|
+
declare enum VersioningMode {
|
|
4485
4502
|
/** use default versioning mode agreed with search team */
|
|
4486
4503
|
DEFAULT = "DEFAULT",
|
|
4487
4504
|
/** execute only if version is greater than existing */
|
|
@@ -4490,12 +4507,18 @@ export declare enum VersioningMode {
|
|
|
4490
4507
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
4491
4508
|
}
|
|
4492
4509
|
/** @enumType */
|
|
4493
|
-
|
|
4494
|
-
|
|
4510
|
+
type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
4511
|
+
interface VersionedDeleteByIdsOperation {
|
|
4495
4512
|
/** ids with version of the documents to delete */
|
|
4496
4513
|
documentIds?: VersionedDocumentId[];
|
|
4514
|
+
/**
|
|
4515
|
+
* tenant id for custom tenancy strategy
|
|
4516
|
+
* @minLength 2
|
|
4517
|
+
* @maxLength 300
|
|
4518
|
+
*/
|
|
4519
|
+
tenantId?: string | null;
|
|
4497
4520
|
}
|
|
4498
|
-
|
|
4521
|
+
interface VersionedDocumentId {
|
|
4499
4522
|
/** document id */
|
|
4500
4523
|
documentId?: string;
|
|
4501
4524
|
/** document version */
|
|
@@ -4503,7 +4526,7 @@ export interface VersionedDocumentId {
|
|
|
4503
4526
|
/** versioning mode to use instead of default */
|
|
4504
4527
|
versioningMode?: VersioningModeWithLiterals;
|
|
4505
4528
|
}
|
|
4506
|
-
|
|
4529
|
+
interface TriggerReindexRequest {
|
|
4507
4530
|
/** @format GUID */
|
|
4508
4531
|
metasiteId?: string;
|
|
4509
4532
|
/**
|
|
@@ -4513,13 +4536,13 @@ export interface TriggerReindexRequest {
|
|
|
4513
4536
|
*/
|
|
4514
4537
|
orderIds?: string[];
|
|
4515
4538
|
}
|
|
4516
|
-
|
|
4539
|
+
interface TriggerReindexResponse {
|
|
4517
4540
|
}
|
|
4518
|
-
|
|
4541
|
+
interface BatchOfTriggerReindexOrderRequest {
|
|
4519
4542
|
/** @maxSize 25 */
|
|
4520
4543
|
requests?: TriggerReindexOrderRequest[];
|
|
4521
4544
|
}
|
|
4522
|
-
|
|
4545
|
+
interface DiffmatokyPayload {
|
|
4523
4546
|
left?: string;
|
|
4524
4547
|
right?: string;
|
|
4525
4548
|
compareChannel?: string;
|
|
@@ -4527,20 +4550,20 @@ export interface DiffmatokyPayload {
|
|
|
4527
4550
|
errorInformation?: ErrorInformation;
|
|
4528
4551
|
tags?: string[];
|
|
4529
4552
|
}
|
|
4530
|
-
|
|
4553
|
+
interface ErrorInformation {
|
|
4531
4554
|
stackTrace?: string;
|
|
4532
4555
|
}
|
|
4533
|
-
|
|
4556
|
+
interface ContinueSideEffectsFlowInLegacyData {
|
|
4534
4557
|
storeId?: string;
|
|
4535
4558
|
orderId?: string;
|
|
4536
4559
|
ordersExperiments?: OrdersExperiments;
|
|
4537
4560
|
}
|
|
4538
|
-
|
|
4561
|
+
interface IndexingMessage {
|
|
4539
4562
|
_id?: string;
|
|
4540
4563
|
opType?: number;
|
|
4541
4564
|
requiredVersions?: string[];
|
|
4542
4565
|
}
|
|
4543
|
-
|
|
4566
|
+
interface GetOrderRequest {
|
|
4544
4567
|
/**
|
|
4545
4568
|
* ID of the order to retrieve.
|
|
4546
4569
|
* @minLength 1
|
|
@@ -4548,31 +4571,31 @@ export interface GetOrderRequest {
|
|
|
4548
4571
|
*/
|
|
4549
4572
|
_id: string;
|
|
4550
4573
|
}
|
|
4551
|
-
|
|
4574
|
+
interface GetOrderResponse {
|
|
4552
4575
|
/** The requested order. */
|
|
4553
4576
|
order?: Order;
|
|
4554
4577
|
}
|
|
4555
|
-
|
|
4578
|
+
interface InternalQueryOrdersResponse {
|
|
4556
4579
|
/** List of orders. */
|
|
4557
4580
|
orders?: Order[];
|
|
4558
4581
|
/** Details on the paged set of results returned. */
|
|
4559
4582
|
metadata?: PlatformPagingMetadata;
|
|
4560
4583
|
}
|
|
4561
|
-
|
|
4584
|
+
interface QueryOrderRequest {
|
|
4562
4585
|
/** Query options. */
|
|
4563
4586
|
query?: PlatformQuery;
|
|
4564
4587
|
}
|
|
4565
|
-
|
|
4588
|
+
interface QueryOrderResponse {
|
|
4566
4589
|
/** List of orders. */
|
|
4567
4590
|
orders?: Order[];
|
|
4568
4591
|
/** Details on the paged set of results returned. */
|
|
4569
4592
|
metadata?: PlatformPagingMetadata;
|
|
4570
4593
|
}
|
|
4571
|
-
|
|
4594
|
+
interface SearchOrdersRequest {
|
|
4572
4595
|
/** Search options. */
|
|
4573
4596
|
search?: CursorSearch;
|
|
4574
4597
|
}
|
|
4575
|
-
|
|
4598
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
4576
4599
|
/**
|
|
4577
4600
|
* Cursor paging options.
|
|
4578
4601
|
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
@@ -4601,20 +4624,20 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
4601
4624
|
sort?: Sorting[];
|
|
4602
4625
|
}
|
|
4603
4626
|
/** @oneof */
|
|
4604
|
-
|
|
4627
|
+
interface CursorSearchPagingMethodOneOf {
|
|
4605
4628
|
/**
|
|
4606
4629
|
* Cursor paging options.
|
|
4607
4630
|
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
4608
4631
|
*/
|
|
4609
4632
|
cursorPaging?: CursorPaging;
|
|
4610
4633
|
}
|
|
4611
|
-
|
|
4634
|
+
interface SearchOrdersResponse {
|
|
4612
4635
|
/** List of orders. */
|
|
4613
4636
|
orders?: Order[];
|
|
4614
4637
|
/** Details on the paged set of results returned. */
|
|
4615
4638
|
metadata?: CursorPagingMetadata;
|
|
4616
4639
|
}
|
|
4617
|
-
|
|
4640
|
+
interface CursorPagingMetadata {
|
|
4618
4641
|
/** Number of items returned in current page. */
|
|
4619
4642
|
count?: number | null;
|
|
4620
4643
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -4627,13 +4650,13 @@ export interface CursorPagingMetadata {
|
|
|
4627
4650
|
*/
|
|
4628
4651
|
hasNext?: boolean | null;
|
|
4629
4652
|
}
|
|
4630
|
-
|
|
4653
|
+
interface CreateOrderRequest {
|
|
4631
4654
|
/** Order info. */
|
|
4632
4655
|
order: Order;
|
|
4633
4656
|
/** Determine order lifecycle */
|
|
4634
4657
|
settings?: OrderCreationSettings;
|
|
4635
4658
|
}
|
|
4636
|
-
|
|
4659
|
+
interface OrderCreationSettings {
|
|
4637
4660
|
/**
|
|
4638
4661
|
* Condition for the order to be approved.
|
|
4639
4662
|
* Default: `DEFAULT`
|
|
@@ -4642,7 +4665,7 @@ export interface OrderCreationSettings {
|
|
|
4642
4665
|
/** Notification settings to be applied on order creation */
|
|
4643
4666
|
notifications?: OrderCreateNotifications;
|
|
4644
4667
|
}
|
|
4645
|
-
|
|
4668
|
+
declare enum OrderApprovalStrategy {
|
|
4646
4669
|
/** Order is automatically approved when `order.priceSummary.total = 0`, **or** after receiving payment. */
|
|
4647
4670
|
DEFAULT = "DEFAULT",
|
|
4648
4671
|
/** Order is automatically approved **only** after receiving payment. */
|
|
@@ -4651,8 +4674,8 @@ export declare enum OrderApprovalStrategy {
|
|
|
4651
4674
|
PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
|
|
4652
4675
|
}
|
|
4653
4676
|
/** @enumType */
|
|
4654
|
-
|
|
4655
|
-
|
|
4677
|
+
type OrderApprovalStrategyWithLiterals = OrderApprovalStrategy | 'DEFAULT' | 'PAYMENT_RECEIVED' | 'PAYMENT_METHOD_SAVED';
|
|
4678
|
+
interface OrderCreateNotifications {
|
|
4656
4679
|
/**
|
|
4657
4680
|
* Whether to send notification to the buyer.
|
|
4658
4681
|
*
|
|
@@ -4666,19 +4689,19 @@ export interface OrderCreateNotifications {
|
|
|
4666
4689
|
*/
|
|
4667
4690
|
sendNotificationsToBusiness?: boolean | null;
|
|
4668
4691
|
}
|
|
4669
|
-
|
|
4692
|
+
interface CreateOrderResponse {
|
|
4670
4693
|
/** Newly created order. */
|
|
4671
4694
|
order?: Order;
|
|
4672
4695
|
}
|
|
4673
|
-
|
|
4696
|
+
interface UpdateOrderRequest {
|
|
4674
4697
|
/** Order to be updated. */
|
|
4675
4698
|
order: Order;
|
|
4676
4699
|
}
|
|
4677
|
-
|
|
4700
|
+
interface UpdateOrderResponse {
|
|
4678
4701
|
/** Newly created order. */
|
|
4679
4702
|
order?: Order;
|
|
4680
4703
|
}
|
|
4681
|
-
|
|
4704
|
+
interface BulkUpdateOrdersRequest {
|
|
4682
4705
|
/**
|
|
4683
4706
|
* Orders to update.
|
|
4684
4707
|
* @minSize 1
|
|
@@ -4692,11 +4715,11 @@ export interface BulkUpdateOrdersRequest {
|
|
|
4692
4715
|
*/
|
|
4693
4716
|
returnEntity?: boolean;
|
|
4694
4717
|
}
|
|
4695
|
-
|
|
4718
|
+
interface MaskedOrder {
|
|
4696
4719
|
/** Order to be updated. */
|
|
4697
4720
|
order?: Order;
|
|
4698
4721
|
}
|
|
4699
|
-
|
|
4722
|
+
interface BulkUpdateOrdersResponse {
|
|
4700
4723
|
/**
|
|
4701
4724
|
* Bulk action results.
|
|
4702
4725
|
* @minSize 1
|
|
@@ -4706,7 +4729,7 @@ export interface BulkUpdateOrdersResponse {
|
|
|
4706
4729
|
/** Bulk action metadata. */
|
|
4707
4730
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4708
4731
|
}
|
|
4709
|
-
|
|
4732
|
+
interface CommitDeltasRequest {
|
|
4710
4733
|
/** Order id to be updated */
|
|
4711
4734
|
_id: string;
|
|
4712
4735
|
/**
|
|
@@ -4725,7 +4748,7 @@ export interface CommitDeltasRequest {
|
|
|
4725
4748
|
*/
|
|
4726
4749
|
reason?: string | null;
|
|
4727
4750
|
}
|
|
4728
|
-
|
|
4751
|
+
interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftOrderDiffsBuyerUpdateInfoOneOf, DraftOrderDiffsBillingUpdateInfoOneOf, DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4729
4752
|
/** Shipping info and selected shipping option details. */
|
|
4730
4753
|
changedShippingInfo?: V1ShippingInformation;
|
|
4731
4754
|
/** Remove existing shipping info. */
|
|
@@ -4763,22 +4786,22 @@ export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf,
|
|
|
4763
4786
|
priceSummary?: PriceSummary;
|
|
4764
4787
|
}
|
|
4765
4788
|
/** @oneof */
|
|
4766
|
-
|
|
4789
|
+
interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
4767
4790
|
/** Shipping info and selected shipping option details. */
|
|
4768
4791
|
changedShippingInfo?: V1ShippingInformation;
|
|
4769
4792
|
/** Remove existing shipping info. */
|
|
4770
4793
|
shippingInfoRemoved?: boolean;
|
|
4771
4794
|
}
|
|
4772
4795
|
/** @oneof */
|
|
4773
|
-
|
|
4796
|
+
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
4774
4797
|
}
|
|
4775
4798
|
/** @oneof */
|
|
4776
|
-
|
|
4799
|
+
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
4777
4800
|
}
|
|
4778
4801
|
/** @oneof */
|
|
4779
|
-
|
|
4802
|
+
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
4780
4803
|
}
|
|
4781
|
-
|
|
4804
|
+
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
4782
4805
|
/** The line item was added. */
|
|
4783
4806
|
lineItemAdded?: boolean;
|
|
4784
4807
|
/** The line item was modified. */
|
|
@@ -4793,7 +4816,7 @@ export interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
|
4793
4816
|
lineItem?: OrderLineItemChangedDetails;
|
|
4794
4817
|
}
|
|
4795
4818
|
/** @oneof */
|
|
4796
|
-
|
|
4819
|
+
interface V1LineItemDeltaDeltaOneOf {
|
|
4797
4820
|
/** The line item was added. */
|
|
4798
4821
|
lineItemAdded?: boolean;
|
|
4799
4822
|
/** The line item was modified. */
|
|
@@ -4801,7 +4824,7 @@ export interface V1LineItemDeltaDeltaOneOf {
|
|
|
4801
4824
|
/** The line item was added. */
|
|
4802
4825
|
lineItemRemoved?: boolean;
|
|
4803
4826
|
}
|
|
4804
|
-
|
|
4827
|
+
interface OrderLineItemChangedDetails {
|
|
4805
4828
|
/**
|
|
4806
4829
|
* Item name.
|
|
4807
4830
|
* + Stores - `product.name`
|
|
@@ -4880,7 +4903,7 @@ export interface OrderLineItemChangedDetails {
|
|
|
4880
4903
|
subscriptionInfo?: SubscriptionInfo;
|
|
4881
4904
|
}
|
|
4882
4905
|
/** Type of selected payment option for catalog item */
|
|
4883
|
-
|
|
4906
|
+
declare enum DeltaPaymentOptionType {
|
|
4884
4907
|
/** Irrelevant */
|
|
4885
4908
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
4886
4909
|
/** The entire payment for the given item will happen after checkout. */
|
|
@@ -4892,8 +4915,8 @@ export declare enum DeltaPaymentOptionType {
|
|
|
4892
4915
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
4893
4916
|
}
|
|
4894
4917
|
/** @enumType */
|
|
4895
|
-
|
|
4896
|
-
|
|
4918
|
+
type DeltaPaymentOptionTypeWithLiterals = DeltaPaymentOptionType | 'UNKNOWN_PAYMENT_OPTION' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP_OFFLINE';
|
|
4919
|
+
interface ItemChangedDetails {
|
|
4897
4920
|
/**
|
|
4898
4921
|
* The quantity before the change.
|
|
4899
4922
|
* @min 1
|
|
@@ -4905,7 +4928,7 @@ export interface ItemChangedDetails {
|
|
|
4905
4928
|
/** The price description before the change */
|
|
4906
4929
|
priceDescriptionBeforeChange?: PriceDescription;
|
|
4907
4930
|
}
|
|
4908
|
-
|
|
4931
|
+
interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
|
|
4909
4932
|
editedDiscount?: AppliedDiscount;
|
|
4910
4933
|
discountRemoved?: boolean;
|
|
4911
4934
|
/**
|
|
@@ -4915,11 +4938,11 @@ export interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
|
|
|
4915
4938
|
discountId?: string;
|
|
4916
4939
|
}
|
|
4917
4940
|
/** @oneof */
|
|
4918
|
-
|
|
4941
|
+
interface AppliedDiscountDeltaDeltaOneOf {
|
|
4919
4942
|
editedDiscount?: AppliedDiscount;
|
|
4920
4943
|
discountRemoved?: boolean;
|
|
4921
4944
|
}
|
|
4922
|
-
|
|
4945
|
+
interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
|
|
4923
4946
|
editedAdditionalFee?: AdditionalFee;
|
|
4924
4947
|
additionalFeeRemoved?: boolean;
|
|
4925
4948
|
/**
|
|
@@ -4929,11 +4952,11 @@ export interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
|
|
|
4929
4952
|
additionalFeeId?: string;
|
|
4930
4953
|
}
|
|
4931
4954
|
/** @oneof */
|
|
4932
|
-
|
|
4955
|
+
interface AdditionalFeeDeltaDeltaOneOf {
|
|
4933
4956
|
editedAdditionalFee?: AdditionalFee;
|
|
4934
4957
|
additionalFeeRemoved?: boolean;
|
|
4935
4958
|
}
|
|
4936
|
-
|
|
4959
|
+
interface DraftOrderCommitSettings {
|
|
4937
4960
|
/** If false, do not send notifications to buyer. Default is true. */
|
|
4938
4961
|
sendNotificationsToBuyer?: boolean | null;
|
|
4939
4962
|
/** If false, do not send notifications to business. Default is true. */
|
|
@@ -4948,7 +4971,7 @@ export interface DraftOrderCommitSettings {
|
|
|
4948
4971
|
*/
|
|
4949
4972
|
inventoryUpdates?: InventoryUpdateDetails[];
|
|
4950
4973
|
}
|
|
4951
|
-
|
|
4974
|
+
interface InventoryUpdateDetails {
|
|
4952
4975
|
/** Action to be applied - decrease or restock */
|
|
4953
4976
|
actionType?: InventoryActionWithLiterals;
|
|
4954
4977
|
/** Order line item id */
|
|
@@ -4956,20 +4979,20 @@ export interface InventoryUpdateDetails {
|
|
|
4956
4979
|
/** The amount to be increased or restocked */
|
|
4957
4980
|
quantityChange?: number;
|
|
4958
4981
|
}
|
|
4959
|
-
|
|
4982
|
+
declare enum InventoryAction {
|
|
4960
4983
|
/** Restock inventory */
|
|
4961
4984
|
RESTOCK = "RESTOCK",
|
|
4962
4985
|
/** Decrease inventory. Without failing on negative inventory. */
|
|
4963
4986
|
DECREASE = "DECREASE"
|
|
4964
4987
|
}
|
|
4965
4988
|
/** @enumType */
|
|
4966
|
-
|
|
4967
|
-
|
|
4989
|
+
type InventoryActionWithLiterals = InventoryAction | 'RESTOCK' | 'DECREASE';
|
|
4990
|
+
interface CommitDeltasResponse {
|
|
4968
4991
|
/** Order after deltas are applied */
|
|
4969
4992
|
order?: Order;
|
|
4970
4993
|
}
|
|
4971
4994
|
/** Triggered when order is edited by draftOrders */
|
|
4972
|
-
|
|
4995
|
+
interface OrderDeltasCommitted {
|
|
4973
4996
|
/** The order after committed changes. */
|
|
4974
4997
|
order?: Order;
|
|
4975
4998
|
/** Draft order Id representing this change. */
|
|
@@ -4984,7 +5007,7 @@ export interface OrderDeltasCommitted {
|
|
|
4984
5007
|
*/
|
|
4985
5008
|
commitDate?: Date | null;
|
|
4986
5009
|
}
|
|
4987
|
-
|
|
5010
|
+
interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
|
|
4988
5011
|
/** Shipping info and selected shipping option details. */
|
|
4989
5012
|
changedShippingInfo?: V1ShippingInformation;
|
|
4990
5013
|
/** Remove existing shipping info. */
|
|
@@ -5006,13 +5029,13 @@ export interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
|
|
|
5006
5029
|
additionalFees?: AdditionalFeeDelta[];
|
|
5007
5030
|
}
|
|
5008
5031
|
/** @oneof */
|
|
5009
|
-
|
|
5032
|
+
interface CommittedDiffsShippingUpdateInfoOneOf {
|
|
5010
5033
|
/** Shipping info and selected shipping option details. */
|
|
5011
5034
|
changedShippingInfo?: V1ShippingInformation;
|
|
5012
5035
|
/** Remove existing shipping info. */
|
|
5013
5036
|
shippingInfoRemoved?: boolean;
|
|
5014
5037
|
}
|
|
5015
|
-
|
|
5038
|
+
interface LineItemDelta extends LineItemDeltaDeltaOneOf {
|
|
5016
5039
|
lineItemAdded?: boolean;
|
|
5017
5040
|
changedDetails?: ItemChangedDetails;
|
|
5018
5041
|
lineItemRemoved?: OrderLineItemChangedDetails;
|
|
@@ -5023,12 +5046,12 @@ export interface LineItemDelta extends LineItemDeltaDeltaOneOf {
|
|
|
5023
5046
|
lineItemId?: string;
|
|
5024
5047
|
}
|
|
5025
5048
|
/** @oneof */
|
|
5026
|
-
|
|
5049
|
+
interface LineItemDeltaDeltaOneOf {
|
|
5027
5050
|
lineItemAdded?: boolean;
|
|
5028
5051
|
changedDetails?: ItemChangedDetails;
|
|
5029
5052
|
lineItemRemoved?: OrderLineItemChangedDetails;
|
|
5030
5053
|
}
|
|
5031
|
-
|
|
5054
|
+
interface ArchiveOrderRequest {
|
|
5032
5055
|
/**
|
|
5033
5056
|
* Order ID.
|
|
5034
5057
|
* @minLength 1
|
|
@@ -5036,11 +5059,11 @@ export interface ArchiveOrderRequest {
|
|
|
5036
5059
|
*/
|
|
5037
5060
|
_id?: string;
|
|
5038
5061
|
}
|
|
5039
|
-
|
|
5062
|
+
interface ArchiveOrderResponse {
|
|
5040
5063
|
/** Archived order. */
|
|
5041
5064
|
order?: Order;
|
|
5042
5065
|
}
|
|
5043
|
-
|
|
5066
|
+
interface BulkArchiveOrdersRequest {
|
|
5044
5067
|
/**
|
|
5045
5068
|
* IDs of orders to archive.
|
|
5046
5069
|
* @minSize 1
|
|
@@ -5050,23 +5073,23 @@ export interface BulkArchiveOrdersRequest {
|
|
|
5050
5073
|
/** Whether to return the full updated order entities in the response. */
|
|
5051
5074
|
returnFullEntity?: boolean;
|
|
5052
5075
|
}
|
|
5053
|
-
|
|
5076
|
+
interface BulkArchiveOrdersResponse {
|
|
5054
5077
|
/** Items updated by bulk action. */
|
|
5055
5078
|
results?: BulkOrderResult[];
|
|
5056
5079
|
/** Bulk action metadata. */
|
|
5057
5080
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5058
5081
|
}
|
|
5059
|
-
|
|
5082
|
+
interface BulkArchiveOrdersByFilterRequest {
|
|
5060
5083
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
5061
5084
|
filter?: Record<string, any> | null;
|
|
5062
5085
|
}
|
|
5063
|
-
|
|
5086
|
+
interface BulkArchiveOrdersByFilterResponse {
|
|
5064
5087
|
/** Items updated by bulk action. */
|
|
5065
5088
|
results?: BulkOrderResult[];
|
|
5066
5089
|
/** Bulk action metadata. */
|
|
5067
5090
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5068
5091
|
}
|
|
5069
|
-
|
|
5092
|
+
interface UnArchiveOrderRequest {
|
|
5070
5093
|
/**
|
|
5071
5094
|
* Order ID.
|
|
5072
5095
|
* @minLength 1
|
|
@@ -5074,11 +5097,11 @@ export interface UnArchiveOrderRequest {
|
|
|
5074
5097
|
*/
|
|
5075
5098
|
_id?: string;
|
|
5076
5099
|
}
|
|
5077
|
-
|
|
5100
|
+
interface UnArchiveOrderResponse {
|
|
5078
5101
|
/** Unarchived order. */
|
|
5079
5102
|
order?: Order;
|
|
5080
5103
|
}
|
|
5081
|
-
|
|
5104
|
+
interface BulkUnArchiveOrdersRequest {
|
|
5082
5105
|
/**
|
|
5083
5106
|
* IDs or orders to unarchive.
|
|
5084
5107
|
* @minSize 1
|
|
@@ -5088,23 +5111,23 @@ export interface BulkUnArchiveOrdersRequest {
|
|
|
5088
5111
|
/** Whether to return the full updated order entities in the response. */
|
|
5089
5112
|
returnFullEntity?: boolean;
|
|
5090
5113
|
}
|
|
5091
|
-
|
|
5114
|
+
interface BulkUnArchiveOrdersResponse {
|
|
5092
5115
|
/** Items updated by bulk action. */
|
|
5093
5116
|
results?: BulkOrderResult[];
|
|
5094
5117
|
/** Bulk action metadata. */
|
|
5095
5118
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5096
5119
|
}
|
|
5097
|
-
|
|
5120
|
+
interface BulkUnArchiveOrdersByFilterRequest {
|
|
5098
5121
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
5099
5122
|
filter?: Record<string, any> | null;
|
|
5100
5123
|
}
|
|
5101
|
-
|
|
5124
|
+
interface BulkUnArchiveOrdersByFilterResponse {
|
|
5102
5125
|
/** Items updated by bulk action. */
|
|
5103
5126
|
results?: BulkOrderResult[];
|
|
5104
5127
|
/** Bulk action metadata. */
|
|
5105
5128
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5106
5129
|
}
|
|
5107
|
-
|
|
5130
|
+
interface UpdateBuyerInfoRequest {
|
|
5108
5131
|
/**
|
|
5109
5132
|
* Order ID.
|
|
5110
5133
|
* @minLength 1
|
|
@@ -5115,7 +5138,7 @@ export interface UpdateBuyerInfoRequest {
|
|
|
5115
5138
|
/** Buyer info. */
|
|
5116
5139
|
buyerInfo?: BuyerInfoUpdate;
|
|
5117
5140
|
}
|
|
5118
|
-
|
|
5141
|
+
interface BuyerInfoUpdate {
|
|
5119
5142
|
/**
|
|
5120
5143
|
* Contact ID.
|
|
5121
5144
|
* @format GUID
|
|
@@ -5127,11 +5150,11 @@ export interface BuyerInfoUpdate {
|
|
|
5127
5150
|
*/
|
|
5128
5151
|
email?: string | null;
|
|
5129
5152
|
}
|
|
5130
|
-
|
|
5153
|
+
interface UpdateBuyerInfoResponse {
|
|
5131
5154
|
/** Updated order. */
|
|
5132
5155
|
order?: Order;
|
|
5133
5156
|
}
|
|
5134
|
-
|
|
5157
|
+
interface UpdateBuyerEmailRequest {
|
|
5135
5158
|
/**
|
|
5136
5159
|
* @minLength 1
|
|
5137
5160
|
* @maxLength 100
|
|
@@ -5141,10 +5164,10 @@ export interface UpdateBuyerEmailRequest {
|
|
|
5141
5164
|
/** @format EMAIL */
|
|
5142
5165
|
email?: string | null;
|
|
5143
5166
|
}
|
|
5144
|
-
|
|
5167
|
+
interface UpdateBuyerEmailResponse {
|
|
5145
5168
|
order?: Order;
|
|
5146
5169
|
}
|
|
5147
|
-
|
|
5170
|
+
interface UpdateOrderShippingAddressRequest {
|
|
5148
5171
|
/**
|
|
5149
5172
|
* Order ID.
|
|
5150
5173
|
* @minLength 1
|
|
@@ -5154,11 +5177,11 @@ export interface UpdateOrderShippingAddressRequest {
|
|
|
5154
5177
|
/** Shipping address and contact details to be updated. */
|
|
5155
5178
|
shippingAddress?: AddressWithContact;
|
|
5156
5179
|
}
|
|
5157
|
-
|
|
5180
|
+
interface UpdateOrderShippingAddressResponse {
|
|
5158
5181
|
/** Updated order. */
|
|
5159
5182
|
order?: Order;
|
|
5160
5183
|
}
|
|
5161
|
-
|
|
5184
|
+
interface UpdateBillingContactDetailsRequest {
|
|
5162
5185
|
/**
|
|
5163
5186
|
* Order ID.
|
|
5164
5187
|
* @minLength 1
|
|
@@ -5169,11 +5192,11 @@ export interface UpdateBillingContactDetailsRequest {
|
|
|
5169
5192
|
/** Contact details. */
|
|
5170
5193
|
addressContactDetails?: FullAddressContactDetails;
|
|
5171
5194
|
}
|
|
5172
|
-
|
|
5195
|
+
interface UpdateBillingContactDetailsResponse {
|
|
5173
5196
|
/** Updated order. */
|
|
5174
5197
|
order?: Order;
|
|
5175
5198
|
}
|
|
5176
|
-
|
|
5199
|
+
interface UpdateOrderLineItemRequest {
|
|
5177
5200
|
/**
|
|
5178
5201
|
* Order ID
|
|
5179
5202
|
* @minLength 1
|
|
@@ -5183,11 +5206,11 @@ export interface UpdateOrderLineItemRequest {
|
|
|
5183
5206
|
/** Order line item to update */
|
|
5184
5207
|
lineItem: OrderLineItem;
|
|
5185
5208
|
}
|
|
5186
|
-
|
|
5209
|
+
interface UpdateOrderLineItemResponse {
|
|
5187
5210
|
/** Updated order data */
|
|
5188
5211
|
order?: Order;
|
|
5189
5212
|
}
|
|
5190
|
-
|
|
5213
|
+
interface UpdateOrderLineItemsRequest {
|
|
5191
5214
|
/**
|
|
5192
5215
|
* Order ID
|
|
5193
5216
|
* @minLength 1
|
|
@@ -5201,15 +5224,15 @@ export interface UpdateOrderLineItemsRequest {
|
|
|
5201
5224
|
*/
|
|
5202
5225
|
lineItems?: MaskedOrderLineItem[];
|
|
5203
5226
|
}
|
|
5204
|
-
|
|
5227
|
+
interface MaskedOrderLineItem {
|
|
5205
5228
|
/** Order line item to update */
|
|
5206
5229
|
lineItem?: OrderLineItem;
|
|
5207
5230
|
}
|
|
5208
|
-
|
|
5231
|
+
interface UpdateOrderLineItemsResponse {
|
|
5209
5232
|
/** Updated order data */
|
|
5210
5233
|
order?: Order;
|
|
5211
5234
|
}
|
|
5212
|
-
|
|
5235
|
+
interface AddInternalActivityRequest {
|
|
5213
5236
|
/**
|
|
5214
5237
|
* Order ID.
|
|
5215
5238
|
* @minLength 1
|
|
@@ -5219,7 +5242,7 @@ export interface AddInternalActivityRequest {
|
|
|
5219
5242
|
/** Activity info. */
|
|
5220
5243
|
activity?: InternalActivity;
|
|
5221
5244
|
}
|
|
5222
|
-
|
|
5245
|
+
interface InternalActivity extends InternalActivityContentOneOf {
|
|
5223
5246
|
/** Order refunded. */
|
|
5224
5247
|
orderRefunded?: OrderRefunded;
|
|
5225
5248
|
/** Order placed. */
|
|
@@ -5293,7 +5316,7 @@ export interface InternalActivity extends InternalActivityContentOneOf {
|
|
|
5293
5316
|
_createdDate?: Date | null;
|
|
5294
5317
|
}
|
|
5295
5318
|
/** @oneof */
|
|
5296
|
-
|
|
5319
|
+
interface InternalActivityContentOneOf {
|
|
5297
5320
|
/** Order refunded. */
|
|
5298
5321
|
orderRefunded?: OrderRefunded;
|
|
5299
5322
|
/** Order placed. */
|
|
@@ -5350,63 +5373,63 @@ export interface InternalActivityContentOneOf {
|
|
|
5350
5373
|
orderRejected?: OrderRejected;
|
|
5351
5374
|
}
|
|
5352
5375
|
/** Order placed */
|
|
5353
|
-
|
|
5376
|
+
interface OrderPlaced {
|
|
5354
5377
|
}
|
|
5355
5378
|
/** Order marked as paid, either by the store owner (for offline orders), or when an online transaction was confirmed */
|
|
5356
|
-
|
|
5379
|
+
interface OrderPaid {
|
|
5357
5380
|
}
|
|
5358
5381
|
/** Order shipping status set as fulfilled */
|
|
5359
|
-
|
|
5382
|
+
interface OrderFulfilled {
|
|
5360
5383
|
}
|
|
5361
5384
|
/** Order shipping status set as not fulfilled */
|
|
5362
|
-
|
|
5385
|
+
interface OrderNotFulfilled {
|
|
5363
5386
|
}
|
|
5364
5387
|
/** Order canceled */
|
|
5365
|
-
|
|
5388
|
+
interface OrderCanceled {
|
|
5366
5389
|
}
|
|
5367
5390
|
/** A download link was sent (relevant for orders with digital line items) */
|
|
5368
|
-
|
|
5391
|
+
interface DownloadLinkSent {
|
|
5369
5392
|
}
|
|
5370
5393
|
/** Shipping tracking number was set */
|
|
5371
|
-
|
|
5394
|
+
interface TrackingNumberAdded {
|
|
5372
5395
|
}
|
|
5373
5396
|
/** Shipping tracking number was edited */
|
|
5374
|
-
|
|
5397
|
+
interface TrackingNumberEdited {
|
|
5375
5398
|
}
|
|
5376
5399
|
/** Shipping tracking link was set */
|
|
5377
|
-
|
|
5400
|
+
interface TrackingLinkAdded {
|
|
5378
5401
|
}
|
|
5379
5402
|
/** An email confirmation of order shipment was sent */
|
|
5380
|
-
|
|
5403
|
+
interface ShippingConfirmationEmailSent {
|
|
5381
5404
|
}
|
|
5382
5405
|
/** Invoice was set in the order */
|
|
5383
|
-
|
|
5406
|
+
interface InvoiceAdded {
|
|
5384
5407
|
}
|
|
5385
5408
|
/** Invoice sent to customer via email */
|
|
5386
|
-
|
|
5409
|
+
interface InvoiceSent {
|
|
5387
5410
|
}
|
|
5388
5411
|
/** Email was sent to fulfiller */
|
|
5389
|
-
|
|
5412
|
+
interface FulfillerEmailSent {
|
|
5390
5413
|
}
|
|
5391
5414
|
/** Shipping address was updated */
|
|
5392
|
-
|
|
5415
|
+
interface ShippingAddressEdited {
|
|
5393
5416
|
}
|
|
5394
5417
|
/** Order email was updated */
|
|
5395
|
-
|
|
5418
|
+
interface EmailEdited {
|
|
5396
5419
|
}
|
|
5397
5420
|
/** An email notification for pickup was sent */
|
|
5398
|
-
|
|
5421
|
+
interface PickupReadyEmailSent {
|
|
5399
5422
|
}
|
|
5400
5423
|
/** Order marked as partially paid when an online transaction was confirmed with partial minimal required amount of total sum */
|
|
5401
|
-
|
|
5424
|
+
interface OrderPartiallyPaid {
|
|
5402
5425
|
}
|
|
5403
5426
|
/** Order reject */
|
|
5404
|
-
|
|
5427
|
+
interface OrderPending {
|
|
5405
5428
|
}
|
|
5406
5429
|
/** Order reject */
|
|
5407
|
-
|
|
5430
|
+
interface OrderRejected {
|
|
5408
5431
|
}
|
|
5409
|
-
|
|
5432
|
+
interface AddInternalActivityResponse {
|
|
5410
5433
|
/** Updated order. */
|
|
5411
5434
|
order?: Order;
|
|
5412
5435
|
/**
|
|
@@ -5416,7 +5439,7 @@ export interface AddInternalActivityResponse {
|
|
|
5416
5439
|
*/
|
|
5417
5440
|
activityId?: string;
|
|
5418
5441
|
}
|
|
5419
|
-
|
|
5442
|
+
interface AddActivityRequest {
|
|
5420
5443
|
/**
|
|
5421
5444
|
* Order ID.
|
|
5422
5445
|
* @minLength 1
|
|
@@ -5426,20 +5449,20 @@ export interface AddActivityRequest {
|
|
|
5426
5449
|
/** Activity info. */
|
|
5427
5450
|
activity: PublicActivity;
|
|
5428
5451
|
}
|
|
5429
|
-
|
|
5452
|
+
interface PublicActivity extends PublicActivityContentOneOf {
|
|
5430
5453
|
/** Custom activity details. */
|
|
5431
5454
|
customActivity?: CustomActivity;
|
|
5432
5455
|
/** Merchant commment. */
|
|
5433
5456
|
merchantComment?: MerchantComment;
|
|
5434
5457
|
}
|
|
5435
5458
|
/** @oneof */
|
|
5436
|
-
|
|
5459
|
+
interface PublicActivityContentOneOf {
|
|
5437
5460
|
/** Custom activity details. */
|
|
5438
5461
|
customActivity?: CustomActivity;
|
|
5439
5462
|
/** Merchant commment. */
|
|
5440
5463
|
merchantComment?: MerchantComment;
|
|
5441
5464
|
}
|
|
5442
|
-
|
|
5465
|
+
interface AddActivityResponse {
|
|
5443
5466
|
/** Updated order. */
|
|
5444
5467
|
order?: Order;
|
|
5445
5468
|
/**
|
|
@@ -5449,7 +5472,7 @@ export interface AddActivityResponse {
|
|
|
5449
5472
|
*/
|
|
5450
5473
|
activityId?: string;
|
|
5451
5474
|
}
|
|
5452
|
-
|
|
5475
|
+
interface AddActivitiesRequest {
|
|
5453
5476
|
/**
|
|
5454
5477
|
* Order ID.
|
|
5455
5478
|
* @format GUID
|
|
@@ -5462,7 +5485,7 @@ export interface AddActivitiesRequest {
|
|
|
5462
5485
|
*/
|
|
5463
5486
|
activities?: PublicActivity[];
|
|
5464
5487
|
}
|
|
5465
|
-
|
|
5488
|
+
interface AddActivitiesResponse {
|
|
5466
5489
|
/** Updated order. */
|
|
5467
5490
|
order?: Order;
|
|
5468
5491
|
/**
|
|
@@ -5472,7 +5495,7 @@ export interface AddActivitiesResponse {
|
|
|
5472
5495
|
*/
|
|
5473
5496
|
activityIds?: string[];
|
|
5474
5497
|
}
|
|
5475
|
-
|
|
5498
|
+
interface UpdateActivityRequest {
|
|
5476
5499
|
/**
|
|
5477
5500
|
* Order ID.
|
|
5478
5501
|
* @minLength 1
|
|
@@ -5487,11 +5510,11 @@ export interface UpdateActivityRequest {
|
|
|
5487
5510
|
/** Activity info. */
|
|
5488
5511
|
activity: PublicActivity;
|
|
5489
5512
|
}
|
|
5490
|
-
|
|
5513
|
+
interface UpdateActivityResponse {
|
|
5491
5514
|
/** Updated order. */
|
|
5492
5515
|
order?: Order;
|
|
5493
5516
|
}
|
|
5494
|
-
|
|
5517
|
+
interface DeleteActivityRequest {
|
|
5495
5518
|
/**
|
|
5496
5519
|
* Order ID.
|
|
5497
5520
|
* @minLength 1
|
|
@@ -5504,11 +5527,11 @@ export interface DeleteActivityRequest {
|
|
|
5504
5527
|
*/
|
|
5505
5528
|
activityId: string;
|
|
5506
5529
|
}
|
|
5507
|
-
|
|
5530
|
+
interface DeleteActivityResponse {
|
|
5508
5531
|
/** Updated order. */
|
|
5509
5532
|
order?: Order;
|
|
5510
5533
|
}
|
|
5511
|
-
|
|
5534
|
+
interface UpdateLineItemsDescriptionLinesRequest {
|
|
5512
5535
|
/**
|
|
5513
5536
|
* Order ID.
|
|
5514
5537
|
* @minLength 1
|
|
@@ -5522,7 +5545,7 @@ export interface UpdateLineItemsDescriptionLinesRequest {
|
|
|
5522
5545
|
*/
|
|
5523
5546
|
lineItems?: LineItemUpdate[];
|
|
5524
5547
|
}
|
|
5525
|
-
|
|
5548
|
+
interface LineItemUpdate {
|
|
5526
5549
|
/**
|
|
5527
5550
|
* Line item ID.
|
|
5528
5551
|
* @format GUID
|
|
@@ -5536,11 +5559,11 @@ export interface LineItemUpdate {
|
|
|
5536
5559
|
*/
|
|
5537
5560
|
descriptionLines?: DescriptionLine[];
|
|
5538
5561
|
}
|
|
5539
|
-
|
|
5562
|
+
interface UpdateLineItemsDescriptionLinesResponse {
|
|
5540
5563
|
/** Updated order. */
|
|
5541
5564
|
order?: Order;
|
|
5542
5565
|
}
|
|
5543
|
-
|
|
5566
|
+
interface MarkOrderAsSeenByHumanRequest {
|
|
5544
5567
|
/**
|
|
5545
5568
|
* Order ID.
|
|
5546
5569
|
* @minLength 1
|
|
@@ -5548,11 +5571,11 @@ export interface MarkOrderAsSeenByHumanRequest {
|
|
|
5548
5571
|
*/
|
|
5549
5572
|
_id?: string;
|
|
5550
5573
|
}
|
|
5551
|
-
|
|
5574
|
+
interface MarkOrderAsSeenByHumanResponse {
|
|
5552
5575
|
/** Updated order. */
|
|
5553
5576
|
order?: Order;
|
|
5554
5577
|
}
|
|
5555
|
-
|
|
5578
|
+
interface CancelOrderRequest {
|
|
5556
5579
|
/**
|
|
5557
5580
|
* Order ID.
|
|
5558
5581
|
* @minLength 1
|
|
@@ -5570,11 +5593,11 @@ export interface CancelOrderRequest {
|
|
|
5570
5593
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
5571
5594
|
restockAllItems?: boolean;
|
|
5572
5595
|
}
|
|
5573
|
-
|
|
5596
|
+
interface CancelOrderResponse {
|
|
5574
5597
|
/** Canceled order. */
|
|
5575
5598
|
order?: Order;
|
|
5576
5599
|
}
|
|
5577
|
-
|
|
5600
|
+
interface OrderCanceledEventOrderCanceled {
|
|
5578
5601
|
/** The order that was cancelled */
|
|
5579
5602
|
order?: Order;
|
|
5580
5603
|
/** Should restock all items on that order */
|
|
@@ -5584,7 +5607,7 @@ export interface OrderCanceledEventOrderCanceled {
|
|
|
5584
5607
|
/** Personal note added to the email */
|
|
5585
5608
|
customMessage?: string | null;
|
|
5586
5609
|
}
|
|
5587
|
-
|
|
5610
|
+
interface UpdateOrderStatusRequest {
|
|
5588
5611
|
/**
|
|
5589
5612
|
* Order ID.
|
|
5590
5613
|
* @format GUID
|
|
@@ -5593,11 +5616,11 @@ export interface UpdateOrderStatusRequest {
|
|
|
5593
5616
|
/** New order status. */
|
|
5594
5617
|
status: OrderStatusWithLiterals;
|
|
5595
5618
|
}
|
|
5596
|
-
|
|
5619
|
+
interface UpdateOrderStatusResponse {
|
|
5597
5620
|
/** Updated order. */
|
|
5598
5621
|
order?: Order;
|
|
5599
5622
|
}
|
|
5600
|
-
|
|
5623
|
+
interface MarkAsFulfilledRequest {
|
|
5601
5624
|
/**
|
|
5602
5625
|
* Order ID.
|
|
5603
5626
|
* @minLength 1
|
|
@@ -5605,12 +5628,12 @@ export interface MarkAsFulfilledRequest {
|
|
|
5605
5628
|
*/
|
|
5606
5629
|
_id?: string;
|
|
5607
5630
|
}
|
|
5608
|
-
|
|
5631
|
+
interface MarkAsFulfilledResponse {
|
|
5609
5632
|
/** Updated order. */
|
|
5610
5633
|
order?: Order;
|
|
5611
5634
|
}
|
|
5612
5635
|
/** Triggered when the fulfillment status of an order is updated */
|
|
5613
|
-
|
|
5636
|
+
interface FulfillmentStatusUpdated {
|
|
5614
5637
|
/** The order that was updated */
|
|
5615
5638
|
order?: Order;
|
|
5616
5639
|
/** The previous status (before the update) */
|
|
@@ -5620,7 +5643,7 @@ export interface FulfillmentStatusUpdated {
|
|
|
5620
5643
|
/** the action that caused this update */
|
|
5621
5644
|
action?: string;
|
|
5622
5645
|
}
|
|
5623
|
-
|
|
5646
|
+
interface BulkMarkAsFulfilledRequest {
|
|
5624
5647
|
/**
|
|
5625
5648
|
* IDs of orders to be marked as fulfilled.
|
|
5626
5649
|
* @minSize 1
|
|
@@ -5630,23 +5653,23 @@ export interface BulkMarkAsFulfilledRequest {
|
|
|
5630
5653
|
/** Whether to return the full updated order entities in the response. */
|
|
5631
5654
|
returnFullEntity?: boolean;
|
|
5632
5655
|
}
|
|
5633
|
-
|
|
5656
|
+
interface BulkMarkAsFulfilledResponse {
|
|
5634
5657
|
/** Items updated by bulk action. */
|
|
5635
5658
|
results?: BulkOrderResult[];
|
|
5636
5659
|
/** Bulk action metadata. */
|
|
5637
5660
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5638
5661
|
}
|
|
5639
|
-
|
|
5662
|
+
interface BulkMarkAsFulfilledByFilterRequest {
|
|
5640
5663
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
5641
5664
|
filter?: Record<string, any> | null;
|
|
5642
5665
|
}
|
|
5643
|
-
|
|
5666
|
+
interface BulkMarkAsFulfilledByFilterResponse {
|
|
5644
5667
|
/** Items updated by bulk action. */
|
|
5645
5668
|
results?: BulkOrderResult[];
|
|
5646
5669
|
/** Bulk action metadata. */
|
|
5647
5670
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5648
5671
|
}
|
|
5649
|
-
|
|
5672
|
+
interface MarkAsUnfulfilledRequest {
|
|
5650
5673
|
/**
|
|
5651
5674
|
* Order ID.
|
|
5652
5675
|
* @minLength 1
|
|
@@ -5654,11 +5677,11 @@ export interface MarkAsUnfulfilledRequest {
|
|
|
5654
5677
|
*/
|
|
5655
5678
|
_id?: string;
|
|
5656
5679
|
}
|
|
5657
|
-
|
|
5680
|
+
interface MarkAsUnfulfilledResponse {
|
|
5658
5681
|
/** Updated order. */
|
|
5659
5682
|
order?: Order;
|
|
5660
5683
|
}
|
|
5661
|
-
|
|
5684
|
+
interface BulkMarkAsUnfulfilledRequest {
|
|
5662
5685
|
/**
|
|
5663
5686
|
* IDs of orders to be marked as not fulfilled.
|
|
5664
5687
|
* @minSize 1
|
|
@@ -5668,23 +5691,23 @@ export interface BulkMarkAsUnfulfilledRequest {
|
|
|
5668
5691
|
/** Whether to return the full updated order entities in the response. */
|
|
5669
5692
|
returnFullEntity?: boolean;
|
|
5670
5693
|
}
|
|
5671
|
-
|
|
5694
|
+
interface BulkMarkAsUnfulfilledResponse {
|
|
5672
5695
|
/** Items updated by bulk action. */
|
|
5673
5696
|
results?: BulkOrderResult[];
|
|
5674
5697
|
/** Bulk action metadata. */
|
|
5675
5698
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5676
5699
|
}
|
|
5677
|
-
|
|
5700
|
+
interface BulkMarkAsUnfulfilledByFilterRequest {
|
|
5678
5701
|
/** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort). */
|
|
5679
5702
|
filter?: Record<string, any> | null;
|
|
5680
5703
|
}
|
|
5681
|
-
|
|
5704
|
+
interface BulkMarkAsUnfulfilledByFilterResponse {
|
|
5682
5705
|
/** Items updated by bulk action. */
|
|
5683
5706
|
results?: BulkOrderResult[];
|
|
5684
5707
|
/** Bulk action metadata. */
|
|
5685
5708
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5686
5709
|
}
|
|
5687
|
-
|
|
5710
|
+
interface BulkSetBusinessLocationRequest {
|
|
5688
5711
|
/**
|
|
5689
5712
|
* IDs of orders to update location for.
|
|
5690
5713
|
* @minSize 1
|
|
@@ -5695,7 +5718,7 @@ export interface BulkSetBusinessLocationRequest {
|
|
|
5695
5718
|
/** Business location. */
|
|
5696
5719
|
businessLocation?: Location;
|
|
5697
5720
|
}
|
|
5698
|
-
|
|
5721
|
+
interface BulkSetBusinessLocationResponse {
|
|
5699
5722
|
/**
|
|
5700
5723
|
* Bulk action results.
|
|
5701
5724
|
* @minSize 1
|
|
@@ -5705,10 +5728,10 @@ export interface BulkSetBusinessLocationResponse {
|
|
|
5705
5728
|
/** Bulk action metadata. */
|
|
5706
5729
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5707
5730
|
}
|
|
5708
|
-
|
|
5731
|
+
interface BulkSetBusinessLocationResult {
|
|
5709
5732
|
itemMetadata?: ItemMetadata;
|
|
5710
5733
|
}
|
|
5711
|
-
|
|
5734
|
+
interface V1MarkOrderAsPaidRequest {
|
|
5712
5735
|
/**
|
|
5713
5736
|
* Order ID.
|
|
5714
5737
|
* @minLength 1
|
|
@@ -5716,11 +5739,11 @@ export interface V1MarkOrderAsPaidRequest {
|
|
|
5716
5739
|
*/
|
|
5717
5740
|
_id?: string;
|
|
5718
5741
|
}
|
|
5719
|
-
|
|
5742
|
+
interface V1MarkOrderAsPaidResponse {
|
|
5720
5743
|
/** Updated order. */
|
|
5721
5744
|
order?: Order;
|
|
5722
5745
|
}
|
|
5723
|
-
|
|
5746
|
+
interface V1BulkMarkOrdersAsPaidRequest {
|
|
5724
5747
|
/**
|
|
5725
5748
|
* IDs of orders to mark as paid.
|
|
5726
5749
|
* @minSize 1
|
|
@@ -5730,7 +5753,7 @@ export interface V1BulkMarkOrdersAsPaidRequest {
|
|
|
5730
5753
|
*/
|
|
5731
5754
|
ids?: string[];
|
|
5732
5755
|
}
|
|
5733
|
-
|
|
5756
|
+
interface V1BulkMarkOrdersAsPaidResponse {
|
|
5734
5757
|
/**
|
|
5735
5758
|
* Items updated by the bulk action.
|
|
5736
5759
|
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
@@ -5739,7 +5762,7 @@ export interface V1BulkMarkOrdersAsPaidResponse {
|
|
|
5739
5762
|
/** Bulk action metadata. */
|
|
5740
5763
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5741
5764
|
}
|
|
5742
|
-
|
|
5765
|
+
interface V1CreatePaymentGatewayOrderRequest {
|
|
5743
5766
|
/**
|
|
5744
5767
|
* eCom Order ID
|
|
5745
5768
|
* @minLength 1
|
|
@@ -5747,21 +5770,21 @@ export interface V1CreatePaymentGatewayOrderRequest {
|
|
|
5747
5770
|
*/
|
|
5748
5771
|
ecomOrderId?: string;
|
|
5749
5772
|
}
|
|
5750
|
-
|
|
5773
|
+
interface V1CreatePaymentGatewayOrderResponse {
|
|
5751
5774
|
/** ID of the order created in the payment gateway */
|
|
5752
5775
|
paymentGatewayOrderId?: string;
|
|
5753
5776
|
}
|
|
5754
|
-
|
|
5777
|
+
interface GetShipmentsRequest {
|
|
5755
5778
|
/**
|
|
5756
5779
|
* @minLength 1
|
|
5757
5780
|
* @maxLength 100
|
|
5758
5781
|
*/
|
|
5759
5782
|
_id?: string;
|
|
5760
5783
|
}
|
|
5761
|
-
|
|
5784
|
+
interface GetShipmentsResponse {
|
|
5762
5785
|
shipmentIds?: string[];
|
|
5763
5786
|
}
|
|
5764
|
-
|
|
5787
|
+
interface AggregateOrdersRequest {
|
|
5765
5788
|
/** Filter applied to original data */
|
|
5766
5789
|
filter?: Record<string, any> | null;
|
|
5767
5790
|
/** This is an object defining aggregation itself */
|
|
@@ -5777,10 +5800,10 @@ export interface AggregateOrdersRequest {
|
|
|
5777
5800
|
*/
|
|
5778
5801
|
hierarchySeparatorOverride?: string | null;
|
|
5779
5802
|
}
|
|
5780
|
-
|
|
5803
|
+
interface AggregateOrdersResponse {
|
|
5781
5804
|
aggregates?: Record<string, any> | null;
|
|
5782
5805
|
}
|
|
5783
|
-
|
|
5806
|
+
interface DecrementItemsQuantityRequest {
|
|
5784
5807
|
/**
|
|
5785
5808
|
* Order ID
|
|
5786
5809
|
* @minLength 1
|
|
@@ -5794,7 +5817,7 @@ export interface DecrementItemsQuantityRequest {
|
|
|
5794
5817
|
*/
|
|
5795
5818
|
decrementData?: DecrementData[];
|
|
5796
5819
|
}
|
|
5797
|
-
|
|
5820
|
+
interface DecrementData {
|
|
5798
5821
|
/**
|
|
5799
5822
|
* ID of the line item being decremented.
|
|
5800
5823
|
* @format GUID
|
|
@@ -5809,11 +5832,11 @@ export interface DecrementData {
|
|
|
5809
5832
|
/** Whether to restock the line item (triggers inventory update). */
|
|
5810
5833
|
restock?: boolean;
|
|
5811
5834
|
}
|
|
5812
|
-
|
|
5835
|
+
interface DecrementItemsQuantityResponse {
|
|
5813
5836
|
/** Updated order data */
|
|
5814
5837
|
order?: Order;
|
|
5815
5838
|
}
|
|
5816
|
-
|
|
5839
|
+
interface BulkUpdateOrderTagsRequest {
|
|
5817
5840
|
/**
|
|
5818
5841
|
* IDs of orders to update tags for.
|
|
5819
5842
|
* @minSize 1
|
|
@@ -5826,7 +5849,7 @@ export interface BulkUpdateOrderTagsRequest {
|
|
|
5826
5849
|
/** Tags to be removed from orders */
|
|
5827
5850
|
unassignTags?: Tags;
|
|
5828
5851
|
}
|
|
5829
|
-
|
|
5852
|
+
interface BulkUpdateOrderTagsResponse {
|
|
5830
5853
|
/**
|
|
5831
5854
|
* @minSize 1
|
|
5832
5855
|
* @maxSize 100
|
|
@@ -5834,51 +5857,51 @@ export interface BulkUpdateOrderTagsResponse {
|
|
|
5834
5857
|
results?: BulkUpdateOrderTagsResult[];
|
|
5835
5858
|
bulkActionMetadata?: BulkActionMetadata;
|
|
5836
5859
|
}
|
|
5837
|
-
|
|
5860
|
+
interface BulkUpdateOrderTagsResult {
|
|
5838
5861
|
itemMetadata?: ItemMetadata;
|
|
5839
5862
|
}
|
|
5840
|
-
|
|
5863
|
+
interface Task {
|
|
5841
5864
|
key?: TaskKey;
|
|
5842
5865
|
executeAt?: Date | null;
|
|
5843
5866
|
payload?: string | null;
|
|
5844
5867
|
}
|
|
5845
|
-
|
|
5868
|
+
interface TaskKey {
|
|
5846
5869
|
appId?: string;
|
|
5847
5870
|
instanceId?: string;
|
|
5848
5871
|
subjectId?: string | null;
|
|
5849
5872
|
}
|
|
5850
|
-
|
|
5873
|
+
interface TaskAction extends TaskActionActionOneOf {
|
|
5851
5874
|
complete?: Complete;
|
|
5852
5875
|
cancel?: Cancel;
|
|
5853
5876
|
reschedule?: Reschedule;
|
|
5854
5877
|
}
|
|
5855
5878
|
/** @oneof */
|
|
5856
|
-
|
|
5879
|
+
interface TaskActionActionOneOf {
|
|
5857
5880
|
complete?: Complete;
|
|
5858
5881
|
cancel?: Cancel;
|
|
5859
5882
|
reschedule?: Reschedule;
|
|
5860
5883
|
}
|
|
5861
|
-
|
|
5884
|
+
interface Complete {
|
|
5862
5885
|
}
|
|
5863
|
-
|
|
5886
|
+
interface Cancel {
|
|
5864
5887
|
}
|
|
5865
|
-
|
|
5888
|
+
interface Reschedule {
|
|
5866
5889
|
executeAt?: Date | null;
|
|
5867
5890
|
payload?: string | null;
|
|
5868
5891
|
}
|
|
5869
|
-
|
|
5892
|
+
interface InvoiceSentEvent {
|
|
5870
5893
|
_id?: IdAndVersion;
|
|
5871
5894
|
/** @readonly */
|
|
5872
5895
|
data?: InvoiceFields;
|
|
5873
5896
|
/** @readonly */
|
|
5874
5897
|
status?: InvoiceStatusWithLiterals;
|
|
5875
5898
|
}
|
|
5876
|
-
|
|
5899
|
+
interface IdAndVersion {
|
|
5877
5900
|
/** @format GUID */
|
|
5878
5901
|
_id?: string | null;
|
|
5879
5902
|
version?: number | null;
|
|
5880
5903
|
}
|
|
5881
|
-
|
|
5904
|
+
interface InvoiceFields {
|
|
5882
5905
|
/** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
|
|
5883
5906
|
number?: string | null;
|
|
5884
5907
|
/**
|
|
@@ -5949,7 +5972,7 @@ export interface InvoiceFields {
|
|
|
5949
5972
|
/** Associated checkout for this invoice */
|
|
5950
5973
|
ecomCheckoutId?: string | null;
|
|
5951
5974
|
}
|
|
5952
|
-
|
|
5975
|
+
interface Customer {
|
|
5953
5976
|
contactId?: string | null;
|
|
5954
5977
|
name?: string | null;
|
|
5955
5978
|
email?: Email;
|
|
@@ -5961,10 +5984,10 @@ export interface Customer {
|
|
|
5961
5984
|
billingAddress?: CommonAddress;
|
|
5962
5985
|
shippingAddress?: CommonAddress;
|
|
5963
5986
|
}
|
|
5964
|
-
|
|
5987
|
+
interface Email {
|
|
5965
5988
|
address?: string;
|
|
5966
5989
|
}
|
|
5967
|
-
|
|
5990
|
+
interface QuotesAddress {
|
|
5968
5991
|
street?: string | null;
|
|
5969
5992
|
city?: string | null;
|
|
5970
5993
|
zip?: string | null;
|
|
@@ -5973,27 +5996,27 @@ export interface QuotesAddress {
|
|
|
5973
5996
|
/** @readonly */
|
|
5974
5997
|
description?: AddressDescription;
|
|
5975
5998
|
}
|
|
5976
|
-
|
|
5999
|
+
interface AddressDescription {
|
|
5977
6000
|
content?: string;
|
|
5978
6001
|
placement?: PlacementWithLiterals;
|
|
5979
6002
|
}
|
|
5980
|
-
|
|
6003
|
+
declare enum Placement {
|
|
5981
6004
|
Unknown = "Unknown",
|
|
5982
6005
|
Replace = "Replace",
|
|
5983
6006
|
Before = "Before",
|
|
5984
6007
|
After = "After"
|
|
5985
6008
|
}
|
|
5986
6009
|
/** @enumType */
|
|
5987
|
-
|
|
5988
|
-
|
|
6010
|
+
type PlacementWithLiterals = Placement | 'Unknown' | 'Replace' | 'Before' | 'After';
|
|
6011
|
+
interface Phone {
|
|
5989
6012
|
number?: string;
|
|
5990
6013
|
}
|
|
5991
|
-
|
|
6014
|
+
interface Company {
|
|
5992
6015
|
name?: string;
|
|
5993
6016
|
_id?: string | null;
|
|
5994
6017
|
}
|
|
5995
6018
|
/** Physical address */
|
|
5996
|
-
|
|
6019
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
5997
6020
|
/** Street name and number. */
|
|
5998
6021
|
streetAddress?: StreetAddress;
|
|
5999
6022
|
/** Main address line, usually street and number as free text. */
|
|
@@ -6013,19 +6036,19 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
6013
6036
|
addressLine2?: string | null;
|
|
6014
6037
|
}
|
|
6015
6038
|
/** @oneof */
|
|
6016
|
-
|
|
6039
|
+
interface CommonAddressStreetOneOf {
|
|
6017
6040
|
/** Street name and number. */
|
|
6018
6041
|
streetAddress?: StreetAddress;
|
|
6019
6042
|
/** Main address line, usually street and number as free text. */
|
|
6020
6043
|
addressLine?: string | null;
|
|
6021
6044
|
}
|
|
6022
|
-
|
|
6045
|
+
interface Subdivision {
|
|
6023
6046
|
/** Short subdivision code. */
|
|
6024
6047
|
code?: string;
|
|
6025
6048
|
/** Subdivision full name. */
|
|
6026
6049
|
name?: string;
|
|
6027
6050
|
}
|
|
6028
|
-
|
|
6051
|
+
declare enum SubdivisionType {
|
|
6029
6052
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
6030
6053
|
/** State */
|
|
6031
6054
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -6040,17 +6063,15 @@ export declare enum SubdivisionType {
|
|
|
6040
6063
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
6041
6064
|
COUNTRY = "COUNTRY"
|
|
6042
6065
|
}
|
|
6043
|
-
/** @enumType */
|
|
6044
|
-
export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
6045
6066
|
/** Subdivision Concordance values */
|
|
6046
|
-
|
|
6067
|
+
interface StandardDetails {
|
|
6047
6068
|
/**
|
|
6048
6069
|
* 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
|
|
6049
6070
|
* @maxLength 20
|
|
6050
6071
|
*/
|
|
6051
6072
|
iso31662?: string | null;
|
|
6052
6073
|
}
|
|
6053
|
-
|
|
6074
|
+
interface InvoiceDates {
|
|
6054
6075
|
/** use UTC midnight date to set the issue date according to the site time zone */
|
|
6055
6076
|
issueDate?: Date | null;
|
|
6056
6077
|
/** use UTC midnight date to set the due date according to the site time zone */
|
|
@@ -6063,10 +6084,10 @@ export interface InvoiceDates {
|
|
|
6063
6084
|
*/
|
|
6064
6085
|
lastSeenDate?: Date | null;
|
|
6065
6086
|
}
|
|
6066
|
-
|
|
6087
|
+
interface LineItems {
|
|
6067
6088
|
lineItems?: LineItem[];
|
|
6068
6089
|
}
|
|
6069
|
-
|
|
6090
|
+
interface LineItem {
|
|
6070
6091
|
/** @format GUID */
|
|
6071
6092
|
_id?: string;
|
|
6072
6093
|
name?: string;
|
|
@@ -6080,15 +6101,15 @@ export interface LineItem {
|
|
|
6080
6101
|
/** The line-item level metadata. */
|
|
6081
6102
|
metadata?: LineItemMetaData;
|
|
6082
6103
|
}
|
|
6083
|
-
|
|
6104
|
+
interface BigDecimalWrapper {
|
|
6084
6105
|
serializedValue?: number;
|
|
6085
6106
|
}
|
|
6086
|
-
|
|
6107
|
+
interface LineItemTax {
|
|
6087
6108
|
name?: string;
|
|
6088
6109
|
rate?: BigDecimalWrapper;
|
|
6089
6110
|
code?: string | null;
|
|
6090
6111
|
}
|
|
6091
|
-
|
|
6112
|
+
interface Source {
|
|
6092
6113
|
/**
|
|
6093
6114
|
* Source app or service ID.
|
|
6094
6115
|
* @readonly
|
|
@@ -6100,7 +6121,7 @@ export interface Source {
|
|
|
6100
6121
|
*/
|
|
6101
6122
|
sourceType?: SourceTypeWithLiterals;
|
|
6102
6123
|
}
|
|
6103
|
-
|
|
6124
|
+
declare enum SourceType {
|
|
6104
6125
|
UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
|
|
6105
6126
|
WIX_APP = "WIX_APP",
|
|
6106
6127
|
EXTERNAL = "EXTERNAL",
|
|
@@ -6108,18 +6129,18 @@ export declare enum SourceType {
|
|
|
6108
6129
|
OTHER = "OTHER"
|
|
6109
6130
|
}
|
|
6110
6131
|
/** @enumType */
|
|
6111
|
-
|
|
6112
|
-
|
|
6132
|
+
type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'WIX_APP' | 'EXTERNAL' | 'ADMIN' | 'OTHER';
|
|
6133
|
+
interface LineItemMetaData {
|
|
6113
6134
|
metadata?: Record<string, string>;
|
|
6114
6135
|
}
|
|
6115
|
-
|
|
6136
|
+
interface Locale {
|
|
6116
6137
|
/** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
|
|
6117
6138
|
language?: string;
|
|
6118
6139
|
/** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
|
|
6119
6140
|
country?: string | null;
|
|
6120
6141
|
invariant?: string | null;
|
|
6121
6142
|
}
|
|
6122
|
-
|
|
6143
|
+
interface TotalPrice {
|
|
6123
6144
|
/** the subtotal of the line items without the tax reduction */
|
|
6124
6145
|
subtotal?: BigDecimalWrapper;
|
|
6125
6146
|
/** the total price taking into account the itemized fees and the taxes */
|
|
@@ -6128,24 +6149,24 @@ export interface TotalPrice {
|
|
|
6128
6149
|
discountAmount?: BigDecimalWrapper;
|
|
6129
6150
|
taxedAmount?: BigDecimalWrapper;
|
|
6130
6151
|
}
|
|
6131
|
-
|
|
6152
|
+
interface ItemizedFee {
|
|
6132
6153
|
name?: string;
|
|
6133
6154
|
price?: BigDecimalWrapper;
|
|
6134
6155
|
}
|
|
6135
|
-
|
|
6156
|
+
interface Discount extends DiscountOneDiscountTypeOneOf {
|
|
6136
6157
|
/** Discount as percentage value. */
|
|
6137
6158
|
percentage?: BigDecimalWrapper;
|
|
6138
6159
|
}
|
|
6139
6160
|
/** @oneof */
|
|
6140
|
-
|
|
6161
|
+
interface DiscountOneDiscountTypeOneOf {
|
|
6141
6162
|
/** Discount as percentage value. */
|
|
6142
6163
|
percentage?: BigDecimalWrapper;
|
|
6143
6164
|
}
|
|
6144
|
-
|
|
6165
|
+
interface CalculatedTaxes {
|
|
6145
6166
|
/** consider calculated or not - cannot enforce set */
|
|
6146
6167
|
taxes?: CalculatedTax[];
|
|
6147
6168
|
}
|
|
6148
|
-
|
|
6169
|
+
interface CalculatedTax {
|
|
6149
6170
|
name?: string;
|
|
6150
6171
|
rate?: BigDecimalWrapper;
|
|
6151
6172
|
/** the costs on which the taxes are applied */
|
|
@@ -6154,10 +6175,10 @@ export interface CalculatedTax {
|
|
|
6154
6175
|
taxed?: BigDecimalWrapper;
|
|
6155
6176
|
code?: string | null;
|
|
6156
6177
|
}
|
|
6157
|
-
|
|
6178
|
+
interface Payments {
|
|
6158
6179
|
payments?: InvoicesPayment[];
|
|
6159
6180
|
}
|
|
6160
|
-
|
|
6181
|
+
interface InvoicesPayment {
|
|
6161
6182
|
/** document */
|
|
6162
6183
|
_id?: string;
|
|
6163
6184
|
type?: string;
|
|
@@ -6174,7 +6195,7 @@ export interface InvoicesPayment {
|
|
|
6174
6195
|
*/
|
|
6175
6196
|
transactionId?: string | null;
|
|
6176
6197
|
}
|
|
6177
|
-
|
|
6198
|
+
interface MetaData {
|
|
6178
6199
|
notes?: string | null;
|
|
6179
6200
|
legalTerms?: string | null;
|
|
6180
6201
|
sourceUrl?: string | null;
|
|
@@ -6184,7 +6205,7 @@ export interface MetaData {
|
|
|
6184
6205
|
/** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
|
|
6185
6206
|
allowEditByOthers?: boolean | null;
|
|
6186
6207
|
}
|
|
6187
|
-
|
|
6208
|
+
interface InvoiceDynamicPriceTotals {
|
|
6188
6209
|
paidAmount?: BigDecimalWrapper;
|
|
6189
6210
|
balance?: BigDecimalWrapper;
|
|
6190
6211
|
}
|
|
@@ -6192,7 +6213,7 @@ export interface InvoiceDynamicPriceTotals {
|
|
|
6192
6213
|
* A custom field value is used to add additional data to a financial document or to a financial document template.
|
|
6193
6214
|
* The custom field value may be based on a custom field definition.
|
|
6194
6215
|
*/
|
|
6195
|
-
|
|
6216
|
+
interface CustomFieldValue {
|
|
6196
6217
|
/**
|
|
6197
6218
|
* The unique id of the custom field value
|
|
6198
6219
|
* @format GUID
|
|
@@ -6216,7 +6237,7 @@ export interface CustomFieldValue {
|
|
|
6216
6237
|
*/
|
|
6217
6238
|
originCustomFieldKey?: string | null;
|
|
6218
6239
|
}
|
|
6219
|
-
|
|
6240
|
+
declare enum CustomFieldGroup {
|
|
6220
6241
|
UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
|
|
6221
6242
|
BUSINESS_DETAILS = "BUSINESS_DETAILS",
|
|
6222
6243
|
CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
|
|
@@ -6225,12 +6246,12 @@ export declare enum CustomFieldGroup {
|
|
|
6225
6246
|
OTHER = "OTHER"
|
|
6226
6247
|
}
|
|
6227
6248
|
/** @enumType */
|
|
6228
|
-
|
|
6229
|
-
|
|
6249
|
+
type CustomFieldGroupWithLiterals = CustomFieldGroup | 'UNKNOWN_CUSTOM_FIELD_GROUP' | 'BUSINESS_DETAILS' | 'CUSTOMER_DETAILS' | 'DOCUMENT' | 'FOOTER' | 'OTHER';
|
|
6250
|
+
interface Value {
|
|
6230
6251
|
value?: string;
|
|
6231
6252
|
valueType?: ValueTypeWithLiterals;
|
|
6232
6253
|
}
|
|
6233
|
-
|
|
6254
|
+
declare enum ValueType {
|
|
6234
6255
|
UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
|
|
6235
6256
|
STRING = "STRING",
|
|
6236
6257
|
DATE = "DATE",
|
|
@@ -6238,8 +6259,8 @@ export declare enum ValueType {
|
|
|
6238
6259
|
NUMBER = "NUMBER"
|
|
6239
6260
|
}
|
|
6240
6261
|
/** @enumType */
|
|
6241
|
-
|
|
6242
|
-
|
|
6262
|
+
type ValueTypeWithLiterals = ValueType | 'UNKNOWN_VALUE_TYPE' | 'STRING' | 'DATE' | 'BOOLEAN' | 'NUMBER';
|
|
6263
|
+
interface Deposit {
|
|
6243
6264
|
/**
|
|
6244
6265
|
* The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total.
|
|
6245
6266
|
* @format DECIMAL_VALUE
|
|
@@ -6257,13 +6278,13 @@ export interface Deposit {
|
|
|
6257
6278
|
/** The type of the deposit. The default is FLAT. */
|
|
6258
6279
|
type?: DepositTypeWithLiterals;
|
|
6259
6280
|
}
|
|
6260
|
-
|
|
6281
|
+
declare enum DepositType {
|
|
6261
6282
|
UNKNOWN = "UNKNOWN",
|
|
6262
6283
|
FLAT = "FLAT",
|
|
6263
6284
|
PERCENTAGE = "PERCENTAGE"
|
|
6264
6285
|
}
|
|
6265
6286
|
/** @enumType */
|
|
6266
|
-
|
|
6287
|
+
type DepositTypeWithLiterals = DepositType | 'UNKNOWN' | 'FLAT' | 'PERCENTAGE';
|
|
6267
6288
|
/**
|
|
6268
6289
|
* InvoiceStatus allowed transitions based on current status:
|
|
6269
6290
|
* Draft -> Deleted, Paid, Partially Paid, Sent
|
|
@@ -6274,7 +6295,7 @@ export type DepositTypeWithLiterals = DepositType | 'UNKNOWN' | 'FLAT' | 'PERCEN
|
|
|
6274
6295
|
* Void -> Deleted
|
|
6275
6296
|
* Deleted
|
|
6276
6297
|
*/
|
|
6277
|
-
|
|
6298
|
+
declare enum InvoiceStatus {
|
|
6278
6299
|
Draft = "Draft",
|
|
6279
6300
|
Sent = "Sent",
|
|
6280
6301
|
Processing = "Processing",
|
|
@@ -6286,13 +6307,13 @@ export declare enum InvoiceStatus {
|
|
|
6286
6307
|
PartialAndOverdue = "PartialAndOverdue"
|
|
6287
6308
|
}
|
|
6288
6309
|
/** @enumType */
|
|
6289
|
-
|
|
6290
|
-
|
|
6310
|
+
type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
|
|
6311
|
+
interface TriggerSideEffectsFromLegacyData {
|
|
6291
6312
|
storeId?: string;
|
|
6292
6313
|
orderId?: string;
|
|
6293
6314
|
ordersExperiments?: OrdersExperiments;
|
|
6294
6315
|
}
|
|
6295
|
-
|
|
6316
|
+
interface BaseEventMetadata {
|
|
6296
6317
|
/**
|
|
6297
6318
|
* App instance ID.
|
|
6298
6319
|
* @format GUID
|
|
@@ -6306,7 +6327,7 @@ export interface BaseEventMetadata {
|
|
|
6306
6327
|
/** The identification type and identity data. */
|
|
6307
6328
|
identity?: IdentificationData;
|
|
6308
6329
|
}
|
|
6309
|
-
|
|
6330
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
6310
6331
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
6311
6332
|
_id?: string;
|
|
6312
6333
|
/**
|
|
@@ -6336,145 +6357,23 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
6336
6357
|
*/
|
|
6337
6358
|
entityEventSequence?: string | null;
|
|
6338
6359
|
}
|
|
6339
|
-
|
|
6360
|
+
interface OrderApprovedEnvelope {
|
|
6340
6361
|
data: OrderApproved;
|
|
6341
6362
|
metadata: EventMetadata;
|
|
6342
6363
|
}
|
|
6343
|
-
|
|
6344
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6345
|
-
* @permissionScope Manage Stores
|
|
6346
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6347
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6348
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6349
|
-
* @permissionScope Read Orders
|
|
6350
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6351
|
-
* @permissionScope Read Stores - all read permissions
|
|
6352
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6353
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6354
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6355
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6356
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6357
|
-
* @permissionScope Manage Orders
|
|
6358
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6359
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6360
|
-
* @webhook
|
|
6361
|
-
* @eventType wix.ecom.v1.order_approved
|
|
6362
|
-
* @slug approved
|
|
6363
|
-
*/
|
|
6364
|
-
export declare function onOrderApproved(handler: (event: OrderApprovedEnvelope) => void | Promise<void>): void;
|
|
6365
|
-
export interface OrderUpdatedEnvelope {
|
|
6364
|
+
interface OrderUpdatedEnvelope {
|
|
6366
6365
|
entity: Order;
|
|
6367
6366
|
metadata: EventMetadata;
|
|
6368
6367
|
}
|
|
6369
|
-
|
|
6370
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6371
|
-
* @permissionScope Manage Stores
|
|
6372
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6373
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6374
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6375
|
-
* @permissionScope Read Orders
|
|
6376
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6377
|
-
* @permissionScope Read Stores - all read permissions
|
|
6378
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6379
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6380
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6381
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6382
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6383
|
-
* @permissionScope Manage Orders
|
|
6384
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6385
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6386
|
-
* @webhook
|
|
6387
|
-
* @eventType wix.ecom.v1.order_updated
|
|
6388
|
-
* @slug updated
|
|
6389
|
-
*/
|
|
6390
|
-
export declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
6391
|
-
export interface OrderCanceledEnvelope {
|
|
6368
|
+
interface OrderCanceledEnvelope {
|
|
6392
6369
|
data: OrderCanceledEventOrderCanceled;
|
|
6393
6370
|
metadata: EventMetadata;
|
|
6394
6371
|
}
|
|
6395
|
-
|
|
6396
|
-
* Triggered when an order is canceled.
|
|
6397
|
-
* 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).
|
|
6398
|
-
* @permissionScope Manage Stores - all permissions
|
|
6399
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6400
|
-
* @permissionScope Manage Stores
|
|
6401
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6402
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6403
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6404
|
-
* @permissionScope Read Orders
|
|
6405
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6406
|
-
* @permissionScope Read Stores - all read permissions
|
|
6407
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6408
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6409
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6410
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6411
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6412
|
-
* @permissionScope Manage Orders
|
|
6413
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6414
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6415
|
-
* @webhook
|
|
6416
|
-
* @eventType wix.ecom.v1.order_canceled
|
|
6417
|
-
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
6418
|
-
* @slug canceled
|
|
6419
|
-
*/
|
|
6420
|
-
export declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
6421
|
-
export interface OrderCreatedEnvelope {
|
|
6372
|
+
interface OrderCreatedEnvelope {
|
|
6422
6373
|
entity: Order;
|
|
6423
6374
|
metadata: EventMetadata;
|
|
6424
6375
|
}
|
|
6425
|
-
|
|
6426
|
-
* Triggered when an order is created.
|
|
6427
|
-
* Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
|
|
6428
|
-
* @permissionScope Manage Stores - all permissions
|
|
6429
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6430
|
-
* @permissionScope Manage Stores
|
|
6431
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6432
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6433
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6434
|
-
* @permissionScope Read Orders
|
|
6435
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6436
|
-
* @permissionScope Read Stores - all read permissions
|
|
6437
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6438
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6439
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6440
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6441
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6442
|
-
* @permissionScope Manage Orders
|
|
6443
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6444
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6445
|
-
* @webhook
|
|
6446
|
-
* @eventType wix.ecom.v1.order_created
|
|
6447
|
-
* @serviceIdentifier com.wix.ecom.orders.v1.Orders
|
|
6448
|
-
* @slug created
|
|
6449
|
-
*/
|
|
6450
|
-
export declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
6451
|
-
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}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `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` | `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` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `payAfterFreeTrial.subtotal.amount` | `payAfterFreeTrial.subtotal.formattedAmount`;
|
|
6452
|
-
/**
|
|
6453
|
-
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
6454
|
-
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
6455
|
-
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
6456
|
-
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
6457
|
-
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
6458
|
-
* @param ecomOrderId - Ecom order ID.
|
|
6459
|
-
* @param amount - Amount to collect
|
|
6460
|
-
* @public
|
|
6461
|
-
* @documentationMaturity preview
|
|
6462
|
-
* @requiredField amount
|
|
6463
|
-
* @requiredField ecomOrderId
|
|
6464
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6465
|
-
* @permissionScope Manage Stores - all permissions
|
|
6466
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6467
|
-
* @permissionScope Manage Stores
|
|
6468
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6469
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6470
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6471
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6472
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6473
|
-
* @applicableIdentity APP
|
|
6474
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
6475
|
-
*/
|
|
6476
|
-
export declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`>>;
|
|
6477
|
-
export interface PreparePaymentCollectionOptions {
|
|
6376
|
+
interface PreparePaymentCollectionOptions {
|
|
6478
6377
|
/**
|
|
6479
6378
|
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
6480
6379
|
* Existing payment gateway order will be updated with a new amount.
|
|
@@ -6493,32 +6392,11 @@ export interface PreparePaymentCollectionOptions {
|
|
|
6493
6392
|
/** Delayed capture payment settings */
|
|
6494
6393
|
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
6495
6394
|
}
|
|
6496
|
-
|
|
6497
|
-
* Provides payment collectability status for given order. If payment collection is possible
|
|
6498
|
-
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
6499
|
-
* reason why payment collection is not possible.
|
|
6500
|
-
* @param ecomOrderId - Ecom order ID.
|
|
6501
|
-
* @public
|
|
6502
|
-
* @documentationMaturity preview
|
|
6503
|
-
* @requiredField ecomOrderId
|
|
6504
|
-
* @permissionId ECOM.COLLECT_PAYMENTS
|
|
6505
|
-
* @permissionScope Manage Stores - all permissions
|
|
6506
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6507
|
-
* @permissionScope Manage Stores
|
|
6508
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6509
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6510
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6511
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6512
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6513
|
-
* @applicableIdentity APP
|
|
6514
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
6515
|
-
*/
|
|
6516
|
-
export declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
6517
|
-
export interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6395
|
+
interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6518
6396
|
/** Information about the user who initiated the payment. */
|
|
6519
6397
|
chargedBy?: ChargedBy;
|
|
6520
6398
|
}
|
|
6521
|
-
|
|
6399
|
+
interface ChargeMembershipsOptions {
|
|
6522
6400
|
/**
|
|
6523
6401
|
* List of items to be paid by memberships
|
|
6524
6402
|
* @minSize 1
|
|
@@ -6526,136 +6404,13 @@ export interface ChargeMembershipsOptions {
|
|
|
6526
6404
|
*/
|
|
6527
6405
|
membershipCharges?: MembershipChargeItem[];
|
|
6528
6406
|
}
|
|
6529
|
-
|
|
6407
|
+
interface TriggerRefundOptions {
|
|
6530
6408
|
/** Business model of a refund */
|
|
6531
6409
|
details?: RefundDetails;
|
|
6532
6410
|
/** Side effect details related to refund */
|
|
6533
6411
|
sideEffects?: RefundSideEffects;
|
|
6534
6412
|
}
|
|
6535
|
-
|
|
6536
|
-
* Void authorized payments
|
|
6537
|
-
* Transaction statuses for related payments will be updated in async way
|
|
6538
|
-
* @param ecomOrderId - Wix eCommerce order ID
|
|
6539
|
-
* @param paymentIds - Payment IDs
|
|
6540
|
-
* @public
|
|
6541
|
-
* @documentationMaturity preview
|
|
6542
|
-
* @requiredField ecomOrderId
|
|
6543
|
-
* @requiredField paymentIds
|
|
6544
|
-
* @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
|
|
6545
|
-
* @permissionScope Manage Stores - all permissions
|
|
6546
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6547
|
-
* @permissionScope Manage Stores
|
|
6548
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6549
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6550
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6551
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6552
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6553
|
-
* @permissionScope Manage Orders
|
|
6554
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6555
|
-
* @applicableIdentity APP
|
|
6556
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
6557
|
-
*/
|
|
6558
|
-
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.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}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`>>;
|
|
6559
|
-
/**
|
|
6560
|
-
* Capture authorized payments
|
|
6561
|
-
* Transaction statuses for related payments will be updated in async way
|
|
6562
|
-
* @param ecomOrderId - Wix eCommerce order ID
|
|
6563
|
-
* @param payments - Capture payments information
|
|
6564
|
-
* @public
|
|
6565
|
-
* @documentationMaturity preview
|
|
6566
|
-
* @requiredField ecomOrderId
|
|
6567
|
-
* @requiredField payments
|
|
6568
|
-
* @requiredField payments.paymentId
|
|
6569
|
-
* @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
|
|
6570
|
-
* @permissionScope Manage Stores - all permissions
|
|
6571
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6572
|
-
* @permissionScope Manage Stores
|
|
6573
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6574
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6575
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6576
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6577
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6578
|
-
* @permissionScope Manage Orders
|
|
6579
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6580
|
-
* @applicableIdentity APP
|
|
6581
|
-
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
6582
|
-
*/
|
|
6583
|
-
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.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}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`>>;
|
|
6584
|
-
/**
|
|
6585
|
-
* Retrieves an order.
|
|
6586
|
-
*
|
|
6587
|
-
*
|
|
6588
|
-
* The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.
|
|
6589
|
-
*
|
|
6590
|
-
* 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).
|
|
6591
|
-
* @param _id - ID of the order to retrieve.
|
|
6592
|
-
* @public
|
|
6593
|
-
* @requiredField _id
|
|
6594
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6595
|
-
* @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS
|
|
6596
|
-
* @permissionScope Manage Stores - all permissions
|
|
6597
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6598
|
-
* @permissionScope Manage Stores
|
|
6599
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6600
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6601
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6602
|
-
* @permissionScope Read Orders
|
|
6603
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6604
|
-
* @permissionScope Read Stores - all read permissions
|
|
6605
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6606
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6607
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6608
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6609
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6610
|
-
* @permissionScope Manage Orders
|
|
6611
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6612
|
-
* @applicableIdentity APP
|
|
6613
|
-
* @returns Fulfilled - The requested order.
|
|
6614
|
-
* @fqn com.wix.ecom.orders.v1.Orders.GetOrder
|
|
6615
|
-
*/
|
|
6616
|
-
export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
6617
|
-
/**
|
|
6618
|
-
* Retrieves a list of orders, given the provided paging, filtering, and sorting.
|
|
6619
|
-
*
|
|
6620
|
-
*
|
|
6621
|
-
* Search Orders runs with these defaults, which you can override:
|
|
6622
|
-
*
|
|
6623
|
-
* - `createdDate` is sorted in `DESC` order
|
|
6624
|
-
* - `cursorPaging.limit` is `100`
|
|
6625
|
-
* - `filter: {"status": {"$ne": "INITIALIZED"}}` - other order statuses can be queried, but orders with `status: "INITIALIZED"` are never returned
|
|
6626
|
-
*
|
|
6627
|
-
* 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).
|
|
6628
|
-
*
|
|
6629
|
-
* To learn about working with _Search_ endpoints, see
|
|
6630
|
-
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
|
|
6631
|
-
* [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
6632
|
-
* @param search - Search options.
|
|
6633
|
-
* @public
|
|
6634
|
-
* @requiredField search
|
|
6635
|
-
* @permissionId ECOM.READ_ORDERS
|
|
6636
|
-
* @permissionScope Manage Stores - all permissions
|
|
6637
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6638
|
-
* @permissionScope Manage Stores
|
|
6639
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6640
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
6641
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
6642
|
-
* @permissionScope Read Orders
|
|
6643
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
6644
|
-
* @permissionScope Read Stores - all read permissions
|
|
6645
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
6646
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6647
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6648
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6649
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6650
|
-
* @permissionScope Manage Orders
|
|
6651
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6652
|
-
* @applicableIdentity APP
|
|
6653
|
-
* @fqn com.wix.ecom.orders.v1.Orders.SearchOrders
|
|
6654
|
-
*/
|
|
6655
|
-
export declare function searchOrders(search: OrderSearch): Promise<NonNullablePaths<SearchOrdersResponse, {
|
|
6656
|
-
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
6657
|
-
}[OrderNonNullablePaths]>>;
|
|
6658
|
-
export interface OrderSearchSpec extends SearchSpec {
|
|
6413
|
+
interface OrderSearchSpec extends SearchSpec {
|
|
6659
6414
|
paging: 'cursor';
|
|
6660
6415
|
wql: [
|
|
6661
6416
|
{
|
|
@@ -6729,8 +6484,8 @@ export interface OrderSearchSpec extends SearchSpec {
|
|
|
6729
6484
|
}
|
|
6730
6485
|
];
|
|
6731
6486
|
}
|
|
6732
|
-
|
|
6733
|
-
|
|
6487
|
+
type CommonSearchWithEntityContext = Search<Order, OrderSearchSpec>;
|
|
6488
|
+
type OrderSearch = {
|
|
6734
6489
|
/**
|
|
6735
6490
|
Cursor paging options.
|
|
6736
6491
|
Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
@@ -6782,100 +6537,11 @@ export type OrderSearch = {
|
|
|
6782
6537
|
order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
|
|
6783
6538
|
}[];
|
|
6784
6539
|
};
|
|
6785
|
-
|
|
6786
|
-
* Creates an order.
|
|
6787
|
-
*
|
|
6788
|
-
*
|
|
6789
|
-
* The `createOrder()` function returns a Promise that resolves when the order is created.
|
|
6790
|
-
*
|
|
6791
|
-
* > **Notes:**
|
|
6792
|
-
* > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.
|
|
6793
|
-
* > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.
|
|
6794
|
-
* @param order - Order info.
|
|
6795
|
-
* @public
|
|
6796
|
-
* @requiredField order
|
|
6797
|
-
* @requiredField order.billingInfo.contactDetails
|
|
6798
|
-
* @requiredField order.channelInfo
|
|
6799
|
-
* @requiredField order.currencyConversionDetails.conversionRate
|
|
6800
|
-
* @requiredField order.currencyConversionDetails.originalCurrency
|
|
6801
|
-
* @requiredField order.lineItems
|
|
6802
|
-
* @requiredField order.lineItems.catalogReference.appId
|
|
6803
|
-
* @requiredField order.lineItems.catalogReference.catalogItemId
|
|
6804
|
-
* @requiredField order.lineItems.itemType
|
|
6805
|
-
* @requiredField order.lineItems.price
|
|
6806
|
-
* @requiredField order.lineItems.productName
|
|
6807
|
-
* @requiredField order.lineItems.productName.original
|
|
6808
|
-
* @requiredField order.lineItems.quantity
|
|
6809
|
-
* @requiredField order.priceSummary
|
|
6810
|
-
* @permissionId ECOM.CREATE_ORDERS
|
|
6811
|
-
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
6812
|
-
* @permissionScope Manage Stores - all permissions
|
|
6813
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6814
|
-
* @permissionScope Manage Stores
|
|
6815
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6816
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6817
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6818
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6819
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6820
|
-
* @permissionScope Manage Orders
|
|
6821
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6822
|
-
* @applicableIdentity APP
|
|
6823
|
-
* @returns Newly created order.
|
|
6824
|
-
* @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
|
|
6825
|
-
*/
|
|
6826
|
-
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>>;
|
|
6827
|
-
export interface CreateOrderOptions {
|
|
6540
|
+
interface CreateOrderOptions {
|
|
6828
6541
|
/** Determine order lifecycle */
|
|
6829
6542
|
settings?: OrderCreationSettings;
|
|
6830
6543
|
}
|
|
6831
|
-
|
|
6832
|
-
* Updates an order.
|
|
6833
|
-
*
|
|
6834
|
-
*
|
|
6835
|
-
* The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.
|
|
6836
|
-
*
|
|
6837
|
-
* Currently, the following fields can be updated:
|
|
6838
|
-
* + `order.buyerInfo.email`
|
|
6839
|
-
* + `order.buyerLanguage`
|
|
6840
|
-
* + `order.weightUnit`
|
|
6841
|
-
* + `order.billingInfo.address`
|
|
6842
|
-
* + `order.billingInfo.contactDetails`
|
|
6843
|
-
* + `order.archived`
|
|
6844
|
-
* + `order.attributionSource`
|
|
6845
|
-
* + `order.seenByAHuman`
|
|
6846
|
-
* + `order.recipientInfo.address`
|
|
6847
|
-
* + `order.recipientInfo.contactDetails`
|
|
6848
|
-
* + `order.shippingInfo.logistics.shippingDestination.address`
|
|
6849
|
-
* + `order.shippingInfo.logistics.shippingDestination.contactDetails`
|
|
6850
|
-
*
|
|
6851
|
-
* To update a field's value, include the new value in the `order` object in the method parameters.
|
|
6852
|
-
* To remove a field's value, pass `null`.
|
|
6853
|
-
*
|
|
6854
|
-
* > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
|
|
6855
|
-
*
|
|
6856
|
-
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
6857
|
-
* @param _id - Order ID.
|
|
6858
|
-
* @public
|
|
6859
|
-
* @requiredField _id
|
|
6860
|
-
* @requiredField order
|
|
6861
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
6862
|
-
* @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
6863
|
-
* @permissionScope Manage Stores - all permissions
|
|
6864
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
6865
|
-
* @permissionScope Manage Stores
|
|
6866
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
6867
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
6868
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
6869
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
6870
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
6871
|
-
* @permissionScope Manage Orders
|
|
6872
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
6873
|
-
* @applicableIdentity APP
|
|
6874
|
-
* @returns Newly created order.
|
|
6875
|
-
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
|
|
6876
|
-
*/
|
|
6877
|
-
export declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
6878
|
-
export interface UpdateOrder {
|
|
6544
|
+
interface UpdateOrder {
|
|
6879
6545
|
/**
|
|
6880
6546
|
* Order ID.
|
|
6881
6547
|
* @format GUID
|
|
@@ -7048,55 +6714,7 @@ export interface UpdateOrder {
|
|
|
7048
6714
|
*/
|
|
7049
6715
|
payAfterFreeTrial?: PriceSummary;
|
|
7050
6716
|
}
|
|
7051
|
-
|
|
7052
|
-
* Updates up to 100 orders.
|
|
7053
|
-
*
|
|
7054
|
-
*
|
|
7055
|
-
* The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
|
|
7056
|
-
*
|
|
7057
|
-
* Currently, the following fields can be updated:
|
|
7058
|
-
* + `order.buyerInfo.email`
|
|
7059
|
-
* + `order.buyerLanguage`
|
|
7060
|
-
* + `order.weightUnit`
|
|
7061
|
-
* + `order.billingInfo.address`
|
|
7062
|
-
* + `order.billingInfo.contactDetails`
|
|
7063
|
-
* + `order.archived`
|
|
7064
|
-
* + `order.attributionSource`
|
|
7065
|
-
* + `order.seenByAHuman`
|
|
7066
|
-
* + `order.recipientInfo.address`
|
|
7067
|
-
* + `order.recipientInfo.contactDetails`
|
|
7068
|
-
* + `order.shippingInfo.logistics.shippingDestination.address`
|
|
7069
|
-
* + `order.shippingInfo.logistics.shippingDestination.contactDetails`
|
|
7070
|
-
*
|
|
7071
|
-
* To update a field's value, include the new value in the `orders.order` object in the method parameters.
|
|
7072
|
-
* To remove a field's value, pass `null`.
|
|
7073
|
-
*
|
|
7074
|
-
* > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
|
|
7075
|
-
*
|
|
7076
|
-
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
7077
|
-
* @param orders - Orders to update.
|
|
7078
|
-
* @public
|
|
7079
|
-
* @requiredField orders
|
|
7080
|
-
* @requiredField orders.order
|
|
7081
|
-
* @requiredField orders.order._id
|
|
7082
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
7083
|
-
* @permissionScope Manage Stores - all permissions
|
|
7084
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7085
|
-
* @permissionScope Manage Stores
|
|
7086
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
7087
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
7088
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7089
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
7090
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
7091
|
-
* @permissionScope Manage Orders
|
|
7092
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7093
|
-
* @applicableIdentity APP
|
|
7094
|
-
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
|
|
7095
|
-
*/
|
|
7096
|
-
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` | {
|
|
7097
|
-
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
7098
|
-
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
7099
|
-
export interface BulkUpdateOrdersOptions {
|
|
6717
|
+
interface BulkUpdateOrdersOptions {
|
|
7100
6718
|
/**
|
|
7101
6719
|
* Whether to return the full order entities.
|
|
7102
6720
|
*
|
|
@@ -7104,7 +6722,7 @@ export interface BulkUpdateOrdersOptions {
|
|
|
7104
6722
|
*/
|
|
7105
6723
|
returnEntity?: boolean;
|
|
7106
6724
|
}
|
|
7107
|
-
|
|
6725
|
+
interface CommitDeltasOptions {
|
|
7108
6726
|
/**
|
|
7109
6727
|
* Draft order Id representing this change.
|
|
7110
6728
|
* Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
|
|
@@ -7121,7 +6739,7 @@ export interface CommitDeltasOptions {
|
|
|
7121
6739
|
*/
|
|
7122
6740
|
reason?: string | null;
|
|
7123
6741
|
}
|
|
7124
|
-
|
|
6742
|
+
interface UpdateOrderLineItemIdentifiers {
|
|
7125
6743
|
/**
|
|
7126
6744
|
* Order ID
|
|
7127
6745
|
* @minLength 1
|
|
@@ -7134,7 +6752,7 @@ export interface UpdateOrderLineItemIdentifiers {
|
|
|
7134
6752
|
*/
|
|
7135
6753
|
lineItemId?: string;
|
|
7136
6754
|
}
|
|
7137
|
-
|
|
6755
|
+
interface UpdateOrderLineItem {
|
|
7138
6756
|
/**
|
|
7139
6757
|
* Line item ID.
|
|
7140
6758
|
* @immutable
|
|
@@ -7251,7 +6869,7 @@ export interface UpdateOrderLineItem {
|
|
|
7251
6869
|
*/
|
|
7252
6870
|
extendedFields?: ExtendedFields;
|
|
7253
6871
|
}
|
|
7254
|
-
|
|
6872
|
+
interface UpdateActivityIdentifiers {
|
|
7255
6873
|
/**
|
|
7256
6874
|
* Order ID.
|
|
7257
6875
|
* @minLength 1
|
|
@@ -7264,7 +6882,7 @@ export interface UpdateActivityIdentifiers {
|
|
|
7264
6882
|
*/
|
|
7265
6883
|
activityId: string;
|
|
7266
6884
|
}
|
|
7267
|
-
|
|
6885
|
+
interface DeleteActivityIdentifiers {
|
|
7268
6886
|
/**
|
|
7269
6887
|
* Order ID.
|
|
7270
6888
|
* @minLength 1
|
|
@@ -7277,32 +6895,7 @@ export interface DeleteActivityIdentifiers {
|
|
|
7277
6895
|
*/
|
|
7278
6896
|
activityId: string;
|
|
7279
6897
|
}
|
|
7280
|
-
|
|
7281
|
-
* Cancels an order.
|
|
7282
|
-
*
|
|
7283
|
-
*
|
|
7284
|
-
* The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
|
|
7285
|
-
* @param _id - Order ID.
|
|
7286
|
-
* @public
|
|
7287
|
-
* @requiredField _id
|
|
7288
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
7289
|
-
* @permissionScope Manage Stores - all permissions
|
|
7290
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7291
|
-
* @permissionScope Manage Stores
|
|
7292
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
7293
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
7294
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7295
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
7296
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
7297
|
-
* @permissionScope Manage Orders
|
|
7298
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7299
|
-
* @applicableIdentity APP
|
|
7300
|
-
* @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
|
|
7301
|
-
*/
|
|
7302
|
-
export declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, {
|
|
7303
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7304
|
-
}[OrderNonNullablePaths]>>;
|
|
7305
|
-
export interface CancelOrderOptions {
|
|
6898
|
+
interface CancelOrderOptions {
|
|
7306
6899
|
/** Whether to send an order canceled email to the buyer. */
|
|
7307
6900
|
sendOrderCanceledEmail?: boolean;
|
|
7308
6901
|
/**
|
|
@@ -7314,7 +6907,7 @@ export interface CancelOrderOptions {
|
|
|
7314
6907
|
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
7315
6908
|
restockAllItems?: boolean;
|
|
7316
6909
|
}
|
|
7317
|
-
|
|
6910
|
+
interface AggregateOrdersOptions {
|
|
7318
6911
|
/** Filter applied to original data */
|
|
7319
6912
|
filter?: Record<string, any> | null;
|
|
7320
6913
|
/** This is an object defining aggregation itself */
|
|
@@ -7330,43 +6923,11 @@ export interface AggregateOrdersOptions {
|
|
|
7330
6923
|
*/
|
|
7331
6924
|
hierarchySeparatorOverride?: string | null;
|
|
7332
6925
|
}
|
|
7333
|
-
|
|
7334
|
-
* Synchronously update tags on multiple orders, by list of order IDs.
|
|
7335
|
-
*
|
|
7336
|
-
* > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
|
|
7337
|
-
* @param orderIds - IDs of orders to update tags for.
|
|
7338
|
-
* @public
|
|
7339
|
-
* @requiredField orderIds
|
|
7340
|
-
* @permissionId ECOM.MODIFY_ORDERS
|
|
7341
|
-
* @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS
|
|
7342
|
-
* @permissionScope Manage Stores - all permissions
|
|
7343
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7344
|
-
* @permissionScope Manage Stores
|
|
7345
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
7346
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
7347
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7348
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
7349
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
7350
|
-
* @permissionScope Manage Orders
|
|
7351
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7352
|
-
* @permissionScope Manage Stores - all permissions
|
|
7353
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
7354
|
-
* @permissionScope Manage Stores
|
|
7355
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
7356
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
7357
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
7358
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
7359
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
7360
|
-
* @permissionScope Manage Orders
|
|
7361
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
7362
|
-
* @applicableIdentity APP
|
|
7363
|
-
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
|
|
7364
|
-
*/
|
|
7365
|
-
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`>>;
|
|
7366
|
-
export interface BulkUpdateOrderTagsOptions {
|
|
6926
|
+
interface BulkUpdateOrderTagsOptions {
|
|
7367
6927
|
/** Tags to be added to orders */
|
|
7368
6928
|
assignTags?: Tags;
|
|
7369
6929
|
/** Tags to be removed from orders */
|
|
7370
6930
|
unassignTags?: Tags;
|
|
7371
6931
|
}
|
|
7372
|
-
|
|
6932
|
+
|
|
6933
|
+
export { ActionType as $, AdjustmentType as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, DurationUnit as E, FulfillmentStatus as F, type GetPaymentCollectabilityStatusResponse as G, PaymentCollectabilityStatus as H, ItemTypeItemType as I, JurisdictionType as J, ManuallyRefundableReason as K, LineItemQuantityChangeType as L, type MaskedOrder as M, NonRefundableReason as N, type Order as O, type Price as P, RestockType as Q, RefundableStatus as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, TransactionStatus as X, AuthorizationCaptureStatus as Y, AuthorizationVoidStatus as Z, Reason as _, type PreparePaymentCollectionOptions as a, type DeliveryLogistics as a$, MembershipPaymentStatus as a0, RefundStatus as a1, WebhookIdentityType as a2, TextDetection as a3, AnimationDetection as a4, PreviewEmailType as a5, State as a6, Namespace as a7, SortOrder as a8, VersioningMode as a9, type DigitalFile as aA, type SubscriptionInfo as aB, type SubscriptionTitle as aC, type SubscriptionDescription as aD, type SubscriptionSettings as aE, type FreeTrialPeriod as aF, type BillingAdjustment as aG, type BillingAdjustmentPriceSummary as aH, type PriceDescription as aI, type LocationAndQuantity as aJ, type TaxableAddress as aK, type TaxableAddressTaxableAddressDataOneOf as aL, type ExtendedFields as aM, type ModifierGroup as aN, type TranslatableString as aO, type ItemModifier as aP, type BuyerInfo as aQ, type BuyerInfoIdOneOf as aR, type CurrencyConversionDetails as aS, type PriceSummary as aT, type AddressWithContact as aU, type Address as aV, type StreetAddress as aW, type AddressLocation as aX, type FullAddressContactDetails as aY, type VatId as aZ, type V1ShippingInformation as a_, OrderApprovalStrategy as aa, DeltaPaymentOptionType as ab, InventoryAction as ac, Placement as ad, SubdivisionType as ae, SourceType as af, CustomFieldGroup as ag, ValueType as ah, DepositType as ai, InvoiceStatus as aj, type OrderLineItem as ak, type ProductName as al, type CatalogReference as am, type DescriptionLine as an, type DescriptionLineValueOneOf as ao, type DescriptionLineDescriptionLineValueOneOf as ap, type DescriptionLineName as aq, type PlainTextValue as ar, type Color as as, type FocalPoint as at, type PhysicalProperties as au, type ItemType as av, type ItemTypeItemTypeDataOneOf as aw, type ItemTaxFullDetails as ax, type LineItemTaxInfo as ay, type LineItemTaxBreakdown as az, type PreparePaymentCollectionResponse as b, type WixReceipt as b$, type DeliveryLogisticsAddressOneOf as b0, type PickupDetails as b1, type PickupAddress as b2, type DeliveryTimeSlot as b3, type ShippingPrice as b4, type ShippingRegion as b5, type TaxSummary as b6, type OrderTaxInfo as b7, type OrderTaxBreakdown as b8, type AppliedDiscount as b9, type TotalPriceChange as bA, type ShippingInformationChange as bB, type ShippingInformation as bC, type SavedPaymentMethod as bD, type AuthorizedPaymentCreated as bE, type AuthorizedPaymentCaptured as bF, type AuthorizedPaymentVoided as bG, type RefundInitiated as bH, type RefundedPayment as bI, type RefundedPaymentKindOneOf as bJ, type RegularPaymentRefund as bK, type GiftCardPaymentRefund as bL, type MembershipPaymentRefund as bM, type PaymentRefunded as bN, type PaymentRefundFailed as bO, type RefundedAsStoreCredit as bP, type PaymentPending as bQ, type PaymentPendingPaymentDetailsOneOf as bR, type RegularPayment as bS, type RegularPaymentPaymentMethodDetailsOneOf as bT, type CreditCardDetails as bU, type PaymentCanceled as bV, type PaymentCanceledPaymentDetailsOneOf as bW, type PaymentDeclined as bX, type PaymentDeclinedPaymentDetailsOneOf as bY, type ReceiptCreated as bZ, type ReceiptCreatedReceiptInfoOneOf as b_, type AppliedDiscountDiscountSourceOneOf as ba, type Coupon as bb, type MerchantDiscount as bc, type MerchantDiscountMerchantDiscountReasonOneOf as bd, type DiscountRule as be, type DiscountRuleName as bf, type LineItemDiscount as bg, type Activity as bh, type ActivityContentOneOf as bi, type CustomActivity as bj, type MerchantComment as bk, type OrderRefunded as bl, type OrderCreatedFromExchange as bm, type NewExchangeOrderCreated as bn, type LineItemExchangeData as bo, type DraftOrderChangesApplied as bp, type OrderChange as bq, type OrderChangeValueOneOf as br, type LineItemChanges as bs, type LineItemQuantityChange as bt, type LineItemPriceChange as bu, type ManagedLineItem as bv, type ManagedDiscount as bw, type TranslatedValue as bx, type LineItemAmount as by, type ManagedAdditionalFee as bz, type PaymentCapture as c, type RegularPaymentDetailsPaymentMethodDetailsOneOf as c$, type ExternalReceipt as c0, type ReceiptSent as c1, type ReceiptSentReceiptInfoOneOf as c2, type CreatedBy as c3, type CreatedByStringOneOf as c4, type ChannelInfo as c5, type CustomField as c6, type BalanceSummary as c7, type Balance as c8, type AdditionalFee as c9, type GetRefundabilityStatusResponse as cA, type Refundability as cB, type RefundabilityAdditionalRefundabilityInfoOneOf as cC, type CreatePaymentGatewayOrderRequest as cD, type ChargedBy as cE, type CreatePaymentGatewayOrderResponse as cF, type ChargeMembershipsRequest as cG, type MembershipChargeItem as cH, type MembershipName as cI, type ServiceProperties as cJ, type ChargeMembershipsResponse as cK, type TriggerRefundRequest as cL, type PaymentRefund as cM, type RefundDetails as cN, type RefundItem as cO, type LineItemRefund as cP, type AdditionalFeeRefund as cQ, type ShippingRefund as cR, type RefundSideEffects as cS, type RestockInfo as cT, type RestockItem as cU, type TriggerRefundResponse as cV, type OrderTransactions as cW, type Payment as cX, type PaymentPaymentDetailsOneOf as cY, type PaymentReceiptInfoOneOf as cZ, type RegularPaymentDetails as c_, type FulfillmentStatusesAggregate as ca, type Tags as cb, type TagList as cc, type Location as cd, type OrderApproved as ce, type OrdersExperiments as cf, type OrderRejectedEventOrderRejected as cg, type OrderItemsRestocked as ch, type V1RestockItem as ci, type PreparePaymentCollectionRequest as cj, type RedirectUrls as ck, type DelayedCaptureSettings as cl, type Duration as cm, type GetPaymentCollectabilityStatusRequest as cn, type RecordManuallyCollectedPaymentRequest as co, type RecordManuallyCollectedPaymentResponse as cp, type MarkOrderAsPaidRequest as cq, type MarkOrderAsPaidResponse as cr, type PaymentStatusUpdated as cs, type BulkMarkOrdersAsPaidRequest as ct, type BulkMarkOrdersAsPaidResponse as cu, type BulkOrderResult as cv, type ItemMetadata as cw, type ApplicationError as cx, type BulkActionMetadata as cy, type GetRefundabilityStatusRequest as cz, type OrderSearch as d, type PreviewCancelRefundEmailRequest as d$, type CreditCardPaymentMethodDetails as d0, type AuthorizationDetails as d1, type AuthorizationCapture as d2, type AuthorizationActionFailureDetails as d3, type AuthorizationVoid as d4, type V1ScheduledAction as d5, type GiftCardPaymentDetails as d6, type MembershipPaymentDetails as d7, type WixReceiptInfo as d8, type ExternalReceiptInfo as d9, type ImageContent as dA, type SendBuyerConfirmationEmailRequest as dB, type SendBuyerConfirmationEmailResponse as dC, type SendBuyerPaymentsReceivedEmailRequest as dD, type SendBuyerPaymentsReceivedEmailResponse as dE, type SendBuyerPickupConfirmationEmailRequest as dF, type SendBuyerPickupConfirmationEmailResponse as dG, type BulkSendBuyerPickupConfirmationEmailsRequest as dH, type BulkSendBuyerPickupConfirmationEmailsResponse as dI, type SendBuyerShippingConfirmationEmailRequest as dJ, type SendBuyerShippingConfirmationEmailResponse as dK, type BulkSendBuyerShippingConfirmationEmailsRequest as dL, type BulkSendBuyerShippingConfirmationEmailsResponse as dM, type SendMerchantOrderReceivedNotificationRequest as dN, type SendMerchantOrderReceivedNotificationResponse as dO, type SendCancelRefundEmailRequest as dP, type SendCancelRefundEmailResponse as dQ, type SendRefundEmailRequest as dR, type SendRefundEmailResponse as dS, type SendMerchantOrderReceivedPushRequest as dT, type SendMerchantOrderReceivedPushResponse as dU, type PreviewEmailByTypeRequest as dV, type PreviewEmailByTypeResponse as dW, type PreviewRefundEmailRequest as dX, type PreviewRefundEmailResponse as dY, type PreviewCancelEmailRequest as dZ, type PreviewCancelEmailResponse as d_, type Refund as da, type RefundTransaction as db, type RefundStatusInfo as dc, type AggregatedRefundSummary as dd, type RefundItemsBreakdown as de, type LineItemRefundSummary as df, type CalculateRefundRequest as dg, type CalculateRefundItemRequest as dh, type CalculateRefundResponse as di, type CalculateRefundItemResponse as dj, type VoidAuthorizedPaymentsRequest as dk, type CaptureAuthorizedPaymentsRequest as dl, type ChargeSavedPaymentMethodRequest as dm, type ChargeSavedPaymentMethodResponse as dn, type DomainEvent as dp, type DomainEventBodyOneOf as dq, type EntityCreatedEvent as dr, type RestoreInfo as ds, type EntityUpdatedEvent as dt, type EntityDeletedEvent as du, type ActionEvent as dv, type Empty as dw, type MessageEnvelope as dx, type IdentificationData as dy, type IdentificationDataIdOneOf as dz, type CreateOrderOptions as e, type GetOrderResponse as e$, type PreviewCancelRefundEmailResponse as e0, type PreviewBuyerPaymentsReceivedEmailRequest as e1, type PreviewBuyerPaymentsReceivedEmailResponse as e2, type PreviewBuyerConfirmationEmailRequest as e3, type PreviewBuyerConfirmationEmailResponse as e4, type PreviewBuyerPickupConfirmationEmailRequest as e5, type PreviewBuyerPickupConfirmationEmailResponse as e6, type PreviewShippingConfirmationEmailRequest as e7, type PreviewShippingConfirmationEmailResponse as e8, type PreviewResendDownloadLinksEmailRequest as e9, type UpsertRefundRequest as eA, type UpsertRefundResponse as eB, type GetOrderOutOfBoxRequest as eC, type GetOrderOutOfBoxResponse as eD, type GetOrderAgcRequest as eE, type GetOrderAgcResponse as eF, type GetOrderWithFilterByLocationRequest as eG, type GetOrderWithFilterByLocationResponse as eH, type UpdateInternalDocumentsEvent as eI, type UpdateInternalDocumentsEventOperationOneOf as eJ, type InternalDocument as eK, type InternalDocumentUpdateOperation as eL, type DeleteByIdsOperation as eM, type DeleteByFilterOperation as eN, type InternalDocumentUpdateByFilterOperation as eO, type InternalUpdateExistingOperation as eP, type VersionedDocumentUpdateOperation as eQ, type VersionedDeleteByIdsOperation as eR, type VersionedDocumentId as eS, type TriggerReindexRequest as eT, type TriggerReindexResponse as eU, type BatchOfTriggerReindexOrderRequest as eV, type DiffmatokyPayload as eW, type ErrorInformation as eX, type ContinueSideEffectsFlowInLegacyData as eY, type IndexingMessage as eZ, type GetOrderRequest as e_, type PreviewResendDownloadLinksEmailResponse as ea, type TriggerReindexOrderRequest as eb, type SnapshotMessage as ec, type GetMetasiteDataRequest as ed, type GetMetasiteDataResponse as ee, type MetaSite as ef, type App as eg, type SeoData as eh, type MetaTag as ei, type HtmlApplication as ej, type ExternalUriMapping as ek, type UserDataResponse as el, type QueryOrdersForMetasiteRequest as em, type InternalQueryOrdersRequest as en, type PlatformQuery as eo, type PlatformQueryPagingMethodOneOf as ep, type Sorting as eq, type PlatformPaging as er, type CursorPaging as es, type QueryOrdersForMetasiteResponse as et, type PlatformPagingMetadata as eu, type Cursors as ev, type GetOrderForMetasiteRequest as ew, type GetOrderForMetasiteResponse as ex, type ListOrderTransactionsForMetasiteRequest as ey, type ListOrderTransactionsForMetasiteResponse as ez, type BulkUpdateOrdersResponse as f, type InternalActivity as f$, type InternalQueryOrdersResponse as f0, type QueryOrderRequest as f1, type QueryOrderResponse as f2, type SearchOrdersRequest as f3, type CursorSearch as f4, type CursorSearchPagingMethodOneOf as f5, type CursorPagingMetadata as f6, type CreateOrderRequest as f7, type OrderCreationSettings as f8, type OrderCreateNotifications as f9, type ArchiveOrderRequest as fA, type ArchiveOrderResponse as fB, type BulkArchiveOrdersRequest as fC, type BulkArchiveOrdersResponse as fD, type BulkArchiveOrdersByFilterRequest as fE, type BulkArchiveOrdersByFilterResponse as fF, type UnArchiveOrderRequest as fG, type UnArchiveOrderResponse as fH, type BulkUnArchiveOrdersRequest as fI, type BulkUnArchiveOrdersResponse as fJ, type BulkUnArchiveOrdersByFilterRequest as fK, type BulkUnArchiveOrdersByFilterResponse as fL, type UpdateBuyerInfoRequest as fM, type BuyerInfoUpdate as fN, type UpdateBuyerInfoResponse as fO, type UpdateBuyerEmailRequest as fP, type UpdateBuyerEmailResponse as fQ, type UpdateOrderShippingAddressRequest as fR, type UpdateOrderShippingAddressResponse as fS, type UpdateBillingContactDetailsRequest as fT, type UpdateBillingContactDetailsResponse as fU, type UpdateOrderLineItemRequest as fV, type UpdateOrderLineItemResponse as fW, type UpdateOrderLineItemsRequest as fX, type MaskedOrderLineItem as fY, type UpdateOrderLineItemsResponse as fZ, type AddInternalActivityRequest as f_, type CreateOrderResponse as fa, type UpdateOrderRequest as fb, type UpdateOrderResponse as fc, type BulkUpdateOrdersRequest as fd, type CommitDeltasRequest as fe, type DraftOrderDiffs as ff, type DraftOrderDiffsShippingUpdateInfoOneOf as fg, type DraftOrderDiffsBuyerUpdateInfoOneOf as fh, type DraftOrderDiffsBillingUpdateInfoOneOf as fi, type DraftOrderDiffsRecipientUpdateInfoOneOf as fj, type V1LineItemDelta as fk, type V1LineItemDeltaDeltaOneOf as fl, type OrderLineItemChangedDetails as fm, type ItemChangedDetails as fn, type AppliedDiscountDelta as fo, type AppliedDiscountDeltaDeltaOneOf as fp, type AdditionalFeeDelta as fq, type AdditionalFeeDeltaDeltaOneOf as fr, type DraftOrderCommitSettings as fs, type InventoryUpdateDetails as ft, type CommitDeltasResponse as fu, type OrderDeltasCommitted as fv, type CommittedDiffs as fw, type CommittedDiffsShippingUpdateInfoOneOf as fx, type LineItemDelta as fy, type LineItemDeltaDeltaOneOf as fz, type CancelOrderOptions as g, type GetShipmentsResponse as g$, type InternalActivityContentOneOf as g0, type OrderPlaced as g1, type OrderPaid as g2, type OrderFulfilled as g3, type OrderNotFulfilled as g4, type OrderCanceled as g5, type DownloadLinkSent as g6, type TrackingNumberAdded as g7, type TrackingNumberEdited as g8, type TrackingLinkAdded as g9, type CancelOrderRequest as gA, type OrderCanceledEventOrderCanceled as gB, type UpdateOrderStatusRequest as gC, type UpdateOrderStatusResponse as gD, type MarkAsFulfilledRequest as gE, type MarkAsFulfilledResponse as gF, type FulfillmentStatusUpdated as gG, type BulkMarkAsFulfilledRequest as gH, type BulkMarkAsFulfilledResponse as gI, type BulkMarkAsFulfilledByFilterRequest as gJ, type BulkMarkAsFulfilledByFilterResponse as gK, type MarkAsUnfulfilledRequest as gL, type MarkAsUnfulfilledResponse as gM, type BulkMarkAsUnfulfilledRequest as gN, type BulkMarkAsUnfulfilledResponse as gO, type BulkMarkAsUnfulfilledByFilterRequest as gP, type BulkMarkAsUnfulfilledByFilterResponse as gQ, type BulkSetBusinessLocationRequest as gR, type BulkSetBusinessLocationResponse as gS, type BulkSetBusinessLocationResult as gT, type V1MarkOrderAsPaidRequest as gU, type V1MarkOrderAsPaidResponse as gV, type V1BulkMarkOrdersAsPaidRequest as gW, type V1BulkMarkOrdersAsPaidResponse as gX, type V1CreatePaymentGatewayOrderRequest as gY, type V1CreatePaymentGatewayOrderResponse as gZ, type GetShipmentsRequest as g_, type ShippingConfirmationEmailSent as ga, type InvoiceAdded as gb, type InvoiceSent as gc, type FulfillerEmailSent as gd, type ShippingAddressEdited as ge, type EmailEdited as gf, type PickupReadyEmailSent as gg, type OrderPartiallyPaid as gh, type OrderPending as gi, type OrderRejected as gj, type AddInternalActivityResponse as gk, type AddActivityRequest as gl, type PublicActivity as gm, type PublicActivityContentOneOf as gn, type AddActivityResponse as go, type AddActivitiesRequest as gp, type AddActivitiesResponse as gq, type UpdateActivityRequest as gr, type UpdateActivityResponse as gs, type DeleteActivityRequest as gt, type DeleteActivityResponse as gu, type UpdateLineItemsDescriptionLinesRequest as gv, type LineItemUpdate as gw, type UpdateLineItemsDescriptionLinesResponse as gx, type MarkOrderAsSeenByHumanRequest as gy, type MarkOrderAsSeenByHumanResponse as gz, type CancelOrderResponse as h, type AggregateOrdersRequest as h0, type AggregateOrdersResponse as h1, type DecrementItemsQuantityRequest as h2, type DecrementData as h3, type DecrementItemsQuantityResponse as h4, type BulkUpdateOrderTagsRequest as h5, type BulkUpdateOrderTagsResult as h6, type Task as h7, type TaskKey as h8, type TaskAction as h9, type ItemizedFee as hA, type Discount as hB, type DiscountOneDiscountTypeOneOf as hC, type CalculatedTaxes as hD, type CalculatedTax as hE, type Payments as hF, type InvoicesPayment as hG, type MetaData as hH, type InvoiceDynamicPriceTotals as hI, type CustomFieldValue as hJ, type Value as hK, type Deposit as hL, type TriggerSideEffectsFromLegacyData as hM, type BaseEventMetadata as hN, type EventMetadata as hO, type PaymentCollectionCreatePaymentGatewayOrderOptions as hP, type ChargeMembershipsOptions as hQ, type TriggerRefundOptions as hR, type OrderSearchSpec as hS, type CommitDeltasOptions as hT, type UpdateOrderLineItemIdentifiers as hU, type UpdateOrderLineItem as hV, type UpdateActivityIdentifiers as hW, type DeleteActivityIdentifiers as hX, type AggregateOrdersOptions as hY, type TaskActionActionOneOf as ha, type Complete as hb, type Cancel as hc, type Reschedule as hd, type InvoiceSentEvent as he, type IdAndVersion as hf, type InvoiceFields as hg, type Customer as hh, type Email as hi, type QuotesAddress as hj, type AddressDescription as hk, type Phone as hl, type Company as hm, type CommonAddress as hn, type CommonAddressStreetOneOf as ho, type Subdivision as hp, type StandardDetails as hq, type InvoiceDates as hr, type LineItems as hs, type LineItem as ht, type BigDecimalWrapper as hu, type LineItemTax as hv, type Source as hw, type LineItemMetaData as hx, type Locale as hy, type TotalPrice as hz, type BulkUpdateOrderTagsOptions as i, type BulkUpdateOrderTagsResponse as j, type OrderApprovedEnvelope as k, type OrderUpdatedEnvelope as l, type OrderCanceledEnvelope as m, type OrderCreatedEnvelope as n, PaymentOptionType as o, SubscriptionFrequency as p, PaymentStatus as q, VatType as r, PickupMethod as s, OrderStatus as t, DiscountType as u, DiscountReason as v, ActivityType as w, AttributionSource as x, ChannelType as y, ScheduledAction as z };
|