@wix/auto_sdk_ecom_checkout 1.0.36 → 1.0.37
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-DEDRvPML.d.mts} +674 -365
- package/build/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-DEDRvPML.d.ts} +674 -365
- package/build/index.d.mts +210 -0
- package/build/index.d.ts +210 -0
- package/build/index.js +2782 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +2708 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-CirtPjnM.d.mts} +803 -364
- package/build/internal/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-CirtPjnM.d.ts} +803 -364
- package/build/internal/index.d.mts +240 -0
- package/build/internal/index.d.ts +240 -0
- package/build/internal/index.js +2782 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +2708 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2606 -0
- package/build/internal/meta.d.ts +2606 -0
- package/build/internal/meta.js +1587 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1544 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2606 -0
- package/build/meta.d.ts +2606 -0
- package/build/meta.js +1587 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1544 -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 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -35
- package/build/cjs/src/ecom-v1-checkout-checkout.context.js +0 -76
- package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -101
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1317
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -182
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js +0 -357
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js +0 -303
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4437
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1587
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +0 -35
- package/build/es/src/ecom-v1-checkout-checkout.context.js +0 -41
- package/build/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -101
- package/build/es/src/ecom-v1-checkout-checkout.http.js +0 -1297
- package/build/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
- package/build/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
- package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -182
- package/build/es/src/ecom-v1-checkout-checkout.public.js +0 -305
- package/build/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.types.js +0 -300
- package/build/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4437
- package/build/es/src/ecom-v1-checkout-checkout.universal.js +0 -1544
- package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -41
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +0 -76
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -101
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1317
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -206
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +0 -357
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +0 -303
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4623
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1587
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +0 -41
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +0 -41
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -101
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +0 -1297
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -206
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +0 -305
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +0 -300
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4623
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +0 -1544
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface Checkout {
|
|
2
2
|
/**
|
|
3
3
|
* Checkout ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
_id?: string | null;
|
|
8
8
|
/**
|
|
9
9
|
* Line items.
|
|
10
10
|
*
|
|
@@ -109,12 +109,12 @@ export interface Checkout {
|
|
|
109
109
|
* Date and time the checkout was created.
|
|
110
110
|
* @readonly
|
|
111
111
|
*/
|
|
112
|
-
|
|
112
|
+
_createdDate?: Date | null;
|
|
113
113
|
/**
|
|
114
114
|
* Date and time the checkout was updated.
|
|
115
115
|
* @readonly
|
|
116
116
|
*/
|
|
117
|
-
|
|
117
|
+
_updatedDate?: Date | null;
|
|
118
118
|
/**
|
|
119
119
|
* Minimal amount to pay in order to place the order.
|
|
120
120
|
* @readonly
|
|
@@ -195,13 +195,13 @@ export interface Checkout {
|
|
|
195
195
|
*/
|
|
196
196
|
paymentCurrency?: string;
|
|
197
197
|
}
|
|
198
|
-
|
|
198
|
+
interface LineItem {
|
|
199
199
|
/**
|
|
200
200
|
* Line item ID.
|
|
201
201
|
* @format GUID
|
|
202
202
|
* @readonly
|
|
203
203
|
*/
|
|
204
|
-
|
|
204
|
+
_id?: string | null;
|
|
205
205
|
/**
|
|
206
206
|
* Item quantity.
|
|
207
207
|
*
|
|
@@ -225,7 +225,7 @@ export interface LineItem {
|
|
|
225
225
|
* URL to the item's page on the site.
|
|
226
226
|
* @readonly
|
|
227
227
|
*/
|
|
228
|
-
url?:
|
|
228
|
+
url?: string;
|
|
229
229
|
/**
|
|
230
230
|
* Item price **after** catalog-defined discount and line item discounts.
|
|
231
231
|
* @readonly
|
|
@@ -275,7 +275,7 @@ export interface LineItem {
|
|
|
275
275
|
* Line item image details.
|
|
276
276
|
* @readonly
|
|
277
277
|
*/
|
|
278
|
-
media?:
|
|
278
|
+
media?: string;
|
|
279
279
|
/**
|
|
280
280
|
* Item availability details.
|
|
281
281
|
* @readonly
|
|
@@ -398,7 +398,7 @@ export interface LineItem {
|
|
|
398
398
|
modifiersTotalPrice?: MultiCurrencyPrice;
|
|
399
399
|
}
|
|
400
400
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
401
|
-
|
|
401
|
+
interface CatalogReference {
|
|
402
402
|
/**
|
|
403
403
|
* ID of the item within the catalog it belongs to.
|
|
404
404
|
* @minLength 1
|
|
@@ -424,7 +424,7 @@ export interface CatalogReference {
|
|
|
424
424
|
*/
|
|
425
425
|
options?: Record<string, any> | null;
|
|
426
426
|
}
|
|
427
|
-
|
|
427
|
+
interface ProductName {
|
|
428
428
|
/**
|
|
429
429
|
* __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).
|
|
430
430
|
*
|
|
@@ -445,13 +445,7 @@ export interface ProductName {
|
|
|
445
445
|
*/
|
|
446
446
|
translated?: string | null;
|
|
447
447
|
}
|
|
448
|
-
|
|
449
|
-
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
450
|
-
relativePath?: string;
|
|
451
|
-
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
452
|
-
url?: string | null;
|
|
453
|
-
}
|
|
454
|
-
export interface MultiCurrencyPrice {
|
|
448
|
+
interface MultiCurrencyPrice {
|
|
455
449
|
/**
|
|
456
450
|
* Amount.
|
|
457
451
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -474,7 +468,7 @@ export interface MultiCurrencyPrice {
|
|
|
474
468
|
*/
|
|
475
469
|
formattedConvertedAmount?: string;
|
|
476
470
|
}
|
|
477
|
-
|
|
471
|
+
interface ItemTaxFullDetails {
|
|
478
472
|
/** Amount for which tax is calculated. */
|
|
479
473
|
taxableAmount?: MultiCurrencyPrice;
|
|
480
474
|
/**
|
|
@@ -491,7 +485,7 @@ export interface ItemTaxFullDetails {
|
|
|
491
485
|
*/
|
|
492
486
|
rateBreakdown?: TaxRateBreakdown[];
|
|
493
487
|
}
|
|
494
|
-
|
|
488
|
+
interface TaxRateBreakdown {
|
|
495
489
|
/**
|
|
496
490
|
* Name of tax against which the calculation was performed.
|
|
497
491
|
* @maxLength 100
|
|
@@ -509,7 +503,7 @@ export interface TaxRateBreakdown {
|
|
|
509
503
|
* TaxBreakdown represents tax information for a line item.
|
|
510
504
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
511
505
|
*/
|
|
512
|
-
|
|
506
|
+
interface TaxBreakdown {
|
|
513
507
|
/**
|
|
514
508
|
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
515
509
|
* @maxLength 200
|
|
@@ -541,7 +535,7 @@ export interface TaxBreakdown {
|
|
|
541
535
|
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
542
536
|
}
|
|
543
537
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
544
|
-
|
|
538
|
+
declare enum JurisdictionType {
|
|
545
539
|
UNDEFINED = "UNDEFINED",
|
|
546
540
|
COUNTRY = "COUNTRY",
|
|
547
541
|
STATE = "STATE",
|
|
@@ -550,8 +544,8 @@ export declare enum JurisdictionType {
|
|
|
550
544
|
SPECIAL = "SPECIAL"
|
|
551
545
|
}
|
|
552
546
|
/** @enumType */
|
|
553
|
-
|
|
554
|
-
|
|
547
|
+
type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
548
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
555
549
|
/** Description line plain text value. */
|
|
556
550
|
plainText?: PlainTextValue;
|
|
557
551
|
/** Description line color value. */
|
|
@@ -560,16 +554,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
560
554
|
name?: DescriptionLineName;
|
|
561
555
|
}
|
|
562
556
|
/** @oneof */
|
|
563
|
-
|
|
557
|
+
interface DescriptionLineValueOneOf {
|
|
564
558
|
/** Description line plain text value. */
|
|
565
559
|
plainText?: PlainTextValue;
|
|
566
560
|
/** Description line color value. */
|
|
567
561
|
colorInfo?: Color;
|
|
568
562
|
}
|
|
569
563
|
/** @oneof */
|
|
570
|
-
|
|
564
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
571
565
|
}
|
|
572
|
-
|
|
566
|
+
interface DescriptionLineName {
|
|
573
567
|
/**
|
|
574
568
|
* 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).
|
|
575
569
|
* @maxLength 100
|
|
@@ -583,7 +577,7 @@ export interface DescriptionLineName {
|
|
|
583
577
|
*/
|
|
584
578
|
translated?: string | null;
|
|
585
579
|
}
|
|
586
|
-
|
|
580
|
+
interface PlainTextValue {
|
|
587
581
|
/**
|
|
588
582
|
* 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).
|
|
589
583
|
* @maxLength 600
|
|
@@ -597,7 +591,7 @@ export interface PlainTextValue {
|
|
|
597
591
|
*/
|
|
598
592
|
translated?: string | null;
|
|
599
593
|
}
|
|
600
|
-
|
|
594
|
+
interface Color {
|
|
601
595
|
/**
|
|
602
596
|
* 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).
|
|
603
597
|
* @maxLength 500
|
|
@@ -613,7 +607,7 @@ export interface Color {
|
|
|
613
607
|
/** HEX or RGB color code for display. */
|
|
614
608
|
code?: string | null;
|
|
615
609
|
}
|
|
616
|
-
|
|
610
|
+
declare enum DescriptionLineType {
|
|
617
611
|
/** Unrecognized type. */
|
|
618
612
|
UNRECOGNISED = "UNRECOGNISED",
|
|
619
613
|
/** Plain text type. */
|
|
@@ -621,32 +615,7 @@ export declare enum DescriptionLineType {
|
|
|
621
615
|
/** Color type. */
|
|
622
616
|
COLOR = "COLOR"
|
|
623
617
|
}
|
|
624
|
-
|
|
625
|
-
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
626
|
-
export interface CommonImage {
|
|
627
|
-
/** WixMedia image ID. */
|
|
628
|
-
id?: string;
|
|
629
|
-
/** Image URL. */
|
|
630
|
-
url?: string;
|
|
631
|
-
/**
|
|
632
|
-
* Original image height.
|
|
633
|
-
* @readonly
|
|
634
|
-
*/
|
|
635
|
-
height?: number;
|
|
636
|
-
/**
|
|
637
|
-
* Original image width.
|
|
638
|
-
* @readonly
|
|
639
|
-
*/
|
|
640
|
-
width?: number;
|
|
641
|
-
/** Image alt text. */
|
|
642
|
-
altText?: string | null;
|
|
643
|
-
/**
|
|
644
|
-
* Image filename.
|
|
645
|
-
* @readonly
|
|
646
|
-
*/
|
|
647
|
-
filename?: string | null;
|
|
648
|
-
}
|
|
649
|
-
export interface FocalPoint {
|
|
618
|
+
interface FocalPoint {
|
|
650
619
|
/** X-coordinate of the focal point. */
|
|
651
620
|
x?: number;
|
|
652
621
|
/** Y-coordinate of the focal point. */
|
|
@@ -656,13 +625,13 @@ export interface FocalPoint {
|
|
|
656
625
|
/** crop by width */
|
|
657
626
|
width?: number | null;
|
|
658
627
|
}
|
|
659
|
-
|
|
628
|
+
interface ItemAvailabilityInfo {
|
|
660
629
|
/** Item availability status. */
|
|
661
630
|
status?: ItemAvailabilityStatusWithLiterals;
|
|
662
631
|
/** Quantity available. */
|
|
663
632
|
quantityAvailable?: number | null;
|
|
664
633
|
}
|
|
665
|
-
|
|
634
|
+
declare enum ItemAvailabilityStatus {
|
|
666
635
|
AVAILABLE = "AVAILABLE",
|
|
667
636
|
/** Item does not exist. */
|
|
668
637
|
NOT_FOUND = "NOT_FOUND",
|
|
@@ -672,8 +641,8 @@ export declare enum ItemAvailabilityStatus {
|
|
|
672
641
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
673
642
|
}
|
|
674
643
|
/** @enumType */
|
|
675
|
-
|
|
676
|
-
|
|
644
|
+
type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
|
|
645
|
+
interface PhysicalProperties {
|
|
677
646
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
678
647
|
weight?: number | null;
|
|
679
648
|
/**
|
|
@@ -684,32 +653,32 @@ export interface PhysicalProperties {
|
|
|
684
653
|
/** Whether this line item is shippable. */
|
|
685
654
|
shippable?: boolean;
|
|
686
655
|
}
|
|
687
|
-
|
|
656
|
+
interface Scope {
|
|
688
657
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
689
658
|
namespace?: string;
|
|
690
659
|
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
691
660
|
group?: Group;
|
|
692
661
|
}
|
|
693
|
-
|
|
662
|
+
interface Group {
|
|
694
663
|
/** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
|
|
695
664
|
name?: string;
|
|
696
665
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
697
666
|
entityId?: string | null;
|
|
698
667
|
}
|
|
699
|
-
|
|
668
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
700
669
|
/** Preset item type. */
|
|
701
670
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
702
671
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
703
672
|
custom?: string;
|
|
704
673
|
}
|
|
705
674
|
/** @oneof */
|
|
706
|
-
|
|
675
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
707
676
|
/** Preset item type. */
|
|
708
677
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
709
678
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
710
679
|
custom?: string;
|
|
711
680
|
}
|
|
712
|
-
|
|
681
|
+
declare enum ItemTypeItemType {
|
|
713
682
|
UNRECOGNISED = "UNRECOGNISED",
|
|
714
683
|
PHYSICAL = "PHYSICAL",
|
|
715
684
|
DIGITAL = "DIGITAL",
|
|
@@ -717,8 +686,8 @@ export declare enum ItemTypeItemType {
|
|
|
717
686
|
SERVICE = "SERVICE"
|
|
718
687
|
}
|
|
719
688
|
/** @enumType */
|
|
720
|
-
|
|
721
|
-
|
|
689
|
+
type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
690
|
+
interface SubscriptionOptionInfo {
|
|
722
691
|
/** Subscription option settings. */
|
|
723
692
|
subscriptionSettings?: SubscriptionSettings;
|
|
724
693
|
/** Subscription option title. */
|
|
@@ -726,7 +695,7 @@ export interface SubscriptionOptionInfo {
|
|
|
726
695
|
/** Subscription option description. */
|
|
727
696
|
description?: Description;
|
|
728
697
|
}
|
|
729
|
-
|
|
698
|
+
interface SubscriptionSettings {
|
|
730
699
|
/** Frequency of recurring payment. */
|
|
731
700
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
732
701
|
/**
|
|
@@ -754,7 +723,7 @@ export interface SubscriptionSettings {
|
|
|
754
723
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
755
724
|
}
|
|
756
725
|
/** Frequency unit of recurring payment */
|
|
757
|
-
|
|
726
|
+
declare enum SubscriptionFrequency {
|
|
758
727
|
UNDEFINED = "UNDEFINED",
|
|
759
728
|
DAY = "DAY",
|
|
760
729
|
WEEK = "WEEK",
|
|
@@ -762,8 +731,8 @@ export declare enum SubscriptionFrequency {
|
|
|
762
731
|
YEAR = "YEAR"
|
|
763
732
|
}
|
|
764
733
|
/** @enumType */
|
|
765
|
-
|
|
766
|
-
|
|
734
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
735
|
+
interface FreeTrialPeriod {
|
|
767
736
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
768
737
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
769
738
|
/**
|
|
@@ -773,7 +742,7 @@ export interface FreeTrialPeriod {
|
|
|
773
742
|
*/
|
|
774
743
|
interval?: number;
|
|
775
744
|
}
|
|
776
|
-
|
|
745
|
+
interface Title {
|
|
777
746
|
/**
|
|
778
747
|
* 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).
|
|
779
748
|
* @minLength 1
|
|
@@ -789,7 +758,7 @@ export interface Title {
|
|
|
789
758
|
*/
|
|
790
759
|
translated?: string | null;
|
|
791
760
|
}
|
|
792
|
-
|
|
761
|
+
interface Description {
|
|
793
762
|
/**
|
|
794
763
|
* Subscription option description.
|
|
795
764
|
* @maxLength 500
|
|
@@ -801,13 +770,13 @@ export interface Description {
|
|
|
801
770
|
*/
|
|
802
771
|
translated?: string | null;
|
|
803
772
|
}
|
|
804
|
-
|
|
773
|
+
interface SecuredMedia {
|
|
805
774
|
/**
|
|
806
775
|
* Media ID in Wix Media Manager.
|
|
807
776
|
* @minLength 1
|
|
808
777
|
* @maxLength 100
|
|
809
778
|
*/
|
|
810
|
-
|
|
779
|
+
_id?: string;
|
|
811
780
|
/**
|
|
812
781
|
* Original filename.
|
|
813
782
|
* @minLength 1
|
|
@@ -817,7 +786,7 @@ export interface SecuredMedia {
|
|
|
817
786
|
/** File type. */
|
|
818
787
|
fileType?: FileTypeWithLiterals;
|
|
819
788
|
}
|
|
820
|
-
|
|
789
|
+
declare enum FileType {
|
|
821
790
|
UNSPECIFIED = "UNSPECIFIED",
|
|
822
791
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
823
792
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -826,9 +795,9 @@ export declare enum FileType {
|
|
|
826
795
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
827
796
|
}
|
|
828
797
|
/** @enumType */
|
|
829
|
-
|
|
798
|
+
type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
830
799
|
/** Type of selected payment option for catalog item */
|
|
831
|
-
|
|
800
|
+
declare enum PaymentOptionType {
|
|
832
801
|
/** The entire payment for this item happens as part of the checkout. */
|
|
833
802
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
834
803
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -841,8 +810,8 @@ export declare enum PaymentOptionType {
|
|
|
841
810
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
842
811
|
}
|
|
843
812
|
/** @enumType */
|
|
844
|
-
|
|
845
|
-
|
|
813
|
+
type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
814
|
+
interface ServiceProperties {
|
|
846
815
|
/**
|
|
847
816
|
* 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.
|
|
848
817
|
* For example, the start time of a class.
|
|
@@ -855,7 +824,7 @@ export interface ServiceProperties {
|
|
|
855
824
|
*/
|
|
856
825
|
numberOfParticipants?: number | null;
|
|
857
826
|
}
|
|
858
|
-
|
|
827
|
+
interface PriceDescription {
|
|
859
828
|
/**
|
|
860
829
|
* __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).
|
|
861
830
|
* @minLength 1
|
|
@@ -871,7 +840,7 @@ export interface PriceDescription {
|
|
|
871
840
|
*/
|
|
872
841
|
translated?: string | null;
|
|
873
842
|
}
|
|
874
|
-
|
|
843
|
+
interface CatalogOverrideFields {
|
|
875
844
|
/** Item name. */
|
|
876
845
|
productName?: ProductName;
|
|
877
846
|
/**
|
|
@@ -892,7 +861,7 @@ export interface CatalogOverrideFields {
|
|
|
892
861
|
/** Physical properties of the item. */
|
|
893
862
|
physicalProperties?: PhysicalProperties;
|
|
894
863
|
/** Item image. */
|
|
895
|
-
image?:
|
|
864
|
+
image?: string;
|
|
896
865
|
/** Payment method selected for the item. */
|
|
897
866
|
paymentOption?: PaymentOption;
|
|
898
867
|
/**
|
|
@@ -908,19 +877,7 @@ export interface CatalogOverrideFields {
|
|
|
908
877
|
*/
|
|
909
878
|
savePaymentMethod?: boolean | null;
|
|
910
879
|
}
|
|
911
|
-
|
|
912
|
-
/** WixMedia image ID. */
|
|
913
|
-
id?: string;
|
|
914
|
-
/** Original image height. */
|
|
915
|
-
height?: number;
|
|
916
|
-
/** Original image width. */
|
|
917
|
-
width?: number;
|
|
918
|
-
/** Image alt text. Optional. */
|
|
919
|
-
altText?: string | null;
|
|
920
|
-
/** Image filename. Optional. */
|
|
921
|
-
filename?: string | null;
|
|
922
|
-
}
|
|
923
|
-
export interface PaymentOption {
|
|
880
|
+
interface PaymentOption {
|
|
924
881
|
/**
|
|
925
882
|
* Type of selected payment option for current item.
|
|
926
883
|
*
|
|
@@ -928,24 +885,24 @@ export interface PaymentOption {
|
|
|
928
885
|
*/
|
|
929
886
|
value?: PaymentOptionTypeWithLiterals;
|
|
930
887
|
}
|
|
931
|
-
|
|
888
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
932
889
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
933
890
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
934
891
|
}
|
|
935
892
|
/** @oneof */
|
|
936
|
-
|
|
893
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
937
894
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
938
895
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
939
896
|
}
|
|
940
|
-
|
|
897
|
+
declare enum TaxableAddressType {
|
|
941
898
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
942
899
|
BUSINESS = "BUSINESS",
|
|
943
900
|
BILLING = "BILLING",
|
|
944
901
|
SHIPPING = "SHIPPING"
|
|
945
902
|
}
|
|
946
903
|
/** @enumType */
|
|
947
|
-
|
|
948
|
-
|
|
904
|
+
type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
905
|
+
interface ExtendedFields {
|
|
949
906
|
/**
|
|
950
907
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
951
908
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -956,7 +913,7 @@ export interface ExtendedFields {
|
|
|
956
913
|
*/
|
|
957
914
|
namespaces?: Record<string, Record<string, any>>;
|
|
958
915
|
}
|
|
959
|
-
|
|
916
|
+
interface Policy {
|
|
960
917
|
/**
|
|
961
918
|
* Policy title - should be translated
|
|
962
919
|
* @minLength 1
|
|
@@ -970,13 +927,13 @@ export interface Policy {
|
|
|
970
927
|
*/
|
|
971
928
|
content?: string;
|
|
972
929
|
}
|
|
973
|
-
|
|
930
|
+
interface ModifierGroup {
|
|
974
931
|
/**
|
|
975
932
|
* Modifier group id.
|
|
976
933
|
* @minLength 1
|
|
977
934
|
* @maxLength 36
|
|
978
935
|
*/
|
|
979
|
-
|
|
936
|
+
_id?: string;
|
|
980
937
|
/** Modifier group name. */
|
|
981
938
|
name?: TranslatableString;
|
|
982
939
|
/**
|
|
@@ -986,7 +943,7 @@ export interface ModifierGroup {
|
|
|
986
943
|
*/
|
|
987
944
|
modifiers?: ItemModifier[];
|
|
988
945
|
}
|
|
989
|
-
|
|
946
|
+
interface TranslatableString {
|
|
990
947
|
/**
|
|
991
948
|
* __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).
|
|
992
949
|
*
|
|
@@ -1007,13 +964,13 @@ export interface TranslatableString {
|
|
|
1007
964
|
*/
|
|
1008
965
|
translated?: string | null;
|
|
1009
966
|
}
|
|
1010
|
-
|
|
967
|
+
interface ItemModifier {
|
|
1011
968
|
/**
|
|
1012
969
|
* Modifier ID.
|
|
1013
970
|
* @minLength 1
|
|
1014
971
|
* @maxLength 36
|
|
1015
972
|
*/
|
|
1016
|
-
|
|
973
|
+
_id?: string;
|
|
1017
974
|
/**
|
|
1018
975
|
* The quantity of this modifier.
|
|
1019
976
|
* @min 1
|
|
@@ -1028,14 +985,14 @@ export interface ItemModifier {
|
|
|
1028
985
|
price?: MultiCurrencyPrice;
|
|
1029
986
|
}
|
|
1030
987
|
/** Billing Info and shipping details */
|
|
1031
|
-
|
|
988
|
+
interface AddressWithContact {
|
|
1032
989
|
/** Address. */
|
|
1033
990
|
address?: ApiAddress;
|
|
1034
991
|
/** Contact details. */
|
|
1035
992
|
contactDetails?: FullAddressContactDetails;
|
|
1036
993
|
}
|
|
1037
994
|
/** Physical address */
|
|
1038
|
-
|
|
995
|
+
interface ApiAddress {
|
|
1039
996
|
/**
|
|
1040
997
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1041
998
|
* @format COUNTRY
|
|
@@ -1062,7 +1019,7 @@ export interface ApiAddress {
|
|
|
1062
1019
|
* Main address line (usually street name and number).
|
|
1063
1020
|
* @maxLength 150
|
|
1064
1021
|
*/
|
|
1065
|
-
|
|
1022
|
+
addressLine1?: string | null;
|
|
1066
1023
|
/**
|
|
1067
1024
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
1068
1025
|
* @maxLength 100
|
|
@@ -1079,20 +1036,20 @@ export interface ApiAddress {
|
|
|
1079
1036
|
*/
|
|
1080
1037
|
subdivisionFullname?: string | null;
|
|
1081
1038
|
}
|
|
1082
|
-
|
|
1039
|
+
interface StreetAddress {
|
|
1083
1040
|
/** Street number. */
|
|
1084
1041
|
number?: string;
|
|
1085
1042
|
/** Street name. */
|
|
1086
1043
|
name?: string;
|
|
1087
1044
|
}
|
|
1088
|
-
|
|
1045
|
+
interface AddressLocation {
|
|
1089
1046
|
/** Address latitude. */
|
|
1090
1047
|
latitude?: number | null;
|
|
1091
1048
|
/** Address longitude. */
|
|
1092
1049
|
longitude?: number | null;
|
|
1093
1050
|
}
|
|
1094
1051
|
/** Full contact details for an address */
|
|
1095
|
-
|
|
1052
|
+
interface FullAddressContactDetails {
|
|
1096
1053
|
/**
|
|
1097
1054
|
* First name.
|
|
1098
1055
|
* @maxLength 100
|
|
@@ -1116,9 +1073,9 @@ export interface FullAddressContactDetails {
|
|
|
1116
1073
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1117
1074
|
vatId?: CommonVatId;
|
|
1118
1075
|
}
|
|
1119
|
-
|
|
1076
|
+
interface CommonVatId {
|
|
1120
1077
|
/** Customer's tax ID. */
|
|
1121
|
-
|
|
1078
|
+
_id?: string;
|
|
1122
1079
|
/**
|
|
1123
1080
|
* Tax type.
|
|
1124
1081
|
*
|
|
@@ -1129,7 +1086,7 @@ export interface CommonVatId {
|
|
|
1129
1086
|
type?: CommonVatTypeWithLiterals;
|
|
1130
1087
|
}
|
|
1131
1088
|
/** tax info types */
|
|
1132
|
-
|
|
1089
|
+
declare enum CommonVatType {
|
|
1133
1090
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1134
1091
|
/** CPF - for individual tax payers. */
|
|
1135
1092
|
CPF = "CPF",
|
|
@@ -1137,8 +1094,8 @@ export declare enum CommonVatType {
|
|
|
1137
1094
|
CNPJ = "CNPJ"
|
|
1138
1095
|
}
|
|
1139
1096
|
/** @enumType */
|
|
1140
|
-
|
|
1141
|
-
|
|
1097
|
+
type CommonVatTypeWithLiterals = CommonVatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1098
|
+
interface ShippingInfo {
|
|
1142
1099
|
/** Shipping address and contact details. */
|
|
1143
1100
|
shippingDestination?: AddressWithContact;
|
|
1144
1101
|
/** Selected option out of the options allowed for the `region`. */
|
|
@@ -1154,7 +1111,7 @@ export interface ShippingInfo {
|
|
|
1154
1111
|
*/
|
|
1155
1112
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
1156
1113
|
}
|
|
1157
|
-
|
|
1114
|
+
interface SelectedCarrierServiceOption {
|
|
1158
1115
|
/**
|
|
1159
1116
|
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1160
1117
|
* @maxLength 100
|
|
@@ -1202,7 +1159,7 @@ export interface SelectedCarrierServiceOption {
|
|
|
1202
1159
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1203
1160
|
partial?: boolean | null;
|
|
1204
1161
|
}
|
|
1205
|
-
|
|
1162
|
+
interface DeliveryLogistics {
|
|
1206
1163
|
/**
|
|
1207
1164
|
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1208
1165
|
* @maxLength 500
|
|
@@ -1216,7 +1173,7 @@ export interface DeliveryLogistics {
|
|
|
1216
1173
|
/** Pickup details. */
|
|
1217
1174
|
pickupDetails?: PickupDetails;
|
|
1218
1175
|
}
|
|
1219
|
-
|
|
1176
|
+
interface PickupDetails {
|
|
1220
1177
|
/** Pickup address. */
|
|
1221
1178
|
address?: ApiAddress;
|
|
1222
1179
|
/**
|
|
@@ -1227,20 +1184,20 @@ export interface PickupDetails {
|
|
|
1227
1184
|
/** Pickup method */
|
|
1228
1185
|
pickupMethod?: PickupMethodWithLiterals;
|
|
1229
1186
|
}
|
|
1230
|
-
|
|
1187
|
+
declare enum PickupMethod {
|
|
1231
1188
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1232
1189
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1233
1190
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1234
1191
|
}
|
|
1235
1192
|
/** @enumType */
|
|
1236
|
-
|
|
1237
|
-
|
|
1193
|
+
type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1194
|
+
interface DeliveryTimeSlot {
|
|
1238
1195
|
/** starting time of the delivery time slot */
|
|
1239
1196
|
from?: Date | null;
|
|
1240
1197
|
/** ending time of the delivery time slot */
|
|
1241
1198
|
to?: Date | null;
|
|
1242
1199
|
}
|
|
1243
|
-
|
|
1200
|
+
interface SelectedCarrierServiceOptionPrices {
|
|
1244
1201
|
/** Total shipping price, after discount and after tax. */
|
|
1245
1202
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1246
1203
|
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
@@ -1252,7 +1209,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1252
1209
|
/** Shipping price before discount and before tax. */
|
|
1253
1210
|
price?: MultiCurrencyPrice;
|
|
1254
1211
|
}
|
|
1255
|
-
|
|
1212
|
+
interface SelectedCarrierServiceOptionOtherCharge {
|
|
1256
1213
|
/** Type of additional cost. */
|
|
1257
1214
|
type?: ChargeTypeWithLiterals;
|
|
1258
1215
|
/**
|
|
@@ -1263,13 +1220,13 @@ export interface SelectedCarrierServiceOptionOtherCharge {
|
|
|
1263
1220
|
/** Price of added charge. */
|
|
1264
1221
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
1265
1222
|
}
|
|
1266
|
-
|
|
1223
|
+
declare enum ChargeType {
|
|
1267
1224
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1268
1225
|
INSURANCE = "INSURANCE"
|
|
1269
1226
|
}
|
|
1270
1227
|
/** @enumType */
|
|
1271
|
-
|
|
1272
|
-
|
|
1228
|
+
type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
|
|
1229
|
+
interface DeliveryAllocation {
|
|
1273
1230
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1274
1231
|
deliveryCarrier?: Carrier;
|
|
1275
1232
|
/** The delivery region that are relevant for this delivery solution. */
|
|
@@ -1277,7 +1234,7 @@ export interface DeliveryAllocation {
|
|
|
1277
1234
|
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
1278
1235
|
applicableLineItems?: ApplicableLineItems;
|
|
1279
1236
|
}
|
|
1280
|
-
|
|
1237
|
+
interface Carrier {
|
|
1281
1238
|
/**
|
|
1282
1239
|
* The carrier app id
|
|
1283
1240
|
* @format GUID
|
|
@@ -1289,19 +1246,19 @@ export interface Carrier {
|
|
|
1289
1246
|
*/
|
|
1290
1247
|
code?: string;
|
|
1291
1248
|
}
|
|
1292
|
-
|
|
1249
|
+
interface Region {
|
|
1293
1250
|
/**
|
|
1294
1251
|
* The delivery region id.
|
|
1295
1252
|
* @format GUID
|
|
1296
1253
|
*/
|
|
1297
|
-
|
|
1254
|
+
_id?: string | null;
|
|
1298
1255
|
/**
|
|
1299
1256
|
* The delivery region name.
|
|
1300
1257
|
* @maxLength 100
|
|
1301
1258
|
*/
|
|
1302
1259
|
name?: string | null;
|
|
1303
1260
|
}
|
|
1304
|
-
|
|
1261
|
+
interface ApplicableLineItems {
|
|
1305
1262
|
/**
|
|
1306
1263
|
* Line items that the delivery solution is for.
|
|
1307
1264
|
* @maxSize 300
|
|
@@ -1310,20 +1267,20 @@ export interface ApplicableLineItems {
|
|
|
1310
1267
|
*/
|
|
1311
1268
|
lineItemIds?: string[];
|
|
1312
1269
|
}
|
|
1313
|
-
|
|
1270
|
+
interface ShippingRegion {
|
|
1314
1271
|
/**
|
|
1315
1272
|
* Shipping region ID.
|
|
1316
1273
|
* @format GUID
|
|
1317
1274
|
* @readonly
|
|
1318
1275
|
*/
|
|
1319
|
-
|
|
1276
|
+
_id?: string;
|
|
1320
1277
|
/**
|
|
1321
1278
|
* Shipping region name.
|
|
1322
1279
|
* @maxLength 100
|
|
1323
1280
|
*/
|
|
1324
1281
|
name?: string;
|
|
1325
1282
|
}
|
|
1326
|
-
|
|
1283
|
+
interface CarrierServiceOption {
|
|
1327
1284
|
/**
|
|
1328
1285
|
* Carrier ID.
|
|
1329
1286
|
* @format GUID
|
|
@@ -1332,7 +1289,7 @@ export interface CarrierServiceOption {
|
|
|
1332
1289
|
/** Shipping options offered by this carrier for this request. */
|
|
1333
1290
|
shippingOptions?: ShippingOption[];
|
|
1334
1291
|
}
|
|
1335
|
-
|
|
1292
|
+
interface ShippingOption {
|
|
1336
1293
|
/**
|
|
1337
1294
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1338
1295
|
* For legacy calculators this would be the UUID of the option.
|
|
@@ -1357,13 +1314,13 @@ export interface ShippingOption {
|
|
|
1357
1314
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1358
1315
|
partial?: boolean | null;
|
|
1359
1316
|
}
|
|
1360
|
-
|
|
1317
|
+
interface ShippingPrice {
|
|
1361
1318
|
/** Shipping price. */
|
|
1362
1319
|
price?: MultiCurrencyPrice;
|
|
1363
1320
|
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
1364
1321
|
otherCharges?: OtherCharge[];
|
|
1365
1322
|
}
|
|
1366
|
-
|
|
1323
|
+
interface OtherCharge {
|
|
1367
1324
|
/** Type of additional cost. */
|
|
1368
1325
|
type?: ChargeTypeWithLiterals;
|
|
1369
1326
|
/** Price of added cost. */
|
|
@@ -1374,7 +1331,7 @@ export interface OtherCharge {
|
|
|
1374
1331
|
*/
|
|
1375
1332
|
details?: string | null;
|
|
1376
1333
|
}
|
|
1377
|
-
|
|
1334
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1378
1335
|
/**
|
|
1379
1336
|
* Visitor ID (if site visitor is **not** a member).
|
|
1380
1337
|
* @format GUID
|
|
@@ -1400,7 +1357,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1400
1357
|
email?: string | null;
|
|
1401
1358
|
}
|
|
1402
1359
|
/** @oneof */
|
|
1403
|
-
|
|
1360
|
+
interface BuyerInfoIdOneOf {
|
|
1404
1361
|
/**
|
|
1405
1362
|
* Visitor ID (if site visitor is **not** a member).
|
|
1406
1363
|
* @format GUID
|
|
@@ -1414,7 +1371,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
1414
1371
|
*/
|
|
1415
1372
|
memberId?: string;
|
|
1416
1373
|
}
|
|
1417
|
-
|
|
1374
|
+
interface PriceSummary {
|
|
1418
1375
|
/** Subtotal of all line items, before discounts and before tax. */
|
|
1419
1376
|
subtotal?: MultiCurrencyPrice;
|
|
1420
1377
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1428,7 +1385,7 @@ export interface PriceSummary {
|
|
|
1428
1385
|
/** Total additional fees price before tax. */
|
|
1429
1386
|
additionalFees?: MultiCurrencyPrice;
|
|
1430
1387
|
}
|
|
1431
|
-
|
|
1388
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1432
1389
|
/** General shipping calculation error. */
|
|
1433
1390
|
generalShippingCalculationError?: Details;
|
|
1434
1391
|
/** Carrier errors. */
|
|
@@ -1450,13 +1407,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
1450
1407
|
discountsCalculationError?: Details;
|
|
1451
1408
|
}
|
|
1452
1409
|
/** @oneof */
|
|
1453
|
-
|
|
1410
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1454
1411
|
/** General shipping calculation error. */
|
|
1455
1412
|
generalShippingCalculationError?: Details;
|
|
1456
1413
|
/** Carrier errors. */
|
|
1457
1414
|
carrierErrors?: CarrierErrors;
|
|
1458
1415
|
}
|
|
1459
|
-
|
|
1416
|
+
interface Details extends DetailsKindOneOf {
|
|
1460
1417
|
applicationError?: ApplicationError;
|
|
1461
1418
|
validationError?: ValidationError;
|
|
1462
1419
|
systemError?: SystemError;
|
|
@@ -1467,12 +1424,12 @@ export interface Details extends DetailsKindOneOf {
|
|
|
1467
1424
|
tracing?: Record<string, string>;
|
|
1468
1425
|
}
|
|
1469
1426
|
/** @oneof */
|
|
1470
|
-
|
|
1427
|
+
interface DetailsKindOneOf {
|
|
1471
1428
|
applicationError?: ApplicationError;
|
|
1472
1429
|
validationError?: ValidationError;
|
|
1473
1430
|
systemError?: SystemError;
|
|
1474
1431
|
}
|
|
1475
|
-
|
|
1432
|
+
interface ApplicationError {
|
|
1476
1433
|
/** Error code. */
|
|
1477
1434
|
code?: string;
|
|
1478
1435
|
/** Description of the error. */
|
|
@@ -1512,10 +1469,10 @@ export interface ApplicationError {
|
|
|
1512
1469
|
* ]
|
|
1513
1470
|
* }
|
|
1514
1471
|
*/
|
|
1515
|
-
|
|
1472
|
+
interface ValidationError {
|
|
1516
1473
|
fieldViolations?: FieldViolation[];
|
|
1517
1474
|
}
|
|
1518
|
-
|
|
1475
|
+
declare enum RuleType {
|
|
1519
1476
|
VALIDATION = "VALIDATION",
|
|
1520
1477
|
OTHER = "OTHER",
|
|
1521
1478
|
MAX = "MAX",
|
|
@@ -1539,8 +1496,8 @@ export declare enum RuleType {
|
|
|
1539
1496
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1540
1497
|
}
|
|
1541
1498
|
/** @enumType */
|
|
1542
|
-
|
|
1543
|
-
|
|
1499
|
+
type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
|
|
1500
|
+
interface FieldViolation {
|
|
1544
1501
|
field?: string;
|
|
1545
1502
|
description?: string;
|
|
1546
1503
|
violatedRule?: RuleTypeWithLiterals;
|
|
@@ -1548,26 +1505,26 @@ export interface FieldViolation {
|
|
|
1548
1505
|
ruleName?: string | null;
|
|
1549
1506
|
data?: Record<string, any> | null;
|
|
1550
1507
|
}
|
|
1551
|
-
|
|
1508
|
+
interface SystemError {
|
|
1552
1509
|
/** Error code. */
|
|
1553
1510
|
errorCode?: string | null;
|
|
1554
1511
|
}
|
|
1555
|
-
|
|
1512
|
+
interface CarrierErrors {
|
|
1556
1513
|
/** Carrier errors. */
|
|
1557
1514
|
errors?: CarrierError[];
|
|
1558
1515
|
}
|
|
1559
|
-
|
|
1516
|
+
interface CarrierError {
|
|
1560
1517
|
/** Carrier ID. */
|
|
1561
1518
|
carrierId?: string;
|
|
1562
1519
|
/** Error details. */
|
|
1563
1520
|
error?: Details;
|
|
1564
1521
|
}
|
|
1565
|
-
|
|
1522
|
+
interface GiftCard {
|
|
1566
1523
|
/**
|
|
1567
1524
|
* Gift Card ID.
|
|
1568
1525
|
* @deprecated
|
|
1569
1526
|
*/
|
|
1570
|
-
|
|
1527
|
+
_id?: string;
|
|
1571
1528
|
/** Gift card obfuscated code. */
|
|
1572
1529
|
obfuscatedCode?: string;
|
|
1573
1530
|
/** Gift card value. */
|
|
@@ -1585,7 +1542,7 @@ export interface GiftCard {
|
|
|
1585
1542
|
*/
|
|
1586
1543
|
externalId?: string | null;
|
|
1587
1544
|
}
|
|
1588
|
-
|
|
1545
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1589
1546
|
/** Coupon details. */
|
|
1590
1547
|
coupon?: Coupon;
|
|
1591
1548
|
/** Merchant discount. */
|
|
@@ -1604,7 +1561,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1604
1561
|
lineItemIds?: string[];
|
|
1605
1562
|
}
|
|
1606
1563
|
/** @oneof */
|
|
1607
|
-
|
|
1564
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1608
1565
|
/** Coupon details. */
|
|
1609
1566
|
coupon?: Coupon;
|
|
1610
1567
|
/** Merchant discount. */
|
|
@@ -1612,17 +1569,17 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1612
1569
|
/** Discount rule */
|
|
1613
1570
|
discountRule?: DiscountRule;
|
|
1614
1571
|
}
|
|
1615
|
-
|
|
1572
|
+
declare enum DiscountType {
|
|
1616
1573
|
GLOBAL = "GLOBAL",
|
|
1617
1574
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1618
1575
|
SHIPPING = "SHIPPING"
|
|
1619
1576
|
}
|
|
1620
1577
|
/** @enumType */
|
|
1621
|
-
|
|
1578
|
+
type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1622
1579
|
/** Coupon */
|
|
1623
|
-
|
|
1580
|
+
interface Coupon {
|
|
1624
1581
|
/** Coupon ID. */
|
|
1625
|
-
|
|
1582
|
+
_id?: string;
|
|
1626
1583
|
/** Coupon code. */
|
|
1627
1584
|
code?: string;
|
|
1628
1585
|
/** Coupon value. */
|
|
@@ -1630,7 +1587,7 @@ export interface Coupon {
|
|
|
1630
1587
|
/** Coupon name. */
|
|
1631
1588
|
name?: string;
|
|
1632
1589
|
}
|
|
1633
|
-
|
|
1590
|
+
interface MerchantDiscount {
|
|
1634
1591
|
/** Discount value. */
|
|
1635
1592
|
amount?: MultiCurrencyPrice;
|
|
1636
1593
|
/**
|
|
@@ -1640,18 +1597,18 @@ export interface MerchantDiscount {
|
|
|
1640
1597
|
*/
|
|
1641
1598
|
percentage?: number | null;
|
|
1642
1599
|
}
|
|
1643
|
-
|
|
1600
|
+
interface DiscountRule {
|
|
1644
1601
|
/**
|
|
1645
1602
|
* Discount rule ID
|
|
1646
1603
|
* @format GUID
|
|
1647
1604
|
*/
|
|
1648
|
-
|
|
1605
|
+
_id?: string;
|
|
1649
1606
|
/** Discount rule name */
|
|
1650
1607
|
name?: DiscountRuleName;
|
|
1651
1608
|
/** Discount value. */
|
|
1652
1609
|
amount?: MultiCurrencyPrice;
|
|
1653
1610
|
}
|
|
1654
|
-
|
|
1611
|
+
interface DiscountRuleName {
|
|
1655
1612
|
/**
|
|
1656
1613
|
* Original discount rule name (in site's default language).
|
|
1657
1614
|
* @minLength 1
|
|
@@ -1665,16 +1622,16 @@ export interface DiscountRuleName {
|
|
|
1665
1622
|
*/
|
|
1666
1623
|
translated?: string | null;
|
|
1667
1624
|
}
|
|
1668
|
-
|
|
1625
|
+
interface LineItemDiscount {
|
|
1669
1626
|
/**
|
|
1670
1627
|
* ID of line item the discount applies to.
|
|
1671
1628
|
* @format GUID
|
|
1672
1629
|
*/
|
|
1673
|
-
|
|
1630
|
+
_id?: string;
|
|
1674
1631
|
/** Discount value. */
|
|
1675
1632
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
1676
1633
|
}
|
|
1677
|
-
|
|
1634
|
+
interface CustomField {
|
|
1678
1635
|
/** Custom field value. */
|
|
1679
1636
|
value?: any;
|
|
1680
1637
|
/**
|
|
@@ -1690,7 +1647,7 @@ export interface CustomField {
|
|
|
1690
1647
|
*/
|
|
1691
1648
|
translatedTitle?: string | null;
|
|
1692
1649
|
}
|
|
1693
|
-
|
|
1650
|
+
declare enum WeightUnit {
|
|
1694
1651
|
/** Weight unit can't be classified due to an error. */
|
|
1695
1652
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1696
1653
|
/** Kilograms. */
|
|
@@ -1699,8 +1656,8 @@ export declare enum WeightUnit {
|
|
|
1699
1656
|
LB = "LB"
|
|
1700
1657
|
}
|
|
1701
1658
|
/** @enumType */
|
|
1702
|
-
|
|
1703
|
-
|
|
1659
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1660
|
+
interface TaxSummary {
|
|
1704
1661
|
/**
|
|
1705
1662
|
* Amount for which tax is calculated, added from line items.
|
|
1706
1663
|
* @readonly
|
|
@@ -1717,7 +1674,7 @@ export interface TaxSummary {
|
|
|
1717
1674
|
*/
|
|
1718
1675
|
calculationDetails?: TaxCalculationDetails;
|
|
1719
1676
|
}
|
|
1720
|
-
|
|
1677
|
+
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1721
1678
|
/** Reason the manual calculation was used. */
|
|
1722
1679
|
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1723
1680
|
/** Details of the fallback rate calculation. */
|
|
@@ -1726,13 +1683,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
|
|
|
1726
1683
|
rateType?: RateTypeWithLiterals;
|
|
1727
1684
|
}
|
|
1728
1685
|
/** @oneof */
|
|
1729
|
-
|
|
1686
|
+
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1730
1687
|
/** Reason the manual calculation was used. */
|
|
1731
1688
|
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1732
1689
|
/** Details of the fallback rate calculation. */
|
|
1733
1690
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1734
1691
|
}
|
|
1735
|
-
|
|
1692
|
+
declare enum RateType {
|
|
1736
1693
|
/** no tax being collected for this request due to location of purchase */
|
|
1737
1694
|
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
1738
1695
|
/** manual rate used for calculation */
|
|
@@ -1743,34 +1700,34 @@ export declare enum RateType {
|
|
|
1743
1700
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1744
1701
|
}
|
|
1745
1702
|
/** @enumType */
|
|
1746
|
-
|
|
1747
|
-
|
|
1703
|
+
type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
|
|
1704
|
+
declare enum ManualCalculationReason {
|
|
1748
1705
|
/** user set calculator in Business Manager to be Manual */
|
|
1749
1706
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1750
1707
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1751
1708
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1752
1709
|
}
|
|
1753
1710
|
/** @enumType */
|
|
1754
|
-
|
|
1755
|
-
|
|
1711
|
+
type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
|
|
1712
|
+
interface AutoTaxFallbackCalculationDetails {
|
|
1756
1713
|
/** reason for fallback */
|
|
1757
1714
|
fallbackReason?: FallbackReasonWithLiterals;
|
|
1758
1715
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1759
1716
|
error?: ApplicationError;
|
|
1760
1717
|
}
|
|
1761
|
-
|
|
1718
|
+
declare enum FallbackReason {
|
|
1762
1719
|
/** auto-tax failed to be calculated */
|
|
1763
1720
|
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
1764
1721
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
1765
1722
|
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
1766
1723
|
}
|
|
1767
1724
|
/** @enumType */
|
|
1768
|
-
|
|
1725
|
+
type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
|
|
1769
1726
|
/**
|
|
1770
1727
|
* 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.
|
|
1771
1728
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1772
1729
|
*/
|
|
1773
|
-
|
|
1730
|
+
interface AggregatedTaxBreakdown {
|
|
1774
1731
|
/**
|
|
1775
1732
|
* The name of the tax against which this tax amount was calculated.
|
|
1776
1733
|
* @maxLength 200
|
|
@@ -1796,7 +1753,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
1796
1753
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1797
1754
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
1798
1755
|
}
|
|
1799
|
-
|
|
1756
|
+
declare enum ChannelType {
|
|
1800
1757
|
/** Unspecified sales channel. This value is not supported. */
|
|
1801
1758
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1802
1759
|
/** A web client. */
|
|
@@ -1831,8 +1788,8 @@ export declare enum ChannelType {
|
|
|
1831
1788
|
FAIRE_COM = "FAIRE_COM"
|
|
1832
1789
|
}
|
|
1833
1790
|
/** @enumType */
|
|
1834
|
-
|
|
1835
|
-
|
|
1791
|
+
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';
|
|
1792
|
+
interface CreatedBy extends CreatedByIdOneOf {
|
|
1836
1793
|
/**
|
|
1837
1794
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1838
1795
|
* For example, via POS (point of service).
|
|
@@ -1856,7 +1813,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
|
|
|
1856
1813
|
appId?: string;
|
|
1857
1814
|
}
|
|
1858
1815
|
/** @oneof */
|
|
1859
|
-
|
|
1816
|
+
interface CreatedByIdOneOf {
|
|
1860
1817
|
/**
|
|
1861
1818
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1862
1819
|
* For example, via POS (point of service).
|
|
@@ -1880,7 +1837,7 @@ export interface CreatedByIdOneOf {
|
|
|
1880
1837
|
appId?: string;
|
|
1881
1838
|
}
|
|
1882
1839
|
/** Reserved for internal use. */
|
|
1883
|
-
|
|
1840
|
+
interface MembershipOptions {
|
|
1884
1841
|
/**
|
|
1885
1842
|
* Reserved for internal use.
|
|
1886
1843
|
* @readonly
|
|
@@ -1896,13 +1853,13 @@ export interface MembershipOptions {
|
|
|
1896
1853
|
/** Selected membership to apply to this checkout. */
|
|
1897
1854
|
selectedMemberships?: SelectedMemberships;
|
|
1898
1855
|
}
|
|
1899
|
-
|
|
1856
|
+
interface Membership {
|
|
1900
1857
|
/**
|
|
1901
1858
|
* Membership ID.
|
|
1902
1859
|
* @minLength 1
|
|
1903
1860
|
* @maxLength 100
|
|
1904
1861
|
*/
|
|
1905
|
-
|
|
1862
|
+
_id?: string;
|
|
1906
1863
|
/**
|
|
1907
1864
|
* ID of the application providing this payment option.
|
|
1908
1865
|
* @format GUID
|
|
@@ -1925,7 +1882,7 @@ export interface Membership {
|
|
|
1925
1882
|
/** Additional data about this membership. */
|
|
1926
1883
|
additionalData?: Record<string, any> | null;
|
|
1927
1884
|
}
|
|
1928
|
-
|
|
1885
|
+
interface MembershipName {
|
|
1929
1886
|
/**
|
|
1930
1887
|
* Membership name.
|
|
1931
1888
|
* @maxLength 100
|
|
@@ -1937,7 +1894,7 @@ export interface MembershipName {
|
|
|
1937
1894
|
*/
|
|
1938
1895
|
translated?: string | null;
|
|
1939
1896
|
}
|
|
1940
|
-
|
|
1897
|
+
interface MembershipPaymentCredits {
|
|
1941
1898
|
/**
|
|
1942
1899
|
* Membership's total amount of credits.
|
|
1943
1900
|
* @min 1
|
|
@@ -1946,7 +1903,7 @@ export interface MembershipPaymentCredits {
|
|
|
1946
1903
|
/** Membership's remaining amount of credits. */
|
|
1947
1904
|
remaining?: number;
|
|
1948
1905
|
}
|
|
1949
|
-
|
|
1906
|
+
interface InvalidMembership {
|
|
1950
1907
|
/** Membership details. */
|
|
1951
1908
|
membership?: Membership;
|
|
1952
1909
|
/**
|
|
@@ -1956,20 +1913,20 @@ export interface InvalidMembership {
|
|
|
1956
1913
|
*/
|
|
1957
1914
|
reason?: string;
|
|
1958
1915
|
}
|
|
1959
|
-
|
|
1916
|
+
interface SelectedMemberships {
|
|
1960
1917
|
/**
|
|
1961
1918
|
* Selected memberships.
|
|
1962
1919
|
* @maxSize 300
|
|
1963
1920
|
*/
|
|
1964
1921
|
memberships?: SelectedMembership[];
|
|
1965
1922
|
}
|
|
1966
|
-
|
|
1923
|
+
interface SelectedMembership {
|
|
1967
1924
|
/**
|
|
1968
1925
|
* Membership ID.
|
|
1969
1926
|
* @minLength 1
|
|
1970
1927
|
* @maxLength 100
|
|
1971
1928
|
*/
|
|
1972
|
-
|
|
1929
|
+
_id?: string;
|
|
1973
1930
|
/**
|
|
1974
1931
|
* ID of the app providing this payment option.
|
|
1975
1932
|
* @format GUID
|
|
@@ -1984,7 +1941,7 @@ export interface SelectedMembership {
|
|
|
1984
1941
|
*/
|
|
1985
1942
|
lineItemIds?: string[];
|
|
1986
1943
|
}
|
|
1987
|
-
|
|
1944
|
+
interface AdditionalFee {
|
|
1988
1945
|
/**
|
|
1989
1946
|
* Additional fee's unique code (or ID) for future processing.
|
|
1990
1947
|
* @minLength 1
|
|
@@ -2020,7 +1977,7 @@ export interface AdditionalFee {
|
|
|
2020
1977
|
/** the source the additional fee was added from */
|
|
2021
1978
|
source?: AdditionalFeeSourceWithLiterals;
|
|
2022
1979
|
}
|
|
2023
|
-
|
|
1980
|
+
declare enum AdditionalFeeSource {
|
|
2024
1981
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
2025
1982
|
/** The additional fee was added by an additional fee service plugin */
|
|
2026
1983
|
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
@@ -2032,8 +1989,8 @@ export declare enum AdditionalFeeSource {
|
|
|
2032
1989
|
SHIPPING = "SHIPPING"
|
|
2033
1990
|
}
|
|
2034
1991
|
/** @enumType */
|
|
2035
|
-
|
|
2036
|
-
|
|
1992
|
+
type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
|
|
1993
|
+
interface ConversionInfo {
|
|
2037
1994
|
/**
|
|
2038
1995
|
* The site currency.
|
|
2039
1996
|
* @readonly
|
|
@@ -2047,7 +2004,7 @@ export interface ConversionInfo {
|
|
|
2047
2004
|
*/
|
|
2048
2005
|
conversionRate?: string;
|
|
2049
2006
|
}
|
|
2050
|
-
|
|
2007
|
+
interface Violation {
|
|
2051
2008
|
/** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
|
|
2052
2009
|
severity?: SeverityWithLiterals;
|
|
2053
2010
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
@@ -2059,7 +2016,7 @@ export interface Violation {
|
|
|
2059
2016
|
*/
|
|
2060
2017
|
description?: string | null;
|
|
2061
2018
|
}
|
|
2062
|
-
|
|
2019
|
+
declare enum Severity {
|
|
2063
2020
|
/** The user is allowed to move forward in the flow. */
|
|
2064
2021
|
WARNING = "WARNING",
|
|
2065
2022
|
/**
|
|
@@ -2069,55 +2026,53 @@ export declare enum Severity {
|
|
|
2069
2026
|
ERROR = "ERROR"
|
|
2070
2027
|
}
|
|
2071
2028
|
/** @enumType */
|
|
2072
|
-
|
|
2073
|
-
|
|
2029
|
+
type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
|
|
2030
|
+
interface Target extends TargetTargetTypeOneOf {
|
|
2074
2031
|
/** General (other) violation. */
|
|
2075
2032
|
other?: Other;
|
|
2076
2033
|
/** Specific line item violation. */
|
|
2077
2034
|
lineItem?: TargetLineItem;
|
|
2078
2035
|
}
|
|
2079
2036
|
/** @oneof */
|
|
2080
|
-
|
|
2037
|
+
interface TargetTargetTypeOneOf {
|
|
2081
2038
|
/** General (other) violation. */
|
|
2082
2039
|
other?: Other;
|
|
2083
2040
|
/** Specific line item violation. */
|
|
2084
2041
|
lineItem?: TargetLineItem;
|
|
2085
2042
|
}
|
|
2086
2043
|
/** Available locations on the webpage */
|
|
2087
|
-
|
|
2044
|
+
declare enum NameInOther {
|
|
2088
2045
|
/** Default location, in case no specific location is specified. */
|
|
2089
2046
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
2090
2047
|
}
|
|
2091
2048
|
/** @enumType */
|
|
2092
|
-
|
|
2049
|
+
type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
|
|
2093
2050
|
/** Available locations on the line item */
|
|
2094
|
-
|
|
2051
|
+
declare enum NameInLineItem {
|
|
2095
2052
|
/** Default location, in case no specific location is specified. */
|
|
2096
2053
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
2097
2054
|
}
|
|
2098
2055
|
/** @enumType */
|
|
2099
|
-
|
|
2100
|
-
|
|
2056
|
+
type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
|
|
2057
|
+
declare enum SuggestedFix {
|
|
2101
2058
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
2102
2059
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
2103
2060
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
2104
2061
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
2105
2062
|
}
|
|
2106
|
-
/** @enumType */
|
|
2107
|
-
export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
|
|
2108
2063
|
/** General (other) violation. */
|
|
2109
|
-
|
|
2064
|
+
interface Other {
|
|
2110
2065
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
2111
2066
|
name?: NameInOtherWithLiterals;
|
|
2112
2067
|
}
|
|
2113
2068
|
/** Specific line item violation. */
|
|
2114
|
-
|
|
2069
|
+
interface TargetLineItem {
|
|
2115
2070
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
2116
2071
|
name?: NameInLineItemWithLiterals;
|
|
2117
2072
|
/** ID of the line item containing the violation. */
|
|
2118
|
-
|
|
2073
|
+
_id?: string | null;
|
|
2119
2074
|
}
|
|
2120
|
-
|
|
2075
|
+
interface CustomSettings {
|
|
2121
2076
|
/**
|
|
2122
2077
|
* Whether to restrict the option to add or remove a gift card on the checkout page.
|
|
2123
2078
|
*
|
|
@@ -2143,7 +2098,7 @@ export interface CustomSettings {
|
|
|
2143
2098
|
*/
|
|
2144
2099
|
disabledManualPayment?: boolean;
|
|
2145
2100
|
}
|
|
2146
|
-
|
|
2101
|
+
interface CustomContentReference {
|
|
2147
2102
|
/**
|
|
2148
2103
|
* ID of the app providing the content.
|
|
2149
2104
|
*
|
|
@@ -2159,7 +2114,7 @@ export interface CustomContentReference {
|
|
|
2159
2114
|
*/
|
|
2160
2115
|
componentId?: string;
|
|
2161
2116
|
}
|
|
2162
|
-
|
|
2117
|
+
interface ExternalReference {
|
|
2163
2118
|
/**
|
|
2164
2119
|
* ID of the app associated with the purchase flow.
|
|
2165
2120
|
* For example, the Wix Pay Links app ID.
|
|
@@ -2176,7 +2131,7 @@ export interface ExternalReference {
|
|
|
2176
2131
|
*/
|
|
2177
2132
|
resourceId?: string | null;
|
|
2178
2133
|
}
|
|
2179
|
-
|
|
2134
|
+
interface SubscriptionCharges {
|
|
2180
2135
|
/**
|
|
2181
2136
|
* ids of the items the subscription is defined on
|
|
2182
2137
|
* @format GUID
|
|
@@ -2196,7 +2151,7 @@ export interface SubscriptionCharges {
|
|
|
2196
2151
|
*/
|
|
2197
2152
|
charges?: Charge[];
|
|
2198
2153
|
}
|
|
2199
|
-
|
|
2154
|
+
interface Charge {
|
|
2200
2155
|
/** The cycle number from which the charge starts. */
|
|
2201
2156
|
cycleFrom?: number;
|
|
2202
2157
|
/** The number of cycles for which the charge is applicable. */
|
|
@@ -2206,13 +2161,13 @@ export interface Charge {
|
|
|
2206
2161
|
/** The billing date from which the charge starts. */
|
|
2207
2162
|
cycleBillingDate?: Date | null;
|
|
2208
2163
|
}
|
|
2209
|
-
|
|
2164
|
+
interface UpdatedCheckoutMessage {
|
|
2210
2165
|
/** Previous checkout. */
|
|
2211
2166
|
oldCheckout?: Checkout;
|
|
2212
2167
|
/** Updated checkout. */
|
|
2213
2168
|
updatedCheckout?: Checkout;
|
|
2214
2169
|
}
|
|
2215
|
-
|
|
2170
|
+
interface CreateCheckoutRequest {
|
|
2216
2171
|
/** Checkout information. */
|
|
2217
2172
|
checkoutInfo?: Checkout;
|
|
2218
2173
|
/** Coupon code. */
|
|
@@ -2250,7 +2205,7 @@ export interface CreateCheckoutRequest {
|
|
|
2250
2205
|
*/
|
|
2251
2206
|
overrideCheckoutUrl?: string | null;
|
|
2252
2207
|
}
|
|
2253
|
-
|
|
2208
|
+
interface CustomLineItem {
|
|
2254
2209
|
/**
|
|
2255
2210
|
* Custom line item quantity.
|
|
2256
2211
|
*
|
|
@@ -2261,9 +2216,7 @@ export interface CustomLineItem {
|
|
|
2261
2216
|
*/
|
|
2262
2217
|
quantity?: number;
|
|
2263
2218
|
/**
|
|
2264
|
-
* Custom line item price.
|
|
2265
|
-
*
|
|
2266
|
-
* Must be a number or a decimal without symbols.
|
|
2219
|
+
* Custom line item price. For security reasons, the `price` field should come from backend code, and not be passed from the frontend.
|
|
2267
2220
|
* @format DECIMAL_VALUE
|
|
2268
2221
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
2269
2222
|
*/
|
|
@@ -2275,15 +2228,19 @@ export interface CustomLineItem {
|
|
|
2275
2228
|
* @maxSize 10
|
|
2276
2229
|
*/
|
|
2277
2230
|
descriptionLines?: DescriptionLine[];
|
|
2278
|
-
/**
|
|
2279
|
-
|
|
2231
|
+
/**
|
|
2232
|
+
* Custom line item media.
|
|
2233
|
+
* + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
|
|
2234
|
+
* + An image from the web - `"http(s)://<image url>"`.
|
|
2235
|
+
*/
|
|
2236
|
+
media?: string;
|
|
2280
2237
|
/**
|
|
2281
2238
|
* Custom line item ID. If passed, `id` must be unique.
|
|
2282
2239
|
*
|
|
2283
2240
|
* Default: auto-generated ID
|
|
2284
2241
|
* @format GUID
|
|
2285
2242
|
*/
|
|
2286
|
-
|
|
2243
|
+
_id?: string | null;
|
|
2287
2244
|
/**
|
|
2288
2245
|
* Tax group ID for this custom line item.
|
|
2289
2246
|
* @format GUID
|
|
@@ -2292,7 +2249,7 @@ export interface CustomLineItem {
|
|
|
2292
2249
|
/** Name of the item or product. */
|
|
2293
2250
|
productName?: ProductName;
|
|
2294
2251
|
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
2295
|
-
url?:
|
|
2252
|
+
url?: string;
|
|
2296
2253
|
/** Item type. Either a preset type or custom. */
|
|
2297
2254
|
itemType?: ItemType;
|
|
2298
2255
|
/**
|
|
@@ -2380,13 +2337,13 @@ export interface CustomLineItem {
|
|
|
2380
2337
|
*/
|
|
2381
2338
|
modifierGroups?: V1ModifierGroup[];
|
|
2382
2339
|
}
|
|
2383
|
-
|
|
2340
|
+
interface V1ModifierGroup {
|
|
2384
2341
|
/**
|
|
2385
2342
|
* Modifier group id.
|
|
2386
2343
|
* @minLength 1
|
|
2387
2344
|
* @maxLength 36
|
|
2388
2345
|
*/
|
|
2389
|
-
|
|
2346
|
+
_id?: string;
|
|
2390
2347
|
/** Modifier group name. */
|
|
2391
2348
|
name?: TranslatableString;
|
|
2392
2349
|
/**
|
|
@@ -2396,13 +2353,13 @@ export interface V1ModifierGroup {
|
|
|
2396
2353
|
*/
|
|
2397
2354
|
modifiers?: V1ItemModifier[];
|
|
2398
2355
|
}
|
|
2399
|
-
|
|
2356
|
+
interface V1ItemModifier {
|
|
2400
2357
|
/**
|
|
2401
2358
|
* Modifier ID.
|
|
2402
2359
|
* @minLength 1
|
|
2403
2360
|
* @maxLength 36
|
|
2404
2361
|
*/
|
|
2405
|
-
|
|
2362
|
+
_id?: string;
|
|
2406
2363
|
/**
|
|
2407
2364
|
* The quantity of this modifier.
|
|
2408
2365
|
* @min 1
|
|
@@ -2419,7 +2376,7 @@ export interface V1ItemModifier {
|
|
|
2419
2376
|
*/
|
|
2420
2377
|
price?: string | null;
|
|
2421
2378
|
}
|
|
2422
|
-
|
|
2379
|
+
interface MerchantDiscountInput {
|
|
2423
2380
|
/**
|
|
2424
2381
|
* Discount amount.
|
|
2425
2382
|
* @decimalValue options { gte:0 }
|
|
@@ -2432,75 +2389,75 @@ export interface MerchantDiscountInput {
|
|
|
2432
2389
|
*/
|
|
2433
2390
|
lineItemIds?: string[];
|
|
2434
2391
|
}
|
|
2435
|
-
|
|
2392
|
+
interface CreateCheckoutResponse {
|
|
2436
2393
|
/** Newly created checkout. */
|
|
2437
2394
|
checkout?: Checkout;
|
|
2438
2395
|
}
|
|
2439
|
-
|
|
2396
|
+
interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2440
2397
|
generalShippingCalculationError?: Details;
|
|
2441
2398
|
carrierErrors?: CarrierErrors;
|
|
2442
2399
|
}
|
|
2443
2400
|
/** @oneof */
|
|
2444
|
-
|
|
2401
|
+
interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2445
2402
|
generalShippingCalculationError?: Details;
|
|
2446
2403
|
carrierErrors?: CarrierErrors;
|
|
2447
2404
|
}
|
|
2448
|
-
|
|
2405
|
+
interface GetCheckoutRequest {
|
|
2449
2406
|
/**
|
|
2450
2407
|
* Checkout ID.
|
|
2451
2408
|
* @format GUID
|
|
2452
2409
|
*/
|
|
2453
|
-
|
|
2410
|
+
_id: string;
|
|
2454
2411
|
}
|
|
2455
|
-
|
|
2412
|
+
interface GetCheckoutResponse {
|
|
2456
2413
|
/** Retrieved checkout. */
|
|
2457
2414
|
checkout?: Checkout;
|
|
2458
2415
|
}
|
|
2459
|
-
|
|
2416
|
+
interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
2460
2417
|
/**
|
|
2461
2418
|
* Checkout ID.
|
|
2462
2419
|
* @format GUID
|
|
2463
2420
|
*/
|
|
2464
|
-
|
|
2421
|
+
_id?: string;
|
|
2465
2422
|
}
|
|
2466
|
-
|
|
2423
|
+
interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2467
2424
|
/** Retrieved checkout. */
|
|
2468
2425
|
checkout?: Checkout;
|
|
2469
2426
|
}
|
|
2470
|
-
|
|
2427
|
+
interface GetCheckoutByCartIdRequest {
|
|
2471
2428
|
/**
|
|
2472
2429
|
* Cart ID.
|
|
2473
2430
|
* @format GUID
|
|
2474
2431
|
*/
|
|
2475
|
-
|
|
2432
|
+
_id: string;
|
|
2476
2433
|
}
|
|
2477
|
-
|
|
2434
|
+
interface GetCheckoutByCartIdResponse {
|
|
2478
2435
|
/** Retrieved checkout. */
|
|
2479
2436
|
checkout?: Checkout;
|
|
2480
2437
|
}
|
|
2481
|
-
|
|
2438
|
+
interface GetWixCheckoutURLRequest {
|
|
2482
2439
|
/**
|
|
2483
2440
|
* Checkout ID.
|
|
2484
2441
|
* @format GUID
|
|
2485
2442
|
*/
|
|
2486
|
-
|
|
2443
|
+
_id: string;
|
|
2487
2444
|
}
|
|
2488
|
-
|
|
2445
|
+
interface GetWixCheckoutURLResponse {
|
|
2489
2446
|
/** Checkout URL. */
|
|
2490
2447
|
checkoutUrl?: string;
|
|
2491
2448
|
}
|
|
2492
|
-
|
|
2449
|
+
interface GetCheckoutURLRequest {
|
|
2493
2450
|
/**
|
|
2494
2451
|
* Checkout ID.
|
|
2495
2452
|
* @format GUID
|
|
2496
2453
|
*/
|
|
2497
|
-
|
|
2454
|
+
_id: string;
|
|
2498
2455
|
}
|
|
2499
|
-
|
|
2456
|
+
interface GetCheckoutURLResponse {
|
|
2500
2457
|
/** Checkout URL. */
|
|
2501
2458
|
checkoutUrl?: string;
|
|
2502
2459
|
}
|
|
2503
|
-
|
|
2460
|
+
interface UpdateCheckoutRequest {
|
|
2504
2461
|
/** Checkout information. */
|
|
2505
2462
|
checkout: Checkout;
|
|
2506
2463
|
/**
|
|
@@ -2534,49 +2491,49 @@ export interface UpdateCheckoutRequest {
|
|
|
2534
2491
|
*/
|
|
2535
2492
|
customLineItems?: CustomLineItem[];
|
|
2536
2493
|
}
|
|
2537
|
-
|
|
2494
|
+
interface UpdateCheckoutResponse {
|
|
2538
2495
|
/** Updated checkout. */
|
|
2539
2496
|
checkout?: Checkout;
|
|
2540
2497
|
}
|
|
2541
|
-
|
|
2498
|
+
interface RemoveCouponRequest {
|
|
2542
2499
|
/**
|
|
2543
2500
|
* ID of the checkout to remove the coupon from.
|
|
2544
2501
|
* @format GUID
|
|
2545
2502
|
*/
|
|
2546
|
-
|
|
2503
|
+
_id: string;
|
|
2547
2504
|
}
|
|
2548
|
-
|
|
2505
|
+
interface RemoveCouponResponse {
|
|
2549
2506
|
/** Updated checkout after removal of coupon. */
|
|
2550
2507
|
checkout?: Checkout;
|
|
2551
2508
|
}
|
|
2552
|
-
|
|
2509
|
+
interface RemoveGiftCardRequest {
|
|
2553
2510
|
/**
|
|
2554
2511
|
* ID of the checkout to remove the gift card from.
|
|
2555
2512
|
* @format GUID
|
|
2556
2513
|
*/
|
|
2557
|
-
|
|
2514
|
+
_id: string;
|
|
2558
2515
|
}
|
|
2559
|
-
|
|
2516
|
+
interface RemoveGiftCardResponse {
|
|
2560
2517
|
/** Updated checkout after removal of gift card. */
|
|
2561
2518
|
checkout?: Checkout;
|
|
2562
2519
|
}
|
|
2563
|
-
|
|
2520
|
+
interface RemoveOverrideCheckoutUrlRequest {
|
|
2564
2521
|
/**
|
|
2565
2522
|
* ID of the checkout to remove the override checkout url from.
|
|
2566
2523
|
* @format GUID
|
|
2567
2524
|
*/
|
|
2568
|
-
|
|
2525
|
+
_id: string;
|
|
2569
2526
|
}
|
|
2570
|
-
|
|
2527
|
+
interface RemoveOverrideCheckoutUrlResponse {
|
|
2571
2528
|
/** Updated checkout after removal of override checkout url. */
|
|
2572
2529
|
checkout?: Checkout;
|
|
2573
2530
|
}
|
|
2574
|
-
|
|
2531
|
+
interface AddToCheckoutRequest {
|
|
2575
2532
|
/**
|
|
2576
2533
|
* Checkout ID.
|
|
2577
2534
|
* @format GUID
|
|
2578
2535
|
*/
|
|
2579
|
-
|
|
2536
|
+
_id: string;
|
|
2580
2537
|
/**
|
|
2581
2538
|
* Catalog line items.
|
|
2582
2539
|
* @maxSize 100
|
|
@@ -2591,16 +2548,16 @@ export interface AddToCheckoutRequest {
|
|
|
2591
2548
|
*/
|
|
2592
2549
|
customLineItems?: CustomLineItem[];
|
|
2593
2550
|
}
|
|
2594
|
-
|
|
2551
|
+
interface AddToCheckoutResponse {
|
|
2595
2552
|
/** Updated checkout. */
|
|
2596
2553
|
checkout?: Checkout;
|
|
2597
2554
|
}
|
|
2598
|
-
|
|
2555
|
+
interface RemoveLineItemsRequest {
|
|
2599
2556
|
/**
|
|
2600
2557
|
* ID of the checkout to remove line items from.
|
|
2601
2558
|
* @format GUID
|
|
2602
2559
|
*/
|
|
2603
|
-
|
|
2560
|
+
_id: string;
|
|
2604
2561
|
/**
|
|
2605
2562
|
* IDs of the line items to remove from the checkout.
|
|
2606
2563
|
*
|
|
@@ -2613,22 +2570,22 @@ export interface RemoveLineItemsRequest {
|
|
|
2613
2570
|
*/
|
|
2614
2571
|
lineItemIds: string[];
|
|
2615
2572
|
}
|
|
2616
|
-
|
|
2573
|
+
interface RemoveLineItemsResponse {
|
|
2617
2574
|
/** Updated checkout after removal of line items. */
|
|
2618
2575
|
checkout?: Checkout;
|
|
2619
2576
|
}
|
|
2620
|
-
|
|
2577
|
+
interface CreateOrderRequest {
|
|
2621
2578
|
/**
|
|
2622
2579
|
* Checkout ID.
|
|
2623
2580
|
* @format GUID
|
|
2624
2581
|
*/
|
|
2625
|
-
|
|
2582
|
+
_id: string;
|
|
2626
2583
|
/** Whether the payment method should be saved on the order. */
|
|
2627
2584
|
savePaymentMethod?: boolean;
|
|
2628
2585
|
/** Whether to authorize the payment and delay the capture. */
|
|
2629
2586
|
delayCapture?: boolean;
|
|
2630
2587
|
}
|
|
2631
|
-
|
|
2588
|
+
interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
2632
2589
|
/**
|
|
2633
2590
|
* ID of newly created order.
|
|
2634
2591
|
* @format GUID
|
|
@@ -2652,7 +2609,7 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
|
2652
2609
|
paymentGatewayOrderId?: string | null;
|
|
2653
2610
|
}
|
|
2654
2611
|
/** @oneof */
|
|
2655
|
-
|
|
2612
|
+
interface CreateOrderResponseIdOneOf {
|
|
2656
2613
|
/**
|
|
2657
2614
|
* ID of newly created order.
|
|
2658
2615
|
* @format GUID
|
|
@@ -2664,37 +2621,37 @@ export interface CreateOrderResponseIdOneOf {
|
|
|
2664
2621
|
*/
|
|
2665
2622
|
subscriptionId?: string;
|
|
2666
2623
|
}
|
|
2667
|
-
|
|
2624
|
+
interface PaymentErrorResponseData {
|
|
2668
2625
|
paymentResponseToken?: string | null;
|
|
2669
2626
|
transactionStatus?: string;
|
|
2670
2627
|
failureDetails?: string | null;
|
|
2671
2628
|
}
|
|
2672
|
-
|
|
2629
|
+
interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
|
|
2673
2630
|
/** @format GUID */
|
|
2674
2631
|
orderId?: string;
|
|
2675
2632
|
/** @format GUID */
|
|
2676
2633
|
subscriptionId?: string;
|
|
2677
2634
|
}
|
|
2678
2635
|
/** @oneof */
|
|
2679
|
-
|
|
2636
|
+
interface DoublePaymentErrorDataIdOneOf {
|
|
2680
2637
|
/** @format GUID */
|
|
2681
2638
|
orderId?: string;
|
|
2682
2639
|
/** @format GUID */
|
|
2683
2640
|
subscriptionId?: string;
|
|
2684
2641
|
}
|
|
2685
|
-
|
|
2642
|
+
interface RedeemErrorData {
|
|
2686
2643
|
reason?: string;
|
|
2687
2644
|
}
|
|
2688
|
-
|
|
2645
|
+
interface ViolationsList {
|
|
2689
2646
|
/** Violations risen by ValidationsSPI implementers. */
|
|
2690
2647
|
violations?: Violation[];
|
|
2691
2648
|
}
|
|
2692
|
-
|
|
2649
|
+
interface CreateOrderAndChargeRequest {
|
|
2693
2650
|
/**
|
|
2694
2651
|
* Checkout ID.
|
|
2695
2652
|
* @format GUID
|
|
2696
2653
|
*/
|
|
2697
|
-
|
|
2654
|
+
_id: string;
|
|
2698
2655
|
/** Payment token. */
|
|
2699
2656
|
paymentToken?: string | null;
|
|
2700
2657
|
/** Whether the payment method should be saved on the order. */
|
|
@@ -2702,7 +2659,7 @@ export interface CreateOrderAndChargeRequest {
|
|
|
2702
2659
|
/** Whether to authorize the payment and delay the capture. */
|
|
2703
2660
|
delayCapture?: boolean;
|
|
2704
2661
|
}
|
|
2705
|
-
|
|
2662
|
+
interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
2706
2663
|
/**
|
|
2707
2664
|
* ID of newly created order.
|
|
2708
2665
|
* @format GUID
|
|
@@ -2725,7 +2682,7 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
|
|
|
2725
2682
|
paymentGatewayOrderId?: string | null;
|
|
2726
2683
|
}
|
|
2727
2684
|
/** @oneof */
|
|
2728
|
-
|
|
2685
|
+
interface CreateOrderAndChargeResponseIdOneOf {
|
|
2729
2686
|
/**
|
|
2730
2687
|
* ID of newly created order.
|
|
2731
2688
|
* @format GUID
|
|
@@ -2737,41 +2694,41 @@ export interface CreateOrderAndChargeResponseIdOneOf {
|
|
|
2737
2694
|
*/
|
|
2738
2695
|
subscriptionId?: string;
|
|
2739
2696
|
}
|
|
2740
|
-
|
|
2697
|
+
interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
|
|
2741
2698
|
/**
|
|
2742
2699
|
* Server-signed JWT token with required information to complete checkout
|
|
2743
2700
|
* @maxLength 4096
|
|
2744
2701
|
*/
|
|
2745
2702
|
token: string;
|
|
2746
2703
|
}
|
|
2747
|
-
|
|
2704
|
+
interface RawHttpResponse {
|
|
2748
2705
|
body?: Uint8Array;
|
|
2749
2706
|
statusCode?: number | null;
|
|
2750
2707
|
headers?: HeadersEntry[];
|
|
2751
2708
|
}
|
|
2752
|
-
|
|
2709
|
+
interface HeadersEntry {
|
|
2753
2710
|
key?: string;
|
|
2754
2711
|
value?: string;
|
|
2755
2712
|
}
|
|
2756
|
-
|
|
2713
|
+
interface MarkCheckoutAsCompletedRequest {
|
|
2757
2714
|
/**
|
|
2758
2715
|
* Checkout ID.
|
|
2759
2716
|
* @format GUID
|
|
2760
2717
|
*/
|
|
2761
|
-
|
|
2718
|
+
_id: string;
|
|
2762
2719
|
}
|
|
2763
|
-
|
|
2720
|
+
interface MarkCheckoutAsCompletedResponse {
|
|
2764
2721
|
}
|
|
2765
2722
|
/** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
|
|
2766
|
-
|
|
2723
|
+
interface CheckoutMarkedAsCompleted {
|
|
2767
2724
|
checkout?: Checkout;
|
|
2768
2725
|
}
|
|
2769
|
-
|
|
2726
|
+
interface UpdateLineItemsQuantityRequest {
|
|
2770
2727
|
/**
|
|
2771
2728
|
* Checkout ID.
|
|
2772
2729
|
* @format GUID
|
|
2773
2730
|
*/
|
|
2774
|
-
|
|
2731
|
+
_id: string;
|
|
2775
2732
|
/**
|
|
2776
2733
|
* Line item info to update.
|
|
2777
2734
|
* @minSize 1
|
|
@@ -2779,12 +2736,12 @@ export interface UpdateLineItemsQuantityRequest {
|
|
|
2779
2736
|
*/
|
|
2780
2737
|
lineItems: LineItemQuantityUpdate[];
|
|
2781
2738
|
}
|
|
2782
|
-
|
|
2739
|
+
interface LineItemQuantityUpdate {
|
|
2783
2740
|
/**
|
|
2784
2741
|
* ID of the line item to update.
|
|
2785
2742
|
* @format GUID
|
|
2786
2743
|
*/
|
|
2787
|
-
|
|
2744
|
+
_id?: string;
|
|
2788
2745
|
/**
|
|
2789
2746
|
* New total amount of the line item,
|
|
2790
2747
|
* not the amount to add to the current `quantity`.
|
|
@@ -2797,44 +2754,44 @@ export interface LineItemQuantityUpdate {
|
|
|
2797
2754
|
*/
|
|
2798
2755
|
quantity?: number;
|
|
2799
2756
|
}
|
|
2800
|
-
|
|
2757
|
+
interface UpdateLineItemsQuantityResponse {
|
|
2801
2758
|
/** Updated checkout. */
|
|
2802
2759
|
checkout?: Checkout;
|
|
2803
2760
|
}
|
|
2804
|
-
|
|
2761
|
+
interface GetCheckoutPaymentSettingsRequest {
|
|
2805
2762
|
/**
|
|
2806
2763
|
* Checkout ID.
|
|
2807
2764
|
* @format GUID
|
|
2808
2765
|
*/
|
|
2809
|
-
|
|
2766
|
+
_id: string;
|
|
2810
2767
|
}
|
|
2811
|
-
|
|
2768
|
+
interface GetCheckoutPaymentSettingsResponse {
|
|
2812
2769
|
blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals[];
|
|
2813
2770
|
}
|
|
2814
|
-
|
|
2771
|
+
declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2815
2772
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
2816
2773
|
MANUAL = "MANUAL"
|
|
2817
2774
|
}
|
|
2818
2775
|
/** @enumType */
|
|
2819
|
-
|
|
2820
|
-
|
|
2776
|
+
type GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals = GetCheckoutPaymentSettingsResponsePaymentOption | 'UNKNOWN_PAYMENT_OPTION' | 'MANUAL';
|
|
2777
|
+
interface DeleteCheckoutRequest {
|
|
2821
2778
|
/**
|
|
2822
2779
|
* ID of the checkout to delete.
|
|
2823
2780
|
* @format GUID
|
|
2824
2781
|
*/
|
|
2825
|
-
|
|
2782
|
+
_id?: string;
|
|
2826
2783
|
}
|
|
2827
|
-
|
|
2784
|
+
interface DeleteCheckoutResponse {
|
|
2828
2785
|
}
|
|
2829
|
-
|
|
2786
|
+
interface SubscriptionCreated {
|
|
2830
2787
|
subscription?: Subscription;
|
|
2831
2788
|
}
|
|
2832
|
-
|
|
2789
|
+
interface Subscription {
|
|
2833
2790
|
/**
|
|
2834
2791
|
* Subscription id (auto-generated upon subscription creation)
|
|
2835
2792
|
* @readonly
|
|
2836
2793
|
*/
|
|
2837
|
-
|
|
2794
|
+
_id?: string;
|
|
2838
2795
|
/**
|
|
2839
2796
|
* id of subscription in external system
|
|
2840
2797
|
* @format GUID
|
|
@@ -2893,16 +2850,16 @@ export interface Subscription {
|
|
|
2893
2850
|
billingInfo?: BillingInfo;
|
|
2894
2851
|
}
|
|
2895
2852
|
/** Buyer Info */
|
|
2896
|
-
|
|
2853
|
+
interface V1BuyerInfo {
|
|
2897
2854
|
/**
|
|
2898
2855
|
* Wix customer ID
|
|
2899
2856
|
* @format GUID
|
|
2900
2857
|
*/
|
|
2901
|
-
|
|
2858
|
+
_id?: string;
|
|
2902
2859
|
/** Customer type */
|
|
2903
2860
|
identityType?: IdentityTypeWithLiterals;
|
|
2904
2861
|
}
|
|
2905
|
-
|
|
2862
|
+
declare enum IdentityType {
|
|
2906
2863
|
UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
|
|
2907
2864
|
/** Site member */
|
|
2908
2865
|
MEMBER = "MEMBER",
|
|
@@ -2910,8 +2867,8 @@ export declare enum IdentityType {
|
|
|
2910
2867
|
CONTACT = "CONTACT"
|
|
2911
2868
|
}
|
|
2912
2869
|
/** @enumType */
|
|
2913
|
-
|
|
2914
|
-
|
|
2870
|
+
type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
|
|
2871
|
+
interface V1LineItem {
|
|
2915
2872
|
/** Line item ID (auto-generated) */
|
|
2916
2873
|
index?: number;
|
|
2917
2874
|
/**
|
|
@@ -2940,7 +2897,7 @@ export interface V1LineItem {
|
|
|
2940
2897
|
/** Product details */
|
|
2941
2898
|
productDetails?: ProductDetails;
|
|
2942
2899
|
}
|
|
2943
|
-
|
|
2900
|
+
interface OptionSelection {
|
|
2944
2901
|
/**
|
|
2945
2902
|
* Option name
|
|
2946
2903
|
* @maxLength 200
|
|
@@ -2952,7 +2909,7 @@ export interface OptionSelection {
|
|
|
2952
2909
|
*/
|
|
2953
2910
|
selection?: string;
|
|
2954
2911
|
}
|
|
2955
|
-
|
|
2912
|
+
interface CustomTextFieldSelection {
|
|
2956
2913
|
/**
|
|
2957
2914
|
* Custom text field name
|
|
2958
2915
|
* @maxLength 100
|
|
@@ -2964,7 +2921,7 @@ export interface CustomTextFieldSelection {
|
|
|
2964
2921
|
*/
|
|
2965
2922
|
value?: string;
|
|
2966
2923
|
}
|
|
2967
|
-
|
|
2924
|
+
interface ChargeDetails {
|
|
2968
2925
|
/**
|
|
2969
2926
|
* price of line item (depends on subscription option)
|
|
2970
2927
|
* @max 999999999.99
|
|
@@ -2993,7 +2950,7 @@ export interface ChargeDetails {
|
|
|
2993
2950
|
*/
|
|
2994
2951
|
taxRate?: string | null;
|
|
2995
2952
|
}
|
|
2996
|
-
|
|
2953
|
+
interface ProductDetails {
|
|
2997
2954
|
/**
|
|
2998
2955
|
* Line item product ID (optional for POS orders)
|
|
2999
2956
|
* @minLength 1
|
|
@@ -3046,7 +3003,7 @@ export interface ProductDetails {
|
|
|
3046
3003
|
*/
|
|
3047
3004
|
appId?: string | null;
|
|
3048
3005
|
}
|
|
3049
|
-
|
|
3006
|
+
declare enum LineItemType {
|
|
3050
3007
|
/** Line item type can't be classified, due to an error */
|
|
3051
3008
|
UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
|
|
3052
3009
|
/** Physical item type */
|
|
@@ -3057,8 +3014,8 @@ export declare enum LineItemType {
|
|
|
3057
3014
|
CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
|
|
3058
3015
|
}
|
|
3059
3016
|
/** @enumType */
|
|
3060
|
-
|
|
3061
|
-
|
|
3017
|
+
type LineItemTypeWithLiterals = LineItemType | 'UNSPECIFIED_LINE_ITEM_TYPE' | 'PHYSICAL' | 'DIGITAL' | 'CUSTOM_AMOUNT_ITEM';
|
|
3018
|
+
interface MediaItem {
|
|
3062
3019
|
/**
|
|
3063
3020
|
* Media type
|
|
3064
3021
|
* @readonly
|
|
@@ -3083,7 +3040,7 @@ export interface MediaItem {
|
|
|
3083
3040
|
*/
|
|
3084
3041
|
height?: number;
|
|
3085
3042
|
/** Media ID (for media items previously saved in Wix Media) */
|
|
3086
|
-
|
|
3043
|
+
_id?: string | null;
|
|
3087
3044
|
/** Media external URL */
|
|
3088
3045
|
externalImageUrl?: string | null;
|
|
3089
3046
|
/**
|
|
@@ -3092,15 +3049,15 @@ export interface MediaItem {
|
|
|
3092
3049
|
*/
|
|
3093
3050
|
altText?: string | null;
|
|
3094
3051
|
}
|
|
3095
|
-
|
|
3052
|
+
declare enum MediaItemType {
|
|
3096
3053
|
/** Media item type can't be classified, due to an error */
|
|
3097
3054
|
UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
|
|
3098
3055
|
/** Image item type */
|
|
3099
3056
|
IMAGE = "IMAGE"
|
|
3100
3057
|
}
|
|
3101
3058
|
/** @enumType */
|
|
3102
|
-
|
|
3103
|
-
|
|
3059
|
+
type MediaItemTypeWithLiterals = MediaItemType | 'UNSPECIFIED_MEDIA_TYPE_ITEM' | 'IMAGE';
|
|
3060
|
+
interface Totals {
|
|
3104
3061
|
/**
|
|
3105
3062
|
* Subtotal of all line items, before tax
|
|
3106
3063
|
* @max 999999999.99
|
|
@@ -3137,7 +3094,7 @@ export interface Totals {
|
|
|
3137
3094
|
*/
|
|
3138
3095
|
quantity?: number;
|
|
3139
3096
|
}
|
|
3140
|
-
|
|
3097
|
+
interface StoreSettings {
|
|
3141
3098
|
/**
|
|
3142
3099
|
* Currency used for pricing in this store
|
|
3143
3100
|
* @maxLength 3
|
|
@@ -3155,7 +3112,7 @@ export interface StoreSettings {
|
|
|
3155
3112
|
*/
|
|
3156
3113
|
buyerLanguage?: string | null;
|
|
3157
3114
|
}
|
|
3158
|
-
|
|
3115
|
+
interface Address extends AddressAddressLine1OptionsOneOf {
|
|
3159
3116
|
/**
|
|
3160
3117
|
* Address line 1 (free text)
|
|
3161
3118
|
* @maxLength 1000
|
|
@@ -3209,7 +3166,7 @@ export interface Address extends AddressAddressLine1OptionsOneOf {
|
|
|
3209
3166
|
vatId?: VatId;
|
|
3210
3167
|
}
|
|
3211
3168
|
/** @oneof */
|
|
3212
|
-
|
|
3169
|
+
interface AddressAddressLine1OptionsOneOf {
|
|
3213
3170
|
/**
|
|
3214
3171
|
* Address line 1 (free text)
|
|
3215
3172
|
* @maxLength 1000
|
|
@@ -3218,7 +3175,7 @@ export interface AddressAddressLine1OptionsOneOf {
|
|
|
3218
3175
|
/** Address line 1 (street) */
|
|
3219
3176
|
street?: Street;
|
|
3220
3177
|
}
|
|
3221
|
-
|
|
3178
|
+
interface FullName {
|
|
3222
3179
|
/**
|
|
3223
3180
|
* Customer's first name
|
|
3224
3181
|
* @maxLength 1000
|
|
@@ -3230,7 +3187,7 @@ export interface FullName {
|
|
|
3230
3187
|
*/
|
|
3231
3188
|
lastName?: string;
|
|
3232
3189
|
}
|
|
3233
|
-
|
|
3190
|
+
interface Street {
|
|
3234
3191
|
/**
|
|
3235
3192
|
* Street number
|
|
3236
3193
|
* @maxLength 500
|
|
@@ -3242,7 +3199,7 @@ export interface Street {
|
|
|
3242
3199
|
*/
|
|
3243
3200
|
name?: string;
|
|
3244
3201
|
}
|
|
3245
|
-
|
|
3202
|
+
interface VatId {
|
|
3246
3203
|
/**
|
|
3247
3204
|
* Customer's tax ID.
|
|
3248
3205
|
* @maxLength 50
|
|
@@ -3256,7 +3213,7 @@ export interface VatId {
|
|
|
3256
3213
|
type?: VatTypeWithLiterals;
|
|
3257
3214
|
}
|
|
3258
3215
|
/** Brazilian tax info types */
|
|
3259
|
-
|
|
3216
|
+
declare enum VatType {
|
|
3260
3217
|
/** When the tax info type can't be classified, due to an error */
|
|
3261
3218
|
UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
|
|
3262
3219
|
/** CPF - for individual tax payers */
|
|
@@ -3265,8 +3222,8 @@ export declare enum VatType {
|
|
|
3265
3222
|
CNPJ = "CNPJ"
|
|
3266
3223
|
}
|
|
3267
3224
|
/** @enumType */
|
|
3268
|
-
|
|
3269
|
-
|
|
3225
|
+
type VatTypeWithLiterals = VatType | 'UNSPECIFIED_TAX_TYPE' | 'CPF' | 'CNPJ';
|
|
3226
|
+
interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3270
3227
|
/** Shipment details (when this object describes shipment) */
|
|
3271
3228
|
shipmentDetails?: ShipmentDetails;
|
|
3272
3229
|
/** Pickup details (when this object describes pickup) */
|
|
@@ -3283,13 +3240,13 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
|
3283
3240
|
estimatedDeliveryTime?: string | null;
|
|
3284
3241
|
}
|
|
3285
3242
|
/** @oneof */
|
|
3286
|
-
|
|
3243
|
+
interface V1ShippingInfoDetailsOneOf {
|
|
3287
3244
|
/** Shipment details (when this object describes shipment) */
|
|
3288
3245
|
shipmentDetails?: ShipmentDetails;
|
|
3289
3246
|
/** Pickup details (when this object describes pickup) */
|
|
3290
3247
|
pickupDetails?: V1PickupDetails;
|
|
3291
3248
|
}
|
|
3292
|
-
|
|
3249
|
+
interface ShipmentDetails {
|
|
3293
3250
|
/** Shipping destination address */
|
|
3294
3251
|
address?: Address;
|
|
3295
3252
|
/**
|
|
@@ -3310,7 +3267,7 @@ export interface ShipmentDetails {
|
|
|
3310
3267
|
*/
|
|
3311
3268
|
taxRate?: string | null;
|
|
3312
3269
|
}
|
|
3313
|
-
|
|
3270
|
+
interface V1PickupDetails {
|
|
3314
3271
|
/** Pickup address */
|
|
3315
3272
|
address?: PickupAddress;
|
|
3316
3273
|
/**
|
|
@@ -3319,7 +3276,7 @@ export interface V1PickupDetails {
|
|
|
3319
3276
|
*/
|
|
3320
3277
|
pickupInstructions?: string | null;
|
|
3321
3278
|
}
|
|
3322
|
-
|
|
3279
|
+
interface PickupAddress {
|
|
3323
3280
|
/**
|
|
3324
3281
|
* Country code (2 letters)
|
|
3325
3282
|
* @format COUNTRY
|
|
@@ -3346,7 +3303,7 @@ export interface PickupAddress {
|
|
|
3346
3303
|
*/
|
|
3347
3304
|
zipCode?: string;
|
|
3348
3305
|
}
|
|
3349
|
-
|
|
3306
|
+
interface AppliedCoupon {
|
|
3350
3307
|
/** Coupon ID */
|
|
3351
3308
|
couponId?: string;
|
|
3352
3309
|
/**
|
|
@@ -3361,7 +3318,7 @@ export interface AppliedCoupon {
|
|
|
3361
3318
|
code?: string;
|
|
3362
3319
|
}
|
|
3363
3320
|
/** Custom field */
|
|
3364
|
-
|
|
3321
|
+
interface V1CustomField {
|
|
3365
3322
|
/**
|
|
3366
3323
|
* Free text that the customer entered in the custom field during the checkout process
|
|
3367
3324
|
* @maxLength 250
|
|
@@ -3378,9 +3335,9 @@ export interface V1CustomField {
|
|
|
3378
3335
|
*/
|
|
3379
3336
|
translatedTitle?: string;
|
|
3380
3337
|
}
|
|
3381
|
-
|
|
3338
|
+
interface V1SubscriptionOptionInfo {
|
|
3382
3339
|
/** @format GUID */
|
|
3383
|
-
|
|
3340
|
+
_id?: string | null;
|
|
3384
3341
|
/**
|
|
3385
3342
|
* @minLength 1
|
|
3386
3343
|
* @maxLength 20
|
|
@@ -3390,33 +3347,33 @@ export interface V1SubscriptionOptionInfo {
|
|
|
3390
3347
|
description?: string | null;
|
|
3391
3348
|
discount?: Discount;
|
|
3392
3349
|
}
|
|
3393
|
-
|
|
3350
|
+
interface Discount {
|
|
3394
3351
|
/** Discount type. */
|
|
3395
3352
|
type?: DiscountDiscountTypeWithLiterals;
|
|
3396
3353
|
/** Discount value. */
|
|
3397
3354
|
value?: number;
|
|
3398
3355
|
}
|
|
3399
|
-
|
|
3356
|
+
declare enum DiscountDiscountType {
|
|
3400
3357
|
UNDEFINED = "UNDEFINED",
|
|
3401
3358
|
/** No discount */
|
|
3402
3359
|
AMOUNT = "AMOUNT",
|
|
3403
3360
|
PERCENT = "PERCENT"
|
|
3404
3361
|
}
|
|
3405
3362
|
/** @enumType */
|
|
3406
|
-
|
|
3407
|
-
|
|
3363
|
+
type DiscountDiscountTypeWithLiterals = DiscountDiscountType | 'UNDEFINED' | 'AMOUNT' | 'PERCENT';
|
|
3364
|
+
interface ChannelInfo {
|
|
3408
3365
|
/** Sales channel that submitted the subscription */
|
|
3409
3366
|
type?: ChannelInfoChannelTypeWithLiterals;
|
|
3410
3367
|
}
|
|
3411
|
-
|
|
3368
|
+
declare enum ChannelInfoChannelType {
|
|
3412
3369
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3413
3370
|
WEB = "WEB",
|
|
3414
3371
|
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
3415
3372
|
WIX_APP_STORE = "WIX_APP_STORE"
|
|
3416
3373
|
}
|
|
3417
3374
|
/** @enumType */
|
|
3418
|
-
|
|
3419
|
-
|
|
3375
|
+
type ChannelInfoChannelTypeWithLiterals = ChannelInfoChannelType | 'UNSPECIFIED' | 'WEB' | 'OTHER_PLATFORM' | 'WIX_APP_STORE';
|
|
3376
|
+
interface V1SubscriptionSettings {
|
|
3420
3377
|
/** Frequency of recurring payment. */
|
|
3421
3378
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
3422
3379
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
@@ -3428,7 +3385,7 @@ export interface V1SubscriptionSettings {
|
|
|
3428
3385
|
*/
|
|
3429
3386
|
billingCycles?: number | null;
|
|
3430
3387
|
}
|
|
3431
|
-
|
|
3388
|
+
interface BillingInfo {
|
|
3432
3389
|
/**
|
|
3433
3390
|
* Payment method used for this order
|
|
3434
3391
|
* @maxLength 50
|
|
@@ -3445,15 +3402,15 @@ export interface BillingInfo {
|
|
|
3445
3402
|
*/
|
|
3446
3403
|
paymentGatewayOrderId?: string | null;
|
|
3447
3404
|
}
|
|
3448
|
-
|
|
3405
|
+
interface Empty {
|
|
3449
3406
|
}
|
|
3450
|
-
|
|
3407
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3451
3408
|
createdEvent?: EntityCreatedEvent;
|
|
3452
3409
|
updatedEvent?: EntityUpdatedEvent;
|
|
3453
3410
|
deletedEvent?: EntityDeletedEvent;
|
|
3454
3411
|
actionEvent?: ActionEvent;
|
|
3455
3412
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3456
|
-
|
|
3413
|
+
_id?: string;
|
|
3457
3414
|
/**
|
|
3458
3415
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3459
3416
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -3482,36 +3439,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3482
3439
|
entityEventSequence?: string | null;
|
|
3483
3440
|
}
|
|
3484
3441
|
/** @oneof */
|
|
3485
|
-
|
|
3442
|
+
interface DomainEventBodyOneOf {
|
|
3486
3443
|
createdEvent?: EntityCreatedEvent;
|
|
3487
3444
|
updatedEvent?: EntityUpdatedEvent;
|
|
3488
3445
|
deletedEvent?: EntityDeletedEvent;
|
|
3489
3446
|
actionEvent?: ActionEvent;
|
|
3490
3447
|
}
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3494
|
-
restoreInfo?: RestoreInfo;
|
|
3448
|
+
interface EntityCreatedEvent {
|
|
3449
|
+
entity?: string;
|
|
3495
3450
|
}
|
|
3496
|
-
|
|
3451
|
+
interface RestoreInfo {
|
|
3497
3452
|
deletedDate?: Date | null;
|
|
3498
3453
|
}
|
|
3499
|
-
|
|
3454
|
+
interface EntityUpdatedEvent {
|
|
3500
3455
|
/**
|
|
3501
3456
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3502
3457
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3503
3458
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3504
3459
|
*/
|
|
3505
|
-
|
|
3460
|
+
currentEntity?: string;
|
|
3506
3461
|
}
|
|
3507
|
-
|
|
3462
|
+
interface EntityDeletedEvent {
|
|
3508
3463
|
/** Entity that was deleted. */
|
|
3509
|
-
|
|
3464
|
+
deletedEntity?: string | null;
|
|
3510
3465
|
}
|
|
3511
|
-
|
|
3512
|
-
|
|
3466
|
+
interface ActionEvent {
|
|
3467
|
+
body?: string;
|
|
3513
3468
|
}
|
|
3514
|
-
|
|
3469
|
+
interface MessageEnvelope {
|
|
3515
3470
|
/**
|
|
3516
3471
|
* App instance ID.
|
|
3517
3472
|
* @format GUID
|
|
@@ -3527,7 +3482,7 @@ export interface MessageEnvelope {
|
|
|
3527
3482
|
/** Stringify payload. */
|
|
3528
3483
|
data?: string;
|
|
3529
3484
|
}
|
|
3530
|
-
|
|
3485
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3531
3486
|
/**
|
|
3532
3487
|
* ID of a site visitor that has not logged in to the site.
|
|
3533
3488
|
* @format GUID
|
|
@@ -3552,7 +3507,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3552
3507
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3553
3508
|
}
|
|
3554
3509
|
/** @oneof */
|
|
3555
|
-
|
|
3510
|
+
interface IdentificationDataIdOneOf {
|
|
3556
3511
|
/**
|
|
3557
3512
|
* ID of a site visitor that has not logged in to the site.
|
|
3558
3513
|
* @format GUID
|
|
@@ -3574,7 +3529,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
3574
3529
|
*/
|
|
3575
3530
|
appId?: string;
|
|
3576
3531
|
}
|
|
3577
|
-
|
|
3532
|
+
declare enum WebhookIdentityType {
|
|
3578
3533
|
UNKNOWN = "UNKNOWN",
|
|
3579
3534
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3580
3535
|
MEMBER = "MEMBER",
|
|
@@ -3582,4 +3537,358 @@ export declare enum WebhookIdentityType {
|
|
|
3582
3537
|
APP = "APP"
|
|
3583
3538
|
}
|
|
3584
3539
|
/** @enumType */
|
|
3585
|
-
|
|
3540
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3541
|
+
interface BaseEventMetadata {
|
|
3542
|
+
/**
|
|
3543
|
+
* App instance ID.
|
|
3544
|
+
* @format GUID
|
|
3545
|
+
*/
|
|
3546
|
+
instanceId?: string | null;
|
|
3547
|
+
/**
|
|
3548
|
+
* Event type.
|
|
3549
|
+
* @maxLength 150
|
|
3550
|
+
*/
|
|
3551
|
+
eventType?: string;
|
|
3552
|
+
/** The identification type and identity data. */
|
|
3553
|
+
identity?: IdentificationData;
|
|
3554
|
+
}
|
|
3555
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
3556
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3557
|
+
_id?: string;
|
|
3558
|
+
/**
|
|
3559
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3560
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3561
|
+
*/
|
|
3562
|
+
entityFqdn?: string;
|
|
3563
|
+
/**
|
|
3564
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3565
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3566
|
+
*/
|
|
3567
|
+
slug?: string;
|
|
3568
|
+
/** ID of the entity associated with the event. */
|
|
3569
|
+
entityId?: string;
|
|
3570
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3571
|
+
eventTime?: Date | null;
|
|
3572
|
+
/**
|
|
3573
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3574
|
+
* (for example, GDPR).
|
|
3575
|
+
*/
|
|
3576
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3577
|
+
/** If present, indicates the action that triggered the event. */
|
|
3578
|
+
originatedFrom?: string | null;
|
|
3579
|
+
/**
|
|
3580
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3581
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3582
|
+
*/
|
|
3583
|
+
entityEventSequence?: string | null;
|
|
3584
|
+
}
|
|
3585
|
+
interface CheckoutCompletedEnvelope {
|
|
3586
|
+
data: CheckoutMarkedAsCompleted;
|
|
3587
|
+
metadata: EventMetadata;
|
|
3588
|
+
}
|
|
3589
|
+
interface CheckoutCreatedEnvelope {
|
|
3590
|
+
entity: Checkout;
|
|
3591
|
+
metadata: EventMetadata;
|
|
3592
|
+
}
|
|
3593
|
+
interface CheckoutUpdatedEnvelope {
|
|
3594
|
+
entity: Checkout;
|
|
3595
|
+
metadata: EventMetadata;
|
|
3596
|
+
}
|
|
3597
|
+
interface CreateCheckoutOptions {
|
|
3598
|
+
/** Checkout information. */
|
|
3599
|
+
checkoutInfo?: Checkout;
|
|
3600
|
+
/** Coupon code. */
|
|
3601
|
+
couponCode?: string | null;
|
|
3602
|
+
/**
|
|
3603
|
+
* Catalog line items to add to the checkout.
|
|
3604
|
+
* @maxSize 300
|
|
3605
|
+
*/
|
|
3606
|
+
lineItems?: LineItem[];
|
|
3607
|
+
/**
|
|
3608
|
+
* Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
|
|
3609
|
+
*
|
|
3610
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3611
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3612
|
+
* @maxSize 300
|
|
3613
|
+
*/
|
|
3614
|
+
customLineItems?: CustomLineItem[];
|
|
3615
|
+
/** Sales channel that submitted the order. */
|
|
3616
|
+
channelType: ChannelTypeWithLiterals;
|
|
3617
|
+
/**
|
|
3618
|
+
* Gift card code.
|
|
3619
|
+
*
|
|
3620
|
+
* The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
|
|
3621
|
+
*
|
|
3622
|
+
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
3623
|
+
*/
|
|
3624
|
+
giftCardCode?: string | null;
|
|
3625
|
+
/**
|
|
3626
|
+
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
3627
|
+
*
|
|
3628
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
3629
|
+
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
3630
|
+
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
3631
|
+
* @maxLength 1000
|
|
3632
|
+
*/
|
|
3633
|
+
overrideCheckoutUrl?: string | null;
|
|
3634
|
+
}
|
|
3635
|
+
interface UpdateCheckout {
|
|
3636
|
+
/**
|
|
3637
|
+
* Checkout ID.
|
|
3638
|
+
* @format GUID
|
|
3639
|
+
* @readonly
|
|
3640
|
+
*/
|
|
3641
|
+
_id?: string | null;
|
|
3642
|
+
/**
|
|
3643
|
+
* Line items.
|
|
3644
|
+
*
|
|
3645
|
+
* Max: 300 items
|
|
3646
|
+
* @minSize 1
|
|
3647
|
+
* @maxSize 300
|
|
3648
|
+
* @readonly
|
|
3649
|
+
*/
|
|
3650
|
+
lineItems?: LineItem[];
|
|
3651
|
+
/** Billing information. */
|
|
3652
|
+
billingInfo?: AddressWithContact;
|
|
3653
|
+
/** Shipping information. */
|
|
3654
|
+
shippingInfo?: ShippingInfo;
|
|
3655
|
+
/**
|
|
3656
|
+
* [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
|
|
3657
|
+
* @maxLength 1000
|
|
3658
|
+
*/
|
|
3659
|
+
buyerNote?: string | null;
|
|
3660
|
+
/** Buyer information. */
|
|
3661
|
+
buyerInfo?: BuyerInfo;
|
|
3662
|
+
/**
|
|
3663
|
+
* The currency selected by the buyer during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
3664
|
+
* @readonly
|
|
3665
|
+
* @format CURRENCY
|
|
3666
|
+
*/
|
|
3667
|
+
conversionCurrency?: string;
|
|
3668
|
+
/**
|
|
3669
|
+
* Calculated price summary for the checkout.
|
|
3670
|
+
* @readonly
|
|
3671
|
+
*/
|
|
3672
|
+
priceSummary?: PriceSummary;
|
|
3673
|
+
/**
|
|
3674
|
+
* Errors when calculating totals.
|
|
3675
|
+
* @readonly
|
|
3676
|
+
*/
|
|
3677
|
+
calculationErrors?: CalculationErrors;
|
|
3678
|
+
/**
|
|
3679
|
+
* Applied gift card details.
|
|
3680
|
+
*
|
|
3681
|
+
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
3682
|
+
* @readonly
|
|
3683
|
+
*/
|
|
3684
|
+
giftCard?: GiftCard;
|
|
3685
|
+
/**
|
|
3686
|
+
* Applied discounts.
|
|
3687
|
+
* @readonly
|
|
3688
|
+
*/
|
|
3689
|
+
appliedDiscounts?: AppliedDiscount[];
|
|
3690
|
+
/** Custom fields. */
|
|
3691
|
+
customFields?: CustomField[];
|
|
3692
|
+
/**
|
|
3693
|
+
* Weight measurement unit. Defaults to a site's weight unit.
|
|
3694
|
+
* @readonly
|
|
3695
|
+
*/
|
|
3696
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
3697
|
+
/**
|
|
3698
|
+
* Tax summary.
|
|
3699
|
+
* @readonly
|
|
3700
|
+
*/
|
|
3701
|
+
taxSummary?: TaxSummary;
|
|
3702
|
+
/**
|
|
3703
|
+
* The site's default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
3704
|
+
* @format CURRENCY
|
|
3705
|
+
* @readonly
|
|
3706
|
+
*/
|
|
3707
|
+
currency?: string;
|
|
3708
|
+
/**
|
|
3709
|
+
* Sales channel that submitted the order.
|
|
3710
|
+
* @readonly
|
|
3711
|
+
*/
|
|
3712
|
+
channelType?: ChannelTypeWithLiterals;
|
|
3713
|
+
/**
|
|
3714
|
+
* Site language in which original values are shown.
|
|
3715
|
+
* @readonly
|
|
3716
|
+
*/
|
|
3717
|
+
siteLanguage?: string;
|
|
3718
|
+
/**
|
|
3719
|
+
* Language for communication with the buyer. Defaults to the site language.
|
|
3720
|
+
*
|
|
3721
|
+
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
3722
|
+
* @readonly
|
|
3723
|
+
*/
|
|
3724
|
+
buyerLanguage?: string;
|
|
3725
|
+
/**
|
|
3726
|
+
* Whether an order was successfully created from this checkout.
|
|
3727
|
+
*
|
|
3728
|
+
* For an order to be successful, it must be successfully paid for (unless the total is 0).
|
|
3729
|
+
* @readonly
|
|
3730
|
+
*/
|
|
3731
|
+
completed?: boolean;
|
|
3732
|
+
/**
|
|
3733
|
+
* Whether tax is included in line item prices.
|
|
3734
|
+
* @readonly
|
|
3735
|
+
*/
|
|
3736
|
+
taxIncludedInPrice?: boolean;
|
|
3737
|
+
/**
|
|
3738
|
+
* ID of the checkout's initiator.
|
|
3739
|
+
* @readonly
|
|
3740
|
+
*/
|
|
3741
|
+
createdBy?: CreatedBy;
|
|
3742
|
+
/**
|
|
3743
|
+
* Date and time the checkout was created.
|
|
3744
|
+
* @readonly
|
|
3745
|
+
*/
|
|
3746
|
+
_createdDate?: Date | null;
|
|
3747
|
+
/**
|
|
3748
|
+
* Date and time the checkout was updated.
|
|
3749
|
+
* @readonly
|
|
3750
|
+
*/
|
|
3751
|
+
_updatedDate?: Date | null;
|
|
3752
|
+
/**
|
|
3753
|
+
* Minimal amount to pay in order to place the order.
|
|
3754
|
+
* @readonly
|
|
3755
|
+
*/
|
|
3756
|
+
payNow?: PriceSummary;
|
|
3757
|
+
/**
|
|
3758
|
+
* Remaining amount for the order to be fully paid.
|
|
3759
|
+
* @readonly
|
|
3760
|
+
*/
|
|
3761
|
+
payLater?: PriceSummary;
|
|
3762
|
+
/** Memberships to apply when creating the order. */
|
|
3763
|
+
membershipOptions?: MembershipOptions;
|
|
3764
|
+
/**
|
|
3765
|
+
* Additional Fees.
|
|
3766
|
+
* @maxSize 100
|
|
3767
|
+
*/
|
|
3768
|
+
additionalFees?: AdditionalFee[];
|
|
3769
|
+
/**
|
|
3770
|
+
* Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
|
|
3771
|
+
* @format GUID
|
|
3772
|
+
*/
|
|
3773
|
+
cartId?: string | null;
|
|
3774
|
+
/**
|
|
3775
|
+
* List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
|
|
3776
|
+
* @readonly
|
|
3777
|
+
*/
|
|
3778
|
+
violations?: Violation[];
|
|
3779
|
+
/**
|
|
3780
|
+
* Custom field data for the checkout object.
|
|
3781
|
+
*
|
|
3782
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
3783
|
+
*/
|
|
3784
|
+
extendedFields?: ExtendedFields;
|
|
3785
|
+
/**
|
|
3786
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
3787
|
+
* @format GUID
|
|
3788
|
+
* @readonly
|
|
3789
|
+
*/
|
|
3790
|
+
purchaseFlowId?: string | null;
|
|
3791
|
+
/**
|
|
3792
|
+
* Additional settings for customization of the checkout process.
|
|
3793
|
+
*
|
|
3794
|
+
* > **Notes:**
|
|
3795
|
+
* > * Custom settings can only be set when creating a checkout.
|
|
3796
|
+
* > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3797
|
+
* @immutable
|
|
3798
|
+
*/
|
|
3799
|
+
customSettings?: CustomSettings;
|
|
3800
|
+
/**
|
|
3801
|
+
* Reference IDs for the app and component providing custom checkout page content.
|
|
3802
|
+
*
|
|
3803
|
+
* To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3804
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3805
|
+
*/
|
|
3806
|
+
customContentReference?: CustomContentReference;
|
|
3807
|
+
/**
|
|
3808
|
+
* References to an external app and resource associated with this checkout.
|
|
3809
|
+
* Used for integration and tracking across different platforms.
|
|
3810
|
+
* @immutable
|
|
3811
|
+
*/
|
|
3812
|
+
externalReference?: ExternalReference;
|
|
3813
|
+
/**
|
|
3814
|
+
* Payment for subscriptions after free trial period.
|
|
3815
|
+
* @readonly
|
|
3816
|
+
*/
|
|
3817
|
+
payAfterFreeTrial?: PriceSummary;
|
|
3818
|
+
/**
|
|
3819
|
+
* The business location ID associated with the checkout.
|
|
3820
|
+
*
|
|
3821
|
+
* To learn more, see the Locations API.
|
|
3822
|
+
* @format GUID
|
|
3823
|
+
*/
|
|
3824
|
+
businessLocationId?: string | null;
|
|
3825
|
+
/**
|
|
3826
|
+
* Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
3827
|
+
* @readonly
|
|
3828
|
+
* @format CURRENCY
|
|
3829
|
+
*/
|
|
3830
|
+
paymentCurrency?: string;
|
|
3831
|
+
}
|
|
3832
|
+
interface UpdateCheckoutOptions {
|
|
3833
|
+
/**
|
|
3834
|
+
* Coupon code.
|
|
3835
|
+
*
|
|
3836
|
+
* The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
|
|
3837
|
+
*/
|
|
3838
|
+
couponCode?: string | null;
|
|
3839
|
+
/** Gift card code. */
|
|
3840
|
+
giftCardCode?: string | null;
|
|
3841
|
+
/**
|
|
3842
|
+
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
3843
|
+
*
|
|
3844
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
3845
|
+
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
3846
|
+
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
3847
|
+
* @maxLength 1000
|
|
3848
|
+
*/
|
|
3849
|
+
overrideCheckoutUrl?: string | null;
|
|
3850
|
+
/**
|
|
3851
|
+
* Catalog line items.
|
|
3852
|
+
* @maxSize 300
|
|
3853
|
+
*/
|
|
3854
|
+
lineItems?: LineItem[];
|
|
3855
|
+
/**
|
|
3856
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
3857
|
+
*
|
|
3858
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3859
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3860
|
+
* @maxSize 300
|
|
3861
|
+
*/
|
|
3862
|
+
customLineItems?: CustomLineItem[];
|
|
3863
|
+
}
|
|
3864
|
+
interface AddToCheckoutOptions {
|
|
3865
|
+
/**
|
|
3866
|
+
* Catalog line items.
|
|
3867
|
+
* @maxSize 100
|
|
3868
|
+
*/
|
|
3869
|
+
lineItems?: LineItem[];
|
|
3870
|
+
/**
|
|
3871
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
3872
|
+
*
|
|
3873
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3874
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3875
|
+
* @maxSize 100
|
|
3876
|
+
*/
|
|
3877
|
+
customLineItems?: CustomLineItem[];
|
|
3878
|
+
}
|
|
3879
|
+
interface CreateOrderOptions {
|
|
3880
|
+
/** Whether the payment method should be saved on the order. */
|
|
3881
|
+
savePaymentMethod?: boolean;
|
|
3882
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
3883
|
+
delayCapture?: boolean;
|
|
3884
|
+
}
|
|
3885
|
+
interface CreateOrderAndChargeOptions {
|
|
3886
|
+
/** Payment token. */
|
|
3887
|
+
paymentToken?: string | null;
|
|
3888
|
+
/** Whether the payment method should be saved on the order. */
|
|
3889
|
+
savePaymentMethod?: boolean;
|
|
3890
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
3891
|
+
delayCapture?: boolean;
|
|
3892
|
+
}
|
|
3893
|
+
|
|
3894
|
+
export { type ProductName as $, type AddToCheckoutOptions as A, SuggestedFix as B, type CreateCheckoutOptions as C, DescriptionLineType as D, GetCheckoutPaymentSettingsResponsePaymentOption as E, FileType as F, type GetCheckoutByCartIdResponse as G, IdentityType as H, ItemAvailabilityStatus as I, JurisdictionType as J, LineItemType as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, MediaItemType as O, PaymentOptionType as P, DiscountDiscountType as Q, type RemoveCouponResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCheckout as U, VatType as V, WeightUnit as W, ChannelInfoChannelType as X, WebhookIdentityType as Y, type LineItem as Z, type CatalogReference as _, type Checkout as a, type ApplicationError as a$, type MultiCurrencyPrice as a0, type ItemTaxFullDetails as a1, type TaxRateBreakdown as a2, type TaxBreakdown as a3, type DescriptionLine as a4, type DescriptionLineValueOneOf as a5, type DescriptionLineDescriptionLineValueOneOf as a6, type DescriptionLineName as a7, type PlainTextValue as a8, type Color as a9, type StreetAddress as aA, type AddressLocation as aB, type FullAddressContactDetails as aC, type CommonVatId as aD, type ShippingInfo as aE, type SelectedCarrierServiceOption as aF, type DeliveryLogistics as aG, type PickupDetails as aH, type DeliveryTimeSlot as aI, type SelectedCarrierServiceOptionPrices as aJ, type SelectedCarrierServiceOptionOtherCharge as aK, type DeliveryAllocation as aL, type Carrier as aM, type Region as aN, type ApplicableLineItems as aO, type ShippingRegion as aP, type CarrierServiceOption as aQ, type ShippingOption as aR, type ShippingPrice as aS, type OtherCharge as aT, type BuyerInfo as aU, type BuyerInfoIdOneOf as aV, type PriceSummary as aW, type CalculationErrors as aX, type CalculationErrorsShippingCalculationErrorOneOf as aY, type Details as aZ, type DetailsKindOneOf as a_, type FocalPoint as aa, type ItemAvailabilityInfo as ab, type PhysicalProperties as ac, type Scope as ad, type Group as ae, type ItemType as af, type ItemTypeItemTypeDataOneOf as ag, type SubscriptionOptionInfo as ah, type SubscriptionSettings as ai, type FreeTrialPeriod as aj, type Title as ak, type Description as al, type SecuredMedia as am, type ServiceProperties as an, type PriceDescription as ao, type CatalogOverrideFields as ap, type PaymentOption as aq, type TaxableAddress as ar, type TaxableAddressTaxableAddressDataOneOf as as, type ExtendedFields as at, type Policy as au, type ModifierGroup as av, type TranslatableString as aw, type ItemModifier as ax, type AddressWithContact as ay, type ApiAddress as az, type GetCheckoutURLResponse as b, type RemoveLineItemsRequest as b$, type ValidationError as b0, type FieldViolation as b1, type SystemError as b2, type CarrierErrors as b3, type CarrierError as b4, type GiftCard as b5, type AppliedDiscount as b6, type AppliedDiscountDiscountSourceOneOf as b7, type Coupon as b8, type MerchantDiscount as b9, type CustomContentReference as bA, type ExternalReference as bB, type SubscriptionCharges as bC, type Charge as bD, type UpdatedCheckoutMessage as bE, type CreateCheckoutRequest as bF, type CustomLineItem as bG, type V1ModifierGroup as bH, type V1ItemModifier as bI, type MerchantDiscountInput as bJ, type CreateCheckoutResponse as bK, type ShippingCalculationErrorData as bL, type ShippingCalculationErrorDataShippingCalculationErrorOneOf as bM, type GetCheckoutRequest as bN, type GetCheckoutResponse as bO, type GetCheckoutWithAllExtendedFieldsRequest as bP, type GetCheckoutWithAllExtendedFieldsResponse as bQ, type GetCheckoutByCartIdRequest as bR, type GetWixCheckoutURLRequest as bS, type GetWixCheckoutURLResponse as bT, type GetCheckoutURLRequest as bU, type UpdateCheckoutRequest as bV, type UpdateCheckoutResponse as bW, type RemoveCouponRequest as bX, type RemoveGiftCardRequest as bY, type RemoveOverrideCheckoutUrlRequest as bZ, type AddToCheckoutRequest as b_, type DiscountRule as ba, type DiscountRuleName as bb, type LineItemDiscount as bc, type CustomField as bd, type TaxSummary as be, type TaxCalculationDetails as bf, type TaxCalculationDetailsCalculationDetailsOneOf as bg, type AutoTaxFallbackCalculationDetails as bh, type AggregatedTaxBreakdown as bi, type CreatedBy as bj, type CreatedByIdOneOf as bk, type MembershipOptions as bl, type Membership as bm, type MembershipName as bn, type MembershipPaymentCredits as bo, type InvalidMembership as bp, type SelectedMemberships as bq, type SelectedMembership as br, type AdditionalFee as bs, type ConversionInfo as bt, type Violation as bu, type Target as bv, type TargetTargetTypeOneOf as bw, type Other as bx, type TargetLineItem as by, type CustomSettings as bz, type UpdateCheckoutOptions as c, type CreateOrderRequest as c0, type CreateOrderResponseIdOneOf as c1, type PaymentErrorResponseData as c2, type DoublePaymentErrorData as c3, type DoublePaymentErrorDataIdOneOf as c4, type RedeemErrorData as c5, type ViolationsList as c6, type CreateOrderAndChargeRequest as c7, type CreateOrderAndChargeResponse as c8, type CreateOrderAndChargeResponseIdOneOf as c9, type V1ShippingInfo as cA, type V1ShippingInfoDetailsOneOf as cB, type ShipmentDetails as cC, type V1PickupDetails as cD, type PickupAddress as cE, type AppliedCoupon as cF, type V1CustomField as cG, type V1SubscriptionOptionInfo as cH, type Discount as cI, type ChannelInfo as cJ, type V1SubscriptionSettings as cK, type BillingInfo as cL, type Empty as cM, type DomainEvent as cN, type DomainEventBodyOneOf as cO, type EntityCreatedEvent as cP, type RestoreInfo as cQ, type EntityUpdatedEvent as cR, type EntityDeletedEvent as cS, type ActionEvent as cT, type MessageEnvelope as cU, type IdentificationData as cV, type IdentificationDataIdOneOf as cW, type BaseEventMetadata as cX, type EventMetadata as cY, type CreateOrderAndChargeOptions as cZ, type MarkCheckoutAsCompletedAndRedirectToUrlRequest as ca, type HeadersEntry as cb, type MarkCheckoutAsCompletedRequest as cc, type MarkCheckoutAsCompletedResponse as cd, type CheckoutMarkedAsCompleted as ce, type UpdateLineItemsQuantityRequest as cf, type GetCheckoutPaymentSettingsRequest as cg, type GetCheckoutPaymentSettingsResponse as ch, type DeleteCheckoutRequest as ci, type DeleteCheckoutResponse as cj, type SubscriptionCreated as ck, type Subscription as cl, type V1BuyerInfo as cm, type V1LineItem as cn, type OptionSelection as co, type CustomTextFieldSelection as cp, type ChargeDetails as cq, type ProductDetails as cr, type MediaItem as cs, type Totals as ct, type StoreSettings as cu, type Address as cv, type AddressAddressLine1OptionsOneOf as cw, type FullName as cx, type Street as cy, type VatId as cz, type RemoveGiftCardResponse as d, type RemoveOverrideCheckoutUrlResponse as e, type AddToCheckoutResponse as f, type RemoveLineItemsResponse as g, type CreateOrderOptions as h, type CreateOrderResponse as i, type RawHttpResponse as j, type UpdateLineItemsQuantityResponse as k, type CheckoutCompletedEnvelope as l, type CheckoutCreatedEnvelope as m, type CheckoutUpdatedEnvelope as n, ItemTypeItemType as o, CommonVatType as p, PickupMethod as q, ChargeType as r, RuleType as s, DiscountType as t, RateType as u, FallbackReason as v, ChannelType as w, AdditionalFeeSource as x, Severity as y, NameInLineItem as z };
|