@wix/auto_sdk_ecom_checkout 1.0.17 → 1.0.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +34 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.context.js +77 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +122 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js +1338 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +59 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +351 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +186 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js +358 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
- package/build/{ecom-v1-checkout-checkout.universal-BV8QOlPP.d.mts → cjs/src/ecom-v1-checkout-checkout.types.d.ts} +376 -664
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js +301 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -0
- package/build/{internal/ecom-v1-checkout-checkout.universal-DGEClxWR.d.mts → cjs/src/ecom-v1-checkout-checkout.universal.d.ts} +735 -453
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +1559 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +34 -0
- package/build/es/src/ecom-v1-checkout-checkout.context.js +42 -0
- package/build/es/src/ecom-v1-checkout-checkout.context.js.map +1 -0
- package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +122 -0
- package/build/es/src/ecom-v1-checkout-checkout.http.js +1318 -0
- package/build/es/src/ecom-v1-checkout-checkout.http.js.map +1 -0
- package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +59 -0
- package/build/es/src/ecom-v1-checkout-checkout.meta.js +308 -0
- package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
- package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +186 -0
- package/build/es/src/ecom-v1-checkout-checkout.public.js +306 -0
- package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
- package/build/{ecom-v1-checkout-checkout.universal-BV8QOlPP.d.ts → es/src/ecom-v1-checkout-checkout.types.d.ts} +376 -664
- package/build/es/src/ecom-v1-checkout-checkout.types.js +298 -0
- package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -0
- package/build/{internal/ecom-v1-checkout-checkout.universal-DGEClxWR.d.ts → es/src/ecom-v1-checkout-checkout.universal.d.ts} +735 -453
- package/build/es/src/ecom-v1-checkout-checkout.universal.js +1516 -0
- package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +42 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +77 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +122 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +1338 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +59 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +351 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +219 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +358 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +3406 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +301 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +4468 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +1559 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +42 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +42 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +122 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +1318 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +59 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +308 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +219 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +306 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +3406 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +298 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +4468 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +1516 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -211
- package/build/index.d.ts +0 -211
- package/build/index.js +0 -2781
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -2707
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -252
- package/build/internal/index.d.ts +0 -252
- package/build/internal/index.js +0 -2781
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -2707
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -2345
- package/build/internal/meta.d.ts +0 -2345
- package/build/internal/meta.js +0 -1587
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -1544
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -2345
- package/build/meta.d.ts +0 -2345
- package/build/meta.js +0 -1587
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -1544
- package/build/meta.mjs.map +0 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
export interface Checkout {
|
|
2
3
|
/**
|
|
3
4
|
* Checkout ID.
|
|
4
5
|
* @format GUID
|
|
@@ -172,21 +173,6 @@ interface Checkout {
|
|
|
172
173
|
* @immutable
|
|
173
174
|
*/
|
|
174
175
|
externalReference?: ExternalReference;
|
|
175
|
-
/**
|
|
176
|
-
* Order ID.
|
|
177
|
-
*
|
|
178
|
-
* This field is empty until the checkout completes and becomes an order.
|
|
179
|
-
* @internal
|
|
180
|
-
* @format GUID
|
|
181
|
-
* @readonly
|
|
182
|
-
*/
|
|
183
|
-
orderId?: string | null;
|
|
184
|
-
/**
|
|
185
|
-
* Payment for subscriptions after free trial period.
|
|
186
|
-
* @internal
|
|
187
|
-
* @readonly
|
|
188
|
-
*/
|
|
189
|
-
payAfterFreeTrial?: PriceSummary;
|
|
190
176
|
/**
|
|
191
177
|
* The business location ID associated with the checkout.
|
|
192
178
|
*
|
|
@@ -194,25 +180,8 @@ interface Checkout {
|
|
|
194
180
|
* @format GUID
|
|
195
181
|
*/
|
|
196
182
|
businessLocationId?: string | null;
|
|
197
|
-
/**
|
|
198
|
-
* Whether payment is required to create an order.
|
|
199
|
-
*
|
|
200
|
-
* Payment is required if any of the following conditions are met:
|
|
201
|
-
* 1. At least one item requires a payment method. This can be because the item has the `savePaymentMethod` field set to `true`, or the item is a subscription with a price greater than zero.
|
|
202
|
-
* 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
|
|
203
|
-
* @internal
|
|
204
|
-
* @readonly
|
|
205
|
-
*/
|
|
206
|
-
paymentRequired?: boolean;
|
|
207
|
-
/**
|
|
208
|
-
* Charges information for each subscription in the checkout.
|
|
209
|
-
* @internal
|
|
210
|
-
* @readonly
|
|
211
|
-
* @maxSize 100
|
|
212
|
-
*/
|
|
213
|
-
subscriptionCharges?: SubscriptionCharges[];
|
|
214
183
|
}
|
|
215
|
-
interface LineItem {
|
|
184
|
+
export interface LineItem {
|
|
216
185
|
/**
|
|
217
186
|
* Line item ID.
|
|
218
187
|
* @format GUID
|
|
@@ -372,18 +341,6 @@ interface LineItem {
|
|
|
372
341
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
373
342
|
*/
|
|
374
343
|
catalogOverrideFields?: CatalogOverrideFields;
|
|
375
|
-
/**
|
|
376
|
-
* Whether the price is not yet defined, and will be updated after the order is created.
|
|
377
|
-
* @internal
|
|
378
|
-
* @readonly
|
|
379
|
-
*/
|
|
380
|
-
priceUndetermined?: boolean;
|
|
381
|
-
/**
|
|
382
|
-
* Whether the line item quantity is fixed and cannot be changed.
|
|
383
|
-
* @internal
|
|
384
|
-
* @readonly
|
|
385
|
-
*/
|
|
386
|
-
fixedQuantity?: boolean;
|
|
387
344
|
/**
|
|
388
345
|
* Whether to save the payment method on the order.
|
|
389
346
|
*
|
|
@@ -391,55 +348,9 @@ interface LineItem {
|
|
|
391
348
|
* @readonly
|
|
392
349
|
*/
|
|
393
350
|
savePaymentMethod?: boolean;
|
|
394
|
-
/**
|
|
395
|
-
* Address to use for tax calculation purposes.
|
|
396
|
-
* @internal
|
|
397
|
-
*/
|
|
398
|
-
taxableAddress?: TaxableAddress;
|
|
399
|
-
/**
|
|
400
|
-
* Custom extended fields for the line item object.
|
|
401
|
-
*
|
|
402
|
-
* [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.
|
|
403
|
-
* @internal
|
|
404
|
-
*/
|
|
405
|
-
extendedFields?: ExtendedFields;
|
|
406
|
-
/**
|
|
407
|
-
* Policies to be displayed to the customer on the checkout page.
|
|
408
|
-
* @internal
|
|
409
|
-
* @readonly
|
|
410
|
-
* @maxSize 5
|
|
411
|
-
*/
|
|
412
|
-
policies?: Policy[];
|
|
413
|
-
/**
|
|
414
|
-
* ID of the app managing the inventory.
|
|
415
|
-
* @internal
|
|
416
|
-
* @format GUID
|
|
417
|
-
*/
|
|
418
|
-
inventoryAppId?: string | null;
|
|
419
|
-
/**
|
|
420
|
-
* Whether the item can only be purchased by site members.
|
|
421
|
-
*
|
|
422
|
-
* Default: `false`
|
|
423
|
-
* @internal
|
|
424
|
-
* @readonly
|
|
425
|
-
*/
|
|
426
|
-
membersOnly?: boolean;
|
|
427
|
-
/**
|
|
428
|
-
* Modifier groups that were added to the item.
|
|
429
|
-
* @internal
|
|
430
|
-
* @readonly
|
|
431
|
-
* @maxSize 10
|
|
432
|
-
*/
|
|
433
|
-
modifierGroups?: ModifierGroup[];
|
|
434
|
-
/**
|
|
435
|
-
* Total price of all item modifiers. Included in the item price.
|
|
436
|
-
* @internal
|
|
437
|
-
* @readonly
|
|
438
|
-
*/
|
|
439
|
-
modifiersTotalPrice?: MultiCurrencyPrice;
|
|
440
351
|
}
|
|
441
352
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
442
|
-
interface CatalogReference {
|
|
353
|
+
export interface CatalogReference {
|
|
443
354
|
/**
|
|
444
355
|
* ID of the item within the catalog it belongs to.
|
|
445
356
|
* @minLength 1
|
|
@@ -467,7 +378,7 @@ interface CatalogReference {
|
|
|
467
378
|
*/
|
|
468
379
|
options?: Record<string, any> | null;
|
|
469
380
|
}
|
|
470
|
-
interface ProductName {
|
|
381
|
+
export interface ProductName {
|
|
471
382
|
/**
|
|
472
383
|
* __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).
|
|
473
384
|
*
|
|
@@ -488,7 +399,7 @@ interface ProductName {
|
|
|
488
399
|
*/
|
|
489
400
|
translated?: string | null;
|
|
490
401
|
}
|
|
491
|
-
interface MultiCurrencyPrice {
|
|
402
|
+
export interface MultiCurrencyPrice {
|
|
492
403
|
/**
|
|
493
404
|
* Amount.
|
|
494
405
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -511,7 +422,7 @@ interface MultiCurrencyPrice {
|
|
|
511
422
|
*/
|
|
512
423
|
formattedConvertedAmount?: string;
|
|
513
424
|
}
|
|
514
|
-
interface ItemTaxFullDetails {
|
|
425
|
+
export interface ItemTaxFullDetails {
|
|
515
426
|
/** Amount for which tax is calculated. */
|
|
516
427
|
taxableAmount?: MultiCurrencyPrice;
|
|
517
428
|
/**
|
|
@@ -528,7 +439,7 @@ interface ItemTaxFullDetails {
|
|
|
528
439
|
*/
|
|
529
440
|
rateBreakdown?: TaxRateBreakdown[];
|
|
530
441
|
}
|
|
531
|
-
interface TaxRateBreakdown {
|
|
442
|
+
export interface TaxRateBreakdown {
|
|
532
443
|
/**
|
|
533
444
|
* Name of tax against which the calculation was performed.
|
|
534
445
|
* @maxLength 100
|
|
@@ -546,7 +457,7 @@ interface TaxRateBreakdown {
|
|
|
546
457
|
* TaxBreakdown represents tax information for a line item.
|
|
547
458
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
548
459
|
*/
|
|
549
|
-
interface TaxBreakdown {
|
|
460
|
+
export interface TaxBreakdown {
|
|
550
461
|
/**
|
|
551
462
|
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
552
463
|
* @maxLength 200
|
|
@@ -578,7 +489,7 @@ interface TaxBreakdown {
|
|
|
578
489
|
jurisdictionType?: JurisdictionType;
|
|
579
490
|
}
|
|
580
491
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
581
|
-
declare enum JurisdictionType {
|
|
492
|
+
export declare enum JurisdictionType {
|
|
582
493
|
UNDEFINED = "UNDEFINED",
|
|
583
494
|
COUNTRY = "COUNTRY",
|
|
584
495
|
STATE = "STATE",
|
|
@@ -586,7 +497,7 @@ declare enum JurisdictionType {
|
|
|
586
497
|
CITY = "CITY",
|
|
587
498
|
SPECIAL = "SPECIAL"
|
|
588
499
|
}
|
|
589
|
-
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
500
|
+
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
590
501
|
/** Description line plain text value. */
|
|
591
502
|
plainText?: PlainTextValue;
|
|
592
503
|
/** Description line color value. */
|
|
@@ -595,16 +506,16 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
595
506
|
name?: DescriptionLineName;
|
|
596
507
|
}
|
|
597
508
|
/** @oneof */
|
|
598
|
-
interface DescriptionLineValueOneOf {
|
|
509
|
+
export interface DescriptionLineValueOneOf {
|
|
599
510
|
/** Description line plain text value. */
|
|
600
511
|
plainText?: PlainTextValue;
|
|
601
512
|
/** Description line color value. */
|
|
602
513
|
colorInfo?: Color;
|
|
603
514
|
}
|
|
604
515
|
/** @oneof */
|
|
605
|
-
interface DescriptionLineDescriptionLineValueOneOf {
|
|
516
|
+
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
606
517
|
}
|
|
607
|
-
interface DescriptionLineName {
|
|
518
|
+
export interface DescriptionLineName {
|
|
608
519
|
/**
|
|
609
520
|
* 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).
|
|
610
521
|
* @maxLength 100
|
|
@@ -618,7 +529,7 @@ interface DescriptionLineName {
|
|
|
618
529
|
*/
|
|
619
530
|
translated?: string | null;
|
|
620
531
|
}
|
|
621
|
-
interface PlainTextValue {
|
|
532
|
+
export interface PlainTextValue {
|
|
622
533
|
/**
|
|
623
534
|
* 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).
|
|
624
535
|
* @maxLength 600
|
|
@@ -632,7 +543,7 @@ interface PlainTextValue {
|
|
|
632
543
|
*/
|
|
633
544
|
translated?: string | null;
|
|
634
545
|
}
|
|
635
|
-
interface Color {
|
|
546
|
+
export interface Color {
|
|
636
547
|
/**
|
|
637
548
|
* 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).
|
|
638
549
|
* @maxLength 500
|
|
@@ -648,7 +559,7 @@ interface Color {
|
|
|
648
559
|
/** HEX or RGB color code for display. */
|
|
649
560
|
code?: string | null;
|
|
650
561
|
}
|
|
651
|
-
declare enum DescriptionLineType {
|
|
562
|
+
export declare enum DescriptionLineType {
|
|
652
563
|
/** Unrecognized type. */
|
|
653
564
|
UNRECOGNISED = "UNRECOGNISED",
|
|
654
565
|
/** Plain text type. */
|
|
@@ -656,7 +567,7 @@ declare enum DescriptionLineType {
|
|
|
656
567
|
/** Color type. */
|
|
657
568
|
COLOR = "COLOR"
|
|
658
569
|
}
|
|
659
|
-
interface FocalPoint {
|
|
570
|
+
export interface FocalPoint {
|
|
660
571
|
/** X-coordinate of the focal point. */
|
|
661
572
|
x?: number;
|
|
662
573
|
/** Y-coordinate of the focal point. */
|
|
@@ -666,13 +577,13 @@ interface FocalPoint {
|
|
|
666
577
|
/** crop by width */
|
|
667
578
|
width?: number | null;
|
|
668
579
|
}
|
|
669
|
-
interface ItemAvailabilityInfo {
|
|
580
|
+
export interface ItemAvailabilityInfo {
|
|
670
581
|
/** Item availability status. */
|
|
671
582
|
status?: ItemAvailabilityStatus;
|
|
672
583
|
/** Quantity available. */
|
|
673
584
|
quantityAvailable?: number | null;
|
|
674
585
|
}
|
|
675
|
-
declare enum ItemAvailabilityStatus {
|
|
586
|
+
export declare enum ItemAvailabilityStatus {
|
|
676
587
|
AVAILABLE = "AVAILABLE",
|
|
677
588
|
/** Item does not exist. */
|
|
678
589
|
NOT_FOUND = "NOT_FOUND",
|
|
@@ -681,7 +592,7 @@ declare enum ItemAvailabilityStatus {
|
|
|
681
592
|
/** Available quantity is less than requested. */
|
|
682
593
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
683
594
|
}
|
|
684
|
-
interface PhysicalProperties {
|
|
595
|
+
export interface PhysicalProperties {
|
|
685
596
|
/** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
|
|
686
597
|
weight?: number | null;
|
|
687
598
|
/**
|
|
@@ -692,39 +603,39 @@ interface PhysicalProperties {
|
|
|
692
603
|
/** Whether this line item is shippable. */
|
|
693
604
|
shippable?: boolean;
|
|
694
605
|
}
|
|
695
|
-
interface Scope {
|
|
606
|
+
export interface Scope {
|
|
696
607
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
697
608
|
namespace?: string;
|
|
698
609
|
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
699
610
|
group?: Group;
|
|
700
611
|
}
|
|
701
|
-
interface Group {
|
|
612
|
+
export interface Group {
|
|
702
613
|
/** 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). */
|
|
703
614
|
name?: string;
|
|
704
615
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
705
616
|
entityId?: string | null;
|
|
706
617
|
}
|
|
707
|
-
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
618
|
+
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
708
619
|
/** Preset item type. */
|
|
709
620
|
preset?: ItemTypeItemType;
|
|
710
621
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
711
622
|
custom?: string;
|
|
712
623
|
}
|
|
713
624
|
/** @oneof */
|
|
714
|
-
interface ItemTypeItemTypeDataOneOf {
|
|
625
|
+
export interface ItemTypeItemTypeDataOneOf {
|
|
715
626
|
/** Preset item type. */
|
|
716
627
|
preset?: ItemTypeItemType;
|
|
717
628
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
718
629
|
custom?: string;
|
|
719
630
|
}
|
|
720
|
-
declare enum ItemTypeItemType {
|
|
631
|
+
export declare enum ItemTypeItemType {
|
|
721
632
|
UNRECOGNISED = "UNRECOGNISED",
|
|
722
633
|
PHYSICAL = "PHYSICAL",
|
|
723
634
|
DIGITAL = "DIGITAL",
|
|
724
635
|
GIFT_CARD = "GIFT_CARD",
|
|
725
636
|
SERVICE = "SERVICE"
|
|
726
637
|
}
|
|
727
|
-
interface SubscriptionOptionInfo {
|
|
638
|
+
export interface SubscriptionOptionInfo {
|
|
728
639
|
/** Subscription option settings. */
|
|
729
640
|
subscriptionSettings?: SubscriptionSettings;
|
|
730
641
|
/** Subscription option title. */
|
|
@@ -732,7 +643,7 @@ interface SubscriptionOptionInfo {
|
|
|
732
643
|
/** Subscription option description. */
|
|
733
644
|
description?: Description;
|
|
734
645
|
}
|
|
735
|
-
interface SubscriptionSettings {
|
|
646
|
+
export interface SubscriptionSettings {
|
|
736
647
|
/** Frequency of recurring payment. */
|
|
737
648
|
frequency?: SubscriptionFrequency;
|
|
738
649
|
/**
|
|
@@ -751,32 +662,16 @@ interface SubscriptionSettings {
|
|
|
751
662
|
* @min 1
|
|
752
663
|
*/
|
|
753
664
|
billingCycles?: number | null;
|
|
754
|
-
/**
|
|
755
|
-
* Whether to allow the customer to cancel the subscription..
|
|
756
|
-
* @internal
|
|
757
|
-
*/
|
|
758
|
-
enableCustomerCancellation?: boolean;
|
|
759
|
-
/**
|
|
760
|
-
* Period until first cycle starts. If applied payNow will be 0
|
|
761
|
-
* If None => no free trial
|
|
762
|
-
* @internal
|
|
763
|
-
*/
|
|
764
|
-
freeTrialPeriod?: FreeTrialPeriod;
|
|
765
|
-
/**
|
|
766
|
-
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
767
|
-
* @internal
|
|
768
|
-
*/
|
|
769
|
-
startDate?: Date | null;
|
|
770
665
|
}
|
|
771
666
|
/** Frequency unit of recurring payment */
|
|
772
|
-
declare enum SubscriptionFrequency {
|
|
667
|
+
export declare enum SubscriptionFrequency {
|
|
773
668
|
UNDEFINED = "UNDEFINED",
|
|
774
669
|
DAY = "DAY",
|
|
775
670
|
WEEK = "WEEK",
|
|
776
671
|
MONTH = "MONTH",
|
|
777
672
|
YEAR = "YEAR"
|
|
778
673
|
}
|
|
779
|
-
interface FreeTrialPeriod {
|
|
674
|
+
export interface FreeTrialPeriod {
|
|
780
675
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
781
676
|
frequency?: SubscriptionFrequency;
|
|
782
677
|
/**
|
|
@@ -786,7 +681,7 @@ interface FreeTrialPeriod {
|
|
|
786
681
|
*/
|
|
787
682
|
interval?: number;
|
|
788
683
|
}
|
|
789
|
-
interface Title {
|
|
684
|
+
export interface Title {
|
|
790
685
|
/**
|
|
791
686
|
* 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).
|
|
792
687
|
* @minLength 1
|
|
@@ -802,7 +697,7 @@ interface Title {
|
|
|
802
697
|
*/
|
|
803
698
|
translated?: string | null;
|
|
804
699
|
}
|
|
805
|
-
interface Description {
|
|
700
|
+
export interface Description {
|
|
806
701
|
/**
|
|
807
702
|
* Subscription option description.
|
|
808
703
|
* @maxLength 500
|
|
@@ -814,7 +709,7 @@ interface Description {
|
|
|
814
709
|
*/
|
|
815
710
|
translated?: string | null;
|
|
816
711
|
}
|
|
817
|
-
interface SecuredMedia {
|
|
712
|
+
export interface SecuredMedia {
|
|
818
713
|
/**
|
|
819
714
|
* Media ID in Wix Media Manager.
|
|
820
715
|
* @minLength 1
|
|
@@ -830,7 +725,7 @@ interface SecuredMedia {
|
|
|
830
725
|
/** File type. */
|
|
831
726
|
fileType?: FileType;
|
|
832
727
|
}
|
|
833
|
-
declare enum FileType {
|
|
728
|
+
export declare enum FileType {
|
|
834
729
|
UNSPECIFIED = "UNSPECIFIED",
|
|
835
730
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
836
731
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -839,7 +734,7 @@ declare enum FileType {
|
|
|
839
734
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
840
735
|
}
|
|
841
736
|
/** Type of selected payment option for catalog item */
|
|
842
|
-
declare enum PaymentOptionType {
|
|
737
|
+
export declare enum PaymentOptionType {
|
|
843
738
|
/** The entire payment for this item happens as part of the checkout. */
|
|
844
739
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
845
740
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -851,7 +746,7 @@ declare enum PaymentOptionType {
|
|
|
851
746
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
852
747
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
853
748
|
}
|
|
854
|
-
interface ServiceProperties {
|
|
749
|
+
export interface ServiceProperties {
|
|
855
750
|
/**
|
|
856
751
|
* 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.
|
|
857
752
|
* For example, the start time of a class.
|
|
@@ -864,7 +759,7 @@ interface ServiceProperties {
|
|
|
864
759
|
*/
|
|
865
760
|
numberOfParticipants?: number | null;
|
|
866
761
|
}
|
|
867
|
-
interface PriceDescription {
|
|
762
|
+
export interface PriceDescription {
|
|
868
763
|
/**
|
|
869
764
|
* __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).
|
|
870
765
|
* @minLength 1
|
|
@@ -880,7 +775,7 @@ interface PriceDescription {
|
|
|
880
775
|
*/
|
|
881
776
|
translated?: string | null;
|
|
882
777
|
}
|
|
883
|
-
interface CatalogOverrideFields {
|
|
778
|
+
export interface CatalogOverrideFields {
|
|
884
779
|
/** Item name. */
|
|
885
780
|
productName?: ProductName;
|
|
886
781
|
/**
|
|
@@ -917,7 +812,7 @@ interface CatalogOverrideFields {
|
|
|
917
812
|
*/
|
|
918
813
|
savePaymentMethod?: boolean | null;
|
|
919
814
|
}
|
|
920
|
-
interface PaymentOption {
|
|
815
|
+
export interface PaymentOption {
|
|
921
816
|
/**
|
|
922
817
|
* Type of selected payment option for current item.
|
|
923
818
|
*
|
|
@@ -925,22 +820,22 @@ interface PaymentOption {
|
|
|
925
820
|
*/
|
|
926
821
|
value?: PaymentOptionType;
|
|
927
822
|
}
|
|
928
|
-
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
823
|
+
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
929
824
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
930
825
|
addressType?: TaxableAddressType;
|
|
931
826
|
}
|
|
932
827
|
/** @oneof */
|
|
933
|
-
interface TaxableAddressTaxableAddressDataOneOf {
|
|
828
|
+
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
934
829
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
935
830
|
addressType?: TaxableAddressType;
|
|
936
831
|
}
|
|
937
|
-
declare enum TaxableAddressType {
|
|
832
|
+
export declare enum TaxableAddressType {
|
|
938
833
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
939
834
|
BUSINESS = "BUSINESS",
|
|
940
835
|
BILLING = "BILLING",
|
|
941
836
|
SHIPPING = "SHIPPING"
|
|
942
837
|
}
|
|
943
|
-
interface ExtendedFields {
|
|
838
|
+
export interface ExtendedFields {
|
|
944
839
|
/**
|
|
945
840
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
946
841
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -951,7 +846,7 @@ interface ExtendedFields {
|
|
|
951
846
|
*/
|
|
952
847
|
namespaces?: Record<string, Record<string, any>>;
|
|
953
848
|
}
|
|
954
|
-
interface Policy {
|
|
849
|
+
export interface Policy {
|
|
955
850
|
/**
|
|
956
851
|
* Policy title - should be translated
|
|
957
852
|
* @minLength 1
|
|
@@ -965,7 +860,7 @@ interface Policy {
|
|
|
965
860
|
*/
|
|
966
861
|
content?: string;
|
|
967
862
|
}
|
|
968
|
-
interface ModifierGroup {
|
|
863
|
+
export interface ModifierGroup {
|
|
969
864
|
/**
|
|
970
865
|
* Modifier group id.
|
|
971
866
|
* @minLength 1
|
|
@@ -981,7 +876,7 @@ interface ModifierGroup {
|
|
|
981
876
|
*/
|
|
982
877
|
modifiers?: ItemModifier[];
|
|
983
878
|
}
|
|
984
|
-
interface TranslatableString {
|
|
879
|
+
export interface TranslatableString {
|
|
985
880
|
/**
|
|
986
881
|
* __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).
|
|
987
882
|
*
|
|
@@ -1002,7 +897,7 @@ interface TranslatableString {
|
|
|
1002
897
|
*/
|
|
1003
898
|
translated?: string | null;
|
|
1004
899
|
}
|
|
1005
|
-
interface ItemModifier {
|
|
900
|
+
export interface ItemModifier {
|
|
1006
901
|
/**
|
|
1007
902
|
* Modifier ID.
|
|
1008
903
|
* @minLength 1
|
|
@@ -1023,14 +918,14 @@ interface ItemModifier {
|
|
|
1023
918
|
price?: MultiCurrencyPrice;
|
|
1024
919
|
}
|
|
1025
920
|
/** Billing Info and shipping details */
|
|
1026
|
-
interface AddressWithContact {
|
|
921
|
+
export interface AddressWithContact {
|
|
1027
922
|
/** Address. */
|
|
1028
923
|
address?: ApiAddress;
|
|
1029
924
|
/** Contact details. */
|
|
1030
925
|
contactDetails?: FullAddressContactDetails;
|
|
1031
926
|
}
|
|
1032
927
|
/** Physical address */
|
|
1033
|
-
interface ApiAddress {
|
|
928
|
+
export interface ApiAddress {
|
|
1034
929
|
/**
|
|
1035
930
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1036
931
|
* @format COUNTRY
|
|
@@ -1074,20 +969,20 @@ interface ApiAddress {
|
|
|
1074
969
|
*/
|
|
1075
970
|
subdivisionFullname?: string | null;
|
|
1076
971
|
}
|
|
1077
|
-
interface StreetAddress {
|
|
972
|
+
export interface StreetAddress {
|
|
1078
973
|
/** Street number. */
|
|
1079
974
|
number?: string;
|
|
1080
975
|
/** Street name. */
|
|
1081
976
|
name?: string;
|
|
1082
977
|
}
|
|
1083
|
-
interface AddressLocation {
|
|
978
|
+
export interface AddressLocation {
|
|
1084
979
|
/** Address latitude. */
|
|
1085
980
|
latitude?: number | null;
|
|
1086
981
|
/** Address longitude. */
|
|
1087
982
|
longitude?: number | null;
|
|
1088
983
|
}
|
|
1089
984
|
/** Full contact details for an address */
|
|
1090
|
-
interface FullAddressContactDetails {
|
|
985
|
+
export interface FullAddressContactDetails {
|
|
1091
986
|
/**
|
|
1092
987
|
* First name.
|
|
1093
988
|
* @maxLength 100
|
|
@@ -1111,7 +1006,7 @@ interface FullAddressContactDetails {
|
|
|
1111
1006
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1112
1007
|
vatId?: CommonVatId;
|
|
1113
1008
|
}
|
|
1114
|
-
interface CommonVatId {
|
|
1009
|
+
export interface CommonVatId {
|
|
1115
1010
|
/** Customer's tax ID. */
|
|
1116
1011
|
_id?: string;
|
|
1117
1012
|
/**
|
|
@@ -1124,14 +1019,14 @@ interface CommonVatId {
|
|
|
1124
1019
|
type?: CommonVatType;
|
|
1125
1020
|
}
|
|
1126
1021
|
/** tax info types */
|
|
1127
|
-
declare enum CommonVatType {
|
|
1022
|
+
export declare enum CommonVatType {
|
|
1128
1023
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1129
1024
|
/** CPF - for individual tax payers. */
|
|
1130
1025
|
CPF = "CPF",
|
|
1131
1026
|
/** CNPJ - for corporations */
|
|
1132
1027
|
CNPJ = "CNPJ"
|
|
1133
1028
|
}
|
|
1134
|
-
interface ShippingInfo {
|
|
1029
|
+
export interface ShippingInfo {
|
|
1135
1030
|
/** Shipping address and contact details. */
|
|
1136
1031
|
shippingDestination?: AddressWithContact;
|
|
1137
1032
|
/** Selected option out of the options allowed for the `region`. */
|
|
@@ -1147,7 +1042,7 @@ interface ShippingInfo {
|
|
|
1147
1042
|
*/
|
|
1148
1043
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
1149
1044
|
}
|
|
1150
|
-
interface SelectedCarrierServiceOption {
|
|
1045
|
+
export interface SelectedCarrierServiceOption {
|
|
1151
1046
|
/**
|
|
1152
1047
|
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1153
1048
|
* @maxLength 100
|
|
@@ -1190,7 +1085,7 @@ interface SelectedCarrierServiceOption {
|
|
|
1190
1085
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1191
1086
|
partial?: boolean | null;
|
|
1192
1087
|
}
|
|
1193
|
-
interface DeliveryLogistics {
|
|
1088
|
+
export interface DeliveryLogistics {
|
|
1194
1089
|
/**
|
|
1195
1090
|
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1196
1091
|
* @maxLength 500
|
|
@@ -1204,7 +1099,7 @@ interface DeliveryLogistics {
|
|
|
1204
1099
|
/** Pickup details. */
|
|
1205
1100
|
pickupDetails?: PickupDetails;
|
|
1206
1101
|
}
|
|
1207
|
-
interface PickupDetails {
|
|
1102
|
+
export interface PickupDetails {
|
|
1208
1103
|
/** Pickup address. */
|
|
1209
1104
|
address?: ApiAddress;
|
|
1210
1105
|
/**
|
|
@@ -1215,18 +1110,18 @@ interface PickupDetails {
|
|
|
1215
1110
|
/** Pickup method */
|
|
1216
1111
|
pickupMethod?: PickupMethod;
|
|
1217
1112
|
}
|
|
1218
|
-
declare enum PickupMethod {
|
|
1113
|
+
export declare enum PickupMethod {
|
|
1219
1114
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1220
1115
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1221
1116
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1222
1117
|
}
|
|
1223
|
-
interface DeliveryTimeSlot {
|
|
1118
|
+
export interface DeliveryTimeSlot {
|
|
1224
1119
|
/** starting time of the delivery time slot */
|
|
1225
1120
|
from?: Date | null;
|
|
1226
1121
|
/** ending time of the delivery time slot */
|
|
1227
1122
|
to?: Date | null;
|
|
1228
1123
|
}
|
|
1229
|
-
interface SelectedCarrierServiceOptionPrices {
|
|
1124
|
+
export interface SelectedCarrierServiceOptionPrices {
|
|
1230
1125
|
/** Total shipping price, after discount and after tax. */
|
|
1231
1126
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1232
1127
|
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
@@ -1238,7 +1133,7 @@ interface SelectedCarrierServiceOptionPrices {
|
|
|
1238
1133
|
/** Shipping price before discount and before tax. */
|
|
1239
1134
|
price?: MultiCurrencyPrice;
|
|
1240
1135
|
}
|
|
1241
|
-
interface SelectedCarrierServiceOptionOtherCharge {
|
|
1136
|
+
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1242
1137
|
/** Type of additional cost. */
|
|
1243
1138
|
type?: ChargeType;
|
|
1244
1139
|
/**
|
|
@@ -1249,11 +1144,11 @@ interface SelectedCarrierServiceOptionOtherCharge {
|
|
|
1249
1144
|
/** Price of added charge. */
|
|
1250
1145
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
1251
1146
|
}
|
|
1252
|
-
declare enum ChargeType {
|
|
1147
|
+
export declare enum ChargeType {
|
|
1253
1148
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1254
1149
|
INSURANCE = "INSURANCE"
|
|
1255
1150
|
}
|
|
1256
|
-
interface DeliveryAllocation {
|
|
1151
|
+
export interface DeliveryAllocation {
|
|
1257
1152
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1258
1153
|
deliveryCarrier?: Carrier;
|
|
1259
1154
|
/** The delivery region that are relevant for this delivery solution. */
|
|
@@ -1261,7 +1156,7 @@ interface DeliveryAllocation {
|
|
|
1261
1156
|
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
1262
1157
|
applicableLineItems?: ApplicableLineItems;
|
|
1263
1158
|
}
|
|
1264
|
-
interface Carrier {
|
|
1159
|
+
export interface Carrier {
|
|
1265
1160
|
/**
|
|
1266
1161
|
* The carrier app id
|
|
1267
1162
|
* @format GUID
|
|
@@ -1273,7 +1168,7 @@ interface Carrier {
|
|
|
1273
1168
|
*/
|
|
1274
1169
|
code?: string;
|
|
1275
1170
|
}
|
|
1276
|
-
interface Region {
|
|
1171
|
+
export interface Region {
|
|
1277
1172
|
/**
|
|
1278
1173
|
* The delivery region id.
|
|
1279
1174
|
* @format GUID
|
|
@@ -1285,7 +1180,7 @@ interface Region {
|
|
|
1285
1180
|
*/
|
|
1286
1181
|
name?: string | null;
|
|
1287
1182
|
}
|
|
1288
|
-
interface ApplicableLineItems {
|
|
1183
|
+
export interface ApplicableLineItems {
|
|
1289
1184
|
/**
|
|
1290
1185
|
* Line items that the delivery solution is for.
|
|
1291
1186
|
* @maxSize 300
|
|
@@ -1294,7 +1189,7 @@ interface ApplicableLineItems {
|
|
|
1294
1189
|
*/
|
|
1295
1190
|
lineItemIds?: string[];
|
|
1296
1191
|
}
|
|
1297
|
-
interface ShippingRegion {
|
|
1192
|
+
export interface ShippingRegion {
|
|
1298
1193
|
/**
|
|
1299
1194
|
* Shipping region ID.
|
|
1300
1195
|
* @format GUID
|
|
@@ -1307,7 +1202,7 @@ interface ShippingRegion {
|
|
|
1307
1202
|
*/
|
|
1308
1203
|
name?: string;
|
|
1309
1204
|
}
|
|
1310
|
-
interface CarrierServiceOption {
|
|
1205
|
+
export interface CarrierServiceOption {
|
|
1311
1206
|
/**
|
|
1312
1207
|
* Carrier ID.
|
|
1313
1208
|
* @format GUID
|
|
@@ -1316,7 +1211,7 @@ interface CarrierServiceOption {
|
|
|
1316
1211
|
/** Shipping options offered by this carrier for this request. */
|
|
1317
1212
|
shippingOptions?: ShippingOption[];
|
|
1318
1213
|
}
|
|
1319
|
-
interface ShippingOption {
|
|
1214
|
+
export interface ShippingOption {
|
|
1320
1215
|
/**
|
|
1321
1216
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1322
1217
|
* For legacy calculators this would be the UUID of the option.
|
|
@@ -1341,19 +1236,19 @@ interface ShippingOption {
|
|
|
1341
1236
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1342
1237
|
partial?: boolean | null;
|
|
1343
1238
|
}
|
|
1344
|
-
interface ShippingPrice {
|
|
1239
|
+
export interface ShippingPrice {
|
|
1345
1240
|
/** Shipping price. */
|
|
1346
1241
|
price?: MultiCurrencyPrice;
|
|
1347
1242
|
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
1348
1243
|
otherCharges?: OtherCharge[];
|
|
1349
1244
|
}
|
|
1350
|
-
interface OtherCharge {
|
|
1245
|
+
export interface OtherCharge {
|
|
1351
1246
|
/** Type of additional cost. */
|
|
1352
1247
|
type?: ChargeType;
|
|
1353
1248
|
/** Price of added cost. */
|
|
1354
1249
|
price?: MultiCurrencyPrice;
|
|
1355
1250
|
}
|
|
1356
|
-
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1251
|
+
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1357
1252
|
/**
|
|
1358
1253
|
* Visitor ID - if the buyer is **not** a site member.
|
|
1359
1254
|
* @format GUID
|
|
@@ -1379,7 +1274,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1379
1274
|
email?: string | null;
|
|
1380
1275
|
}
|
|
1381
1276
|
/** @oneof */
|
|
1382
|
-
interface BuyerInfoIdOneOf {
|
|
1277
|
+
export interface BuyerInfoIdOneOf {
|
|
1383
1278
|
/**
|
|
1384
1279
|
* Visitor ID - if the buyer is **not** a site member.
|
|
1385
1280
|
* @format GUID
|
|
@@ -1393,7 +1288,7 @@ interface BuyerInfoIdOneOf {
|
|
|
1393
1288
|
*/
|
|
1394
1289
|
memberId?: string;
|
|
1395
1290
|
}
|
|
1396
|
-
interface PriceSummary {
|
|
1291
|
+
export interface PriceSummary {
|
|
1397
1292
|
/** Subtotal of all line items, before discounts and before tax. */
|
|
1398
1293
|
subtotal?: MultiCurrencyPrice;
|
|
1399
1294
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1407,7 +1302,7 @@ interface PriceSummary {
|
|
|
1407
1302
|
/** Total additional fees price before tax. */
|
|
1408
1303
|
additionalFees?: MultiCurrencyPrice;
|
|
1409
1304
|
}
|
|
1410
|
-
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1305
|
+
export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1411
1306
|
/** General shipping calculation error. */
|
|
1412
1307
|
generalShippingCalculationError?: Details;
|
|
1413
1308
|
/** Carrier errors. */
|
|
@@ -1429,13 +1324,13 @@ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOne
|
|
|
1429
1324
|
discountsCalculationError?: Details;
|
|
1430
1325
|
}
|
|
1431
1326
|
/** @oneof */
|
|
1432
|
-
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1327
|
+
export interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1433
1328
|
/** General shipping calculation error. */
|
|
1434
1329
|
generalShippingCalculationError?: Details;
|
|
1435
1330
|
/** Carrier errors. */
|
|
1436
1331
|
carrierErrors?: CarrierErrors;
|
|
1437
1332
|
}
|
|
1438
|
-
interface Details extends DetailsKindOneOf {
|
|
1333
|
+
export interface Details extends DetailsKindOneOf {
|
|
1439
1334
|
applicationError?: ApplicationError;
|
|
1440
1335
|
validationError?: ValidationError;
|
|
1441
1336
|
systemError?: SystemError;
|
|
@@ -1446,12 +1341,12 @@ interface Details extends DetailsKindOneOf {
|
|
|
1446
1341
|
tracing?: Record<string, string>;
|
|
1447
1342
|
}
|
|
1448
1343
|
/** @oneof */
|
|
1449
|
-
interface DetailsKindOneOf {
|
|
1344
|
+
export interface DetailsKindOneOf {
|
|
1450
1345
|
applicationError?: ApplicationError;
|
|
1451
1346
|
validationError?: ValidationError;
|
|
1452
1347
|
systemError?: SystemError;
|
|
1453
1348
|
}
|
|
1454
|
-
interface ApplicationError {
|
|
1349
|
+
export interface ApplicationError {
|
|
1455
1350
|
/** Error code. */
|
|
1456
1351
|
code?: string;
|
|
1457
1352
|
/** Description of the error. */
|
|
@@ -1491,10 +1386,10 @@ interface ApplicationError {
|
|
|
1491
1386
|
* ]
|
|
1492
1387
|
* }
|
|
1493
1388
|
*/
|
|
1494
|
-
interface ValidationError {
|
|
1389
|
+
export interface ValidationError {
|
|
1495
1390
|
fieldViolations?: FieldViolation[];
|
|
1496
1391
|
}
|
|
1497
|
-
declare enum RuleType {
|
|
1392
|
+
export declare enum RuleType {
|
|
1498
1393
|
VALIDATION = "VALIDATION",
|
|
1499
1394
|
OTHER = "OTHER",
|
|
1500
1395
|
MAX = "MAX",
|
|
@@ -1517,7 +1412,7 @@ declare enum RuleType {
|
|
|
1517
1412
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1518
1413
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1519
1414
|
}
|
|
1520
|
-
interface FieldViolation {
|
|
1415
|
+
export interface FieldViolation {
|
|
1521
1416
|
field?: string;
|
|
1522
1417
|
description?: string;
|
|
1523
1418
|
violatedRule?: RuleType;
|
|
@@ -1525,21 +1420,21 @@ interface FieldViolation {
|
|
|
1525
1420
|
ruleName?: string | null;
|
|
1526
1421
|
data?: Record<string, any> | null;
|
|
1527
1422
|
}
|
|
1528
|
-
interface SystemError {
|
|
1423
|
+
export interface SystemError {
|
|
1529
1424
|
/** Error code. */
|
|
1530
1425
|
errorCode?: string | null;
|
|
1531
1426
|
}
|
|
1532
|
-
interface CarrierErrors {
|
|
1427
|
+
export interface CarrierErrors {
|
|
1533
1428
|
/** Carrier errors. */
|
|
1534
1429
|
errors?: CarrierError[];
|
|
1535
1430
|
}
|
|
1536
|
-
interface CarrierError {
|
|
1431
|
+
export interface CarrierError {
|
|
1537
1432
|
/** Carrier ID. */
|
|
1538
1433
|
carrierId?: string;
|
|
1539
1434
|
/** Error details. */
|
|
1540
1435
|
error?: Details;
|
|
1541
1436
|
}
|
|
1542
|
-
interface GiftCard {
|
|
1437
|
+
export interface GiftCard {
|
|
1543
1438
|
/**
|
|
1544
1439
|
* Gift Card ID.
|
|
1545
1440
|
* @deprecated
|
|
@@ -1562,7 +1457,7 @@ interface GiftCard {
|
|
|
1562
1457
|
*/
|
|
1563
1458
|
externalId?: string | null;
|
|
1564
1459
|
}
|
|
1565
|
-
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1460
|
+
export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1566
1461
|
/** Coupon details. */
|
|
1567
1462
|
coupon?: Coupon;
|
|
1568
1463
|
/** Merchant discount. */
|
|
@@ -1579,17 +1474,9 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1579
1474
|
* @targetRemovalDate 2024-06-01
|
|
1580
1475
|
*/
|
|
1581
1476
|
lineItemIds?: string[];
|
|
1582
|
-
/**
|
|
1583
|
-
* Number of subscription cycle this discount applies to
|
|
1584
|
-
* default None - all billing cycle
|
|
1585
|
-
* @internal
|
|
1586
|
-
* @min 1
|
|
1587
|
-
* @max 999
|
|
1588
|
-
*/
|
|
1589
|
-
subscriptionCycles?: number | null;
|
|
1590
1477
|
}
|
|
1591
1478
|
/** @oneof */
|
|
1592
|
-
interface AppliedDiscountDiscountSourceOneOf {
|
|
1479
|
+
export interface AppliedDiscountDiscountSourceOneOf {
|
|
1593
1480
|
/** Coupon details. */
|
|
1594
1481
|
coupon?: Coupon;
|
|
1595
1482
|
/** Merchant discount. */
|
|
@@ -1597,13 +1484,13 @@ interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1597
1484
|
/** Discount rule */
|
|
1598
1485
|
discountRule?: DiscountRule;
|
|
1599
1486
|
}
|
|
1600
|
-
declare enum DiscountType {
|
|
1487
|
+
export declare enum DiscountType {
|
|
1601
1488
|
GLOBAL = "GLOBAL",
|
|
1602
1489
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1603
1490
|
SHIPPING = "SHIPPING"
|
|
1604
1491
|
}
|
|
1605
1492
|
/** Coupon */
|
|
1606
|
-
interface Coupon {
|
|
1493
|
+
export interface Coupon {
|
|
1607
1494
|
/** Coupon ID. */
|
|
1608
1495
|
_id?: string;
|
|
1609
1496
|
/** Coupon code. */
|
|
@@ -1613,7 +1500,7 @@ interface Coupon {
|
|
|
1613
1500
|
/** Coupon name. */
|
|
1614
1501
|
name?: string;
|
|
1615
1502
|
}
|
|
1616
|
-
interface MerchantDiscount {
|
|
1503
|
+
export interface MerchantDiscount {
|
|
1617
1504
|
/** Discount value. */
|
|
1618
1505
|
amount?: MultiCurrencyPrice;
|
|
1619
1506
|
/**
|
|
@@ -1623,7 +1510,7 @@ interface MerchantDiscount {
|
|
|
1623
1510
|
*/
|
|
1624
1511
|
percentage?: number | null;
|
|
1625
1512
|
}
|
|
1626
|
-
interface DiscountRule {
|
|
1513
|
+
export interface DiscountRule {
|
|
1627
1514
|
/**
|
|
1628
1515
|
* Discount rule ID
|
|
1629
1516
|
* @format GUID
|
|
@@ -1634,7 +1521,7 @@ interface DiscountRule {
|
|
|
1634
1521
|
/** Discount value. */
|
|
1635
1522
|
amount?: MultiCurrencyPrice;
|
|
1636
1523
|
}
|
|
1637
|
-
interface DiscountRuleName {
|
|
1524
|
+
export interface DiscountRuleName {
|
|
1638
1525
|
/**
|
|
1639
1526
|
* Original discount rule name (in site's default language).
|
|
1640
1527
|
* @minLength 1
|
|
@@ -1648,7 +1535,7 @@ interface DiscountRuleName {
|
|
|
1648
1535
|
*/
|
|
1649
1536
|
translated?: string | null;
|
|
1650
1537
|
}
|
|
1651
|
-
interface LineItemDiscount {
|
|
1538
|
+
export interface LineItemDiscount {
|
|
1652
1539
|
/**
|
|
1653
1540
|
* ID of line item the discount applies to.
|
|
1654
1541
|
* @format GUID
|
|
@@ -1657,7 +1544,7 @@ interface LineItemDiscount {
|
|
|
1657
1544
|
/** Discount value. */
|
|
1658
1545
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
1659
1546
|
}
|
|
1660
|
-
interface CustomField {
|
|
1547
|
+
export interface CustomField {
|
|
1661
1548
|
/** Custom field value. */
|
|
1662
1549
|
value?: any;
|
|
1663
1550
|
/**
|
|
@@ -1673,7 +1560,7 @@ interface CustomField {
|
|
|
1673
1560
|
*/
|
|
1674
1561
|
translatedTitle?: string | null;
|
|
1675
1562
|
}
|
|
1676
|
-
declare enum WeightUnit {
|
|
1563
|
+
export declare enum WeightUnit {
|
|
1677
1564
|
/** Weight unit can't be classified due to an error. */
|
|
1678
1565
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1679
1566
|
/** Kilograms. */
|
|
@@ -1681,7 +1568,7 @@ declare enum WeightUnit {
|
|
|
1681
1568
|
/** Pounds. */
|
|
1682
1569
|
LB = "LB"
|
|
1683
1570
|
}
|
|
1684
|
-
interface TaxSummary {
|
|
1571
|
+
export interface TaxSummary {
|
|
1685
1572
|
/**
|
|
1686
1573
|
* Amount for which tax is calculated, added from line items.
|
|
1687
1574
|
* @readonly
|
|
@@ -1698,7 +1585,7 @@ interface TaxSummary {
|
|
|
1698
1585
|
*/
|
|
1699
1586
|
calculationDetails?: TaxCalculationDetails;
|
|
1700
1587
|
}
|
|
1701
|
-
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1588
|
+
export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1702
1589
|
/** Reason the manual calculation was used. */
|
|
1703
1590
|
manualRateReason?: ManualCalculationReason;
|
|
1704
1591
|
/** Details of the fallback rate calculation. */
|
|
@@ -1707,13 +1594,13 @@ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsO
|
|
|
1707
1594
|
rateType?: RateType;
|
|
1708
1595
|
}
|
|
1709
1596
|
/** @oneof */
|
|
1710
|
-
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1597
|
+
export interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1711
1598
|
/** Reason the manual calculation was used. */
|
|
1712
1599
|
manualRateReason?: ManualCalculationReason;
|
|
1713
1600
|
/** Details of the fallback rate calculation. */
|
|
1714
1601
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1715
1602
|
}
|
|
1716
|
-
declare enum RateType {
|
|
1603
|
+
export declare enum RateType {
|
|
1717
1604
|
/** no tax being collected for this request due to location of purchase */
|
|
1718
1605
|
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
1719
1606
|
/** manual rate used for calculation */
|
|
@@ -1723,19 +1610,19 @@ declare enum RateType {
|
|
|
1723
1610
|
/** fallback rate used for calculation */
|
|
1724
1611
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1725
1612
|
}
|
|
1726
|
-
declare enum ManualCalculationReason {
|
|
1613
|
+
export declare enum ManualCalculationReason {
|
|
1727
1614
|
/** user set calculator in Business Manager to be Manual */
|
|
1728
1615
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1729
1616
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1730
1617
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1731
1618
|
}
|
|
1732
|
-
interface AutoTaxFallbackCalculationDetails {
|
|
1619
|
+
export interface AutoTaxFallbackCalculationDetails {
|
|
1733
1620
|
/** reason for fallback */
|
|
1734
1621
|
fallbackReason?: FallbackReason;
|
|
1735
1622
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1736
1623
|
error?: ApplicationError;
|
|
1737
1624
|
}
|
|
1738
|
-
declare enum FallbackReason {
|
|
1625
|
+
export declare enum FallbackReason {
|
|
1739
1626
|
/** auto-tax failed to be calculated */
|
|
1740
1627
|
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
1741
1628
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
@@ -1745,7 +1632,7 @@ declare enum FallbackReason {
|
|
|
1745
1632
|
* 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.
|
|
1746
1633
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1747
1634
|
*/
|
|
1748
|
-
interface AggregatedTaxBreakdown {
|
|
1635
|
+
export interface AggregatedTaxBreakdown {
|
|
1749
1636
|
/**
|
|
1750
1637
|
* The name of the tax against which this tax amount was calculated.
|
|
1751
1638
|
* @maxLength 200
|
|
@@ -1771,7 +1658,7 @@ interface AggregatedTaxBreakdown {
|
|
|
1771
1658
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1772
1659
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
1773
1660
|
}
|
|
1774
|
-
declare enum ChannelType {
|
|
1661
|
+
export declare enum ChannelType {
|
|
1775
1662
|
/** Unspecified sales channel. This value is not supported. */
|
|
1776
1663
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1777
1664
|
/** A web client. */
|
|
@@ -1805,7 +1692,7 @@ declare enum ChannelType {
|
|
|
1805
1692
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1806
1693
|
FAIRE_COM = "FAIRE_COM"
|
|
1807
1694
|
}
|
|
1808
|
-
interface CreatedBy extends CreatedByIdOneOf {
|
|
1695
|
+
export interface CreatedBy extends CreatedByIdOneOf {
|
|
1809
1696
|
/**
|
|
1810
1697
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1811
1698
|
* For example, via POS (point of service).
|
|
@@ -1829,7 +1716,7 @@ interface CreatedBy extends CreatedByIdOneOf {
|
|
|
1829
1716
|
appId?: string;
|
|
1830
1717
|
}
|
|
1831
1718
|
/** @oneof */
|
|
1832
|
-
interface CreatedByIdOneOf {
|
|
1719
|
+
export interface CreatedByIdOneOf {
|
|
1833
1720
|
/**
|
|
1834
1721
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1835
1722
|
* For example, via POS (point of service).
|
|
@@ -1853,7 +1740,7 @@ interface CreatedByIdOneOf {
|
|
|
1853
1740
|
appId?: string;
|
|
1854
1741
|
}
|
|
1855
1742
|
/** Reserved for internal use. */
|
|
1856
|
-
interface MembershipOptions {
|
|
1743
|
+
export interface MembershipOptions {
|
|
1857
1744
|
/**
|
|
1858
1745
|
* Reserved for internal use.
|
|
1859
1746
|
* @readonly
|
|
@@ -1869,7 +1756,7 @@ interface MembershipOptions {
|
|
|
1869
1756
|
/** Selected membership to apply to this checkout. */
|
|
1870
1757
|
selectedMemberships?: SelectedMemberships;
|
|
1871
1758
|
}
|
|
1872
|
-
interface Membership {
|
|
1759
|
+
export interface Membership {
|
|
1873
1760
|
/**
|
|
1874
1761
|
* Membership ID.
|
|
1875
1762
|
* @minLength 1
|
|
@@ -1898,7 +1785,7 @@ interface Membership {
|
|
|
1898
1785
|
/** Additional data about this membership. */
|
|
1899
1786
|
additionalData?: Record<string, any> | null;
|
|
1900
1787
|
}
|
|
1901
|
-
interface MembershipName {
|
|
1788
|
+
export interface MembershipName {
|
|
1902
1789
|
/**
|
|
1903
1790
|
* Membership name.
|
|
1904
1791
|
* @maxLength 100
|
|
@@ -1910,7 +1797,7 @@ interface MembershipName {
|
|
|
1910
1797
|
*/
|
|
1911
1798
|
translated?: string | null;
|
|
1912
1799
|
}
|
|
1913
|
-
interface MembershipPaymentCredits {
|
|
1800
|
+
export interface MembershipPaymentCredits {
|
|
1914
1801
|
/**
|
|
1915
1802
|
* Membership's total amount of credits.
|
|
1916
1803
|
* @min 1
|
|
@@ -1919,7 +1806,7 @@ interface MembershipPaymentCredits {
|
|
|
1919
1806
|
/** Membership's remaining amount of credits. */
|
|
1920
1807
|
remaining?: number;
|
|
1921
1808
|
}
|
|
1922
|
-
interface InvalidMembership {
|
|
1809
|
+
export interface InvalidMembership {
|
|
1923
1810
|
/** Membership details. */
|
|
1924
1811
|
membership?: Membership;
|
|
1925
1812
|
/**
|
|
@@ -1929,14 +1816,14 @@ interface InvalidMembership {
|
|
|
1929
1816
|
*/
|
|
1930
1817
|
reason?: string;
|
|
1931
1818
|
}
|
|
1932
|
-
interface SelectedMemberships {
|
|
1819
|
+
export interface SelectedMemberships {
|
|
1933
1820
|
/**
|
|
1934
1821
|
* Selected memberships.
|
|
1935
1822
|
* @maxSize 300
|
|
1936
1823
|
*/
|
|
1937
1824
|
memberships?: SelectedMembership[];
|
|
1938
1825
|
}
|
|
1939
|
-
interface SelectedMembership {
|
|
1826
|
+
export interface SelectedMembership {
|
|
1940
1827
|
/**
|
|
1941
1828
|
* Membership ID.
|
|
1942
1829
|
* @minLength 1
|
|
@@ -1957,7 +1844,7 @@ interface SelectedMembership {
|
|
|
1957
1844
|
*/
|
|
1958
1845
|
lineItemIds?: string[];
|
|
1959
1846
|
}
|
|
1960
|
-
interface AdditionalFee {
|
|
1847
|
+
export interface AdditionalFee {
|
|
1961
1848
|
/**
|
|
1962
1849
|
* Additional fee's unique code (or ID) for future processing.
|
|
1963
1850
|
* @minLength 1
|
|
@@ -1990,18 +1877,10 @@ interface AdditionalFee {
|
|
|
1990
1877
|
* @format GUID
|
|
1991
1878
|
*/
|
|
1992
1879
|
lineItemIds?: string[];
|
|
1993
|
-
/**
|
|
1994
|
-
* Number of subscription cycle this fee applies to
|
|
1995
|
-
* default None - all billing cycle
|
|
1996
|
-
* @internal
|
|
1997
|
-
* @min 1
|
|
1998
|
-
* @max 999
|
|
1999
|
-
*/
|
|
2000
|
-
subscriptionCycles?: number | null;
|
|
2001
1880
|
/** the source the additional fee was added from */
|
|
2002
1881
|
source?: AdditionalFeeSource;
|
|
2003
1882
|
}
|
|
2004
|
-
declare enum AdditionalFeeSource {
|
|
1883
|
+
export declare enum AdditionalFeeSource {
|
|
2005
1884
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
2006
1885
|
/** The additional fee was added by an additional fee service plugin */
|
|
2007
1886
|
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
@@ -2010,7 +1889,7 @@ declare enum AdditionalFeeSource {
|
|
|
2010
1889
|
/** The additional fee was added manually on the request */
|
|
2011
1890
|
MANUAL = "MANUAL"
|
|
2012
1891
|
}
|
|
2013
|
-
interface ConversionInfo {
|
|
1892
|
+
export interface ConversionInfo {
|
|
2014
1893
|
/**
|
|
2015
1894
|
* The site currency.
|
|
2016
1895
|
* @readonly
|
|
@@ -2024,7 +1903,7 @@ interface ConversionInfo {
|
|
|
2024
1903
|
*/
|
|
2025
1904
|
conversionRate?: string;
|
|
2026
1905
|
}
|
|
2027
|
-
interface Violation {
|
|
1906
|
+
export interface Violation {
|
|
2028
1907
|
/** 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. */
|
|
2029
1908
|
severity?: Severity;
|
|
2030
1909
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
@@ -2036,7 +1915,7 @@ interface Violation {
|
|
|
2036
1915
|
*/
|
|
2037
1916
|
description?: string | null;
|
|
2038
1917
|
}
|
|
2039
|
-
declare enum Severity {
|
|
1918
|
+
export declare enum Severity {
|
|
2040
1919
|
/** The user is allowed to move forward in the flow. */
|
|
2041
1920
|
WARNING = "WARNING",
|
|
2042
1921
|
/**
|
|
@@ -2045,53 +1924,48 @@ declare enum Severity {
|
|
|
2045
1924
|
*/
|
|
2046
1925
|
ERROR = "ERROR"
|
|
2047
1926
|
}
|
|
2048
|
-
interface Target extends TargetTargetTypeOneOf {
|
|
1927
|
+
export interface Target extends TargetTargetTypeOneOf {
|
|
2049
1928
|
/** General (other) violation. */
|
|
2050
1929
|
other?: Other;
|
|
2051
1930
|
/** Specific line item violation. */
|
|
2052
1931
|
lineItem?: TargetLineItem;
|
|
2053
1932
|
}
|
|
2054
1933
|
/** @oneof */
|
|
2055
|
-
interface TargetTargetTypeOneOf {
|
|
1934
|
+
export interface TargetTargetTypeOneOf {
|
|
2056
1935
|
/** General (other) violation. */
|
|
2057
1936
|
other?: Other;
|
|
2058
1937
|
/** Specific line item violation. */
|
|
2059
1938
|
lineItem?: TargetLineItem;
|
|
2060
1939
|
}
|
|
2061
1940
|
/** Available locations on the webpage */
|
|
2062
|
-
declare enum NameInOther {
|
|
1941
|
+
export declare enum NameInOther {
|
|
2063
1942
|
/** Default location, in case no specific location is specified. */
|
|
2064
1943
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
2065
1944
|
}
|
|
2066
1945
|
/** Available locations on the line item */
|
|
2067
|
-
declare enum NameInLineItem {
|
|
1946
|
+
export declare enum NameInLineItem {
|
|
2068
1947
|
/** Default location, in case no specific location is specified. */
|
|
2069
1948
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
2070
1949
|
}
|
|
2071
|
-
declare enum SuggestedFix {
|
|
1950
|
+
export declare enum SuggestedFix {
|
|
2072
1951
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
2073
1952
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
2074
1953
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
2075
1954
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
2076
1955
|
}
|
|
2077
1956
|
/** General (other) violation. */
|
|
2078
|
-
interface Other {
|
|
1957
|
+
export interface Other {
|
|
2079
1958
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
2080
1959
|
name?: NameInOther;
|
|
2081
1960
|
}
|
|
2082
1961
|
/** Specific line item violation. */
|
|
2083
|
-
interface TargetLineItem {
|
|
1962
|
+
export interface TargetLineItem {
|
|
2084
1963
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
2085
1964
|
name?: NameInLineItem;
|
|
2086
1965
|
/** ID of the line item containing the violation. */
|
|
2087
1966
|
_id?: string | null;
|
|
2088
|
-
/**
|
|
2089
|
-
* Suggested fix for resolving the line item violation.
|
|
2090
|
-
* @internal
|
|
2091
|
-
*/
|
|
2092
|
-
suggestedFix?: SuggestedFix;
|
|
2093
1967
|
}
|
|
2094
|
-
interface CustomSettings {
|
|
1968
|
+
export interface CustomSettings {
|
|
2095
1969
|
/**
|
|
2096
1970
|
* Whether to restrict the option to add or remove a gift card on the checkout page.
|
|
2097
1971
|
*
|
|
@@ -2117,7 +1991,7 @@ interface CustomSettings {
|
|
|
2117
1991
|
*/
|
|
2118
1992
|
disabledManualPayment?: boolean;
|
|
2119
1993
|
}
|
|
2120
|
-
interface CustomContentReference {
|
|
1994
|
+
export interface CustomContentReference {
|
|
2121
1995
|
/**
|
|
2122
1996
|
* ID of the app providing the content.
|
|
2123
1997
|
*
|
|
@@ -2133,7 +2007,7 @@ interface CustomContentReference {
|
|
|
2133
2007
|
*/
|
|
2134
2008
|
componentId?: string;
|
|
2135
2009
|
}
|
|
2136
|
-
interface ExternalReference {
|
|
2010
|
+
export interface ExternalReference {
|
|
2137
2011
|
/**
|
|
2138
2012
|
* ID of the app associated with the purchase flow.
|
|
2139
2013
|
* For example, the Wix Pay Links app ID.
|
|
@@ -2150,7 +2024,7 @@ interface ExternalReference {
|
|
|
2150
2024
|
*/
|
|
2151
2025
|
resourceId?: string | null;
|
|
2152
2026
|
}
|
|
2153
|
-
interface SubscriptionCharges {
|
|
2027
|
+
export interface SubscriptionCharges {
|
|
2154
2028
|
/**
|
|
2155
2029
|
* ids of the items the subscription is defined on
|
|
2156
2030
|
* @format GUID
|
|
@@ -2170,7 +2044,7 @@ interface SubscriptionCharges {
|
|
|
2170
2044
|
*/
|
|
2171
2045
|
charges?: Charge[];
|
|
2172
2046
|
}
|
|
2173
|
-
interface Charge {
|
|
2047
|
+
export interface Charge {
|
|
2174
2048
|
/** The cycle number from which the charge starts. */
|
|
2175
2049
|
cycleFrom?: number;
|
|
2176
2050
|
/** The number of cycles for which the charge is applicable. */
|
|
@@ -2180,13 +2054,13 @@ interface Charge {
|
|
|
2180
2054
|
/** The billing date from which the charge starts. */
|
|
2181
2055
|
cycleBillingDate?: Date | null;
|
|
2182
2056
|
}
|
|
2183
|
-
interface UpdatedCheckoutMessage {
|
|
2057
|
+
export interface UpdatedCheckoutMessage {
|
|
2184
2058
|
/** Previous checkout. */
|
|
2185
2059
|
oldCheckout?: Checkout;
|
|
2186
2060
|
/** Updated checkout. */
|
|
2187
2061
|
updatedCheckout?: Checkout;
|
|
2188
2062
|
}
|
|
2189
|
-
interface CreateCheckoutRequest {
|
|
2063
|
+
export interface CreateCheckoutRequest {
|
|
2190
2064
|
/** Checkout information. */
|
|
2191
2065
|
checkoutInfo?: Checkout;
|
|
2192
2066
|
/** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
@@ -2222,7 +2096,7 @@ interface CreateCheckoutRequest {
|
|
|
2222
2096
|
*/
|
|
2223
2097
|
overrideCheckoutUrl?: string | null;
|
|
2224
2098
|
}
|
|
2225
|
-
interface CustomLineItem {
|
|
2099
|
+
export interface CustomLineItem {
|
|
2226
2100
|
/**
|
|
2227
2101
|
* Custom line item quantity.
|
|
2228
2102
|
*
|
|
@@ -2321,20 +2195,6 @@ interface CustomLineItem {
|
|
|
2321
2195
|
deliveryProfileId?: string | null;
|
|
2322
2196
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
|
|
2323
2197
|
catalogReference?: CatalogReference;
|
|
2324
|
-
/**
|
|
2325
|
-
* Whether the price is not yet defined, and will be updated after the order is created.
|
|
2326
|
-
*
|
|
2327
|
-
* Default: `false`
|
|
2328
|
-
* @internal
|
|
2329
|
-
*/
|
|
2330
|
-
priceUndetermined?: boolean;
|
|
2331
|
-
/**
|
|
2332
|
-
* Whether the line item quantity is fixed and cannot be changed.
|
|
2333
|
-
*
|
|
2334
|
-
* Default: `false`
|
|
2335
|
-
* @internal
|
|
2336
|
-
*/
|
|
2337
|
-
fixedQuantity?: boolean;
|
|
2338
2198
|
/**
|
|
2339
2199
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
2340
2200
|
* @minLength 1
|
|
@@ -2349,32 +2209,8 @@ interface CustomLineItem {
|
|
|
2349
2209
|
* @readonly
|
|
2350
2210
|
*/
|
|
2351
2211
|
savePaymentMethod?: boolean;
|
|
2352
|
-
/**
|
|
2353
|
-
* Policies to be displayed to the customer on the checkout page.
|
|
2354
|
-
* @internal
|
|
2355
|
-
* @maxSize 5
|
|
2356
|
-
*/
|
|
2357
|
-
policies?: Policy[];
|
|
2358
|
-
/**
|
|
2359
|
-
* ID of the app managing the inventory.
|
|
2360
|
-
* @internal
|
|
2361
|
-
* @format GUID
|
|
2362
|
-
*/
|
|
2363
|
-
inventoryAppId?: string | null;
|
|
2364
|
-
/**
|
|
2365
|
-
* Whether the item can only be purchased by site members.
|
|
2366
|
-
*
|
|
2367
|
-
* Default: `false`
|
|
2368
|
-
* @internal
|
|
2369
|
-
*/
|
|
2370
|
-
membersOnly?: boolean;
|
|
2371
|
-
/**
|
|
2372
|
-
* Address to use for tax calculation purposes.
|
|
2373
|
-
* @internal
|
|
2374
|
-
*/
|
|
2375
|
-
taxableAddress?: TaxableAddress;
|
|
2376
2212
|
}
|
|
2377
|
-
interface MerchantDiscountInput {
|
|
2213
|
+
export interface MerchantDiscountInput {
|
|
2378
2214
|
/**
|
|
2379
2215
|
* Discount amount.
|
|
2380
2216
|
* @decimalValue options { gte:0 }
|
|
@@ -2387,75 +2223,75 @@ interface MerchantDiscountInput {
|
|
|
2387
2223
|
*/
|
|
2388
2224
|
lineItemIds?: string[];
|
|
2389
2225
|
}
|
|
2390
|
-
interface CreateCheckoutResponse {
|
|
2226
|
+
export interface CreateCheckoutResponse {
|
|
2391
2227
|
/** Newly created checkout. */
|
|
2392
2228
|
checkout?: Checkout;
|
|
2393
2229
|
}
|
|
2394
|
-
interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2230
|
+
export interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2395
2231
|
generalShippingCalculationError?: Details;
|
|
2396
2232
|
carrierErrors?: CarrierErrors;
|
|
2397
2233
|
}
|
|
2398
2234
|
/** @oneof */
|
|
2399
|
-
interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2235
|
+
export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2400
2236
|
generalShippingCalculationError?: Details;
|
|
2401
2237
|
carrierErrors?: CarrierErrors;
|
|
2402
2238
|
}
|
|
2403
|
-
interface GetCheckoutRequest {
|
|
2239
|
+
export interface GetCheckoutRequest {
|
|
2404
2240
|
/**
|
|
2405
2241
|
* Checkout ID.
|
|
2406
2242
|
* @format GUID
|
|
2407
2243
|
*/
|
|
2408
2244
|
_id: string;
|
|
2409
2245
|
}
|
|
2410
|
-
interface GetCheckoutResponse {
|
|
2246
|
+
export interface GetCheckoutResponse {
|
|
2411
2247
|
/** Retrieved checkout. */
|
|
2412
2248
|
checkout?: Checkout;
|
|
2413
2249
|
}
|
|
2414
|
-
interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
2250
|
+
export interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
2415
2251
|
/**
|
|
2416
2252
|
* Checkout ID.
|
|
2417
2253
|
* @format GUID
|
|
2418
2254
|
*/
|
|
2419
2255
|
_id?: string;
|
|
2420
2256
|
}
|
|
2421
|
-
interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2257
|
+
export interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2422
2258
|
/** Retrieved checkout. */
|
|
2423
2259
|
checkout?: Checkout;
|
|
2424
2260
|
}
|
|
2425
|
-
interface GetCheckoutByCartIdRequest {
|
|
2261
|
+
export interface GetCheckoutByCartIdRequest {
|
|
2426
2262
|
/**
|
|
2427
2263
|
* Cart ID.
|
|
2428
2264
|
* @format GUID
|
|
2429
2265
|
*/
|
|
2430
2266
|
_id: string;
|
|
2431
2267
|
}
|
|
2432
|
-
interface GetCheckoutByCartIdResponse {
|
|
2268
|
+
export interface GetCheckoutByCartIdResponse {
|
|
2433
2269
|
/** Retrieved checkout. */
|
|
2434
2270
|
checkout?: Checkout;
|
|
2435
2271
|
}
|
|
2436
|
-
interface GetWixCheckoutURLRequest {
|
|
2272
|
+
export interface GetWixCheckoutURLRequest {
|
|
2437
2273
|
/**
|
|
2438
2274
|
* Checkout ID.
|
|
2439
2275
|
* @format GUID
|
|
2440
2276
|
*/
|
|
2441
2277
|
_id: string;
|
|
2442
2278
|
}
|
|
2443
|
-
interface GetWixCheckoutURLResponse {
|
|
2279
|
+
export interface GetWixCheckoutURLResponse {
|
|
2444
2280
|
/** Checkout URL. */
|
|
2445
2281
|
checkoutUrl?: string;
|
|
2446
2282
|
}
|
|
2447
|
-
interface GetCheckoutURLRequest {
|
|
2283
|
+
export interface GetCheckoutURLRequest {
|
|
2448
2284
|
/**
|
|
2449
2285
|
* Checkout ID.
|
|
2450
2286
|
* @format GUID
|
|
2451
2287
|
*/
|
|
2452
2288
|
_id: string;
|
|
2453
2289
|
}
|
|
2454
|
-
interface GetCheckoutURLResponse {
|
|
2290
|
+
export interface GetCheckoutURLResponse {
|
|
2455
2291
|
/** Checkout URL. */
|
|
2456
2292
|
checkoutUrl?: string;
|
|
2457
2293
|
}
|
|
2458
|
-
interface UpdateCheckoutRequest {
|
|
2294
|
+
export interface UpdateCheckoutRequest {
|
|
2459
2295
|
/** Checkout information. */
|
|
2460
2296
|
checkout: Checkout;
|
|
2461
2297
|
/** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
@@ -2483,44 +2319,44 @@ interface UpdateCheckoutRequest {
|
|
|
2483
2319
|
*/
|
|
2484
2320
|
customLineItems?: CustomLineItem[];
|
|
2485
2321
|
}
|
|
2486
|
-
interface UpdateCheckoutResponse {
|
|
2322
|
+
export interface UpdateCheckoutResponse {
|
|
2487
2323
|
/** Updated checkout. */
|
|
2488
2324
|
checkout?: Checkout;
|
|
2489
2325
|
}
|
|
2490
|
-
interface RemoveCouponRequest {
|
|
2326
|
+
export interface RemoveCouponRequest {
|
|
2491
2327
|
/**
|
|
2492
2328
|
* ID of the checkout to remove the coupon from.
|
|
2493
2329
|
* @format GUID
|
|
2494
2330
|
*/
|
|
2495
2331
|
_id: string;
|
|
2496
2332
|
}
|
|
2497
|
-
interface RemoveCouponResponse {
|
|
2333
|
+
export interface RemoveCouponResponse {
|
|
2498
2334
|
/** Updated checkout after removal of coupon. */
|
|
2499
2335
|
checkout?: Checkout;
|
|
2500
2336
|
}
|
|
2501
|
-
interface RemoveGiftCardRequest {
|
|
2337
|
+
export interface RemoveGiftCardRequest {
|
|
2502
2338
|
/**
|
|
2503
2339
|
* ID of the checkout to remove the gift card from.
|
|
2504
2340
|
* @format GUID
|
|
2505
2341
|
*/
|
|
2506
2342
|
_id: string;
|
|
2507
2343
|
}
|
|
2508
|
-
interface RemoveGiftCardResponse {
|
|
2344
|
+
export interface RemoveGiftCardResponse {
|
|
2509
2345
|
/** Updated checkout after removal of gift card. */
|
|
2510
2346
|
checkout?: Checkout;
|
|
2511
2347
|
}
|
|
2512
|
-
interface RemoveOverrideCheckoutUrlRequest {
|
|
2348
|
+
export interface RemoveOverrideCheckoutUrlRequest {
|
|
2513
2349
|
/**
|
|
2514
2350
|
* ID of the checkout to remove the override checkout url from.
|
|
2515
2351
|
* @format GUID
|
|
2516
2352
|
*/
|
|
2517
2353
|
_id: string;
|
|
2518
2354
|
}
|
|
2519
|
-
interface RemoveOverrideCheckoutUrlResponse {
|
|
2355
|
+
export interface RemoveOverrideCheckoutUrlResponse {
|
|
2520
2356
|
/** Updated checkout after removal of override checkout url. */
|
|
2521
2357
|
checkout?: Checkout;
|
|
2522
2358
|
}
|
|
2523
|
-
interface AddToCheckoutRequest {
|
|
2359
|
+
export interface AddToCheckoutRequest {
|
|
2524
2360
|
/**
|
|
2525
2361
|
* Checkout ID.
|
|
2526
2362
|
* @format GUID
|
|
@@ -2540,11 +2376,11 @@ interface AddToCheckoutRequest {
|
|
|
2540
2376
|
*/
|
|
2541
2377
|
customLineItems?: CustomLineItem[];
|
|
2542
2378
|
}
|
|
2543
|
-
interface AddToCheckoutResponse {
|
|
2379
|
+
export interface AddToCheckoutResponse {
|
|
2544
2380
|
/** Updated checkout. */
|
|
2545
2381
|
checkout?: Checkout;
|
|
2546
2382
|
}
|
|
2547
|
-
interface RemoveLineItemsRequest {
|
|
2383
|
+
export interface RemoveLineItemsRequest {
|
|
2548
2384
|
/**
|
|
2549
2385
|
* ID of the checkout to remove line items from.
|
|
2550
2386
|
* @format GUID
|
|
@@ -2558,11 +2394,11 @@ interface RemoveLineItemsRequest {
|
|
|
2558
2394
|
*/
|
|
2559
2395
|
lineItemIds: string[];
|
|
2560
2396
|
}
|
|
2561
|
-
interface RemoveLineItemsResponse {
|
|
2397
|
+
export interface RemoveLineItemsResponse {
|
|
2562
2398
|
/** Updated checkout after removal of line items. */
|
|
2563
2399
|
checkout?: Checkout;
|
|
2564
2400
|
}
|
|
2565
|
-
interface CreateOrderRequest {
|
|
2401
|
+
export interface CreateOrderRequest {
|
|
2566
2402
|
/**
|
|
2567
2403
|
* Checkout ID.
|
|
2568
2404
|
* @format GUID
|
|
@@ -2573,7 +2409,7 @@ interface CreateOrderRequest {
|
|
|
2573
2409
|
/** Whether to authorize the payment and delay the capture. */
|
|
2574
2410
|
delayCapture?: boolean;
|
|
2575
2411
|
}
|
|
2576
|
-
interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
2412
|
+
export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
2577
2413
|
/**
|
|
2578
2414
|
* ID of the newly created order.
|
|
2579
2415
|
* @format GUID
|
|
@@ -2596,7 +2432,7 @@ interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
|
2596
2432
|
paymentGatewayOrderId?: string | null;
|
|
2597
2433
|
}
|
|
2598
2434
|
/** @oneof */
|
|
2599
|
-
interface CreateOrderResponseIdOneOf {
|
|
2435
|
+
export interface CreateOrderResponseIdOneOf {
|
|
2600
2436
|
/**
|
|
2601
2437
|
* ID of newly created order.
|
|
2602
2438
|
* @format GUID
|
|
@@ -2608,32 +2444,32 @@ interface CreateOrderResponseIdOneOf {
|
|
|
2608
2444
|
*/
|
|
2609
2445
|
subscriptionId?: string;
|
|
2610
2446
|
}
|
|
2611
|
-
interface PaymentErrorResponseData {
|
|
2447
|
+
export interface PaymentErrorResponseData {
|
|
2612
2448
|
paymentResponseToken?: string | null;
|
|
2613
2449
|
transactionStatus?: string;
|
|
2614
2450
|
failureDetails?: string | null;
|
|
2615
2451
|
}
|
|
2616
|
-
interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
|
|
2452
|
+
export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
|
|
2617
2453
|
/** @format GUID */
|
|
2618
2454
|
orderId?: string;
|
|
2619
2455
|
/** @format GUID */
|
|
2620
2456
|
subscriptionId?: string;
|
|
2621
2457
|
}
|
|
2622
2458
|
/** @oneof */
|
|
2623
|
-
interface DoublePaymentErrorDataIdOneOf {
|
|
2459
|
+
export interface DoublePaymentErrorDataIdOneOf {
|
|
2624
2460
|
/** @format GUID */
|
|
2625
2461
|
orderId?: string;
|
|
2626
2462
|
/** @format GUID */
|
|
2627
2463
|
subscriptionId?: string;
|
|
2628
2464
|
}
|
|
2629
|
-
interface RedeemErrorData {
|
|
2465
|
+
export interface RedeemErrorData {
|
|
2630
2466
|
reason?: string;
|
|
2631
2467
|
}
|
|
2632
|
-
interface ViolationsList {
|
|
2468
|
+
export interface ViolationsList {
|
|
2633
2469
|
/** Violations risen by ValidationsSPI implementers. */
|
|
2634
2470
|
violations?: Violation[];
|
|
2635
2471
|
}
|
|
2636
|
-
interface CreateOrderAndChargeRequest {
|
|
2472
|
+
export interface CreateOrderAndChargeRequest {
|
|
2637
2473
|
/**
|
|
2638
2474
|
* Checkout ID.
|
|
2639
2475
|
* @format GUID
|
|
@@ -2646,7 +2482,7 @@ interface CreateOrderAndChargeRequest {
|
|
|
2646
2482
|
/** Whether to authorize the payment and delay the capture. */
|
|
2647
2483
|
delayCapture?: boolean;
|
|
2648
2484
|
}
|
|
2649
|
-
interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
2485
|
+
export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
2650
2486
|
/**
|
|
2651
2487
|
* ID of newly created order.
|
|
2652
2488
|
* @format GUID
|
|
@@ -2668,15 +2504,9 @@ interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOne
|
|
|
2668
2504
|
* + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
|
|
2669
2505
|
*/
|
|
2670
2506
|
paymentGatewayOrderId?: string | null;
|
|
2671
|
-
/**
|
|
2672
|
-
* Whether an order was successfully created from this checkout and the payment transaction was completed
|
|
2673
|
-
* @internal
|
|
2674
|
-
* @readonly
|
|
2675
|
-
*/
|
|
2676
|
-
checkoutCompleted?: boolean;
|
|
2677
2507
|
}
|
|
2678
2508
|
/** @oneof */
|
|
2679
|
-
interface CreateOrderAndChargeResponseIdOneOf {
|
|
2509
|
+
export interface CreateOrderAndChargeResponseIdOneOf {
|
|
2680
2510
|
/**
|
|
2681
2511
|
* ID of newly created order.
|
|
2682
2512
|
* @format GUID
|
|
@@ -2688,42 +2518,36 @@ interface CreateOrderAndChargeResponseIdOneOf {
|
|
|
2688
2518
|
*/
|
|
2689
2519
|
subscriptionId?: string;
|
|
2690
2520
|
}
|
|
2691
|
-
interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
|
|
2521
|
+
export interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
|
|
2692
2522
|
/**
|
|
2693
2523
|
* Server-signed JWT token with required information to complete checkout
|
|
2694
2524
|
* @maxLength 4096
|
|
2695
2525
|
*/
|
|
2696
2526
|
token: string;
|
|
2697
2527
|
}
|
|
2698
|
-
interface RawHttpResponse {
|
|
2528
|
+
export interface RawHttpResponse {
|
|
2699
2529
|
body?: Uint8Array;
|
|
2700
2530
|
statusCode?: number | null;
|
|
2701
2531
|
headers?: HeadersEntry[];
|
|
2702
2532
|
}
|
|
2703
|
-
interface HeadersEntry {
|
|
2533
|
+
export interface HeadersEntry {
|
|
2704
2534
|
key?: string;
|
|
2705
2535
|
value?: string;
|
|
2706
2536
|
}
|
|
2707
|
-
interface MarkCheckoutAsCompletedRequest {
|
|
2537
|
+
export interface MarkCheckoutAsCompletedRequest {
|
|
2708
2538
|
/**
|
|
2709
2539
|
* Checkout ID.
|
|
2710
2540
|
* @format GUID
|
|
2711
2541
|
*/
|
|
2712
2542
|
_id: string;
|
|
2713
|
-
/**
|
|
2714
|
-
* Order ID.
|
|
2715
|
-
* @internal
|
|
2716
|
-
* @format GUID
|
|
2717
|
-
*/
|
|
2718
|
-
orderId?: string | null;
|
|
2719
2543
|
}
|
|
2720
|
-
interface MarkCheckoutAsCompletedResponse {
|
|
2544
|
+
export interface MarkCheckoutAsCompletedResponse {
|
|
2721
2545
|
}
|
|
2722
2546
|
/** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
|
|
2723
|
-
interface CheckoutMarkedAsCompleted {
|
|
2547
|
+
export interface CheckoutMarkedAsCompleted {
|
|
2724
2548
|
checkout?: Checkout;
|
|
2725
2549
|
}
|
|
2726
|
-
interface UpdateLineItemsQuantityRequest {
|
|
2550
|
+
export interface UpdateLineItemsQuantityRequest {
|
|
2727
2551
|
/**
|
|
2728
2552
|
* Checkout ID.
|
|
2729
2553
|
* @format GUID
|
|
@@ -2736,7 +2560,7 @@ interface UpdateLineItemsQuantityRequest {
|
|
|
2736
2560
|
*/
|
|
2737
2561
|
lineItems: LineItemQuantityUpdate[];
|
|
2738
2562
|
}
|
|
2739
|
-
interface LineItemQuantityUpdate {
|
|
2563
|
+
export interface LineItemQuantityUpdate {
|
|
2740
2564
|
/**
|
|
2741
2565
|
* ID of the line item to update.
|
|
2742
2566
|
* @format GUID
|
|
@@ -2754,37 +2578,37 @@ interface LineItemQuantityUpdate {
|
|
|
2754
2578
|
*/
|
|
2755
2579
|
quantity?: number;
|
|
2756
2580
|
}
|
|
2757
|
-
interface UpdateLineItemsQuantityResponse {
|
|
2581
|
+
export interface UpdateLineItemsQuantityResponse {
|
|
2758
2582
|
/** Updated checkout. */
|
|
2759
2583
|
checkout?: Checkout;
|
|
2760
2584
|
}
|
|
2761
|
-
interface GetCheckoutPaymentSettingsRequest {
|
|
2585
|
+
export interface GetCheckoutPaymentSettingsRequest {
|
|
2762
2586
|
/**
|
|
2763
2587
|
* Checkout ID.
|
|
2764
2588
|
* @format GUID
|
|
2765
2589
|
*/
|
|
2766
2590
|
_id: string;
|
|
2767
2591
|
}
|
|
2768
|
-
interface GetCheckoutPaymentSettingsResponse {
|
|
2592
|
+
export interface GetCheckoutPaymentSettingsResponse {
|
|
2769
2593
|
blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOption[];
|
|
2770
2594
|
}
|
|
2771
|
-
declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2595
|
+
export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2772
2596
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
2773
2597
|
MANUAL = "MANUAL"
|
|
2774
2598
|
}
|
|
2775
|
-
interface DeleteCheckoutRequest {
|
|
2599
|
+
export interface DeleteCheckoutRequest {
|
|
2776
2600
|
/**
|
|
2777
2601
|
* ID of the checkout to delete.
|
|
2778
2602
|
* @format GUID
|
|
2779
2603
|
*/
|
|
2780
2604
|
_id?: string;
|
|
2781
2605
|
}
|
|
2782
|
-
interface DeleteCheckoutResponse {
|
|
2606
|
+
export interface DeleteCheckoutResponse {
|
|
2783
2607
|
}
|
|
2784
|
-
interface SubscriptionCreated {
|
|
2608
|
+
export interface SubscriptionCreated {
|
|
2785
2609
|
subscription?: Subscription;
|
|
2786
2610
|
}
|
|
2787
|
-
interface Subscription {
|
|
2611
|
+
export interface Subscription {
|
|
2788
2612
|
/**
|
|
2789
2613
|
* Subscription id (auto-generated upon subscription creation)
|
|
2790
2614
|
* @readonly
|
|
@@ -2848,7 +2672,7 @@ interface Subscription {
|
|
|
2848
2672
|
billingInfo?: BillingInfo;
|
|
2849
2673
|
}
|
|
2850
2674
|
/** Buyer Info */
|
|
2851
|
-
interface V1BuyerInfo {
|
|
2675
|
+
export interface V1BuyerInfo {
|
|
2852
2676
|
/**
|
|
2853
2677
|
* Wix customer ID
|
|
2854
2678
|
* @format GUID
|
|
@@ -2857,14 +2681,14 @@ interface V1BuyerInfo {
|
|
|
2857
2681
|
/** Customer type */
|
|
2858
2682
|
identityType?: IdentityType;
|
|
2859
2683
|
}
|
|
2860
|
-
declare enum IdentityType {
|
|
2684
|
+
export declare enum IdentityType {
|
|
2861
2685
|
UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
|
|
2862
2686
|
/** Site member */
|
|
2863
2687
|
MEMBER = "MEMBER",
|
|
2864
2688
|
/** Contact */
|
|
2865
2689
|
CONTACT = "CONTACT"
|
|
2866
2690
|
}
|
|
2867
|
-
interface V1LineItem {
|
|
2691
|
+
export interface V1LineItem {
|
|
2868
2692
|
/** Line item ID (auto-generated) */
|
|
2869
2693
|
index?: number;
|
|
2870
2694
|
/**
|
|
@@ -2893,7 +2717,7 @@ interface V1LineItem {
|
|
|
2893
2717
|
/** Product details */
|
|
2894
2718
|
productDetails?: ProductDetails;
|
|
2895
2719
|
}
|
|
2896
|
-
interface OptionSelection {
|
|
2720
|
+
export interface OptionSelection {
|
|
2897
2721
|
/**
|
|
2898
2722
|
* Option name
|
|
2899
2723
|
* @maxLength 200
|
|
@@ -2905,7 +2729,7 @@ interface OptionSelection {
|
|
|
2905
2729
|
*/
|
|
2906
2730
|
selection?: string;
|
|
2907
2731
|
}
|
|
2908
|
-
interface CustomTextFieldSelection {
|
|
2732
|
+
export interface CustomTextFieldSelection {
|
|
2909
2733
|
/**
|
|
2910
2734
|
* Custom text field name
|
|
2911
2735
|
* @maxLength 100
|
|
@@ -2917,7 +2741,7 @@ interface CustomTextFieldSelection {
|
|
|
2917
2741
|
*/
|
|
2918
2742
|
value?: string;
|
|
2919
2743
|
}
|
|
2920
|
-
interface ChargeDetails {
|
|
2744
|
+
export interface ChargeDetails {
|
|
2921
2745
|
/**
|
|
2922
2746
|
* price of line item (depends on subscription option)
|
|
2923
2747
|
* @max 999999999.99
|
|
@@ -2946,7 +2770,7 @@ interface ChargeDetails {
|
|
|
2946
2770
|
*/
|
|
2947
2771
|
taxRate?: string | null;
|
|
2948
2772
|
}
|
|
2949
|
-
interface ProductDetails {
|
|
2773
|
+
export interface ProductDetails {
|
|
2950
2774
|
/**
|
|
2951
2775
|
* Line item product ID (optional for POS orders)
|
|
2952
2776
|
* @minLength 1
|
|
@@ -2999,7 +2823,7 @@ interface ProductDetails {
|
|
|
2999
2823
|
*/
|
|
3000
2824
|
appId?: string | null;
|
|
3001
2825
|
}
|
|
3002
|
-
declare enum LineItemType {
|
|
2826
|
+
export declare enum LineItemType {
|
|
3003
2827
|
/** Line item type can't be classified, due to an error */
|
|
3004
2828
|
UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
|
|
3005
2829
|
/** Physical item type */
|
|
@@ -3009,7 +2833,7 @@ declare enum LineItemType {
|
|
|
3009
2833
|
/** Custom item price */
|
|
3010
2834
|
CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
|
|
3011
2835
|
}
|
|
3012
|
-
interface MediaItem {
|
|
2836
|
+
export interface MediaItem {
|
|
3013
2837
|
/**
|
|
3014
2838
|
* Media type
|
|
3015
2839
|
* @readonly
|
|
@@ -3043,13 +2867,13 @@ interface MediaItem {
|
|
|
3043
2867
|
*/
|
|
3044
2868
|
altText?: string | null;
|
|
3045
2869
|
}
|
|
3046
|
-
declare enum MediaItemType {
|
|
2870
|
+
export declare enum MediaItemType {
|
|
3047
2871
|
/** Media item type can't be classified, due to an error */
|
|
3048
2872
|
UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
|
|
3049
2873
|
/** Image item type */
|
|
3050
2874
|
IMAGE = "IMAGE"
|
|
3051
2875
|
}
|
|
3052
|
-
interface Totals {
|
|
2876
|
+
export interface Totals {
|
|
3053
2877
|
/**
|
|
3054
2878
|
* Subtotal of all line items, before tax
|
|
3055
2879
|
* @max 999999999.99
|
|
@@ -3086,7 +2910,7 @@ interface Totals {
|
|
|
3086
2910
|
*/
|
|
3087
2911
|
quantity?: number;
|
|
3088
2912
|
}
|
|
3089
|
-
interface StoreSettings {
|
|
2913
|
+
export interface StoreSettings {
|
|
3090
2914
|
/**
|
|
3091
2915
|
* Currency used for pricing in this store
|
|
3092
2916
|
* @maxLength 3
|
|
@@ -3104,7 +2928,7 @@ interface StoreSettings {
|
|
|
3104
2928
|
*/
|
|
3105
2929
|
buyerLanguage?: string | null;
|
|
3106
2930
|
}
|
|
3107
|
-
interface Address extends AddressAddressLine1OptionsOneOf {
|
|
2931
|
+
export interface Address extends AddressAddressLine1OptionsOneOf {
|
|
3108
2932
|
/**
|
|
3109
2933
|
* Address line 1 (free text)
|
|
3110
2934
|
* @maxLength 1000
|
|
@@ -3158,7 +2982,7 @@ interface Address extends AddressAddressLine1OptionsOneOf {
|
|
|
3158
2982
|
vatId?: VatId;
|
|
3159
2983
|
}
|
|
3160
2984
|
/** @oneof */
|
|
3161
|
-
interface AddressAddressLine1OptionsOneOf {
|
|
2985
|
+
export interface AddressAddressLine1OptionsOneOf {
|
|
3162
2986
|
/**
|
|
3163
2987
|
* Address line 1 (free text)
|
|
3164
2988
|
* @maxLength 1000
|
|
@@ -3167,7 +2991,7 @@ interface AddressAddressLine1OptionsOneOf {
|
|
|
3167
2991
|
/** Address line 1 (street) */
|
|
3168
2992
|
street?: Street;
|
|
3169
2993
|
}
|
|
3170
|
-
interface FullName {
|
|
2994
|
+
export interface FullName {
|
|
3171
2995
|
/**
|
|
3172
2996
|
* Customer's first name
|
|
3173
2997
|
* @maxLength 1000
|
|
@@ -3179,7 +3003,7 @@ interface FullName {
|
|
|
3179
3003
|
*/
|
|
3180
3004
|
lastName?: string;
|
|
3181
3005
|
}
|
|
3182
|
-
interface Street {
|
|
3006
|
+
export interface Street {
|
|
3183
3007
|
/**
|
|
3184
3008
|
* Street number
|
|
3185
3009
|
* @maxLength 500
|
|
@@ -3191,7 +3015,7 @@ interface Street {
|
|
|
3191
3015
|
*/
|
|
3192
3016
|
name?: string;
|
|
3193
3017
|
}
|
|
3194
|
-
interface VatId {
|
|
3018
|
+
export interface VatId {
|
|
3195
3019
|
/**
|
|
3196
3020
|
* Customer's tax ID.
|
|
3197
3021
|
* @maxLength 50
|
|
@@ -3205,7 +3029,7 @@ interface VatId {
|
|
|
3205
3029
|
type?: VatType;
|
|
3206
3030
|
}
|
|
3207
3031
|
/** Brazilian tax info types */
|
|
3208
|
-
declare enum VatType {
|
|
3032
|
+
export declare enum VatType {
|
|
3209
3033
|
/** When the tax info type can't be classified, due to an error */
|
|
3210
3034
|
UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
|
|
3211
3035
|
/** CPF - for individual tax payers */
|
|
@@ -3213,7 +3037,7 @@ declare enum VatType {
|
|
|
3213
3037
|
/** CNPJ - for corporations */
|
|
3214
3038
|
CNPJ = "CNPJ"
|
|
3215
3039
|
}
|
|
3216
|
-
interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3040
|
+
export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3217
3041
|
/** Shipment details (when this object describes shipment) */
|
|
3218
3042
|
shipmentDetails?: ShipmentDetails;
|
|
3219
3043
|
/** Pickup details (when this object describes pickup) */
|
|
@@ -3230,13 +3054,13 @@ interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
|
3230
3054
|
estimatedDeliveryTime?: string | null;
|
|
3231
3055
|
}
|
|
3232
3056
|
/** @oneof */
|
|
3233
|
-
interface V1ShippingInfoDetailsOneOf {
|
|
3057
|
+
export interface V1ShippingInfoDetailsOneOf {
|
|
3234
3058
|
/** Shipment details (when this object describes shipment) */
|
|
3235
3059
|
shipmentDetails?: ShipmentDetails;
|
|
3236
3060
|
/** Pickup details (when this object describes pickup) */
|
|
3237
3061
|
pickupDetails?: V1PickupDetails;
|
|
3238
3062
|
}
|
|
3239
|
-
interface ShipmentDetails {
|
|
3063
|
+
export interface ShipmentDetails {
|
|
3240
3064
|
/** Shipping destination address */
|
|
3241
3065
|
address?: Address;
|
|
3242
3066
|
/**
|
|
@@ -3257,7 +3081,7 @@ interface ShipmentDetails {
|
|
|
3257
3081
|
*/
|
|
3258
3082
|
taxRate?: string | null;
|
|
3259
3083
|
}
|
|
3260
|
-
interface V1PickupDetails {
|
|
3084
|
+
export interface V1PickupDetails {
|
|
3261
3085
|
/** Pickup address */
|
|
3262
3086
|
address?: PickupAddress;
|
|
3263
3087
|
/**
|
|
@@ -3266,7 +3090,7 @@ interface V1PickupDetails {
|
|
|
3266
3090
|
*/
|
|
3267
3091
|
pickupInstructions?: string | null;
|
|
3268
3092
|
}
|
|
3269
|
-
interface PickupAddress {
|
|
3093
|
+
export interface PickupAddress {
|
|
3270
3094
|
/**
|
|
3271
3095
|
* Country code (2 letters)
|
|
3272
3096
|
* @format COUNTRY
|
|
@@ -3293,7 +3117,7 @@ interface PickupAddress {
|
|
|
3293
3117
|
*/
|
|
3294
3118
|
zipCode?: string;
|
|
3295
3119
|
}
|
|
3296
|
-
interface AppliedCoupon {
|
|
3120
|
+
export interface AppliedCoupon {
|
|
3297
3121
|
/** Coupon ID */
|
|
3298
3122
|
couponId?: string;
|
|
3299
3123
|
/**
|
|
@@ -3308,7 +3132,7 @@ interface AppliedCoupon {
|
|
|
3308
3132
|
code?: string;
|
|
3309
3133
|
}
|
|
3310
3134
|
/** Custom field */
|
|
3311
|
-
interface V1CustomField {
|
|
3135
|
+
export interface V1CustomField {
|
|
3312
3136
|
/**
|
|
3313
3137
|
* Free text that the customer entered in the custom field during the checkout process
|
|
3314
3138
|
* @maxLength 250
|
|
@@ -3325,7 +3149,7 @@ interface V1CustomField {
|
|
|
3325
3149
|
*/
|
|
3326
3150
|
translatedTitle?: string;
|
|
3327
3151
|
}
|
|
3328
|
-
interface V1SubscriptionOptionInfo {
|
|
3152
|
+
export interface V1SubscriptionOptionInfo {
|
|
3329
3153
|
/** @format GUID */
|
|
3330
3154
|
_id?: string | null;
|
|
3331
3155
|
/**
|
|
@@ -3337,29 +3161,29 @@ interface V1SubscriptionOptionInfo {
|
|
|
3337
3161
|
description?: string | null;
|
|
3338
3162
|
discount?: Discount;
|
|
3339
3163
|
}
|
|
3340
|
-
interface Discount {
|
|
3164
|
+
export interface Discount {
|
|
3341
3165
|
/** Discount type. */
|
|
3342
3166
|
type?: DiscountDiscountType;
|
|
3343
3167
|
/** Discount value. */
|
|
3344
3168
|
value?: number;
|
|
3345
3169
|
}
|
|
3346
|
-
declare enum DiscountDiscountType {
|
|
3170
|
+
export declare enum DiscountDiscountType {
|
|
3347
3171
|
UNDEFINED = "UNDEFINED",
|
|
3348
3172
|
/** No discount */
|
|
3349
3173
|
AMOUNT = "AMOUNT",
|
|
3350
3174
|
PERCENT = "PERCENT"
|
|
3351
3175
|
}
|
|
3352
|
-
interface ChannelInfo {
|
|
3176
|
+
export interface ChannelInfo {
|
|
3353
3177
|
/** Sales channel that submitted the subscription */
|
|
3354
3178
|
type?: ChannelInfoChannelType;
|
|
3355
3179
|
}
|
|
3356
|
-
declare enum ChannelInfoChannelType {
|
|
3180
|
+
export declare enum ChannelInfoChannelType {
|
|
3357
3181
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3358
3182
|
WEB = "WEB",
|
|
3359
3183
|
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
3360
3184
|
WIX_APP_STORE = "WIX_APP_STORE"
|
|
3361
3185
|
}
|
|
3362
|
-
interface V1SubscriptionSettings {
|
|
3186
|
+
export interface V1SubscriptionSettings {
|
|
3363
3187
|
/** Frequency of recurring payment. */
|
|
3364
3188
|
frequency?: SubscriptionFrequency;
|
|
3365
3189
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
@@ -3371,7 +3195,7 @@ interface V1SubscriptionSettings {
|
|
|
3371
3195
|
*/
|
|
3372
3196
|
billingCycles?: number | null;
|
|
3373
3197
|
}
|
|
3374
|
-
interface BillingInfo {
|
|
3198
|
+
export interface BillingInfo {
|
|
3375
3199
|
/**
|
|
3376
3200
|
* Payment method used for this order
|
|
3377
3201
|
* @maxLength 50
|
|
@@ -3388,9 +3212,9 @@ interface BillingInfo {
|
|
|
3388
3212
|
*/
|
|
3389
3213
|
paymentGatewayOrderId?: string | null;
|
|
3390
3214
|
}
|
|
3391
|
-
interface Empty {
|
|
3215
|
+
export interface Empty {
|
|
3392
3216
|
}
|
|
3393
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3217
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3394
3218
|
createdEvent?: EntityCreatedEvent;
|
|
3395
3219
|
updatedEvent?: EntityUpdatedEvent;
|
|
3396
3220
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3433,19 +3257,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3433
3257
|
entityEventSequence?: string | null;
|
|
3434
3258
|
}
|
|
3435
3259
|
/** @oneof */
|
|
3436
|
-
interface DomainEventBodyOneOf {
|
|
3260
|
+
export interface DomainEventBodyOneOf {
|
|
3437
3261
|
createdEvent?: EntityCreatedEvent;
|
|
3438
3262
|
updatedEvent?: EntityUpdatedEvent;
|
|
3439
3263
|
deletedEvent?: EntityDeletedEvent;
|
|
3440
3264
|
actionEvent?: ActionEvent;
|
|
3441
3265
|
}
|
|
3442
|
-
interface EntityCreatedEvent {
|
|
3266
|
+
export interface EntityCreatedEvent {
|
|
3443
3267
|
entity?: string;
|
|
3444
3268
|
}
|
|
3445
|
-
interface RestoreInfo {
|
|
3269
|
+
export interface RestoreInfo {
|
|
3446
3270
|
deletedDate?: Date | null;
|
|
3447
3271
|
}
|
|
3448
|
-
interface EntityUpdatedEvent {
|
|
3272
|
+
export interface EntityUpdatedEvent {
|
|
3449
3273
|
/**
|
|
3450
3274
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3451
3275
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -3453,14 +3277,14 @@ interface EntityUpdatedEvent {
|
|
|
3453
3277
|
*/
|
|
3454
3278
|
currentEntity?: string;
|
|
3455
3279
|
}
|
|
3456
|
-
interface EntityDeletedEvent {
|
|
3280
|
+
export interface EntityDeletedEvent {
|
|
3457
3281
|
/** Entity that was deleted */
|
|
3458
3282
|
deletedEntity?: string | null;
|
|
3459
3283
|
}
|
|
3460
|
-
interface ActionEvent {
|
|
3284
|
+
export interface ActionEvent {
|
|
3461
3285
|
body?: string;
|
|
3462
3286
|
}
|
|
3463
|
-
interface MessageEnvelope {
|
|
3287
|
+
export interface MessageEnvelope {
|
|
3464
3288
|
/**
|
|
3465
3289
|
* App instance ID.
|
|
3466
3290
|
* @format GUID
|
|
@@ -3476,7 +3300,7 @@ interface MessageEnvelope {
|
|
|
3476
3300
|
/** Stringify payload. */
|
|
3477
3301
|
data?: string;
|
|
3478
3302
|
}
|
|
3479
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3303
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3480
3304
|
/**
|
|
3481
3305
|
* ID of a site visitor that has not logged in to the site.
|
|
3482
3306
|
* @format GUID
|
|
@@ -3501,7 +3325,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3501
3325
|
identityType?: WebhookIdentityType;
|
|
3502
3326
|
}
|
|
3503
3327
|
/** @oneof */
|
|
3504
|
-
interface IdentificationDataIdOneOf {
|
|
3328
|
+
export interface IdentificationDataIdOneOf {
|
|
3505
3329
|
/**
|
|
3506
3330
|
* ID of a site visitor that has not logged in to the site.
|
|
3507
3331
|
* @format GUID
|
|
@@ -3523,14 +3347,14 @@ interface IdentificationDataIdOneOf {
|
|
|
3523
3347
|
*/
|
|
3524
3348
|
appId?: string;
|
|
3525
3349
|
}
|
|
3526
|
-
declare enum WebhookIdentityType {
|
|
3350
|
+
export declare enum WebhookIdentityType {
|
|
3527
3351
|
UNKNOWN = "UNKNOWN",
|
|
3528
3352
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3529
3353
|
MEMBER = "MEMBER",
|
|
3530
3354
|
WIX_USER = "WIX_USER",
|
|
3531
3355
|
APP = "APP"
|
|
3532
3356
|
}
|
|
3533
|
-
interface BaseEventMetadata {
|
|
3357
|
+
export interface BaseEventMetadata {
|
|
3534
3358
|
/**
|
|
3535
3359
|
* App instance ID.
|
|
3536
3360
|
* @format GUID
|
|
@@ -3544,7 +3368,7 @@ interface BaseEventMetadata {
|
|
|
3544
3368
|
/** The identification type and identity data. */
|
|
3545
3369
|
identity?: IdentificationData;
|
|
3546
3370
|
}
|
|
3547
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
3371
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
3548
3372
|
/**
|
|
3549
3373
|
* Unique event ID.
|
|
3550
3374
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -3582,19 +3406,142 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
3582
3406
|
*/
|
|
3583
3407
|
entityEventSequence?: string | null;
|
|
3584
3408
|
}
|
|
3585
|
-
interface CheckoutCompletedEnvelope {
|
|
3409
|
+
export interface CheckoutCompletedEnvelope {
|
|
3586
3410
|
data: CheckoutMarkedAsCompleted;
|
|
3587
3411
|
metadata: EventMetadata;
|
|
3588
3412
|
}
|
|
3589
|
-
|
|
3413
|
+
/**
|
|
3414
|
+
* Triggered when an order created from this checkout is
|
|
3415
|
+
* successfully paid for or when a checkout is marked as completed.
|
|
3416
|
+
* @permissionScope Manage Stores - all permissions
|
|
3417
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3418
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
3419
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
3420
|
+
* @permissionScope Read Orders
|
|
3421
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
3422
|
+
* @permissionScope Read Stores - all read permissions
|
|
3423
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
3424
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3425
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3426
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3427
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3428
|
+
* @permissionScope Manage Orders
|
|
3429
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3430
|
+
* @permissionId ECOM.READ_CHECKOUTS
|
|
3431
|
+
* @webhook
|
|
3432
|
+
* @eventType wix.ecom.v1.checkout_completed
|
|
3433
|
+
* @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
|
|
3434
|
+
* @slug completed
|
|
3435
|
+
*/
|
|
3436
|
+
export declare function onCheckoutCompleted(handler: (event: CheckoutCompletedEnvelope) => void | Promise<void>): void;
|
|
3437
|
+
export interface CheckoutCreatedEnvelope {
|
|
3590
3438
|
entity: Checkout;
|
|
3591
3439
|
metadata: EventMetadata;
|
|
3592
3440
|
}
|
|
3593
|
-
|
|
3441
|
+
/**
|
|
3442
|
+
* Triggered when a checkout is created.
|
|
3443
|
+
* @permissionScope Manage Stores - all permissions
|
|
3444
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3445
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
3446
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
3447
|
+
* @permissionScope Read Orders
|
|
3448
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
3449
|
+
* @permissionScope Read Stores - all read permissions
|
|
3450
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
3451
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3452
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3453
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3454
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3455
|
+
* @permissionScope Manage Orders
|
|
3456
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3457
|
+
* @permissionId ECOM.READ_CHECKOUTS
|
|
3458
|
+
* @webhook
|
|
3459
|
+
* @eventType wix.ecom.v1.checkout_created
|
|
3460
|
+
* @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
|
|
3461
|
+
* @slug created
|
|
3462
|
+
*/
|
|
3463
|
+
export declare function onCheckoutCreated(handler: (event: CheckoutCreatedEnvelope) => void | Promise<void>): void;
|
|
3464
|
+
export interface CheckoutUpdatedEnvelope {
|
|
3594
3465
|
entity: Checkout;
|
|
3595
3466
|
metadata: EventMetadata;
|
|
3596
3467
|
}
|
|
3597
|
-
|
|
3468
|
+
/**
|
|
3469
|
+
* Triggered when a checkout is updated.
|
|
3470
|
+
* @permissionScope Manage Stores - all permissions
|
|
3471
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3472
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
3473
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
3474
|
+
* @permissionScope Read Orders
|
|
3475
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
3476
|
+
* @permissionScope Read Stores - all read permissions
|
|
3477
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
3478
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3479
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3480
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3481
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3482
|
+
* @permissionScope Manage Orders
|
|
3483
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3484
|
+
* @permissionId ECOM.READ_CHECKOUTS
|
|
3485
|
+
* @webhook
|
|
3486
|
+
* @eventType wix.ecom.v1.checkout_updated
|
|
3487
|
+
* @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
|
|
3488
|
+
* @slug updated
|
|
3489
|
+
*/
|
|
3490
|
+
export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelope) => void | Promise<void>): void;
|
|
3491
|
+
type CheckoutNonNullablePaths = `lineItems` | `lineItems.${number}.quantity` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.productName.original` | `lineItems.${number}.price.amount` | `lineItems.${number}.price.convertedAmount` | `lineItems.${number}.price.formattedAmount` | `lineItems.${number}.price.formattedConvertedAmount` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxDetails.rateBreakdown` | `lineItems.${number}.taxDetails.rateBreakdown.${number}.name` | `lineItems.${number}.taxDetails.rateBreakdown.${number}.rate` | `lineItems.${number}.descriptionLines` | `lineItems.${number}.descriptionLines.${number}.plainText.original` | `lineItems.${number}.descriptionLines.${number}.colorInfo.original` | `lineItems.${number}.descriptionLines.${number}.name.original` | `lineItems.${number}.availability.status` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionOptionInfo.title.original` | `lineItems.${number}.subscriptionOptionInfo.description.original` | `lineItems.${number}.paymentOption` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.customLineItem` | `lineItems.${number}.catalogOverrideFields.descriptionLines` | `lineItems.${number}.catalogOverrideFields.paymentOption.value` | `lineItems.${number}.savePaymentMethod` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.shippingDestination.address.streetAddress.number` | `shippingInfo.shippingDestination.address.streetAddress.name` | `shippingInfo.shippingDestination.contactDetails.vatId._id` | `shippingInfo.shippingDestination.contactDetails.vatId.type` | `shippingInfo.selectedCarrierServiceOption.code` | `shippingInfo.selectedCarrierServiceOption.title` | `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.businessLocation` | `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.pickupMethod` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.amount` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.convertedAmount` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.formattedAmount` | `shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax.formattedConvertedAmount` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.taxRate` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.rateBreakdown` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.rateBreakdown.${number}.name` | `shippingInfo.selectedCarrierServiceOption.cost.taxDetails.rateBreakdown.${number}.rate` | `shippingInfo.selectedCarrierServiceOption.requestedShippingOption` | `shippingInfo.selectedCarrierServiceOption.otherCharges` | `shippingInfo.selectedCarrierServiceOption.otherCharges.${number}.type` | `shippingInfo.selectedCarrierServiceOption.deliveryAllocations` | `shippingInfo.selectedCarrierServiceOption.deliveryAllocations.${number}.deliveryCarrier.code` | `shippingInfo.selectedCarrierServiceOption.deliveryAllocations.${number}.applicableLineItems.lineItemIds` | `shippingInfo.region._id` | `shippingInfo.region.name` | `shippingInfo.carrierServiceOptions` | `shippingInfo.carrierServiceOptions.${number}.carrierId` | `shippingInfo.carrierServiceOptions.${number}.shippingOptions` | `shippingInfo.carrierServiceOptions.${number}.shippingOptions.${number}.code` | `shippingInfo.carrierServiceOptions.${number}.shippingOptions.${number}.title` | `shippingInfo.carrierServiceOptions.${number}.shippingOptions.${number}.cost.otherCharges` | `shippingInfo.carrierServiceOptions.${number}.shippingOptions.${number}.cost.otherCharges.${number}.type` | `shippingInfo.carrierServiceOptions.${number}.shippingOptions.${number}.deliveryAllocations` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `conversionCurrency` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.convertedAmount` | `priceSummary.subtotal.formattedAmount` | `priceSummary.subtotal.formattedConvertedAmount` | `calculationErrors.generalShippingCalculationError.applicationError.code` | `calculationErrors.generalShippingCalculationError.applicationError.description` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculationErrors.carrierErrors.errors` | `calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculationErrors.orderValidationErrors` | `giftCard._id` | `giftCard.obfuscatedCode` | `giftCard.amount.amount` | `giftCard.amount.convertedAmount` | `giftCard.amount.formattedAmount` | `giftCard.amount.formattedConvertedAmount` | `giftCard.appId` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.convertedAmount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.coupon.amount.formattedConvertedAmount` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `appliedDiscounts.${number}.lineItemIds` | `customFields` | `customFields.${number}.title` | `weightUnit` | `taxSummary.taxableAmount.amount` | `taxSummary.taxableAmount.convertedAmount` | `taxSummary.taxableAmount.formattedAmount` | `taxSummary.taxableAmount.formattedConvertedAmount` | `taxSummary.calculationDetails.manualRateReason` | `taxSummary.calculationDetails.autoTaxFallbackDetails.fallbackReason` | `taxSummary.calculationDetails.autoTaxFallbackDetails.error.code` | `taxSummary.calculationDetails.autoTaxFallbackDetails.error.description` | `taxSummary.calculationDetails.rateType` | `currency` | `channelType` | `siteLanguage` | `buyerLanguage` | `completed` | `taxIncludedInPrice` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `payNow.subtotal.amount` | `payNow.subtotal.convertedAmount` | `payNow.subtotal.formattedAmount` | `payNow.subtotal.formattedConvertedAmount` | `payLater.subtotal.amount` | `payLater.subtotal.convertedAmount` | `payLater.subtotal.formattedAmount` | `payLater.subtotal.formattedConvertedAmount` | `membershipOptions.eligibleMemberships` | `membershipOptions.eligibleMemberships.${number}._id` | `membershipOptions.eligibleMemberships.${number}.appId` | `membershipOptions.eligibleMemberships.${number}.name.original` | `membershipOptions.eligibleMemberships.${number}.lineItemIds` | `membershipOptions.eligibleMemberships.${number}.credits.total` | `membershipOptions.eligibleMemberships.${number}.credits.remaining` | `membershipOptions.invalidMemberships` | `membershipOptions.invalidMemberships.${number}.reason` | `membershipOptions.selectedMemberships.memberships` | `membershipOptions.selectedMemberships.memberships.${number}._id` | `membershipOptions.selectedMemberships.memberships.${number}.appId` | `membershipOptions.selectedMemberships.memberships.${number}.lineItemIds` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.convertedAmount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.price.formattedConvertedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}.taxDetails.rateBreakdown` | `additionalFees.${number}.taxDetails.rateBreakdown.${number}.name` | `additionalFees.${number}.taxDetails.rateBreakdown.${number}.rate` | `additionalFees.${number}.lineItemIds` | `additionalFees.${number}.source` | `violations` | `violations.${number}.severity` | `violations.${number}.target.other.name` | `violations.${number}.target.lineItem.name` | `customSettings.lockGiftCard` | `customSettings.lockCouponCode` | `customSettings.disabledPolicyAgreementCheckbox` | `customSettings.disabledManualPayment` | `customContentReference.appId` | `customContentReference.componentId` | `externalReference.appId`;
|
|
3492
|
+
/**
|
|
3493
|
+
* Creates a checkout.
|
|
3494
|
+
*
|
|
3495
|
+
*
|
|
3496
|
+
* The `createCheckout()` function returns a Promise that resolves to the new checkout when it's created.
|
|
3497
|
+
*
|
|
3498
|
+
* > **Notes:**
|
|
3499
|
+
* > + Checkout must include at least 1 item in the `options.lineItems` array.
|
|
3500
|
+
* > + `options.channelType` is required.
|
|
3501
|
+
* > + If `_id` for `options.lineItems` is added, make sure that each `_id` is unique.
|
|
3502
|
+
* > + If `options.checkoutInfo.customFields` are added, then `options.checkoutInfo.customFields.value` is required.
|
|
3503
|
+
* @public
|
|
3504
|
+
* @requiredField options.channelType
|
|
3505
|
+
* @requiredField options.checkoutInfo.customFields.value
|
|
3506
|
+
* @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id
|
|
3507
|
+
* @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId
|
|
3508
|
+
* @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds
|
|
3509
|
+
* @requiredField options.customLineItems.descriptionLines.name
|
|
3510
|
+
* @requiredField options.customLineItems.descriptionLines.value
|
|
3511
|
+
* @requiredField options.customLineItems.itemType
|
|
3512
|
+
* @requiredField options.customLineItems.price
|
|
3513
|
+
* @requiredField options.customLineItems.productName
|
|
3514
|
+
* @requiredField options.customLineItems.quantity
|
|
3515
|
+
* @requiredField options.lineItems.catalogReference
|
|
3516
|
+
* @requiredField options.lineItems.catalogReference.appId
|
|
3517
|
+
* @requiredField options.lineItems.catalogReference.catalogItemId
|
|
3518
|
+
* @requiredField options.lineItems.quantity
|
|
3519
|
+
* @param options - Checkout creation options.
|
|
3520
|
+
* @permissionId ECOM.MODIFY_CHECKOUTS
|
|
3521
|
+
* @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
|
|
3522
|
+
* @permissionScope Manage Stores - all permissions
|
|
3523
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3524
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3525
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3526
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3527
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3528
|
+
* @permissionScope Manage Orders
|
|
3529
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3530
|
+
* @permissionScope Manage Stores - all permissions
|
|
3531
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3532
|
+
* @permissionScope Manage eCommerce - Admin Permissions
|
|
3533
|
+
* @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
|
|
3534
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3535
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3536
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3537
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3538
|
+
* @applicableIdentity APP
|
|
3539
|
+
* @applicableIdentity VISITOR
|
|
3540
|
+
* @returns Fulfilled - the newly created checkout.
|
|
3541
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateCheckout
|
|
3542
|
+
*/
|
|
3543
|
+
export declare function createCheckout(options?: NonNullablePaths<CreateCheckoutOptions, `channelType` | `checkoutInfo.customFields.${number}.value` | `checkoutInfo.membershipOptions.selectedMemberships.memberships.${number}._id` | `checkoutInfo.membershipOptions.selectedMemberships.memberships.${number}.appId` | `checkoutInfo.membershipOptions.selectedMemberships.memberships.${number}.lineItemIds` | `customLineItems.${number}.descriptionLines` | `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.price` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.quantity`>): Promise<NonNullablePaths<Checkout, CheckoutNonNullablePaths>>;
|
|
3544
|
+
export interface CreateCheckoutOptions {
|
|
3598
3545
|
/** Checkout information. */
|
|
3599
3546
|
checkoutInfo?: Checkout;
|
|
3600
3547
|
/** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
@@ -3630,7 +3577,142 @@ interface CreateCheckoutOptions {
|
|
|
3630
3577
|
*/
|
|
3631
3578
|
overrideCheckoutUrl?: string | null;
|
|
3632
3579
|
}
|
|
3633
|
-
|
|
3580
|
+
/**
|
|
3581
|
+
* Retrieves a checkout.
|
|
3582
|
+
*
|
|
3583
|
+
*
|
|
3584
|
+
* The `getCheckout()` function returns a Promise that resolves when the specified checkout is retrieved.
|
|
3585
|
+
* @param _id - Checkout ID.
|
|
3586
|
+
* @public
|
|
3587
|
+
* @requiredField _id
|
|
3588
|
+
* @permissionId ECOM.READ_CHECKOUTS
|
|
3589
|
+
* @permissionScope Manage Stores - all permissions
|
|
3590
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3591
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
3592
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
3593
|
+
* @permissionScope Read Orders
|
|
3594
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
3595
|
+
* @permissionScope Read Stores - all read permissions
|
|
3596
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
3597
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3598
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3599
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3600
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3601
|
+
* @permissionScope Manage Orders
|
|
3602
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3603
|
+
* @applicableIdentity APP
|
|
3604
|
+
* @applicableIdentity VISITOR
|
|
3605
|
+
* @returns Fulfilled - the requested checkout.
|
|
3606
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckout
|
|
3607
|
+
*/
|
|
3608
|
+
export declare function getCheckout(_id: string): Promise<NonNullablePaths<Checkout, CheckoutNonNullablePaths>>;
|
|
3609
|
+
/**
|
|
3610
|
+
* Retrieves the checkout associated with a specified cart.
|
|
3611
|
+
* @param _id - Cart ID.
|
|
3612
|
+
* @public
|
|
3613
|
+
* @requiredField _id
|
|
3614
|
+
* @permissionId ECOM.READ_CHECKOUTS
|
|
3615
|
+
* @permissionScope Manage Stores - all permissions
|
|
3616
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3617
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
3618
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
3619
|
+
* @permissionScope Read Orders
|
|
3620
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
3621
|
+
* @permissionScope Read Stores - all read permissions
|
|
3622
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
3623
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3624
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3625
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3626
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3627
|
+
* @permissionScope Manage Orders
|
|
3628
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3629
|
+
* @applicableIdentity APP
|
|
3630
|
+
* @applicableIdentity VISITOR
|
|
3631
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutByCartId
|
|
3632
|
+
*/
|
|
3633
|
+
export declare function getCheckoutByCartId(_id: string): Promise<NonNullablePaths<GetCheckoutByCartIdResponse, {
|
|
3634
|
+
[P in CheckoutNonNullablePaths]: `checkout.${P}`;
|
|
3635
|
+
}[CheckoutNonNullablePaths]>>;
|
|
3636
|
+
/**
|
|
3637
|
+
* Retrieves the checkout page URL of a specified checkout.
|
|
3638
|
+
*
|
|
3639
|
+
* By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page.
|
|
3640
|
+
* However, if `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
3641
|
+
* @param _id - Checkout ID.
|
|
3642
|
+
* @public
|
|
3643
|
+
* @requiredField _id
|
|
3644
|
+
* @permissionId ECOM.READ_CHECKOUTS
|
|
3645
|
+
* @permissionScope Manage Stores - all permissions
|
|
3646
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3647
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
3648
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
3649
|
+
* @permissionScope Read Orders
|
|
3650
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
3651
|
+
* @permissionScope Read Stores - all read permissions
|
|
3652
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
3653
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3654
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3655
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3656
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3657
|
+
* @permissionScope Manage Orders
|
|
3658
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3659
|
+
* @applicableIdentity APP
|
|
3660
|
+
* @applicableIdentity VISITOR
|
|
3661
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutURL
|
|
3662
|
+
*/
|
|
3663
|
+
export declare function getCheckoutUrl(_id: string): Promise<NonNullablePaths<GetCheckoutURLResponse, `checkoutUrl`>>;
|
|
3664
|
+
/**
|
|
3665
|
+
* Updates a checkout.
|
|
3666
|
+
*
|
|
3667
|
+
*
|
|
3668
|
+
* The `updateCheckout()` function returns a Promise that resolves to the updated checkout when the specified properties are updated.
|
|
3669
|
+
*
|
|
3670
|
+
* >**Notes:**
|
|
3671
|
+
* > + If nothing is passed in the request, the call will fail.
|
|
3672
|
+
* > + The `checkout.buyerInfo.email` may not be removed once it is set.
|
|
3673
|
+
* @param _id - Checkout ID.
|
|
3674
|
+
* @public
|
|
3675
|
+
* @requiredField _id
|
|
3676
|
+
* @requiredField checkout
|
|
3677
|
+
* @requiredField checkout.customFields.value
|
|
3678
|
+
* @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
|
|
3679
|
+
* @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
|
|
3680
|
+
* @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
|
|
3681
|
+
* @requiredField options.customLineItems.descriptionLines.name
|
|
3682
|
+
* @requiredField options.customLineItems.descriptionLines.value
|
|
3683
|
+
* @requiredField options.customLineItems.itemType
|
|
3684
|
+
* @requiredField options.customLineItems.productName
|
|
3685
|
+
* @requiredField options.customLineItems.quantity
|
|
3686
|
+
* @requiredField options.lineItems.catalogReference
|
|
3687
|
+
* @requiredField options.lineItems.catalogReference.appId
|
|
3688
|
+
* @requiredField options.lineItems.catalogReference.catalogItemId
|
|
3689
|
+
* @requiredField options.lineItems.quantity
|
|
3690
|
+
* @param options - Checkout update options.
|
|
3691
|
+
* @permissionId ECOM.MODIFY_CHECKOUTS
|
|
3692
|
+
* @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
|
|
3693
|
+
* @permissionScope Manage Stores - all permissions
|
|
3694
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3695
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3696
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3697
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3698
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3699
|
+
* @permissionScope Manage Orders
|
|
3700
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3701
|
+
* @permissionScope Manage Stores - all permissions
|
|
3702
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3703
|
+
* @permissionScope Manage eCommerce - Admin Permissions
|
|
3704
|
+
* @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
|
|
3705
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3706
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3707
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3708
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3709
|
+
* @applicableIdentity APP
|
|
3710
|
+
* @applicableIdentity VISITOR
|
|
3711
|
+
* @returns Updated checkout.
|
|
3712
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateCheckout
|
|
3713
|
+
*/
|
|
3714
|
+
export declare function updateCheckout(_id: string, checkout: NonNullablePaths<UpdateCheckout, `customFields.${number}.value` | `membershipOptions.selectedMemberships.memberships.${number}._id` | `membershipOptions.selectedMemberships.memberships.${number}.appId` | `membershipOptions.selectedMemberships.memberships.${number}.lineItemIds`>, options?: NonNullablePaths<UpdateCheckoutOptions, `customLineItems.${number}.descriptionLines` | `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.quantity`>): Promise<NonNullablePaths<Checkout, CheckoutNonNullablePaths>>;
|
|
3715
|
+
export interface UpdateCheckout {
|
|
3634
3716
|
/**
|
|
3635
3717
|
* Checkout ID.
|
|
3636
3718
|
* @format GUID
|
|
@@ -3804,21 +3886,6 @@ interface UpdateCheckout {
|
|
|
3804
3886
|
* @immutable
|
|
3805
3887
|
*/
|
|
3806
3888
|
externalReference?: ExternalReference;
|
|
3807
|
-
/**
|
|
3808
|
-
* Order ID.
|
|
3809
|
-
*
|
|
3810
|
-
* This field is empty until the checkout completes and becomes an order.
|
|
3811
|
-
* @internal
|
|
3812
|
-
* @format GUID
|
|
3813
|
-
* @readonly
|
|
3814
|
-
*/
|
|
3815
|
-
orderId?: string | null;
|
|
3816
|
-
/**
|
|
3817
|
-
* Payment for subscriptions after free trial period.
|
|
3818
|
-
* @internal
|
|
3819
|
-
* @readonly
|
|
3820
|
-
*/
|
|
3821
|
-
payAfterFreeTrial?: PriceSummary;
|
|
3822
3889
|
/**
|
|
3823
3890
|
* The business location ID associated with the checkout.
|
|
3824
3891
|
*
|
|
@@ -3826,25 +3893,8 @@ interface UpdateCheckout {
|
|
|
3826
3893
|
* @format GUID
|
|
3827
3894
|
*/
|
|
3828
3895
|
businessLocationId?: string | null;
|
|
3829
|
-
/**
|
|
3830
|
-
* Whether payment is required to create an order.
|
|
3831
|
-
*
|
|
3832
|
-
* Payment is required if any of the following conditions are met:
|
|
3833
|
-
* 1. At least one item requires a payment method. This can be because the item has the `savePaymentMethod` field set to `true`, or the item is a subscription with a price greater than zero.
|
|
3834
|
-
* 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
|
|
3835
|
-
* @internal
|
|
3836
|
-
* @readonly
|
|
3837
|
-
*/
|
|
3838
|
-
paymentRequired?: boolean;
|
|
3839
|
-
/**
|
|
3840
|
-
* Charges information for each subscription in the checkout.
|
|
3841
|
-
* @internal
|
|
3842
|
-
* @readonly
|
|
3843
|
-
* @maxSize 100
|
|
3844
|
-
*/
|
|
3845
|
-
subscriptionCharges?: SubscriptionCharges[];
|
|
3846
3896
|
}
|
|
3847
|
-
interface UpdateCheckoutOptions {
|
|
3897
|
+
export interface UpdateCheckoutOptions {
|
|
3848
3898
|
/** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
3849
3899
|
couponCode?: string | null;
|
|
3850
3900
|
/** Gift card code. */
|
|
@@ -3870,7 +3920,127 @@ interface UpdateCheckoutOptions {
|
|
|
3870
3920
|
*/
|
|
3871
3921
|
customLineItems?: CustomLineItem[];
|
|
3872
3922
|
}
|
|
3873
|
-
|
|
3923
|
+
/**
|
|
3924
|
+
* Removes the coupon from a specified checkout.
|
|
3925
|
+
*
|
|
3926
|
+
*
|
|
3927
|
+
* The `removeCoupon()` function returns a Promise that resolves to the updated checkout when the coupon is removed from the specified checkout.
|
|
3928
|
+
*
|
|
3929
|
+
* >**Note:** A checkout can only hold 1 coupon.
|
|
3930
|
+
* @param _id - ID of the checkout to remove the coupon from.
|
|
3931
|
+
* @public
|
|
3932
|
+
* @requiredField _id
|
|
3933
|
+
* @permissionId ECOM.MODIFY_CHECKOUTS
|
|
3934
|
+
* @permissionScope Manage Stores - all permissions
|
|
3935
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3936
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3937
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3938
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3939
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3940
|
+
* @permissionScope Manage Orders
|
|
3941
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3942
|
+
* @applicableIdentity APP
|
|
3943
|
+
* @applicableIdentity VISITOR
|
|
3944
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveCoupon
|
|
3945
|
+
*/
|
|
3946
|
+
export declare function removeCoupon(_id: string): Promise<NonNullablePaths<RemoveCouponResponse, {
|
|
3947
|
+
[P in CheckoutNonNullablePaths]: `checkout.${P}`;
|
|
3948
|
+
}[CheckoutNonNullablePaths]>>;
|
|
3949
|
+
/**
|
|
3950
|
+
* Removes the gift card from a specified checkout.
|
|
3951
|
+
*
|
|
3952
|
+
*
|
|
3953
|
+
* The `removeGiftCard()` function returns a Promise that resolves to the updated checkout when the gift card is removed from the specified checkout.
|
|
3954
|
+
*
|
|
3955
|
+
* >**Note:** A checkout can only hold 1 gift card.
|
|
3956
|
+
* @param _id - ID of the checkout to remove the gift card from.
|
|
3957
|
+
* @public
|
|
3958
|
+
* @requiredField _id
|
|
3959
|
+
* @permissionId ECOM.MODIFY_CHECKOUTS
|
|
3960
|
+
* @permissionScope Manage Stores - all permissions
|
|
3961
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3962
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3963
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3964
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3965
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3966
|
+
* @permissionScope Manage Orders
|
|
3967
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3968
|
+
* @applicableIdentity APP
|
|
3969
|
+
* @applicableIdentity VISITOR
|
|
3970
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveGiftCard
|
|
3971
|
+
*/
|
|
3972
|
+
export declare function removeGiftCard(_id: string): Promise<NonNullablePaths<RemoveGiftCardResponse, {
|
|
3973
|
+
[P in CheckoutNonNullablePaths]: `checkout.${P}`;
|
|
3974
|
+
}[CheckoutNonNullablePaths]>>;
|
|
3975
|
+
/**
|
|
3976
|
+
* Removes the `overrideCheckoutUrl` from a specified checkout.
|
|
3977
|
+
*
|
|
3978
|
+
* When `overrideCheckoutUrl` is removed, the `checkoutUrl` will be set to the default, standard
|
|
3979
|
+
* Wix checkout page URL.
|
|
3980
|
+
* @param _id - ID of the checkout to remove the override checkout url from.
|
|
3981
|
+
* @public
|
|
3982
|
+
* @requiredField _id
|
|
3983
|
+
* @permissionId ECOM.MODIFY_CHECKOUTS
|
|
3984
|
+
* @permissionScope Manage Stores - all permissions
|
|
3985
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3986
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3987
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3988
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
3989
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3990
|
+
* @permissionScope Manage Orders
|
|
3991
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
3992
|
+
* @applicableIdentity APP
|
|
3993
|
+
* @applicableIdentity VISITOR
|
|
3994
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveOverrideCheckoutUrl
|
|
3995
|
+
*/
|
|
3996
|
+
export declare function removeOverrideCheckoutUrl(_id: string): Promise<NonNullablePaths<RemoveOverrideCheckoutUrlResponse, {
|
|
3997
|
+
[P in CheckoutNonNullablePaths]: `checkout.${P}`;
|
|
3998
|
+
}[CheckoutNonNullablePaths]>>;
|
|
3999
|
+
/**
|
|
4000
|
+
* Adds catalog line items and/or custom line items to a checkout.
|
|
4001
|
+
*
|
|
4002
|
+
*
|
|
4003
|
+
* The `addToCheckout()` function returns a Promise that resolves to the updated checkout when the specified items have been added.
|
|
4004
|
+
* > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
|
|
4005
|
+
* @param _id - Checkout ID.
|
|
4006
|
+
* @public
|
|
4007
|
+
* @requiredField _id
|
|
4008
|
+
* @requiredField options.customLineItems.descriptionLines.name
|
|
4009
|
+
* @requiredField options.customLineItems.descriptionLines.value
|
|
4010
|
+
* @requiredField options.customLineItems.itemType
|
|
4011
|
+
* @requiredField options.customLineItems.productName
|
|
4012
|
+
* @requiredField options.customLineItems.quantity
|
|
4013
|
+
* @requiredField options.lineItems.catalogReference
|
|
4014
|
+
* @requiredField options.lineItems.catalogReference.appId
|
|
4015
|
+
* @requiredField options.lineItems.catalogReference.catalogItemId
|
|
4016
|
+
* @requiredField options.lineItems.quantity
|
|
4017
|
+
* @param options - Items to be added to checkout.
|
|
4018
|
+
* @permissionId ECOM.MODIFY_CHECKOUTS
|
|
4019
|
+
* @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
|
|
4020
|
+
* @permissionScope Manage Stores - all permissions
|
|
4021
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4022
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4023
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4024
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4025
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4026
|
+
* @permissionScope Manage Orders
|
|
4027
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4028
|
+
* @permissionScope Manage Stores - all permissions
|
|
4029
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4030
|
+
* @permissionScope Manage eCommerce - Admin Permissions
|
|
4031
|
+
* @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
|
|
4032
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4033
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4034
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4035
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4036
|
+
* @applicableIdentity APP
|
|
4037
|
+
* @applicableIdentity VISITOR
|
|
4038
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.AddToCheckout
|
|
4039
|
+
*/
|
|
4040
|
+
export declare function addToCheckout(_id: string, options?: NonNullablePaths<AddToCheckoutOptions, `customLineItems.${number}.descriptionLines` | `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.quantity`>): Promise<NonNullablePaths<AddToCheckoutResponse, {
|
|
4041
|
+
[P in CheckoutNonNullablePaths]: `checkout.${P}`;
|
|
4042
|
+
}[CheckoutNonNullablePaths]>>;
|
|
4043
|
+
export interface AddToCheckoutOptions {
|
|
3874
4044
|
/**
|
|
3875
4045
|
* Catalog line items.
|
|
3876
4046
|
* @maxSize 100
|
|
@@ -3885,13 +4055,71 @@ interface AddToCheckoutOptions {
|
|
|
3885
4055
|
*/
|
|
3886
4056
|
customLineItems?: CustomLineItem[];
|
|
3887
4057
|
}
|
|
3888
|
-
|
|
4058
|
+
/**
|
|
4059
|
+
* Removes line items from the specified checkout.
|
|
4060
|
+
*
|
|
4061
|
+
*
|
|
4062
|
+
* The `removeLineItems()` function returns a Promise that resolves to the updated checkout when the line items are removed from the specified checkout.
|
|
4063
|
+
* @param _id - ID of the checkout to remove line items from.
|
|
4064
|
+
* @public
|
|
4065
|
+
* @requiredField _id
|
|
4066
|
+
* @requiredField lineItemIds
|
|
4067
|
+
* @param lineItemIds - IDs of the line items to be removed.
|
|
4068
|
+
* To find the IDs of the checkout line items you'd like to remove, pass the `checkout._id` to [getCheckout()](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and look for the IDs under `lineItems` and/or `customLineItems`.
|
|
4069
|
+
* @permissionId ECOM.MODIFY_CHECKOUTS
|
|
4070
|
+
* @permissionScope Manage Stores - all permissions
|
|
4071
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4072
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4073
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4074
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4075
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4076
|
+
* @permissionScope Manage Orders
|
|
4077
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4078
|
+
* @applicableIdentity APP
|
|
4079
|
+
* @applicableIdentity VISITOR
|
|
4080
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveLineItems
|
|
4081
|
+
*/
|
|
4082
|
+
export declare function removeLineItems(_id: string, lineItemIds: string[]): Promise<NonNullablePaths<RemoveLineItemsResponse, {
|
|
4083
|
+
[P in CheckoutNonNullablePaths]: `checkout.${P}`;
|
|
4084
|
+
}[CheckoutNonNullablePaths]>>;
|
|
4085
|
+
/**
|
|
4086
|
+
* Creates an order from a specified checkout.
|
|
4087
|
+
*
|
|
4088
|
+
* The `createOrder()` function returns a Promise that resolves to the new order's ID and `paymentGatewayOrderID` when the order is created.
|
|
4089
|
+
* Pass the `paymentGatewayOrderId` as the `paymentId` param to the [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function to allow a customer to pay for their order.
|
|
4090
|
+
*
|
|
4091
|
+
* > **Note:** The following requirements must be met for an order to be created from a checkout.
|
|
4092
|
+
* > + A checkout cannot have calculation errors. Pass the `checkout._id` to [Get Checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and take a look at the `calculationErrors` field.
|
|
4093
|
+
* > + A checkout must have at least 1 line item.
|
|
4094
|
+
* > + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
|
|
4095
|
+
* > + If there is a payment to be made, meaning that `priceSummary.total` is greater than 0, the `billingInfo.address` field must be provided.
|
|
4096
|
+
* > + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields must be provided.
|
|
4097
|
+
* > + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field must be provided.
|
|
4098
|
+
* @param _id - Checkout ID.
|
|
4099
|
+
* @public
|
|
4100
|
+
* @requiredField _id
|
|
4101
|
+
* @param options - Further order creation options.
|
|
4102
|
+
* @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
|
|
4103
|
+
* @permissionScope Manage Stores - all permissions
|
|
4104
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4105
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4106
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4107
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4108
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4109
|
+
* @permissionScope Manage Orders
|
|
4110
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4111
|
+
* @applicableIdentity APP
|
|
4112
|
+
* @applicableIdentity VISITOR
|
|
4113
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrder
|
|
4114
|
+
*/
|
|
4115
|
+
export declare function createOrder(_id: string, options?: CreateOrderOptions): Promise<NonNullablePaths<CreateOrderResponse, `orderId` | `subscriptionId`>>;
|
|
4116
|
+
export interface CreateOrderOptions {
|
|
3889
4117
|
/** Whether the payment method should be saved on the order. */
|
|
3890
4118
|
savePaymentMethod?: boolean;
|
|
3891
4119
|
/** Whether to authorize the payment and delay the capture. */
|
|
3892
4120
|
delayCapture?: boolean;
|
|
3893
4121
|
}
|
|
3894
|
-
interface CreateOrderAndChargeOptions {
|
|
4122
|
+
export interface CreateOrderAndChargeOptions {
|
|
3895
4123
|
/** Payment token. */
|
|
3896
4124
|
paymentToken?: string | null;
|
|
3897
4125
|
/** Whether the payment method should be saved on the order. */
|
|
@@ -3899,5 +4127,59 @@ interface CreateOrderAndChargeOptions {
|
|
|
3899
4127
|
/** Whether to authorize the payment and delay the capture. */
|
|
3900
4128
|
delayCapture?: boolean;
|
|
3901
4129
|
}
|
|
3902
|
-
|
|
3903
|
-
|
|
4130
|
+
/**
|
|
4131
|
+
* Marks a checkout as completed - `checkout.complete` boolean is set to `true`.
|
|
4132
|
+
*
|
|
4133
|
+
*
|
|
4134
|
+
* The `markCheckoutAsCompleted()` function returns a Promise that resolves when the specified checkout is marked as completed.
|
|
4135
|
+
* @param _id - Checkout ID.
|
|
4136
|
+
* @public
|
|
4137
|
+
* @requiredField _id
|
|
4138
|
+
* @permissionId ECOM.MODIFY_CHECKOUTS
|
|
4139
|
+
* @permissionScope Manage Stores - all permissions
|
|
4140
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4141
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4142
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4143
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4144
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4145
|
+
* @permissionScope Manage Orders
|
|
4146
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4147
|
+
* @applicableIdentity APP
|
|
4148
|
+
* @applicableIdentity VISITOR
|
|
4149
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompleted
|
|
4150
|
+
*/
|
|
4151
|
+
export declare function markCheckoutAsCompleted(_id: string): Promise<void>;
|
|
4152
|
+
/**
|
|
4153
|
+
* Updates the quantity of one or more line items in a checkout.
|
|
4154
|
+
*
|
|
4155
|
+
* This endpoint is only for updating the quantity of line items. To entirely remove a line item from
|
|
4156
|
+
* the checkout, use [`removeLineItems()`](#removelineitems).
|
|
4157
|
+
* To add a new line item to the checkout, use [`addToCheckout()`](#addtocheckout).
|
|
4158
|
+
*
|
|
4159
|
+
* This endpoint checks the amount of stock remaining for this line item. If the specified `quantity`
|
|
4160
|
+
* is greater than the remaining stock, then the `quantity` returned in the response is the total amount
|
|
4161
|
+
* of remaining stock.
|
|
4162
|
+
* @param _id - Checkout ID.
|
|
4163
|
+
* @param lineItems - Line item info to update.
|
|
4164
|
+
* @public
|
|
4165
|
+
* @requiredField _id
|
|
4166
|
+
* @requiredField lineItems
|
|
4167
|
+
* @requiredField lineItems._id
|
|
4168
|
+
* @requiredField lineItems.quantity
|
|
4169
|
+
* @permissionId ECOM.MODIFY_CHECKOUTS
|
|
4170
|
+
* @permissionScope Manage Stores - all permissions
|
|
4171
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4172
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4173
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4174
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4175
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4176
|
+
* @permissionScope Manage Orders
|
|
4177
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4178
|
+
* @applicableIdentity APP
|
|
4179
|
+
* @applicableIdentity VISITOR
|
|
4180
|
+
* @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateLineItemsQuantity
|
|
4181
|
+
*/
|
|
4182
|
+
export declare function updateLineItemsQuantity(_id: string, lineItems: NonNullablePaths<LineItemQuantityUpdate, `_id` | `quantity`>[]): Promise<NonNullablePaths<UpdateLineItemsQuantityResponse, {
|
|
4183
|
+
[P in CheckoutNonNullablePaths]: `checkout.${P}`;
|
|
4184
|
+
}[CheckoutNonNullablePaths]>>;
|
|
4185
|
+
export {};
|