@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,10 +1,10 @@
|
|
|
1
|
-
interface Checkout {
|
|
1
|
+
export interface Checkout {
|
|
2
2
|
/**
|
|
3
3
|
* Checkout ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
id?: string | null;
|
|
8
8
|
/**
|
|
9
9
|
* Line items.
|
|
10
10
|
*
|
|
@@ -19,7 +19,7 @@ interface Checkout {
|
|
|
19
19
|
/** Shipping information. */
|
|
20
20
|
shippingInfo?: ShippingInfo;
|
|
21
21
|
/**
|
|
22
|
-
* [Buyer note](https://support.wix.com/en/article/
|
|
22
|
+
* [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
|
|
23
23
|
* @maxLength 1000
|
|
24
24
|
*/
|
|
25
25
|
buyerNote?: string | null;
|
|
@@ -107,12 +107,12 @@ interface Checkout {
|
|
|
107
107
|
* Date and time the checkout was created.
|
|
108
108
|
* @readonly
|
|
109
109
|
*/
|
|
110
|
-
|
|
110
|
+
createdDate?: Date | null;
|
|
111
111
|
/**
|
|
112
112
|
* Date and time the checkout was updated.
|
|
113
113
|
* @readonly
|
|
114
114
|
*/
|
|
115
|
-
|
|
115
|
+
updatedDate?: Date | null;
|
|
116
116
|
/**
|
|
117
117
|
* Minimal amount to pay in order to place the order.
|
|
118
118
|
* @readonly
|
|
@@ -136,7 +136,7 @@ interface Checkout {
|
|
|
136
136
|
*/
|
|
137
137
|
cartId?: string | null;
|
|
138
138
|
/**
|
|
139
|
-
* List of validation violations raised by the
|
|
139
|
+
* List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
|
|
140
140
|
* @readonly
|
|
141
141
|
*/
|
|
142
142
|
violations?: Violation[];
|
|
@@ -155,7 +155,9 @@ interface Checkout {
|
|
|
155
155
|
/**
|
|
156
156
|
* Additional settings for customization of the checkout process.
|
|
157
157
|
*
|
|
158
|
-
*
|
|
158
|
+
* > **Notes:**
|
|
159
|
+
* > * Custom settings can only be set when creating a checkout.
|
|
160
|
+
* > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
159
161
|
* @immutable
|
|
160
162
|
*/
|
|
161
163
|
customSettings?: CustomSettings;
|
|
@@ -180,13 +182,13 @@ interface Checkout {
|
|
|
180
182
|
*/
|
|
181
183
|
businessLocationId?: string | null;
|
|
182
184
|
}
|
|
183
|
-
interface LineItem {
|
|
185
|
+
export interface LineItem {
|
|
184
186
|
/**
|
|
185
187
|
* Line item ID.
|
|
186
188
|
* @format GUID
|
|
187
189
|
* @readonly
|
|
188
190
|
*/
|
|
189
|
-
|
|
191
|
+
id?: string | null;
|
|
190
192
|
/**
|
|
191
193
|
* Item quantity.
|
|
192
194
|
*
|
|
@@ -196,7 +198,7 @@ interface LineItem {
|
|
|
196
198
|
* @max 100000
|
|
197
199
|
*/
|
|
198
200
|
quantity?: number;
|
|
199
|
-
/** Catalog and item reference.
|
|
201
|
+
/** 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. */
|
|
200
202
|
catalogReference?: CatalogReference;
|
|
201
203
|
/**
|
|
202
204
|
* Item name.
|
|
@@ -210,7 +212,7 @@ interface LineItem {
|
|
|
210
212
|
* URL to the item's page on the site.
|
|
211
213
|
* @readonly
|
|
212
214
|
*/
|
|
213
|
-
url?:
|
|
215
|
+
url?: PageUrlV2;
|
|
214
216
|
/**
|
|
215
217
|
* Item price **after** catalog-defined discount and line item discounts.
|
|
216
218
|
* @readonly
|
|
@@ -252,7 +254,7 @@ interface LineItem {
|
|
|
252
254
|
*/
|
|
253
255
|
discount?: MultiCurrencyPrice;
|
|
254
256
|
/**
|
|
255
|
-
* Line item description lines. Used for
|
|
257
|
+
* Line item description lines. Used for display purposes for the cart, checkout and order.
|
|
256
258
|
* @readonly
|
|
257
259
|
*/
|
|
258
260
|
descriptionLines?: DescriptionLine[];
|
|
@@ -260,7 +262,7 @@ interface LineItem {
|
|
|
260
262
|
* Line item image details.
|
|
261
263
|
* @readonly
|
|
262
264
|
*/
|
|
263
|
-
media?:
|
|
265
|
+
media?: CommonImage;
|
|
264
266
|
/**
|
|
265
267
|
* Item availability details.
|
|
266
268
|
* @readonly
|
|
@@ -282,11 +284,9 @@ interface LineItem {
|
|
|
282
284
|
*/
|
|
283
285
|
subscriptionOptionInfo?: SubscriptionOptionInfo;
|
|
284
286
|
/**
|
|
285
|
-
* Type of selected payment option for current item.
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
* + `"MEMBERSHIP"`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
289
|
-
* + `"DEPOSIT_ONLINE"`: Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
|
|
287
|
+
* Type of selected payment option for current item.
|
|
288
|
+
*
|
|
289
|
+
* Default: `FULL_PAYMENT_ONLINE`
|
|
290
290
|
* @readonly
|
|
291
291
|
*/
|
|
292
292
|
paymentOption?: PaymentOptionType;
|
|
@@ -349,7 +349,7 @@ interface LineItem {
|
|
|
349
349
|
savePaymentMethod?: boolean;
|
|
350
350
|
}
|
|
351
351
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
352
|
-
interface CatalogReference {
|
|
352
|
+
export interface CatalogReference {
|
|
353
353
|
/**
|
|
354
354
|
* ID of the item within the catalog it belongs to.
|
|
355
355
|
* @minLength 1
|
|
@@ -369,15 +369,13 @@ interface CatalogReference {
|
|
|
369
369
|
*/
|
|
370
370
|
appId?: string;
|
|
371
371
|
/**
|
|
372
|
-
* Additional item details in key:value pairs.
|
|
373
|
-
*
|
|
374
|
-
* Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
372
|
+
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
375
373
|
*
|
|
376
|
-
* For products and variants from
|
|
374
|
+
* For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
|
|
377
375
|
*/
|
|
378
376
|
options?: Record<string, any> | null;
|
|
379
377
|
}
|
|
380
|
-
interface ProductName {
|
|
378
|
+
export interface ProductName {
|
|
381
379
|
/**
|
|
382
380
|
* __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).
|
|
383
381
|
*
|
|
@@ -398,7 +396,13 @@ interface ProductName {
|
|
|
398
396
|
*/
|
|
399
397
|
translated?: string | null;
|
|
400
398
|
}
|
|
401
|
-
interface
|
|
399
|
+
export interface PageUrlV2 {
|
|
400
|
+
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
401
|
+
relativePath?: string;
|
|
402
|
+
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
403
|
+
url?: string | null;
|
|
404
|
+
}
|
|
405
|
+
export interface MultiCurrencyPrice {
|
|
402
406
|
/**
|
|
403
407
|
* Amount.
|
|
404
408
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -421,7 +425,7 @@ interface MultiCurrencyPrice {
|
|
|
421
425
|
*/
|
|
422
426
|
formattedConvertedAmount?: string;
|
|
423
427
|
}
|
|
424
|
-
interface ItemTaxFullDetails {
|
|
428
|
+
export interface ItemTaxFullDetails {
|
|
425
429
|
/** Amount for which tax is calculated. */
|
|
426
430
|
taxableAmount?: MultiCurrencyPrice;
|
|
427
431
|
/**
|
|
@@ -438,7 +442,7 @@ interface ItemTaxFullDetails {
|
|
|
438
442
|
*/
|
|
439
443
|
rateBreakdown?: TaxRateBreakdown[];
|
|
440
444
|
}
|
|
441
|
-
interface TaxRateBreakdown {
|
|
445
|
+
export interface TaxRateBreakdown {
|
|
442
446
|
/**
|
|
443
447
|
* Name of tax against which the calculation was performed.
|
|
444
448
|
* @maxLength 100
|
|
@@ -456,7 +460,7 @@ interface TaxRateBreakdown {
|
|
|
456
460
|
* TaxBreakdown represents tax information for a line item.
|
|
457
461
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
458
462
|
*/
|
|
459
|
-
interface TaxBreakdown {
|
|
463
|
+
export interface TaxBreakdown {
|
|
460
464
|
/**
|
|
461
465
|
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
462
466
|
* @maxLength 200
|
|
@@ -488,7 +492,7 @@ interface TaxBreakdown {
|
|
|
488
492
|
jurisdictionType?: JurisdictionType;
|
|
489
493
|
}
|
|
490
494
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
491
|
-
declare enum JurisdictionType {
|
|
495
|
+
export declare enum JurisdictionType {
|
|
492
496
|
UNDEFINED = "UNDEFINED",
|
|
493
497
|
COUNTRY = "COUNTRY",
|
|
494
498
|
STATE = "STATE",
|
|
@@ -496,7 +500,7 @@ declare enum JurisdictionType {
|
|
|
496
500
|
CITY = "CITY",
|
|
497
501
|
SPECIAL = "SPECIAL"
|
|
498
502
|
}
|
|
499
|
-
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
503
|
+
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
500
504
|
/** Description line plain text value. */
|
|
501
505
|
plainText?: PlainTextValue;
|
|
502
506
|
/** Description line color value. */
|
|
@@ -505,16 +509,16 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
505
509
|
name?: DescriptionLineName;
|
|
506
510
|
}
|
|
507
511
|
/** @oneof */
|
|
508
|
-
interface DescriptionLineValueOneOf {
|
|
512
|
+
export interface DescriptionLineValueOneOf {
|
|
509
513
|
/** Description line plain text value. */
|
|
510
514
|
plainText?: PlainTextValue;
|
|
511
515
|
/** Description line color value. */
|
|
512
516
|
colorInfo?: Color;
|
|
513
517
|
}
|
|
514
518
|
/** @oneof */
|
|
515
|
-
interface DescriptionLineDescriptionLineValueOneOf {
|
|
519
|
+
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
516
520
|
}
|
|
517
|
-
interface DescriptionLineName {
|
|
521
|
+
export interface DescriptionLineName {
|
|
518
522
|
/**
|
|
519
523
|
* 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).
|
|
520
524
|
* @maxLength 100
|
|
@@ -528,7 +532,7 @@ interface DescriptionLineName {
|
|
|
528
532
|
*/
|
|
529
533
|
translated?: string | null;
|
|
530
534
|
}
|
|
531
|
-
interface PlainTextValue {
|
|
535
|
+
export interface PlainTextValue {
|
|
532
536
|
/**
|
|
533
537
|
* 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).
|
|
534
538
|
* @maxLength 600
|
|
@@ -542,7 +546,7 @@ interface PlainTextValue {
|
|
|
542
546
|
*/
|
|
543
547
|
translated?: string | null;
|
|
544
548
|
}
|
|
545
|
-
interface Color {
|
|
549
|
+
export interface Color {
|
|
546
550
|
/**
|
|
547
551
|
* 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).
|
|
548
552
|
* @maxLength 500
|
|
@@ -558,7 +562,7 @@ interface Color {
|
|
|
558
562
|
/** HEX or RGB color code for display. */
|
|
559
563
|
code?: string | null;
|
|
560
564
|
}
|
|
561
|
-
declare enum DescriptionLineType {
|
|
565
|
+
export declare enum DescriptionLineType {
|
|
562
566
|
/** Unrecognized type. */
|
|
563
567
|
UNRECOGNISED = "UNRECOGNISED",
|
|
564
568
|
/** Plain text type. */
|
|
@@ -566,7 +570,30 @@ declare enum DescriptionLineType {
|
|
|
566
570
|
/** Color type. */
|
|
567
571
|
COLOR = "COLOR"
|
|
568
572
|
}
|
|
569
|
-
interface
|
|
573
|
+
export interface CommonImage {
|
|
574
|
+
/** WixMedia image ID. */
|
|
575
|
+
id?: string;
|
|
576
|
+
/** Image URL. */
|
|
577
|
+
url?: string;
|
|
578
|
+
/**
|
|
579
|
+
* Original image height.
|
|
580
|
+
* @readonly
|
|
581
|
+
*/
|
|
582
|
+
height?: number;
|
|
583
|
+
/**
|
|
584
|
+
* Original image width.
|
|
585
|
+
* @readonly
|
|
586
|
+
*/
|
|
587
|
+
width?: number;
|
|
588
|
+
/** Image alt text. */
|
|
589
|
+
altText?: string | null;
|
|
590
|
+
/**
|
|
591
|
+
* Image filename.
|
|
592
|
+
* @readonly
|
|
593
|
+
*/
|
|
594
|
+
filename?: string | null;
|
|
595
|
+
}
|
|
596
|
+
export interface FocalPoint {
|
|
570
597
|
/** X-coordinate of the focal point. */
|
|
571
598
|
x?: number;
|
|
572
599
|
/** Y-coordinate of the focal point. */
|
|
@@ -576,13 +603,13 @@ interface FocalPoint {
|
|
|
576
603
|
/** crop by width */
|
|
577
604
|
width?: number | null;
|
|
578
605
|
}
|
|
579
|
-
interface ItemAvailabilityInfo {
|
|
606
|
+
export interface ItemAvailabilityInfo {
|
|
580
607
|
/** Item availability status. */
|
|
581
608
|
status?: ItemAvailabilityStatus;
|
|
582
609
|
/** Quantity available. */
|
|
583
610
|
quantityAvailable?: number | null;
|
|
584
611
|
}
|
|
585
|
-
declare enum ItemAvailabilityStatus {
|
|
612
|
+
export declare enum ItemAvailabilityStatus {
|
|
586
613
|
AVAILABLE = "AVAILABLE",
|
|
587
614
|
/** Item does not exist. */
|
|
588
615
|
NOT_FOUND = "NOT_FOUND",
|
|
@@ -591,8 +618,8 @@ declare enum ItemAvailabilityStatus {
|
|
|
591
618
|
/** Available quantity is less than requested. */
|
|
592
619
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
593
620
|
}
|
|
594
|
-
interface PhysicalProperties {
|
|
595
|
-
/** Line item weight. Measurement unit
|
|
621
|
+
export interface PhysicalProperties {
|
|
622
|
+
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
596
623
|
weight?: number | null;
|
|
597
624
|
/**
|
|
598
625
|
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
@@ -602,39 +629,39 @@ interface PhysicalProperties {
|
|
|
602
629
|
/** Whether this line item is shippable. */
|
|
603
630
|
shippable?: boolean;
|
|
604
631
|
}
|
|
605
|
-
interface Scope {
|
|
632
|
+
export interface Scope {
|
|
606
633
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
607
634
|
namespace?: string;
|
|
608
635
|
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
609
636
|
group?: Group;
|
|
610
637
|
}
|
|
611
|
-
interface Group {
|
|
638
|
+
export interface Group {
|
|
612
639
|
/** 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). */
|
|
613
640
|
name?: string;
|
|
614
641
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
615
642
|
entityId?: string | null;
|
|
616
643
|
}
|
|
617
|
-
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
644
|
+
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
618
645
|
/** Preset item type. */
|
|
619
646
|
preset?: ItemTypeItemType;
|
|
620
647
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
621
648
|
custom?: string;
|
|
622
649
|
}
|
|
623
650
|
/** @oneof */
|
|
624
|
-
interface ItemTypeItemTypeDataOneOf {
|
|
651
|
+
export interface ItemTypeItemTypeDataOneOf {
|
|
625
652
|
/** Preset item type. */
|
|
626
653
|
preset?: ItemTypeItemType;
|
|
627
654
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
628
655
|
custom?: string;
|
|
629
656
|
}
|
|
630
|
-
declare enum ItemTypeItemType {
|
|
657
|
+
export declare enum ItemTypeItemType {
|
|
631
658
|
UNRECOGNISED = "UNRECOGNISED",
|
|
632
659
|
PHYSICAL = "PHYSICAL",
|
|
633
660
|
DIGITAL = "DIGITAL",
|
|
634
661
|
GIFT_CARD = "GIFT_CARD",
|
|
635
662
|
SERVICE = "SERVICE"
|
|
636
663
|
}
|
|
637
|
-
interface SubscriptionOptionInfo {
|
|
664
|
+
export interface SubscriptionOptionInfo {
|
|
638
665
|
/** Subscription option settings. */
|
|
639
666
|
subscriptionSettings?: SubscriptionSettings;
|
|
640
667
|
/** Subscription option title. */
|
|
@@ -642,7 +669,7 @@ interface SubscriptionOptionInfo {
|
|
|
642
669
|
/** Subscription option description. */
|
|
643
670
|
description?: Description;
|
|
644
671
|
}
|
|
645
|
-
interface SubscriptionSettings {
|
|
672
|
+
export interface SubscriptionSettings {
|
|
646
673
|
/** Frequency of recurring payment. */
|
|
647
674
|
frequency?: SubscriptionFrequency;
|
|
648
675
|
/**
|
|
@@ -663,14 +690,14 @@ interface SubscriptionSettings {
|
|
|
663
690
|
billingCycles?: number | null;
|
|
664
691
|
}
|
|
665
692
|
/** Frequency unit of recurring payment */
|
|
666
|
-
declare enum SubscriptionFrequency {
|
|
693
|
+
export declare enum SubscriptionFrequency {
|
|
667
694
|
UNDEFINED = "UNDEFINED",
|
|
668
695
|
DAY = "DAY",
|
|
669
696
|
WEEK = "WEEK",
|
|
670
697
|
MONTH = "MONTH",
|
|
671
698
|
YEAR = "YEAR"
|
|
672
699
|
}
|
|
673
|
-
interface FreeTrialPeriod {
|
|
700
|
+
export interface FreeTrialPeriod {
|
|
674
701
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
675
702
|
frequency?: SubscriptionFrequency;
|
|
676
703
|
/**
|
|
@@ -680,7 +707,7 @@ interface FreeTrialPeriod {
|
|
|
680
707
|
*/
|
|
681
708
|
interval?: number;
|
|
682
709
|
}
|
|
683
|
-
interface Title {
|
|
710
|
+
export interface Title {
|
|
684
711
|
/**
|
|
685
712
|
* 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).
|
|
686
713
|
* @minLength 1
|
|
@@ -696,7 +723,7 @@ interface Title {
|
|
|
696
723
|
*/
|
|
697
724
|
translated?: string | null;
|
|
698
725
|
}
|
|
699
|
-
interface Description {
|
|
726
|
+
export interface Description {
|
|
700
727
|
/**
|
|
701
728
|
* Subscription option description.
|
|
702
729
|
* @maxLength 500
|
|
@@ -708,13 +735,13 @@ interface Description {
|
|
|
708
735
|
*/
|
|
709
736
|
translated?: string | null;
|
|
710
737
|
}
|
|
711
|
-
interface SecuredMedia {
|
|
738
|
+
export interface SecuredMedia {
|
|
712
739
|
/**
|
|
713
740
|
* Media ID in Wix Media Manager.
|
|
714
741
|
* @minLength 1
|
|
715
742
|
* @maxLength 100
|
|
716
743
|
*/
|
|
717
|
-
|
|
744
|
+
id?: string;
|
|
718
745
|
/**
|
|
719
746
|
* Original filename.
|
|
720
747
|
* @minLength 1
|
|
@@ -724,7 +751,7 @@ interface SecuredMedia {
|
|
|
724
751
|
/** File type. */
|
|
725
752
|
fileType?: FileType;
|
|
726
753
|
}
|
|
727
|
-
declare enum FileType {
|
|
754
|
+
export declare enum FileType {
|
|
728
755
|
UNSPECIFIED = "UNSPECIFIED",
|
|
729
756
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
730
757
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -733,7 +760,7 @@ declare enum FileType {
|
|
|
733
760
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
734
761
|
}
|
|
735
762
|
/** Type of selected payment option for catalog item */
|
|
736
|
-
declare enum PaymentOptionType {
|
|
763
|
+
export declare enum PaymentOptionType {
|
|
737
764
|
/** The entire payment for this item happens as part of the checkout. */
|
|
738
765
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
739
766
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -745,7 +772,7 @@ declare enum PaymentOptionType {
|
|
|
745
772
|
/** 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`. */
|
|
746
773
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
747
774
|
}
|
|
748
|
-
interface ServiceProperties {
|
|
775
|
+
export interface ServiceProperties {
|
|
749
776
|
/**
|
|
750
777
|
* 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.
|
|
751
778
|
* For example, the start time of a class.
|
|
@@ -758,7 +785,7 @@ interface ServiceProperties {
|
|
|
758
785
|
*/
|
|
759
786
|
numberOfParticipants?: number | null;
|
|
760
787
|
}
|
|
761
|
-
interface PriceDescription {
|
|
788
|
+
export interface PriceDescription {
|
|
762
789
|
/**
|
|
763
790
|
* __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).
|
|
764
791
|
* @minLength 1
|
|
@@ -774,7 +801,7 @@ interface PriceDescription {
|
|
|
774
801
|
*/
|
|
775
802
|
translated?: string | null;
|
|
776
803
|
}
|
|
777
|
-
interface CatalogOverrideFields {
|
|
804
|
+
export interface CatalogOverrideFields {
|
|
778
805
|
/** Item name. */
|
|
779
806
|
productName?: ProductName;
|
|
780
807
|
/**
|
|
@@ -795,7 +822,7 @@ interface CatalogOverrideFields {
|
|
|
795
822
|
/** Physical properties of the item. */
|
|
796
823
|
physicalProperties?: PhysicalProperties;
|
|
797
824
|
/** Item image. */
|
|
798
|
-
image?:
|
|
825
|
+
image?: Image;
|
|
799
826
|
/** Payment method selected for the item. */
|
|
800
827
|
paymentOption?: PaymentOption;
|
|
801
828
|
/**
|
|
@@ -811,7 +838,19 @@ interface CatalogOverrideFields {
|
|
|
811
838
|
*/
|
|
812
839
|
savePaymentMethod?: boolean | null;
|
|
813
840
|
}
|
|
814
|
-
interface
|
|
841
|
+
export interface Image {
|
|
842
|
+
/** WixMedia image ID. */
|
|
843
|
+
id?: string;
|
|
844
|
+
/** Original image height. */
|
|
845
|
+
height?: number;
|
|
846
|
+
/** Original image width. */
|
|
847
|
+
width?: number;
|
|
848
|
+
/** Image alt text. Optional. */
|
|
849
|
+
altText?: string | null;
|
|
850
|
+
/** Image filename. Optional. */
|
|
851
|
+
filename?: string | null;
|
|
852
|
+
}
|
|
853
|
+
export interface PaymentOption {
|
|
815
854
|
/**
|
|
816
855
|
* Type of selected payment option for current item.
|
|
817
856
|
*
|
|
@@ -819,22 +858,22 @@ interface PaymentOption {
|
|
|
819
858
|
*/
|
|
820
859
|
value?: PaymentOptionType;
|
|
821
860
|
}
|
|
822
|
-
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
861
|
+
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
823
862
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
824
863
|
addressType?: TaxableAddressType;
|
|
825
864
|
}
|
|
826
865
|
/** @oneof */
|
|
827
|
-
interface TaxableAddressTaxableAddressDataOneOf {
|
|
866
|
+
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
828
867
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
829
868
|
addressType?: TaxableAddressType;
|
|
830
869
|
}
|
|
831
|
-
declare enum TaxableAddressType {
|
|
870
|
+
export declare enum TaxableAddressType {
|
|
832
871
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
833
872
|
BUSINESS = "BUSINESS",
|
|
834
873
|
BILLING = "BILLING",
|
|
835
874
|
SHIPPING = "SHIPPING"
|
|
836
875
|
}
|
|
837
|
-
interface ExtendedFields {
|
|
876
|
+
export interface ExtendedFields {
|
|
838
877
|
/**
|
|
839
878
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
840
879
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -845,7 +884,7 @@ interface ExtendedFields {
|
|
|
845
884
|
*/
|
|
846
885
|
namespaces?: Record<string, Record<string, any>>;
|
|
847
886
|
}
|
|
848
|
-
interface Policy {
|
|
887
|
+
export interface Policy {
|
|
849
888
|
/**
|
|
850
889
|
* Policy title - should be translated
|
|
851
890
|
* @minLength 1
|
|
@@ -859,13 +898,13 @@ interface Policy {
|
|
|
859
898
|
*/
|
|
860
899
|
content?: string;
|
|
861
900
|
}
|
|
862
|
-
interface ModifierGroup {
|
|
901
|
+
export interface ModifierGroup {
|
|
863
902
|
/**
|
|
864
903
|
* Modifier group id.
|
|
865
904
|
* @minLength 1
|
|
866
905
|
* @maxLength 36
|
|
867
906
|
*/
|
|
868
|
-
|
|
907
|
+
id?: string;
|
|
869
908
|
/** Modifier group name. */
|
|
870
909
|
name?: TranslatableString;
|
|
871
910
|
/**
|
|
@@ -875,7 +914,7 @@ interface ModifierGroup {
|
|
|
875
914
|
*/
|
|
876
915
|
modifiers?: ItemModifier[];
|
|
877
916
|
}
|
|
878
|
-
interface TranslatableString {
|
|
917
|
+
export interface TranslatableString {
|
|
879
918
|
/**
|
|
880
919
|
* __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).
|
|
881
920
|
*
|
|
@@ -896,13 +935,13 @@ interface TranslatableString {
|
|
|
896
935
|
*/
|
|
897
936
|
translated?: string | null;
|
|
898
937
|
}
|
|
899
|
-
interface ItemModifier {
|
|
938
|
+
export interface ItemModifier {
|
|
900
939
|
/**
|
|
901
940
|
* Modifier ID.
|
|
902
941
|
* @minLength 1
|
|
903
942
|
* @maxLength 36
|
|
904
943
|
*/
|
|
905
|
-
|
|
944
|
+
id?: string;
|
|
906
945
|
/**
|
|
907
946
|
* The quantity of this modifier.
|
|
908
947
|
* @min 1
|
|
@@ -917,14 +956,14 @@ interface ItemModifier {
|
|
|
917
956
|
price?: MultiCurrencyPrice;
|
|
918
957
|
}
|
|
919
958
|
/** Billing Info and shipping details */
|
|
920
|
-
interface AddressWithContact {
|
|
959
|
+
export interface AddressWithContact {
|
|
921
960
|
/** Address. */
|
|
922
961
|
address?: ApiAddress;
|
|
923
962
|
/** Contact details. */
|
|
924
963
|
contactDetails?: FullAddressContactDetails;
|
|
925
964
|
}
|
|
926
965
|
/** Physical address */
|
|
927
|
-
interface ApiAddress {
|
|
966
|
+
export interface ApiAddress {
|
|
928
967
|
/**
|
|
929
968
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
930
969
|
* @format COUNTRY
|
|
@@ -951,7 +990,7 @@ interface ApiAddress {
|
|
|
951
990
|
* Main address line (usually street name and number).
|
|
952
991
|
* @maxLength 150
|
|
953
992
|
*/
|
|
954
|
-
|
|
993
|
+
addressLine?: string | null;
|
|
955
994
|
/**
|
|
956
995
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
957
996
|
* @maxLength 100
|
|
@@ -968,20 +1007,20 @@ interface ApiAddress {
|
|
|
968
1007
|
*/
|
|
969
1008
|
subdivisionFullname?: string | null;
|
|
970
1009
|
}
|
|
971
|
-
interface StreetAddress {
|
|
1010
|
+
export interface StreetAddress {
|
|
972
1011
|
/** Street number. */
|
|
973
1012
|
number?: string;
|
|
974
1013
|
/** Street name. */
|
|
975
1014
|
name?: string;
|
|
976
1015
|
}
|
|
977
|
-
interface AddressLocation {
|
|
1016
|
+
export interface AddressLocation {
|
|
978
1017
|
/** Address latitude. */
|
|
979
1018
|
latitude?: number | null;
|
|
980
1019
|
/** Address longitude. */
|
|
981
1020
|
longitude?: number | null;
|
|
982
1021
|
}
|
|
983
1022
|
/** Full contact details for an address */
|
|
984
|
-
interface FullAddressContactDetails {
|
|
1023
|
+
export interface FullAddressContactDetails {
|
|
985
1024
|
/**
|
|
986
1025
|
* First name.
|
|
987
1026
|
* @maxLength 100
|
|
@@ -1005,9 +1044,9 @@ interface FullAddressContactDetails {
|
|
|
1005
1044
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1006
1045
|
vatId?: CommonVatId;
|
|
1007
1046
|
}
|
|
1008
|
-
interface CommonVatId {
|
|
1047
|
+
export interface CommonVatId {
|
|
1009
1048
|
/** Customer's tax ID. */
|
|
1010
|
-
|
|
1049
|
+
id?: string;
|
|
1011
1050
|
/**
|
|
1012
1051
|
* Tax type.
|
|
1013
1052
|
*
|
|
@@ -1018,14 +1057,14 @@ interface CommonVatId {
|
|
|
1018
1057
|
type?: CommonVatType;
|
|
1019
1058
|
}
|
|
1020
1059
|
/** tax info types */
|
|
1021
|
-
declare enum CommonVatType {
|
|
1060
|
+
export declare enum CommonVatType {
|
|
1022
1061
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1023
1062
|
/** CPF - for individual tax payers. */
|
|
1024
1063
|
CPF = "CPF",
|
|
1025
1064
|
/** CNPJ - for corporations */
|
|
1026
1065
|
CNPJ = "CNPJ"
|
|
1027
1066
|
}
|
|
1028
|
-
interface ShippingInfo {
|
|
1067
|
+
export interface ShippingInfo {
|
|
1029
1068
|
/** Shipping address and contact details. */
|
|
1030
1069
|
shippingDestination?: AddressWithContact;
|
|
1031
1070
|
/** Selected option out of the options allowed for the `region`. */
|
|
@@ -1041,7 +1080,7 @@ interface ShippingInfo {
|
|
|
1041
1080
|
*/
|
|
1042
1081
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
1043
1082
|
}
|
|
1044
|
-
interface SelectedCarrierServiceOption {
|
|
1083
|
+
export interface SelectedCarrierServiceOption {
|
|
1045
1084
|
/**
|
|
1046
1085
|
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1047
1086
|
* @maxLength 100
|
|
@@ -1084,7 +1123,7 @@ interface SelectedCarrierServiceOption {
|
|
|
1084
1123
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1085
1124
|
partial?: boolean | null;
|
|
1086
1125
|
}
|
|
1087
|
-
interface DeliveryLogistics {
|
|
1126
|
+
export interface DeliveryLogistics {
|
|
1088
1127
|
/**
|
|
1089
1128
|
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1090
1129
|
* @maxLength 500
|
|
@@ -1098,7 +1137,7 @@ interface DeliveryLogistics {
|
|
|
1098
1137
|
/** Pickup details. */
|
|
1099
1138
|
pickupDetails?: PickupDetails;
|
|
1100
1139
|
}
|
|
1101
|
-
interface PickupDetails {
|
|
1140
|
+
export interface PickupDetails {
|
|
1102
1141
|
/** Pickup address. */
|
|
1103
1142
|
address?: ApiAddress;
|
|
1104
1143
|
/**
|
|
@@ -1109,18 +1148,18 @@ interface PickupDetails {
|
|
|
1109
1148
|
/** Pickup method */
|
|
1110
1149
|
pickupMethod?: PickupMethod;
|
|
1111
1150
|
}
|
|
1112
|
-
declare enum PickupMethod {
|
|
1151
|
+
export declare enum PickupMethod {
|
|
1113
1152
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1114
1153
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1115
1154
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1116
1155
|
}
|
|
1117
|
-
interface DeliveryTimeSlot {
|
|
1156
|
+
export interface DeliveryTimeSlot {
|
|
1118
1157
|
/** starting time of the delivery time slot */
|
|
1119
1158
|
from?: Date | null;
|
|
1120
1159
|
/** ending time of the delivery time slot */
|
|
1121
1160
|
to?: Date | null;
|
|
1122
1161
|
}
|
|
1123
|
-
interface SelectedCarrierServiceOptionPrices {
|
|
1162
|
+
export interface SelectedCarrierServiceOptionPrices {
|
|
1124
1163
|
/** Total shipping price, after discount and after tax. */
|
|
1125
1164
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1126
1165
|
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
@@ -1132,7 +1171,7 @@ interface SelectedCarrierServiceOptionPrices {
|
|
|
1132
1171
|
/** Shipping price before discount and before tax. */
|
|
1133
1172
|
price?: MultiCurrencyPrice;
|
|
1134
1173
|
}
|
|
1135
|
-
interface SelectedCarrierServiceOptionOtherCharge {
|
|
1174
|
+
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1136
1175
|
/** Type of additional cost. */
|
|
1137
1176
|
type?: ChargeType;
|
|
1138
1177
|
/**
|
|
@@ -1143,11 +1182,11 @@ interface SelectedCarrierServiceOptionOtherCharge {
|
|
|
1143
1182
|
/** Price of added charge. */
|
|
1144
1183
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
1145
1184
|
}
|
|
1146
|
-
declare enum ChargeType {
|
|
1185
|
+
export declare enum ChargeType {
|
|
1147
1186
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1148
1187
|
INSURANCE = "INSURANCE"
|
|
1149
1188
|
}
|
|
1150
|
-
interface DeliveryAllocation {
|
|
1189
|
+
export interface DeliveryAllocation {
|
|
1151
1190
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1152
1191
|
deliveryCarrier?: Carrier;
|
|
1153
1192
|
/** The delivery region that are relevant for this delivery solution. */
|
|
@@ -1155,7 +1194,7 @@ interface DeliveryAllocation {
|
|
|
1155
1194
|
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
1156
1195
|
applicableLineItems?: ApplicableLineItems;
|
|
1157
1196
|
}
|
|
1158
|
-
interface Carrier {
|
|
1197
|
+
export interface Carrier {
|
|
1159
1198
|
/**
|
|
1160
1199
|
* The carrier app id
|
|
1161
1200
|
* @format GUID
|
|
@@ -1167,19 +1206,19 @@ interface Carrier {
|
|
|
1167
1206
|
*/
|
|
1168
1207
|
code?: string;
|
|
1169
1208
|
}
|
|
1170
|
-
interface Region {
|
|
1209
|
+
export interface Region {
|
|
1171
1210
|
/**
|
|
1172
1211
|
* The delivery region id.
|
|
1173
1212
|
* @format GUID
|
|
1174
1213
|
*/
|
|
1175
|
-
|
|
1214
|
+
id?: string | null;
|
|
1176
1215
|
/**
|
|
1177
1216
|
* The delivery region name.
|
|
1178
1217
|
* @maxLength 100
|
|
1179
1218
|
*/
|
|
1180
1219
|
name?: string | null;
|
|
1181
1220
|
}
|
|
1182
|
-
interface ApplicableLineItems {
|
|
1221
|
+
export interface ApplicableLineItems {
|
|
1183
1222
|
/**
|
|
1184
1223
|
* Line items that the delivery solution is for.
|
|
1185
1224
|
* @maxSize 300
|
|
@@ -1188,20 +1227,20 @@ interface ApplicableLineItems {
|
|
|
1188
1227
|
*/
|
|
1189
1228
|
lineItemIds?: string[];
|
|
1190
1229
|
}
|
|
1191
|
-
interface ShippingRegion {
|
|
1230
|
+
export interface ShippingRegion {
|
|
1192
1231
|
/**
|
|
1193
1232
|
* Shipping region ID.
|
|
1194
1233
|
* @format GUID
|
|
1195
1234
|
* @readonly
|
|
1196
1235
|
*/
|
|
1197
|
-
|
|
1236
|
+
id?: string;
|
|
1198
1237
|
/**
|
|
1199
1238
|
* Shipping region name.
|
|
1200
1239
|
* @maxLength 100
|
|
1201
1240
|
*/
|
|
1202
1241
|
name?: string;
|
|
1203
1242
|
}
|
|
1204
|
-
interface CarrierServiceOption {
|
|
1243
|
+
export interface CarrierServiceOption {
|
|
1205
1244
|
/**
|
|
1206
1245
|
* Carrier ID.
|
|
1207
1246
|
* @format GUID
|
|
@@ -1210,7 +1249,7 @@ interface CarrierServiceOption {
|
|
|
1210
1249
|
/** Shipping options offered by this carrier for this request. */
|
|
1211
1250
|
shippingOptions?: ShippingOption[];
|
|
1212
1251
|
}
|
|
1213
|
-
interface ShippingOption {
|
|
1252
|
+
export interface ShippingOption {
|
|
1214
1253
|
/**
|
|
1215
1254
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1216
1255
|
* For legacy calculators this would be the UUID of the option.
|
|
@@ -1235,33 +1274,33 @@ interface ShippingOption {
|
|
|
1235
1274
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1236
1275
|
partial?: boolean | null;
|
|
1237
1276
|
}
|
|
1238
|
-
interface ShippingPrice {
|
|
1277
|
+
export interface ShippingPrice {
|
|
1239
1278
|
/** Shipping price. */
|
|
1240
1279
|
price?: MultiCurrencyPrice;
|
|
1241
1280
|
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
1242
1281
|
otherCharges?: OtherCharge[];
|
|
1243
1282
|
}
|
|
1244
|
-
interface OtherCharge {
|
|
1283
|
+
export interface OtherCharge {
|
|
1245
1284
|
/** Type of additional cost. */
|
|
1246
1285
|
type?: ChargeType;
|
|
1247
1286
|
/** Price of added cost. */
|
|
1248
1287
|
price?: MultiCurrencyPrice;
|
|
1249
1288
|
}
|
|
1250
|
-
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1289
|
+
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1251
1290
|
/**
|
|
1252
|
-
* Visitor ID
|
|
1291
|
+
* Visitor ID (if site visitor is **not** a member).
|
|
1253
1292
|
* @format GUID
|
|
1254
1293
|
* @readonly
|
|
1255
1294
|
*/
|
|
1256
1295
|
visitorId?: string;
|
|
1257
1296
|
/**
|
|
1258
|
-
* Member ID
|
|
1297
|
+
* Member ID (if site visitor is a site member).
|
|
1259
1298
|
* @format GUID
|
|
1260
1299
|
* @readonly
|
|
1261
1300
|
*/
|
|
1262
1301
|
memberId?: string;
|
|
1263
1302
|
/**
|
|
1264
|
-
* Contact ID. For more information, see the Contacts API.
|
|
1303
|
+
* Contact ID. Auto-created if one does not yet exist. For more information, see the Contacts API.
|
|
1265
1304
|
* @format GUID
|
|
1266
1305
|
* @readonly
|
|
1267
1306
|
*/
|
|
@@ -1273,21 +1312,21 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1273
1312
|
email?: string | null;
|
|
1274
1313
|
}
|
|
1275
1314
|
/** @oneof */
|
|
1276
|
-
interface BuyerInfoIdOneOf {
|
|
1315
|
+
export interface BuyerInfoIdOneOf {
|
|
1277
1316
|
/**
|
|
1278
|
-
* Visitor ID
|
|
1317
|
+
* Visitor ID (if site visitor is **not** a member).
|
|
1279
1318
|
* @format GUID
|
|
1280
1319
|
* @readonly
|
|
1281
1320
|
*/
|
|
1282
1321
|
visitorId?: string;
|
|
1283
1322
|
/**
|
|
1284
|
-
* Member ID
|
|
1323
|
+
* Member ID (if site visitor is a site member).
|
|
1285
1324
|
* @format GUID
|
|
1286
1325
|
* @readonly
|
|
1287
1326
|
*/
|
|
1288
1327
|
memberId?: string;
|
|
1289
1328
|
}
|
|
1290
|
-
interface PriceSummary {
|
|
1329
|
+
export interface PriceSummary {
|
|
1291
1330
|
/** Subtotal of all line items, before discounts and before tax. */
|
|
1292
1331
|
subtotal?: MultiCurrencyPrice;
|
|
1293
1332
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1301,7 +1340,7 @@ interface PriceSummary {
|
|
|
1301
1340
|
/** Total additional fees price before tax. */
|
|
1302
1341
|
additionalFees?: MultiCurrencyPrice;
|
|
1303
1342
|
}
|
|
1304
|
-
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1343
|
+
export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1305
1344
|
/** General shipping calculation error. */
|
|
1306
1345
|
generalShippingCalculationError?: Details;
|
|
1307
1346
|
/** Carrier errors. */
|
|
@@ -1323,13 +1362,13 @@ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOne
|
|
|
1323
1362
|
discountsCalculationError?: Details;
|
|
1324
1363
|
}
|
|
1325
1364
|
/** @oneof */
|
|
1326
|
-
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1365
|
+
export interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1327
1366
|
/** General shipping calculation error. */
|
|
1328
1367
|
generalShippingCalculationError?: Details;
|
|
1329
1368
|
/** Carrier errors. */
|
|
1330
1369
|
carrierErrors?: CarrierErrors;
|
|
1331
1370
|
}
|
|
1332
|
-
interface Details extends DetailsKindOneOf {
|
|
1371
|
+
export interface Details extends DetailsKindOneOf {
|
|
1333
1372
|
applicationError?: ApplicationError;
|
|
1334
1373
|
validationError?: ValidationError;
|
|
1335
1374
|
systemError?: SystemError;
|
|
@@ -1340,12 +1379,12 @@ interface Details extends DetailsKindOneOf {
|
|
|
1340
1379
|
tracing?: Record<string, string>;
|
|
1341
1380
|
}
|
|
1342
1381
|
/** @oneof */
|
|
1343
|
-
interface DetailsKindOneOf {
|
|
1382
|
+
export interface DetailsKindOneOf {
|
|
1344
1383
|
applicationError?: ApplicationError;
|
|
1345
1384
|
validationError?: ValidationError;
|
|
1346
1385
|
systemError?: SystemError;
|
|
1347
1386
|
}
|
|
1348
|
-
interface ApplicationError {
|
|
1387
|
+
export interface ApplicationError {
|
|
1349
1388
|
/** Error code. */
|
|
1350
1389
|
code?: string;
|
|
1351
1390
|
/** Description of the error. */
|
|
@@ -1385,10 +1424,10 @@ interface ApplicationError {
|
|
|
1385
1424
|
* ]
|
|
1386
1425
|
* }
|
|
1387
1426
|
*/
|
|
1388
|
-
interface ValidationError {
|
|
1427
|
+
export interface ValidationError {
|
|
1389
1428
|
fieldViolations?: FieldViolation[];
|
|
1390
1429
|
}
|
|
1391
|
-
declare enum RuleType {
|
|
1430
|
+
export declare enum RuleType {
|
|
1392
1431
|
VALIDATION = "VALIDATION",
|
|
1393
1432
|
OTHER = "OTHER",
|
|
1394
1433
|
MAX = "MAX",
|
|
@@ -1411,7 +1450,7 @@ declare enum RuleType {
|
|
|
1411
1450
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1412
1451
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1413
1452
|
}
|
|
1414
|
-
interface FieldViolation {
|
|
1453
|
+
export interface FieldViolation {
|
|
1415
1454
|
field?: string;
|
|
1416
1455
|
description?: string;
|
|
1417
1456
|
violatedRule?: RuleType;
|
|
@@ -1419,26 +1458,26 @@ interface FieldViolation {
|
|
|
1419
1458
|
ruleName?: string | null;
|
|
1420
1459
|
data?: Record<string, any> | null;
|
|
1421
1460
|
}
|
|
1422
|
-
interface SystemError {
|
|
1461
|
+
export interface SystemError {
|
|
1423
1462
|
/** Error code. */
|
|
1424
1463
|
errorCode?: string | null;
|
|
1425
1464
|
}
|
|
1426
|
-
interface CarrierErrors {
|
|
1465
|
+
export interface CarrierErrors {
|
|
1427
1466
|
/** Carrier errors. */
|
|
1428
1467
|
errors?: CarrierError[];
|
|
1429
1468
|
}
|
|
1430
|
-
interface CarrierError {
|
|
1469
|
+
export interface CarrierError {
|
|
1431
1470
|
/** Carrier ID. */
|
|
1432
1471
|
carrierId?: string;
|
|
1433
1472
|
/** Error details. */
|
|
1434
1473
|
error?: Details;
|
|
1435
1474
|
}
|
|
1436
|
-
interface GiftCard {
|
|
1475
|
+
export interface GiftCard {
|
|
1437
1476
|
/**
|
|
1438
1477
|
* Gift Card ID.
|
|
1439
1478
|
* @deprecated
|
|
1440
1479
|
*/
|
|
1441
|
-
|
|
1480
|
+
id?: string;
|
|
1442
1481
|
/** Gift card obfuscated code. */
|
|
1443
1482
|
obfuscatedCode?: string;
|
|
1444
1483
|
/** Gift card value. */
|
|
@@ -1456,7 +1495,7 @@ interface GiftCard {
|
|
|
1456
1495
|
*/
|
|
1457
1496
|
externalId?: string | null;
|
|
1458
1497
|
}
|
|
1459
|
-
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1498
|
+
export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1460
1499
|
/** Coupon details. */
|
|
1461
1500
|
coupon?: Coupon;
|
|
1462
1501
|
/** Merchant discount. */
|
|
@@ -1466,7 +1505,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1466
1505
|
/** Discount type. */
|
|
1467
1506
|
discountType?: DiscountType;
|
|
1468
1507
|
/**
|
|
1469
|
-
* IDs of
|
|
1508
|
+
* IDs of line items the discount applies to.
|
|
1470
1509
|
* @format GUID
|
|
1471
1510
|
* @deprecated IDs of line items the discount applies to.
|
|
1472
1511
|
* @replacedBy line_items_discounts
|
|
@@ -1475,7 +1514,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1475
1514
|
lineItemIds?: string[];
|
|
1476
1515
|
}
|
|
1477
1516
|
/** @oneof */
|
|
1478
|
-
interface AppliedDiscountDiscountSourceOneOf {
|
|
1517
|
+
export interface AppliedDiscountDiscountSourceOneOf {
|
|
1479
1518
|
/** Coupon details. */
|
|
1480
1519
|
coupon?: Coupon;
|
|
1481
1520
|
/** Merchant discount. */
|
|
@@ -1483,15 +1522,15 @@ interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1483
1522
|
/** Discount rule */
|
|
1484
1523
|
discountRule?: DiscountRule;
|
|
1485
1524
|
}
|
|
1486
|
-
declare enum DiscountType {
|
|
1525
|
+
export declare enum DiscountType {
|
|
1487
1526
|
GLOBAL = "GLOBAL",
|
|
1488
1527
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1489
1528
|
SHIPPING = "SHIPPING"
|
|
1490
1529
|
}
|
|
1491
1530
|
/** Coupon */
|
|
1492
|
-
interface Coupon {
|
|
1531
|
+
export interface Coupon {
|
|
1493
1532
|
/** Coupon ID. */
|
|
1494
|
-
|
|
1533
|
+
id?: string;
|
|
1495
1534
|
/** Coupon code. */
|
|
1496
1535
|
code?: string;
|
|
1497
1536
|
/** Coupon value. */
|
|
@@ -1499,7 +1538,7 @@ interface Coupon {
|
|
|
1499
1538
|
/** Coupon name. */
|
|
1500
1539
|
name?: string;
|
|
1501
1540
|
}
|
|
1502
|
-
interface MerchantDiscount {
|
|
1541
|
+
export interface MerchantDiscount {
|
|
1503
1542
|
/** Discount value. */
|
|
1504
1543
|
amount?: MultiCurrencyPrice;
|
|
1505
1544
|
/**
|
|
@@ -1509,18 +1548,18 @@ interface MerchantDiscount {
|
|
|
1509
1548
|
*/
|
|
1510
1549
|
percentage?: number | null;
|
|
1511
1550
|
}
|
|
1512
|
-
interface DiscountRule {
|
|
1551
|
+
export interface DiscountRule {
|
|
1513
1552
|
/**
|
|
1514
1553
|
* Discount rule ID
|
|
1515
1554
|
* @format GUID
|
|
1516
1555
|
*/
|
|
1517
|
-
|
|
1556
|
+
id?: string;
|
|
1518
1557
|
/** Discount rule name */
|
|
1519
1558
|
name?: DiscountRuleName;
|
|
1520
1559
|
/** Discount value. */
|
|
1521
1560
|
amount?: MultiCurrencyPrice;
|
|
1522
1561
|
}
|
|
1523
|
-
interface DiscountRuleName {
|
|
1562
|
+
export interface DiscountRuleName {
|
|
1524
1563
|
/**
|
|
1525
1564
|
* Original discount rule name (in site's default language).
|
|
1526
1565
|
* @minLength 1
|
|
@@ -1534,16 +1573,16 @@ interface DiscountRuleName {
|
|
|
1534
1573
|
*/
|
|
1535
1574
|
translated?: string | null;
|
|
1536
1575
|
}
|
|
1537
|
-
interface LineItemDiscount {
|
|
1576
|
+
export interface LineItemDiscount {
|
|
1538
1577
|
/**
|
|
1539
1578
|
* ID of line item the discount applies to.
|
|
1540
1579
|
* @format GUID
|
|
1541
1580
|
*/
|
|
1542
|
-
|
|
1581
|
+
id?: string;
|
|
1543
1582
|
/** Discount value. */
|
|
1544
1583
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
1545
1584
|
}
|
|
1546
|
-
interface CustomField {
|
|
1585
|
+
export interface CustomField {
|
|
1547
1586
|
/** Custom field value. */
|
|
1548
1587
|
value?: any;
|
|
1549
1588
|
/**
|
|
@@ -1559,7 +1598,7 @@ interface CustomField {
|
|
|
1559
1598
|
*/
|
|
1560
1599
|
translatedTitle?: string | null;
|
|
1561
1600
|
}
|
|
1562
|
-
declare enum WeightUnit {
|
|
1601
|
+
export declare enum WeightUnit {
|
|
1563
1602
|
/** Weight unit can't be classified due to an error. */
|
|
1564
1603
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1565
1604
|
/** Kilograms. */
|
|
@@ -1567,7 +1606,7 @@ declare enum WeightUnit {
|
|
|
1567
1606
|
/** Pounds. */
|
|
1568
1607
|
LB = "LB"
|
|
1569
1608
|
}
|
|
1570
|
-
interface TaxSummary {
|
|
1609
|
+
export interface TaxSummary {
|
|
1571
1610
|
/**
|
|
1572
1611
|
* Amount for which tax is calculated, added from line items.
|
|
1573
1612
|
* @readonly
|
|
@@ -1584,7 +1623,7 @@ interface TaxSummary {
|
|
|
1584
1623
|
*/
|
|
1585
1624
|
calculationDetails?: TaxCalculationDetails;
|
|
1586
1625
|
}
|
|
1587
|
-
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1626
|
+
export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1588
1627
|
/** Reason the manual calculation was used. */
|
|
1589
1628
|
manualRateReason?: ManualCalculationReason;
|
|
1590
1629
|
/** Details of the fallback rate calculation. */
|
|
@@ -1593,13 +1632,13 @@ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsO
|
|
|
1593
1632
|
rateType?: RateType;
|
|
1594
1633
|
}
|
|
1595
1634
|
/** @oneof */
|
|
1596
|
-
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1635
|
+
export interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1597
1636
|
/** Reason the manual calculation was used. */
|
|
1598
1637
|
manualRateReason?: ManualCalculationReason;
|
|
1599
1638
|
/** Details of the fallback rate calculation. */
|
|
1600
1639
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1601
1640
|
}
|
|
1602
|
-
declare enum RateType {
|
|
1641
|
+
export declare enum RateType {
|
|
1603
1642
|
/** no tax being collected for this request due to location of purchase */
|
|
1604
1643
|
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
1605
1644
|
/** manual rate used for calculation */
|
|
@@ -1609,19 +1648,19 @@ declare enum RateType {
|
|
|
1609
1648
|
/** fallback rate used for calculation */
|
|
1610
1649
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1611
1650
|
}
|
|
1612
|
-
declare enum ManualCalculationReason {
|
|
1651
|
+
export declare enum ManualCalculationReason {
|
|
1613
1652
|
/** user set calculator in Business Manager to be Manual */
|
|
1614
1653
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1615
1654
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1616
1655
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1617
1656
|
}
|
|
1618
|
-
interface AutoTaxFallbackCalculationDetails {
|
|
1657
|
+
export interface AutoTaxFallbackCalculationDetails {
|
|
1619
1658
|
/** reason for fallback */
|
|
1620
1659
|
fallbackReason?: FallbackReason;
|
|
1621
1660
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1622
1661
|
error?: ApplicationError;
|
|
1623
1662
|
}
|
|
1624
|
-
declare enum FallbackReason {
|
|
1663
|
+
export declare enum FallbackReason {
|
|
1625
1664
|
/** auto-tax failed to be calculated */
|
|
1626
1665
|
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
1627
1666
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
@@ -1631,7 +1670,7 @@ declare enum FallbackReason {
|
|
|
1631
1670
|
* 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.
|
|
1632
1671
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1633
1672
|
*/
|
|
1634
|
-
interface AggregatedTaxBreakdown {
|
|
1673
|
+
export interface AggregatedTaxBreakdown {
|
|
1635
1674
|
/**
|
|
1636
1675
|
* The name of the tax against which this tax amount was calculated.
|
|
1637
1676
|
* @maxLength 200
|
|
@@ -1657,7 +1696,7 @@ interface AggregatedTaxBreakdown {
|
|
|
1657
1696
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1658
1697
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
1659
1698
|
}
|
|
1660
|
-
declare enum ChannelType {
|
|
1699
|
+
export declare enum ChannelType {
|
|
1661
1700
|
/** Unspecified sales channel. This value is not supported. */
|
|
1662
1701
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1663
1702
|
/** A web client. */
|
|
@@ -1691,7 +1730,7 @@ declare enum ChannelType {
|
|
|
1691
1730
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1692
1731
|
FAIRE_COM = "FAIRE_COM"
|
|
1693
1732
|
}
|
|
1694
|
-
interface CreatedBy extends CreatedByIdOneOf {
|
|
1733
|
+
export interface CreatedBy extends CreatedByIdOneOf {
|
|
1695
1734
|
/**
|
|
1696
1735
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1697
1736
|
* For example, via POS (point of service).
|
|
@@ -1715,7 +1754,7 @@ interface CreatedBy extends CreatedByIdOneOf {
|
|
|
1715
1754
|
appId?: string;
|
|
1716
1755
|
}
|
|
1717
1756
|
/** @oneof */
|
|
1718
|
-
interface CreatedByIdOneOf {
|
|
1757
|
+
export interface CreatedByIdOneOf {
|
|
1719
1758
|
/**
|
|
1720
1759
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1721
1760
|
* For example, via POS (point of service).
|
|
@@ -1739,7 +1778,7 @@ interface CreatedByIdOneOf {
|
|
|
1739
1778
|
appId?: string;
|
|
1740
1779
|
}
|
|
1741
1780
|
/** Reserved for internal use. */
|
|
1742
|
-
interface MembershipOptions {
|
|
1781
|
+
export interface MembershipOptions {
|
|
1743
1782
|
/**
|
|
1744
1783
|
* Reserved for internal use.
|
|
1745
1784
|
* @readonly
|
|
@@ -1755,13 +1794,13 @@ interface MembershipOptions {
|
|
|
1755
1794
|
/** Selected membership to apply to this checkout. */
|
|
1756
1795
|
selectedMemberships?: SelectedMemberships;
|
|
1757
1796
|
}
|
|
1758
|
-
interface Membership {
|
|
1797
|
+
export interface Membership {
|
|
1759
1798
|
/**
|
|
1760
1799
|
* Membership ID.
|
|
1761
1800
|
* @minLength 1
|
|
1762
1801
|
* @maxLength 100
|
|
1763
1802
|
*/
|
|
1764
|
-
|
|
1803
|
+
id?: string;
|
|
1765
1804
|
/**
|
|
1766
1805
|
* ID of the application providing this payment option.
|
|
1767
1806
|
* @format GUID
|
|
@@ -1770,7 +1809,7 @@ interface Membership {
|
|
|
1770
1809
|
/** The name of this membership. */
|
|
1771
1810
|
name?: MembershipName;
|
|
1772
1811
|
/**
|
|
1773
|
-
* Line item IDs which are "paid for
|
|
1812
|
+
* Line item IDs which are "paid" for by this membership.
|
|
1774
1813
|
* @minSize 1
|
|
1775
1814
|
* @maxSize 300
|
|
1776
1815
|
* @minLength 1
|
|
@@ -1784,7 +1823,7 @@ interface Membership {
|
|
|
1784
1823
|
/** Additional data about this membership. */
|
|
1785
1824
|
additionalData?: Record<string, any> | null;
|
|
1786
1825
|
}
|
|
1787
|
-
interface MembershipName {
|
|
1826
|
+
export interface MembershipName {
|
|
1788
1827
|
/**
|
|
1789
1828
|
* Membership name.
|
|
1790
1829
|
* @maxLength 100
|
|
@@ -1796,7 +1835,7 @@ interface MembershipName {
|
|
|
1796
1835
|
*/
|
|
1797
1836
|
translated?: string | null;
|
|
1798
1837
|
}
|
|
1799
|
-
interface MembershipPaymentCredits {
|
|
1838
|
+
export interface MembershipPaymentCredits {
|
|
1800
1839
|
/**
|
|
1801
1840
|
* Membership's total amount of credits.
|
|
1802
1841
|
* @min 1
|
|
@@ -1805,7 +1844,7 @@ interface MembershipPaymentCredits {
|
|
|
1805
1844
|
/** Membership's remaining amount of credits. */
|
|
1806
1845
|
remaining?: number;
|
|
1807
1846
|
}
|
|
1808
|
-
interface InvalidMembership {
|
|
1847
|
+
export interface InvalidMembership {
|
|
1809
1848
|
/** Membership details. */
|
|
1810
1849
|
membership?: Membership;
|
|
1811
1850
|
/**
|
|
@@ -1815,20 +1854,20 @@ interface InvalidMembership {
|
|
|
1815
1854
|
*/
|
|
1816
1855
|
reason?: string;
|
|
1817
1856
|
}
|
|
1818
|
-
interface SelectedMemberships {
|
|
1857
|
+
export interface SelectedMemberships {
|
|
1819
1858
|
/**
|
|
1820
1859
|
* Selected memberships.
|
|
1821
1860
|
* @maxSize 300
|
|
1822
1861
|
*/
|
|
1823
1862
|
memberships?: SelectedMembership[];
|
|
1824
1863
|
}
|
|
1825
|
-
interface SelectedMembership {
|
|
1864
|
+
export interface SelectedMembership {
|
|
1826
1865
|
/**
|
|
1827
1866
|
* Membership ID.
|
|
1828
1867
|
* @minLength 1
|
|
1829
1868
|
* @maxLength 100
|
|
1830
1869
|
*/
|
|
1831
|
-
|
|
1870
|
+
id?: string;
|
|
1832
1871
|
/**
|
|
1833
1872
|
* ID of the app providing this payment option.
|
|
1834
1873
|
* @format GUID
|
|
@@ -1843,7 +1882,7 @@ interface SelectedMembership {
|
|
|
1843
1882
|
*/
|
|
1844
1883
|
lineItemIds?: string[];
|
|
1845
1884
|
}
|
|
1846
|
-
interface AdditionalFee {
|
|
1885
|
+
export interface AdditionalFee {
|
|
1847
1886
|
/**
|
|
1848
1887
|
* Additional fee's unique code (or ID) for future processing.
|
|
1849
1888
|
* @minLength 1
|
|
@@ -1879,7 +1918,7 @@ interface AdditionalFee {
|
|
|
1879
1918
|
/** the source the additional fee was added from */
|
|
1880
1919
|
source?: AdditionalFeeSource;
|
|
1881
1920
|
}
|
|
1882
|
-
declare enum AdditionalFeeSource {
|
|
1921
|
+
export declare enum AdditionalFeeSource {
|
|
1883
1922
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
1884
1923
|
/** The additional fee was added by an additional fee service plugin */
|
|
1885
1924
|
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
@@ -1888,7 +1927,7 @@ declare enum AdditionalFeeSource {
|
|
|
1888
1927
|
/** The additional fee was added manually on the request */
|
|
1889
1928
|
MANUAL = "MANUAL"
|
|
1890
1929
|
}
|
|
1891
|
-
interface ConversionInfo {
|
|
1930
|
+
export interface ConversionInfo {
|
|
1892
1931
|
/**
|
|
1893
1932
|
* The site currency.
|
|
1894
1933
|
* @readonly
|
|
@@ -1902,7 +1941,7 @@ interface ConversionInfo {
|
|
|
1902
1941
|
*/
|
|
1903
1942
|
conversionRate?: string;
|
|
1904
1943
|
}
|
|
1905
|
-
interface Violation {
|
|
1944
|
+
export interface Violation {
|
|
1906
1945
|
/** 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. */
|
|
1907
1946
|
severity?: Severity;
|
|
1908
1947
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
@@ -1914,7 +1953,7 @@ interface Violation {
|
|
|
1914
1953
|
*/
|
|
1915
1954
|
description?: string | null;
|
|
1916
1955
|
}
|
|
1917
|
-
declare enum Severity {
|
|
1956
|
+
export declare enum Severity {
|
|
1918
1957
|
/** The user is allowed to move forward in the flow. */
|
|
1919
1958
|
WARNING = "WARNING",
|
|
1920
1959
|
/**
|
|
@@ -1923,48 +1962,48 @@ declare enum Severity {
|
|
|
1923
1962
|
*/
|
|
1924
1963
|
ERROR = "ERROR"
|
|
1925
1964
|
}
|
|
1926
|
-
interface Target extends TargetTargetTypeOneOf {
|
|
1965
|
+
export interface Target extends TargetTargetTypeOneOf {
|
|
1927
1966
|
/** General (other) violation. */
|
|
1928
1967
|
other?: Other;
|
|
1929
1968
|
/** Specific line item violation. */
|
|
1930
1969
|
lineItem?: TargetLineItem;
|
|
1931
1970
|
}
|
|
1932
1971
|
/** @oneof */
|
|
1933
|
-
interface TargetTargetTypeOneOf {
|
|
1972
|
+
export interface TargetTargetTypeOneOf {
|
|
1934
1973
|
/** General (other) violation. */
|
|
1935
1974
|
other?: Other;
|
|
1936
1975
|
/** Specific line item violation. */
|
|
1937
1976
|
lineItem?: TargetLineItem;
|
|
1938
1977
|
}
|
|
1939
1978
|
/** Available locations on the webpage */
|
|
1940
|
-
declare enum NameInOther {
|
|
1979
|
+
export declare enum NameInOther {
|
|
1941
1980
|
/** Default location, in case no specific location is specified. */
|
|
1942
1981
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
1943
1982
|
}
|
|
1944
1983
|
/** Available locations on the line item */
|
|
1945
|
-
declare enum NameInLineItem {
|
|
1984
|
+
export declare enum NameInLineItem {
|
|
1946
1985
|
/** Default location, in case no specific location is specified. */
|
|
1947
1986
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
1948
1987
|
}
|
|
1949
|
-
declare enum SuggestedFix {
|
|
1988
|
+
export declare enum SuggestedFix {
|
|
1950
1989
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
1951
1990
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
1952
1991
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
1953
1992
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
1954
1993
|
}
|
|
1955
1994
|
/** General (other) violation. */
|
|
1956
|
-
interface Other {
|
|
1995
|
+
export interface Other {
|
|
1957
1996
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
1958
1997
|
name?: NameInOther;
|
|
1959
1998
|
}
|
|
1960
1999
|
/** Specific line item violation. */
|
|
1961
|
-
interface TargetLineItem {
|
|
2000
|
+
export interface TargetLineItem {
|
|
1962
2001
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
1963
2002
|
name?: NameInLineItem;
|
|
1964
2003
|
/** ID of the line item containing the violation. */
|
|
1965
|
-
|
|
2004
|
+
id?: string | null;
|
|
1966
2005
|
}
|
|
1967
|
-
interface CustomSettings {
|
|
2006
|
+
export interface CustomSettings {
|
|
1968
2007
|
/**
|
|
1969
2008
|
* Whether to restrict the option to add or remove a gift card on the checkout page.
|
|
1970
2009
|
*
|
|
@@ -1990,7 +2029,7 @@ interface CustomSettings {
|
|
|
1990
2029
|
*/
|
|
1991
2030
|
disabledManualPayment?: boolean;
|
|
1992
2031
|
}
|
|
1993
|
-
interface CustomContentReference {
|
|
2032
|
+
export interface CustomContentReference {
|
|
1994
2033
|
/**
|
|
1995
2034
|
* ID of the app providing the content.
|
|
1996
2035
|
*
|
|
@@ -2006,7 +2045,7 @@ interface CustomContentReference {
|
|
|
2006
2045
|
*/
|
|
2007
2046
|
componentId?: string;
|
|
2008
2047
|
}
|
|
2009
|
-
interface ExternalReference {
|
|
2048
|
+
export interface ExternalReference {
|
|
2010
2049
|
/**
|
|
2011
2050
|
* ID of the app associated with the purchase flow.
|
|
2012
2051
|
* For example, the Wix Pay Links app ID.
|
|
@@ -2023,7 +2062,7 @@ interface ExternalReference {
|
|
|
2023
2062
|
*/
|
|
2024
2063
|
resourceId?: string | null;
|
|
2025
2064
|
}
|
|
2026
|
-
interface SubscriptionCharges {
|
|
2065
|
+
export interface SubscriptionCharges {
|
|
2027
2066
|
/**
|
|
2028
2067
|
* ids of the items the subscription is defined on
|
|
2029
2068
|
* @format GUID
|
|
@@ -2043,7 +2082,7 @@ interface SubscriptionCharges {
|
|
|
2043
2082
|
*/
|
|
2044
2083
|
charges?: Charge[];
|
|
2045
2084
|
}
|
|
2046
|
-
interface Charge {
|
|
2085
|
+
export interface Charge {
|
|
2047
2086
|
/** The cycle number from which the charge starts. */
|
|
2048
2087
|
cycleFrom?: number;
|
|
2049
2088
|
/** The number of cycles for which the charge is applicable. */
|
|
@@ -2053,16 +2092,16 @@ interface Charge {
|
|
|
2053
2092
|
/** The billing date from which the charge starts. */
|
|
2054
2093
|
cycleBillingDate?: Date | null;
|
|
2055
2094
|
}
|
|
2056
|
-
interface UpdatedCheckoutMessage {
|
|
2095
|
+
export interface UpdatedCheckoutMessage {
|
|
2057
2096
|
/** Previous checkout. */
|
|
2058
2097
|
oldCheckout?: Checkout;
|
|
2059
2098
|
/** Updated checkout. */
|
|
2060
2099
|
updatedCheckout?: Checkout;
|
|
2061
2100
|
}
|
|
2062
|
-
interface CreateCheckoutRequest {
|
|
2101
|
+
export interface CreateCheckoutRequest {
|
|
2063
2102
|
/** Checkout information. */
|
|
2064
2103
|
checkoutInfo?: Checkout;
|
|
2065
|
-
/**
|
|
2104
|
+
/** Coupon code. */
|
|
2066
2105
|
couponCode?: string | null;
|
|
2067
2106
|
/**
|
|
2068
2107
|
* Catalog line items to add to the checkout.
|
|
@@ -2090,12 +2129,14 @@ interface CreateCheckoutRequest {
|
|
|
2090
2129
|
/**
|
|
2091
2130
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2092
2131
|
*
|
|
2093
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used
|
|
2132
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
2133
|
+
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2134
|
+
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2094
2135
|
* @maxLength 1000
|
|
2095
2136
|
*/
|
|
2096
2137
|
overrideCheckoutUrl?: string | null;
|
|
2097
2138
|
}
|
|
2098
|
-
interface CustomLineItem {
|
|
2139
|
+
export interface CustomLineItem {
|
|
2099
2140
|
/**
|
|
2100
2141
|
* Custom line item quantity.
|
|
2101
2142
|
*
|
|
@@ -2106,7 +2147,9 @@ interface CustomLineItem {
|
|
|
2106
2147
|
*/
|
|
2107
2148
|
quantity?: number;
|
|
2108
2149
|
/**
|
|
2109
|
-
* Custom line item price.
|
|
2150
|
+
* Custom line item price.
|
|
2151
|
+
*
|
|
2152
|
+
* Must be a number or a decimal without symbols.
|
|
2110
2153
|
* @format DECIMAL_VALUE
|
|
2111
2154
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
2112
2155
|
*/
|
|
@@ -2114,23 +2157,19 @@ interface CustomLineItem {
|
|
|
2114
2157
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
2115
2158
|
priceDescription?: PriceDescription;
|
|
2116
2159
|
/**
|
|
2117
|
-
* Custom line item description lines. Used for
|
|
2160
|
+
* Custom line item description lines. Used for display purposes for the cart, checkout and order.
|
|
2118
2161
|
* @maxSize 10
|
|
2119
2162
|
*/
|
|
2120
2163
|
descriptionLines?: DescriptionLine[];
|
|
2121
|
-
/**
|
|
2122
|
-
|
|
2123
|
-
* + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
|
|
2124
|
-
* + An image from the web - `"http(s)://<image url>"`.
|
|
2125
|
-
*/
|
|
2126
|
-
media?: string;
|
|
2164
|
+
/** Custom line item's media. */
|
|
2165
|
+
media?: Image;
|
|
2127
2166
|
/**
|
|
2128
2167
|
* Custom line item ID. If passed, `id` must be unique.
|
|
2129
2168
|
*
|
|
2130
2169
|
* Default: auto-generated ID
|
|
2131
2170
|
* @format GUID
|
|
2132
2171
|
*/
|
|
2133
|
-
|
|
2172
|
+
id?: string | null;
|
|
2134
2173
|
/**
|
|
2135
2174
|
* Tax group ID for this custom line item.
|
|
2136
2175
|
* @format GUID
|
|
@@ -2139,7 +2178,7 @@ interface CustomLineItem {
|
|
|
2139
2178
|
/** Name of the item or product. */
|
|
2140
2179
|
productName?: ProductName;
|
|
2141
2180
|
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
2142
|
-
url?:
|
|
2181
|
+
url?: PageUrlV2;
|
|
2143
2182
|
/** Item type. Either a preset type or custom. */
|
|
2144
2183
|
itemType?: ItemType;
|
|
2145
2184
|
/**
|
|
@@ -2209,98 +2248,104 @@ interface CustomLineItem {
|
|
|
2209
2248
|
*/
|
|
2210
2249
|
savePaymentMethod?: boolean;
|
|
2211
2250
|
}
|
|
2212
|
-
interface MerchantDiscountInput {
|
|
2251
|
+
export interface MerchantDiscountInput {
|
|
2213
2252
|
/**
|
|
2214
2253
|
* Discount amount.
|
|
2215
2254
|
* @decimalValue options { gte:0 }
|
|
2216
2255
|
*/
|
|
2217
2256
|
amount?: string;
|
|
2218
2257
|
/**
|
|
2219
|
-
* IDs of
|
|
2258
|
+
* IDs of line items the discount applies to.
|
|
2220
2259
|
* @format GUID
|
|
2221
2260
|
* @maxSize 300
|
|
2222
2261
|
*/
|
|
2223
2262
|
lineItemIds?: string[];
|
|
2224
2263
|
}
|
|
2225
|
-
interface CreateCheckoutResponse {
|
|
2264
|
+
export interface CreateCheckoutResponse {
|
|
2226
2265
|
/** Newly created checkout. */
|
|
2227
2266
|
checkout?: Checkout;
|
|
2228
2267
|
}
|
|
2229
|
-
interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2268
|
+
export interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2230
2269
|
generalShippingCalculationError?: Details;
|
|
2231
2270
|
carrierErrors?: CarrierErrors;
|
|
2232
2271
|
}
|
|
2233
2272
|
/** @oneof */
|
|
2234
|
-
interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2273
|
+
export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2235
2274
|
generalShippingCalculationError?: Details;
|
|
2236
2275
|
carrierErrors?: CarrierErrors;
|
|
2237
2276
|
}
|
|
2238
|
-
interface GetCheckoutRequest {
|
|
2277
|
+
export interface GetCheckoutRequest {
|
|
2239
2278
|
/**
|
|
2240
2279
|
* Checkout ID.
|
|
2241
2280
|
* @format GUID
|
|
2242
2281
|
*/
|
|
2243
|
-
|
|
2282
|
+
id: string;
|
|
2244
2283
|
}
|
|
2245
|
-
interface GetCheckoutResponse {
|
|
2284
|
+
export interface GetCheckoutResponse {
|
|
2246
2285
|
/** Retrieved checkout. */
|
|
2247
2286
|
checkout?: Checkout;
|
|
2248
2287
|
}
|
|
2249
|
-
interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
2288
|
+
export interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
2250
2289
|
/**
|
|
2251
2290
|
* Checkout ID.
|
|
2252
2291
|
* @format GUID
|
|
2253
2292
|
*/
|
|
2254
|
-
|
|
2293
|
+
id?: string;
|
|
2255
2294
|
}
|
|
2256
|
-
interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2295
|
+
export interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2257
2296
|
/** Retrieved checkout. */
|
|
2258
2297
|
checkout?: Checkout;
|
|
2259
2298
|
}
|
|
2260
|
-
interface GetCheckoutByCartIdRequest {
|
|
2299
|
+
export interface GetCheckoutByCartIdRequest {
|
|
2261
2300
|
/**
|
|
2262
2301
|
* Cart ID.
|
|
2263
2302
|
* @format GUID
|
|
2264
2303
|
*/
|
|
2265
|
-
|
|
2304
|
+
id: string;
|
|
2266
2305
|
}
|
|
2267
|
-
interface GetCheckoutByCartIdResponse {
|
|
2306
|
+
export interface GetCheckoutByCartIdResponse {
|
|
2268
2307
|
/** Retrieved checkout. */
|
|
2269
2308
|
checkout?: Checkout;
|
|
2270
2309
|
}
|
|
2271
|
-
interface GetWixCheckoutURLRequest {
|
|
2310
|
+
export interface GetWixCheckoutURLRequest {
|
|
2272
2311
|
/**
|
|
2273
2312
|
* Checkout ID.
|
|
2274
2313
|
* @format GUID
|
|
2275
2314
|
*/
|
|
2276
|
-
|
|
2315
|
+
id: string;
|
|
2277
2316
|
}
|
|
2278
|
-
interface GetWixCheckoutURLResponse {
|
|
2317
|
+
export interface GetWixCheckoutURLResponse {
|
|
2279
2318
|
/** Checkout URL. */
|
|
2280
2319
|
checkoutUrl?: string;
|
|
2281
2320
|
}
|
|
2282
|
-
interface GetCheckoutURLRequest {
|
|
2321
|
+
export interface GetCheckoutURLRequest {
|
|
2283
2322
|
/**
|
|
2284
2323
|
* Checkout ID.
|
|
2285
2324
|
* @format GUID
|
|
2286
2325
|
*/
|
|
2287
|
-
|
|
2326
|
+
id: string;
|
|
2288
2327
|
}
|
|
2289
|
-
interface GetCheckoutURLResponse {
|
|
2328
|
+
export interface GetCheckoutURLResponse {
|
|
2290
2329
|
/** Checkout URL. */
|
|
2291
2330
|
checkoutUrl?: string;
|
|
2292
2331
|
}
|
|
2293
|
-
interface UpdateCheckoutRequest {
|
|
2332
|
+
export interface UpdateCheckoutRequest {
|
|
2294
2333
|
/** Checkout information. */
|
|
2295
2334
|
checkout: Checkout;
|
|
2296
|
-
/**
|
|
2335
|
+
/**
|
|
2336
|
+
* Coupon code.
|
|
2337
|
+
*
|
|
2338
|
+
* The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
|
|
2339
|
+
*/
|
|
2297
2340
|
couponCode?: string | null;
|
|
2298
2341
|
/** Gift card code. */
|
|
2299
2342
|
giftCardCode?: string | null;
|
|
2300
2343
|
/**
|
|
2301
2344
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2302
2345
|
*
|
|
2303
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used
|
|
2346
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
2347
|
+
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2348
|
+
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2304
2349
|
* @maxLength 1000
|
|
2305
2350
|
*/
|
|
2306
2351
|
overrideCheckoutUrl?: string | null;
|
|
@@ -2318,49 +2363,49 @@ interface UpdateCheckoutRequest {
|
|
|
2318
2363
|
*/
|
|
2319
2364
|
customLineItems?: CustomLineItem[];
|
|
2320
2365
|
}
|
|
2321
|
-
interface UpdateCheckoutResponse {
|
|
2366
|
+
export interface UpdateCheckoutResponse {
|
|
2322
2367
|
/** Updated checkout. */
|
|
2323
2368
|
checkout?: Checkout;
|
|
2324
2369
|
}
|
|
2325
|
-
interface RemoveCouponRequest {
|
|
2370
|
+
export interface RemoveCouponRequest {
|
|
2326
2371
|
/**
|
|
2327
2372
|
* ID of the checkout to remove the coupon from.
|
|
2328
2373
|
* @format GUID
|
|
2329
2374
|
*/
|
|
2330
|
-
|
|
2375
|
+
id: string;
|
|
2331
2376
|
}
|
|
2332
|
-
interface RemoveCouponResponse {
|
|
2377
|
+
export interface RemoveCouponResponse {
|
|
2333
2378
|
/** Updated checkout after removal of coupon. */
|
|
2334
2379
|
checkout?: Checkout;
|
|
2335
2380
|
}
|
|
2336
|
-
interface RemoveGiftCardRequest {
|
|
2381
|
+
export interface RemoveGiftCardRequest {
|
|
2337
2382
|
/**
|
|
2338
2383
|
* ID of the checkout to remove the gift card from.
|
|
2339
2384
|
* @format GUID
|
|
2340
2385
|
*/
|
|
2341
|
-
|
|
2386
|
+
id: string;
|
|
2342
2387
|
}
|
|
2343
|
-
interface RemoveGiftCardResponse {
|
|
2388
|
+
export interface RemoveGiftCardResponse {
|
|
2344
2389
|
/** Updated checkout after removal of gift card. */
|
|
2345
2390
|
checkout?: Checkout;
|
|
2346
2391
|
}
|
|
2347
|
-
interface RemoveOverrideCheckoutUrlRequest {
|
|
2392
|
+
export interface RemoveOverrideCheckoutUrlRequest {
|
|
2348
2393
|
/**
|
|
2349
2394
|
* ID of the checkout to remove the override checkout url from.
|
|
2350
2395
|
* @format GUID
|
|
2351
2396
|
*/
|
|
2352
|
-
|
|
2397
|
+
id: string;
|
|
2353
2398
|
}
|
|
2354
|
-
interface RemoveOverrideCheckoutUrlResponse {
|
|
2399
|
+
export interface RemoveOverrideCheckoutUrlResponse {
|
|
2355
2400
|
/** Updated checkout after removal of override checkout url. */
|
|
2356
2401
|
checkout?: Checkout;
|
|
2357
2402
|
}
|
|
2358
|
-
interface AddToCheckoutRequest {
|
|
2403
|
+
export interface AddToCheckoutRequest {
|
|
2359
2404
|
/**
|
|
2360
2405
|
* Checkout ID.
|
|
2361
2406
|
* @format GUID
|
|
2362
2407
|
*/
|
|
2363
|
-
|
|
2408
|
+
id: string;
|
|
2364
2409
|
/**
|
|
2365
2410
|
* Catalog line items.
|
|
2366
2411
|
* @maxSize 100
|
|
@@ -2375,42 +2420,46 @@ interface AddToCheckoutRequest {
|
|
|
2375
2420
|
*/
|
|
2376
2421
|
customLineItems?: CustomLineItem[];
|
|
2377
2422
|
}
|
|
2378
|
-
interface AddToCheckoutResponse {
|
|
2423
|
+
export interface AddToCheckoutResponse {
|
|
2379
2424
|
/** Updated checkout. */
|
|
2380
2425
|
checkout?: Checkout;
|
|
2381
2426
|
}
|
|
2382
|
-
interface RemoveLineItemsRequest {
|
|
2427
|
+
export interface RemoveLineItemsRequest {
|
|
2383
2428
|
/**
|
|
2384
2429
|
* ID of the checkout to remove line items from.
|
|
2385
2430
|
* @format GUID
|
|
2386
2431
|
*/
|
|
2387
|
-
|
|
2432
|
+
id: string;
|
|
2388
2433
|
/**
|
|
2389
2434
|
* IDs of the line items to remove from the checkout.
|
|
2435
|
+
*
|
|
2436
|
+
* To find the IDs of the checkout line items you'd like to remove,
|
|
2437
|
+
* pass the checkout ID to Get Checkout and look for the IDs under
|
|
2438
|
+
* `lineItems`.
|
|
2390
2439
|
* @format GUID
|
|
2391
2440
|
* @minSize 1
|
|
2392
2441
|
* @maxSize 300
|
|
2393
2442
|
*/
|
|
2394
2443
|
lineItemIds: string[];
|
|
2395
2444
|
}
|
|
2396
|
-
interface RemoveLineItemsResponse {
|
|
2445
|
+
export interface RemoveLineItemsResponse {
|
|
2397
2446
|
/** Updated checkout after removal of line items. */
|
|
2398
2447
|
checkout?: Checkout;
|
|
2399
2448
|
}
|
|
2400
|
-
interface CreateOrderRequest {
|
|
2449
|
+
export interface CreateOrderRequest {
|
|
2401
2450
|
/**
|
|
2402
2451
|
* Checkout ID.
|
|
2403
2452
|
* @format GUID
|
|
2404
2453
|
*/
|
|
2405
|
-
|
|
2454
|
+
id: string;
|
|
2406
2455
|
/** Whether the payment method should be saved on the order. */
|
|
2407
2456
|
savePaymentMethod?: boolean;
|
|
2408
2457
|
/** Whether to authorize the payment and delay the capture. */
|
|
2409
2458
|
delayCapture?: boolean;
|
|
2410
2459
|
}
|
|
2411
|
-
interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
2460
|
+
export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
2412
2461
|
/**
|
|
2413
|
-
* ID of
|
|
2462
|
+
* ID of newly created order.
|
|
2414
2463
|
* @format GUID
|
|
2415
2464
|
*/
|
|
2416
2465
|
orderId?: string;
|
|
@@ -2423,15 +2472,16 @@ interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
|
2423
2472
|
* Payment gateway order ID.
|
|
2424
2473
|
*
|
|
2425
2474
|
* For online orders, pass this value as the `paymentId` parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function so your customer can pay for the order.
|
|
2475
|
+
* `paymentGatewayOrderId` will be returned if money needs to be charged.
|
|
2426
2476
|
*
|
|
2427
|
-
*
|
|
2428
|
-
* + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is 0
|
|
2429
|
-
* + If the total price is not 0
|
|
2477
|
+
* In some cases, money cannot be charged:
|
|
2478
|
+
* + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is `0`. For example, in the case of a free item or an item with a 100% discount.
|
|
2479
|
+
* + If the total price is not `0`, but the payment is covered by alternative payment methods, such as a gift card.
|
|
2430
2480
|
*/
|
|
2431
2481
|
paymentGatewayOrderId?: string | null;
|
|
2432
2482
|
}
|
|
2433
2483
|
/** @oneof */
|
|
2434
|
-
interface CreateOrderResponseIdOneOf {
|
|
2484
|
+
export interface CreateOrderResponseIdOneOf {
|
|
2435
2485
|
/**
|
|
2436
2486
|
* ID of newly created order.
|
|
2437
2487
|
* @format GUID
|
|
@@ -2443,37 +2493,37 @@ interface CreateOrderResponseIdOneOf {
|
|
|
2443
2493
|
*/
|
|
2444
2494
|
subscriptionId?: string;
|
|
2445
2495
|
}
|
|
2446
|
-
interface PaymentErrorResponseData {
|
|
2496
|
+
export interface PaymentErrorResponseData {
|
|
2447
2497
|
paymentResponseToken?: string | null;
|
|
2448
2498
|
transactionStatus?: string;
|
|
2449
2499
|
failureDetails?: string | null;
|
|
2450
2500
|
}
|
|
2451
|
-
interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
|
|
2501
|
+
export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
|
|
2452
2502
|
/** @format GUID */
|
|
2453
2503
|
orderId?: string;
|
|
2454
2504
|
/** @format GUID */
|
|
2455
2505
|
subscriptionId?: string;
|
|
2456
2506
|
}
|
|
2457
2507
|
/** @oneof */
|
|
2458
|
-
interface DoublePaymentErrorDataIdOneOf {
|
|
2508
|
+
export interface DoublePaymentErrorDataIdOneOf {
|
|
2459
2509
|
/** @format GUID */
|
|
2460
2510
|
orderId?: string;
|
|
2461
2511
|
/** @format GUID */
|
|
2462
2512
|
subscriptionId?: string;
|
|
2463
2513
|
}
|
|
2464
|
-
interface RedeemErrorData {
|
|
2514
|
+
export interface RedeemErrorData {
|
|
2465
2515
|
reason?: string;
|
|
2466
2516
|
}
|
|
2467
|
-
interface ViolationsList {
|
|
2517
|
+
export interface ViolationsList {
|
|
2468
2518
|
/** Violations risen by ValidationsSPI implementers. */
|
|
2469
2519
|
violations?: Violation[];
|
|
2470
2520
|
}
|
|
2471
|
-
interface CreateOrderAndChargeRequest {
|
|
2521
|
+
export interface CreateOrderAndChargeRequest {
|
|
2472
2522
|
/**
|
|
2473
2523
|
* Checkout ID.
|
|
2474
2524
|
* @format GUID
|
|
2475
2525
|
*/
|
|
2476
|
-
|
|
2526
|
+
id: string;
|
|
2477
2527
|
/** Payment token. */
|
|
2478
2528
|
paymentToken?: string | null;
|
|
2479
2529
|
/** Whether the payment method should be saved on the order. */
|
|
@@ -2481,7 +2531,7 @@ interface CreateOrderAndChargeRequest {
|
|
|
2481
2531
|
/** Whether to authorize the payment and delay the capture. */
|
|
2482
2532
|
delayCapture?: boolean;
|
|
2483
2533
|
}
|
|
2484
|
-
interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
2534
|
+
export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
2485
2535
|
/**
|
|
2486
2536
|
* ID of newly created order.
|
|
2487
2537
|
* @format GUID
|
|
@@ -2495,17 +2545,16 @@ interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOne
|
|
|
2495
2545
|
/** Payment response token. */
|
|
2496
2546
|
paymentResponseToken?: string | null;
|
|
2497
2547
|
/**
|
|
2498
|
-
*
|
|
2499
|
-
*
|
|
2500
|
-
*
|
|
2501
|
-
*
|
|
2502
|
-
*
|
|
2503
|
-
* + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
|
|
2548
|
+
* The payment gateway is cashier.
|
|
2549
|
+
* payment_gateway_order_id will be returned given that money was charged.
|
|
2550
|
+
* In some cases, money will not be charged:
|
|
2551
|
+
* If the total price is 0 - For example, could be a free item or a an item with 100% discount
|
|
2552
|
+
* If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
|
|
2504
2553
|
*/
|
|
2505
2554
|
paymentGatewayOrderId?: string | null;
|
|
2506
2555
|
}
|
|
2507
2556
|
/** @oneof */
|
|
2508
|
-
interface CreateOrderAndChargeResponseIdOneOf {
|
|
2557
|
+
export interface CreateOrderAndChargeResponseIdOneOf {
|
|
2509
2558
|
/**
|
|
2510
2559
|
* ID of newly created order.
|
|
2511
2560
|
* @format GUID
|
|
@@ -2517,41 +2566,41 @@ interface CreateOrderAndChargeResponseIdOneOf {
|
|
|
2517
2566
|
*/
|
|
2518
2567
|
subscriptionId?: string;
|
|
2519
2568
|
}
|
|
2520
|
-
interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
|
|
2569
|
+
export interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
|
|
2521
2570
|
/**
|
|
2522
2571
|
* Server-signed JWT token with required information to complete checkout
|
|
2523
2572
|
* @maxLength 4096
|
|
2524
2573
|
*/
|
|
2525
2574
|
token: string;
|
|
2526
2575
|
}
|
|
2527
|
-
interface RawHttpResponse {
|
|
2576
|
+
export interface RawHttpResponse {
|
|
2528
2577
|
body?: Uint8Array;
|
|
2529
2578
|
statusCode?: number | null;
|
|
2530
2579
|
headers?: HeadersEntry[];
|
|
2531
2580
|
}
|
|
2532
|
-
interface HeadersEntry {
|
|
2581
|
+
export interface HeadersEntry {
|
|
2533
2582
|
key?: string;
|
|
2534
2583
|
value?: string;
|
|
2535
2584
|
}
|
|
2536
|
-
interface MarkCheckoutAsCompletedRequest {
|
|
2585
|
+
export interface MarkCheckoutAsCompletedRequest {
|
|
2537
2586
|
/**
|
|
2538
2587
|
* Checkout ID.
|
|
2539
2588
|
* @format GUID
|
|
2540
2589
|
*/
|
|
2541
|
-
|
|
2590
|
+
id: string;
|
|
2542
2591
|
}
|
|
2543
|
-
interface MarkCheckoutAsCompletedResponse {
|
|
2592
|
+
export interface MarkCheckoutAsCompletedResponse {
|
|
2544
2593
|
}
|
|
2545
2594
|
/** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
|
|
2546
|
-
interface CheckoutMarkedAsCompleted {
|
|
2595
|
+
export interface CheckoutMarkedAsCompleted {
|
|
2547
2596
|
checkout?: Checkout;
|
|
2548
2597
|
}
|
|
2549
|
-
interface UpdateLineItemsQuantityRequest {
|
|
2598
|
+
export interface UpdateLineItemsQuantityRequest {
|
|
2550
2599
|
/**
|
|
2551
2600
|
* Checkout ID.
|
|
2552
2601
|
* @format GUID
|
|
2553
2602
|
*/
|
|
2554
|
-
|
|
2603
|
+
id: string;
|
|
2555
2604
|
/**
|
|
2556
2605
|
* Line item info to update.
|
|
2557
2606
|
* @minSize 1
|
|
@@ -2559,12 +2608,12 @@ interface UpdateLineItemsQuantityRequest {
|
|
|
2559
2608
|
*/
|
|
2560
2609
|
lineItems: LineItemQuantityUpdate[];
|
|
2561
2610
|
}
|
|
2562
|
-
interface LineItemQuantityUpdate {
|
|
2611
|
+
export interface LineItemQuantityUpdate {
|
|
2563
2612
|
/**
|
|
2564
2613
|
* ID of the line item to update.
|
|
2565
2614
|
* @format GUID
|
|
2566
2615
|
*/
|
|
2567
|
-
|
|
2616
|
+
id?: string;
|
|
2568
2617
|
/**
|
|
2569
2618
|
* New total amount of the line item,
|
|
2570
2619
|
* not the amount to add to the current `quantity`.
|
|
@@ -2577,42 +2626,42 @@ interface LineItemQuantityUpdate {
|
|
|
2577
2626
|
*/
|
|
2578
2627
|
quantity?: number;
|
|
2579
2628
|
}
|
|
2580
|
-
interface UpdateLineItemsQuantityResponse {
|
|
2629
|
+
export interface UpdateLineItemsQuantityResponse {
|
|
2581
2630
|
/** Updated checkout. */
|
|
2582
2631
|
checkout?: Checkout;
|
|
2583
2632
|
}
|
|
2584
|
-
interface GetCheckoutPaymentSettingsRequest {
|
|
2633
|
+
export interface GetCheckoutPaymentSettingsRequest {
|
|
2585
2634
|
/**
|
|
2586
2635
|
* Checkout ID.
|
|
2587
2636
|
* @format GUID
|
|
2588
2637
|
*/
|
|
2589
|
-
|
|
2638
|
+
id: string;
|
|
2590
2639
|
}
|
|
2591
|
-
interface GetCheckoutPaymentSettingsResponse {
|
|
2640
|
+
export interface GetCheckoutPaymentSettingsResponse {
|
|
2592
2641
|
blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOption[];
|
|
2593
2642
|
}
|
|
2594
|
-
declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2643
|
+
export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2595
2644
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
2596
2645
|
MANUAL = "MANUAL"
|
|
2597
2646
|
}
|
|
2598
|
-
interface DeleteCheckoutRequest {
|
|
2647
|
+
export interface DeleteCheckoutRequest {
|
|
2599
2648
|
/**
|
|
2600
2649
|
* ID of the checkout to delete.
|
|
2601
2650
|
* @format GUID
|
|
2602
2651
|
*/
|
|
2603
|
-
|
|
2652
|
+
id?: string;
|
|
2604
2653
|
}
|
|
2605
|
-
interface DeleteCheckoutResponse {
|
|
2654
|
+
export interface DeleteCheckoutResponse {
|
|
2606
2655
|
}
|
|
2607
|
-
interface SubscriptionCreated {
|
|
2656
|
+
export interface SubscriptionCreated {
|
|
2608
2657
|
subscription?: Subscription;
|
|
2609
2658
|
}
|
|
2610
|
-
interface Subscription {
|
|
2659
|
+
export interface Subscription {
|
|
2611
2660
|
/**
|
|
2612
2661
|
* Subscription id (auto-generated upon subscription creation)
|
|
2613
2662
|
* @readonly
|
|
2614
2663
|
*/
|
|
2615
|
-
|
|
2664
|
+
id?: string;
|
|
2616
2665
|
/**
|
|
2617
2666
|
* id of subscription in external system
|
|
2618
2667
|
* @format GUID
|
|
@@ -2671,23 +2720,23 @@ interface Subscription {
|
|
|
2671
2720
|
billingInfo?: BillingInfo;
|
|
2672
2721
|
}
|
|
2673
2722
|
/** Buyer Info */
|
|
2674
|
-
interface V1BuyerInfo {
|
|
2723
|
+
export interface V1BuyerInfo {
|
|
2675
2724
|
/**
|
|
2676
2725
|
* Wix customer ID
|
|
2677
2726
|
* @format GUID
|
|
2678
2727
|
*/
|
|
2679
|
-
|
|
2728
|
+
id?: string;
|
|
2680
2729
|
/** Customer type */
|
|
2681
2730
|
identityType?: IdentityType;
|
|
2682
2731
|
}
|
|
2683
|
-
declare enum IdentityType {
|
|
2732
|
+
export declare enum IdentityType {
|
|
2684
2733
|
UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
|
|
2685
2734
|
/** Site member */
|
|
2686
2735
|
MEMBER = "MEMBER",
|
|
2687
2736
|
/** Contact */
|
|
2688
2737
|
CONTACT = "CONTACT"
|
|
2689
2738
|
}
|
|
2690
|
-
interface V1LineItem {
|
|
2739
|
+
export interface V1LineItem {
|
|
2691
2740
|
/** Line item ID (auto-generated) */
|
|
2692
2741
|
index?: number;
|
|
2693
2742
|
/**
|
|
@@ -2716,7 +2765,7 @@ interface V1LineItem {
|
|
|
2716
2765
|
/** Product details */
|
|
2717
2766
|
productDetails?: ProductDetails;
|
|
2718
2767
|
}
|
|
2719
|
-
interface OptionSelection {
|
|
2768
|
+
export interface OptionSelection {
|
|
2720
2769
|
/**
|
|
2721
2770
|
* Option name
|
|
2722
2771
|
* @maxLength 200
|
|
@@ -2728,7 +2777,7 @@ interface OptionSelection {
|
|
|
2728
2777
|
*/
|
|
2729
2778
|
selection?: string;
|
|
2730
2779
|
}
|
|
2731
|
-
interface CustomTextFieldSelection {
|
|
2780
|
+
export interface CustomTextFieldSelection {
|
|
2732
2781
|
/**
|
|
2733
2782
|
* Custom text field name
|
|
2734
2783
|
* @maxLength 100
|
|
@@ -2740,7 +2789,7 @@ interface CustomTextFieldSelection {
|
|
|
2740
2789
|
*/
|
|
2741
2790
|
value?: string;
|
|
2742
2791
|
}
|
|
2743
|
-
interface ChargeDetails {
|
|
2792
|
+
export interface ChargeDetails {
|
|
2744
2793
|
/**
|
|
2745
2794
|
* price of line item (depends on subscription option)
|
|
2746
2795
|
* @max 999999999.99
|
|
@@ -2769,7 +2818,7 @@ interface ChargeDetails {
|
|
|
2769
2818
|
*/
|
|
2770
2819
|
taxRate?: string | null;
|
|
2771
2820
|
}
|
|
2772
|
-
interface ProductDetails {
|
|
2821
|
+
export interface ProductDetails {
|
|
2773
2822
|
/**
|
|
2774
2823
|
* Line item product ID (optional for POS orders)
|
|
2775
2824
|
* @minLength 1
|
|
@@ -2822,7 +2871,7 @@ interface ProductDetails {
|
|
|
2822
2871
|
*/
|
|
2823
2872
|
appId?: string | null;
|
|
2824
2873
|
}
|
|
2825
|
-
declare enum LineItemType {
|
|
2874
|
+
export declare enum LineItemType {
|
|
2826
2875
|
/** Line item type can't be classified, due to an error */
|
|
2827
2876
|
UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
|
|
2828
2877
|
/** Physical item type */
|
|
@@ -2832,7 +2881,7 @@ declare enum LineItemType {
|
|
|
2832
2881
|
/** Custom item price */
|
|
2833
2882
|
CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
|
|
2834
2883
|
}
|
|
2835
|
-
interface MediaItem {
|
|
2884
|
+
export interface MediaItem {
|
|
2836
2885
|
/**
|
|
2837
2886
|
* Media type
|
|
2838
2887
|
* @readonly
|
|
@@ -2857,7 +2906,7 @@ interface MediaItem {
|
|
|
2857
2906
|
*/
|
|
2858
2907
|
height?: number;
|
|
2859
2908
|
/** Media ID (for media items previously saved in Wix Media) */
|
|
2860
|
-
|
|
2909
|
+
id?: string | null;
|
|
2861
2910
|
/** Media external URL */
|
|
2862
2911
|
externalImageUrl?: string | null;
|
|
2863
2912
|
/**
|
|
@@ -2866,13 +2915,13 @@ interface MediaItem {
|
|
|
2866
2915
|
*/
|
|
2867
2916
|
altText?: string | null;
|
|
2868
2917
|
}
|
|
2869
|
-
declare enum MediaItemType {
|
|
2918
|
+
export declare enum MediaItemType {
|
|
2870
2919
|
/** Media item type can't be classified, due to an error */
|
|
2871
2920
|
UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
|
|
2872
2921
|
/** Image item type */
|
|
2873
2922
|
IMAGE = "IMAGE"
|
|
2874
2923
|
}
|
|
2875
|
-
interface Totals {
|
|
2924
|
+
export interface Totals {
|
|
2876
2925
|
/**
|
|
2877
2926
|
* Subtotal of all line items, before tax
|
|
2878
2927
|
* @max 999999999.99
|
|
@@ -2909,7 +2958,7 @@ interface Totals {
|
|
|
2909
2958
|
*/
|
|
2910
2959
|
quantity?: number;
|
|
2911
2960
|
}
|
|
2912
|
-
interface StoreSettings {
|
|
2961
|
+
export interface StoreSettings {
|
|
2913
2962
|
/**
|
|
2914
2963
|
* Currency used for pricing in this store
|
|
2915
2964
|
* @maxLength 3
|
|
@@ -2927,7 +2976,7 @@ interface StoreSettings {
|
|
|
2927
2976
|
*/
|
|
2928
2977
|
buyerLanguage?: string | null;
|
|
2929
2978
|
}
|
|
2930
|
-
interface Address extends AddressAddressLine1OptionsOneOf {
|
|
2979
|
+
export interface Address extends AddressAddressLine1OptionsOneOf {
|
|
2931
2980
|
/**
|
|
2932
2981
|
* Address line 1 (free text)
|
|
2933
2982
|
* @maxLength 1000
|
|
@@ -2981,7 +3030,7 @@ interface Address extends AddressAddressLine1OptionsOneOf {
|
|
|
2981
3030
|
vatId?: VatId;
|
|
2982
3031
|
}
|
|
2983
3032
|
/** @oneof */
|
|
2984
|
-
interface AddressAddressLine1OptionsOneOf {
|
|
3033
|
+
export interface AddressAddressLine1OptionsOneOf {
|
|
2985
3034
|
/**
|
|
2986
3035
|
* Address line 1 (free text)
|
|
2987
3036
|
* @maxLength 1000
|
|
@@ -2990,7 +3039,7 @@ interface AddressAddressLine1OptionsOneOf {
|
|
|
2990
3039
|
/** Address line 1 (street) */
|
|
2991
3040
|
street?: Street;
|
|
2992
3041
|
}
|
|
2993
|
-
interface FullName {
|
|
3042
|
+
export interface FullName {
|
|
2994
3043
|
/**
|
|
2995
3044
|
* Customer's first name
|
|
2996
3045
|
* @maxLength 1000
|
|
@@ -3002,7 +3051,7 @@ interface FullName {
|
|
|
3002
3051
|
*/
|
|
3003
3052
|
lastName?: string;
|
|
3004
3053
|
}
|
|
3005
|
-
interface Street {
|
|
3054
|
+
export interface Street {
|
|
3006
3055
|
/**
|
|
3007
3056
|
* Street number
|
|
3008
3057
|
* @maxLength 500
|
|
@@ -3014,7 +3063,7 @@ interface Street {
|
|
|
3014
3063
|
*/
|
|
3015
3064
|
name?: string;
|
|
3016
3065
|
}
|
|
3017
|
-
interface VatId {
|
|
3066
|
+
export interface VatId {
|
|
3018
3067
|
/**
|
|
3019
3068
|
* Customer's tax ID.
|
|
3020
3069
|
* @maxLength 50
|
|
@@ -3028,7 +3077,7 @@ interface VatId {
|
|
|
3028
3077
|
type?: VatType;
|
|
3029
3078
|
}
|
|
3030
3079
|
/** Brazilian tax info types */
|
|
3031
|
-
declare enum VatType {
|
|
3080
|
+
export declare enum VatType {
|
|
3032
3081
|
/** When the tax info type can't be classified, due to an error */
|
|
3033
3082
|
UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
|
|
3034
3083
|
/** CPF - for individual tax payers */
|
|
@@ -3036,7 +3085,7 @@ declare enum VatType {
|
|
|
3036
3085
|
/** CNPJ - for corporations */
|
|
3037
3086
|
CNPJ = "CNPJ"
|
|
3038
3087
|
}
|
|
3039
|
-
interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3088
|
+
export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3040
3089
|
/** Shipment details (when this object describes shipment) */
|
|
3041
3090
|
shipmentDetails?: ShipmentDetails;
|
|
3042
3091
|
/** Pickup details (when this object describes pickup) */
|
|
@@ -3053,13 +3102,13 @@ interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
|
3053
3102
|
estimatedDeliveryTime?: string | null;
|
|
3054
3103
|
}
|
|
3055
3104
|
/** @oneof */
|
|
3056
|
-
interface V1ShippingInfoDetailsOneOf {
|
|
3105
|
+
export interface V1ShippingInfoDetailsOneOf {
|
|
3057
3106
|
/** Shipment details (when this object describes shipment) */
|
|
3058
3107
|
shipmentDetails?: ShipmentDetails;
|
|
3059
3108
|
/** Pickup details (when this object describes pickup) */
|
|
3060
3109
|
pickupDetails?: V1PickupDetails;
|
|
3061
3110
|
}
|
|
3062
|
-
interface ShipmentDetails {
|
|
3111
|
+
export interface ShipmentDetails {
|
|
3063
3112
|
/** Shipping destination address */
|
|
3064
3113
|
address?: Address;
|
|
3065
3114
|
/**
|
|
@@ -3080,7 +3129,7 @@ interface ShipmentDetails {
|
|
|
3080
3129
|
*/
|
|
3081
3130
|
taxRate?: string | null;
|
|
3082
3131
|
}
|
|
3083
|
-
interface V1PickupDetails {
|
|
3132
|
+
export interface V1PickupDetails {
|
|
3084
3133
|
/** Pickup address */
|
|
3085
3134
|
address?: PickupAddress;
|
|
3086
3135
|
/**
|
|
@@ -3089,7 +3138,7 @@ interface V1PickupDetails {
|
|
|
3089
3138
|
*/
|
|
3090
3139
|
pickupInstructions?: string | null;
|
|
3091
3140
|
}
|
|
3092
|
-
interface PickupAddress {
|
|
3141
|
+
export interface PickupAddress {
|
|
3093
3142
|
/**
|
|
3094
3143
|
* Country code (2 letters)
|
|
3095
3144
|
* @format COUNTRY
|
|
@@ -3116,7 +3165,7 @@ interface PickupAddress {
|
|
|
3116
3165
|
*/
|
|
3117
3166
|
zipCode?: string;
|
|
3118
3167
|
}
|
|
3119
|
-
interface AppliedCoupon {
|
|
3168
|
+
export interface AppliedCoupon {
|
|
3120
3169
|
/** Coupon ID */
|
|
3121
3170
|
couponId?: string;
|
|
3122
3171
|
/**
|
|
@@ -3131,7 +3180,7 @@ interface AppliedCoupon {
|
|
|
3131
3180
|
code?: string;
|
|
3132
3181
|
}
|
|
3133
3182
|
/** Custom field */
|
|
3134
|
-
interface V1CustomField {
|
|
3183
|
+
export interface V1CustomField {
|
|
3135
3184
|
/**
|
|
3136
3185
|
* Free text that the customer entered in the custom field during the checkout process
|
|
3137
3186
|
* @maxLength 250
|
|
@@ -3148,9 +3197,9 @@ interface V1CustomField {
|
|
|
3148
3197
|
*/
|
|
3149
3198
|
translatedTitle?: string;
|
|
3150
3199
|
}
|
|
3151
|
-
interface V1SubscriptionOptionInfo {
|
|
3200
|
+
export interface V1SubscriptionOptionInfo {
|
|
3152
3201
|
/** @format GUID */
|
|
3153
|
-
|
|
3202
|
+
id?: string | null;
|
|
3154
3203
|
/**
|
|
3155
3204
|
* @minLength 1
|
|
3156
3205
|
* @maxLength 20
|
|
@@ -3160,29 +3209,29 @@ interface V1SubscriptionOptionInfo {
|
|
|
3160
3209
|
description?: string | null;
|
|
3161
3210
|
discount?: Discount;
|
|
3162
3211
|
}
|
|
3163
|
-
interface Discount {
|
|
3212
|
+
export interface Discount {
|
|
3164
3213
|
/** Discount type. */
|
|
3165
3214
|
type?: DiscountDiscountType;
|
|
3166
3215
|
/** Discount value. */
|
|
3167
3216
|
value?: number;
|
|
3168
3217
|
}
|
|
3169
|
-
declare enum DiscountDiscountType {
|
|
3218
|
+
export declare enum DiscountDiscountType {
|
|
3170
3219
|
UNDEFINED = "UNDEFINED",
|
|
3171
3220
|
/** No discount */
|
|
3172
3221
|
AMOUNT = "AMOUNT",
|
|
3173
3222
|
PERCENT = "PERCENT"
|
|
3174
3223
|
}
|
|
3175
|
-
interface ChannelInfo {
|
|
3224
|
+
export interface ChannelInfo {
|
|
3176
3225
|
/** Sales channel that submitted the subscription */
|
|
3177
3226
|
type?: ChannelInfoChannelType;
|
|
3178
3227
|
}
|
|
3179
|
-
declare enum ChannelInfoChannelType {
|
|
3228
|
+
export declare enum ChannelInfoChannelType {
|
|
3180
3229
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3181
3230
|
WEB = "WEB",
|
|
3182
3231
|
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
3183
3232
|
WIX_APP_STORE = "WIX_APP_STORE"
|
|
3184
3233
|
}
|
|
3185
|
-
interface V1SubscriptionSettings {
|
|
3234
|
+
export interface V1SubscriptionSettings {
|
|
3186
3235
|
/** Frequency of recurring payment. */
|
|
3187
3236
|
frequency?: SubscriptionFrequency;
|
|
3188
3237
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
@@ -3194,7 +3243,7 @@ interface V1SubscriptionSettings {
|
|
|
3194
3243
|
*/
|
|
3195
3244
|
billingCycles?: number | null;
|
|
3196
3245
|
}
|
|
3197
|
-
interface BillingInfo {
|
|
3246
|
+
export interface BillingInfo {
|
|
3198
3247
|
/**
|
|
3199
3248
|
* Payment method used for this order
|
|
3200
3249
|
* @maxLength 50
|
|
@@ -3211,9 +3260,9 @@ interface BillingInfo {
|
|
|
3211
3260
|
*/
|
|
3212
3261
|
paymentGatewayOrderId?: string | null;
|
|
3213
3262
|
}
|
|
3214
|
-
interface Empty {
|
|
3263
|
+
export interface Empty {
|
|
3215
3264
|
}
|
|
3216
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3265
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3217
3266
|
createdEvent?: EntityCreatedEvent;
|
|
3218
3267
|
updatedEvent?: EntityUpdatedEvent;
|
|
3219
3268
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3222,7 +3271,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3222
3271
|
* Unique event ID.
|
|
3223
3272
|
* Allows clients to ignore duplicate webhooks.
|
|
3224
3273
|
*/
|
|
3225
|
-
|
|
3274
|
+
id?: string;
|
|
3226
3275
|
/**
|
|
3227
3276
|
* Assumes actions are also always typed to an entity_type
|
|
3228
3277
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -3256,34 +3305,36 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3256
3305
|
entityEventSequence?: string | null;
|
|
3257
3306
|
}
|
|
3258
3307
|
/** @oneof */
|
|
3259
|
-
interface DomainEventBodyOneOf {
|
|
3308
|
+
export interface DomainEventBodyOneOf {
|
|
3260
3309
|
createdEvent?: EntityCreatedEvent;
|
|
3261
3310
|
updatedEvent?: EntityUpdatedEvent;
|
|
3262
3311
|
deletedEvent?: EntityDeletedEvent;
|
|
3263
3312
|
actionEvent?: ActionEvent;
|
|
3264
3313
|
}
|
|
3265
|
-
interface EntityCreatedEvent {
|
|
3266
|
-
|
|
3314
|
+
export interface EntityCreatedEvent {
|
|
3315
|
+
entityAsJson?: string;
|
|
3316
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3317
|
+
restoreInfo?: RestoreInfo;
|
|
3267
3318
|
}
|
|
3268
|
-
interface RestoreInfo {
|
|
3319
|
+
export interface RestoreInfo {
|
|
3269
3320
|
deletedDate?: Date | null;
|
|
3270
3321
|
}
|
|
3271
|
-
interface EntityUpdatedEvent {
|
|
3322
|
+
export interface EntityUpdatedEvent {
|
|
3272
3323
|
/**
|
|
3273
3324
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3274
3325
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3275
3326
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3276
3327
|
*/
|
|
3277
|
-
|
|
3328
|
+
currentEntityAsJson?: string;
|
|
3278
3329
|
}
|
|
3279
|
-
interface EntityDeletedEvent {
|
|
3330
|
+
export interface EntityDeletedEvent {
|
|
3280
3331
|
/** Entity that was deleted */
|
|
3281
|
-
|
|
3332
|
+
deletedEntityAsJson?: string | null;
|
|
3282
3333
|
}
|
|
3283
|
-
interface ActionEvent {
|
|
3284
|
-
|
|
3334
|
+
export interface ActionEvent {
|
|
3335
|
+
bodyAsJson?: string;
|
|
3285
3336
|
}
|
|
3286
|
-
interface MessageEnvelope {
|
|
3337
|
+
export interface MessageEnvelope {
|
|
3287
3338
|
/**
|
|
3288
3339
|
* App instance ID.
|
|
3289
3340
|
* @format GUID
|
|
@@ -3299,7 +3350,7 @@ interface MessageEnvelope {
|
|
|
3299
3350
|
/** Stringify payload. */
|
|
3300
3351
|
data?: string;
|
|
3301
3352
|
}
|
|
3302
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3353
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3303
3354
|
/**
|
|
3304
3355
|
* ID of a site visitor that has not logged in to the site.
|
|
3305
3356
|
* @format GUID
|
|
@@ -3324,7 +3375,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3324
3375
|
identityType?: WebhookIdentityType;
|
|
3325
3376
|
}
|
|
3326
3377
|
/** @oneof */
|
|
3327
|
-
interface IdentificationDataIdOneOf {
|
|
3378
|
+
export interface IdentificationDataIdOneOf {
|
|
3328
3379
|
/**
|
|
3329
3380
|
* ID of a site visitor that has not logged in to the site.
|
|
3330
3381
|
* @format GUID
|
|
@@ -3346,349 +3397,10 @@ interface IdentificationDataIdOneOf {
|
|
|
3346
3397
|
*/
|
|
3347
3398
|
appId?: string;
|
|
3348
3399
|
}
|
|
3349
|
-
declare enum WebhookIdentityType {
|
|
3400
|
+
export declare enum WebhookIdentityType {
|
|
3350
3401
|
UNKNOWN = "UNKNOWN",
|
|
3351
3402
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3352
3403
|
MEMBER = "MEMBER",
|
|
3353
3404
|
WIX_USER = "WIX_USER",
|
|
3354
3405
|
APP = "APP"
|
|
3355
3406
|
}
|
|
3356
|
-
interface BaseEventMetadata {
|
|
3357
|
-
/**
|
|
3358
|
-
* App instance ID.
|
|
3359
|
-
* @format GUID
|
|
3360
|
-
*/
|
|
3361
|
-
instanceId?: string | null;
|
|
3362
|
-
/**
|
|
3363
|
-
* Event type.
|
|
3364
|
-
* @maxLength 150
|
|
3365
|
-
*/
|
|
3366
|
-
eventType?: string;
|
|
3367
|
-
/** The identification type and identity data. */
|
|
3368
|
-
identity?: IdentificationData;
|
|
3369
|
-
}
|
|
3370
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
3371
|
-
/**
|
|
3372
|
-
* Unique event ID.
|
|
3373
|
-
* Allows clients to ignore duplicate webhooks.
|
|
3374
|
-
*/
|
|
3375
|
-
_id?: string;
|
|
3376
|
-
/**
|
|
3377
|
-
* Assumes actions are also always typed to an entity_type
|
|
3378
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3379
|
-
*/
|
|
3380
|
-
entityFqdn?: string;
|
|
3381
|
-
/**
|
|
3382
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3383
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3384
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
3385
|
-
*/
|
|
3386
|
-
slug?: string;
|
|
3387
|
-
/** ID of the entity associated with the event. */
|
|
3388
|
-
entityId?: string;
|
|
3389
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3390
|
-
eventTime?: Date | null;
|
|
3391
|
-
/**
|
|
3392
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
3393
|
-
* (for example, GDPR).
|
|
3394
|
-
*/
|
|
3395
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3396
|
-
/** If present, indicates the action that triggered the event. */
|
|
3397
|
-
originatedFrom?: string | null;
|
|
3398
|
-
/**
|
|
3399
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
3400
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3401
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3402
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3403
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3404
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3405
|
-
*/
|
|
3406
|
-
entityEventSequence?: string | null;
|
|
3407
|
-
}
|
|
3408
|
-
interface CheckoutCompletedEnvelope {
|
|
3409
|
-
data: CheckoutMarkedAsCompleted;
|
|
3410
|
-
metadata: EventMetadata;
|
|
3411
|
-
}
|
|
3412
|
-
interface CheckoutCreatedEnvelope {
|
|
3413
|
-
entity: Checkout;
|
|
3414
|
-
metadata: EventMetadata;
|
|
3415
|
-
}
|
|
3416
|
-
interface CheckoutUpdatedEnvelope {
|
|
3417
|
-
entity: Checkout;
|
|
3418
|
-
metadata: EventMetadata;
|
|
3419
|
-
}
|
|
3420
|
-
interface CreateCheckoutOptions {
|
|
3421
|
-
/** Checkout information. */
|
|
3422
|
-
checkoutInfo?: Checkout;
|
|
3423
|
-
/** 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). */
|
|
3424
|
-
couponCode?: string | null;
|
|
3425
|
-
/**
|
|
3426
|
-
* Catalog line items to add to the checkout.
|
|
3427
|
-
* @maxSize 300
|
|
3428
|
-
*/
|
|
3429
|
-
lineItems?: LineItem[];
|
|
3430
|
-
/**
|
|
3431
|
-
* Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
|
|
3432
|
-
*
|
|
3433
|
-
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3434
|
-
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3435
|
-
* @maxSize 300
|
|
3436
|
-
*/
|
|
3437
|
-
customLineItems?: CustomLineItem[];
|
|
3438
|
-
/** Sales channel that submitted the order. */
|
|
3439
|
-
channelType: ChannelType;
|
|
3440
|
-
/**
|
|
3441
|
-
* Gift card code.
|
|
3442
|
-
*
|
|
3443
|
-
* The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
|
|
3444
|
-
*
|
|
3445
|
-
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
3446
|
-
*/
|
|
3447
|
-
giftCardCode?: string | null;
|
|
3448
|
-
/**
|
|
3449
|
-
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
3450
|
-
*
|
|
3451
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
3452
|
-
* @maxLength 1000
|
|
3453
|
-
*/
|
|
3454
|
-
overrideCheckoutUrl?: string | null;
|
|
3455
|
-
}
|
|
3456
|
-
interface UpdateCheckout {
|
|
3457
|
-
/**
|
|
3458
|
-
* Checkout ID.
|
|
3459
|
-
* @format GUID
|
|
3460
|
-
* @readonly
|
|
3461
|
-
*/
|
|
3462
|
-
_id?: string | null;
|
|
3463
|
-
/**
|
|
3464
|
-
* Line items.
|
|
3465
|
-
*
|
|
3466
|
-
* Max: 300 items
|
|
3467
|
-
* @minSize 1
|
|
3468
|
-
* @maxSize 300
|
|
3469
|
-
* @readonly
|
|
3470
|
-
*/
|
|
3471
|
-
lineItems?: LineItem[];
|
|
3472
|
-
/** Billing information. */
|
|
3473
|
-
billingInfo?: AddressWithContact;
|
|
3474
|
-
/** Shipping information. */
|
|
3475
|
-
shippingInfo?: ShippingInfo;
|
|
3476
|
-
/**
|
|
3477
|
-
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
3478
|
-
* @maxLength 1000
|
|
3479
|
-
*/
|
|
3480
|
-
buyerNote?: string | null;
|
|
3481
|
-
/** Buyer information. */
|
|
3482
|
-
buyerInfo?: BuyerInfo;
|
|
3483
|
-
/**
|
|
3484
|
-
* All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
3485
|
-
* @readonly
|
|
3486
|
-
* @format CURRENCY
|
|
3487
|
-
*/
|
|
3488
|
-
conversionCurrency?: string;
|
|
3489
|
-
/**
|
|
3490
|
-
* Calculated price summary for the checkout.
|
|
3491
|
-
* @readonly
|
|
3492
|
-
*/
|
|
3493
|
-
priceSummary?: PriceSummary;
|
|
3494
|
-
/**
|
|
3495
|
-
* Errors when calculating totals.
|
|
3496
|
-
* @readonly
|
|
3497
|
-
*/
|
|
3498
|
-
calculationErrors?: CalculationErrors;
|
|
3499
|
-
/**
|
|
3500
|
-
* Applied gift card details.
|
|
3501
|
-
*
|
|
3502
|
-
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
3503
|
-
* @readonly
|
|
3504
|
-
*/
|
|
3505
|
-
giftCard?: GiftCard;
|
|
3506
|
-
/**
|
|
3507
|
-
* Applied discounts.
|
|
3508
|
-
* @readonly
|
|
3509
|
-
*/
|
|
3510
|
-
appliedDiscounts?: AppliedDiscount[];
|
|
3511
|
-
/** Custom fields. */
|
|
3512
|
-
customFields?: CustomField[];
|
|
3513
|
-
/**
|
|
3514
|
-
* Weight measurement unit. Defaults to a site's weight unit.
|
|
3515
|
-
* @readonly
|
|
3516
|
-
*/
|
|
3517
|
-
weightUnit?: WeightUnit;
|
|
3518
|
-
/**
|
|
3519
|
-
* Tax summary.
|
|
3520
|
-
* @readonly
|
|
3521
|
-
*/
|
|
3522
|
-
taxSummary?: TaxSummary;
|
|
3523
|
-
/**
|
|
3524
|
-
* The currency used when submitting the order.
|
|
3525
|
-
* @format CURRENCY
|
|
3526
|
-
* @readonly
|
|
3527
|
-
*/
|
|
3528
|
-
currency?: string;
|
|
3529
|
-
/**
|
|
3530
|
-
* Sales channel that submitted the order.
|
|
3531
|
-
* @readonly
|
|
3532
|
-
*/
|
|
3533
|
-
channelType?: ChannelType;
|
|
3534
|
-
/**
|
|
3535
|
-
* Site language in which original values are shown.
|
|
3536
|
-
* @readonly
|
|
3537
|
-
*/
|
|
3538
|
-
siteLanguage?: string;
|
|
3539
|
-
/**
|
|
3540
|
-
* Language for communication with the buyer. Defaults to the site language.
|
|
3541
|
-
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
3542
|
-
* @readonly
|
|
3543
|
-
*/
|
|
3544
|
-
buyerLanguage?: string;
|
|
3545
|
-
/**
|
|
3546
|
-
* Whether an order was successfully created from this checkout.
|
|
3547
|
-
* For an order to be successful, it must be successfully paid for (unless the total is 0).
|
|
3548
|
-
* @readonly
|
|
3549
|
-
*/
|
|
3550
|
-
completed?: boolean;
|
|
3551
|
-
/**
|
|
3552
|
-
* Whether tax is included in line item prices.
|
|
3553
|
-
* @readonly
|
|
3554
|
-
*/
|
|
3555
|
-
taxIncludedInPrice?: boolean;
|
|
3556
|
-
/**
|
|
3557
|
-
* ID of the checkout's initiator.
|
|
3558
|
-
* @readonly
|
|
3559
|
-
*/
|
|
3560
|
-
createdBy?: CreatedBy;
|
|
3561
|
-
/**
|
|
3562
|
-
* Date and time the checkout was created.
|
|
3563
|
-
* @readonly
|
|
3564
|
-
*/
|
|
3565
|
-
_createdDate?: Date | null;
|
|
3566
|
-
/**
|
|
3567
|
-
* Date and time the checkout was updated.
|
|
3568
|
-
* @readonly
|
|
3569
|
-
*/
|
|
3570
|
-
_updatedDate?: Date | null;
|
|
3571
|
-
/**
|
|
3572
|
-
* Minimal amount to pay in order to place the order.
|
|
3573
|
-
* @readonly
|
|
3574
|
-
*/
|
|
3575
|
-
payNow?: PriceSummary;
|
|
3576
|
-
/**
|
|
3577
|
-
* Remaining amount for the order to be fully paid.
|
|
3578
|
-
* @readonly
|
|
3579
|
-
*/
|
|
3580
|
-
payLater?: PriceSummary;
|
|
3581
|
-
/** Memberships to apply when creating the order. */
|
|
3582
|
-
membershipOptions?: MembershipOptions;
|
|
3583
|
-
/**
|
|
3584
|
-
* Additional Fees.
|
|
3585
|
-
* @maxSize 100
|
|
3586
|
-
*/
|
|
3587
|
-
additionalFees?: AdditionalFee[];
|
|
3588
|
-
/**
|
|
3589
|
-
* Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
|
|
3590
|
-
* @format GUID
|
|
3591
|
-
*/
|
|
3592
|
-
cartId?: string | null;
|
|
3593
|
-
/**
|
|
3594
|
-
* List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
|
|
3595
|
-
* @readonly
|
|
3596
|
-
*/
|
|
3597
|
-
violations?: Violation[];
|
|
3598
|
-
/**
|
|
3599
|
-
* Custom field data for the checkout object.
|
|
3600
|
-
*
|
|
3601
|
-
* [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.
|
|
3602
|
-
*/
|
|
3603
|
-
extendedFields?: ExtendedFields;
|
|
3604
|
-
/**
|
|
3605
|
-
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
3606
|
-
* @format GUID
|
|
3607
|
-
* @readonly
|
|
3608
|
-
*/
|
|
3609
|
-
purchaseFlowId?: string | null;
|
|
3610
|
-
/**
|
|
3611
|
-
* Additional settings for customization of the checkout process.
|
|
3612
|
-
*
|
|
3613
|
-
* Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
|
|
3614
|
-
* @immutable
|
|
3615
|
-
*/
|
|
3616
|
-
customSettings?: CustomSettings;
|
|
3617
|
-
/**
|
|
3618
|
-
* Reference IDs for the app and component providing custom checkout page content.
|
|
3619
|
-
*
|
|
3620
|
-
* To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3621
|
-
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3622
|
-
*/
|
|
3623
|
-
customContentReference?: CustomContentReference;
|
|
3624
|
-
/**
|
|
3625
|
-
* References to an external app and resource associated with this checkout.
|
|
3626
|
-
* Used for integration and tracking across different platforms.
|
|
3627
|
-
* @immutable
|
|
3628
|
-
*/
|
|
3629
|
-
externalReference?: ExternalReference;
|
|
3630
|
-
/**
|
|
3631
|
-
* The business location ID associated with the checkout.
|
|
3632
|
-
*
|
|
3633
|
-
* To learn more, see the Locations API.
|
|
3634
|
-
* @format GUID
|
|
3635
|
-
*/
|
|
3636
|
-
businessLocationId?: string | null;
|
|
3637
|
-
}
|
|
3638
|
-
interface UpdateCheckoutOptions {
|
|
3639
|
-
/** 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). */
|
|
3640
|
-
couponCode?: string | null;
|
|
3641
|
-
/** Gift card code. */
|
|
3642
|
-
giftCardCode?: string | null;
|
|
3643
|
-
/**
|
|
3644
|
-
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
3645
|
-
*
|
|
3646
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
3647
|
-
* @maxLength 1000
|
|
3648
|
-
*/
|
|
3649
|
-
overrideCheckoutUrl?: string | null;
|
|
3650
|
-
/**
|
|
3651
|
-
* Catalog line items.
|
|
3652
|
-
* @maxSize 300
|
|
3653
|
-
*/
|
|
3654
|
-
lineItems?: LineItem[];
|
|
3655
|
-
/**
|
|
3656
|
-
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
3657
|
-
*
|
|
3658
|
-
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3659
|
-
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3660
|
-
* @maxSize 300
|
|
3661
|
-
*/
|
|
3662
|
-
customLineItems?: CustomLineItem[];
|
|
3663
|
-
}
|
|
3664
|
-
interface AddToCheckoutOptions {
|
|
3665
|
-
/**
|
|
3666
|
-
* Catalog line items.
|
|
3667
|
-
* @maxSize 100
|
|
3668
|
-
*/
|
|
3669
|
-
lineItems?: LineItem[];
|
|
3670
|
-
/**
|
|
3671
|
-
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
3672
|
-
*
|
|
3673
|
-
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3674
|
-
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3675
|
-
* @maxSize 100
|
|
3676
|
-
*/
|
|
3677
|
-
customLineItems?: CustomLineItem[];
|
|
3678
|
-
}
|
|
3679
|
-
interface CreateOrderOptions {
|
|
3680
|
-
/** Whether the payment method should be saved on the order. */
|
|
3681
|
-
savePaymentMethod?: boolean;
|
|
3682
|
-
/** Whether to authorize the payment and delay the capture. */
|
|
3683
|
-
delayCapture?: boolean;
|
|
3684
|
-
}
|
|
3685
|
-
interface CreateOrderAndChargeOptions {
|
|
3686
|
-
/** Payment token. */
|
|
3687
|
-
paymentToken?: string | null;
|
|
3688
|
-
/** Whether the payment method should be saved on the order. */
|
|
3689
|
-
savePaymentMethod?: boolean;
|
|
3690
|
-
/** Whether to authorize the payment and delay the capture. */
|
|
3691
|
-
delayCapture?: boolean;
|
|
3692
|
-
}
|
|
3693
|
-
|
|
3694
|
-
export { type TaxBreakdown as $, type AddToCheckoutOptions as A, MediaItemType as B, type CreateCheckoutOptions as C, DescriptionLineType as D, DiscountDiscountType as E, FileType as F, type GetCheckoutByCartIdResponse as G, ChannelInfoChannelType as H, ItemAvailabilityStatus as I, JurisdictionType as J, WebhookIdentityType as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, type LineItem as O, PaymentOptionType as P, type CatalogReference as Q, type RemoveCouponResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCheckout as U, VatType as V, WeightUnit as W, type ProductName as X, type MultiCurrencyPrice as Y, type ItemTaxFullDetails as Z, type TaxRateBreakdown as _, type Checkout as a, type CarrierErrors as a$, type DescriptionLine as a0, type DescriptionLineValueOneOf as a1, type DescriptionLineDescriptionLineValueOneOf as a2, type DescriptionLineName as a3, type PlainTextValue as a4, type Color as a5, type FocalPoint as a6, type ItemAvailabilityInfo as a7, type PhysicalProperties as a8, type Scope as a9, type ShippingInfo as aA, type SelectedCarrierServiceOption as aB, type DeliveryLogistics as aC, type PickupDetails as aD, type DeliveryTimeSlot as aE, type SelectedCarrierServiceOptionPrices as aF, type SelectedCarrierServiceOptionOtherCharge as aG, type DeliveryAllocation as aH, type Carrier as aI, type Region as aJ, type ApplicableLineItems as aK, type ShippingRegion as aL, type CarrierServiceOption as aM, type ShippingOption as aN, type ShippingPrice as aO, type OtherCharge as aP, type BuyerInfo as aQ, type BuyerInfoIdOneOf as aR, type PriceSummary as aS, type CalculationErrors as aT, type CalculationErrorsShippingCalculationErrorOneOf as aU, type Details as aV, type DetailsKindOneOf as aW, type ApplicationError as aX, type ValidationError as aY, type FieldViolation as aZ, type SystemError as a_, type Group as aa, type ItemType as ab, type ItemTypeItemTypeDataOneOf as ac, type SubscriptionOptionInfo as ad, type SubscriptionSettings as ae, type FreeTrialPeriod as af, type Title as ag, type Description as ah, type SecuredMedia as ai, type ServiceProperties as aj, type PriceDescription as ak, type CatalogOverrideFields as al, type PaymentOption as am, type TaxableAddress as an, type TaxableAddressTaxableAddressDataOneOf as ao, type ExtendedFields as ap, type Policy as aq, type ModifierGroup as ar, type TranslatableString as as, type ItemModifier as at, type AddressWithContact as au, type ApiAddress as av, type StreetAddress as aw, type AddressLocation as ax, type FullAddressContactDetails as ay, type CommonVatId as az, type GetCheckoutURLResponse as b, type RedeemErrorData as b$, type CarrierError as b0, type GiftCard as b1, type AppliedDiscount as b2, type AppliedDiscountDiscountSourceOneOf as b3, type Coupon as b4, type MerchantDiscount as b5, type DiscountRule as b6, type DiscountRuleName as b7, type LineItemDiscount as b8, type CustomField as b9, type UpdatedCheckoutMessage as bA, type CreateCheckoutRequest as bB, type CustomLineItem as bC, type MerchantDiscountInput as bD, type CreateCheckoutResponse as bE, type ShippingCalculationErrorData as bF, type ShippingCalculationErrorDataShippingCalculationErrorOneOf as bG, type GetCheckoutRequest as bH, type GetCheckoutResponse as bI, type GetCheckoutWithAllExtendedFieldsRequest as bJ, type GetCheckoutWithAllExtendedFieldsResponse as bK, type GetCheckoutByCartIdRequest as bL, type GetWixCheckoutURLRequest as bM, type GetWixCheckoutURLResponse as bN, type GetCheckoutURLRequest as bO, type UpdateCheckoutRequest as bP, type UpdateCheckoutResponse as bQ, type RemoveCouponRequest as bR, type RemoveGiftCardRequest as bS, type RemoveOverrideCheckoutUrlRequest as bT, type AddToCheckoutRequest as bU, type RemoveLineItemsRequest as bV, type CreateOrderRequest as bW, type CreateOrderResponseIdOneOf as bX, type PaymentErrorResponseData as bY, type DoublePaymentErrorData as bZ, type DoublePaymentErrorDataIdOneOf as b_, type TaxSummary as ba, type TaxCalculationDetails as bb, type TaxCalculationDetailsCalculationDetailsOneOf as bc, type AutoTaxFallbackCalculationDetails as bd, type AggregatedTaxBreakdown as be, type CreatedBy as bf, type CreatedByIdOneOf as bg, type MembershipOptions as bh, type Membership as bi, type MembershipName as bj, type MembershipPaymentCredits as bk, type InvalidMembership as bl, type SelectedMemberships as bm, type SelectedMembership as bn, type AdditionalFee as bo, type ConversionInfo as bp, type Violation as bq, type Target as br, type TargetTargetTypeOneOf as bs, type Other as bt, type TargetLineItem as bu, type CustomSettings as bv, type CustomContentReference as bw, type ExternalReference as bx, type SubscriptionCharges as by, type Charge as bz, type UpdateCheckoutOptions as c, type ViolationsList as c0, type CreateOrderAndChargeRequest as c1, type CreateOrderAndChargeResponse as c2, type CreateOrderAndChargeResponseIdOneOf as c3, type MarkCheckoutAsCompletedAndRedirectToUrlRequest as c4, type RawHttpResponse as c5, type HeadersEntry as c6, type MarkCheckoutAsCompletedRequest as c7, type MarkCheckoutAsCompletedResponse as c8, type CheckoutMarkedAsCompleted as c9, type AppliedCoupon as cA, type V1CustomField as cB, type V1SubscriptionOptionInfo as cC, type Discount as cD, type ChannelInfo as cE, type V1SubscriptionSettings as cF, type BillingInfo as cG, type Empty as cH, type DomainEvent as cI, type DomainEventBodyOneOf as cJ, type EntityCreatedEvent as cK, type RestoreInfo as cL, type EntityUpdatedEvent as cM, type EntityDeletedEvent as cN, type ActionEvent as cO, type MessageEnvelope as cP, type IdentificationData as cQ, type IdentificationDataIdOneOf as cR, type BaseEventMetadata as cS, type EventMetadata as cT, type CheckoutCompletedEnvelope as cU, type CheckoutCreatedEnvelope as cV, type CheckoutUpdatedEnvelope as cW, type CreateOrderAndChargeOptions as cX, type UpdateLineItemsQuantityRequest as ca, type GetCheckoutPaymentSettingsRequest as cb, type GetCheckoutPaymentSettingsResponse as cc, type DeleteCheckoutRequest as cd, type DeleteCheckoutResponse as ce, type SubscriptionCreated as cf, type Subscription as cg, type V1BuyerInfo as ch, type V1LineItem as ci, type OptionSelection as cj, type CustomTextFieldSelection as ck, type ChargeDetails as cl, type ProductDetails as cm, type MediaItem as cn, type Totals as co, type StoreSettings as cp, type Address as cq, type AddressAddressLine1OptionsOneOf as cr, type FullName as cs, type Street as ct, type VatId as cu, type V1ShippingInfo as cv, type V1ShippingInfoDetailsOneOf as cw, type ShipmentDetails as cx, type V1PickupDetails as cy, type PickupAddress as cz, type RemoveGiftCardResponse as d, type RemoveOverrideCheckoutUrlResponse as e, type AddToCheckoutResponse as f, type RemoveLineItemsResponse as g, type CreateOrderOptions as h, type CreateOrderResponse as i, type UpdateLineItemsQuantityResponse as j, ItemTypeItemType as k, CommonVatType as l, PickupMethod as m, ChargeType as n, RuleType as o, DiscountType as p, RateType as q, FallbackReason as r, ChannelType as s, AdditionalFeeSource as t, Severity as u, NameInLineItem as v, SuggestedFix as w, GetCheckoutPaymentSettingsResponsePaymentOption as x, IdentityType as y, LineItemType as z };
|