@wix/auto_sdk_ecom_checkout 1.0.15 → 1.0.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-C4Y04uL3.d.mts} +658 -376
- package/build/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-C4Y04uL3.d.ts} +658 -376
- package/build/index.d.mts +211 -0
- package/build/index.d.ts +211 -0
- package/build/index.js +2781 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +2707 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.mts} +867 -376
- package/build/internal/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.ts} +867 -376
- package/build/internal/index.d.mts +252 -0
- package/build/internal/index.d.ts +252 -0
- package/build/internal/index.js +2781 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +2707 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2322 -0
- package/build/internal/meta.d.ts +2322 -0
- package/build/internal/meta.js +1587 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1544 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2322 -0
- package/build/meta.d.ts +2322 -0
- package/build/meta.js +1587 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1544 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -34
- package/build/cjs/src/ecom-v1-checkout-checkout.context.js +0 -77
- package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1338
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -186
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js +0 -358
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js +0 -301
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4211
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1597
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +0 -34
- package/build/es/src/ecom-v1-checkout-checkout.context.js +0 -42
- package/build/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
- package/build/es/src/ecom-v1-checkout-checkout.http.js +0 -1318
- package/build/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
- package/build/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
- package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -186
- package/build/es/src/ecom-v1-checkout-checkout.public.js +0 -306
- package/build/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.types.js +0 -298
- package/build/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
- package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4211
- package/build/es/src/ecom-v1-checkout-checkout.universal.js +0 -1554
- package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -42
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +0 -77
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1338
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -219
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +0 -358
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +0 -301
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4500
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1597
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +0 -42
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +0 -42
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +0 -1318
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -219
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +0 -306
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +0 -298
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4500
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +0 -1554
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface Checkout {
|
|
2
2
|
/**
|
|
3
3
|
* Checkout ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
_id?: string | null;
|
|
8
8
|
/**
|
|
9
9
|
* Line items.
|
|
10
10
|
*
|
|
@@ -19,7 +19,7 @@ export 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/wix-stores-viewing-buyer-notes) left by the customer.
|
|
23
23
|
* @maxLength 1000
|
|
24
24
|
*/
|
|
25
25
|
buyerNote?: string | null;
|
|
@@ -107,12 +107,12 @@ export 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 @@ export interface Checkout {
|
|
|
136
136
|
*/
|
|
137
137
|
cartId?: string | null;
|
|
138
138
|
/**
|
|
139
|
-
* List of validation violations raised by the Validations
|
|
139
|
+
* List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
|
|
140
140
|
* @readonly
|
|
141
141
|
*/
|
|
142
142
|
violations?: Violation[];
|
|
@@ -155,9 +155,7 @@ export interface Checkout {
|
|
|
155
155
|
/**
|
|
156
156
|
* Additional settings for customization of the checkout process.
|
|
157
157
|
*
|
|
158
|
-
*
|
|
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).
|
|
158
|
+
* Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
|
|
161
159
|
* @immutable
|
|
162
160
|
*/
|
|
163
161
|
customSettings?: CustomSettings;
|
|
@@ -176,13 +174,13 @@ export interface Checkout {
|
|
|
176
174
|
*/
|
|
177
175
|
businessLocationId?: string | null;
|
|
178
176
|
}
|
|
179
|
-
|
|
177
|
+
interface LineItem {
|
|
180
178
|
/**
|
|
181
179
|
* Line item ID.
|
|
182
180
|
* @format GUID
|
|
183
181
|
* @readonly
|
|
184
182
|
*/
|
|
185
|
-
|
|
183
|
+
_id?: string | null;
|
|
186
184
|
/**
|
|
187
185
|
* Item quantity.
|
|
188
186
|
*
|
|
@@ -192,7 +190,7 @@ export interface LineItem {
|
|
|
192
190
|
* @max 100000
|
|
193
191
|
*/
|
|
194
192
|
quantity?: number;
|
|
195
|
-
/** Catalog and item reference.
|
|
193
|
+
/** Catalog and item reference. Holds 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. */
|
|
196
194
|
catalogReference?: CatalogReference;
|
|
197
195
|
/**
|
|
198
196
|
* Item name.
|
|
@@ -206,7 +204,7 @@ export interface LineItem {
|
|
|
206
204
|
* URL to the item's page on the site.
|
|
207
205
|
* @readonly
|
|
208
206
|
*/
|
|
209
|
-
url?:
|
|
207
|
+
url?: string;
|
|
210
208
|
/**
|
|
211
209
|
* Item price **after** catalog-defined discount and line item discounts.
|
|
212
210
|
* @readonly
|
|
@@ -248,7 +246,7 @@ export interface LineItem {
|
|
|
248
246
|
*/
|
|
249
247
|
discount?: MultiCurrencyPrice;
|
|
250
248
|
/**
|
|
251
|
-
* Line item description lines. Used for
|
|
249
|
+
* Line item description lines. Used for displaying the cart, checkout and order.
|
|
252
250
|
* @readonly
|
|
253
251
|
*/
|
|
254
252
|
descriptionLines?: DescriptionLine[];
|
|
@@ -256,7 +254,7 @@ export interface LineItem {
|
|
|
256
254
|
* Line item image details.
|
|
257
255
|
* @readonly
|
|
258
256
|
*/
|
|
259
|
-
media?:
|
|
257
|
+
media?: string;
|
|
260
258
|
/**
|
|
261
259
|
* Item availability details.
|
|
262
260
|
* @readonly
|
|
@@ -278,9 +276,11 @@ export interface LineItem {
|
|
|
278
276
|
*/
|
|
279
277
|
subscriptionOptionInfo?: SubscriptionOptionInfo;
|
|
280
278
|
/**
|
|
281
|
-
* Type of selected payment option for current item.
|
|
282
|
-
*
|
|
283
|
-
*
|
|
279
|
+
* Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
|
|
280
|
+
* + `"FULL_PAYMENT_ONLINE"`: The entire payment for this item happens as part of the checkout.
|
|
281
|
+
* + `"FULL_PAYMENT_OFFLINE"`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
282
|
+
* + `"MEMBERSHIP"`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
283
|
+
* + `"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.
|
|
284
284
|
* @readonly
|
|
285
285
|
*/
|
|
286
286
|
paymentOption?: PaymentOptionType;
|
|
@@ -343,7 +343,7 @@ export interface LineItem {
|
|
|
343
343
|
savePaymentMethod?: boolean;
|
|
344
344
|
}
|
|
345
345
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
346
|
-
|
|
346
|
+
interface CatalogReference {
|
|
347
347
|
/**
|
|
348
348
|
* ID of the item within the catalog it belongs to.
|
|
349
349
|
* @minLength 1
|
|
@@ -363,13 +363,15 @@ export interface CatalogReference {
|
|
|
363
363
|
*/
|
|
364
364
|
appId?: string;
|
|
365
365
|
/**
|
|
366
|
-
* Additional item details in key:value pairs.
|
|
366
|
+
* Additional item details in key:value pairs.
|
|
367
|
+
*
|
|
368
|
+
* Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
367
369
|
*
|
|
368
|
-
* For products and variants from
|
|
370
|
+
* For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).
|
|
369
371
|
*/
|
|
370
372
|
options?: Record<string, any> | null;
|
|
371
373
|
}
|
|
372
|
-
|
|
374
|
+
interface ProductName {
|
|
373
375
|
/**
|
|
374
376
|
* __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).
|
|
375
377
|
*
|
|
@@ -390,13 +392,7 @@ export interface ProductName {
|
|
|
390
392
|
*/
|
|
391
393
|
translated?: string | null;
|
|
392
394
|
}
|
|
393
|
-
|
|
394
|
-
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
395
|
-
relativePath?: string;
|
|
396
|
-
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
397
|
-
url?: string | null;
|
|
398
|
-
}
|
|
399
|
-
export interface MultiCurrencyPrice {
|
|
395
|
+
interface MultiCurrencyPrice {
|
|
400
396
|
/**
|
|
401
397
|
* Amount.
|
|
402
398
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -419,7 +415,7 @@ export interface MultiCurrencyPrice {
|
|
|
419
415
|
*/
|
|
420
416
|
formattedConvertedAmount?: string;
|
|
421
417
|
}
|
|
422
|
-
|
|
418
|
+
interface ItemTaxFullDetails {
|
|
423
419
|
/** Amount for which tax is calculated. */
|
|
424
420
|
taxableAmount?: MultiCurrencyPrice;
|
|
425
421
|
/**
|
|
@@ -436,7 +432,7 @@ export interface ItemTaxFullDetails {
|
|
|
436
432
|
*/
|
|
437
433
|
rateBreakdown?: TaxRateBreakdown[];
|
|
438
434
|
}
|
|
439
|
-
|
|
435
|
+
interface TaxRateBreakdown {
|
|
440
436
|
/**
|
|
441
437
|
* Name of tax against which the calculation was performed.
|
|
442
438
|
* @maxLength 100
|
|
@@ -454,7 +450,7 @@ export interface TaxRateBreakdown {
|
|
|
454
450
|
* TaxBreakdown represents tax information for a line item.
|
|
455
451
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
456
452
|
*/
|
|
457
|
-
|
|
453
|
+
interface TaxBreakdown {
|
|
458
454
|
/**
|
|
459
455
|
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
460
456
|
* @maxLength 200
|
|
@@ -486,7 +482,7 @@ export interface TaxBreakdown {
|
|
|
486
482
|
jurisdictionType?: JurisdictionType;
|
|
487
483
|
}
|
|
488
484
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
489
|
-
|
|
485
|
+
declare enum JurisdictionType {
|
|
490
486
|
UNDEFINED = "UNDEFINED",
|
|
491
487
|
COUNTRY = "COUNTRY",
|
|
492
488
|
STATE = "STATE",
|
|
@@ -494,7 +490,7 @@ export declare enum JurisdictionType {
|
|
|
494
490
|
CITY = "CITY",
|
|
495
491
|
SPECIAL = "SPECIAL"
|
|
496
492
|
}
|
|
497
|
-
|
|
493
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
498
494
|
/** Description line plain text value. */
|
|
499
495
|
plainText?: PlainTextValue;
|
|
500
496
|
/** Description line color value. */
|
|
@@ -503,16 +499,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
503
499
|
name?: DescriptionLineName;
|
|
504
500
|
}
|
|
505
501
|
/** @oneof */
|
|
506
|
-
|
|
502
|
+
interface DescriptionLineValueOneOf {
|
|
507
503
|
/** Description line plain text value. */
|
|
508
504
|
plainText?: PlainTextValue;
|
|
509
505
|
/** Description line color value. */
|
|
510
506
|
colorInfo?: Color;
|
|
511
507
|
}
|
|
512
508
|
/** @oneof */
|
|
513
|
-
|
|
509
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
514
510
|
}
|
|
515
|
-
|
|
511
|
+
interface DescriptionLineName {
|
|
516
512
|
/**
|
|
517
513
|
* 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).
|
|
518
514
|
* @maxLength 100
|
|
@@ -526,7 +522,7 @@ export interface DescriptionLineName {
|
|
|
526
522
|
*/
|
|
527
523
|
translated?: string | null;
|
|
528
524
|
}
|
|
529
|
-
|
|
525
|
+
interface PlainTextValue {
|
|
530
526
|
/**
|
|
531
527
|
* 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).
|
|
532
528
|
* @maxLength 600
|
|
@@ -540,7 +536,7 @@ export interface PlainTextValue {
|
|
|
540
536
|
*/
|
|
541
537
|
translated?: string | null;
|
|
542
538
|
}
|
|
543
|
-
|
|
539
|
+
interface Color {
|
|
544
540
|
/**
|
|
545
541
|
* 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).
|
|
546
542
|
* @maxLength 500
|
|
@@ -556,7 +552,7 @@ export interface Color {
|
|
|
556
552
|
/** HEX or RGB color code for display. */
|
|
557
553
|
code?: string | null;
|
|
558
554
|
}
|
|
559
|
-
|
|
555
|
+
declare enum DescriptionLineType {
|
|
560
556
|
/** Unrecognized type. */
|
|
561
557
|
UNRECOGNISED = "UNRECOGNISED",
|
|
562
558
|
/** Plain text type. */
|
|
@@ -564,30 +560,7 @@ export declare enum DescriptionLineType {
|
|
|
564
560
|
/** Color type. */
|
|
565
561
|
COLOR = "COLOR"
|
|
566
562
|
}
|
|
567
|
-
|
|
568
|
-
/** WixMedia image ID. */
|
|
569
|
-
id?: string;
|
|
570
|
-
/** Image URL. */
|
|
571
|
-
url?: string;
|
|
572
|
-
/**
|
|
573
|
-
* Original image height.
|
|
574
|
-
* @readonly
|
|
575
|
-
*/
|
|
576
|
-
height?: number;
|
|
577
|
-
/**
|
|
578
|
-
* Original image width.
|
|
579
|
-
* @readonly
|
|
580
|
-
*/
|
|
581
|
-
width?: number;
|
|
582
|
-
/** Image alt text. */
|
|
583
|
-
altText?: string | null;
|
|
584
|
-
/**
|
|
585
|
-
* Image filename.
|
|
586
|
-
* @readonly
|
|
587
|
-
*/
|
|
588
|
-
filename?: string | null;
|
|
589
|
-
}
|
|
590
|
-
export interface FocalPoint {
|
|
563
|
+
interface FocalPoint {
|
|
591
564
|
/** X-coordinate of the focal point. */
|
|
592
565
|
x?: number;
|
|
593
566
|
/** Y-coordinate of the focal point. */
|
|
@@ -597,13 +570,13 @@ export interface FocalPoint {
|
|
|
597
570
|
/** crop by width */
|
|
598
571
|
width?: number | null;
|
|
599
572
|
}
|
|
600
|
-
|
|
573
|
+
interface ItemAvailabilityInfo {
|
|
601
574
|
/** Item availability status. */
|
|
602
575
|
status?: ItemAvailabilityStatus;
|
|
603
576
|
/** Quantity available. */
|
|
604
577
|
quantityAvailable?: number | null;
|
|
605
578
|
}
|
|
606
|
-
|
|
579
|
+
declare enum ItemAvailabilityStatus {
|
|
607
580
|
AVAILABLE = "AVAILABLE",
|
|
608
581
|
/** Item does not exist. */
|
|
609
582
|
NOT_FOUND = "NOT_FOUND",
|
|
@@ -612,8 +585,8 @@ export declare enum ItemAvailabilityStatus {
|
|
|
612
585
|
/** Available quantity is less than requested. */
|
|
613
586
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
614
587
|
}
|
|
615
|
-
|
|
616
|
-
/** Line item weight. Measurement unit
|
|
588
|
+
interface PhysicalProperties {
|
|
589
|
+
/** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
|
|
617
590
|
weight?: number | null;
|
|
618
591
|
/**
|
|
619
592
|
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
@@ -623,39 +596,39 @@ export interface PhysicalProperties {
|
|
|
623
596
|
/** Whether this line item is shippable. */
|
|
624
597
|
shippable?: boolean;
|
|
625
598
|
}
|
|
626
|
-
|
|
599
|
+
interface Scope {
|
|
627
600
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
628
601
|
namespace?: string;
|
|
629
602
|
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
630
603
|
group?: Group;
|
|
631
604
|
}
|
|
632
|
-
|
|
605
|
+
interface Group {
|
|
633
606
|
/** 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). */
|
|
634
607
|
name?: string;
|
|
635
608
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
636
609
|
entityId?: string | null;
|
|
637
610
|
}
|
|
638
|
-
|
|
611
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
639
612
|
/** Preset item type. */
|
|
640
613
|
preset?: ItemTypeItemType;
|
|
641
614
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
642
615
|
custom?: string;
|
|
643
616
|
}
|
|
644
617
|
/** @oneof */
|
|
645
|
-
|
|
618
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
646
619
|
/** Preset item type. */
|
|
647
620
|
preset?: ItemTypeItemType;
|
|
648
621
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
649
622
|
custom?: string;
|
|
650
623
|
}
|
|
651
|
-
|
|
624
|
+
declare enum ItemTypeItemType {
|
|
652
625
|
UNRECOGNISED = "UNRECOGNISED",
|
|
653
626
|
PHYSICAL = "PHYSICAL",
|
|
654
627
|
DIGITAL = "DIGITAL",
|
|
655
628
|
GIFT_CARD = "GIFT_CARD",
|
|
656
629
|
SERVICE = "SERVICE"
|
|
657
630
|
}
|
|
658
|
-
|
|
631
|
+
interface SubscriptionOptionInfo {
|
|
659
632
|
/** Subscription option settings. */
|
|
660
633
|
subscriptionSettings?: SubscriptionSettings;
|
|
661
634
|
/** Subscription option title. */
|
|
@@ -663,7 +636,7 @@ export interface SubscriptionOptionInfo {
|
|
|
663
636
|
/** Subscription option description. */
|
|
664
637
|
description?: Description;
|
|
665
638
|
}
|
|
666
|
-
|
|
639
|
+
interface SubscriptionSettings {
|
|
667
640
|
/** Frequency of recurring payment. */
|
|
668
641
|
frequency?: SubscriptionFrequency;
|
|
669
642
|
/**
|
|
@@ -684,14 +657,14 @@ export interface SubscriptionSettings {
|
|
|
684
657
|
billingCycles?: number | null;
|
|
685
658
|
}
|
|
686
659
|
/** Frequency unit of recurring payment */
|
|
687
|
-
|
|
660
|
+
declare enum SubscriptionFrequency {
|
|
688
661
|
UNDEFINED = "UNDEFINED",
|
|
689
662
|
DAY = "DAY",
|
|
690
663
|
WEEK = "WEEK",
|
|
691
664
|
MONTH = "MONTH",
|
|
692
665
|
YEAR = "YEAR"
|
|
693
666
|
}
|
|
694
|
-
|
|
667
|
+
interface FreeTrialPeriod {
|
|
695
668
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
696
669
|
frequency?: SubscriptionFrequency;
|
|
697
670
|
/**
|
|
@@ -701,7 +674,7 @@ export interface FreeTrialPeriod {
|
|
|
701
674
|
*/
|
|
702
675
|
interval?: number;
|
|
703
676
|
}
|
|
704
|
-
|
|
677
|
+
interface Title {
|
|
705
678
|
/**
|
|
706
679
|
* 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).
|
|
707
680
|
* @minLength 1
|
|
@@ -717,7 +690,7 @@ export interface Title {
|
|
|
717
690
|
*/
|
|
718
691
|
translated?: string | null;
|
|
719
692
|
}
|
|
720
|
-
|
|
693
|
+
interface Description {
|
|
721
694
|
/**
|
|
722
695
|
* Subscription option description.
|
|
723
696
|
* @maxLength 500
|
|
@@ -729,13 +702,13 @@ export interface Description {
|
|
|
729
702
|
*/
|
|
730
703
|
translated?: string | null;
|
|
731
704
|
}
|
|
732
|
-
|
|
705
|
+
interface SecuredMedia {
|
|
733
706
|
/**
|
|
734
707
|
* Media ID in Wix Media Manager.
|
|
735
708
|
* @minLength 1
|
|
736
709
|
* @maxLength 100
|
|
737
710
|
*/
|
|
738
|
-
|
|
711
|
+
_id?: string;
|
|
739
712
|
/**
|
|
740
713
|
* Original filename.
|
|
741
714
|
* @minLength 1
|
|
@@ -745,7 +718,7 @@ export interface SecuredMedia {
|
|
|
745
718
|
/** File type. */
|
|
746
719
|
fileType?: FileType;
|
|
747
720
|
}
|
|
748
|
-
|
|
721
|
+
declare enum FileType {
|
|
749
722
|
UNSPECIFIED = "UNSPECIFIED",
|
|
750
723
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
751
724
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -754,7 +727,7 @@ export declare enum FileType {
|
|
|
754
727
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
755
728
|
}
|
|
756
729
|
/** Type of selected payment option for catalog item */
|
|
757
|
-
|
|
730
|
+
declare enum PaymentOptionType {
|
|
758
731
|
/** The entire payment for this item happens as part of the checkout. */
|
|
759
732
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
760
733
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -766,7 +739,7 @@ export declare enum PaymentOptionType {
|
|
|
766
739
|
/** 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`. */
|
|
767
740
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
768
741
|
}
|
|
769
|
-
|
|
742
|
+
interface ServiceProperties {
|
|
770
743
|
/**
|
|
771
744
|
* 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.
|
|
772
745
|
* For example, the start time of a class.
|
|
@@ -779,7 +752,7 @@ export interface ServiceProperties {
|
|
|
779
752
|
*/
|
|
780
753
|
numberOfParticipants?: number | null;
|
|
781
754
|
}
|
|
782
|
-
|
|
755
|
+
interface PriceDescription {
|
|
783
756
|
/**
|
|
784
757
|
* __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).
|
|
785
758
|
* @minLength 1
|
|
@@ -795,7 +768,7 @@ export interface PriceDescription {
|
|
|
795
768
|
*/
|
|
796
769
|
translated?: string | null;
|
|
797
770
|
}
|
|
798
|
-
|
|
771
|
+
interface CatalogOverrideFields {
|
|
799
772
|
/** Item name. */
|
|
800
773
|
productName?: ProductName;
|
|
801
774
|
/**
|
|
@@ -816,7 +789,7 @@ export interface CatalogOverrideFields {
|
|
|
816
789
|
/** Physical properties of the item. */
|
|
817
790
|
physicalProperties?: PhysicalProperties;
|
|
818
791
|
/** Item image. */
|
|
819
|
-
image?:
|
|
792
|
+
image?: string;
|
|
820
793
|
/** Payment method selected for the item. */
|
|
821
794
|
paymentOption?: PaymentOption;
|
|
822
795
|
/**
|
|
@@ -832,19 +805,7 @@ export interface CatalogOverrideFields {
|
|
|
832
805
|
*/
|
|
833
806
|
savePaymentMethod?: boolean | null;
|
|
834
807
|
}
|
|
835
|
-
|
|
836
|
-
/** WixMedia image ID. */
|
|
837
|
-
id?: string;
|
|
838
|
-
/** Original image height. */
|
|
839
|
-
height?: number;
|
|
840
|
-
/** Original image width. */
|
|
841
|
-
width?: number;
|
|
842
|
-
/** Image alt text. Optional. */
|
|
843
|
-
altText?: string | null;
|
|
844
|
-
/** Image filename. Optional. */
|
|
845
|
-
filename?: string | null;
|
|
846
|
-
}
|
|
847
|
-
export interface PaymentOption {
|
|
808
|
+
interface PaymentOption {
|
|
848
809
|
/**
|
|
849
810
|
* Type of selected payment option for current item.
|
|
850
811
|
*
|
|
@@ -852,22 +813,22 @@ export interface PaymentOption {
|
|
|
852
813
|
*/
|
|
853
814
|
value?: PaymentOptionType;
|
|
854
815
|
}
|
|
855
|
-
|
|
816
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
856
817
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
857
818
|
addressType?: TaxableAddressType;
|
|
858
819
|
}
|
|
859
820
|
/** @oneof */
|
|
860
|
-
|
|
821
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
861
822
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
862
823
|
addressType?: TaxableAddressType;
|
|
863
824
|
}
|
|
864
|
-
|
|
825
|
+
declare enum TaxableAddressType {
|
|
865
826
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
866
827
|
BUSINESS = "BUSINESS",
|
|
867
828
|
BILLING = "BILLING",
|
|
868
829
|
SHIPPING = "SHIPPING"
|
|
869
830
|
}
|
|
870
|
-
|
|
831
|
+
interface ExtendedFields {
|
|
871
832
|
/**
|
|
872
833
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
873
834
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -878,7 +839,7 @@ export interface ExtendedFields {
|
|
|
878
839
|
*/
|
|
879
840
|
namespaces?: Record<string, Record<string, any>>;
|
|
880
841
|
}
|
|
881
|
-
|
|
842
|
+
interface Policy {
|
|
882
843
|
/**
|
|
883
844
|
* Policy title - should be translated
|
|
884
845
|
* @minLength 1
|
|
@@ -892,13 +853,13 @@ export interface Policy {
|
|
|
892
853
|
*/
|
|
893
854
|
content?: string;
|
|
894
855
|
}
|
|
895
|
-
|
|
856
|
+
interface ModifierGroup {
|
|
896
857
|
/**
|
|
897
858
|
* Modifier group id.
|
|
898
859
|
* @minLength 1
|
|
899
860
|
* @maxLength 36
|
|
900
861
|
*/
|
|
901
|
-
|
|
862
|
+
_id?: string;
|
|
902
863
|
/** Modifier group name. */
|
|
903
864
|
name?: TranslatableString;
|
|
904
865
|
/**
|
|
@@ -908,7 +869,7 @@ export interface ModifierGroup {
|
|
|
908
869
|
*/
|
|
909
870
|
modifiers?: ItemModifier[];
|
|
910
871
|
}
|
|
911
|
-
|
|
872
|
+
interface TranslatableString {
|
|
912
873
|
/**
|
|
913
874
|
* __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).
|
|
914
875
|
*
|
|
@@ -929,13 +890,13 @@ export interface TranslatableString {
|
|
|
929
890
|
*/
|
|
930
891
|
translated?: string | null;
|
|
931
892
|
}
|
|
932
|
-
|
|
893
|
+
interface ItemModifier {
|
|
933
894
|
/**
|
|
934
895
|
* Modifier ID.
|
|
935
896
|
* @minLength 1
|
|
936
897
|
* @maxLength 36
|
|
937
898
|
*/
|
|
938
|
-
|
|
899
|
+
_id?: string;
|
|
939
900
|
/**
|
|
940
901
|
* The quantity of this modifier.
|
|
941
902
|
* @min 1
|
|
@@ -950,14 +911,14 @@ export interface ItemModifier {
|
|
|
950
911
|
price?: MultiCurrencyPrice;
|
|
951
912
|
}
|
|
952
913
|
/** Billing Info and shipping details */
|
|
953
|
-
|
|
914
|
+
interface AddressWithContact {
|
|
954
915
|
/** Address. */
|
|
955
916
|
address?: ApiAddress;
|
|
956
917
|
/** Contact details. */
|
|
957
918
|
contactDetails?: FullAddressContactDetails;
|
|
958
919
|
}
|
|
959
920
|
/** Physical address */
|
|
960
|
-
|
|
921
|
+
interface ApiAddress {
|
|
961
922
|
/**
|
|
962
923
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
963
924
|
* @format COUNTRY
|
|
@@ -984,7 +945,7 @@ export interface ApiAddress {
|
|
|
984
945
|
* Main address line (usually street name and number).
|
|
985
946
|
* @maxLength 150
|
|
986
947
|
*/
|
|
987
|
-
|
|
948
|
+
addressLine1?: string | null;
|
|
988
949
|
/**
|
|
989
950
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
990
951
|
* @maxLength 100
|
|
@@ -1001,20 +962,20 @@ export interface ApiAddress {
|
|
|
1001
962
|
*/
|
|
1002
963
|
subdivisionFullname?: string | null;
|
|
1003
964
|
}
|
|
1004
|
-
|
|
965
|
+
interface StreetAddress {
|
|
1005
966
|
/** Street number. */
|
|
1006
967
|
number?: string;
|
|
1007
968
|
/** Street name. */
|
|
1008
969
|
name?: string;
|
|
1009
970
|
}
|
|
1010
|
-
|
|
971
|
+
interface AddressLocation {
|
|
1011
972
|
/** Address latitude. */
|
|
1012
973
|
latitude?: number | null;
|
|
1013
974
|
/** Address longitude. */
|
|
1014
975
|
longitude?: number | null;
|
|
1015
976
|
}
|
|
1016
977
|
/** Full contact details for an address */
|
|
1017
|
-
|
|
978
|
+
interface FullAddressContactDetails {
|
|
1018
979
|
/**
|
|
1019
980
|
* First name.
|
|
1020
981
|
* @maxLength 100
|
|
@@ -1038,9 +999,9 @@ export interface FullAddressContactDetails {
|
|
|
1038
999
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1039
1000
|
vatId?: CommonVatId;
|
|
1040
1001
|
}
|
|
1041
|
-
|
|
1002
|
+
interface CommonVatId {
|
|
1042
1003
|
/** Customer's tax ID. */
|
|
1043
|
-
|
|
1004
|
+
_id?: string;
|
|
1044
1005
|
/**
|
|
1045
1006
|
* Tax type.
|
|
1046
1007
|
*
|
|
@@ -1051,14 +1012,14 @@ export interface CommonVatId {
|
|
|
1051
1012
|
type?: CommonVatType;
|
|
1052
1013
|
}
|
|
1053
1014
|
/** tax info types */
|
|
1054
|
-
|
|
1015
|
+
declare enum CommonVatType {
|
|
1055
1016
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1056
1017
|
/** CPF - for individual tax payers. */
|
|
1057
1018
|
CPF = "CPF",
|
|
1058
1019
|
/** CNPJ - for corporations */
|
|
1059
1020
|
CNPJ = "CNPJ"
|
|
1060
1021
|
}
|
|
1061
|
-
|
|
1022
|
+
interface ShippingInfo {
|
|
1062
1023
|
/** Shipping address and contact details. */
|
|
1063
1024
|
shippingDestination?: AddressWithContact;
|
|
1064
1025
|
/** Selected option out of the options allowed for the `region`. */
|
|
@@ -1074,7 +1035,7 @@ export interface ShippingInfo {
|
|
|
1074
1035
|
*/
|
|
1075
1036
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
1076
1037
|
}
|
|
1077
|
-
|
|
1038
|
+
interface SelectedCarrierServiceOption {
|
|
1078
1039
|
/**
|
|
1079
1040
|
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1080
1041
|
* @maxLength 100
|
|
@@ -1117,7 +1078,7 @@ export interface SelectedCarrierServiceOption {
|
|
|
1117
1078
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1118
1079
|
partial?: boolean | null;
|
|
1119
1080
|
}
|
|
1120
|
-
|
|
1081
|
+
interface DeliveryLogistics {
|
|
1121
1082
|
/**
|
|
1122
1083
|
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1123
1084
|
* @maxLength 500
|
|
@@ -1131,7 +1092,7 @@ export interface DeliveryLogistics {
|
|
|
1131
1092
|
/** Pickup details. */
|
|
1132
1093
|
pickupDetails?: PickupDetails;
|
|
1133
1094
|
}
|
|
1134
|
-
|
|
1095
|
+
interface PickupDetails {
|
|
1135
1096
|
/** Pickup address. */
|
|
1136
1097
|
address?: ApiAddress;
|
|
1137
1098
|
/**
|
|
@@ -1142,18 +1103,18 @@ export interface PickupDetails {
|
|
|
1142
1103
|
/** Pickup method */
|
|
1143
1104
|
pickupMethod?: PickupMethod;
|
|
1144
1105
|
}
|
|
1145
|
-
|
|
1106
|
+
declare enum PickupMethod {
|
|
1146
1107
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1147
1108
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1148
1109
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1149
1110
|
}
|
|
1150
|
-
|
|
1111
|
+
interface DeliveryTimeSlot {
|
|
1151
1112
|
/** starting time of the delivery time slot */
|
|
1152
1113
|
from?: Date | null;
|
|
1153
1114
|
/** ending time of the delivery time slot */
|
|
1154
1115
|
to?: Date | null;
|
|
1155
1116
|
}
|
|
1156
|
-
|
|
1117
|
+
interface SelectedCarrierServiceOptionPrices {
|
|
1157
1118
|
/** Total shipping price, after discount and after tax. */
|
|
1158
1119
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1159
1120
|
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
@@ -1165,7 +1126,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1165
1126
|
/** Shipping price before discount and before tax. */
|
|
1166
1127
|
price?: MultiCurrencyPrice;
|
|
1167
1128
|
}
|
|
1168
|
-
|
|
1129
|
+
interface SelectedCarrierServiceOptionOtherCharge {
|
|
1169
1130
|
/** Type of additional cost. */
|
|
1170
1131
|
type?: ChargeType;
|
|
1171
1132
|
/**
|
|
@@ -1176,11 +1137,11 @@ export interface SelectedCarrierServiceOptionOtherCharge {
|
|
|
1176
1137
|
/** Price of added charge. */
|
|
1177
1138
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
1178
1139
|
}
|
|
1179
|
-
|
|
1140
|
+
declare enum ChargeType {
|
|
1180
1141
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1181
1142
|
INSURANCE = "INSURANCE"
|
|
1182
1143
|
}
|
|
1183
|
-
|
|
1144
|
+
interface DeliveryAllocation {
|
|
1184
1145
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1185
1146
|
deliveryCarrier?: Carrier;
|
|
1186
1147
|
/** The delivery region that are relevant for this delivery solution. */
|
|
@@ -1188,7 +1149,7 @@ export interface DeliveryAllocation {
|
|
|
1188
1149
|
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
1189
1150
|
applicableLineItems?: ApplicableLineItems;
|
|
1190
1151
|
}
|
|
1191
|
-
|
|
1152
|
+
interface Carrier {
|
|
1192
1153
|
/**
|
|
1193
1154
|
* The carrier app id
|
|
1194
1155
|
* @format GUID
|
|
@@ -1200,19 +1161,19 @@ export interface Carrier {
|
|
|
1200
1161
|
*/
|
|
1201
1162
|
code?: string;
|
|
1202
1163
|
}
|
|
1203
|
-
|
|
1164
|
+
interface Region {
|
|
1204
1165
|
/**
|
|
1205
1166
|
* The delivery region id.
|
|
1206
1167
|
* @format GUID
|
|
1207
1168
|
*/
|
|
1208
|
-
|
|
1169
|
+
_id?: string | null;
|
|
1209
1170
|
/**
|
|
1210
1171
|
* The delivery region name.
|
|
1211
1172
|
* @maxLength 100
|
|
1212
1173
|
*/
|
|
1213
1174
|
name?: string | null;
|
|
1214
1175
|
}
|
|
1215
|
-
|
|
1176
|
+
interface ApplicableLineItems {
|
|
1216
1177
|
/**
|
|
1217
1178
|
* Line items that the delivery solution is for.
|
|
1218
1179
|
* @maxSize 300
|
|
@@ -1221,20 +1182,20 @@ export interface ApplicableLineItems {
|
|
|
1221
1182
|
*/
|
|
1222
1183
|
lineItemIds?: string[];
|
|
1223
1184
|
}
|
|
1224
|
-
|
|
1185
|
+
interface ShippingRegion {
|
|
1225
1186
|
/**
|
|
1226
1187
|
* Shipping region ID.
|
|
1227
1188
|
* @format GUID
|
|
1228
1189
|
* @readonly
|
|
1229
1190
|
*/
|
|
1230
|
-
|
|
1191
|
+
_id?: string;
|
|
1231
1192
|
/**
|
|
1232
1193
|
* Shipping region name.
|
|
1233
1194
|
* @maxLength 100
|
|
1234
1195
|
*/
|
|
1235
1196
|
name?: string;
|
|
1236
1197
|
}
|
|
1237
|
-
|
|
1198
|
+
interface CarrierServiceOption {
|
|
1238
1199
|
/**
|
|
1239
1200
|
* Carrier ID.
|
|
1240
1201
|
* @format GUID
|
|
@@ -1243,7 +1204,7 @@ export interface CarrierServiceOption {
|
|
|
1243
1204
|
/** Shipping options offered by this carrier for this request. */
|
|
1244
1205
|
shippingOptions?: ShippingOption[];
|
|
1245
1206
|
}
|
|
1246
|
-
|
|
1207
|
+
interface ShippingOption {
|
|
1247
1208
|
/**
|
|
1248
1209
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1249
1210
|
* For legacy calculators this would be the UUID of the option.
|
|
@@ -1268,33 +1229,33 @@ export interface ShippingOption {
|
|
|
1268
1229
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1269
1230
|
partial?: boolean | null;
|
|
1270
1231
|
}
|
|
1271
|
-
|
|
1232
|
+
interface ShippingPrice {
|
|
1272
1233
|
/** Shipping price. */
|
|
1273
1234
|
price?: MultiCurrencyPrice;
|
|
1274
1235
|
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
1275
1236
|
otherCharges?: OtherCharge[];
|
|
1276
1237
|
}
|
|
1277
|
-
|
|
1238
|
+
interface OtherCharge {
|
|
1278
1239
|
/** Type of additional cost. */
|
|
1279
1240
|
type?: ChargeType;
|
|
1280
1241
|
/** Price of added cost. */
|
|
1281
1242
|
price?: MultiCurrencyPrice;
|
|
1282
1243
|
}
|
|
1283
|
-
|
|
1244
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1284
1245
|
/**
|
|
1285
|
-
* Visitor ID
|
|
1246
|
+
* Visitor ID - if the buyer is **not** a site member.
|
|
1286
1247
|
* @format GUID
|
|
1287
1248
|
* @readonly
|
|
1288
1249
|
*/
|
|
1289
1250
|
visitorId?: string;
|
|
1290
1251
|
/**
|
|
1291
|
-
* Member ID
|
|
1252
|
+
* Member ID - If the buyer is a site member.
|
|
1292
1253
|
* @format GUID
|
|
1293
1254
|
* @readonly
|
|
1294
1255
|
*/
|
|
1295
1256
|
memberId?: string;
|
|
1296
1257
|
/**
|
|
1297
|
-
* Contact ID.
|
|
1258
|
+
* Contact ID. For more information, see the Contacts API.
|
|
1298
1259
|
* @format GUID
|
|
1299
1260
|
* @readonly
|
|
1300
1261
|
*/
|
|
@@ -1306,21 +1267,21 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1306
1267
|
email?: string | null;
|
|
1307
1268
|
}
|
|
1308
1269
|
/** @oneof */
|
|
1309
|
-
|
|
1270
|
+
interface BuyerInfoIdOneOf {
|
|
1310
1271
|
/**
|
|
1311
|
-
* Visitor ID
|
|
1272
|
+
* Visitor ID - if the buyer is **not** a site member.
|
|
1312
1273
|
* @format GUID
|
|
1313
1274
|
* @readonly
|
|
1314
1275
|
*/
|
|
1315
1276
|
visitorId?: string;
|
|
1316
1277
|
/**
|
|
1317
|
-
* Member ID
|
|
1278
|
+
* Member ID - If the buyer is a site member.
|
|
1318
1279
|
* @format GUID
|
|
1319
1280
|
* @readonly
|
|
1320
1281
|
*/
|
|
1321
1282
|
memberId?: string;
|
|
1322
1283
|
}
|
|
1323
|
-
|
|
1284
|
+
interface PriceSummary {
|
|
1324
1285
|
/** Subtotal of all line items, before discounts and before tax. */
|
|
1325
1286
|
subtotal?: MultiCurrencyPrice;
|
|
1326
1287
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1334,7 +1295,7 @@ export interface PriceSummary {
|
|
|
1334
1295
|
/** Total additional fees price before tax. */
|
|
1335
1296
|
additionalFees?: MultiCurrencyPrice;
|
|
1336
1297
|
}
|
|
1337
|
-
|
|
1298
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1338
1299
|
/** General shipping calculation error. */
|
|
1339
1300
|
generalShippingCalculationError?: Details;
|
|
1340
1301
|
/** Carrier errors. */
|
|
@@ -1356,13 +1317,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
1356
1317
|
discountsCalculationError?: Details;
|
|
1357
1318
|
}
|
|
1358
1319
|
/** @oneof */
|
|
1359
|
-
|
|
1320
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1360
1321
|
/** General shipping calculation error. */
|
|
1361
1322
|
generalShippingCalculationError?: Details;
|
|
1362
1323
|
/** Carrier errors. */
|
|
1363
1324
|
carrierErrors?: CarrierErrors;
|
|
1364
1325
|
}
|
|
1365
|
-
|
|
1326
|
+
interface Details extends DetailsKindOneOf {
|
|
1366
1327
|
applicationError?: ApplicationError;
|
|
1367
1328
|
validationError?: ValidationError;
|
|
1368
1329
|
systemError?: SystemError;
|
|
@@ -1373,12 +1334,12 @@ export interface Details extends DetailsKindOneOf {
|
|
|
1373
1334
|
tracing?: Record<string, string>;
|
|
1374
1335
|
}
|
|
1375
1336
|
/** @oneof */
|
|
1376
|
-
|
|
1337
|
+
interface DetailsKindOneOf {
|
|
1377
1338
|
applicationError?: ApplicationError;
|
|
1378
1339
|
validationError?: ValidationError;
|
|
1379
1340
|
systemError?: SystemError;
|
|
1380
1341
|
}
|
|
1381
|
-
|
|
1342
|
+
interface ApplicationError {
|
|
1382
1343
|
/** Error code. */
|
|
1383
1344
|
code?: string;
|
|
1384
1345
|
/** Description of the error. */
|
|
@@ -1418,10 +1379,10 @@ export interface ApplicationError {
|
|
|
1418
1379
|
* ]
|
|
1419
1380
|
* }
|
|
1420
1381
|
*/
|
|
1421
|
-
|
|
1382
|
+
interface ValidationError {
|
|
1422
1383
|
fieldViolations?: FieldViolation[];
|
|
1423
1384
|
}
|
|
1424
|
-
|
|
1385
|
+
declare enum RuleType {
|
|
1425
1386
|
VALIDATION = "VALIDATION",
|
|
1426
1387
|
OTHER = "OTHER",
|
|
1427
1388
|
MAX = "MAX",
|
|
@@ -1444,7 +1405,7 @@ export declare enum RuleType {
|
|
|
1444
1405
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1445
1406
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1446
1407
|
}
|
|
1447
|
-
|
|
1408
|
+
interface FieldViolation {
|
|
1448
1409
|
field?: string;
|
|
1449
1410
|
description?: string;
|
|
1450
1411
|
violatedRule?: RuleType;
|
|
@@ -1452,26 +1413,26 @@ export interface FieldViolation {
|
|
|
1452
1413
|
ruleName?: string | null;
|
|
1453
1414
|
data?: Record<string, any> | null;
|
|
1454
1415
|
}
|
|
1455
|
-
|
|
1416
|
+
interface SystemError {
|
|
1456
1417
|
/** Error code. */
|
|
1457
1418
|
errorCode?: string | null;
|
|
1458
1419
|
}
|
|
1459
|
-
|
|
1420
|
+
interface CarrierErrors {
|
|
1460
1421
|
/** Carrier errors. */
|
|
1461
1422
|
errors?: CarrierError[];
|
|
1462
1423
|
}
|
|
1463
|
-
|
|
1424
|
+
interface CarrierError {
|
|
1464
1425
|
/** Carrier ID. */
|
|
1465
1426
|
carrierId?: string;
|
|
1466
1427
|
/** Error details. */
|
|
1467
1428
|
error?: Details;
|
|
1468
1429
|
}
|
|
1469
|
-
|
|
1430
|
+
interface GiftCard {
|
|
1470
1431
|
/**
|
|
1471
1432
|
* Gift Card ID.
|
|
1472
1433
|
* @deprecated
|
|
1473
1434
|
*/
|
|
1474
|
-
|
|
1435
|
+
_id?: string;
|
|
1475
1436
|
/** Gift card obfuscated code. */
|
|
1476
1437
|
obfuscatedCode?: string;
|
|
1477
1438
|
/** Gift card value. */
|
|
@@ -1489,7 +1450,7 @@ export interface GiftCard {
|
|
|
1489
1450
|
*/
|
|
1490
1451
|
externalId?: string | null;
|
|
1491
1452
|
}
|
|
1492
|
-
|
|
1453
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1493
1454
|
/** Coupon details. */
|
|
1494
1455
|
coupon?: Coupon;
|
|
1495
1456
|
/** Merchant discount. */
|
|
@@ -1499,7 +1460,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1499
1460
|
/** Discount type. */
|
|
1500
1461
|
discountType?: DiscountType;
|
|
1501
1462
|
/**
|
|
1502
|
-
* IDs of line items the discount applies to.
|
|
1463
|
+
* IDs of the line items the discount applies to.
|
|
1503
1464
|
* @format GUID
|
|
1504
1465
|
* @deprecated IDs of line items the discount applies to.
|
|
1505
1466
|
* @replacedBy line_items_discounts
|
|
@@ -1508,7 +1469,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1508
1469
|
lineItemIds?: string[];
|
|
1509
1470
|
}
|
|
1510
1471
|
/** @oneof */
|
|
1511
|
-
|
|
1472
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1512
1473
|
/** Coupon details. */
|
|
1513
1474
|
coupon?: Coupon;
|
|
1514
1475
|
/** Merchant discount. */
|
|
@@ -1516,15 +1477,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1516
1477
|
/** Discount rule */
|
|
1517
1478
|
discountRule?: DiscountRule;
|
|
1518
1479
|
}
|
|
1519
|
-
|
|
1480
|
+
declare enum DiscountType {
|
|
1520
1481
|
GLOBAL = "GLOBAL",
|
|
1521
1482
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1522
1483
|
SHIPPING = "SHIPPING"
|
|
1523
1484
|
}
|
|
1524
1485
|
/** Coupon */
|
|
1525
|
-
|
|
1486
|
+
interface Coupon {
|
|
1526
1487
|
/** Coupon ID. */
|
|
1527
|
-
|
|
1488
|
+
_id?: string;
|
|
1528
1489
|
/** Coupon code. */
|
|
1529
1490
|
code?: string;
|
|
1530
1491
|
/** Coupon value. */
|
|
@@ -1532,7 +1493,7 @@ export interface Coupon {
|
|
|
1532
1493
|
/** Coupon name. */
|
|
1533
1494
|
name?: string;
|
|
1534
1495
|
}
|
|
1535
|
-
|
|
1496
|
+
interface MerchantDiscount {
|
|
1536
1497
|
/** Discount value. */
|
|
1537
1498
|
amount?: MultiCurrencyPrice;
|
|
1538
1499
|
/**
|
|
@@ -1542,18 +1503,18 @@ export interface MerchantDiscount {
|
|
|
1542
1503
|
*/
|
|
1543
1504
|
percentage?: number | null;
|
|
1544
1505
|
}
|
|
1545
|
-
|
|
1506
|
+
interface DiscountRule {
|
|
1546
1507
|
/**
|
|
1547
1508
|
* Discount rule ID
|
|
1548
1509
|
* @format GUID
|
|
1549
1510
|
*/
|
|
1550
|
-
|
|
1511
|
+
_id?: string;
|
|
1551
1512
|
/** Discount rule name */
|
|
1552
1513
|
name?: DiscountRuleName;
|
|
1553
1514
|
/** Discount value. */
|
|
1554
1515
|
amount?: MultiCurrencyPrice;
|
|
1555
1516
|
}
|
|
1556
|
-
|
|
1517
|
+
interface DiscountRuleName {
|
|
1557
1518
|
/**
|
|
1558
1519
|
* Original discount rule name (in site's default language).
|
|
1559
1520
|
* @minLength 1
|
|
@@ -1567,16 +1528,16 @@ export interface DiscountRuleName {
|
|
|
1567
1528
|
*/
|
|
1568
1529
|
translated?: string | null;
|
|
1569
1530
|
}
|
|
1570
|
-
|
|
1531
|
+
interface LineItemDiscount {
|
|
1571
1532
|
/**
|
|
1572
1533
|
* ID of line item the discount applies to.
|
|
1573
1534
|
* @format GUID
|
|
1574
1535
|
*/
|
|
1575
|
-
|
|
1536
|
+
_id?: string;
|
|
1576
1537
|
/** Discount value. */
|
|
1577
1538
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
1578
1539
|
}
|
|
1579
|
-
|
|
1540
|
+
interface CustomField {
|
|
1580
1541
|
/** Custom field value. */
|
|
1581
1542
|
value?: any;
|
|
1582
1543
|
/**
|
|
@@ -1592,7 +1553,7 @@ export interface CustomField {
|
|
|
1592
1553
|
*/
|
|
1593
1554
|
translatedTitle?: string | null;
|
|
1594
1555
|
}
|
|
1595
|
-
|
|
1556
|
+
declare enum WeightUnit {
|
|
1596
1557
|
/** Weight unit can't be classified due to an error. */
|
|
1597
1558
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1598
1559
|
/** Kilograms. */
|
|
@@ -1600,7 +1561,7 @@ export declare enum WeightUnit {
|
|
|
1600
1561
|
/** Pounds. */
|
|
1601
1562
|
LB = "LB"
|
|
1602
1563
|
}
|
|
1603
|
-
|
|
1564
|
+
interface TaxSummary {
|
|
1604
1565
|
/**
|
|
1605
1566
|
* Amount for which tax is calculated, added from line items.
|
|
1606
1567
|
* @readonly
|
|
@@ -1617,7 +1578,7 @@ export interface TaxSummary {
|
|
|
1617
1578
|
*/
|
|
1618
1579
|
calculationDetails?: TaxCalculationDetails;
|
|
1619
1580
|
}
|
|
1620
|
-
|
|
1581
|
+
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1621
1582
|
/** Reason the manual calculation was used. */
|
|
1622
1583
|
manualRateReason?: ManualCalculationReason;
|
|
1623
1584
|
/** Details of the fallback rate calculation. */
|
|
@@ -1626,13 +1587,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
|
|
|
1626
1587
|
rateType?: RateType;
|
|
1627
1588
|
}
|
|
1628
1589
|
/** @oneof */
|
|
1629
|
-
|
|
1590
|
+
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1630
1591
|
/** Reason the manual calculation was used. */
|
|
1631
1592
|
manualRateReason?: ManualCalculationReason;
|
|
1632
1593
|
/** Details of the fallback rate calculation. */
|
|
1633
1594
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1634
1595
|
}
|
|
1635
|
-
|
|
1596
|
+
declare enum RateType {
|
|
1636
1597
|
/** no tax being collected for this request due to location of purchase */
|
|
1637
1598
|
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
1638
1599
|
/** manual rate used for calculation */
|
|
@@ -1642,19 +1603,19 @@ export declare enum RateType {
|
|
|
1642
1603
|
/** fallback rate used for calculation */
|
|
1643
1604
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1644
1605
|
}
|
|
1645
|
-
|
|
1606
|
+
declare enum ManualCalculationReason {
|
|
1646
1607
|
/** user set calculator in Business Manager to be Manual */
|
|
1647
1608
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1648
1609
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1649
1610
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1650
1611
|
}
|
|
1651
|
-
|
|
1612
|
+
interface AutoTaxFallbackCalculationDetails {
|
|
1652
1613
|
/** reason for fallback */
|
|
1653
1614
|
fallbackReason?: FallbackReason;
|
|
1654
1615
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1655
1616
|
error?: ApplicationError;
|
|
1656
1617
|
}
|
|
1657
|
-
|
|
1618
|
+
declare enum FallbackReason {
|
|
1658
1619
|
/** auto-tax failed to be calculated */
|
|
1659
1620
|
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
1660
1621
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
@@ -1664,7 +1625,7 @@ export declare enum FallbackReason {
|
|
|
1664
1625
|
* 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.
|
|
1665
1626
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1666
1627
|
*/
|
|
1667
|
-
|
|
1628
|
+
interface AggregatedTaxBreakdown {
|
|
1668
1629
|
/**
|
|
1669
1630
|
* The name of the tax against which this tax amount was calculated.
|
|
1670
1631
|
* @maxLength 200
|
|
@@ -1690,7 +1651,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
1690
1651
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1691
1652
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
1692
1653
|
}
|
|
1693
|
-
|
|
1654
|
+
declare enum ChannelType {
|
|
1694
1655
|
/** Unspecified sales channel. This value is not supported. */
|
|
1695
1656
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1696
1657
|
/** A web client. */
|
|
@@ -1724,7 +1685,7 @@ export declare enum ChannelType {
|
|
|
1724
1685
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1725
1686
|
FAIRE_COM = "FAIRE_COM"
|
|
1726
1687
|
}
|
|
1727
|
-
|
|
1688
|
+
interface CreatedBy extends CreatedByIdOneOf {
|
|
1728
1689
|
/**
|
|
1729
1690
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1730
1691
|
* For example, via POS (point of service).
|
|
@@ -1748,7 +1709,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
|
|
|
1748
1709
|
appId?: string;
|
|
1749
1710
|
}
|
|
1750
1711
|
/** @oneof */
|
|
1751
|
-
|
|
1712
|
+
interface CreatedByIdOneOf {
|
|
1752
1713
|
/**
|
|
1753
1714
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1754
1715
|
* For example, via POS (point of service).
|
|
@@ -1772,7 +1733,7 @@ export interface CreatedByIdOneOf {
|
|
|
1772
1733
|
appId?: string;
|
|
1773
1734
|
}
|
|
1774
1735
|
/** Reserved for internal use. */
|
|
1775
|
-
|
|
1736
|
+
interface MembershipOptions {
|
|
1776
1737
|
/**
|
|
1777
1738
|
* Reserved for internal use.
|
|
1778
1739
|
* @readonly
|
|
@@ -1788,13 +1749,13 @@ export interface MembershipOptions {
|
|
|
1788
1749
|
/** Selected membership to apply to this checkout. */
|
|
1789
1750
|
selectedMemberships?: SelectedMemberships;
|
|
1790
1751
|
}
|
|
1791
|
-
|
|
1752
|
+
interface Membership {
|
|
1792
1753
|
/**
|
|
1793
1754
|
* Membership ID.
|
|
1794
1755
|
* @minLength 1
|
|
1795
1756
|
* @maxLength 100
|
|
1796
1757
|
*/
|
|
1797
|
-
|
|
1758
|
+
_id?: string;
|
|
1798
1759
|
/**
|
|
1799
1760
|
* ID of the application providing this payment option.
|
|
1800
1761
|
* @format GUID
|
|
@@ -1803,7 +1764,7 @@ export interface Membership {
|
|
|
1803
1764
|
/** The name of this membership. */
|
|
1804
1765
|
name?: MembershipName;
|
|
1805
1766
|
/**
|
|
1806
|
-
* Line item IDs which are "paid
|
|
1767
|
+
* Line item IDs which are "paid for" by this membership.
|
|
1807
1768
|
* @minSize 1
|
|
1808
1769
|
* @maxSize 300
|
|
1809
1770
|
* @minLength 1
|
|
@@ -1817,7 +1778,7 @@ export interface Membership {
|
|
|
1817
1778
|
/** Additional data about this membership. */
|
|
1818
1779
|
additionalData?: Record<string, any> | null;
|
|
1819
1780
|
}
|
|
1820
|
-
|
|
1781
|
+
interface MembershipName {
|
|
1821
1782
|
/**
|
|
1822
1783
|
* Membership name.
|
|
1823
1784
|
* @maxLength 100
|
|
@@ -1829,7 +1790,7 @@ export interface MembershipName {
|
|
|
1829
1790
|
*/
|
|
1830
1791
|
translated?: string | null;
|
|
1831
1792
|
}
|
|
1832
|
-
|
|
1793
|
+
interface MembershipPaymentCredits {
|
|
1833
1794
|
/**
|
|
1834
1795
|
* Membership's total amount of credits.
|
|
1835
1796
|
* @min 1
|
|
@@ -1838,7 +1799,7 @@ export interface MembershipPaymentCredits {
|
|
|
1838
1799
|
/** Membership's remaining amount of credits. */
|
|
1839
1800
|
remaining?: number;
|
|
1840
1801
|
}
|
|
1841
|
-
|
|
1802
|
+
interface InvalidMembership {
|
|
1842
1803
|
/** Membership details. */
|
|
1843
1804
|
membership?: Membership;
|
|
1844
1805
|
/**
|
|
@@ -1848,20 +1809,20 @@ export interface InvalidMembership {
|
|
|
1848
1809
|
*/
|
|
1849
1810
|
reason?: string;
|
|
1850
1811
|
}
|
|
1851
|
-
|
|
1812
|
+
interface SelectedMemberships {
|
|
1852
1813
|
/**
|
|
1853
1814
|
* Selected memberships.
|
|
1854
1815
|
* @maxSize 300
|
|
1855
1816
|
*/
|
|
1856
1817
|
memberships?: SelectedMembership[];
|
|
1857
1818
|
}
|
|
1858
|
-
|
|
1819
|
+
interface SelectedMembership {
|
|
1859
1820
|
/**
|
|
1860
1821
|
* Membership ID.
|
|
1861
1822
|
* @minLength 1
|
|
1862
1823
|
* @maxLength 100
|
|
1863
1824
|
*/
|
|
1864
|
-
|
|
1825
|
+
_id?: string;
|
|
1865
1826
|
/**
|
|
1866
1827
|
* ID of the app providing this payment option.
|
|
1867
1828
|
* @format GUID
|
|
@@ -1876,7 +1837,7 @@ export interface SelectedMembership {
|
|
|
1876
1837
|
*/
|
|
1877
1838
|
lineItemIds?: string[];
|
|
1878
1839
|
}
|
|
1879
|
-
|
|
1840
|
+
interface AdditionalFee {
|
|
1880
1841
|
/**
|
|
1881
1842
|
* Additional fee's unique code (or ID) for future processing.
|
|
1882
1843
|
* @minLength 1
|
|
@@ -1912,7 +1873,7 @@ export interface AdditionalFee {
|
|
|
1912
1873
|
/** the source the additional fee was added from */
|
|
1913
1874
|
source?: AdditionalFeeSource;
|
|
1914
1875
|
}
|
|
1915
|
-
|
|
1876
|
+
declare enum AdditionalFeeSource {
|
|
1916
1877
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
1917
1878
|
/** The additional fee was added by an additional fee service plugin */
|
|
1918
1879
|
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
@@ -1921,7 +1882,7 @@ export declare enum AdditionalFeeSource {
|
|
|
1921
1882
|
/** The additional fee was added manually on the request */
|
|
1922
1883
|
MANUAL = "MANUAL"
|
|
1923
1884
|
}
|
|
1924
|
-
|
|
1885
|
+
interface ConversionInfo {
|
|
1925
1886
|
/**
|
|
1926
1887
|
* The site currency.
|
|
1927
1888
|
* @readonly
|
|
@@ -1935,7 +1896,7 @@ export interface ConversionInfo {
|
|
|
1935
1896
|
*/
|
|
1936
1897
|
conversionRate?: string;
|
|
1937
1898
|
}
|
|
1938
|
-
|
|
1899
|
+
interface Violation {
|
|
1939
1900
|
/** 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. */
|
|
1940
1901
|
severity?: Severity;
|
|
1941
1902
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
@@ -1947,7 +1908,7 @@ export interface Violation {
|
|
|
1947
1908
|
*/
|
|
1948
1909
|
description?: string | null;
|
|
1949
1910
|
}
|
|
1950
|
-
|
|
1911
|
+
declare enum Severity {
|
|
1951
1912
|
/** The user is allowed to move forward in the flow. */
|
|
1952
1913
|
WARNING = "WARNING",
|
|
1953
1914
|
/**
|
|
@@ -1956,48 +1917,48 @@ export declare enum Severity {
|
|
|
1956
1917
|
*/
|
|
1957
1918
|
ERROR = "ERROR"
|
|
1958
1919
|
}
|
|
1959
|
-
|
|
1920
|
+
interface Target extends TargetTargetTypeOneOf {
|
|
1960
1921
|
/** General (other) violation. */
|
|
1961
1922
|
other?: Other;
|
|
1962
1923
|
/** Specific line item violation. */
|
|
1963
1924
|
lineItem?: TargetLineItem;
|
|
1964
1925
|
}
|
|
1965
1926
|
/** @oneof */
|
|
1966
|
-
|
|
1927
|
+
interface TargetTargetTypeOneOf {
|
|
1967
1928
|
/** General (other) violation. */
|
|
1968
1929
|
other?: Other;
|
|
1969
1930
|
/** Specific line item violation. */
|
|
1970
1931
|
lineItem?: TargetLineItem;
|
|
1971
1932
|
}
|
|
1972
1933
|
/** Available locations on the webpage */
|
|
1973
|
-
|
|
1934
|
+
declare enum NameInOther {
|
|
1974
1935
|
/** Default location, in case no specific location is specified. */
|
|
1975
1936
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
1976
1937
|
}
|
|
1977
1938
|
/** Available locations on the line item */
|
|
1978
|
-
|
|
1939
|
+
declare enum NameInLineItem {
|
|
1979
1940
|
/** Default location, in case no specific location is specified. */
|
|
1980
1941
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
1981
1942
|
}
|
|
1982
|
-
|
|
1943
|
+
declare enum SuggestedFix {
|
|
1983
1944
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
1984
1945
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
1985
1946
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
1986
1947
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
1987
1948
|
}
|
|
1988
1949
|
/** General (other) violation. */
|
|
1989
|
-
|
|
1950
|
+
interface Other {
|
|
1990
1951
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
1991
1952
|
name?: NameInOther;
|
|
1992
1953
|
}
|
|
1993
1954
|
/** Specific line item violation. */
|
|
1994
|
-
|
|
1955
|
+
interface TargetLineItem {
|
|
1995
1956
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
1996
1957
|
name?: NameInLineItem;
|
|
1997
1958
|
/** ID of the line item containing the violation. */
|
|
1998
|
-
|
|
1959
|
+
_id?: string | null;
|
|
1999
1960
|
}
|
|
2000
|
-
|
|
1961
|
+
interface CustomSettings {
|
|
2001
1962
|
/**
|
|
2002
1963
|
* Whether to restrict the option to add or remove a gift card on the checkout page.
|
|
2003
1964
|
*
|
|
@@ -2023,7 +1984,7 @@ export interface CustomSettings {
|
|
|
2023
1984
|
*/
|
|
2024
1985
|
disabledManualPayment?: boolean;
|
|
2025
1986
|
}
|
|
2026
|
-
|
|
1987
|
+
interface CustomContentReference {
|
|
2027
1988
|
/**
|
|
2028
1989
|
* ID of the app providing the content.
|
|
2029
1990
|
*
|
|
@@ -2039,7 +2000,7 @@ export interface CustomContentReference {
|
|
|
2039
2000
|
*/
|
|
2040
2001
|
componentId?: string;
|
|
2041
2002
|
}
|
|
2042
|
-
|
|
2003
|
+
interface ExternalReference {
|
|
2043
2004
|
/**
|
|
2044
2005
|
* ID of the app associated with the purchase flow.
|
|
2045
2006
|
* For example, the Wix Pay Links app ID.
|
|
@@ -2056,7 +2017,7 @@ export interface ExternalReference {
|
|
|
2056
2017
|
*/
|
|
2057
2018
|
resourceId?: string | null;
|
|
2058
2019
|
}
|
|
2059
|
-
|
|
2020
|
+
interface SubscriptionCharges {
|
|
2060
2021
|
/**
|
|
2061
2022
|
* ids of the items the subscription is defined on
|
|
2062
2023
|
* @format GUID
|
|
@@ -2076,7 +2037,7 @@ export interface SubscriptionCharges {
|
|
|
2076
2037
|
*/
|
|
2077
2038
|
charges?: Charge[];
|
|
2078
2039
|
}
|
|
2079
|
-
|
|
2040
|
+
interface Charge {
|
|
2080
2041
|
/** The cycle number from which the charge starts. */
|
|
2081
2042
|
cycleFrom?: number;
|
|
2082
2043
|
/** The number of cycles for which the charge is applicable. */
|
|
@@ -2086,16 +2047,16 @@ export interface Charge {
|
|
|
2086
2047
|
/** The billing date from which the charge starts. */
|
|
2087
2048
|
cycleBillingDate?: Date | null;
|
|
2088
2049
|
}
|
|
2089
|
-
|
|
2050
|
+
interface UpdatedCheckoutMessage {
|
|
2090
2051
|
/** Previous checkout. */
|
|
2091
2052
|
oldCheckout?: Checkout;
|
|
2092
2053
|
/** Updated checkout. */
|
|
2093
2054
|
updatedCheckout?: Checkout;
|
|
2094
2055
|
}
|
|
2095
|
-
|
|
2056
|
+
interface CreateCheckoutRequest {
|
|
2096
2057
|
/** Checkout information. */
|
|
2097
2058
|
checkoutInfo?: Checkout;
|
|
2098
|
-
/**
|
|
2059
|
+
/** 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). */
|
|
2099
2060
|
couponCode?: string | null;
|
|
2100
2061
|
/**
|
|
2101
2062
|
* Catalog line items to add to the checkout.
|
|
@@ -2123,14 +2084,12 @@ export interface CreateCheckoutRequest {
|
|
|
2123
2084
|
/**
|
|
2124
2085
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2125
2086
|
*
|
|
2126
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used
|
|
2127
|
-
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2128
|
-
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2087
|
+
* 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`.
|
|
2129
2088
|
* @maxLength 1000
|
|
2130
2089
|
*/
|
|
2131
2090
|
overrideCheckoutUrl?: string | null;
|
|
2132
2091
|
}
|
|
2133
|
-
|
|
2092
|
+
interface CustomLineItem {
|
|
2134
2093
|
/**
|
|
2135
2094
|
* Custom line item quantity.
|
|
2136
2095
|
*
|
|
@@ -2141,9 +2100,7 @@ export interface CustomLineItem {
|
|
|
2141
2100
|
*/
|
|
2142
2101
|
quantity?: number;
|
|
2143
2102
|
/**
|
|
2144
|
-
* Custom line item price.
|
|
2145
|
-
*
|
|
2146
|
-
* Must be a number or a decimal without symbols.
|
|
2103
|
+
* Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend.
|
|
2147
2104
|
* @format DECIMAL_VALUE
|
|
2148
2105
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
2149
2106
|
*/
|
|
@@ -2151,19 +2108,23 @@ export interface CustomLineItem {
|
|
|
2151
2108
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
2152
2109
|
priceDescription?: PriceDescription;
|
|
2153
2110
|
/**
|
|
2154
|
-
* Custom line item description lines. Used for
|
|
2111
|
+
* Custom line item description lines. Used for displaying the cart, checkout and order.
|
|
2155
2112
|
* @maxSize 10
|
|
2156
2113
|
*/
|
|
2157
2114
|
descriptionLines?: DescriptionLine[];
|
|
2158
|
-
/**
|
|
2159
|
-
|
|
2115
|
+
/**
|
|
2116
|
+
* Custom line item media.
|
|
2117
|
+
* + 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"`.
|
|
2118
|
+
* + An image from the web - `"http(s)://<image url>"`.
|
|
2119
|
+
*/
|
|
2120
|
+
media?: string;
|
|
2160
2121
|
/**
|
|
2161
2122
|
* Custom line item ID. If passed, `id` must be unique.
|
|
2162
2123
|
*
|
|
2163
2124
|
* Default: auto-generated ID
|
|
2164
2125
|
* @format GUID
|
|
2165
2126
|
*/
|
|
2166
|
-
|
|
2127
|
+
_id?: string | null;
|
|
2167
2128
|
/**
|
|
2168
2129
|
* Tax group ID for this custom line item.
|
|
2169
2130
|
* @format GUID
|
|
@@ -2172,7 +2133,7 @@ export interface CustomLineItem {
|
|
|
2172
2133
|
/** Name of the item or product. */
|
|
2173
2134
|
productName?: ProductName;
|
|
2174
2135
|
/** 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. */
|
|
2175
|
-
url?:
|
|
2136
|
+
url?: string;
|
|
2176
2137
|
/** Item type. Either a preset type or custom. */
|
|
2177
2138
|
itemType?: ItemType;
|
|
2178
2139
|
/**
|
|
@@ -2242,104 +2203,98 @@ export interface CustomLineItem {
|
|
|
2242
2203
|
*/
|
|
2243
2204
|
savePaymentMethod?: boolean;
|
|
2244
2205
|
}
|
|
2245
|
-
|
|
2206
|
+
interface MerchantDiscountInput {
|
|
2246
2207
|
/**
|
|
2247
2208
|
* Discount amount.
|
|
2248
2209
|
* @decimalValue options { gte:0 }
|
|
2249
2210
|
*/
|
|
2250
2211
|
amount?: string;
|
|
2251
2212
|
/**
|
|
2252
|
-
* IDs of line items the discount applies to.
|
|
2213
|
+
* IDs of the line items the discount applies to.
|
|
2253
2214
|
* @format GUID
|
|
2254
2215
|
* @maxSize 300
|
|
2255
2216
|
*/
|
|
2256
2217
|
lineItemIds?: string[];
|
|
2257
2218
|
}
|
|
2258
|
-
|
|
2219
|
+
interface CreateCheckoutResponse {
|
|
2259
2220
|
/** Newly created checkout. */
|
|
2260
2221
|
checkout?: Checkout;
|
|
2261
2222
|
}
|
|
2262
|
-
|
|
2223
|
+
interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2263
2224
|
generalShippingCalculationError?: Details;
|
|
2264
2225
|
carrierErrors?: CarrierErrors;
|
|
2265
2226
|
}
|
|
2266
2227
|
/** @oneof */
|
|
2267
|
-
|
|
2228
|
+
interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2268
2229
|
generalShippingCalculationError?: Details;
|
|
2269
2230
|
carrierErrors?: CarrierErrors;
|
|
2270
2231
|
}
|
|
2271
|
-
|
|
2232
|
+
interface GetCheckoutRequest {
|
|
2272
2233
|
/**
|
|
2273
2234
|
* Checkout ID.
|
|
2274
2235
|
* @format GUID
|
|
2275
2236
|
*/
|
|
2276
|
-
|
|
2237
|
+
_id: string;
|
|
2277
2238
|
}
|
|
2278
|
-
|
|
2239
|
+
interface GetCheckoutResponse {
|
|
2279
2240
|
/** Retrieved checkout. */
|
|
2280
2241
|
checkout?: Checkout;
|
|
2281
2242
|
}
|
|
2282
|
-
|
|
2243
|
+
interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
2283
2244
|
/**
|
|
2284
2245
|
* Checkout ID.
|
|
2285
2246
|
* @format GUID
|
|
2286
2247
|
*/
|
|
2287
|
-
|
|
2248
|
+
_id?: string;
|
|
2288
2249
|
}
|
|
2289
|
-
|
|
2250
|
+
interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2290
2251
|
/** Retrieved checkout. */
|
|
2291
2252
|
checkout?: Checkout;
|
|
2292
2253
|
}
|
|
2293
|
-
|
|
2254
|
+
interface GetCheckoutByCartIdRequest {
|
|
2294
2255
|
/**
|
|
2295
2256
|
* Cart ID.
|
|
2296
2257
|
* @format GUID
|
|
2297
2258
|
*/
|
|
2298
|
-
|
|
2259
|
+
_id: string;
|
|
2299
2260
|
}
|
|
2300
|
-
|
|
2261
|
+
interface GetCheckoutByCartIdResponse {
|
|
2301
2262
|
/** Retrieved checkout. */
|
|
2302
2263
|
checkout?: Checkout;
|
|
2303
2264
|
}
|
|
2304
|
-
|
|
2265
|
+
interface GetWixCheckoutURLRequest {
|
|
2305
2266
|
/**
|
|
2306
2267
|
* Checkout ID.
|
|
2307
2268
|
* @format GUID
|
|
2308
2269
|
*/
|
|
2309
|
-
|
|
2270
|
+
_id: string;
|
|
2310
2271
|
}
|
|
2311
|
-
|
|
2272
|
+
interface GetWixCheckoutURLResponse {
|
|
2312
2273
|
/** Checkout URL. */
|
|
2313
2274
|
checkoutUrl?: string;
|
|
2314
2275
|
}
|
|
2315
|
-
|
|
2276
|
+
interface GetCheckoutURLRequest {
|
|
2316
2277
|
/**
|
|
2317
2278
|
* Checkout ID.
|
|
2318
2279
|
* @format GUID
|
|
2319
2280
|
*/
|
|
2320
|
-
|
|
2281
|
+
_id: string;
|
|
2321
2282
|
}
|
|
2322
|
-
|
|
2283
|
+
interface GetCheckoutURLResponse {
|
|
2323
2284
|
/** Checkout URL. */
|
|
2324
2285
|
checkoutUrl?: string;
|
|
2325
2286
|
}
|
|
2326
|
-
|
|
2287
|
+
interface UpdateCheckoutRequest {
|
|
2327
2288
|
/** Checkout information. */
|
|
2328
2289
|
checkout: Checkout;
|
|
2329
|
-
/**
|
|
2330
|
-
* Coupon code.
|
|
2331
|
-
*
|
|
2332
|
-
* The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
|
|
2333
|
-
*/
|
|
2290
|
+
/** 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). */
|
|
2334
2291
|
couponCode?: string | null;
|
|
2335
2292
|
/** Gift card code. */
|
|
2336
2293
|
giftCardCode?: string | null;
|
|
2337
2294
|
/**
|
|
2338
2295
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2339
2296
|
*
|
|
2340
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used
|
|
2341
|
-
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2342
|
-
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2297
|
+
* 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`.
|
|
2343
2298
|
* @maxLength 1000
|
|
2344
2299
|
*/
|
|
2345
2300
|
overrideCheckoutUrl?: string | null;
|
|
@@ -2357,49 +2312,49 @@ export interface UpdateCheckoutRequest {
|
|
|
2357
2312
|
*/
|
|
2358
2313
|
customLineItems?: CustomLineItem[];
|
|
2359
2314
|
}
|
|
2360
|
-
|
|
2315
|
+
interface UpdateCheckoutResponse {
|
|
2361
2316
|
/** Updated checkout. */
|
|
2362
2317
|
checkout?: Checkout;
|
|
2363
2318
|
}
|
|
2364
|
-
|
|
2319
|
+
interface RemoveCouponRequest {
|
|
2365
2320
|
/**
|
|
2366
2321
|
* ID of the checkout to remove the coupon from.
|
|
2367
2322
|
* @format GUID
|
|
2368
2323
|
*/
|
|
2369
|
-
|
|
2324
|
+
_id: string;
|
|
2370
2325
|
}
|
|
2371
|
-
|
|
2326
|
+
interface RemoveCouponResponse {
|
|
2372
2327
|
/** Updated checkout after removal of coupon. */
|
|
2373
2328
|
checkout?: Checkout;
|
|
2374
2329
|
}
|
|
2375
|
-
|
|
2330
|
+
interface RemoveGiftCardRequest {
|
|
2376
2331
|
/**
|
|
2377
2332
|
* ID of the checkout to remove the gift card from.
|
|
2378
2333
|
* @format GUID
|
|
2379
2334
|
*/
|
|
2380
|
-
|
|
2335
|
+
_id: string;
|
|
2381
2336
|
}
|
|
2382
|
-
|
|
2337
|
+
interface RemoveGiftCardResponse {
|
|
2383
2338
|
/** Updated checkout after removal of gift card. */
|
|
2384
2339
|
checkout?: Checkout;
|
|
2385
2340
|
}
|
|
2386
|
-
|
|
2341
|
+
interface RemoveOverrideCheckoutUrlRequest {
|
|
2387
2342
|
/**
|
|
2388
2343
|
* ID of the checkout to remove the override checkout url from.
|
|
2389
2344
|
* @format GUID
|
|
2390
2345
|
*/
|
|
2391
|
-
|
|
2346
|
+
_id: string;
|
|
2392
2347
|
}
|
|
2393
|
-
|
|
2348
|
+
interface RemoveOverrideCheckoutUrlResponse {
|
|
2394
2349
|
/** Updated checkout after removal of override checkout url. */
|
|
2395
2350
|
checkout?: Checkout;
|
|
2396
2351
|
}
|
|
2397
|
-
|
|
2352
|
+
interface AddToCheckoutRequest {
|
|
2398
2353
|
/**
|
|
2399
2354
|
* Checkout ID.
|
|
2400
2355
|
* @format GUID
|
|
2401
2356
|
*/
|
|
2402
|
-
|
|
2357
|
+
_id: string;
|
|
2403
2358
|
/**
|
|
2404
2359
|
* Catalog line items.
|
|
2405
2360
|
* @maxSize 100
|
|
@@ -2414,46 +2369,42 @@ export interface AddToCheckoutRequest {
|
|
|
2414
2369
|
*/
|
|
2415
2370
|
customLineItems?: CustomLineItem[];
|
|
2416
2371
|
}
|
|
2417
|
-
|
|
2372
|
+
interface AddToCheckoutResponse {
|
|
2418
2373
|
/** Updated checkout. */
|
|
2419
2374
|
checkout?: Checkout;
|
|
2420
2375
|
}
|
|
2421
|
-
|
|
2376
|
+
interface RemoveLineItemsRequest {
|
|
2422
2377
|
/**
|
|
2423
2378
|
* ID of the checkout to remove line items from.
|
|
2424
2379
|
* @format GUID
|
|
2425
2380
|
*/
|
|
2426
|
-
|
|
2381
|
+
_id: string;
|
|
2427
2382
|
/**
|
|
2428
2383
|
* IDs of the line items to remove from the checkout.
|
|
2429
|
-
*
|
|
2430
|
-
* To find the IDs of the checkout line items you'd like to remove,
|
|
2431
|
-
* pass the checkout ID to Get Checkout and look for the IDs under
|
|
2432
|
-
* `lineItems`.
|
|
2433
2384
|
* @format GUID
|
|
2434
2385
|
* @minSize 1
|
|
2435
2386
|
* @maxSize 300
|
|
2436
2387
|
*/
|
|
2437
2388
|
lineItemIds: string[];
|
|
2438
2389
|
}
|
|
2439
|
-
|
|
2390
|
+
interface RemoveLineItemsResponse {
|
|
2440
2391
|
/** Updated checkout after removal of line items. */
|
|
2441
2392
|
checkout?: Checkout;
|
|
2442
2393
|
}
|
|
2443
|
-
|
|
2394
|
+
interface CreateOrderRequest {
|
|
2444
2395
|
/**
|
|
2445
2396
|
* Checkout ID.
|
|
2446
2397
|
* @format GUID
|
|
2447
2398
|
*/
|
|
2448
|
-
|
|
2399
|
+
_id: string;
|
|
2449
2400
|
/** Whether the payment method should be saved on the order. */
|
|
2450
2401
|
savePaymentMethod?: boolean;
|
|
2451
2402
|
/** Whether to authorize the payment and delay the capture. */
|
|
2452
2403
|
delayCapture?: boolean;
|
|
2453
2404
|
}
|
|
2454
|
-
|
|
2405
|
+
interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
2455
2406
|
/**
|
|
2456
|
-
* ID of newly created order.
|
|
2407
|
+
* ID of the newly created order.
|
|
2457
2408
|
* @format GUID
|
|
2458
2409
|
*/
|
|
2459
2410
|
orderId?: string;
|
|
@@ -2466,16 +2417,15 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
|
2466
2417
|
* Payment gateway order ID.
|
|
2467
2418
|
*
|
|
2468
2419
|
* 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.
|
|
2469
|
-
* `paymentGatewayOrderId` will be returned if money needs to be charged.
|
|
2470
2420
|
*
|
|
2471
|
-
* In some cases, money cannot be charged:
|
|
2472
|
-
* + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is
|
|
2473
|
-
* + If the total price is not
|
|
2421
|
+
* This field will be returned if money needs to be charged. In some cases, money cannot be charged:
|
|
2422
|
+
* + 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.
|
|
2423
|
+
* + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
|
|
2474
2424
|
*/
|
|
2475
2425
|
paymentGatewayOrderId?: string | null;
|
|
2476
2426
|
}
|
|
2477
2427
|
/** @oneof */
|
|
2478
|
-
|
|
2428
|
+
interface CreateOrderResponseIdOneOf {
|
|
2479
2429
|
/**
|
|
2480
2430
|
* ID of newly created order.
|
|
2481
2431
|
* @format GUID
|
|
@@ -2487,37 +2437,37 @@ export interface CreateOrderResponseIdOneOf {
|
|
|
2487
2437
|
*/
|
|
2488
2438
|
subscriptionId?: string;
|
|
2489
2439
|
}
|
|
2490
|
-
|
|
2440
|
+
interface PaymentErrorResponseData {
|
|
2491
2441
|
paymentResponseToken?: string | null;
|
|
2492
2442
|
transactionStatus?: string;
|
|
2493
2443
|
failureDetails?: string | null;
|
|
2494
2444
|
}
|
|
2495
|
-
|
|
2445
|
+
interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
|
|
2496
2446
|
/** @format GUID */
|
|
2497
2447
|
orderId?: string;
|
|
2498
2448
|
/** @format GUID */
|
|
2499
2449
|
subscriptionId?: string;
|
|
2500
2450
|
}
|
|
2501
2451
|
/** @oneof */
|
|
2502
|
-
|
|
2452
|
+
interface DoublePaymentErrorDataIdOneOf {
|
|
2503
2453
|
/** @format GUID */
|
|
2504
2454
|
orderId?: string;
|
|
2505
2455
|
/** @format GUID */
|
|
2506
2456
|
subscriptionId?: string;
|
|
2507
2457
|
}
|
|
2508
|
-
|
|
2458
|
+
interface RedeemErrorData {
|
|
2509
2459
|
reason?: string;
|
|
2510
2460
|
}
|
|
2511
|
-
|
|
2461
|
+
interface ViolationsList {
|
|
2512
2462
|
/** Violations risen by ValidationsSPI implementers. */
|
|
2513
2463
|
violations?: Violation[];
|
|
2514
2464
|
}
|
|
2515
|
-
|
|
2465
|
+
interface CreateOrderAndChargeRequest {
|
|
2516
2466
|
/**
|
|
2517
2467
|
* Checkout ID.
|
|
2518
2468
|
* @format GUID
|
|
2519
2469
|
*/
|
|
2520
|
-
|
|
2470
|
+
_id: string;
|
|
2521
2471
|
/** Payment token. */
|
|
2522
2472
|
paymentToken?: string | null;
|
|
2523
2473
|
/** Whether the payment method should be saved on the order. */
|
|
@@ -2525,7 +2475,7 @@ export interface CreateOrderAndChargeRequest {
|
|
|
2525
2475
|
/** Whether to authorize the payment and delay the capture. */
|
|
2526
2476
|
delayCapture?: boolean;
|
|
2527
2477
|
}
|
|
2528
|
-
|
|
2478
|
+
interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
2529
2479
|
/**
|
|
2530
2480
|
* ID of newly created order.
|
|
2531
2481
|
* @format GUID
|
|
@@ -2539,16 +2489,17 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
|
|
|
2539
2489
|
/** Payment response token. */
|
|
2540
2490
|
paymentResponseToken?: string | null;
|
|
2541
2491
|
/**
|
|
2542
|
-
*
|
|
2543
|
-
*
|
|
2544
|
-
*
|
|
2545
|
-
*
|
|
2546
|
-
* If the total price is
|
|
2492
|
+
* For online orders, send this value as a parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay/startpayment) function to enable your buyer to pay for the order.
|
|
2493
|
+
* `paymentGatewayOrderId` will be returned if money needs to be charged.
|
|
2494
|
+
*
|
|
2495
|
+
* In some cases, money should not be charged:
|
|
2496
|
+
* + If the total price is 0. For example, in the case of a free item or an item with 100% discount.
|
|
2497
|
+
* + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
|
|
2547
2498
|
*/
|
|
2548
2499
|
paymentGatewayOrderId?: string | null;
|
|
2549
2500
|
}
|
|
2550
2501
|
/** @oneof */
|
|
2551
|
-
|
|
2502
|
+
interface CreateOrderAndChargeResponseIdOneOf {
|
|
2552
2503
|
/**
|
|
2553
2504
|
* ID of newly created order.
|
|
2554
2505
|
* @format GUID
|
|
@@ -2560,41 +2511,41 @@ export interface CreateOrderAndChargeResponseIdOneOf {
|
|
|
2560
2511
|
*/
|
|
2561
2512
|
subscriptionId?: string;
|
|
2562
2513
|
}
|
|
2563
|
-
|
|
2514
|
+
interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
|
|
2564
2515
|
/**
|
|
2565
2516
|
* Server-signed JWT token with required information to complete checkout
|
|
2566
2517
|
* @maxLength 4096
|
|
2567
2518
|
*/
|
|
2568
2519
|
token: string;
|
|
2569
2520
|
}
|
|
2570
|
-
|
|
2521
|
+
interface RawHttpResponse {
|
|
2571
2522
|
body?: Uint8Array;
|
|
2572
2523
|
statusCode?: number | null;
|
|
2573
2524
|
headers?: HeadersEntry[];
|
|
2574
2525
|
}
|
|
2575
|
-
|
|
2526
|
+
interface HeadersEntry {
|
|
2576
2527
|
key?: string;
|
|
2577
2528
|
value?: string;
|
|
2578
2529
|
}
|
|
2579
|
-
|
|
2530
|
+
interface MarkCheckoutAsCompletedRequest {
|
|
2580
2531
|
/**
|
|
2581
2532
|
* Checkout ID.
|
|
2582
2533
|
* @format GUID
|
|
2583
2534
|
*/
|
|
2584
|
-
|
|
2535
|
+
_id: string;
|
|
2585
2536
|
}
|
|
2586
|
-
|
|
2537
|
+
interface MarkCheckoutAsCompletedResponse {
|
|
2587
2538
|
}
|
|
2588
2539
|
/** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
|
|
2589
|
-
|
|
2540
|
+
interface CheckoutMarkedAsCompleted {
|
|
2590
2541
|
checkout?: Checkout;
|
|
2591
2542
|
}
|
|
2592
|
-
|
|
2543
|
+
interface UpdateLineItemsQuantityRequest {
|
|
2593
2544
|
/**
|
|
2594
2545
|
* Checkout ID.
|
|
2595
2546
|
* @format GUID
|
|
2596
2547
|
*/
|
|
2597
|
-
|
|
2548
|
+
_id: string;
|
|
2598
2549
|
/**
|
|
2599
2550
|
* Line item info to update.
|
|
2600
2551
|
* @minSize 1
|
|
@@ -2602,12 +2553,12 @@ export interface UpdateLineItemsQuantityRequest {
|
|
|
2602
2553
|
*/
|
|
2603
2554
|
lineItems: LineItemQuantityUpdate[];
|
|
2604
2555
|
}
|
|
2605
|
-
|
|
2556
|
+
interface LineItemQuantityUpdate {
|
|
2606
2557
|
/**
|
|
2607
2558
|
* ID of the line item to update.
|
|
2608
2559
|
* @format GUID
|
|
2609
2560
|
*/
|
|
2610
|
-
|
|
2561
|
+
_id?: string;
|
|
2611
2562
|
/**
|
|
2612
2563
|
* New total amount of the line item,
|
|
2613
2564
|
* not the amount to add to the current `quantity`.
|
|
@@ -2620,42 +2571,42 @@ export interface LineItemQuantityUpdate {
|
|
|
2620
2571
|
*/
|
|
2621
2572
|
quantity?: number;
|
|
2622
2573
|
}
|
|
2623
|
-
|
|
2574
|
+
interface UpdateLineItemsQuantityResponse {
|
|
2624
2575
|
/** Updated checkout. */
|
|
2625
2576
|
checkout?: Checkout;
|
|
2626
2577
|
}
|
|
2627
|
-
|
|
2578
|
+
interface GetCheckoutPaymentSettingsRequest {
|
|
2628
2579
|
/**
|
|
2629
2580
|
* Checkout ID.
|
|
2630
2581
|
* @format GUID
|
|
2631
2582
|
*/
|
|
2632
|
-
|
|
2583
|
+
_id: string;
|
|
2633
2584
|
}
|
|
2634
|
-
|
|
2585
|
+
interface GetCheckoutPaymentSettingsResponse {
|
|
2635
2586
|
blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOption[];
|
|
2636
2587
|
}
|
|
2637
|
-
|
|
2588
|
+
declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2638
2589
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
2639
2590
|
MANUAL = "MANUAL"
|
|
2640
2591
|
}
|
|
2641
|
-
|
|
2592
|
+
interface DeleteCheckoutRequest {
|
|
2642
2593
|
/**
|
|
2643
2594
|
* ID of the checkout to delete.
|
|
2644
2595
|
* @format GUID
|
|
2645
2596
|
*/
|
|
2646
|
-
|
|
2597
|
+
_id?: string;
|
|
2647
2598
|
}
|
|
2648
|
-
|
|
2599
|
+
interface DeleteCheckoutResponse {
|
|
2649
2600
|
}
|
|
2650
|
-
|
|
2601
|
+
interface SubscriptionCreated {
|
|
2651
2602
|
subscription?: Subscription;
|
|
2652
2603
|
}
|
|
2653
|
-
|
|
2604
|
+
interface Subscription {
|
|
2654
2605
|
/**
|
|
2655
2606
|
* Subscription id (auto-generated upon subscription creation)
|
|
2656
2607
|
* @readonly
|
|
2657
2608
|
*/
|
|
2658
|
-
|
|
2609
|
+
_id?: string;
|
|
2659
2610
|
/**
|
|
2660
2611
|
* id of subscription in external system
|
|
2661
2612
|
* @format GUID
|
|
@@ -2714,23 +2665,23 @@ export interface Subscription {
|
|
|
2714
2665
|
billingInfo?: BillingInfo;
|
|
2715
2666
|
}
|
|
2716
2667
|
/** Buyer Info */
|
|
2717
|
-
|
|
2668
|
+
interface V1BuyerInfo {
|
|
2718
2669
|
/**
|
|
2719
2670
|
* Wix customer ID
|
|
2720
2671
|
* @format GUID
|
|
2721
2672
|
*/
|
|
2722
|
-
|
|
2673
|
+
_id?: string;
|
|
2723
2674
|
/** Customer type */
|
|
2724
2675
|
identityType?: IdentityType;
|
|
2725
2676
|
}
|
|
2726
|
-
|
|
2677
|
+
declare enum IdentityType {
|
|
2727
2678
|
UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
|
|
2728
2679
|
/** Site member */
|
|
2729
2680
|
MEMBER = "MEMBER",
|
|
2730
2681
|
/** Contact */
|
|
2731
2682
|
CONTACT = "CONTACT"
|
|
2732
2683
|
}
|
|
2733
|
-
|
|
2684
|
+
interface V1LineItem {
|
|
2734
2685
|
/** Line item ID (auto-generated) */
|
|
2735
2686
|
index?: number;
|
|
2736
2687
|
/**
|
|
@@ -2759,7 +2710,7 @@ export interface V1LineItem {
|
|
|
2759
2710
|
/** Product details */
|
|
2760
2711
|
productDetails?: ProductDetails;
|
|
2761
2712
|
}
|
|
2762
|
-
|
|
2713
|
+
interface OptionSelection {
|
|
2763
2714
|
/**
|
|
2764
2715
|
* Option name
|
|
2765
2716
|
* @maxLength 200
|
|
@@ -2771,7 +2722,7 @@ export interface OptionSelection {
|
|
|
2771
2722
|
*/
|
|
2772
2723
|
selection?: string;
|
|
2773
2724
|
}
|
|
2774
|
-
|
|
2725
|
+
interface CustomTextFieldSelection {
|
|
2775
2726
|
/**
|
|
2776
2727
|
* Custom text field name
|
|
2777
2728
|
* @maxLength 100
|
|
@@ -2783,7 +2734,7 @@ export interface CustomTextFieldSelection {
|
|
|
2783
2734
|
*/
|
|
2784
2735
|
value?: string;
|
|
2785
2736
|
}
|
|
2786
|
-
|
|
2737
|
+
interface ChargeDetails {
|
|
2787
2738
|
/**
|
|
2788
2739
|
* price of line item (depends on subscription option)
|
|
2789
2740
|
* @max 999999999.99
|
|
@@ -2812,7 +2763,7 @@ export interface ChargeDetails {
|
|
|
2812
2763
|
*/
|
|
2813
2764
|
taxRate?: string | null;
|
|
2814
2765
|
}
|
|
2815
|
-
|
|
2766
|
+
interface ProductDetails {
|
|
2816
2767
|
/**
|
|
2817
2768
|
* Line item product ID (optional for POS orders)
|
|
2818
2769
|
* @minLength 1
|
|
@@ -2865,7 +2816,7 @@ export interface ProductDetails {
|
|
|
2865
2816
|
*/
|
|
2866
2817
|
appId?: string | null;
|
|
2867
2818
|
}
|
|
2868
|
-
|
|
2819
|
+
declare enum LineItemType {
|
|
2869
2820
|
/** Line item type can't be classified, due to an error */
|
|
2870
2821
|
UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
|
|
2871
2822
|
/** Physical item type */
|
|
@@ -2875,7 +2826,7 @@ export declare enum LineItemType {
|
|
|
2875
2826
|
/** Custom item price */
|
|
2876
2827
|
CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
|
|
2877
2828
|
}
|
|
2878
|
-
|
|
2829
|
+
interface MediaItem {
|
|
2879
2830
|
/**
|
|
2880
2831
|
* Media type
|
|
2881
2832
|
* @readonly
|
|
@@ -2900,7 +2851,7 @@ export interface MediaItem {
|
|
|
2900
2851
|
*/
|
|
2901
2852
|
height?: number;
|
|
2902
2853
|
/** Media ID (for media items previously saved in Wix Media) */
|
|
2903
|
-
|
|
2854
|
+
_id?: string | null;
|
|
2904
2855
|
/** Media external URL */
|
|
2905
2856
|
externalImageUrl?: string | null;
|
|
2906
2857
|
/**
|
|
@@ -2909,13 +2860,13 @@ export interface MediaItem {
|
|
|
2909
2860
|
*/
|
|
2910
2861
|
altText?: string | null;
|
|
2911
2862
|
}
|
|
2912
|
-
|
|
2863
|
+
declare enum MediaItemType {
|
|
2913
2864
|
/** Media item type can't be classified, due to an error */
|
|
2914
2865
|
UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
|
|
2915
2866
|
/** Image item type */
|
|
2916
2867
|
IMAGE = "IMAGE"
|
|
2917
2868
|
}
|
|
2918
|
-
|
|
2869
|
+
interface Totals {
|
|
2919
2870
|
/**
|
|
2920
2871
|
* Subtotal of all line items, before tax
|
|
2921
2872
|
* @max 999999999.99
|
|
@@ -2952,7 +2903,7 @@ export interface Totals {
|
|
|
2952
2903
|
*/
|
|
2953
2904
|
quantity?: number;
|
|
2954
2905
|
}
|
|
2955
|
-
|
|
2906
|
+
interface StoreSettings {
|
|
2956
2907
|
/**
|
|
2957
2908
|
* Currency used for pricing in this store
|
|
2958
2909
|
* @maxLength 3
|
|
@@ -2970,7 +2921,7 @@ export interface StoreSettings {
|
|
|
2970
2921
|
*/
|
|
2971
2922
|
buyerLanguage?: string | null;
|
|
2972
2923
|
}
|
|
2973
|
-
|
|
2924
|
+
interface Address extends AddressAddressLine1OptionsOneOf {
|
|
2974
2925
|
/**
|
|
2975
2926
|
* Address line 1 (free text)
|
|
2976
2927
|
* @maxLength 1000
|
|
@@ -3024,7 +2975,7 @@ export interface Address extends AddressAddressLine1OptionsOneOf {
|
|
|
3024
2975
|
vatId?: VatId;
|
|
3025
2976
|
}
|
|
3026
2977
|
/** @oneof */
|
|
3027
|
-
|
|
2978
|
+
interface AddressAddressLine1OptionsOneOf {
|
|
3028
2979
|
/**
|
|
3029
2980
|
* Address line 1 (free text)
|
|
3030
2981
|
* @maxLength 1000
|
|
@@ -3033,7 +2984,7 @@ export interface AddressAddressLine1OptionsOneOf {
|
|
|
3033
2984
|
/** Address line 1 (street) */
|
|
3034
2985
|
street?: Street;
|
|
3035
2986
|
}
|
|
3036
|
-
|
|
2987
|
+
interface FullName {
|
|
3037
2988
|
/**
|
|
3038
2989
|
* Customer's first name
|
|
3039
2990
|
* @maxLength 1000
|
|
@@ -3045,7 +2996,7 @@ export interface FullName {
|
|
|
3045
2996
|
*/
|
|
3046
2997
|
lastName?: string;
|
|
3047
2998
|
}
|
|
3048
|
-
|
|
2999
|
+
interface Street {
|
|
3049
3000
|
/**
|
|
3050
3001
|
* Street number
|
|
3051
3002
|
* @maxLength 500
|
|
@@ -3057,7 +3008,7 @@ export interface Street {
|
|
|
3057
3008
|
*/
|
|
3058
3009
|
name?: string;
|
|
3059
3010
|
}
|
|
3060
|
-
|
|
3011
|
+
interface VatId {
|
|
3061
3012
|
/**
|
|
3062
3013
|
* Customer's tax ID.
|
|
3063
3014
|
* @maxLength 50
|
|
@@ -3071,7 +3022,7 @@ export interface VatId {
|
|
|
3071
3022
|
type?: VatType;
|
|
3072
3023
|
}
|
|
3073
3024
|
/** Brazilian tax info types */
|
|
3074
|
-
|
|
3025
|
+
declare enum VatType {
|
|
3075
3026
|
/** When the tax info type can't be classified, due to an error */
|
|
3076
3027
|
UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
|
|
3077
3028
|
/** CPF - for individual tax payers */
|
|
@@ -3079,7 +3030,7 @@ export declare enum VatType {
|
|
|
3079
3030
|
/** CNPJ - for corporations */
|
|
3080
3031
|
CNPJ = "CNPJ"
|
|
3081
3032
|
}
|
|
3082
|
-
|
|
3033
|
+
interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3083
3034
|
/** Shipment details (when this object describes shipment) */
|
|
3084
3035
|
shipmentDetails?: ShipmentDetails;
|
|
3085
3036
|
/** Pickup details (when this object describes pickup) */
|
|
@@ -3096,13 +3047,13 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
|
3096
3047
|
estimatedDeliveryTime?: string | null;
|
|
3097
3048
|
}
|
|
3098
3049
|
/** @oneof */
|
|
3099
|
-
|
|
3050
|
+
interface V1ShippingInfoDetailsOneOf {
|
|
3100
3051
|
/** Shipment details (when this object describes shipment) */
|
|
3101
3052
|
shipmentDetails?: ShipmentDetails;
|
|
3102
3053
|
/** Pickup details (when this object describes pickup) */
|
|
3103
3054
|
pickupDetails?: V1PickupDetails;
|
|
3104
3055
|
}
|
|
3105
|
-
|
|
3056
|
+
interface ShipmentDetails {
|
|
3106
3057
|
/** Shipping destination address */
|
|
3107
3058
|
address?: Address;
|
|
3108
3059
|
/**
|
|
@@ -3123,7 +3074,7 @@ export interface ShipmentDetails {
|
|
|
3123
3074
|
*/
|
|
3124
3075
|
taxRate?: string | null;
|
|
3125
3076
|
}
|
|
3126
|
-
|
|
3077
|
+
interface V1PickupDetails {
|
|
3127
3078
|
/** Pickup address */
|
|
3128
3079
|
address?: PickupAddress;
|
|
3129
3080
|
/**
|
|
@@ -3132,7 +3083,7 @@ export interface V1PickupDetails {
|
|
|
3132
3083
|
*/
|
|
3133
3084
|
pickupInstructions?: string | null;
|
|
3134
3085
|
}
|
|
3135
|
-
|
|
3086
|
+
interface PickupAddress {
|
|
3136
3087
|
/**
|
|
3137
3088
|
* Country code (2 letters)
|
|
3138
3089
|
* @format COUNTRY
|
|
@@ -3159,7 +3110,7 @@ export interface PickupAddress {
|
|
|
3159
3110
|
*/
|
|
3160
3111
|
zipCode?: string;
|
|
3161
3112
|
}
|
|
3162
|
-
|
|
3113
|
+
interface AppliedCoupon {
|
|
3163
3114
|
/** Coupon ID */
|
|
3164
3115
|
couponId?: string;
|
|
3165
3116
|
/**
|
|
@@ -3174,7 +3125,7 @@ export interface AppliedCoupon {
|
|
|
3174
3125
|
code?: string;
|
|
3175
3126
|
}
|
|
3176
3127
|
/** Custom field */
|
|
3177
|
-
|
|
3128
|
+
interface V1CustomField {
|
|
3178
3129
|
/**
|
|
3179
3130
|
* Free text that the customer entered in the custom field during the checkout process
|
|
3180
3131
|
* @maxLength 250
|
|
@@ -3191,9 +3142,9 @@ export interface V1CustomField {
|
|
|
3191
3142
|
*/
|
|
3192
3143
|
translatedTitle?: string;
|
|
3193
3144
|
}
|
|
3194
|
-
|
|
3145
|
+
interface V1SubscriptionOptionInfo {
|
|
3195
3146
|
/** @format GUID */
|
|
3196
|
-
|
|
3147
|
+
_id?: string | null;
|
|
3197
3148
|
/**
|
|
3198
3149
|
* @minLength 1
|
|
3199
3150
|
* @maxLength 20
|
|
@@ -3203,29 +3154,29 @@ export interface V1SubscriptionOptionInfo {
|
|
|
3203
3154
|
description?: string | null;
|
|
3204
3155
|
discount?: Discount;
|
|
3205
3156
|
}
|
|
3206
|
-
|
|
3157
|
+
interface Discount {
|
|
3207
3158
|
/** Discount type. */
|
|
3208
3159
|
type?: DiscountDiscountType;
|
|
3209
3160
|
/** Discount value. */
|
|
3210
3161
|
value?: number;
|
|
3211
3162
|
}
|
|
3212
|
-
|
|
3163
|
+
declare enum DiscountDiscountType {
|
|
3213
3164
|
UNDEFINED = "UNDEFINED",
|
|
3214
3165
|
/** No discount */
|
|
3215
3166
|
AMOUNT = "AMOUNT",
|
|
3216
3167
|
PERCENT = "PERCENT"
|
|
3217
3168
|
}
|
|
3218
|
-
|
|
3169
|
+
interface ChannelInfo {
|
|
3219
3170
|
/** Sales channel that submitted the subscription */
|
|
3220
3171
|
type?: ChannelInfoChannelType;
|
|
3221
3172
|
}
|
|
3222
|
-
|
|
3173
|
+
declare enum ChannelInfoChannelType {
|
|
3223
3174
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3224
3175
|
WEB = "WEB",
|
|
3225
3176
|
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
3226
3177
|
WIX_APP_STORE = "WIX_APP_STORE"
|
|
3227
3178
|
}
|
|
3228
|
-
|
|
3179
|
+
interface V1SubscriptionSettings {
|
|
3229
3180
|
/** Frequency of recurring payment. */
|
|
3230
3181
|
frequency?: SubscriptionFrequency;
|
|
3231
3182
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
@@ -3237,7 +3188,7 @@ export interface V1SubscriptionSettings {
|
|
|
3237
3188
|
*/
|
|
3238
3189
|
billingCycles?: number | null;
|
|
3239
3190
|
}
|
|
3240
|
-
|
|
3191
|
+
interface BillingInfo {
|
|
3241
3192
|
/**
|
|
3242
3193
|
* Payment method used for this order
|
|
3243
3194
|
* @maxLength 50
|
|
@@ -3254,9 +3205,9 @@ export interface BillingInfo {
|
|
|
3254
3205
|
*/
|
|
3255
3206
|
paymentGatewayOrderId?: string | null;
|
|
3256
3207
|
}
|
|
3257
|
-
|
|
3208
|
+
interface Empty {
|
|
3258
3209
|
}
|
|
3259
|
-
|
|
3210
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3260
3211
|
createdEvent?: EntityCreatedEvent;
|
|
3261
3212
|
updatedEvent?: EntityUpdatedEvent;
|
|
3262
3213
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3265,7 +3216,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3265
3216
|
* Unique event ID.
|
|
3266
3217
|
* Allows clients to ignore duplicate webhooks.
|
|
3267
3218
|
*/
|
|
3268
|
-
|
|
3219
|
+
_id?: string;
|
|
3269
3220
|
/**
|
|
3270
3221
|
* Assumes actions are also always typed to an entity_type
|
|
3271
3222
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -3299,36 +3250,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3299
3250
|
entityEventSequence?: string | null;
|
|
3300
3251
|
}
|
|
3301
3252
|
/** @oneof */
|
|
3302
|
-
|
|
3253
|
+
interface DomainEventBodyOneOf {
|
|
3303
3254
|
createdEvent?: EntityCreatedEvent;
|
|
3304
3255
|
updatedEvent?: EntityUpdatedEvent;
|
|
3305
3256
|
deletedEvent?: EntityDeletedEvent;
|
|
3306
3257
|
actionEvent?: ActionEvent;
|
|
3307
3258
|
}
|
|
3308
|
-
|
|
3309
|
-
|
|
3310
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3311
|
-
restoreInfo?: RestoreInfo;
|
|
3259
|
+
interface EntityCreatedEvent {
|
|
3260
|
+
entity?: string;
|
|
3312
3261
|
}
|
|
3313
|
-
|
|
3262
|
+
interface RestoreInfo {
|
|
3314
3263
|
deletedDate?: Date | null;
|
|
3315
3264
|
}
|
|
3316
|
-
|
|
3265
|
+
interface EntityUpdatedEvent {
|
|
3317
3266
|
/**
|
|
3318
3267
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3319
3268
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3320
3269
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3321
3270
|
*/
|
|
3322
|
-
|
|
3271
|
+
currentEntity?: string;
|
|
3323
3272
|
}
|
|
3324
|
-
|
|
3273
|
+
interface EntityDeletedEvent {
|
|
3325
3274
|
/** Entity that was deleted */
|
|
3326
|
-
|
|
3275
|
+
deletedEntity?: string | null;
|
|
3327
3276
|
}
|
|
3328
|
-
|
|
3329
|
-
|
|
3277
|
+
interface ActionEvent {
|
|
3278
|
+
body?: string;
|
|
3330
3279
|
}
|
|
3331
|
-
|
|
3280
|
+
interface MessageEnvelope {
|
|
3332
3281
|
/**
|
|
3333
3282
|
* App instance ID.
|
|
3334
3283
|
* @format GUID
|
|
@@ -3344,7 +3293,7 @@ export interface MessageEnvelope {
|
|
|
3344
3293
|
/** Stringify payload. */
|
|
3345
3294
|
data?: string;
|
|
3346
3295
|
}
|
|
3347
|
-
|
|
3296
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3348
3297
|
/**
|
|
3349
3298
|
* ID of a site visitor that has not logged in to the site.
|
|
3350
3299
|
* @format GUID
|
|
@@ -3369,7 +3318,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3369
3318
|
identityType?: WebhookIdentityType;
|
|
3370
3319
|
}
|
|
3371
3320
|
/** @oneof */
|
|
3372
|
-
|
|
3321
|
+
interface IdentificationDataIdOneOf {
|
|
3373
3322
|
/**
|
|
3374
3323
|
* ID of a site visitor that has not logged in to the site.
|
|
3375
3324
|
* @format GUID
|
|
@@ -3391,10 +3340,343 @@ export interface IdentificationDataIdOneOf {
|
|
|
3391
3340
|
*/
|
|
3392
3341
|
appId?: string;
|
|
3393
3342
|
}
|
|
3394
|
-
|
|
3343
|
+
declare enum WebhookIdentityType {
|
|
3395
3344
|
UNKNOWN = "UNKNOWN",
|
|
3396
3345
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3397
3346
|
MEMBER = "MEMBER",
|
|
3398
3347
|
WIX_USER = "WIX_USER",
|
|
3399
3348
|
APP = "APP"
|
|
3400
3349
|
}
|
|
3350
|
+
interface BaseEventMetadata {
|
|
3351
|
+
/**
|
|
3352
|
+
* App instance ID.
|
|
3353
|
+
* @format GUID
|
|
3354
|
+
*/
|
|
3355
|
+
instanceId?: string | null;
|
|
3356
|
+
/**
|
|
3357
|
+
* Event type.
|
|
3358
|
+
* @maxLength 150
|
|
3359
|
+
*/
|
|
3360
|
+
eventType?: string;
|
|
3361
|
+
/** The identification type and identity data. */
|
|
3362
|
+
identity?: IdentificationData;
|
|
3363
|
+
}
|
|
3364
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
3365
|
+
/**
|
|
3366
|
+
* Unique event ID.
|
|
3367
|
+
* Allows clients to ignore duplicate webhooks.
|
|
3368
|
+
*/
|
|
3369
|
+
_id?: string;
|
|
3370
|
+
/**
|
|
3371
|
+
* Assumes actions are also always typed to an entity_type
|
|
3372
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3373
|
+
*/
|
|
3374
|
+
entityFqdn?: string;
|
|
3375
|
+
/**
|
|
3376
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3377
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3378
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
3379
|
+
*/
|
|
3380
|
+
slug?: string;
|
|
3381
|
+
/** ID of the entity associated with the event. */
|
|
3382
|
+
entityId?: string;
|
|
3383
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3384
|
+
eventTime?: Date | null;
|
|
3385
|
+
/**
|
|
3386
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3387
|
+
* (for example, GDPR).
|
|
3388
|
+
*/
|
|
3389
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3390
|
+
/** If present, indicates the action that triggered the event. */
|
|
3391
|
+
originatedFrom?: string | null;
|
|
3392
|
+
/**
|
|
3393
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
3394
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3395
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3396
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3397
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3398
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3399
|
+
*/
|
|
3400
|
+
entityEventSequence?: string | null;
|
|
3401
|
+
}
|
|
3402
|
+
interface CheckoutCompletedEnvelope {
|
|
3403
|
+
data: CheckoutMarkedAsCompleted;
|
|
3404
|
+
metadata: EventMetadata;
|
|
3405
|
+
}
|
|
3406
|
+
interface CheckoutCreatedEnvelope {
|
|
3407
|
+
entity: Checkout;
|
|
3408
|
+
metadata: EventMetadata;
|
|
3409
|
+
}
|
|
3410
|
+
interface CheckoutUpdatedEnvelope {
|
|
3411
|
+
entity: Checkout;
|
|
3412
|
+
metadata: EventMetadata;
|
|
3413
|
+
}
|
|
3414
|
+
interface CreateCheckoutOptions {
|
|
3415
|
+
/** Checkout information. */
|
|
3416
|
+
checkoutInfo?: Checkout;
|
|
3417
|
+
/** 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). */
|
|
3418
|
+
couponCode?: string | null;
|
|
3419
|
+
/**
|
|
3420
|
+
* Catalog line items to add to the checkout.
|
|
3421
|
+
* @maxSize 300
|
|
3422
|
+
*/
|
|
3423
|
+
lineItems?: LineItem[];
|
|
3424
|
+
/**
|
|
3425
|
+
* Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
|
|
3426
|
+
*
|
|
3427
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3428
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3429
|
+
* @maxSize 300
|
|
3430
|
+
*/
|
|
3431
|
+
customLineItems?: CustomLineItem[];
|
|
3432
|
+
/** Sales channel that submitted the order. */
|
|
3433
|
+
channelType: ChannelType;
|
|
3434
|
+
/**
|
|
3435
|
+
* Gift card code.
|
|
3436
|
+
*
|
|
3437
|
+
* The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
|
|
3438
|
+
*
|
|
3439
|
+
* >**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).
|
|
3440
|
+
*/
|
|
3441
|
+
giftCardCode?: string | null;
|
|
3442
|
+
/**
|
|
3443
|
+
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
3444
|
+
*
|
|
3445
|
+
* 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`.
|
|
3446
|
+
* @maxLength 1000
|
|
3447
|
+
*/
|
|
3448
|
+
overrideCheckoutUrl?: string | null;
|
|
3449
|
+
}
|
|
3450
|
+
interface UpdateCheckout {
|
|
3451
|
+
/**
|
|
3452
|
+
* Checkout ID.
|
|
3453
|
+
* @format GUID
|
|
3454
|
+
* @readonly
|
|
3455
|
+
*/
|
|
3456
|
+
_id?: string | null;
|
|
3457
|
+
/**
|
|
3458
|
+
* Line items.
|
|
3459
|
+
*
|
|
3460
|
+
* Max: 300 items
|
|
3461
|
+
* @minSize 1
|
|
3462
|
+
* @maxSize 300
|
|
3463
|
+
* @readonly
|
|
3464
|
+
*/
|
|
3465
|
+
lineItems?: LineItem[];
|
|
3466
|
+
/** Billing information. */
|
|
3467
|
+
billingInfo?: AddressWithContact;
|
|
3468
|
+
/** Shipping information. */
|
|
3469
|
+
shippingInfo?: ShippingInfo;
|
|
3470
|
+
/**
|
|
3471
|
+
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
3472
|
+
* @maxLength 1000
|
|
3473
|
+
*/
|
|
3474
|
+
buyerNote?: string | null;
|
|
3475
|
+
/** Buyer information. */
|
|
3476
|
+
buyerInfo?: BuyerInfo;
|
|
3477
|
+
/**
|
|
3478
|
+
* All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
3479
|
+
* @readonly
|
|
3480
|
+
* @format CURRENCY
|
|
3481
|
+
*/
|
|
3482
|
+
conversionCurrency?: string;
|
|
3483
|
+
/**
|
|
3484
|
+
* Calculated price summary for the checkout.
|
|
3485
|
+
* @readonly
|
|
3486
|
+
*/
|
|
3487
|
+
priceSummary?: PriceSummary;
|
|
3488
|
+
/**
|
|
3489
|
+
* Errors when calculating totals.
|
|
3490
|
+
* @readonly
|
|
3491
|
+
*/
|
|
3492
|
+
calculationErrors?: CalculationErrors;
|
|
3493
|
+
/**
|
|
3494
|
+
* Applied gift card details.
|
|
3495
|
+
*
|
|
3496
|
+
* >**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).
|
|
3497
|
+
* @readonly
|
|
3498
|
+
*/
|
|
3499
|
+
giftCard?: GiftCard;
|
|
3500
|
+
/**
|
|
3501
|
+
* Applied discounts.
|
|
3502
|
+
* @readonly
|
|
3503
|
+
*/
|
|
3504
|
+
appliedDiscounts?: AppliedDiscount[];
|
|
3505
|
+
/** Custom fields. */
|
|
3506
|
+
customFields?: CustomField[];
|
|
3507
|
+
/**
|
|
3508
|
+
* Weight measurement unit. Defaults to a site's weight unit.
|
|
3509
|
+
* @readonly
|
|
3510
|
+
*/
|
|
3511
|
+
weightUnit?: WeightUnit;
|
|
3512
|
+
/**
|
|
3513
|
+
* Tax summary.
|
|
3514
|
+
* @readonly
|
|
3515
|
+
*/
|
|
3516
|
+
taxSummary?: TaxSummary;
|
|
3517
|
+
/**
|
|
3518
|
+
* The currency used when submitting the order.
|
|
3519
|
+
* @format CURRENCY
|
|
3520
|
+
* @readonly
|
|
3521
|
+
*/
|
|
3522
|
+
currency?: string;
|
|
3523
|
+
/**
|
|
3524
|
+
* Sales channel that submitted the order.
|
|
3525
|
+
* @readonly
|
|
3526
|
+
*/
|
|
3527
|
+
channelType?: ChannelType;
|
|
3528
|
+
/**
|
|
3529
|
+
* Site language in which original values are shown.
|
|
3530
|
+
* @readonly
|
|
3531
|
+
*/
|
|
3532
|
+
siteLanguage?: string;
|
|
3533
|
+
/**
|
|
3534
|
+
* Language for communication with the buyer. Defaults to the site language.
|
|
3535
|
+
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
3536
|
+
* @readonly
|
|
3537
|
+
*/
|
|
3538
|
+
buyerLanguage?: string;
|
|
3539
|
+
/**
|
|
3540
|
+
* Whether an order was successfully created from this checkout.
|
|
3541
|
+
* For an order to be successful, it must be successfully paid for (unless the total is 0).
|
|
3542
|
+
* @readonly
|
|
3543
|
+
*/
|
|
3544
|
+
completed?: boolean;
|
|
3545
|
+
/**
|
|
3546
|
+
* Whether tax is included in line item prices.
|
|
3547
|
+
* @readonly
|
|
3548
|
+
*/
|
|
3549
|
+
taxIncludedInPrice?: boolean;
|
|
3550
|
+
/**
|
|
3551
|
+
* ID of the checkout's initiator.
|
|
3552
|
+
* @readonly
|
|
3553
|
+
*/
|
|
3554
|
+
createdBy?: CreatedBy;
|
|
3555
|
+
/**
|
|
3556
|
+
* Date and time the checkout was created.
|
|
3557
|
+
* @readonly
|
|
3558
|
+
*/
|
|
3559
|
+
_createdDate?: Date | null;
|
|
3560
|
+
/**
|
|
3561
|
+
* Date and time the checkout was updated.
|
|
3562
|
+
* @readonly
|
|
3563
|
+
*/
|
|
3564
|
+
_updatedDate?: Date | null;
|
|
3565
|
+
/**
|
|
3566
|
+
* Minimal amount to pay in order to place the order.
|
|
3567
|
+
* @readonly
|
|
3568
|
+
*/
|
|
3569
|
+
payNow?: PriceSummary;
|
|
3570
|
+
/**
|
|
3571
|
+
* Remaining amount for the order to be fully paid.
|
|
3572
|
+
* @readonly
|
|
3573
|
+
*/
|
|
3574
|
+
payLater?: PriceSummary;
|
|
3575
|
+
/** Memberships to apply when creating the order. */
|
|
3576
|
+
membershipOptions?: MembershipOptions;
|
|
3577
|
+
/**
|
|
3578
|
+
* Additional Fees.
|
|
3579
|
+
* @maxSize 100
|
|
3580
|
+
*/
|
|
3581
|
+
additionalFees?: AdditionalFee[];
|
|
3582
|
+
/**
|
|
3583
|
+
* Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
|
|
3584
|
+
* @format GUID
|
|
3585
|
+
*/
|
|
3586
|
+
cartId?: string | null;
|
|
3587
|
+
/**
|
|
3588
|
+
* List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
|
|
3589
|
+
* @readonly
|
|
3590
|
+
*/
|
|
3591
|
+
violations?: Violation[];
|
|
3592
|
+
/**
|
|
3593
|
+
* Custom field data for the checkout object.
|
|
3594
|
+
*
|
|
3595
|
+
* [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.
|
|
3596
|
+
*/
|
|
3597
|
+
extendedFields?: ExtendedFields;
|
|
3598
|
+
/**
|
|
3599
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
3600
|
+
* @format GUID
|
|
3601
|
+
* @readonly
|
|
3602
|
+
*/
|
|
3603
|
+
purchaseFlowId?: string | null;
|
|
3604
|
+
/**
|
|
3605
|
+
* Additional settings for customization of the checkout process.
|
|
3606
|
+
*
|
|
3607
|
+
* Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
|
|
3608
|
+
* @immutable
|
|
3609
|
+
*/
|
|
3610
|
+
customSettings?: CustomSettings;
|
|
3611
|
+
/**
|
|
3612
|
+
* Reference IDs for the app and component providing custom checkout page content.
|
|
3613
|
+
*
|
|
3614
|
+
* To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3615
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3616
|
+
*/
|
|
3617
|
+
customContentReference?: CustomContentReference;
|
|
3618
|
+
/**
|
|
3619
|
+
* The business location ID associated with the checkout.
|
|
3620
|
+
*
|
|
3621
|
+
* To learn more, see the Locations API.
|
|
3622
|
+
* @format GUID
|
|
3623
|
+
*/
|
|
3624
|
+
businessLocationId?: string | null;
|
|
3625
|
+
}
|
|
3626
|
+
interface UpdateCheckoutOptions {
|
|
3627
|
+
/** 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). */
|
|
3628
|
+
couponCode?: string | null;
|
|
3629
|
+
/** Gift card code. */
|
|
3630
|
+
giftCardCode?: string | null;
|
|
3631
|
+
/**
|
|
3632
|
+
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
3633
|
+
*
|
|
3634
|
+
* 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`.
|
|
3635
|
+
* @maxLength 1000
|
|
3636
|
+
*/
|
|
3637
|
+
overrideCheckoutUrl?: string | null;
|
|
3638
|
+
/**
|
|
3639
|
+
* Catalog line items.
|
|
3640
|
+
* @maxSize 300
|
|
3641
|
+
*/
|
|
3642
|
+
lineItems?: LineItem[];
|
|
3643
|
+
/**
|
|
3644
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
3645
|
+
*
|
|
3646
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3647
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3648
|
+
* @maxSize 300
|
|
3649
|
+
*/
|
|
3650
|
+
customLineItems?: CustomLineItem[];
|
|
3651
|
+
}
|
|
3652
|
+
interface AddToCheckoutOptions {
|
|
3653
|
+
/**
|
|
3654
|
+
* Catalog line items.
|
|
3655
|
+
* @maxSize 100
|
|
3656
|
+
*/
|
|
3657
|
+
lineItems?: LineItem[];
|
|
3658
|
+
/**
|
|
3659
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
3660
|
+
*
|
|
3661
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3662
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3663
|
+
* @maxSize 100
|
|
3664
|
+
*/
|
|
3665
|
+
customLineItems?: CustomLineItem[];
|
|
3666
|
+
}
|
|
3667
|
+
interface CreateOrderOptions {
|
|
3668
|
+
/** Whether the payment method should be saved on the order. */
|
|
3669
|
+
savePaymentMethod?: boolean;
|
|
3670
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
3671
|
+
delayCapture?: boolean;
|
|
3672
|
+
}
|
|
3673
|
+
interface CreateOrderAndChargeOptions {
|
|
3674
|
+
/** Payment token. */
|
|
3675
|
+
paymentToken?: string | null;
|
|
3676
|
+
/** Whether the payment method should be saved on the order. */
|
|
3677
|
+
savePaymentMethod?: boolean;
|
|
3678
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
3679
|
+
delayCapture?: boolean;
|
|
3680
|
+
}
|
|
3681
|
+
|
|
3682
|
+
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 };
|