@wix/auto_sdk_ecom_checkout 1.0.16 → 1.0.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +34 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.context.js +77 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +122 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js +1338 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +59 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +351 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +186 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js +358 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
- package/build/{ecom-v1-checkout-checkout.universal-C4Y04uL3.d.mts → cjs/src/ecom-v1-checkout-checkout.types.d.ts} +382 -658
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js +301 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -0
- package/build/{internal/ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.mts → cjs/src/ecom-v1-checkout-checkout.universal.d.ts} +743 -449
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +1559 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +34 -0
- package/build/es/src/ecom-v1-checkout-checkout.context.js +42 -0
- package/build/es/src/ecom-v1-checkout-checkout.context.js.map +1 -0
- package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +122 -0
- package/build/es/src/ecom-v1-checkout-checkout.http.js +1318 -0
- package/build/es/src/ecom-v1-checkout-checkout.http.js.map +1 -0
- package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +59 -0
- package/build/es/src/ecom-v1-checkout-checkout.meta.js +308 -0
- package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
- package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +186 -0
- package/build/es/src/ecom-v1-checkout-checkout.public.js +306 -0
- package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
- package/build/{ecom-v1-checkout-checkout.universal-C4Y04uL3.d.ts → es/src/ecom-v1-checkout-checkout.types.d.ts} +382 -658
- package/build/es/src/ecom-v1-checkout-checkout.types.js +298 -0
- package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -0
- package/build/{internal/ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.ts → es/src/ecom-v1-checkout-checkout.universal.d.ts} +743 -449
- package/build/es/src/ecom-v1-checkout-checkout.universal.js +1516 -0
- package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +42 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +77 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +122 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +1338 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +59 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +351 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +219 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +358 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +3406 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +301 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +4468 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +1559 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +42 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +42 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +122 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +1318 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +59 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +308 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +219 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +306 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +3406 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +298 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +4468 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +1516 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -211
- package/build/index.d.ts +0 -211
- package/build/index.js +0 -2781
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -2707
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -252
- package/build/internal/index.d.ts +0 -252
- package/build/internal/index.js +0 -2781
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -2707
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -2322
- package/build/internal/meta.d.ts +0 -2322
- package/build/internal/meta.js +0 -1587
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -1544
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -2322
- package/build/meta.d.ts +0 -2322
- package/build/meta.js +0 -1587
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -1544
- package/build/meta.mjs.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
interface Checkout {
|
|
1
|
+
export interface Checkout {
|
|
2
2
|
/**
|
|
3
3
|
* Checkout ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
id?: string | null;
|
|
8
8
|
/**
|
|
9
9
|
* Line items.
|
|
10
10
|
*
|
|
@@ -19,7 +19,7 @@ interface Checkout {
|
|
|
19
19
|
/** Shipping information. */
|
|
20
20
|
shippingInfo?: ShippingInfo;
|
|
21
21
|
/**
|
|
22
|
-
* [Buyer note](https://support.wix.com/en/article/
|
|
22
|
+
* [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
|
|
23
23
|
* @maxLength 1000
|
|
24
24
|
*/
|
|
25
25
|
buyerNote?: string | null;
|
|
@@ -107,12 +107,12 @@ interface Checkout {
|
|
|
107
107
|
* Date and time the checkout was created.
|
|
108
108
|
* @readonly
|
|
109
109
|
*/
|
|
110
|
-
|
|
110
|
+
createdDate?: Date | null;
|
|
111
111
|
/**
|
|
112
112
|
* Date and time the checkout was updated.
|
|
113
113
|
* @readonly
|
|
114
114
|
*/
|
|
115
|
-
|
|
115
|
+
updatedDate?: Date | null;
|
|
116
116
|
/**
|
|
117
117
|
* Minimal amount to pay in order to place the order.
|
|
118
118
|
* @readonly
|
|
@@ -136,7 +136,7 @@ interface Checkout {
|
|
|
136
136
|
*/
|
|
137
137
|
cartId?: string | null;
|
|
138
138
|
/**
|
|
139
|
-
* List of validation violations raised by the
|
|
139
|
+
* List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
|
|
140
140
|
* @readonly
|
|
141
141
|
*/
|
|
142
142
|
violations?: Violation[];
|
|
@@ -155,7 +155,9 @@ interface Checkout {
|
|
|
155
155
|
/**
|
|
156
156
|
* Additional settings for customization of the checkout process.
|
|
157
157
|
*
|
|
158
|
-
*
|
|
158
|
+
* > **Notes:**
|
|
159
|
+
* > * Custom settings can only be set when creating a checkout.
|
|
160
|
+
* > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
159
161
|
* @immutable
|
|
160
162
|
*/
|
|
161
163
|
customSettings?: CustomSettings;
|
|
@@ -166,6 +168,12 @@ interface Checkout {
|
|
|
166
168
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
167
169
|
*/
|
|
168
170
|
customContentReference?: CustomContentReference;
|
|
171
|
+
/**
|
|
172
|
+
* References to an external app and resource associated with this checkout.
|
|
173
|
+
* Used for integration and tracking across different platforms.
|
|
174
|
+
* @immutable
|
|
175
|
+
*/
|
|
176
|
+
externalReference?: ExternalReference;
|
|
169
177
|
/**
|
|
170
178
|
* The business location ID associated with the checkout.
|
|
171
179
|
*
|
|
@@ -174,13 +182,13 @@ interface Checkout {
|
|
|
174
182
|
*/
|
|
175
183
|
businessLocationId?: string | null;
|
|
176
184
|
}
|
|
177
|
-
interface LineItem {
|
|
185
|
+
export interface LineItem {
|
|
178
186
|
/**
|
|
179
187
|
* Line item ID.
|
|
180
188
|
* @format GUID
|
|
181
189
|
* @readonly
|
|
182
190
|
*/
|
|
183
|
-
|
|
191
|
+
id?: string | null;
|
|
184
192
|
/**
|
|
185
193
|
* Item quantity.
|
|
186
194
|
*
|
|
@@ -190,7 +198,7 @@ interface LineItem {
|
|
|
190
198
|
* @max 100000
|
|
191
199
|
*/
|
|
192
200
|
quantity?: number;
|
|
193
|
-
/** Catalog and item reference.
|
|
201
|
+
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
|
|
194
202
|
catalogReference?: CatalogReference;
|
|
195
203
|
/**
|
|
196
204
|
* Item name.
|
|
@@ -204,7 +212,7 @@ interface LineItem {
|
|
|
204
212
|
* URL to the item's page on the site.
|
|
205
213
|
* @readonly
|
|
206
214
|
*/
|
|
207
|
-
url?:
|
|
215
|
+
url?: PageUrlV2;
|
|
208
216
|
/**
|
|
209
217
|
* Item price **after** catalog-defined discount and line item discounts.
|
|
210
218
|
* @readonly
|
|
@@ -246,7 +254,7 @@ interface LineItem {
|
|
|
246
254
|
*/
|
|
247
255
|
discount?: MultiCurrencyPrice;
|
|
248
256
|
/**
|
|
249
|
-
* Line item description lines. Used for
|
|
257
|
+
* Line item description lines. Used for display purposes for the cart, checkout and order.
|
|
250
258
|
* @readonly
|
|
251
259
|
*/
|
|
252
260
|
descriptionLines?: DescriptionLine[];
|
|
@@ -254,7 +262,7 @@ interface LineItem {
|
|
|
254
262
|
* Line item image details.
|
|
255
263
|
* @readonly
|
|
256
264
|
*/
|
|
257
|
-
media?:
|
|
265
|
+
media?: CommonImage;
|
|
258
266
|
/**
|
|
259
267
|
* Item availability details.
|
|
260
268
|
* @readonly
|
|
@@ -276,11 +284,9 @@ interface LineItem {
|
|
|
276
284
|
*/
|
|
277
285
|
subscriptionOptionInfo?: SubscriptionOptionInfo;
|
|
278
286
|
/**
|
|
279
|
-
* Type of selected payment option for current item.
|
|
280
|
-
*
|
|
281
|
-
*
|
|
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.
|
|
287
|
+
* Type of selected payment option for current item.
|
|
288
|
+
*
|
|
289
|
+
* Default: `FULL_PAYMENT_ONLINE`
|
|
284
290
|
* @readonly
|
|
285
291
|
*/
|
|
286
292
|
paymentOption?: PaymentOptionType;
|
|
@@ -343,7 +349,7 @@ interface LineItem {
|
|
|
343
349
|
savePaymentMethod?: boolean;
|
|
344
350
|
}
|
|
345
351
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
346
|
-
interface CatalogReference {
|
|
352
|
+
export interface CatalogReference {
|
|
347
353
|
/**
|
|
348
354
|
* ID of the item within the catalog it belongs to.
|
|
349
355
|
* @minLength 1
|
|
@@ -363,15 +369,13 @@ interface CatalogReference {
|
|
|
363
369
|
*/
|
|
364
370
|
appId?: string;
|
|
365
371
|
/**
|
|
366
|
-
* Additional item details in key:value pairs.
|
|
372
|
+
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
367
373
|
*
|
|
368
|
-
*
|
|
369
|
-
*
|
|
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).
|
|
374
|
+
* For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
|
|
371
375
|
*/
|
|
372
376
|
options?: Record<string, any> | null;
|
|
373
377
|
}
|
|
374
|
-
interface ProductName {
|
|
378
|
+
export interface ProductName {
|
|
375
379
|
/**
|
|
376
380
|
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
377
381
|
*
|
|
@@ -392,7 +396,13 @@ interface ProductName {
|
|
|
392
396
|
*/
|
|
393
397
|
translated?: string | null;
|
|
394
398
|
}
|
|
395
|
-
interface
|
|
399
|
+
export interface PageUrlV2 {
|
|
400
|
+
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
401
|
+
relativePath?: string;
|
|
402
|
+
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
403
|
+
url?: string | null;
|
|
404
|
+
}
|
|
405
|
+
export interface MultiCurrencyPrice {
|
|
396
406
|
/**
|
|
397
407
|
* Amount.
|
|
398
408
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -415,7 +425,7 @@ interface MultiCurrencyPrice {
|
|
|
415
425
|
*/
|
|
416
426
|
formattedConvertedAmount?: string;
|
|
417
427
|
}
|
|
418
|
-
interface ItemTaxFullDetails {
|
|
428
|
+
export interface ItemTaxFullDetails {
|
|
419
429
|
/** Amount for which tax is calculated. */
|
|
420
430
|
taxableAmount?: MultiCurrencyPrice;
|
|
421
431
|
/**
|
|
@@ -432,7 +442,7 @@ interface ItemTaxFullDetails {
|
|
|
432
442
|
*/
|
|
433
443
|
rateBreakdown?: TaxRateBreakdown[];
|
|
434
444
|
}
|
|
435
|
-
interface TaxRateBreakdown {
|
|
445
|
+
export interface TaxRateBreakdown {
|
|
436
446
|
/**
|
|
437
447
|
* Name of tax against which the calculation was performed.
|
|
438
448
|
* @maxLength 100
|
|
@@ -450,7 +460,7 @@ interface TaxRateBreakdown {
|
|
|
450
460
|
* TaxBreakdown represents tax information for a line item.
|
|
451
461
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
452
462
|
*/
|
|
453
|
-
interface TaxBreakdown {
|
|
463
|
+
export interface TaxBreakdown {
|
|
454
464
|
/**
|
|
455
465
|
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
456
466
|
* @maxLength 200
|
|
@@ -482,7 +492,7 @@ interface TaxBreakdown {
|
|
|
482
492
|
jurisdictionType?: JurisdictionType;
|
|
483
493
|
}
|
|
484
494
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
485
|
-
declare enum JurisdictionType {
|
|
495
|
+
export declare enum JurisdictionType {
|
|
486
496
|
UNDEFINED = "UNDEFINED",
|
|
487
497
|
COUNTRY = "COUNTRY",
|
|
488
498
|
STATE = "STATE",
|
|
@@ -490,7 +500,7 @@ declare enum JurisdictionType {
|
|
|
490
500
|
CITY = "CITY",
|
|
491
501
|
SPECIAL = "SPECIAL"
|
|
492
502
|
}
|
|
493
|
-
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
503
|
+
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
494
504
|
/** Description line plain text value. */
|
|
495
505
|
plainText?: PlainTextValue;
|
|
496
506
|
/** Description line color value. */
|
|
@@ -499,16 +509,16 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
499
509
|
name?: DescriptionLineName;
|
|
500
510
|
}
|
|
501
511
|
/** @oneof */
|
|
502
|
-
interface DescriptionLineValueOneOf {
|
|
512
|
+
export interface DescriptionLineValueOneOf {
|
|
503
513
|
/** Description line plain text value. */
|
|
504
514
|
plainText?: PlainTextValue;
|
|
505
515
|
/** Description line color value. */
|
|
506
516
|
colorInfo?: Color;
|
|
507
517
|
}
|
|
508
518
|
/** @oneof */
|
|
509
|
-
interface DescriptionLineDescriptionLineValueOneOf {
|
|
519
|
+
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
510
520
|
}
|
|
511
|
-
interface DescriptionLineName {
|
|
521
|
+
export interface DescriptionLineName {
|
|
512
522
|
/**
|
|
513
523
|
* Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
514
524
|
* @maxLength 100
|
|
@@ -522,7 +532,7 @@ interface DescriptionLineName {
|
|
|
522
532
|
*/
|
|
523
533
|
translated?: string | null;
|
|
524
534
|
}
|
|
525
|
-
interface PlainTextValue {
|
|
535
|
+
export interface PlainTextValue {
|
|
526
536
|
/**
|
|
527
537
|
* Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
528
538
|
* @maxLength 600
|
|
@@ -536,7 +546,7 @@ interface PlainTextValue {
|
|
|
536
546
|
*/
|
|
537
547
|
translated?: string | null;
|
|
538
548
|
}
|
|
539
|
-
interface Color {
|
|
549
|
+
export interface Color {
|
|
540
550
|
/**
|
|
541
551
|
* Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
542
552
|
* @maxLength 500
|
|
@@ -552,7 +562,7 @@ interface Color {
|
|
|
552
562
|
/** HEX or RGB color code for display. */
|
|
553
563
|
code?: string | null;
|
|
554
564
|
}
|
|
555
|
-
declare enum DescriptionLineType {
|
|
565
|
+
export declare enum DescriptionLineType {
|
|
556
566
|
/** Unrecognized type. */
|
|
557
567
|
UNRECOGNISED = "UNRECOGNISED",
|
|
558
568
|
/** Plain text type. */
|
|
@@ -560,7 +570,30 @@ declare enum DescriptionLineType {
|
|
|
560
570
|
/** Color type. */
|
|
561
571
|
COLOR = "COLOR"
|
|
562
572
|
}
|
|
563
|
-
interface
|
|
573
|
+
export interface CommonImage {
|
|
574
|
+
/** WixMedia image ID. */
|
|
575
|
+
id?: string;
|
|
576
|
+
/** Image URL. */
|
|
577
|
+
url?: string;
|
|
578
|
+
/**
|
|
579
|
+
* Original image height.
|
|
580
|
+
* @readonly
|
|
581
|
+
*/
|
|
582
|
+
height?: number;
|
|
583
|
+
/**
|
|
584
|
+
* Original image width.
|
|
585
|
+
* @readonly
|
|
586
|
+
*/
|
|
587
|
+
width?: number;
|
|
588
|
+
/** Image alt text. */
|
|
589
|
+
altText?: string | null;
|
|
590
|
+
/**
|
|
591
|
+
* Image filename.
|
|
592
|
+
* @readonly
|
|
593
|
+
*/
|
|
594
|
+
filename?: string | null;
|
|
595
|
+
}
|
|
596
|
+
export interface FocalPoint {
|
|
564
597
|
/** X-coordinate of the focal point. */
|
|
565
598
|
x?: number;
|
|
566
599
|
/** Y-coordinate of the focal point. */
|
|
@@ -570,13 +603,13 @@ interface FocalPoint {
|
|
|
570
603
|
/** crop by width */
|
|
571
604
|
width?: number | null;
|
|
572
605
|
}
|
|
573
|
-
interface ItemAvailabilityInfo {
|
|
606
|
+
export interface ItemAvailabilityInfo {
|
|
574
607
|
/** Item availability status. */
|
|
575
608
|
status?: ItemAvailabilityStatus;
|
|
576
609
|
/** Quantity available. */
|
|
577
610
|
quantityAvailable?: number | null;
|
|
578
611
|
}
|
|
579
|
-
declare enum ItemAvailabilityStatus {
|
|
612
|
+
export declare enum ItemAvailabilityStatus {
|
|
580
613
|
AVAILABLE = "AVAILABLE",
|
|
581
614
|
/** Item does not exist. */
|
|
582
615
|
NOT_FOUND = "NOT_FOUND",
|
|
@@ -585,8 +618,8 @@ declare enum ItemAvailabilityStatus {
|
|
|
585
618
|
/** Available quantity is less than requested. */
|
|
586
619
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
587
620
|
}
|
|
588
|
-
interface PhysicalProperties {
|
|
589
|
-
/** Line item weight. Measurement unit
|
|
621
|
+
export interface PhysicalProperties {
|
|
622
|
+
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
590
623
|
weight?: number | null;
|
|
591
624
|
/**
|
|
592
625
|
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
@@ -596,39 +629,39 @@ interface PhysicalProperties {
|
|
|
596
629
|
/** Whether this line item is shippable. */
|
|
597
630
|
shippable?: boolean;
|
|
598
631
|
}
|
|
599
|
-
interface Scope {
|
|
632
|
+
export interface Scope {
|
|
600
633
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
601
634
|
namespace?: string;
|
|
602
635
|
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
603
636
|
group?: Group;
|
|
604
637
|
}
|
|
605
|
-
interface Group {
|
|
638
|
+
export interface Group {
|
|
606
639
|
/** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
|
|
607
640
|
name?: string;
|
|
608
641
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
609
642
|
entityId?: string | null;
|
|
610
643
|
}
|
|
611
|
-
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
644
|
+
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
612
645
|
/** Preset item type. */
|
|
613
646
|
preset?: ItemTypeItemType;
|
|
614
647
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
615
648
|
custom?: string;
|
|
616
649
|
}
|
|
617
650
|
/** @oneof */
|
|
618
|
-
interface ItemTypeItemTypeDataOneOf {
|
|
651
|
+
export interface ItemTypeItemTypeDataOneOf {
|
|
619
652
|
/** Preset item type. */
|
|
620
653
|
preset?: ItemTypeItemType;
|
|
621
654
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
622
655
|
custom?: string;
|
|
623
656
|
}
|
|
624
|
-
declare enum ItemTypeItemType {
|
|
657
|
+
export declare enum ItemTypeItemType {
|
|
625
658
|
UNRECOGNISED = "UNRECOGNISED",
|
|
626
659
|
PHYSICAL = "PHYSICAL",
|
|
627
660
|
DIGITAL = "DIGITAL",
|
|
628
661
|
GIFT_CARD = "GIFT_CARD",
|
|
629
662
|
SERVICE = "SERVICE"
|
|
630
663
|
}
|
|
631
|
-
interface SubscriptionOptionInfo {
|
|
664
|
+
export interface SubscriptionOptionInfo {
|
|
632
665
|
/** Subscription option settings. */
|
|
633
666
|
subscriptionSettings?: SubscriptionSettings;
|
|
634
667
|
/** Subscription option title. */
|
|
@@ -636,7 +669,7 @@ interface SubscriptionOptionInfo {
|
|
|
636
669
|
/** Subscription option description. */
|
|
637
670
|
description?: Description;
|
|
638
671
|
}
|
|
639
|
-
interface SubscriptionSettings {
|
|
672
|
+
export interface SubscriptionSettings {
|
|
640
673
|
/** Frequency of recurring payment. */
|
|
641
674
|
frequency?: SubscriptionFrequency;
|
|
642
675
|
/**
|
|
@@ -657,14 +690,14 @@ interface SubscriptionSettings {
|
|
|
657
690
|
billingCycles?: number | null;
|
|
658
691
|
}
|
|
659
692
|
/** Frequency unit of recurring payment */
|
|
660
|
-
declare enum SubscriptionFrequency {
|
|
693
|
+
export declare enum SubscriptionFrequency {
|
|
661
694
|
UNDEFINED = "UNDEFINED",
|
|
662
695
|
DAY = "DAY",
|
|
663
696
|
WEEK = "WEEK",
|
|
664
697
|
MONTH = "MONTH",
|
|
665
698
|
YEAR = "YEAR"
|
|
666
699
|
}
|
|
667
|
-
interface FreeTrialPeriod {
|
|
700
|
+
export interface FreeTrialPeriod {
|
|
668
701
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
669
702
|
frequency?: SubscriptionFrequency;
|
|
670
703
|
/**
|
|
@@ -674,7 +707,7 @@ interface FreeTrialPeriod {
|
|
|
674
707
|
*/
|
|
675
708
|
interval?: number;
|
|
676
709
|
}
|
|
677
|
-
interface Title {
|
|
710
|
+
export interface Title {
|
|
678
711
|
/**
|
|
679
712
|
* Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
680
713
|
* @minLength 1
|
|
@@ -690,7 +723,7 @@ interface Title {
|
|
|
690
723
|
*/
|
|
691
724
|
translated?: string | null;
|
|
692
725
|
}
|
|
693
|
-
interface Description {
|
|
726
|
+
export interface Description {
|
|
694
727
|
/**
|
|
695
728
|
* Subscription option description.
|
|
696
729
|
* @maxLength 500
|
|
@@ -702,13 +735,13 @@ interface Description {
|
|
|
702
735
|
*/
|
|
703
736
|
translated?: string | null;
|
|
704
737
|
}
|
|
705
|
-
interface SecuredMedia {
|
|
738
|
+
export interface SecuredMedia {
|
|
706
739
|
/**
|
|
707
740
|
* Media ID in Wix Media Manager.
|
|
708
741
|
* @minLength 1
|
|
709
742
|
* @maxLength 100
|
|
710
743
|
*/
|
|
711
|
-
|
|
744
|
+
id?: string;
|
|
712
745
|
/**
|
|
713
746
|
* Original filename.
|
|
714
747
|
* @minLength 1
|
|
@@ -718,7 +751,7 @@ interface SecuredMedia {
|
|
|
718
751
|
/** File type. */
|
|
719
752
|
fileType?: FileType;
|
|
720
753
|
}
|
|
721
|
-
declare enum FileType {
|
|
754
|
+
export declare enum FileType {
|
|
722
755
|
UNSPECIFIED = "UNSPECIFIED",
|
|
723
756
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
724
757
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -727,7 +760,7 @@ declare enum FileType {
|
|
|
727
760
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
728
761
|
}
|
|
729
762
|
/** Type of selected payment option for catalog item */
|
|
730
|
-
declare enum PaymentOptionType {
|
|
763
|
+
export declare enum PaymentOptionType {
|
|
731
764
|
/** The entire payment for this item happens as part of the checkout. */
|
|
732
765
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
733
766
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -739,7 +772,7 @@ declare enum PaymentOptionType {
|
|
|
739
772
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
740
773
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
741
774
|
}
|
|
742
|
-
interface ServiceProperties {
|
|
775
|
+
export interface ServiceProperties {
|
|
743
776
|
/**
|
|
744
777
|
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
745
778
|
* For example, the start time of a class.
|
|
@@ -752,7 +785,7 @@ interface ServiceProperties {
|
|
|
752
785
|
*/
|
|
753
786
|
numberOfParticipants?: number | null;
|
|
754
787
|
}
|
|
755
|
-
interface PriceDescription {
|
|
788
|
+
export interface PriceDescription {
|
|
756
789
|
/**
|
|
757
790
|
* __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
758
791
|
* @minLength 1
|
|
@@ -768,7 +801,7 @@ interface PriceDescription {
|
|
|
768
801
|
*/
|
|
769
802
|
translated?: string | null;
|
|
770
803
|
}
|
|
771
|
-
interface CatalogOverrideFields {
|
|
804
|
+
export interface CatalogOverrideFields {
|
|
772
805
|
/** Item name. */
|
|
773
806
|
productName?: ProductName;
|
|
774
807
|
/**
|
|
@@ -789,7 +822,7 @@ interface CatalogOverrideFields {
|
|
|
789
822
|
/** Physical properties of the item. */
|
|
790
823
|
physicalProperties?: PhysicalProperties;
|
|
791
824
|
/** Item image. */
|
|
792
|
-
image?:
|
|
825
|
+
image?: Image;
|
|
793
826
|
/** Payment method selected for the item. */
|
|
794
827
|
paymentOption?: PaymentOption;
|
|
795
828
|
/**
|
|
@@ -805,7 +838,19 @@ interface CatalogOverrideFields {
|
|
|
805
838
|
*/
|
|
806
839
|
savePaymentMethod?: boolean | null;
|
|
807
840
|
}
|
|
808
|
-
interface
|
|
841
|
+
export interface Image {
|
|
842
|
+
/** WixMedia image ID. */
|
|
843
|
+
id?: string;
|
|
844
|
+
/** Original image height. */
|
|
845
|
+
height?: number;
|
|
846
|
+
/** Original image width. */
|
|
847
|
+
width?: number;
|
|
848
|
+
/** Image alt text. Optional. */
|
|
849
|
+
altText?: string | null;
|
|
850
|
+
/** Image filename. Optional. */
|
|
851
|
+
filename?: string | null;
|
|
852
|
+
}
|
|
853
|
+
export interface PaymentOption {
|
|
809
854
|
/**
|
|
810
855
|
* Type of selected payment option for current item.
|
|
811
856
|
*
|
|
@@ -813,22 +858,22 @@ interface PaymentOption {
|
|
|
813
858
|
*/
|
|
814
859
|
value?: PaymentOptionType;
|
|
815
860
|
}
|
|
816
|
-
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
861
|
+
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
817
862
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
818
863
|
addressType?: TaxableAddressType;
|
|
819
864
|
}
|
|
820
865
|
/** @oneof */
|
|
821
|
-
interface TaxableAddressTaxableAddressDataOneOf {
|
|
866
|
+
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
822
867
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
823
868
|
addressType?: TaxableAddressType;
|
|
824
869
|
}
|
|
825
|
-
declare enum TaxableAddressType {
|
|
870
|
+
export declare enum TaxableAddressType {
|
|
826
871
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
827
872
|
BUSINESS = "BUSINESS",
|
|
828
873
|
BILLING = "BILLING",
|
|
829
874
|
SHIPPING = "SHIPPING"
|
|
830
875
|
}
|
|
831
|
-
interface ExtendedFields {
|
|
876
|
+
export interface ExtendedFields {
|
|
832
877
|
/**
|
|
833
878
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
834
879
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -839,7 +884,7 @@ interface ExtendedFields {
|
|
|
839
884
|
*/
|
|
840
885
|
namespaces?: Record<string, Record<string, any>>;
|
|
841
886
|
}
|
|
842
|
-
interface Policy {
|
|
887
|
+
export interface Policy {
|
|
843
888
|
/**
|
|
844
889
|
* Policy title - should be translated
|
|
845
890
|
* @minLength 1
|
|
@@ -853,13 +898,13 @@ interface Policy {
|
|
|
853
898
|
*/
|
|
854
899
|
content?: string;
|
|
855
900
|
}
|
|
856
|
-
interface ModifierGroup {
|
|
901
|
+
export interface ModifierGroup {
|
|
857
902
|
/**
|
|
858
903
|
* Modifier group id.
|
|
859
904
|
* @minLength 1
|
|
860
905
|
* @maxLength 36
|
|
861
906
|
*/
|
|
862
|
-
|
|
907
|
+
id?: string;
|
|
863
908
|
/** Modifier group name. */
|
|
864
909
|
name?: TranslatableString;
|
|
865
910
|
/**
|
|
@@ -869,7 +914,7 @@ interface ModifierGroup {
|
|
|
869
914
|
*/
|
|
870
915
|
modifiers?: ItemModifier[];
|
|
871
916
|
}
|
|
872
|
-
interface TranslatableString {
|
|
917
|
+
export interface TranslatableString {
|
|
873
918
|
/**
|
|
874
919
|
* __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
875
920
|
*
|
|
@@ -890,13 +935,13 @@ interface TranslatableString {
|
|
|
890
935
|
*/
|
|
891
936
|
translated?: string | null;
|
|
892
937
|
}
|
|
893
|
-
interface ItemModifier {
|
|
938
|
+
export interface ItemModifier {
|
|
894
939
|
/**
|
|
895
940
|
* Modifier ID.
|
|
896
941
|
* @minLength 1
|
|
897
942
|
* @maxLength 36
|
|
898
943
|
*/
|
|
899
|
-
|
|
944
|
+
id?: string;
|
|
900
945
|
/**
|
|
901
946
|
* The quantity of this modifier.
|
|
902
947
|
* @min 1
|
|
@@ -911,14 +956,14 @@ interface ItemModifier {
|
|
|
911
956
|
price?: MultiCurrencyPrice;
|
|
912
957
|
}
|
|
913
958
|
/** Billing Info and shipping details */
|
|
914
|
-
interface AddressWithContact {
|
|
959
|
+
export interface AddressWithContact {
|
|
915
960
|
/** Address. */
|
|
916
961
|
address?: ApiAddress;
|
|
917
962
|
/** Contact details. */
|
|
918
963
|
contactDetails?: FullAddressContactDetails;
|
|
919
964
|
}
|
|
920
965
|
/** Physical address */
|
|
921
|
-
interface ApiAddress {
|
|
966
|
+
export interface ApiAddress {
|
|
922
967
|
/**
|
|
923
968
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
924
969
|
* @format COUNTRY
|
|
@@ -945,7 +990,7 @@ interface ApiAddress {
|
|
|
945
990
|
* Main address line (usually street name and number).
|
|
946
991
|
* @maxLength 150
|
|
947
992
|
*/
|
|
948
|
-
|
|
993
|
+
addressLine?: string | null;
|
|
949
994
|
/**
|
|
950
995
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
951
996
|
* @maxLength 100
|
|
@@ -962,20 +1007,20 @@ interface ApiAddress {
|
|
|
962
1007
|
*/
|
|
963
1008
|
subdivisionFullname?: string | null;
|
|
964
1009
|
}
|
|
965
|
-
interface StreetAddress {
|
|
1010
|
+
export interface StreetAddress {
|
|
966
1011
|
/** Street number. */
|
|
967
1012
|
number?: string;
|
|
968
1013
|
/** Street name. */
|
|
969
1014
|
name?: string;
|
|
970
1015
|
}
|
|
971
|
-
interface AddressLocation {
|
|
1016
|
+
export interface AddressLocation {
|
|
972
1017
|
/** Address latitude. */
|
|
973
1018
|
latitude?: number | null;
|
|
974
1019
|
/** Address longitude. */
|
|
975
1020
|
longitude?: number | null;
|
|
976
1021
|
}
|
|
977
1022
|
/** Full contact details for an address */
|
|
978
|
-
interface FullAddressContactDetails {
|
|
1023
|
+
export interface FullAddressContactDetails {
|
|
979
1024
|
/**
|
|
980
1025
|
* First name.
|
|
981
1026
|
* @maxLength 100
|
|
@@ -999,9 +1044,9 @@ interface FullAddressContactDetails {
|
|
|
999
1044
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1000
1045
|
vatId?: CommonVatId;
|
|
1001
1046
|
}
|
|
1002
|
-
interface CommonVatId {
|
|
1047
|
+
export interface CommonVatId {
|
|
1003
1048
|
/** Customer's tax ID. */
|
|
1004
|
-
|
|
1049
|
+
id?: string;
|
|
1005
1050
|
/**
|
|
1006
1051
|
* Tax type.
|
|
1007
1052
|
*
|
|
@@ -1012,14 +1057,14 @@ interface CommonVatId {
|
|
|
1012
1057
|
type?: CommonVatType;
|
|
1013
1058
|
}
|
|
1014
1059
|
/** tax info types */
|
|
1015
|
-
declare enum CommonVatType {
|
|
1060
|
+
export declare enum CommonVatType {
|
|
1016
1061
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1017
1062
|
/** CPF - for individual tax payers. */
|
|
1018
1063
|
CPF = "CPF",
|
|
1019
1064
|
/** CNPJ - for corporations */
|
|
1020
1065
|
CNPJ = "CNPJ"
|
|
1021
1066
|
}
|
|
1022
|
-
interface ShippingInfo {
|
|
1067
|
+
export interface ShippingInfo {
|
|
1023
1068
|
/** Shipping address and contact details. */
|
|
1024
1069
|
shippingDestination?: AddressWithContact;
|
|
1025
1070
|
/** Selected option out of the options allowed for the `region`. */
|
|
@@ -1035,7 +1080,7 @@ interface ShippingInfo {
|
|
|
1035
1080
|
*/
|
|
1036
1081
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
1037
1082
|
}
|
|
1038
|
-
interface SelectedCarrierServiceOption {
|
|
1083
|
+
export interface SelectedCarrierServiceOption {
|
|
1039
1084
|
/**
|
|
1040
1085
|
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1041
1086
|
* @maxLength 100
|
|
@@ -1078,7 +1123,7 @@ interface SelectedCarrierServiceOption {
|
|
|
1078
1123
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1079
1124
|
partial?: boolean | null;
|
|
1080
1125
|
}
|
|
1081
|
-
interface DeliveryLogistics {
|
|
1126
|
+
export interface DeliveryLogistics {
|
|
1082
1127
|
/**
|
|
1083
1128
|
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1084
1129
|
* @maxLength 500
|
|
@@ -1092,7 +1137,7 @@ interface DeliveryLogistics {
|
|
|
1092
1137
|
/** Pickup details. */
|
|
1093
1138
|
pickupDetails?: PickupDetails;
|
|
1094
1139
|
}
|
|
1095
|
-
interface PickupDetails {
|
|
1140
|
+
export interface PickupDetails {
|
|
1096
1141
|
/** Pickup address. */
|
|
1097
1142
|
address?: ApiAddress;
|
|
1098
1143
|
/**
|
|
@@ -1103,18 +1148,18 @@ interface PickupDetails {
|
|
|
1103
1148
|
/** Pickup method */
|
|
1104
1149
|
pickupMethod?: PickupMethod;
|
|
1105
1150
|
}
|
|
1106
|
-
declare enum PickupMethod {
|
|
1151
|
+
export declare enum PickupMethod {
|
|
1107
1152
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1108
1153
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1109
1154
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1110
1155
|
}
|
|
1111
|
-
interface DeliveryTimeSlot {
|
|
1156
|
+
export interface DeliveryTimeSlot {
|
|
1112
1157
|
/** starting time of the delivery time slot */
|
|
1113
1158
|
from?: Date | null;
|
|
1114
1159
|
/** ending time of the delivery time slot */
|
|
1115
1160
|
to?: Date | null;
|
|
1116
1161
|
}
|
|
1117
|
-
interface SelectedCarrierServiceOptionPrices {
|
|
1162
|
+
export interface SelectedCarrierServiceOptionPrices {
|
|
1118
1163
|
/** Total shipping price, after discount and after tax. */
|
|
1119
1164
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1120
1165
|
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
@@ -1126,7 +1171,7 @@ interface SelectedCarrierServiceOptionPrices {
|
|
|
1126
1171
|
/** Shipping price before discount and before tax. */
|
|
1127
1172
|
price?: MultiCurrencyPrice;
|
|
1128
1173
|
}
|
|
1129
|
-
interface SelectedCarrierServiceOptionOtherCharge {
|
|
1174
|
+
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1130
1175
|
/** Type of additional cost. */
|
|
1131
1176
|
type?: ChargeType;
|
|
1132
1177
|
/**
|
|
@@ -1137,11 +1182,11 @@ interface SelectedCarrierServiceOptionOtherCharge {
|
|
|
1137
1182
|
/** Price of added charge. */
|
|
1138
1183
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
1139
1184
|
}
|
|
1140
|
-
declare enum ChargeType {
|
|
1185
|
+
export declare enum ChargeType {
|
|
1141
1186
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1142
1187
|
INSURANCE = "INSURANCE"
|
|
1143
1188
|
}
|
|
1144
|
-
interface DeliveryAllocation {
|
|
1189
|
+
export interface DeliveryAllocation {
|
|
1145
1190
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1146
1191
|
deliveryCarrier?: Carrier;
|
|
1147
1192
|
/** The delivery region that are relevant for this delivery solution. */
|
|
@@ -1149,7 +1194,7 @@ interface DeliveryAllocation {
|
|
|
1149
1194
|
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
1150
1195
|
applicableLineItems?: ApplicableLineItems;
|
|
1151
1196
|
}
|
|
1152
|
-
interface Carrier {
|
|
1197
|
+
export interface Carrier {
|
|
1153
1198
|
/**
|
|
1154
1199
|
* The carrier app id
|
|
1155
1200
|
* @format GUID
|
|
@@ -1161,19 +1206,19 @@ interface Carrier {
|
|
|
1161
1206
|
*/
|
|
1162
1207
|
code?: string;
|
|
1163
1208
|
}
|
|
1164
|
-
interface Region {
|
|
1209
|
+
export interface Region {
|
|
1165
1210
|
/**
|
|
1166
1211
|
* The delivery region id.
|
|
1167
1212
|
* @format GUID
|
|
1168
1213
|
*/
|
|
1169
|
-
|
|
1214
|
+
id?: string | null;
|
|
1170
1215
|
/**
|
|
1171
1216
|
* The delivery region name.
|
|
1172
1217
|
* @maxLength 100
|
|
1173
1218
|
*/
|
|
1174
1219
|
name?: string | null;
|
|
1175
1220
|
}
|
|
1176
|
-
interface ApplicableLineItems {
|
|
1221
|
+
export interface ApplicableLineItems {
|
|
1177
1222
|
/**
|
|
1178
1223
|
* Line items that the delivery solution is for.
|
|
1179
1224
|
* @maxSize 300
|
|
@@ -1182,20 +1227,20 @@ interface ApplicableLineItems {
|
|
|
1182
1227
|
*/
|
|
1183
1228
|
lineItemIds?: string[];
|
|
1184
1229
|
}
|
|
1185
|
-
interface ShippingRegion {
|
|
1230
|
+
export interface ShippingRegion {
|
|
1186
1231
|
/**
|
|
1187
1232
|
* Shipping region ID.
|
|
1188
1233
|
* @format GUID
|
|
1189
1234
|
* @readonly
|
|
1190
1235
|
*/
|
|
1191
|
-
|
|
1236
|
+
id?: string;
|
|
1192
1237
|
/**
|
|
1193
1238
|
* Shipping region name.
|
|
1194
1239
|
* @maxLength 100
|
|
1195
1240
|
*/
|
|
1196
1241
|
name?: string;
|
|
1197
1242
|
}
|
|
1198
|
-
interface CarrierServiceOption {
|
|
1243
|
+
export interface CarrierServiceOption {
|
|
1199
1244
|
/**
|
|
1200
1245
|
* Carrier ID.
|
|
1201
1246
|
* @format GUID
|
|
@@ -1204,7 +1249,7 @@ interface CarrierServiceOption {
|
|
|
1204
1249
|
/** Shipping options offered by this carrier for this request. */
|
|
1205
1250
|
shippingOptions?: ShippingOption[];
|
|
1206
1251
|
}
|
|
1207
|
-
interface ShippingOption {
|
|
1252
|
+
export interface ShippingOption {
|
|
1208
1253
|
/**
|
|
1209
1254
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1210
1255
|
* For legacy calculators this would be the UUID of the option.
|
|
@@ -1229,33 +1274,33 @@ interface ShippingOption {
|
|
|
1229
1274
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1230
1275
|
partial?: boolean | null;
|
|
1231
1276
|
}
|
|
1232
|
-
interface ShippingPrice {
|
|
1277
|
+
export interface ShippingPrice {
|
|
1233
1278
|
/** Shipping price. */
|
|
1234
1279
|
price?: MultiCurrencyPrice;
|
|
1235
1280
|
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
1236
1281
|
otherCharges?: OtherCharge[];
|
|
1237
1282
|
}
|
|
1238
|
-
interface OtherCharge {
|
|
1283
|
+
export interface OtherCharge {
|
|
1239
1284
|
/** Type of additional cost. */
|
|
1240
1285
|
type?: ChargeType;
|
|
1241
1286
|
/** Price of added cost. */
|
|
1242
1287
|
price?: MultiCurrencyPrice;
|
|
1243
1288
|
}
|
|
1244
|
-
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1289
|
+
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1245
1290
|
/**
|
|
1246
|
-
* Visitor ID
|
|
1291
|
+
* Visitor ID (if site visitor is **not** a member).
|
|
1247
1292
|
* @format GUID
|
|
1248
1293
|
* @readonly
|
|
1249
1294
|
*/
|
|
1250
1295
|
visitorId?: string;
|
|
1251
1296
|
/**
|
|
1252
|
-
* Member ID
|
|
1297
|
+
* Member ID (if site visitor is a site member).
|
|
1253
1298
|
* @format GUID
|
|
1254
1299
|
* @readonly
|
|
1255
1300
|
*/
|
|
1256
1301
|
memberId?: string;
|
|
1257
1302
|
/**
|
|
1258
|
-
* Contact ID. For more information, see the Contacts API.
|
|
1303
|
+
* Contact ID. Auto-created if one does not yet exist. For more information, see the Contacts API.
|
|
1259
1304
|
* @format GUID
|
|
1260
1305
|
* @readonly
|
|
1261
1306
|
*/
|
|
@@ -1267,21 +1312,21 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1267
1312
|
email?: string | null;
|
|
1268
1313
|
}
|
|
1269
1314
|
/** @oneof */
|
|
1270
|
-
interface BuyerInfoIdOneOf {
|
|
1315
|
+
export interface BuyerInfoIdOneOf {
|
|
1271
1316
|
/**
|
|
1272
|
-
* Visitor ID
|
|
1317
|
+
* Visitor ID (if site visitor is **not** a member).
|
|
1273
1318
|
* @format GUID
|
|
1274
1319
|
* @readonly
|
|
1275
1320
|
*/
|
|
1276
1321
|
visitorId?: string;
|
|
1277
1322
|
/**
|
|
1278
|
-
* Member ID
|
|
1323
|
+
* Member ID (if site visitor is a site member).
|
|
1279
1324
|
* @format GUID
|
|
1280
1325
|
* @readonly
|
|
1281
1326
|
*/
|
|
1282
1327
|
memberId?: string;
|
|
1283
1328
|
}
|
|
1284
|
-
interface PriceSummary {
|
|
1329
|
+
export interface PriceSummary {
|
|
1285
1330
|
/** Subtotal of all line items, before discounts and before tax. */
|
|
1286
1331
|
subtotal?: MultiCurrencyPrice;
|
|
1287
1332
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1295,7 +1340,7 @@ interface PriceSummary {
|
|
|
1295
1340
|
/** Total additional fees price before tax. */
|
|
1296
1341
|
additionalFees?: MultiCurrencyPrice;
|
|
1297
1342
|
}
|
|
1298
|
-
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1343
|
+
export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1299
1344
|
/** General shipping calculation error. */
|
|
1300
1345
|
generalShippingCalculationError?: Details;
|
|
1301
1346
|
/** Carrier errors. */
|
|
@@ -1317,13 +1362,13 @@ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOne
|
|
|
1317
1362
|
discountsCalculationError?: Details;
|
|
1318
1363
|
}
|
|
1319
1364
|
/** @oneof */
|
|
1320
|
-
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1365
|
+
export interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1321
1366
|
/** General shipping calculation error. */
|
|
1322
1367
|
generalShippingCalculationError?: Details;
|
|
1323
1368
|
/** Carrier errors. */
|
|
1324
1369
|
carrierErrors?: CarrierErrors;
|
|
1325
1370
|
}
|
|
1326
|
-
interface Details extends DetailsKindOneOf {
|
|
1371
|
+
export interface Details extends DetailsKindOneOf {
|
|
1327
1372
|
applicationError?: ApplicationError;
|
|
1328
1373
|
validationError?: ValidationError;
|
|
1329
1374
|
systemError?: SystemError;
|
|
@@ -1334,12 +1379,12 @@ interface Details extends DetailsKindOneOf {
|
|
|
1334
1379
|
tracing?: Record<string, string>;
|
|
1335
1380
|
}
|
|
1336
1381
|
/** @oneof */
|
|
1337
|
-
interface DetailsKindOneOf {
|
|
1382
|
+
export interface DetailsKindOneOf {
|
|
1338
1383
|
applicationError?: ApplicationError;
|
|
1339
1384
|
validationError?: ValidationError;
|
|
1340
1385
|
systemError?: SystemError;
|
|
1341
1386
|
}
|
|
1342
|
-
interface ApplicationError {
|
|
1387
|
+
export interface ApplicationError {
|
|
1343
1388
|
/** Error code. */
|
|
1344
1389
|
code?: string;
|
|
1345
1390
|
/** Description of the error. */
|
|
@@ -1379,10 +1424,10 @@ interface ApplicationError {
|
|
|
1379
1424
|
* ]
|
|
1380
1425
|
* }
|
|
1381
1426
|
*/
|
|
1382
|
-
interface ValidationError {
|
|
1427
|
+
export interface ValidationError {
|
|
1383
1428
|
fieldViolations?: FieldViolation[];
|
|
1384
1429
|
}
|
|
1385
|
-
declare enum RuleType {
|
|
1430
|
+
export declare enum RuleType {
|
|
1386
1431
|
VALIDATION = "VALIDATION",
|
|
1387
1432
|
OTHER = "OTHER",
|
|
1388
1433
|
MAX = "MAX",
|
|
@@ -1405,7 +1450,7 @@ declare enum RuleType {
|
|
|
1405
1450
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1406
1451
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1407
1452
|
}
|
|
1408
|
-
interface FieldViolation {
|
|
1453
|
+
export interface FieldViolation {
|
|
1409
1454
|
field?: string;
|
|
1410
1455
|
description?: string;
|
|
1411
1456
|
violatedRule?: RuleType;
|
|
@@ -1413,26 +1458,26 @@ interface FieldViolation {
|
|
|
1413
1458
|
ruleName?: string | null;
|
|
1414
1459
|
data?: Record<string, any> | null;
|
|
1415
1460
|
}
|
|
1416
|
-
interface SystemError {
|
|
1461
|
+
export interface SystemError {
|
|
1417
1462
|
/** Error code. */
|
|
1418
1463
|
errorCode?: string | null;
|
|
1419
1464
|
}
|
|
1420
|
-
interface CarrierErrors {
|
|
1465
|
+
export interface CarrierErrors {
|
|
1421
1466
|
/** Carrier errors. */
|
|
1422
1467
|
errors?: CarrierError[];
|
|
1423
1468
|
}
|
|
1424
|
-
interface CarrierError {
|
|
1469
|
+
export interface CarrierError {
|
|
1425
1470
|
/** Carrier ID. */
|
|
1426
1471
|
carrierId?: string;
|
|
1427
1472
|
/** Error details. */
|
|
1428
1473
|
error?: Details;
|
|
1429
1474
|
}
|
|
1430
|
-
interface GiftCard {
|
|
1475
|
+
export interface GiftCard {
|
|
1431
1476
|
/**
|
|
1432
1477
|
* Gift Card ID.
|
|
1433
1478
|
* @deprecated
|
|
1434
1479
|
*/
|
|
1435
|
-
|
|
1480
|
+
id?: string;
|
|
1436
1481
|
/** Gift card obfuscated code. */
|
|
1437
1482
|
obfuscatedCode?: string;
|
|
1438
1483
|
/** Gift card value. */
|
|
@@ -1450,7 +1495,7 @@ interface GiftCard {
|
|
|
1450
1495
|
*/
|
|
1451
1496
|
externalId?: string | null;
|
|
1452
1497
|
}
|
|
1453
|
-
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1498
|
+
export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1454
1499
|
/** Coupon details. */
|
|
1455
1500
|
coupon?: Coupon;
|
|
1456
1501
|
/** Merchant discount. */
|
|
@@ -1460,7 +1505,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1460
1505
|
/** Discount type. */
|
|
1461
1506
|
discountType?: DiscountType;
|
|
1462
1507
|
/**
|
|
1463
|
-
* IDs of
|
|
1508
|
+
* IDs of line items the discount applies to.
|
|
1464
1509
|
* @format GUID
|
|
1465
1510
|
* @deprecated IDs of line items the discount applies to.
|
|
1466
1511
|
* @replacedBy line_items_discounts
|
|
@@ -1469,7 +1514,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1469
1514
|
lineItemIds?: string[];
|
|
1470
1515
|
}
|
|
1471
1516
|
/** @oneof */
|
|
1472
|
-
interface AppliedDiscountDiscountSourceOneOf {
|
|
1517
|
+
export interface AppliedDiscountDiscountSourceOneOf {
|
|
1473
1518
|
/** Coupon details. */
|
|
1474
1519
|
coupon?: Coupon;
|
|
1475
1520
|
/** Merchant discount. */
|
|
@@ -1477,15 +1522,15 @@ interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1477
1522
|
/** Discount rule */
|
|
1478
1523
|
discountRule?: DiscountRule;
|
|
1479
1524
|
}
|
|
1480
|
-
declare enum DiscountType {
|
|
1525
|
+
export declare enum DiscountType {
|
|
1481
1526
|
GLOBAL = "GLOBAL",
|
|
1482
1527
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1483
1528
|
SHIPPING = "SHIPPING"
|
|
1484
1529
|
}
|
|
1485
1530
|
/** Coupon */
|
|
1486
|
-
interface Coupon {
|
|
1531
|
+
export interface Coupon {
|
|
1487
1532
|
/** Coupon ID. */
|
|
1488
|
-
|
|
1533
|
+
id?: string;
|
|
1489
1534
|
/** Coupon code. */
|
|
1490
1535
|
code?: string;
|
|
1491
1536
|
/** Coupon value. */
|
|
@@ -1493,7 +1538,7 @@ interface Coupon {
|
|
|
1493
1538
|
/** Coupon name. */
|
|
1494
1539
|
name?: string;
|
|
1495
1540
|
}
|
|
1496
|
-
interface MerchantDiscount {
|
|
1541
|
+
export interface MerchantDiscount {
|
|
1497
1542
|
/** Discount value. */
|
|
1498
1543
|
amount?: MultiCurrencyPrice;
|
|
1499
1544
|
/**
|
|
@@ -1503,18 +1548,18 @@ interface MerchantDiscount {
|
|
|
1503
1548
|
*/
|
|
1504
1549
|
percentage?: number | null;
|
|
1505
1550
|
}
|
|
1506
|
-
interface DiscountRule {
|
|
1551
|
+
export interface DiscountRule {
|
|
1507
1552
|
/**
|
|
1508
1553
|
* Discount rule ID
|
|
1509
1554
|
* @format GUID
|
|
1510
1555
|
*/
|
|
1511
|
-
|
|
1556
|
+
id?: string;
|
|
1512
1557
|
/** Discount rule name */
|
|
1513
1558
|
name?: DiscountRuleName;
|
|
1514
1559
|
/** Discount value. */
|
|
1515
1560
|
amount?: MultiCurrencyPrice;
|
|
1516
1561
|
}
|
|
1517
|
-
interface DiscountRuleName {
|
|
1562
|
+
export interface DiscountRuleName {
|
|
1518
1563
|
/**
|
|
1519
1564
|
* Original discount rule name (in site's default language).
|
|
1520
1565
|
* @minLength 1
|
|
@@ -1528,16 +1573,16 @@ interface DiscountRuleName {
|
|
|
1528
1573
|
*/
|
|
1529
1574
|
translated?: string | null;
|
|
1530
1575
|
}
|
|
1531
|
-
interface LineItemDiscount {
|
|
1576
|
+
export interface LineItemDiscount {
|
|
1532
1577
|
/**
|
|
1533
1578
|
* ID of line item the discount applies to.
|
|
1534
1579
|
* @format GUID
|
|
1535
1580
|
*/
|
|
1536
|
-
|
|
1581
|
+
id?: string;
|
|
1537
1582
|
/** Discount value. */
|
|
1538
1583
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
1539
1584
|
}
|
|
1540
|
-
interface CustomField {
|
|
1585
|
+
export interface CustomField {
|
|
1541
1586
|
/** Custom field value. */
|
|
1542
1587
|
value?: any;
|
|
1543
1588
|
/**
|
|
@@ -1553,7 +1598,7 @@ interface CustomField {
|
|
|
1553
1598
|
*/
|
|
1554
1599
|
translatedTitle?: string | null;
|
|
1555
1600
|
}
|
|
1556
|
-
declare enum WeightUnit {
|
|
1601
|
+
export declare enum WeightUnit {
|
|
1557
1602
|
/** Weight unit can't be classified due to an error. */
|
|
1558
1603
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1559
1604
|
/** Kilograms. */
|
|
@@ -1561,7 +1606,7 @@ declare enum WeightUnit {
|
|
|
1561
1606
|
/** Pounds. */
|
|
1562
1607
|
LB = "LB"
|
|
1563
1608
|
}
|
|
1564
|
-
interface TaxSummary {
|
|
1609
|
+
export interface TaxSummary {
|
|
1565
1610
|
/**
|
|
1566
1611
|
* Amount for which tax is calculated, added from line items.
|
|
1567
1612
|
* @readonly
|
|
@@ -1578,7 +1623,7 @@ interface TaxSummary {
|
|
|
1578
1623
|
*/
|
|
1579
1624
|
calculationDetails?: TaxCalculationDetails;
|
|
1580
1625
|
}
|
|
1581
|
-
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1626
|
+
export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1582
1627
|
/** Reason the manual calculation was used. */
|
|
1583
1628
|
manualRateReason?: ManualCalculationReason;
|
|
1584
1629
|
/** Details of the fallback rate calculation. */
|
|
@@ -1587,13 +1632,13 @@ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsO
|
|
|
1587
1632
|
rateType?: RateType;
|
|
1588
1633
|
}
|
|
1589
1634
|
/** @oneof */
|
|
1590
|
-
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1635
|
+
export interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1591
1636
|
/** Reason the manual calculation was used. */
|
|
1592
1637
|
manualRateReason?: ManualCalculationReason;
|
|
1593
1638
|
/** Details of the fallback rate calculation. */
|
|
1594
1639
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1595
1640
|
}
|
|
1596
|
-
declare enum RateType {
|
|
1641
|
+
export declare enum RateType {
|
|
1597
1642
|
/** no tax being collected for this request due to location of purchase */
|
|
1598
1643
|
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
1599
1644
|
/** manual rate used for calculation */
|
|
@@ -1603,19 +1648,19 @@ declare enum RateType {
|
|
|
1603
1648
|
/** fallback rate used for calculation */
|
|
1604
1649
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1605
1650
|
}
|
|
1606
|
-
declare enum ManualCalculationReason {
|
|
1651
|
+
export declare enum ManualCalculationReason {
|
|
1607
1652
|
/** user set calculator in Business Manager to be Manual */
|
|
1608
1653
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1609
1654
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1610
1655
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1611
1656
|
}
|
|
1612
|
-
interface AutoTaxFallbackCalculationDetails {
|
|
1657
|
+
export interface AutoTaxFallbackCalculationDetails {
|
|
1613
1658
|
/** reason for fallback */
|
|
1614
1659
|
fallbackReason?: FallbackReason;
|
|
1615
1660
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1616
1661
|
error?: ApplicationError;
|
|
1617
1662
|
}
|
|
1618
|
-
declare enum FallbackReason {
|
|
1663
|
+
export declare enum FallbackReason {
|
|
1619
1664
|
/** auto-tax failed to be calculated */
|
|
1620
1665
|
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
1621
1666
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
@@ -1625,7 +1670,7 @@ declare enum FallbackReason {
|
|
|
1625
1670
|
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
1626
1671
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1627
1672
|
*/
|
|
1628
|
-
interface AggregatedTaxBreakdown {
|
|
1673
|
+
export interface AggregatedTaxBreakdown {
|
|
1629
1674
|
/**
|
|
1630
1675
|
* The name of the tax against which this tax amount was calculated.
|
|
1631
1676
|
* @maxLength 200
|
|
@@ -1651,7 +1696,7 @@ interface AggregatedTaxBreakdown {
|
|
|
1651
1696
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1652
1697
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
1653
1698
|
}
|
|
1654
|
-
declare enum ChannelType {
|
|
1699
|
+
export declare enum ChannelType {
|
|
1655
1700
|
/** Unspecified sales channel. This value is not supported. */
|
|
1656
1701
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1657
1702
|
/** A web client. */
|
|
@@ -1685,7 +1730,7 @@ declare enum ChannelType {
|
|
|
1685
1730
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1686
1731
|
FAIRE_COM = "FAIRE_COM"
|
|
1687
1732
|
}
|
|
1688
|
-
interface CreatedBy extends CreatedByIdOneOf {
|
|
1733
|
+
export interface CreatedBy extends CreatedByIdOneOf {
|
|
1689
1734
|
/**
|
|
1690
1735
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1691
1736
|
* For example, via POS (point of service).
|
|
@@ -1709,7 +1754,7 @@ interface CreatedBy extends CreatedByIdOneOf {
|
|
|
1709
1754
|
appId?: string;
|
|
1710
1755
|
}
|
|
1711
1756
|
/** @oneof */
|
|
1712
|
-
interface CreatedByIdOneOf {
|
|
1757
|
+
export interface CreatedByIdOneOf {
|
|
1713
1758
|
/**
|
|
1714
1759
|
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1715
1760
|
* For example, via POS (point of service).
|
|
@@ -1733,7 +1778,7 @@ interface CreatedByIdOneOf {
|
|
|
1733
1778
|
appId?: string;
|
|
1734
1779
|
}
|
|
1735
1780
|
/** Reserved for internal use. */
|
|
1736
|
-
interface MembershipOptions {
|
|
1781
|
+
export interface MembershipOptions {
|
|
1737
1782
|
/**
|
|
1738
1783
|
* Reserved for internal use.
|
|
1739
1784
|
* @readonly
|
|
@@ -1749,13 +1794,13 @@ interface MembershipOptions {
|
|
|
1749
1794
|
/** Selected membership to apply to this checkout. */
|
|
1750
1795
|
selectedMemberships?: SelectedMemberships;
|
|
1751
1796
|
}
|
|
1752
|
-
interface Membership {
|
|
1797
|
+
export interface Membership {
|
|
1753
1798
|
/**
|
|
1754
1799
|
* Membership ID.
|
|
1755
1800
|
* @minLength 1
|
|
1756
1801
|
* @maxLength 100
|
|
1757
1802
|
*/
|
|
1758
|
-
|
|
1803
|
+
id?: string;
|
|
1759
1804
|
/**
|
|
1760
1805
|
* ID of the application providing this payment option.
|
|
1761
1806
|
* @format GUID
|
|
@@ -1764,7 +1809,7 @@ interface Membership {
|
|
|
1764
1809
|
/** The name of this membership. */
|
|
1765
1810
|
name?: MembershipName;
|
|
1766
1811
|
/**
|
|
1767
|
-
* Line item IDs which are "paid for
|
|
1812
|
+
* Line item IDs which are "paid" for by this membership.
|
|
1768
1813
|
* @minSize 1
|
|
1769
1814
|
* @maxSize 300
|
|
1770
1815
|
* @minLength 1
|
|
@@ -1778,7 +1823,7 @@ interface Membership {
|
|
|
1778
1823
|
/** Additional data about this membership. */
|
|
1779
1824
|
additionalData?: Record<string, any> | null;
|
|
1780
1825
|
}
|
|
1781
|
-
interface MembershipName {
|
|
1826
|
+
export interface MembershipName {
|
|
1782
1827
|
/**
|
|
1783
1828
|
* Membership name.
|
|
1784
1829
|
* @maxLength 100
|
|
@@ -1790,7 +1835,7 @@ interface MembershipName {
|
|
|
1790
1835
|
*/
|
|
1791
1836
|
translated?: string | null;
|
|
1792
1837
|
}
|
|
1793
|
-
interface MembershipPaymentCredits {
|
|
1838
|
+
export interface MembershipPaymentCredits {
|
|
1794
1839
|
/**
|
|
1795
1840
|
* Membership's total amount of credits.
|
|
1796
1841
|
* @min 1
|
|
@@ -1799,7 +1844,7 @@ interface MembershipPaymentCredits {
|
|
|
1799
1844
|
/** Membership's remaining amount of credits. */
|
|
1800
1845
|
remaining?: number;
|
|
1801
1846
|
}
|
|
1802
|
-
interface InvalidMembership {
|
|
1847
|
+
export interface InvalidMembership {
|
|
1803
1848
|
/** Membership details. */
|
|
1804
1849
|
membership?: Membership;
|
|
1805
1850
|
/**
|
|
@@ -1809,20 +1854,20 @@ interface InvalidMembership {
|
|
|
1809
1854
|
*/
|
|
1810
1855
|
reason?: string;
|
|
1811
1856
|
}
|
|
1812
|
-
interface SelectedMemberships {
|
|
1857
|
+
export interface SelectedMemberships {
|
|
1813
1858
|
/**
|
|
1814
1859
|
* Selected memberships.
|
|
1815
1860
|
* @maxSize 300
|
|
1816
1861
|
*/
|
|
1817
1862
|
memberships?: SelectedMembership[];
|
|
1818
1863
|
}
|
|
1819
|
-
interface SelectedMembership {
|
|
1864
|
+
export interface SelectedMembership {
|
|
1820
1865
|
/**
|
|
1821
1866
|
* Membership ID.
|
|
1822
1867
|
* @minLength 1
|
|
1823
1868
|
* @maxLength 100
|
|
1824
1869
|
*/
|
|
1825
|
-
|
|
1870
|
+
id?: string;
|
|
1826
1871
|
/**
|
|
1827
1872
|
* ID of the app providing this payment option.
|
|
1828
1873
|
* @format GUID
|
|
@@ -1837,7 +1882,7 @@ interface SelectedMembership {
|
|
|
1837
1882
|
*/
|
|
1838
1883
|
lineItemIds?: string[];
|
|
1839
1884
|
}
|
|
1840
|
-
interface AdditionalFee {
|
|
1885
|
+
export interface AdditionalFee {
|
|
1841
1886
|
/**
|
|
1842
1887
|
* Additional fee's unique code (or ID) for future processing.
|
|
1843
1888
|
* @minLength 1
|
|
@@ -1873,7 +1918,7 @@ interface AdditionalFee {
|
|
|
1873
1918
|
/** the source the additional fee was added from */
|
|
1874
1919
|
source?: AdditionalFeeSource;
|
|
1875
1920
|
}
|
|
1876
|
-
declare enum AdditionalFeeSource {
|
|
1921
|
+
export declare enum AdditionalFeeSource {
|
|
1877
1922
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
1878
1923
|
/** The additional fee was added by an additional fee service plugin */
|
|
1879
1924
|
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
@@ -1882,7 +1927,7 @@ declare enum AdditionalFeeSource {
|
|
|
1882
1927
|
/** The additional fee was added manually on the request */
|
|
1883
1928
|
MANUAL = "MANUAL"
|
|
1884
1929
|
}
|
|
1885
|
-
interface ConversionInfo {
|
|
1930
|
+
export interface ConversionInfo {
|
|
1886
1931
|
/**
|
|
1887
1932
|
* The site currency.
|
|
1888
1933
|
* @readonly
|
|
@@ -1896,7 +1941,7 @@ interface ConversionInfo {
|
|
|
1896
1941
|
*/
|
|
1897
1942
|
conversionRate?: string;
|
|
1898
1943
|
}
|
|
1899
|
-
interface Violation {
|
|
1944
|
+
export interface Violation {
|
|
1900
1945
|
/** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
|
|
1901
1946
|
severity?: Severity;
|
|
1902
1947
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
@@ -1908,7 +1953,7 @@ interface Violation {
|
|
|
1908
1953
|
*/
|
|
1909
1954
|
description?: string | null;
|
|
1910
1955
|
}
|
|
1911
|
-
declare enum Severity {
|
|
1956
|
+
export declare enum Severity {
|
|
1912
1957
|
/** The user is allowed to move forward in the flow. */
|
|
1913
1958
|
WARNING = "WARNING",
|
|
1914
1959
|
/**
|
|
@@ -1917,48 +1962,48 @@ declare enum Severity {
|
|
|
1917
1962
|
*/
|
|
1918
1963
|
ERROR = "ERROR"
|
|
1919
1964
|
}
|
|
1920
|
-
interface Target extends TargetTargetTypeOneOf {
|
|
1965
|
+
export interface Target extends TargetTargetTypeOneOf {
|
|
1921
1966
|
/** General (other) violation. */
|
|
1922
1967
|
other?: Other;
|
|
1923
1968
|
/** Specific line item violation. */
|
|
1924
1969
|
lineItem?: TargetLineItem;
|
|
1925
1970
|
}
|
|
1926
1971
|
/** @oneof */
|
|
1927
|
-
interface TargetTargetTypeOneOf {
|
|
1972
|
+
export interface TargetTargetTypeOneOf {
|
|
1928
1973
|
/** General (other) violation. */
|
|
1929
1974
|
other?: Other;
|
|
1930
1975
|
/** Specific line item violation. */
|
|
1931
1976
|
lineItem?: TargetLineItem;
|
|
1932
1977
|
}
|
|
1933
1978
|
/** Available locations on the webpage */
|
|
1934
|
-
declare enum NameInOther {
|
|
1979
|
+
export declare enum NameInOther {
|
|
1935
1980
|
/** Default location, in case no specific location is specified. */
|
|
1936
1981
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
1937
1982
|
}
|
|
1938
1983
|
/** Available locations on the line item */
|
|
1939
|
-
declare enum NameInLineItem {
|
|
1984
|
+
export declare enum NameInLineItem {
|
|
1940
1985
|
/** Default location, in case no specific location is specified. */
|
|
1941
1986
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
1942
1987
|
}
|
|
1943
|
-
declare enum SuggestedFix {
|
|
1988
|
+
export declare enum SuggestedFix {
|
|
1944
1989
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
1945
1990
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
1946
1991
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
1947
1992
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
1948
1993
|
}
|
|
1949
1994
|
/** General (other) violation. */
|
|
1950
|
-
interface Other {
|
|
1995
|
+
export interface Other {
|
|
1951
1996
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
1952
1997
|
name?: NameInOther;
|
|
1953
1998
|
}
|
|
1954
1999
|
/** Specific line item violation. */
|
|
1955
|
-
interface TargetLineItem {
|
|
2000
|
+
export interface TargetLineItem {
|
|
1956
2001
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
1957
2002
|
name?: NameInLineItem;
|
|
1958
2003
|
/** ID of the line item containing the violation. */
|
|
1959
|
-
|
|
2004
|
+
id?: string | null;
|
|
1960
2005
|
}
|
|
1961
|
-
interface CustomSettings {
|
|
2006
|
+
export interface CustomSettings {
|
|
1962
2007
|
/**
|
|
1963
2008
|
* Whether to restrict the option to add or remove a gift card on the checkout page.
|
|
1964
2009
|
*
|
|
@@ -1984,7 +2029,7 @@ interface CustomSettings {
|
|
|
1984
2029
|
*/
|
|
1985
2030
|
disabledManualPayment?: boolean;
|
|
1986
2031
|
}
|
|
1987
|
-
interface CustomContentReference {
|
|
2032
|
+
export interface CustomContentReference {
|
|
1988
2033
|
/**
|
|
1989
2034
|
* ID of the app providing the content.
|
|
1990
2035
|
*
|
|
@@ -2000,7 +2045,7 @@ interface CustomContentReference {
|
|
|
2000
2045
|
*/
|
|
2001
2046
|
componentId?: string;
|
|
2002
2047
|
}
|
|
2003
|
-
interface ExternalReference {
|
|
2048
|
+
export interface ExternalReference {
|
|
2004
2049
|
/**
|
|
2005
2050
|
* ID of the app associated with the purchase flow.
|
|
2006
2051
|
* For example, the Wix Pay Links app ID.
|
|
@@ -2017,7 +2062,7 @@ interface ExternalReference {
|
|
|
2017
2062
|
*/
|
|
2018
2063
|
resourceId?: string | null;
|
|
2019
2064
|
}
|
|
2020
|
-
interface SubscriptionCharges {
|
|
2065
|
+
export interface SubscriptionCharges {
|
|
2021
2066
|
/**
|
|
2022
2067
|
* ids of the items the subscription is defined on
|
|
2023
2068
|
* @format GUID
|
|
@@ -2037,7 +2082,7 @@ interface SubscriptionCharges {
|
|
|
2037
2082
|
*/
|
|
2038
2083
|
charges?: Charge[];
|
|
2039
2084
|
}
|
|
2040
|
-
interface Charge {
|
|
2085
|
+
export interface Charge {
|
|
2041
2086
|
/** The cycle number from which the charge starts. */
|
|
2042
2087
|
cycleFrom?: number;
|
|
2043
2088
|
/** The number of cycles for which the charge is applicable. */
|
|
@@ -2047,16 +2092,16 @@ interface Charge {
|
|
|
2047
2092
|
/** The billing date from which the charge starts. */
|
|
2048
2093
|
cycleBillingDate?: Date | null;
|
|
2049
2094
|
}
|
|
2050
|
-
interface UpdatedCheckoutMessage {
|
|
2095
|
+
export interface UpdatedCheckoutMessage {
|
|
2051
2096
|
/** Previous checkout. */
|
|
2052
2097
|
oldCheckout?: Checkout;
|
|
2053
2098
|
/** Updated checkout. */
|
|
2054
2099
|
updatedCheckout?: Checkout;
|
|
2055
2100
|
}
|
|
2056
|
-
interface CreateCheckoutRequest {
|
|
2101
|
+
export interface CreateCheckoutRequest {
|
|
2057
2102
|
/** Checkout information. */
|
|
2058
2103
|
checkoutInfo?: Checkout;
|
|
2059
|
-
/**
|
|
2104
|
+
/** Coupon code. */
|
|
2060
2105
|
couponCode?: string | null;
|
|
2061
2106
|
/**
|
|
2062
2107
|
* Catalog line items to add to the checkout.
|
|
@@ -2084,12 +2129,14 @@ interface CreateCheckoutRequest {
|
|
|
2084
2129
|
/**
|
|
2085
2130
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2086
2131
|
*
|
|
2087
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used
|
|
2132
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
2133
|
+
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2134
|
+
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2088
2135
|
* @maxLength 1000
|
|
2089
2136
|
*/
|
|
2090
2137
|
overrideCheckoutUrl?: string | null;
|
|
2091
2138
|
}
|
|
2092
|
-
interface CustomLineItem {
|
|
2139
|
+
export interface CustomLineItem {
|
|
2093
2140
|
/**
|
|
2094
2141
|
* Custom line item quantity.
|
|
2095
2142
|
*
|
|
@@ -2100,7 +2147,9 @@ interface CustomLineItem {
|
|
|
2100
2147
|
*/
|
|
2101
2148
|
quantity?: number;
|
|
2102
2149
|
/**
|
|
2103
|
-
* Custom line item price.
|
|
2150
|
+
* Custom line item price.
|
|
2151
|
+
*
|
|
2152
|
+
* Must be a number or a decimal without symbols.
|
|
2104
2153
|
* @format DECIMAL_VALUE
|
|
2105
2154
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
2106
2155
|
*/
|
|
@@ -2108,23 +2157,19 @@ interface CustomLineItem {
|
|
|
2108
2157
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
2109
2158
|
priceDescription?: PriceDescription;
|
|
2110
2159
|
/**
|
|
2111
|
-
* Custom line item description lines. Used for
|
|
2160
|
+
* Custom line item description lines. Used for display purposes for the cart, checkout and order.
|
|
2112
2161
|
* @maxSize 10
|
|
2113
2162
|
*/
|
|
2114
2163
|
descriptionLines?: DescriptionLine[];
|
|
2115
|
-
/**
|
|
2116
|
-
|
|
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;
|
|
2164
|
+
/** Custom line item's media. */
|
|
2165
|
+
media?: Image;
|
|
2121
2166
|
/**
|
|
2122
2167
|
* Custom line item ID. If passed, `id` must be unique.
|
|
2123
2168
|
*
|
|
2124
2169
|
* Default: auto-generated ID
|
|
2125
2170
|
* @format GUID
|
|
2126
2171
|
*/
|
|
2127
|
-
|
|
2172
|
+
id?: string | null;
|
|
2128
2173
|
/**
|
|
2129
2174
|
* Tax group ID for this custom line item.
|
|
2130
2175
|
* @format GUID
|
|
@@ -2133,7 +2178,7 @@ interface CustomLineItem {
|
|
|
2133
2178
|
/** Name of the item or product. */
|
|
2134
2179
|
productName?: ProductName;
|
|
2135
2180
|
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
2136
|
-
url?:
|
|
2181
|
+
url?: PageUrlV2;
|
|
2137
2182
|
/** Item type. Either a preset type or custom. */
|
|
2138
2183
|
itemType?: ItemType;
|
|
2139
2184
|
/**
|
|
@@ -2203,98 +2248,104 @@ interface CustomLineItem {
|
|
|
2203
2248
|
*/
|
|
2204
2249
|
savePaymentMethod?: boolean;
|
|
2205
2250
|
}
|
|
2206
|
-
interface MerchantDiscountInput {
|
|
2251
|
+
export interface MerchantDiscountInput {
|
|
2207
2252
|
/**
|
|
2208
2253
|
* Discount amount.
|
|
2209
2254
|
* @decimalValue options { gte:0 }
|
|
2210
2255
|
*/
|
|
2211
2256
|
amount?: string;
|
|
2212
2257
|
/**
|
|
2213
|
-
* IDs of
|
|
2258
|
+
* IDs of line items the discount applies to.
|
|
2214
2259
|
* @format GUID
|
|
2215
2260
|
* @maxSize 300
|
|
2216
2261
|
*/
|
|
2217
2262
|
lineItemIds?: string[];
|
|
2218
2263
|
}
|
|
2219
|
-
interface CreateCheckoutResponse {
|
|
2264
|
+
export interface CreateCheckoutResponse {
|
|
2220
2265
|
/** Newly created checkout. */
|
|
2221
2266
|
checkout?: Checkout;
|
|
2222
2267
|
}
|
|
2223
|
-
interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2268
|
+
export interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2224
2269
|
generalShippingCalculationError?: Details;
|
|
2225
2270
|
carrierErrors?: CarrierErrors;
|
|
2226
2271
|
}
|
|
2227
2272
|
/** @oneof */
|
|
2228
|
-
interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2273
|
+
export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
2229
2274
|
generalShippingCalculationError?: Details;
|
|
2230
2275
|
carrierErrors?: CarrierErrors;
|
|
2231
2276
|
}
|
|
2232
|
-
interface GetCheckoutRequest {
|
|
2277
|
+
export interface GetCheckoutRequest {
|
|
2233
2278
|
/**
|
|
2234
2279
|
* Checkout ID.
|
|
2235
2280
|
* @format GUID
|
|
2236
2281
|
*/
|
|
2237
|
-
|
|
2282
|
+
id: string;
|
|
2238
2283
|
}
|
|
2239
|
-
interface GetCheckoutResponse {
|
|
2284
|
+
export interface GetCheckoutResponse {
|
|
2240
2285
|
/** Retrieved checkout. */
|
|
2241
2286
|
checkout?: Checkout;
|
|
2242
2287
|
}
|
|
2243
|
-
interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
2288
|
+
export interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
2244
2289
|
/**
|
|
2245
2290
|
* Checkout ID.
|
|
2246
2291
|
* @format GUID
|
|
2247
2292
|
*/
|
|
2248
|
-
|
|
2293
|
+
id?: string;
|
|
2249
2294
|
}
|
|
2250
|
-
interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2295
|
+
export interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2251
2296
|
/** Retrieved checkout. */
|
|
2252
2297
|
checkout?: Checkout;
|
|
2253
2298
|
}
|
|
2254
|
-
interface GetCheckoutByCartIdRequest {
|
|
2299
|
+
export interface GetCheckoutByCartIdRequest {
|
|
2255
2300
|
/**
|
|
2256
2301
|
* Cart ID.
|
|
2257
2302
|
* @format GUID
|
|
2258
2303
|
*/
|
|
2259
|
-
|
|
2304
|
+
id: string;
|
|
2260
2305
|
}
|
|
2261
|
-
interface GetCheckoutByCartIdResponse {
|
|
2306
|
+
export interface GetCheckoutByCartIdResponse {
|
|
2262
2307
|
/** Retrieved checkout. */
|
|
2263
2308
|
checkout?: Checkout;
|
|
2264
2309
|
}
|
|
2265
|
-
interface GetWixCheckoutURLRequest {
|
|
2310
|
+
export interface GetWixCheckoutURLRequest {
|
|
2266
2311
|
/**
|
|
2267
2312
|
* Checkout ID.
|
|
2268
2313
|
* @format GUID
|
|
2269
2314
|
*/
|
|
2270
|
-
|
|
2315
|
+
id: string;
|
|
2271
2316
|
}
|
|
2272
|
-
interface GetWixCheckoutURLResponse {
|
|
2317
|
+
export interface GetWixCheckoutURLResponse {
|
|
2273
2318
|
/** Checkout URL. */
|
|
2274
2319
|
checkoutUrl?: string;
|
|
2275
2320
|
}
|
|
2276
|
-
interface GetCheckoutURLRequest {
|
|
2321
|
+
export interface GetCheckoutURLRequest {
|
|
2277
2322
|
/**
|
|
2278
2323
|
* Checkout ID.
|
|
2279
2324
|
* @format GUID
|
|
2280
2325
|
*/
|
|
2281
|
-
|
|
2326
|
+
id: string;
|
|
2282
2327
|
}
|
|
2283
|
-
interface GetCheckoutURLResponse {
|
|
2328
|
+
export interface GetCheckoutURLResponse {
|
|
2284
2329
|
/** Checkout URL. */
|
|
2285
2330
|
checkoutUrl?: string;
|
|
2286
2331
|
}
|
|
2287
|
-
interface UpdateCheckoutRequest {
|
|
2332
|
+
export interface UpdateCheckoutRequest {
|
|
2288
2333
|
/** Checkout information. */
|
|
2289
2334
|
checkout: Checkout;
|
|
2290
|
-
/**
|
|
2335
|
+
/**
|
|
2336
|
+
* Coupon code.
|
|
2337
|
+
*
|
|
2338
|
+
* The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
|
|
2339
|
+
*/
|
|
2291
2340
|
couponCode?: string | null;
|
|
2292
2341
|
/** Gift card code. */
|
|
2293
2342
|
giftCardCode?: string | null;
|
|
2294
2343
|
/**
|
|
2295
2344
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2296
2345
|
*
|
|
2297
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used
|
|
2346
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
2347
|
+
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2348
|
+
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2298
2349
|
* @maxLength 1000
|
|
2299
2350
|
*/
|
|
2300
2351
|
overrideCheckoutUrl?: string | null;
|
|
@@ -2312,49 +2363,49 @@ interface UpdateCheckoutRequest {
|
|
|
2312
2363
|
*/
|
|
2313
2364
|
customLineItems?: CustomLineItem[];
|
|
2314
2365
|
}
|
|
2315
|
-
interface UpdateCheckoutResponse {
|
|
2366
|
+
export interface UpdateCheckoutResponse {
|
|
2316
2367
|
/** Updated checkout. */
|
|
2317
2368
|
checkout?: Checkout;
|
|
2318
2369
|
}
|
|
2319
|
-
interface RemoveCouponRequest {
|
|
2370
|
+
export interface RemoveCouponRequest {
|
|
2320
2371
|
/**
|
|
2321
2372
|
* ID of the checkout to remove the coupon from.
|
|
2322
2373
|
* @format GUID
|
|
2323
2374
|
*/
|
|
2324
|
-
|
|
2375
|
+
id: string;
|
|
2325
2376
|
}
|
|
2326
|
-
interface RemoveCouponResponse {
|
|
2377
|
+
export interface RemoveCouponResponse {
|
|
2327
2378
|
/** Updated checkout after removal of coupon. */
|
|
2328
2379
|
checkout?: Checkout;
|
|
2329
2380
|
}
|
|
2330
|
-
interface RemoveGiftCardRequest {
|
|
2381
|
+
export interface RemoveGiftCardRequest {
|
|
2331
2382
|
/**
|
|
2332
2383
|
* ID of the checkout to remove the gift card from.
|
|
2333
2384
|
* @format GUID
|
|
2334
2385
|
*/
|
|
2335
|
-
|
|
2386
|
+
id: string;
|
|
2336
2387
|
}
|
|
2337
|
-
interface RemoveGiftCardResponse {
|
|
2388
|
+
export interface RemoveGiftCardResponse {
|
|
2338
2389
|
/** Updated checkout after removal of gift card. */
|
|
2339
2390
|
checkout?: Checkout;
|
|
2340
2391
|
}
|
|
2341
|
-
interface RemoveOverrideCheckoutUrlRequest {
|
|
2392
|
+
export interface RemoveOverrideCheckoutUrlRequest {
|
|
2342
2393
|
/**
|
|
2343
2394
|
* ID of the checkout to remove the override checkout url from.
|
|
2344
2395
|
* @format GUID
|
|
2345
2396
|
*/
|
|
2346
|
-
|
|
2397
|
+
id: string;
|
|
2347
2398
|
}
|
|
2348
|
-
interface RemoveOverrideCheckoutUrlResponse {
|
|
2399
|
+
export interface RemoveOverrideCheckoutUrlResponse {
|
|
2349
2400
|
/** Updated checkout after removal of override checkout url. */
|
|
2350
2401
|
checkout?: Checkout;
|
|
2351
2402
|
}
|
|
2352
|
-
interface AddToCheckoutRequest {
|
|
2403
|
+
export interface AddToCheckoutRequest {
|
|
2353
2404
|
/**
|
|
2354
2405
|
* Checkout ID.
|
|
2355
2406
|
* @format GUID
|
|
2356
2407
|
*/
|
|
2357
|
-
|
|
2408
|
+
id: string;
|
|
2358
2409
|
/**
|
|
2359
2410
|
* Catalog line items.
|
|
2360
2411
|
* @maxSize 100
|
|
@@ -2369,42 +2420,46 @@ interface AddToCheckoutRequest {
|
|
|
2369
2420
|
*/
|
|
2370
2421
|
customLineItems?: CustomLineItem[];
|
|
2371
2422
|
}
|
|
2372
|
-
interface AddToCheckoutResponse {
|
|
2423
|
+
export interface AddToCheckoutResponse {
|
|
2373
2424
|
/** Updated checkout. */
|
|
2374
2425
|
checkout?: Checkout;
|
|
2375
2426
|
}
|
|
2376
|
-
interface RemoveLineItemsRequest {
|
|
2427
|
+
export interface RemoveLineItemsRequest {
|
|
2377
2428
|
/**
|
|
2378
2429
|
* ID of the checkout to remove line items from.
|
|
2379
2430
|
* @format GUID
|
|
2380
2431
|
*/
|
|
2381
|
-
|
|
2432
|
+
id: string;
|
|
2382
2433
|
/**
|
|
2383
2434
|
* IDs of the line items to remove from the checkout.
|
|
2435
|
+
*
|
|
2436
|
+
* To find the IDs of the checkout line items you'd like to remove,
|
|
2437
|
+
* pass the checkout ID to Get Checkout and look for the IDs under
|
|
2438
|
+
* `lineItems`.
|
|
2384
2439
|
* @format GUID
|
|
2385
2440
|
* @minSize 1
|
|
2386
2441
|
* @maxSize 300
|
|
2387
2442
|
*/
|
|
2388
2443
|
lineItemIds: string[];
|
|
2389
2444
|
}
|
|
2390
|
-
interface RemoveLineItemsResponse {
|
|
2445
|
+
export interface RemoveLineItemsResponse {
|
|
2391
2446
|
/** Updated checkout after removal of line items. */
|
|
2392
2447
|
checkout?: Checkout;
|
|
2393
2448
|
}
|
|
2394
|
-
interface CreateOrderRequest {
|
|
2449
|
+
export interface CreateOrderRequest {
|
|
2395
2450
|
/**
|
|
2396
2451
|
* Checkout ID.
|
|
2397
2452
|
* @format GUID
|
|
2398
2453
|
*/
|
|
2399
|
-
|
|
2454
|
+
id: string;
|
|
2400
2455
|
/** Whether the payment method should be saved on the order. */
|
|
2401
2456
|
savePaymentMethod?: boolean;
|
|
2402
2457
|
/** Whether to authorize the payment and delay the capture. */
|
|
2403
2458
|
delayCapture?: boolean;
|
|
2404
2459
|
}
|
|
2405
|
-
interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
2460
|
+
export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
2406
2461
|
/**
|
|
2407
|
-
* ID of
|
|
2462
|
+
* ID of newly created order.
|
|
2408
2463
|
* @format GUID
|
|
2409
2464
|
*/
|
|
2410
2465
|
orderId?: string;
|
|
@@ -2417,15 +2472,16 @@ interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
|
2417
2472
|
* Payment gateway order ID.
|
|
2418
2473
|
*
|
|
2419
2474
|
* For online orders, pass this value as the `paymentId` parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function so your customer can pay for the order.
|
|
2475
|
+
* `paymentGatewayOrderId` will be returned if money needs to be charged.
|
|
2420
2476
|
*
|
|
2421
|
-
*
|
|
2422
|
-
* + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is 0
|
|
2423
|
-
* + If the total price is not 0
|
|
2477
|
+
* In some cases, money cannot be charged:
|
|
2478
|
+
* + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is `0`. For example, in the case of a free item or an item with a 100% discount.
|
|
2479
|
+
* + If the total price is not `0`, but the payment is covered by alternative payment methods, such as a gift card.
|
|
2424
2480
|
*/
|
|
2425
2481
|
paymentGatewayOrderId?: string | null;
|
|
2426
2482
|
}
|
|
2427
2483
|
/** @oneof */
|
|
2428
|
-
interface CreateOrderResponseIdOneOf {
|
|
2484
|
+
export interface CreateOrderResponseIdOneOf {
|
|
2429
2485
|
/**
|
|
2430
2486
|
* ID of newly created order.
|
|
2431
2487
|
* @format GUID
|
|
@@ -2437,37 +2493,37 @@ interface CreateOrderResponseIdOneOf {
|
|
|
2437
2493
|
*/
|
|
2438
2494
|
subscriptionId?: string;
|
|
2439
2495
|
}
|
|
2440
|
-
interface PaymentErrorResponseData {
|
|
2496
|
+
export interface PaymentErrorResponseData {
|
|
2441
2497
|
paymentResponseToken?: string | null;
|
|
2442
2498
|
transactionStatus?: string;
|
|
2443
2499
|
failureDetails?: string | null;
|
|
2444
2500
|
}
|
|
2445
|
-
interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
|
|
2501
|
+
export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
|
|
2446
2502
|
/** @format GUID */
|
|
2447
2503
|
orderId?: string;
|
|
2448
2504
|
/** @format GUID */
|
|
2449
2505
|
subscriptionId?: string;
|
|
2450
2506
|
}
|
|
2451
2507
|
/** @oneof */
|
|
2452
|
-
interface DoublePaymentErrorDataIdOneOf {
|
|
2508
|
+
export interface DoublePaymentErrorDataIdOneOf {
|
|
2453
2509
|
/** @format GUID */
|
|
2454
2510
|
orderId?: string;
|
|
2455
2511
|
/** @format GUID */
|
|
2456
2512
|
subscriptionId?: string;
|
|
2457
2513
|
}
|
|
2458
|
-
interface RedeemErrorData {
|
|
2514
|
+
export interface RedeemErrorData {
|
|
2459
2515
|
reason?: string;
|
|
2460
2516
|
}
|
|
2461
|
-
interface ViolationsList {
|
|
2517
|
+
export interface ViolationsList {
|
|
2462
2518
|
/** Violations risen by ValidationsSPI implementers. */
|
|
2463
2519
|
violations?: Violation[];
|
|
2464
2520
|
}
|
|
2465
|
-
interface CreateOrderAndChargeRequest {
|
|
2521
|
+
export interface CreateOrderAndChargeRequest {
|
|
2466
2522
|
/**
|
|
2467
2523
|
* Checkout ID.
|
|
2468
2524
|
* @format GUID
|
|
2469
2525
|
*/
|
|
2470
|
-
|
|
2526
|
+
id: string;
|
|
2471
2527
|
/** Payment token. */
|
|
2472
2528
|
paymentToken?: string | null;
|
|
2473
2529
|
/** Whether the payment method should be saved on the order. */
|
|
@@ -2475,7 +2531,7 @@ interface CreateOrderAndChargeRequest {
|
|
|
2475
2531
|
/** Whether to authorize the payment and delay the capture. */
|
|
2476
2532
|
delayCapture?: boolean;
|
|
2477
2533
|
}
|
|
2478
|
-
interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
2534
|
+
export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
2479
2535
|
/**
|
|
2480
2536
|
* ID of newly created order.
|
|
2481
2537
|
* @format GUID
|
|
@@ -2489,17 +2545,16 @@ interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOne
|
|
|
2489
2545
|
/** Payment response token. */
|
|
2490
2546
|
paymentResponseToken?: string | null;
|
|
2491
2547
|
/**
|
|
2492
|
-
*
|
|
2493
|
-
*
|
|
2494
|
-
*
|
|
2495
|
-
*
|
|
2496
|
-
*
|
|
2497
|
-
* + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
|
|
2548
|
+
* The payment gateway is cashier.
|
|
2549
|
+
* payment_gateway_order_id will be returned given that money was charged.
|
|
2550
|
+
* In some cases, money will not be charged:
|
|
2551
|
+
* If the total price is 0 - For example, could be a free item or a an item with 100% discount
|
|
2552
|
+
* If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
|
|
2498
2553
|
*/
|
|
2499
2554
|
paymentGatewayOrderId?: string | null;
|
|
2500
2555
|
}
|
|
2501
2556
|
/** @oneof */
|
|
2502
|
-
interface CreateOrderAndChargeResponseIdOneOf {
|
|
2557
|
+
export interface CreateOrderAndChargeResponseIdOneOf {
|
|
2503
2558
|
/**
|
|
2504
2559
|
* ID of newly created order.
|
|
2505
2560
|
* @format GUID
|
|
@@ -2511,41 +2566,41 @@ interface CreateOrderAndChargeResponseIdOneOf {
|
|
|
2511
2566
|
*/
|
|
2512
2567
|
subscriptionId?: string;
|
|
2513
2568
|
}
|
|
2514
|
-
interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
|
|
2569
|
+
export interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
|
|
2515
2570
|
/**
|
|
2516
2571
|
* Server-signed JWT token with required information to complete checkout
|
|
2517
2572
|
* @maxLength 4096
|
|
2518
2573
|
*/
|
|
2519
2574
|
token: string;
|
|
2520
2575
|
}
|
|
2521
|
-
interface RawHttpResponse {
|
|
2576
|
+
export interface RawHttpResponse {
|
|
2522
2577
|
body?: Uint8Array;
|
|
2523
2578
|
statusCode?: number | null;
|
|
2524
2579
|
headers?: HeadersEntry[];
|
|
2525
2580
|
}
|
|
2526
|
-
interface HeadersEntry {
|
|
2581
|
+
export interface HeadersEntry {
|
|
2527
2582
|
key?: string;
|
|
2528
2583
|
value?: string;
|
|
2529
2584
|
}
|
|
2530
|
-
interface MarkCheckoutAsCompletedRequest {
|
|
2585
|
+
export interface MarkCheckoutAsCompletedRequest {
|
|
2531
2586
|
/**
|
|
2532
2587
|
* Checkout ID.
|
|
2533
2588
|
* @format GUID
|
|
2534
2589
|
*/
|
|
2535
|
-
|
|
2590
|
+
id: string;
|
|
2536
2591
|
}
|
|
2537
|
-
interface MarkCheckoutAsCompletedResponse {
|
|
2592
|
+
export interface MarkCheckoutAsCompletedResponse {
|
|
2538
2593
|
}
|
|
2539
2594
|
/** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
|
|
2540
|
-
interface CheckoutMarkedAsCompleted {
|
|
2595
|
+
export interface CheckoutMarkedAsCompleted {
|
|
2541
2596
|
checkout?: Checkout;
|
|
2542
2597
|
}
|
|
2543
|
-
interface UpdateLineItemsQuantityRequest {
|
|
2598
|
+
export interface UpdateLineItemsQuantityRequest {
|
|
2544
2599
|
/**
|
|
2545
2600
|
* Checkout ID.
|
|
2546
2601
|
* @format GUID
|
|
2547
2602
|
*/
|
|
2548
|
-
|
|
2603
|
+
id: string;
|
|
2549
2604
|
/**
|
|
2550
2605
|
* Line item info to update.
|
|
2551
2606
|
* @minSize 1
|
|
@@ -2553,12 +2608,12 @@ interface UpdateLineItemsQuantityRequest {
|
|
|
2553
2608
|
*/
|
|
2554
2609
|
lineItems: LineItemQuantityUpdate[];
|
|
2555
2610
|
}
|
|
2556
|
-
interface LineItemQuantityUpdate {
|
|
2611
|
+
export interface LineItemQuantityUpdate {
|
|
2557
2612
|
/**
|
|
2558
2613
|
* ID of the line item to update.
|
|
2559
2614
|
* @format GUID
|
|
2560
2615
|
*/
|
|
2561
|
-
|
|
2616
|
+
id?: string;
|
|
2562
2617
|
/**
|
|
2563
2618
|
* New total amount of the line item,
|
|
2564
2619
|
* not the amount to add to the current `quantity`.
|
|
@@ -2571,42 +2626,42 @@ interface LineItemQuantityUpdate {
|
|
|
2571
2626
|
*/
|
|
2572
2627
|
quantity?: number;
|
|
2573
2628
|
}
|
|
2574
|
-
interface UpdateLineItemsQuantityResponse {
|
|
2629
|
+
export interface UpdateLineItemsQuantityResponse {
|
|
2575
2630
|
/** Updated checkout. */
|
|
2576
2631
|
checkout?: Checkout;
|
|
2577
2632
|
}
|
|
2578
|
-
interface GetCheckoutPaymentSettingsRequest {
|
|
2633
|
+
export interface GetCheckoutPaymentSettingsRequest {
|
|
2579
2634
|
/**
|
|
2580
2635
|
* Checkout ID.
|
|
2581
2636
|
* @format GUID
|
|
2582
2637
|
*/
|
|
2583
|
-
|
|
2638
|
+
id: string;
|
|
2584
2639
|
}
|
|
2585
|
-
interface GetCheckoutPaymentSettingsResponse {
|
|
2640
|
+
export interface GetCheckoutPaymentSettingsResponse {
|
|
2586
2641
|
blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOption[];
|
|
2587
2642
|
}
|
|
2588
|
-
declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2643
|
+
export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
2589
2644
|
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
2590
2645
|
MANUAL = "MANUAL"
|
|
2591
2646
|
}
|
|
2592
|
-
interface DeleteCheckoutRequest {
|
|
2647
|
+
export interface DeleteCheckoutRequest {
|
|
2593
2648
|
/**
|
|
2594
2649
|
* ID of the checkout to delete.
|
|
2595
2650
|
* @format GUID
|
|
2596
2651
|
*/
|
|
2597
|
-
|
|
2652
|
+
id?: string;
|
|
2598
2653
|
}
|
|
2599
|
-
interface DeleteCheckoutResponse {
|
|
2654
|
+
export interface DeleteCheckoutResponse {
|
|
2600
2655
|
}
|
|
2601
|
-
interface SubscriptionCreated {
|
|
2656
|
+
export interface SubscriptionCreated {
|
|
2602
2657
|
subscription?: Subscription;
|
|
2603
2658
|
}
|
|
2604
|
-
interface Subscription {
|
|
2659
|
+
export interface Subscription {
|
|
2605
2660
|
/**
|
|
2606
2661
|
* Subscription id (auto-generated upon subscription creation)
|
|
2607
2662
|
* @readonly
|
|
2608
2663
|
*/
|
|
2609
|
-
|
|
2664
|
+
id?: string;
|
|
2610
2665
|
/**
|
|
2611
2666
|
* id of subscription in external system
|
|
2612
2667
|
* @format GUID
|
|
@@ -2665,23 +2720,23 @@ interface Subscription {
|
|
|
2665
2720
|
billingInfo?: BillingInfo;
|
|
2666
2721
|
}
|
|
2667
2722
|
/** Buyer Info */
|
|
2668
|
-
interface V1BuyerInfo {
|
|
2723
|
+
export interface V1BuyerInfo {
|
|
2669
2724
|
/**
|
|
2670
2725
|
* Wix customer ID
|
|
2671
2726
|
* @format GUID
|
|
2672
2727
|
*/
|
|
2673
|
-
|
|
2728
|
+
id?: string;
|
|
2674
2729
|
/** Customer type */
|
|
2675
2730
|
identityType?: IdentityType;
|
|
2676
2731
|
}
|
|
2677
|
-
declare enum IdentityType {
|
|
2732
|
+
export declare enum IdentityType {
|
|
2678
2733
|
UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
|
|
2679
2734
|
/** Site member */
|
|
2680
2735
|
MEMBER = "MEMBER",
|
|
2681
2736
|
/** Contact */
|
|
2682
2737
|
CONTACT = "CONTACT"
|
|
2683
2738
|
}
|
|
2684
|
-
interface V1LineItem {
|
|
2739
|
+
export interface V1LineItem {
|
|
2685
2740
|
/** Line item ID (auto-generated) */
|
|
2686
2741
|
index?: number;
|
|
2687
2742
|
/**
|
|
@@ -2710,7 +2765,7 @@ interface V1LineItem {
|
|
|
2710
2765
|
/** Product details */
|
|
2711
2766
|
productDetails?: ProductDetails;
|
|
2712
2767
|
}
|
|
2713
|
-
interface OptionSelection {
|
|
2768
|
+
export interface OptionSelection {
|
|
2714
2769
|
/**
|
|
2715
2770
|
* Option name
|
|
2716
2771
|
* @maxLength 200
|
|
@@ -2722,7 +2777,7 @@ interface OptionSelection {
|
|
|
2722
2777
|
*/
|
|
2723
2778
|
selection?: string;
|
|
2724
2779
|
}
|
|
2725
|
-
interface CustomTextFieldSelection {
|
|
2780
|
+
export interface CustomTextFieldSelection {
|
|
2726
2781
|
/**
|
|
2727
2782
|
* Custom text field name
|
|
2728
2783
|
* @maxLength 100
|
|
@@ -2734,7 +2789,7 @@ interface CustomTextFieldSelection {
|
|
|
2734
2789
|
*/
|
|
2735
2790
|
value?: string;
|
|
2736
2791
|
}
|
|
2737
|
-
interface ChargeDetails {
|
|
2792
|
+
export interface ChargeDetails {
|
|
2738
2793
|
/**
|
|
2739
2794
|
* price of line item (depends on subscription option)
|
|
2740
2795
|
* @max 999999999.99
|
|
@@ -2763,7 +2818,7 @@ interface ChargeDetails {
|
|
|
2763
2818
|
*/
|
|
2764
2819
|
taxRate?: string | null;
|
|
2765
2820
|
}
|
|
2766
|
-
interface ProductDetails {
|
|
2821
|
+
export interface ProductDetails {
|
|
2767
2822
|
/**
|
|
2768
2823
|
* Line item product ID (optional for POS orders)
|
|
2769
2824
|
* @minLength 1
|
|
@@ -2816,7 +2871,7 @@ interface ProductDetails {
|
|
|
2816
2871
|
*/
|
|
2817
2872
|
appId?: string | null;
|
|
2818
2873
|
}
|
|
2819
|
-
declare enum LineItemType {
|
|
2874
|
+
export declare enum LineItemType {
|
|
2820
2875
|
/** Line item type can't be classified, due to an error */
|
|
2821
2876
|
UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
|
|
2822
2877
|
/** Physical item type */
|
|
@@ -2826,7 +2881,7 @@ declare enum LineItemType {
|
|
|
2826
2881
|
/** Custom item price */
|
|
2827
2882
|
CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
|
|
2828
2883
|
}
|
|
2829
|
-
interface MediaItem {
|
|
2884
|
+
export interface MediaItem {
|
|
2830
2885
|
/**
|
|
2831
2886
|
* Media type
|
|
2832
2887
|
* @readonly
|
|
@@ -2851,7 +2906,7 @@ interface MediaItem {
|
|
|
2851
2906
|
*/
|
|
2852
2907
|
height?: number;
|
|
2853
2908
|
/** Media ID (for media items previously saved in Wix Media) */
|
|
2854
|
-
|
|
2909
|
+
id?: string | null;
|
|
2855
2910
|
/** Media external URL */
|
|
2856
2911
|
externalImageUrl?: string | null;
|
|
2857
2912
|
/**
|
|
@@ -2860,13 +2915,13 @@ interface MediaItem {
|
|
|
2860
2915
|
*/
|
|
2861
2916
|
altText?: string | null;
|
|
2862
2917
|
}
|
|
2863
|
-
declare enum MediaItemType {
|
|
2918
|
+
export declare enum MediaItemType {
|
|
2864
2919
|
/** Media item type can't be classified, due to an error */
|
|
2865
2920
|
UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
|
|
2866
2921
|
/** Image item type */
|
|
2867
2922
|
IMAGE = "IMAGE"
|
|
2868
2923
|
}
|
|
2869
|
-
interface Totals {
|
|
2924
|
+
export interface Totals {
|
|
2870
2925
|
/**
|
|
2871
2926
|
* Subtotal of all line items, before tax
|
|
2872
2927
|
* @max 999999999.99
|
|
@@ -2903,7 +2958,7 @@ interface Totals {
|
|
|
2903
2958
|
*/
|
|
2904
2959
|
quantity?: number;
|
|
2905
2960
|
}
|
|
2906
|
-
interface StoreSettings {
|
|
2961
|
+
export interface StoreSettings {
|
|
2907
2962
|
/**
|
|
2908
2963
|
* Currency used for pricing in this store
|
|
2909
2964
|
* @maxLength 3
|
|
@@ -2921,7 +2976,7 @@ interface StoreSettings {
|
|
|
2921
2976
|
*/
|
|
2922
2977
|
buyerLanguage?: string | null;
|
|
2923
2978
|
}
|
|
2924
|
-
interface Address extends AddressAddressLine1OptionsOneOf {
|
|
2979
|
+
export interface Address extends AddressAddressLine1OptionsOneOf {
|
|
2925
2980
|
/**
|
|
2926
2981
|
* Address line 1 (free text)
|
|
2927
2982
|
* @maxLength 1000
|
|
@@ -2975,7 +3030,7 @@ interface Address extends AddressAddressLine1OptionsOneOf {
|
|
|
2975
3030
|
vatId?: VatId;
|
|
2976
3031
|
}
|
|
2977
3032
|
/** @oneof */
|
|
2978
|
-
interface AddressAddressLine1OptionsOneOf {
|
|
3033
|
+
export interface AddressAddressLine1OptionsOneOf {
|
|
2979
3034
|
/**
|
|
2980
3035
|
* Address line 1 (free text)
|
|
2981
3036
|
* @maxLength 1000
|
|
@@ -2984,7 +3039,7 @@ interface AddressAddressLine1OptionsOneOf {
|
|
|
2984
3039
|
/** Address line 1 (street) */
|
|
2985
3040
|
street?: Street;
|
|
2986
3041
|
}
|
|
2987
|
-
interface FullName {
|
|
3042
|
+
export interface FullName {
|
|
2988
3043
|
/**
|
|
2989
3044
|
* Customer's first name
|
|
2990
3045
|
* @maxLength 1000
|
|
@@ -2996,7 +3051,7 @@ interface FullName {
|
|
|
2996
3051
|
*/
|
|
2997
3052
|
lastName?: string;
|
|
2998
3053
|
}
|
|
2999
|
-
interface Street {
|
|
3054
|
+
export interface Street {
|
|
3000
3055
|
/**
|
|
3001
3056
|
* Street number
|
|
3002
3057
|
* @maxLength 500
|
|
@@ -3008,7 +3063,7 @@ interface Street {
|
|
|
3008
3063
|
*/
|
|
3009
3064
|
name?: string;
|
|
3010
3065
|
}
|
|
3011
|
-
interface VatId {
|
|
3066
|
+
export interface VatId {
|
|
3012
3067
|
/**
|
|
3013
3068
|
* Customer's tax ID.
|
|
3014
3069
|
* @maxLength 50
|
|
@@ -3022,7 +3077,7 @@ interface VatId {
|
|
|
3022
3077
|
type?: VatType;
|
|
3023
3078
|
}
|
|
3024
3079
|
/** Brazilian tax info types */
|
|
3025
|
-
declare enum VatType {
|
|
3080
|
+
export declare enum VatType {
|
|
3026
3081
|
/** When the tax info type can't be classified, due to an error */
|
|
3027
3082
|
UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
|
|
3028
3083
|
/** CPF - for individual tax payers */
|
|
@@ -3030,7 +3085,7 @@ declare enum VatType {
|
|
|
3030
3085
|
/** CNPJ - for corporations */
|
|
3031
3086
|
CNPJ = "CNPJ"
|
|
3032
3087
|
}
|
|
3033
|
-
interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3088
|
+
export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
3034
3089
|
/** Shipment details (when this object describes shipment) */
|
|
3035
3090
|
shipmentDetails?: ShipmentDetails;
|
|
3036
3091
|
/** Pickup details (when this object describes pickup) */
|
|
@@ -3047,13 +3102,13 @@ interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
|
3047
3102
|
estimatedDeliveryTime?: string | null;
|
|
3048
3103
|
}
|
|
3049
3104
|
/** @oneof */
|
|
3050
|
-
interface V1ShippingInfoDetailsOneOf {
|
|
3105
|
+
export interface V1ShippingInfoDetailsOneOf {
|
|
3051
3106
|
/** Shipment details (when this object describes shipment) */
|
|
3052
3107
|
shipmentDetails?: ShipmentDetails;
|
|
3053
3108
|
/** Pickup details (when this object describes pickup) */
|
|
3054
3109
|
pickupDetails?: V1PickupDetails;
|
|
3055
3110
|
}
|
|
3056
|
-
interface ShipmentDetails {
|
|
3111
|
+
export interface ShipmentDetails {
|
|
3057
3112
|
/** Shipping destination address */
|
|
3058
3113
|
address?: Address;
|
|
3059
3114
|
/**
|
|
@@ -3074,7 +3129,7 @@ interface ShipmentDetails {
|
|
|
3074
3129
|
*/
|
|
3075
3130
|
taxRate?: string | null;
|
|
3076
3131
|
}
|
|
3077
|
-
interface V1PickupDetails {
|
|
3132
|
+
export interface V1PickupDetails {
|
|
3078
3133
|
/** Pickup address */
|
|
3079
3134
|
address?: PickupAddress;
|
|
3080
3135
|
/**
|
|
@@ -3083,7 +3138,7 @@ interface V1PickupDetails {
|
|
|
3083
3138
|
*/
|
|
3084
3139
|
pickupInstructions?: string | null;
|
|
3085
3140
|
}
|
|
3086
|
-
interface PickupAddress {
|
|
3141
|
+
export interface PickupAddress {
|
|
3087
3142
|
/**
|
|
3088
3143
|
* Country code (2 letters)
|
|
3089
3144
|
* @format COUNTRY
|
|
@@ -3110,7 +3165,7 @@ interface PickupAddress {
|
|
|
3110
3165
|
*/
|
|
3111
3166
|
zipCode?: string;
|
|
3112
3167
|
}
|
|
3113
|
-
interface AppliedCoupon {
|
|
3168
|
+
export interface AppliedCoupon {
|
|
3114
3169
|
/** Coupon ID */
|
|
3115
3170
|
couponId?: string;
|
|
3116
3171
|
/**
|
|
@@ -3125,7 +3180,7 @@ interface AppliedCoupon {
|
|
|
3125
3180
|
code?: string;
|
|
3126
3181
|
}
|
|
3127
3182
|
/** Custom field */
|
|
3128
|
-
interface V1CustomField {
|
|
3183
|
+
export interface V1CustomField {
|
|
3129
3184
|
/**
|
|
3130
3185
|
* Free text that the customer entered in the custom field during the checkout process
|
|
3131
3186
|
* @maxLength 250
|
|
@@ -3142,9 +3197,9 @@ interface V1CustomField {
|
|
|
3142
3197
|
*/
|
|
3143
3198
|
translatedTitle?: string;
|
|
3144
3199
|
}
|
|
3145
|
-
interface V1SubscriptionOptionInfo {
|
|
3200
|
+
export interface V1SubscriptionOptionInfo {
|
|
3146
3201
|
/** @format GUID */
|
|
3147
|
-
|
|
3202
|
+
id?: string | null;
|
|
3148
3203
|
/**
|
|
3149
3204
|
* @minLength 1
|
|
3150
3205
|
* @maxLength 20
|
|
@@ -3154,29 +3209,29 @@ interface V1SubscriptionOptionInfo {
|
|
|
3154
3209
|
description?: string | null;
|
|
3155
3210
|
discount?: Discount;
|
|
3156
3211
|
}
|
|
3157
|
-
interface Discount {
|
|
3212
|
+
export interface Discount {
|
|
3158
3213
|
/** Discount type. */
|
|
3159
3214
|
type?: DiscountDiscountType;
|
|
3160
3215
|
/** Discount value. */
|
|
3161
3216
|
value?: number;
|
|
3162
3217
|
}
|
|
3163
|
-
declare enum DiscountDiscountType {
|
|
3218
|
+
export declare enum DiscountDiscountType {
|
|
3164
3219
|
UNDEFINED = "UNDEFINED",
|
|
3165
3220
|
/** No discount */
|
|
3166
3221
|
AMOUNT = "AMOUNT",
|
|
3167
3222
|
PERCENT = "PERCENT"
|
|
3168
3223
|
}
|
|
3169
|
-
interface ChannelInfo {
|
|
3224
|
+
export interface ChannelInfo {
|
|
3170
3225
|
/** Sales channel that submitted the subscription */
|
|
3171
3226
|
type?: ChannelInfoChannelType;
|
|
3172
3227
|
}
|
|
3173
|
-
declare enum ChannelInfoChannelType {
|
|
3228
|
+
export declare enum ChannelInfoChannelType {
|
|
3174
3229
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3175
3230
|
WEB = "WEB",
|
|
3176
3231
|
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
3177
3232
|
WIX_APP_STORE = "WIX_APP_STORE"
|
|
3178
3233
|
}
|
|
3179
|
-
interface V1SubscriptionSettings {
|
|
3234
|
+
export interface V1SubscriptionSettings {
|
|
3180
3235
|
/** Frequency of recurring payment. */
|
|
3181
3236
|
frequency?: SubscriptionFrequency;
|
|
3182
3237
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
@@ -3188,7 +3243,7 @@ interface V1SubscriptionSettings {
|
|
|
3188
3243
|
*/
|
|
3189
3244
|
billingCycles?: number | null;
|
|
3190
3245
|
}
|
|
3191
|
-
interface BillingInfo {
|
|
3246
|
+
export interface BillingInfo {
|
|
3192
3247
|
/**
|
|
3193
3248
|
* Payment method used for this order
|
|
3194
3249
|
* @maxLength 50
|
|
@@ -3205,9 +3260,9 @@ interface BillingInfo {
|
|
|
3205
3260
|
*/
|
|
3206
3261
|
paymentGatewayOrderId?: string | null;
|
|
3207
3262
|
}
|
|
3208
|
-
interface Empty {
|
|
3263
|
+
export interface Empty {
|
|
3209
3264
|
}
|
|
3210
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3265
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3211
3266
|
createdEvent?: EntityCreatedEvent;
|
|
3212
3267
|
updatedEvent?: EntityUpdatedEvent;
|
|
3213
3268
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3216,7 +3271,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3216
3271
|
* Unique event ID.
|
|
3217
3272
|
* Allows clients to ignore duplicate webhooks.
|
|
3218
3273
|
*/
|
|
3219
|
-
|
|
3274
|
+
id?: string;
|
|
3220
3275
|
/**
|
|
3221
3276
|
* Assumes actions are also always typed to an entity_type
|
|
3222
3277
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -3250,34 +3305,36 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3250
3305
|
entityEventSequence?: string | null;
|
|
3251
3306
|
}
|
|
3252
3307
|
/** @oneof */
|
|
3253
|
-
interface DomainEventBodyOneOf {
|
|
3308
|
+
export interface DomainEventBodyOneOf {
|
|
3254
3309
|
createdEvent?: EntityCreatedEvent;
|
|
3255
3310
|
updatedEvent?: EntityUpdatedEvent;
|
|
3256
3311
|
deletedEvent?: EntityDeletedEvent;
|
|
3257
3312
|
actionEvent?: ActionEvent;
|
|
3258
3313
|
}
|
|
3259
|
-
interface EntityCreatedEvent {
|
|
3260
|
-
|
|
3314
|
+
export interface EntityCreatedEvent {
|
|
3315
|
+
entityAsJson?: string;
|
|
3316
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3317
|
+
restoreInfo?: RestoreInfo;
|
|
3261
3318
|
}
|
|
3262
|
-
interface RestoreInfo {
|
|
3319
|
+
export interface RestoreInfo {
|
|
3263
3320
|
deletedDate?: Date | null;
|
|
3264
3321
|
}
|
|
3265
|
-
interface EntityUpdatedEvent {
|
|
3322
|
+
export interface EntityUpdatedEvent {
|
|
3266
3323
|
/**
|
|
3267
3324
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3268
3325
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3269
3326
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3270
3327
|
*/
|
|
3271
|
-
|
|
3328
|
+
currentEntityAsJson?: string;
|
|
3272
3329
|
}
|
|
3273
|
-
interface EntityDeletedEvent {
|
|
3330
|
+
export interface EntityDeletedEvent {
|
|
3274
3331
|
/** Entity that was deleted */
|
|
3275
|
-
|
|
3332
|
+
deletedEntityAsJson?: string | null;
|
|
3276
3333
|
}
|
|
3277
|
-
interface ActionEvent {
|
|
3278
|
-
|
|
3334
|
+
export interface ActionEvent {
|
|
3335
|
+
bodyAsJson?: string;
|
|
3279
3336
|
}
|
|
3280
|
-
interface MessageEnvelope {
|
|
3337
|
+
export interface MessageEnvelope {
|
|
3281
3338
|
/**
|
|
3282
3339
|
* App instance ID.
|
|
3283
3340
|
* @format GUID
|
|
@@ -3293,7 +3350,7 @@ interface MessageEnvelope {
|
|
|
3293
3350
|
/** Stringify payload. */
|
|
3294
3351
|
data?: string;
|
|
3295
3352
|
}
|
|
3296
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3353
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3297
3354
|
/**
|
|
3298
3355
|
* ID of a site visitor that has not logged in to the site.
|
|
3299
3356
|
* @format GUID
|
|
@@ -3318,7 +3375,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3318
3375
|
identityType?: WebhookIdentityType;
|
|
3319
3376
|
}
|
|
3320
3377
|
/** @oneof */
|
|
3321
|
-
interface IdentificationDataIdOneOf {
|
|
3378
|
+
export interface IdentificationDataIdOneOf {
|
|
3322
3379
|
/**
|
|
3323
3380
|
* ID of a site visitor that has not logged in to the site.
|
|
3324
3381
|
* @format GUID
|
|
@@ -3340,343 +3397,10 @@ interface IdentificationDataIdOneOf {
|
|
|
3340
3397
|
*/
|
|
3341
3398
|
appId?: string;
|
|
3342
3399
|
}
|
|
3343
|
-
declare enum WebhookIdentityType {
|
|
3400
|
+
export declare enum WebhookIdentityType {
|
|
3344
3401
|
UNKNOWN = "UNKNOWN",
|
|
3345
3402
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3346
3403
|
MEMBER = "MEMBER",
|
|
3347
3404
|
WIX_USER = "WIX_USER",
|
|
3348
3405
|
APP = "APP"
|
|
3349
3406
|
}
|
|
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 };
|