@wix/auto_sdk_ecom_cart 1.0.13 → 1.0.14
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/src/ecom-v1-cart-cart.types.d.ts → ecom-v1-cart-cart.universal-BIIZxJYL.d.mts} +504 -269
- package/build/{internal/cjs/src/ecom-v1-cart-cart.types.d.ts → ecom-v1-cart-cart.universal-BIIZxJYL.d.ts} +504 -269
- package/build/index.d.mts +149 -0
- package/build/index.d.ts +149 -0
- package/build/index.js +1938 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1875 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/ecom-v1-cart-cart.types.d.ts → ecom-v1-cart-cart.universal-CJdmyIWv.d.mts} +668 -269
- package/build/{es/src/ecom-v1-cart-cart.types.d.ts → internal/ecom-v1-cart-cart.universal-CJdmyIWv.d.ts} +668 -269
- package/build/internal/index.d.mts +160 -0
- package/build/internal/index.d.ts +160 -0
- package/build/internal/index.js +1938 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1875 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2050 -0
- package/build/internal/meta.d.ts +2050 -0
- package/build/internal/meta.js +1027 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +989 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2050 -0
- package/build/meta.d.ts +2050 -0
- package/build/meta.js +1027 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +989 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-cart-cart.context.d.ts +0 -29
- package/build/cjs/src/ecom-v1-cart-cart.context.js +0 -59
- package/build/cjs/src/ecom-v1-cart-cart.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-cart-cart.http.d.ts +0 -60
- package/build/cjs/src/ecom-v1-cart-cart.http.js +0 -818
- package/build/cjs/src/ecom-v1-cart-cart.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-cart-cart.meta.d.ts +0 -46
- package/build/cjs/src/ecom-v1-cart-cart.meta.js +0 -256
- package/build/cjs/src/ecom-v1-cart-cart.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-cart-cart.public.d.ts +0 -129
- package/build/cjs/src/ecom-v1-cart-cart.public.js +0 -227
- package/build/cjs/src/ecom-v1-cart-cart.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-cart-cart.types.js +0 -255
- package/build/cjs/src/ecom-v1-cart-cart.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-cart-cart.universal.d.ts +0 -3263
- package/build/cjs/src/ecom-v1-cart-cart.universal.js +0 -1192
- package/build/cjs/src/ecom-v1-cart-cart.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-cart-cart.context.d.ts +0 -29
- package/build/es/src/ecom-v1-cart-cart.context.js +0 -31
- package/build/es/src/ecom-v1-cart-cart.context.js.map +0 -1
- package/build/es/src/ecom-v1-cart-cart.http.d.ts +0 -60
- package/build/es/src/ecom-v1-cart-cart.http.js +0 -803
- package/build/es/src/ecom-v1-cart-cart.http.js.map +0 -1
- package/build/es/src/ecom-v1-cart-cart.meta.d.ts +0 -46
- package/build/es/src/ecom-v1-cart-cart.meta.js +0 -218
- package/build/es/src/ecom-v1-cart-cart.meta.js.map +0 -1
- package/build/es/src/ecom-v1-cart-cart.public.d.ts +0 -129
- package/build/es/src/ecom-v1-cart-cart.public.js +0 -187
- package/build/es/src/ecom-v1-cart-cart.public.js.map +0 -1
- package/build/es/src/ecom-v1-cart-cart.types.js +0 -252
- package/build/es/src/ecom-v1-cart-cart.types.js.map +0 -1
- package/build/es/src/ecom-v1-cart-cart.universal.d.ts +0 -3263
- package/build/es/src/ecom-v1-cart-cart.universal.js +0 -1154
- package/build/es/src/ecom-v1-cart-cart.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.context.d.ts +0 -31
- package/build/internal/cjs/src/ecom-v1-cart-cart.context.js +0 -59
- package/build/internal/cjs/src/ecom-v1-cart-cart.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.http.d.ts +0 -60
- package/build/internal/cjs/src/ecom-v1-cart-cart.http.js +0 -818
- package/build/internal/cjs/src/ecom-v1-cart-cart.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.meta.d.ts +0 -46
- package/build/internal/cjs/src/ecom-v1-cart-cart.meta.js +0 -256
- package/build/internal/cjs/src/ecom-v1-cart-cart.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.public.d.ts +0 -138
- package/build/internal/cjs/src/ecom-v1-cart-cart.public.js +0 -227
- package/build/internal/cjs/src/ecom-v1-cart-cart.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.types.js +0 -255
- package/build/internal/cjs/src/ecom-v1-cart-cart.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.d.ts +0 -3457
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js +0 -1192
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-cart-cart.context.d.ts +0 -31
- package/build/internal/es/src/ecom-v1-cart-cart.context.js +0 -31
- package/build/internal/es/src/ecom-v1-cart-cart.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-cart-cart.http.d.ts +0 -60
- package/build/internal/es/src/ecom-v1-cart-cart.http.js +0 -803
- package/build/internal/es/src/ecom-v1-cart-cart.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-cart-cart.meta.d.ts +0 -46
- package/build/internal/es/src/ecom-v1-cart-cart.meta.js +0 -218
- package/build/internal/es/src/ecom-v1-cart-cart.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-cart-cart.public.d.ts +0 -138
- package/build/internal/es/src/ecom-v1-cart-cart.public.js +0 -187
- package/build/internal/es/src/ecom-v1-cart-cart.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-cart-cart.types.js +0 -252
- package/build/internal/es/src/ecom-v1-cart-cart.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-cart-cart.universal.d.ts +0 -3457
- package/build/internal/es/src/ecom-v1-cart-cart.universal.js +0 -1154
- package/build/internal/es/src/ecom-v1-cart-cart.universal.js.map +0 -1
package/build/{cjs/src/ecom-v1-cart-cart.types.d.ts → ecom-v1-cart-cart.universal-BIIZxJYL.d.mts}
RENAMED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
|
|
1
|
+
interface Cart {
|
|
2
2
|
/**
|
|
3
3
|
* Cart ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
*/
|
|
6
|
-
|
|
6
|
+
_id?: string | null;
|
|
7
7
|
/**
|
|
8
8
|
* Line items.
|
|
9
9
|
* @minSize 1
|
|
@@ -67,12 +67,12 @@ export interface Cart {
|
|
|
67
67
|
* Date and time the cart was created.
|
|
68
68
|
* @readonly
|
|
69
69
|
*/
|
|
70
|
-
|
|
70
|
+
_createdDate?: Date | null;
|
|
71
71
|
/**
|
|
72
72
|
* Date and time the cart was updated.
|
|
73
73
|
* @readonly
|
|
74
74
|
*/
|
|
75
|
-
|
|
75
|
+
_updatedDate?: Date | null;
|
|
76
76
|
/** Contact info. */
|
|
77
77
|
contactInfo?: AddressWithContact;
|
|
78
78
|
/**
|
|
@@ -100,13 +100,13 @@ export interface Cart {
|
|
|
100
100
|
*/
|
|
101
101
|
businessLocationId?: string | null;
|
|
102
102
|
}
|
|
103
|
-
|
|
103
|
+
interface LineItem {
|
|
104
104
|
/**
|
|
105
105
|
* Line item ID.
|
|
106
106
|
* @format GUID
|
|
107
107
|
* @readonly
|
|
108
108
|
*/
|
|
109
|
-
|
|
109
|
+
_id?: string | null;
|
|
110
110
|
/**
|
|
111
111
|
* Item quantity.
|
|
112
112
|
* @min 1
|
|
@@ -127,7 +127,7 @@ export interface LineItem {
|
|
|
127
127
|
* URL to the item's page on the site.
|
|
128
128
|
* @readonly
|
|
129
129
|
*/
|
|
130
|
-
url?:
|
|
130
|
+
url?: string;
|
|
131
131
|
/**
|
|
132
132
|
* Item price **after** catalog-defined discount and line item discounts.
|
|
133
133
|
* @readonly
|
|
@@ -152,7 +152,7 @@ export interface LineItem {
|
|
|
152
152
|
* Line item image details.
|
|
153
153
|
* @readonly
|
|
154
154
|
*/
|
|
155
|
-
image?:
|
|
155
|
+
image?: string;
|
|
156
156
|
/**
|
|
157
157
|
* Item availability details.
|
|
158
158
|
* @readonly
|
|
@@ -242,7 +242,7 @@ export interface LineItem {
|
|
|
242
242
|
savePaymentMethod?: boolean;
|
|
243
243
|
}
|
|
244
244
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
245
|
-
|
|
245
|
+
interface CatalogReference {
|
|
246
246
|
/**
|
|
247
247
|
* ID of the item within the catalog it belongs to.
|
|
248
248
|
* @minLength 1
|
|
@@ -268,7 +268,7 @@ export interface CatalogReference {
|
|
|
268
268
|
*/
|
|
269
269
|
options?: Record<string, any> | null;
|
|
270
270
|
}
|
|
271
|
-
|
|
271
|
+
interface ProductName {
|
|
272
272
|
/**
|
|
273
273
|
* __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).
|
|
274
274
|
*
|
|
@@ -289,13 +289,7 @@ export interface ProductName {
|
|
|
289
289
|
*/
|
|
290
290
|
translated?: string | null;
|
|
291
291
|
}
|
|
292
|
-
|
|
293
|
-
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
294
|
-
relativePath?: string;
|
|
295
|
-
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
296
|
-
url?: string | null;
|
|
297
|
-
}
|
|
298
|
-
export interface MultiCurrencyPrice {
|
|
292
|
+
interface MultiCurrencyPrice {
|
|
299
293
|
/**
|
|
300
294
|
* Amount.
|
|
301
295
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -318,7 +312,7 @@ export interface MultiCurrencyPrice {
|
|
|
318
312
|
*/
|
|
319
313
|
formattedConvertedAmount?: string;
|
|
320
314
|
}
|
|
321
|
-
|
|
315
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
322
316
|
/** Description line plain text value. */
|
|
323
317
|
plainText?: PlainTextValue;
|
|
324
318
|
/** Description line color value. */
|
|
@@ -327,16 +321,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
327
321
|
name?: DescriptionLineName;
|
|
328
322
|
}
|
|
329
323
|
/** @oneof */
|
|
330
|
-
|
|
324
|
+
interface DescriptionLineValueOneOf {
|
|
331
325
|
/** Description line plain text value. */
|
|
332
326
|
plainText?: PlainTextValue;
|
|
333
327
|
/** Description line color value. */
|
|
334
328
|
colorInfo?: Color;
|
|
335
329
|
}
|
|
336
330
|
/** @oneof */
|
|
337
|
-
|
|
331
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
338
332
|
}
|
|
339
|
-
|
|
333
|
+
interface DescriptionLineName {
|
|
340
334
|
/**
|
|
341
335
|
* 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).
|
|
342
336
|
* @maxLength 100
|
|
@@ -350,7 +344,7 @@ export interface DescriptionLineName {
|
|
|
350
344
|
*/
|
|
351
345
|
translated?: string | null;
|
|
352
346
|
}
|
|
353
|
-
|
|
347
|
+
interface PlainTextValue {
|
|
354
348
|
/**
|
|
355
349
|
* 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).
|
|
356
350
|
* @maxLength 600
|
|
@@ -364,7 +358,7 @@ export interface PlainTextValue {
|
|
|
364
358
|
*/
|
|
365
359
|
translated?: string | null;
|
|
366
360
|
}
|
|
367
|
-
|
|
361
|
+
interface Color {
|
|
368
362
|
/**
|
|
369
363
|
* 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).
|
|
370
364
|
* @maxLength 500
|
|
@@ -380,7 +374,7 @@ export interface Color {
|
|
|
380
374
|
/** HEX or RGB color code for display. */
|
|
381
375
|
code?: string | null;
|
|
382
376
|
}
|
|
383
|
-
|
|
377
|
+
declare enum DescriptionLineType {
|
|
384
378
|
/** Unrecognized type. */
|
|
385
379
|
UNRECOGNISED = "UNRECOGNISED",
|
|
386
380
|
/** Plain text type. */
|
|
@@ -388,30 +382,7 @@ export declare enum DescriptionLineType {
|
|
|
388
382
|
/** Color type. */
|
|
389
383
|
COLOR = "COLOR"
|
|
390
384
|
}
|
|
391
|
-
|
|
392
|
-
/** WixMedia image ID. */
|
|
393
|
-
id?: string;
|
|
394
|
-
/** Image URL. */
|
|
395
|
-
url?: string;
|
|
396
|
-
/**
|
|
397
|
-
* Original image height.
|
|
398
|
-
* @readonly
|
|
399
|
-
*/
|
|
400
|
-
height?: number;
|
|
401
|
-
/**
|
|
402
|
-
* Original image width.
|
|
403
|
-
* @readonly
|
|
404
|
-
*/
|
|
405
|
-
width?: number;
|
|
406
|
-
/** Image alt text. */
|
|
407
|
-
altText?: string | null;
|
|
408
|
-
/**
|
|
409
|
-
* Image filename.
|
|
410
|
-
* @readonly
|
|
411
|
-
*/
|
|
412
|
-
filename?: string | null;
|
|
413
|
-
}
|
|
414
|
-
export interface FocalPoint {
|
|
385
|
+
interface FocalPoint {
|
|
415
386
|
/** X-coordinate of the focal point. */
|
|
416
387
|
x?: number;
|
|
417
388
|
/** Y-coordinate of the focal point. */
|
|
@@ -421,13 +392,13 @@ export interface FocalPoint {
|
|
|
421
392
|
/** crop by width */
|
|
422
393
|
width?: number | null;
|
|
423
394
|
}
|
|
424
|
-
|
|
395
|
+
interface ItemAvailabilityInfo {
|
|
425
396
|
/** Item availability status. */
|
|
426
397
|
status?: ItemAvailabilityStatus;
|
|
427
398
|
/** Quantity available. */
|
|
428
399
|
quantityAvailable?: number | null;
|
|
429
400
|
}
|
|
430
|
-
|
|
401
|
+
declare enum ItemAvailabilityStatus {
|
|
431
402
|
AVAILABLE = "AVAILABLE",
|
|
432
403
|
/** Item does not exist. */
|
|
433
404
|
NOT_FOUND = "NOT_FOUND",
|
|
@@ -436,7 +407,7 @@ export declare enum ItemAvailabilityStatus {
|
|
|
436
407
|
/** Available quantity is less than requested. */
|
|
437
408
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
438
409
|
}
|
|
439
|
-
|
|
410
|
+
interface PhysicalProperties {
|
|
440
411
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
441
412
|
weight?: number | null;
|
|
442
413
|
/**
|
|
@@ -447,39 +418,39 @@ export interface PhysicalProperties {
|
|
|
447
418
|
/** Whether this line item is shippable. */
|
|
448
419
|
shippable?: boolean;
|
|
449
420
|
}
|
|
450
|
-
|
|
421
|
+
interface Scope {
|
|
451
422
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
452
423
|
namespace?: string;
|
|
453
424
|
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
454
425
|
group?: Group;
|
|
455
426
|
}
|
|
456
|
-
|
|
427
|
+
interface Group {
|
|
457
428
|
/** 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). */
|
|
458
429
|
name?: string;
|
|
459
430
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
460
431
|
entityId?: string | null;
|
|
461
432
|
}
|
|
462
|
-
|
|
433
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
463
434
|
/** Preset item type. */
|
|
464
435
|
preset?: ItemTypeItemType;
|
|
465
436
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
466
437
|
custom?: string;
|
|
467
438
|
}
|
|
468
439
|
/** @oneof */
|
|
469
|
-
|
|
440
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
470
441
|
/** Preset item type. */
|
|
471
442
|
preset?: ItemTypeItemType;
|
|
472
443
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
473
444
|
custom?: string;
|
|
474
445
|
}
|
|
475
|
-
|
|
446
|
+
declare enum ItemTypeItemType {
|
|
476
447
|
UNRECOGNISED = "UNRECOGNISED",
|
|
477
448
|
PHYSICAL = "PHYSICAL",
|
|
478
449
|
DIGITAL = "DIGITAL",
|
|
479
450
|
GIFT_CARD = "GIFT_CARD",
|
|
480
451
|
SERVICE = "SERVICE"
|
|
481
452
|
}
|
|
482
|
-
|
|
453
|
+
interface SubscriptionOptionInfo {
|
|
483
454
|
/** Subscription option settings. */
|
|
484
455
|
subscriptionSettings?: SubscriptionSettings;
|
|
485
456
|
/** Subscription option title. */
|
|
@@ -487,7 +458,7 @@ export interface SubscriptionOptionInfo {
|
|
|
487
458
|
/** Subscription option description. */
|
|
488
459
|
description?: Description;
|
|
489
460
|
}
|
|
490
|
-
|
|
461
|
+
interface SubscriptionSettings {
|
|
491
462
|
/** Frequency of recurring payment. */
|
|
492
463
|
frequency?: SubscriptionFrequency;
|
|
493
464
|
/**
|
|
@@ -508,14 +479,14 @@ export interface SubscriptionSettings {
|
|
|
508
479
|
billingCycles?: number | null;
|
|
509
480
|
}
|
|
510
481
|
/** Frequency unit of recurring payment */
|
|
511
|
-
|
|
482
|
+
declare enum SubscriptionFrequency {
|
|
512
483
|
UNDEFINED = "UNDEFINED",
|
|
513
484
|
DAY = "DAY",
|
|
514
485
|
WEEK = "WEEK",
|
|
515
486
|
MONTH = "MONTH",
|
|
516
487
|
YEAR = "YEAR"
|
|
517
488
|
}
|
|
518
|
-
|
|
489
|
+
interface FreeTrialPeriod {
|
|
519
490
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
520
491
|
frequency?: SubscriptionFrequency;
|
|
521
492
|
/**
|
|
@@ -525,7 +496,7 @@ export interface FreeTrialPeriod {
|
|
|
525
496
|
*/
|
|
526
497
|
interval?: number;
|
|
527
498
|
}
|
|
528
|
-
|
|
499
|
+
interface Title {
|
|
529
500
|
/**
|
|
530
501
|
* 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).
|
|
531
502
|
* @minLength 1
|
|
@@ -541,7 +512,7 @@ export interface Title {
|
|
|
541
512
|
*/
|
|
542
513
|
translated?: string | null;
|
|
543
514
|
}
|
|
544
|
-
|
|
515
|
+
interface Description {
|
|
545
516
|
/**
|
|
546
517
|
* Subscription option description.
|
|
547
518
|
* @maxLength 500
|
|
@@ -553,13 +524,13 @@ export interface Description {
|
|
|
553
524
|
*/
|
|
554
525
|
translated?: string | null;
|
|
555
526
|
}
|
|
556
|
-
|
|
527
|
+
interface SecuredMedia {
|
|
557
528
|
/**
|
|
558
529
|
* Media ID in Wix Media Manager.
|
|
559
530
|
* @minLength 1
|
|
560
531
|
* @maxLength 100
|
|
561
532
|
*/
|
|
562
|
-
|
|
533
|
+
_id?: string;
|
|
563
534
|
/**
|
|
564
535
|
* Original filename.
|
|
565
536
|
* @minLength 1
|
|
@@ -569,7 +540,7 @@ export interface SecuredMedia {
|
|
|
569
540
|
/** File type. */
|
|
570
541
|
fileType?: FileType;
|
|
571
542
|
}
|
|
572
|
-
|
|
543
|
+
declare enum FileType {
|
|
573
544
|
UNSPECIFIED = "UNSPECIFIED",
|
|
574
545
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
575
546
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -578,7 +549,7 @@ export declare enum FileType {
|
|
|
578
549
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
579
550
|
}
|
|
580
551
|
/** Type of selected payment option for catalog item */
|
|
581
|
-
|
|
552
|
+
declare enum PaymentOptionType {
|
|
582
553
|
/** The entire payment for this item happens as part of the checkout. */
|
|
583
554
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
584
555
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -590,7 +561,7 @@ export declare enum PaymentOptionType {
|
|
|
590
561
|
/** 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`. */
|
|
591
562
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
592
563
|
}
|
|
593
|
-
|
|
564
|
+
interface ServiceProperties {
|
|
594
565
|
/**
|
|
595
566
|
* 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.
|
|
596
567
|
* For example, the start time of a class.
|
|
@@ -603,7 +574,7 @@ export interface ServiceProperties {
|
|
|
603
574
|
*/
|
|
604
575
|
numberOfParticipants?: number | null;
|
|
605
576
|
}
|
|
606
|
-
|
|
577
|
+
interface PriceDescription {
|
|
607
578
|
/**
|
|
608
579
|
* __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).
|
|
609
580
|
* @minLength 1
|
|
@@ -620,20 +591,20 @@ export interface PriceDescription {
|
|
|
620
591
|
translated?: string | null;
|
|
621
592
|
}
|
|
622
593
|
/** Selected Membership */
|
|
623
|
-
|
|
594
|
+
interface SelectedMembership {
|
|
624
595
|
/**
|
|
625
596
|
* Membership ID.
|
|
626
597
|
* @minLength 1
|
|
627
598
|
* @maxLength 100
|
|
628
599
|
*/
|
|
629
|
-
|
|
600
|
+
_id?: string;
|
|
630
601
|
/**
|
|
631
602
|
* ID of the app providing this payment option.
|
|
632
603
|
* @format GUID
|
|
633
604
|
*/
|
|
634
605
|
appId?: string;
|
|
635
606
|
}
|
|
636
|
-
|
|
607
|
+
interface CatalogOverrideFields {
|
|
637
608
|
/** Item name. */
|
|
638
609
|
productName?: ProductName;
|
|
639
610
|
/**
|
|
@@ -654,7 +625,7 @@ export interface CatalogOverrideFields {
|
|
|
654
625
|
/** Physical properties of the item. */
|
|
655
626
|
physicalProperties?: PhysicalProperties;
|
|
656
627
|
/** Item image. */
|
|
657
|
-
image?:
|
|
628
|
+
image?: string;
|
|
658
629
|
/** Payment method selected for the item. */
|
|
659
630
|
paymentOption?: PaymentOption;
|
|
660
631
|
/**
|
|
@@ -670,19 +641,7 @@ export interface CatalogOverrideFields {
|
|
|
670
641
|
*/
|
|
671
642
|
savePaymentMethod?: boolean | null;
|
|
672
643
|
}
|
|
673
|
-
|
|
674
|
-
/** WixMedia image ID. */
|
|
675
|
-
id?: string;
|
|
676
|
-
/** Original image height. */
|
|
677
|
-
height?: number;
|
|
678
|
-
/** Original image width. */
|
|
679
|
-
width?: number;
|
|
680
|
-
/** Image alt text. Optional. */
|
|
681
|
-
altText?: string | null;
|
|
682
|
-
/** Image filename. Optional. */
|
|
683
|
-
filename?: string | null;
|
|
684
|
-
}
|
|
685
|
-
export interface PaymentOption {
|
|
644
|
+
interface PaymentOption {
|
|
686
645
|
/**
|
|
687
646
|
* Type of selected payment option for current item.
|
|
688
647
|
*
|
|
@@ -690,22 +649,22 @@ export interface PaymentOption {
|
|
|
690
649
|
*/
|
|
691
650
|
value?: PaymentOptionType;
|
|
692
651
|
}
|
|
693
|
-
|
|
652
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
694
653
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
695
654
|
addressType?: TaxableAddressType;
|
|
696
655
|
}
|
|
697
656
|
/** @oneof */
|
|
698
|
-
|
|
657
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
699
658
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
700
659
|
addressType?: TaxableAddressType;
|
|
701
660
|
}
|
|
702
|
-
|
|
661
|
+
declare enum TaxableAddressType {
|
|
703
662
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
704
663
|
BUSINESS = "BUSINESS",
|
|
705
664
|
BILLING = "BILLING",
|
|
706
665
|
SHIPPING = "SHIPPING"
|
|
707
666
|
}
|
|
708
|
-
|
|
667
|
+
interface ExtendedFields {
|
|
709
668
|
/**
|
|
710
669
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
711
670
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -716,7 +675,7 @@ export interface ExtendedFields {
|
|
|
716
675
|
*/
|
|
717
676
|
namespaces?: Record<string, Record<string, any>>;
|
|
718
677
|
}
|
|
719
|
-
|
|
678
|
+
interface Policy {
|
|
720
679
|
/**
|
|
721
680
|
* Policy title - should be translated
|
|
722
681
|
* @minLength 1
|
|
@@ -730,13 +689,13 @@ export interface Policy {
|
|
|
730
689
|
*/
|
|
731
690
|
content?: string;
|
|
732
691
|
}
|
|
733
|
-
|
|
692
|
+
interface ModifierGroup {
|
|
734
693
|
/**
|
|
735
694
|
* Modifier group id.
|
|
736
695
|
* @minLength 1
|
|
737
696
|
* @maxLength 36
|
|
738
697
|
*/
|
|
739
|
-
|
|
698
|
+
_id?: string;
|
|
740
699
|
/** Modifier group name. */
|
|
741
700
|
name?: TranslatableString;
|
|
742
701
|
/**
|
|
@@ -746,7 +705,7 @@ export interface ModifierGroup {
|
|
|
746
705
|
*/
|
|
747
706
|
modifiers?: ItemModifier[];
|
|
748
707
|
}
|
|
749
|
-
|
|
708
|
+
interface TranslatableString {
|
|
750
709
|
/**
|
|
751
710
|
* __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).
|
|
752
711
|
*
|
|
@@ -767,13 +726,13 @@ export interface TranslatableString {
|
|
|
767
726
|
*/
|
|
768
727
|
translated?: string | null;
|
|
769
728
|
}
|
|
770
|
-
|
|
729
|
+
interface ItemModifier {
|
|
771
730
|
/**
|
|
772
731
|
* Modifier ID.
|
|
773
732
|
* @minLength 1
|
|
774
733
|
* @maxLength 36
|
|
775
734
|
*/
|
|
776
|
-
|
|
735
|
+
_id?: string;
|
|
777
736
|
/**
|
|
778
737
|
* The quantity of this modifier.
|
|
779
738
|
* @min 1
|
|
@@ -788,7 +747,7 @@ export interface ItemModifier {
|
|
|
788
747
|
price?: MultiCurrencyPrice;
|
|
789
748
|
}
|
|
790
749
|
/** Buyer Info */
|
|
791
|
-
|
|
750
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
792
751
|
/**
|
|
793
752
|
* Visitor ID. If the buyer is **not** a site member.
|
|
794
753
|
* @format GUID
|
|
@@ -819,7 +778,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
819
778
|
email?: string | null;
|
|
820
779
|
}
|
|
821
780
|
/** @oneof */
|
|
822
|
-
|
|
781
|
+
interface BuyerInfoIdOneOf {
|
|
823
782
|
/**
|
|
824
783
|
* Visitor ID. If the buyer is **not** a site member.
|
|
825
784
|
* @format GUID
|
|
@@ -839,7 +798,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
839
798
|
*/
|
|
840
799
|
userId?: string;
|
|
841
800
|
}
|
|
842
|
-
|
|
801
|
+
declare enum WeightUnit {
|
|
843
802
|
/** Weight unit can't be classified due to an error. */
|
|
844
803
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
845
804
|
/** Kilograms. */
|
|
@@ -847,41 +806,41 @@ export declare enum WeightUnit {
|
|
|
847
806
|
/** Pounds. */
|
|
848
807
|
LB = "LB"
|
|
849
808
|
}
|
|
850
|
-
|
|
809
|
+
interface CartDiscount extends CartDiscountDiscountSourceOneOf {
|
|
851
810
|
/** Coupon details. */
|
|
852
811
|
coupon?: Coupon;
|
|
853
812
|
/** Merchant discount. */
|
|
854
813
|
merchantDiscount?: MerchantDiscount;
|
|
855
814
|
}
|
|
856
815
|
/** @oneof */
|
|
857
|
-
|
|
816
|
+
interface CartDiscountDiscountSourceOneOf {
|
|
858
817
|
/** Coupon details. */
|
|
859
818
|
coupon?: Coupon;
|
|
860
819
|
/** Merchant discount. */
|
|
861
820
|
merchantDiscount?: MerchantDiscount;
|
|
862
821
|
}
|
|
863
|
-
|
|
822
|
+
interface Coupon {
|
|
864
823
|
/** Coupon ID. */
|
|
865
|
-
|
|
824
|
+
_id?: string;
|
|
866
825
|
/** Coupon code. */
|
|
867
826
|
code?: string;
|
|
868
827
|
}
|
|
869
|
-
|
|
828
|
+
interface MerchantDiscount {
|
|
870
829
|
/** Discount value. */
|
|
871
830
|
amount?: MultiCurrencyPrice;
|
|
872
831
|
}
|
|
873
|
-
|
|
832
|
+
interface DiscountRule {
|
|
874
833
|
/**
|
|
875
834
|
* Discount rule ID
|
|
876
835
|
* @format GUID
|
|
877
836
|
*/
|
|
878
|
-
|
|
837
|
+
_id?: string;
|
|
879
838
|
/** Discount rule name */
|
|
880
839
|
name?: DiscountRuleName;
|
|
881
840
|
/** Discount value. */
|
|
882
841
|
amount?: MultiCurrencyPrice;
|
|
883
842
|
}
|
|
884
|
-
|
|
843
|
+
interface DiscountRuleName {
|
|
885
844
|
/**
|
|
886
845
|
* Original discount rule name (in site's default language).
|
|
887
846
|
* @minLength 1
|
|
@@ -895,7 +854,7 @@ export interface DiscountRuleName {
|
|
|
895
854
|
*/
|
|
896
855
|
translated?: string | null;
|
|
897
856
|
}
|
|
898
|
-
|
|
857
|
+
declare enum DiscountType {
|
|
899
858
|
/** "GLOBAL" - discount applies to entire order. */
|
|
900
859
|
GLOBAL = "GLOBAL",
|
|
901
860
|
/** "SPECIFIC-ITEMS" - discount applies to specific items. */
|
|
@@ -904,14 +863,14 @@ export declare enum DiscountType {
|
|
|
904
863
|
SHIPPING = "SHIPPING"
|
|
905
864
|
}
|
|
906
865
|
/** Billing Info and shipping details */
|
|
907
|
-
|
|
866
|
+
interface AddressWithContact {
|
|
908
867
|
/** Address. */
|
|
909
868
|
address?: Address;
|
|
910
869
|
/** Contact details. */
|
|
911
870
|
contactDetails?: FullAddressContactDetails;
|
|
912
871
|
}
|
|
913
872
|
/** Physical address */
|
|
914
|
-
|
|
873
|
+
interface Address {
|
|
915
874
|
/**
|
|
916
875
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
917
876
|
* @format COUNTRY
|
|
@@ -938,7 +897,7 @@ export interface Address {
|
|
|
938
897
|
* Main address line (usually street name and number).
|
|
939
898
|
* @maxLength 150
|
|
940
899
|
*/
|
|
941
|
-
|
|
900
|
+
addressLine1?: string | null;
|
|
942
901
|
/**
|
|
943
902
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
944
903
|
* @maxLength 100
|
|
@@ -955,20 +914,20 @@ export interface Address {
|
|
|
955
914
|
*/
|
|
956
915
|
subdivisionFullname?: string | null;
|
|
957
916
|
}
|
|
958
|
-
|
|
917
|
+
interface StreetAddress {
|
|
959
918
|
/** Street number. */
|
|
960
919
|
number?: string;
|
|
961
920
|
/** Street name. */
|
|
962
921
|
name?: string;
|
|
963
922
|
}
|
|
964
|
-
|
|
923
|
+
interface AddressLocation {
|
|
965
924
|
/** Address latitude. */
|
|
966
925
|
latitude?: number | null;
|
|
967
926
|
/** Address longitude. */
|
|
968
927
|
longitude?: number | null;
|
|
969
928
|
}
|
|
970
929
|
/** Full contact details for an address */
|
|
971
|
-
|
|
930
|
+
interface FullAddressContactDetails {
|
|
972
931
|
/**
|
|
973
932
|
* First name.
|
|
974
933
|
* @maxLength 100
|
|
@@ -992,9 +951,9 @@ export interface FullAddressContactDetails {
|
|
|
992
951
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
993
952
|
vatId?: VatId;
|
|
994
953
|
}
|
|
995
|
-
|
|
954
|
+
interface VatId {
|
|
996
955
|
/** Customer's tax ID. */
|
|
997
|
-
|
|
956
|
+
_id?: string;
|
|
998
957
|
/**
|
|
999
958
|
* Tax type.
|
|
1000
959
|
*
|
|
@@ -1005,14 +964,14 @@ export interface VatId {
|
|
|
1005
964
|
type?: VatType;
|
|
1006
965
|
}
|
|
1007
966
|
/** tax info types */
|
|
1008
|
-
|
|
967
|
+
declare enum VatType {
|
|
1009
968
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1010
969
|
/** CPF - for individual tax payers. */
|
|
1011
970
|
CPF = "CPF",
|
|
1012
971
|
/** CNPJ - for corporations */
|
|
1013
972
|
CNPJ = "CNPJ"
|
|
1014
973
|
}
|
|
1015
|
-
|
|
974
|
+
interface SelectedShippingOption {
|
|
1016
975
|
/**
|
|
1017
976
|
* Carrier ID.
|
|
1018
977
|
* @format GUID
|
|
@@ -1025,13 +984,13 @@ export interface SelectedShippingOption {
|
|
|
1025
984
|
*/
|
|
1026
985
|
code?: string;
|
|
1027
986
|
}
|
|
1028
|
-
|
|
987
|
+
interface GetCurrentCartRequest {
|
|
1029
988
|
}
|
|
1030
|
-
|
|
989
|
+
interface GetCurrentCartResponse {
|
|
1031
990
|
/** Current session's active cart. */
|
|
1032
991
|
cart?: Cart;
|
|
1033
992
|
}
|
|
1034
|
-
|
|
993
|
+
interface UpdateCartRequest {
|
|
1035
994
|
/** Cart info. */
|
|
1036
995
|
cartInfo?: Cart;
|
|
1037
996
|
/** Coupon code. For more information, see the Coupons API. */
|
|
@@ -1055,7 +1014,7 @@ export interface UpdateCartRequest {
|
|
|
1055
1014
|
*/
|
|
1056
1015
|
customLineItems?: CustomLineItem[];
|
|
1057
1016
|
}
|
|
1058
|
-
|
|
1017
|
+
interface MerchantDiscountInput {
|
|
1059
1018
|
/**
|
|
1060
1019
|
* Discount amount.
|
|
1061
1020
|
* @decimalValue options { gte:0 }
|
|
@@ -1068,7 +1027,7 @@ export interface MerchantDiscountInput {
|
|
|
1068
1027
|
*/
|
|
1069
1028
|
lineItemIds?: string[];
|
|
1070
1029
|
}
|
|
1071
|
-
|
|
1030
|
+
interface CustomLineItem {
|
|
1072
1031
|
/**
|
|
1073
1032
|
* Custom line item quantity.
|
|
1074
1033
|
*
|
|
@@ -1093,15 +1052,19 @@ export interface CustomLineItem {
|
|
|
1093
1052
|
* @maxSize 10
|
|
1094
1053
|
*/
|
|
1095
1054
|
descriptionLines?: DescriptionLine[];
|
|
1096
|
-
/**
|
|
1097
|
-
|
|
1055
|
+
/**
|
|
1056
|
+
* Custom line item media. Supported formats:
|
|
1057
|
+
* + 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"`.
|
|
1058
|
+
* + An image from the web - `"http(s)://<image url>"`.
|
|
1059
|
+
*/
|
|
1060
|
+
media?: string;
|
|
1098
1061
|
/**
|
|
1099
1062
|
* Custom line item ID. If passed, `id` must be unique.
|
|
1100
1063
|
*
|
|
1101
1064
|
* Default: auto-generated ID
|
|
1102
1065
|
* @format GUID
|
|
1103
1066
|
*/
|
|
1104
|
-
|
|
1067
|
+
_id?: string | null;
|
|
1105
1068
|
/**
|
|
1106
1069
|
* Tax group ID for this custom line item.
|
|
1107
1070
|
* @format GUID
|
|
@@ -1110,7 +1073,7 @@ export interface CustomLineItem {
|
|
|
1110
1073
|
/** Name of the item or product. */
|
|
1111
1074
|
productName?: ProductName;
|
|
1112
1075
|
/** 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. */
|
|
1113
|
-
url?:
|
|
1076
|
+
url?: string;
|
|
1114
1077
|
/** Item type. Either a preset type or custom. */
|
|
1115
1078
|
itemType?: ItemType;
|
|
1116
1079
|
/**
|
|
@@ -1180,11 +1143,11 @@ export interface CustomLineItem {
|
|
|
1180
1143
|
*/
|
|
1181
1144
|
savePaymentMethod?: boolean;
|
|
1182
1145
|
}
|
|
1183
|
-
|
|
1146
|
+
interface UpdateCartResponse {
|
|
1184
1147
|
/** Updated Cart. */
|
|
1185
1148
|
cart?: Cart;
|
|
1186
1149
|
}
|
|
1187
|
-
|
|
1150
|
+
interface AddToCurrentCartRequest {
|
|
1188
1151
|
/**
|
|
1189
1152
|
* Catalog line items.
|
|
1190
1153
|
* @maxSize 100
|
|
@@ -1206,11 +1169,11 @@ export interface AddToCurrentCartRequest {
|
|
|
1206
1169
|
*/
|
|
1207
1170
|
businessLocationId?: string | null;
|
|
1208
1171
|
}
|
|
1209
|
-
|
|
1172
|
+
interface AddToCartResponse {
|
|
1210
1173
|
/** Updated cart. */
|
|
1211
1174
|
cart?: Cart;
|
|
1212
1175
|
}
|
|
1213
|
-
|
|
1176
|
+
interface AddToCurrentCartAndEstimateTotalsRequest {
|
|
1214
1177
|
/**
|
|
1215
1178
|
* Catalog line items.
|
|
1216
1179
|
* @maxSize 100
|
|
@@ -1245,20 +1208,20 @@ export interface AddToCurrentCartAndEstimateTotalsRequest {
|
|
|
1245
1208
|
*/
|
|
1246
1209
|
calculateShipping?: boolean | null;
|
|
1247
1210
|
}
|
|
1248
|
-
|
|
1211
|
+
interface SelectedMemberships {
|
|
1249
1212
|
/**
|
|
1250
1213
|
* Selected memberships.
|
|
1251
1214
|
* @maxSize 300
|
|
1252
1215
|
*/
|
|
1253
1216
|
memberships?: HostSelectedMembership[];
|
|
1254
1217
|
}
|
|
1255
|
-
|
|
1218
|
+
interface HostSelectedMembership {
|
|
1256
1219
|
/**
|
|
1257
1220
|
* Membership ID.
|
|
1258
1221
|
* @minLength 1
|
|
1259
1222
|
* @maxLength 100
|
|
1260
1223
|
*/
|
|
1261
|
-
|
|
1224
|
+
_id?: string;
|
|
1262
1225
|
/**
|
|
1263
1226
|
* ID of the app providing this payment option.
|
|
1264
1227
|
* @format GUID
|
|
@@ -1273,7 +1236,7 @@ export interface HostSelectedMembership {
|
|
|
1273
1236
|
*/
|
|
1274
1237
|
lineItemIds?: string[];
|
|
1275
1238
|
}
|
|
1276
|
-
|
|
1239
|
+
interface EstimateTotalsResponse {
|
|
1277
1240
|
/** Cart. */
|
|
1278
1241
|
cart?: Cart;
|
|
1279
1242
|
/** Calculated line items. */
|
|
@@ -1320,7 +1283,7 @@ export interface EstimateTotalsResponse {
|
|
|
1320
1283
|
*/
|
|
1321
1284
|
violations?: Violation[];
|
|
1322
1285
|
}
|
|
1323
|
-
|
|
1286
|
+
interface CalculatedLineItem {
|
|
1324
1287
|
/** Line item ID. */
|
|
1325
1288
|
lineItemId?: string;
|
|
1326
1289
|
/** Price breakdown for this line item. */
|
|
@@ -1334,7 +1297,7 @@ export interface CalculatedLineItem {
|
|
|
1334
1297
|
*/
|
|
1335
1298
|
paymentOption?: PaymentOptionType;
|
|
1336
1299
|
}
|
|
1337
|
-
|
|
1300
|
+
interface LineItemPricesData {
|
|
1338
1301
|
/** Total price after discounts, tax, and modifiers. */
|
|
1339
1302
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1340
1303
|
/** Total price after discounts and modifiers, and before tax. */
|
|
@@ -1360,7 +1323,7 @@ export interface LineItemPricesData {
|
|
|
1360
1323
|
/** Total price of all item modifiers. */
|
|
1361
1324
|
modifiers?: MultiCurrencyPrice;
|
|
1362
1325
|
}
|
|
1363
|
-
|
|
1326
|
+
interface ItemTaxFullDetails {
|
|
1364
1327
|
/** Amount for which tax is calculated. */
|
|
1365
1328
|
taxableAmount?: MultiCurrencyPrice;
|
|
1366
1329
|
/**
|
|
@@ -1377,7 +1340,7 @@ export interface ItemTaxFullDetails {
|
|
|
1377
1340
|
*/
|
|
1378
1341
|
rateBreakdown?: TaxRateBreakdown[];
|
|
1379
1342
|
}
|
|
1380
|
-
|
|
1343
|
+
interface TaxRateBreakdown {
|
|
1381
1344
|
/**
|
|
1382
1345
|
* Name of tax against which the calculation was performed.
|
|
1383
1346
|
* @maxLength 100
|
|
@@ -1395,7 +1358,7 @@ export interface TaxRateBreakdown {
|
|
|
1395
1358
|
* TaxBreakdown represents tax information for a line item.
|
|
1396
1359
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
1397
1360
|
*/
|
|
1398
|
-
|
|
1361
|
+
interface TaxBreakdown {
|
|
1399
1362
|
/**
|
|
1400
1363
|
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
1401
1364
|
* @maxLength 200
|
|
@@ -1427,7 +1390,7 @@ export interface TaxBreakdown {
|
|
|
1427
1390
|
jurisdictionType?: JurisdictionType;
|
|
1428
1391
|
}
|
|
1429
1392
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1430
|
-
|
|
1393
|
+
declare enum JurisdictionType {
|
|
1431
1394
|
UNDEFINED = "UNDEFINED",
|
|
1432
1395
|
COUNTRY = "COUNTRY",
|
|
1433
1396
|
STATE = "STATE",
|
|
@@ -1435,7 +1398,7 @@ export declare enum JurisdictionType {
|
|
|
1435
1398
|
CITY = "CITY",
|
|
1436
1399
|
SPECIAL = "SPECIAL"
|
|
1437
1400
|
}
|
|
1438
|
-
|
|
1401
|
+
interface PriceSummary {
|
|
1439
1402
|
/** Subtotal of all line items, before discounts and before tax. */
|
|
1440
1403
|
subtotal?: MultiCurrencyPrice;
|
|
1441
1404
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1449,12 +1412,12 @@ export interface PriceSummary {
|
|
|
1449
1412
|
/** Total additional fees price before tax. */
|
|
1450
1413
|
additionalFees?: MultiCurrencyPrice;
|
|
1451
1414
|
}
|
|
1452
|
-
|
|
1415
|
+
interface GiftCard {
|
|
1453
1416
|
/**
|
|
1454
1417
|
* Gift Card ID.
|
|
1455
1418
|
* @deprecated
|
|
1456
1419
|
*/
|
|
1457
|
-
|
|
1420
|
+
_id?: string;
|
|
1458
1421
|
/** Gift card obfuscated code. */
|
|
1459
1422
|
obfuscatedCode?: string;
|
|
1460
1423
|
/** Gift card value. */
|
|
@@ -1472,7 +1435,7 @@ export interface GiftCard {
|
|
|
1472
1435
|
*/
|
|
1473
1436
|
externalId?: string | null;
|
|
1474
1437
|
}
|
|
1475
|
-
|
|
1438
|
+
interface TaxSummary {
|
|
1476
1439
|
/**
|
|
1477
1440
|
* Amount for which tax is calculated, added from line items.
|
|
1478
1441
|
* @readonly
|
|
@@ -1489,7 +1452,7 @@ export interface TaxSummary {
|
|
|
1489
1452
|
*/
|
|
1490
1453
|
calculationDetails?: TaxCalculationDetails;
|
|
1491
1454
|
}
|
|
1492
|
-
|
|
1455
|
+
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1493
1456
|
/** Reason the manual calculation was used. */
|
|
1494
1457
|
manualRateReason?: ManualCalculationReason;
|
|
1495
1458
|
/** Details of the fallback rate calculation. */
|
|
@@ -1498,13 +1461,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
|
|
|
1498
1461
|
rateType?: RateType;
|
|
1499
1462
|
}
|
|
1500
1463
|
/** @oneof */
|
|
1501
|
-
|
|
1464
|
+
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1502
1465
|
/** Reason the manual calculation was used. */
|
|
1503
1466
|
manualRateReason?: ManualCalculationReason;
|
|
1504
1467
|
/** Details of the fallback rate calculation. */
|
|
1505
1468
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1506
1469
|
}
|
|
1507
|
-
|
|
1470
|
+
declare enum RateType {
|
|
1508
1471
|
/** no tax being collected for this request due to location of purchase */
|
|
1509
1472
|
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
1510
1473
|
/** manual rate used for calculation */
|
|
@@ -1514,25 +1477,25 @@ export declare enum RateType {
|
|
|
1514
1477
|
/** fallback rate used for calculation */
|
|
1515
1478
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1516
1479
|
}
|
|
1517
|
-
|
|
1480
|
+
declare enum ManualCalculationReason {
|
|
1518
1481
|
/** user set calculator in Business Manager to be Manual */
|
|
1519
1482
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1520
1483
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1521
1484
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1522
1485
|
}
|
|
1523
|
-
|
|
1486
|
+
interface AutoTaxFallbackCalculationDetails {
|
|
1524
1487
|
/** reason for fallback */
|
|
1525
1488
|
fallbackReason?: FallbackReason;
|
|
1526
1489
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1527
1490
|
error?: ApplicationError;
|
|
1528
1491
|
}
|
|
1529
|
-
|
|
1492
|
+
declare enum FallbackReason {
|
|
1530
1493
|
/** auto-tax failed to be calculated */
|
|
1531
1494
|
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
1532
1495
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
1533
1496
|
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
1534
1497
|
}
|
|
1535
|
-
|
|
1498
|
+
interface ApplicationError {
|
|
1536
1499
|
/** Error code. */
|
|
1537
1500
|
code?: string;
|
|
1538
1501
|
/** Description of the error. */
|
|
@@ -1544,7 +1507,7 @@ export interface ApplicationError {
|
|
|
1544
1507
|
* 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.
|
|
1545
1508
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1546
1509
|
*/
|
|
1547
|
-
|
|
1510
|
+
interface AggregatedTaxBreakdown {
|
|
1548
1511
|
/**
|
|
1549
1512
|
* The name of the tax against which this tax amount was calculated.
|
|
1550
1513
|
* @maxLength 200
|
|
@@ -1570,7 +1533,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
1570
1533
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1571
1534
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
1572
1535
|
}
|
|
1573
|
-
|
|
1536
|
+
interface ShippingInformation {
|
|
1574
1537
|
/** Shipping region. */
|
|
1575
1538
|
region?: ShippingRegion;
|
|
1576
1539
|
/** Selected shipping option. */
|
|
@@ -1578,20 +1541,20 @@ export interface ShippingInformation {
|
|
|
1578
1541
|
/** All shipping options. */
|
|
1579
1542
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
1580
1543
|
}
|
|
1581
|
-
|
|
1544
|
+
interface ShippingRegion {
|
|
1582
1545
|
/**
|
|
1583
1546
|
* Shipping region ID.
|
|
1584
1547
|
* @format GUID
|
|
1585
1548
|
* @readonly
|
|
1586
1549
|
*/
|
|
1587
|
-
|
|
1550
|
+
_id?: string;
|
|
1588
1551
|
/**
|
|
1589
1552
|
* Shipping region name.
|
|
1590
1553
|
* @maxLength 100
|
|
1591
1554
|
*/
|
|
1592
1555
|
name?: string;
|
|
1593
1556
|
}
|
|
1594
|
-
|
|
1557
|
+
interface SelectedCarrierServiceOption {
|
|
1595
1558
|
/**
|
|
1596
1559
|
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1597
1560
|
* @maxLength 100
|
|
@@ -1634,7 +1597,7 @@ export interface SelectedCarrierServiceOption {
|
|
|
1634
1597
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1635
1598
|
partial?: boolean | null;
|
|
1636
1599
|
}
|
|
1637
|
-
|
|
1600
|
+
interface DeliveryLogistics {
|
|
1638
1601
|
/**
|
|
1639
1602
|
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1640
1603
|
* @maxLength 500
|
|
@@ -1648,7 +1611,7 @@ export interface DeliveryLogistics {
|
|
|
1648
1611
|
/** Pickup details. */
|
|
1649
1612
|
pickupDetails?: PickupDetails;
|
|
1650
1613
|
}
|
|
1651
|
-
|
|
1614
|
+
interface PickupDetails {
|
|
1652
1615
|
/** Pickup address. */
|
|
1653
1616
|
address?: Address;
|
|
1654
1617
|
/**
|
|
@@ -1659,18 +1622,18 @@ export interface PickupDetails {
|
|
|
1659
1622
|
/** Pickup method */
|
|
1660
1623
|
pickupMethod?: PickupMethod;
|
|
1661
1624
|
}
|
|
1662
|
-
|
|
1625
|
+
declare enum PickupMethod {
|
|
1663
1626
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1664
1627
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1665
1628
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1666
1629
|
}
|
|
1667
|
-
|
|
1630
|
+
interface DeliveryTimeSlot {
|
|
1668
1631
|
/** starting time of the delivery time slot */
|
|
1669
1632
|
from?: Date | null;
|
|
1670
1633
|
/** ending time of the delivery time slot */
|
|
1671
1634
|
to?: Date | null;
|
|
1672
1635
|
}
|
|
1673
|
-
|
|
1636
|
+
interface SelectedCarrierServiceOptionPrices {
|
|
1674
1637
|
/** Total shipping price, after discount and after tax. */
|
|
1675
1638
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1676
1639
|
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
@@ -1682,7 +1645,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1682
1645
|
/** Shipping price before discount and before tax. */
|
|
1683
1646
|
price?: MultiCurrencyPrice;
|
|
1684
1647
|
}
|
|
1685
|
-
|
|
1648
|
+
interface SelectedCarrierServiceOptionOtherCharge {
|
|
1686
1649
|
/** Type of additional cost. */
|
|
1687
1650
|
type?: ChargeType;
|
|
1688
1651
|
/**
|
|
@@ -1693,11 +1656,11 @@ export interface SelectedCarrierServiceOptionOtherCharge {
|
|
|
1693
1656
|
/** Price of added charge. */
|
|
1694
1657
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
1695
1658
|
}
|
|
1696
|
-
|
|
1659
|
+
declare enum ChargeType {
|
|
1697
1660
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1698
1661
|
INSURANCE = "INSURANCE"
|
|
1699
1662
|
}
|
|
1700
|
-
|
|
1663
|
+
interface DeliveryAllocation {
|
|
1701
1664
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1702
1665
|
deliveryCarrier?: Carrier;
|
|
1703
1666
|
/** The delivery region that are relevant for this delivery solution. */
|
|
@@ -1705,7 +1668,7 @@ export interface DeliveryAllocation {
|
|
|
1705
1668
|
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
1706
1669
|
applicableLineItems?: ApplicableLineItems;
|
|
1707
1670
|
}
|
|
1708
|
-
|
|
1671
|
+
interface Carrier {
|
|
1709
1672
|
/**
|
|
1710
1673
|
* The carrier app id
|
|
1711
1674
|
* @format GUID
|
|
@@ -1717,19 +1680,19 @@ export interface Carrier {
|
|
|
1717
1680
|
*/
|
|
1718
1681
|
code?: string;
|
|
1719
1682
|
}
|
|
1720
|
-
|
|
1683
|
+
interface Region {
|
|
1721
1684
|
/**
|
|
1722
1685
|
* The delivery region id.
|
|
1723
1686
|
* @format GUID
|
|
1724
1687
|
*/
|
|
1725
|
-
|
|
1688
|
+
_id?: string | null;
|
|
1726
1689
|
/**
|
|
1727
1690
|
* The delivery region name.
|
|
1728
1691
|
* @maxLength 100
|
|
1729
1692
|
*/
|
|
1730
1693
|
name?: string | null;
|
|
1731
1694
|
}
|
|
1732
|
-
|
|
1695
|
+
interface ApplicableLineItems {
|
|
1733
1696
|
/**
|
|
1734
1697
|
* Line items that the delivery solution is for.
|
|
1735
1698
|
* @maxSize 300
|
|
@@ -1738,7 +1701,7 @@ export interface ApplicableLineItems {
|
|
|
1738
1701
|
*/
|
|
1739
1702
|
lineItemIds?: string[];
|
|
1740
1703
|
}
|
|
1741
|
-
|
|
1704
|
+
interface CarrierServiceOption {
|
|
1742
1705
|
/**
|
|
1743
1706
|
* Carrier ID.
|
|
1744
1707
|
* @format GUID
|
|
@@ -1747,7 +1710,7 @@ export interface CarrierServiceOption {
|
|
|
1747
1710
|
/** Shipping options offered by this carrier for this request. */
|
|
1748
1711
|
shippingOptions?: ShippingOption[];
|
|
1749
1712
|
}
|
|
1750
|
-
|
|
1713
|
+
interface ShippingOption {
|
|
1751
1714
|
/**
|
|
1752
1715
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1753
1716
|
* For legacy calculators this would be the UUID of the option.
|
|
@@ -1772,19 +1735,19 @@ export interface ShippingOption {
|
|
|
1772
1735
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1773
1736
|
partial?: boolean | null;
|
|
1774
1737
|
}
|
|
1775
|
-
|
|
1738
|
+
interface ShippingPrice {
|
|
1776
1739
|
/** Shipping price. */
|
|
1777
1740
|
price?: MultiCurrencyPrice;
|
|
1778
1741
|
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
1779
1742
|
otherCharges?: OtherCharge[];
|
|
1780
1743
|
}
|
|
1781
|
-
|
|
1744
|
+
interface OtherCharge {
|
|
1782
1745
|
/** Type of additional cost. */
|
|
1783
1746
|
type?: ChargeType;
|
|
1784
1747
|
/** Price of added cost. */
|
|
1785
1748
|
price?: MultiCurrencyPrice;
|
|
1786
1749
|
}
|
|
1787
|
-
|
|
1750
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1788
1751
|
/** Coupon details. */
|
|
1789
1752
|
coupon?: V1Coupon;
|
|
1790
1753
|
/** Merchant discount. */
|
|
@@ -1803,7 +1766,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1803
1766
|
lineItemIds?: string[];
|
|
1804
1767
|
}
|
|
1805
1768
|
/** @oneof */
|
|
1806
|
-
|
|
1769
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1807
1770
|
/** Coupon details. */
|
|
1808
1771
|
coupon?: V1Coupon;
|
|
1809
1772
|
/** Merchant discount. */
|
|
@@ -1811,15 +1774,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1811
1774
|
/** Discount rule */
|
|
1812
1775
|
discountRule?: V1DiscountRule;
|
|
1813
1776
|
}
|
|
1814
|
-
|
|
1777
|
+
declare enum AppliedDiscountDiscountType {
|
|
1815
1778
|
GLOBAL = "GLOBAL",
|
|
1816
1779
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1817
1780
|
SHIPPING = "SHIPPING"
|
|
1818
1781
|
}
|
|
1819
1782
|
/** Coupon */
|
|
1820
|
-
|
|
1783
|
+
interface V1Coupon {
|
|
1821
1784
|
/** Coupon ID. */
|
|
1822
|
-
|
|
1785
|
+
_id?: string;
|
|
1823
1786
|
/** Coupon code. */
|
|
1824
1787
|
code?: string;
|
|
1825
1788
|
/** Coupon value. */
|
|
@@ -1827,7 +1790,7 @@ export interface V1Coupon {
|
|
|
1827
1790
|
/** Coupon name. */
|
|
1828
1791
|
name?: string;
|
|
1829
1792
|
}
|
|
1830
|
-
|
|
1793
|
+
interface V1MerchantDiscount {
|
|
1831
1794
|
/** Discount value. */
|
|
1832
1795
|
amount?: MultiCurrencyPrice;
|
|
1833
1796
|
/**
|
|
@@ -1837,18 +1800,18 @@ export interface V1MerchantDiscount {
|
|
|
1837
1800
|
*/
|
|
1838
1801
|
percentage?: number | null;
|
|
1839
1802
|
}
|
|
1840
|
-
|
|
1803
|
+
interface V1DiscountRule {
|
|
1841
1804
|
/**
|
|
1842
1805
|
* Discount rule ID
|
|
1843
1806
|
* @format GUID
|
|
1844
1807
|
*/
|
|
1845
|
-
|
|
1808
|
+
_id?: string;
|
|
1846
1809
|
/** Discount rule name */
|
|
1847
1810
|
name?: V1DiscountRuleName;
|
|
1848
1811
|
/** Discount value. */
|
|
1849
1812
|
amount?: MultiCurrencyPrice;
|
|
1850
1813
|
}
|
|
1851
|
-
|
|
1814
|
+
interface V1DiscountRuleName {
|
|
1852
1815
|
/**
|
|
1853
1816
|
* Original discount rule name (in site's default language).
|
|
1854
1817
|
* @minLength 1
|
|
@@ -1862,16 +1825,16 @@ export interface V1DiscountRuleName {
|
|
|
1862
1825
|
*/
|
|
1863
1826
|
translated?: string | null;
|
|
1864
1827
|
}
|
|
1865
|
-
|
|
1828
|
+
interface LineItemDiscount {
|
|
1866
1829
|
/**
|
|
1867
1830
|
* ID of line item the discount applies to.
|
|
1868
1831
|
* @format GUID
|
|
1869
1832
|
*/
|
|
1870
|
-
|
|
1833
|
+
_id?: string;
|
|
1871
1834
|
/** Discount value. */
|
|
1872
1835
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
1873
1836
|
}
|
|
1874
|
-
|
|
1837
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1875
1838
|
/** General shipping calculation error. */
|
|
1876
1839
|
generalShippingCalculationError?: Details;
|
|
1877
1840
|
/** Carrier errors. */
|
|
@@ -1893,13 +1856,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
1893
1856
|
discountsCalculationError?: Details;
|
|
1894
1857
|
}
|
|
1895
1858
|
/** @oneof */
|
|
1896
|
-
|
|
1859
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1897
1860
|
/** General shipping calculation error. */
|
|
1898
1861
|
generalShippingCalculationError?: Details;
|
|
1899
1862
|
/** Carrier errors. */
|
|
1900
1863
|
carrierErrors?: CarrierErrors;
|
|
1901
1864
|
}
|
|
1902
|
-
|
|
1865
|
+
interface Details extends DetailsKindOneOf {
|
|
1903
1866
|
applicationError?: ApplicationError;
|
|
1904
1867
|
validationError?: ValidationError;
|
|
1905
1868
|
systemError?: SystemError;
|
|
@@ -1910,7 +1873,7 @@ export interface Details extends DetailsKindOneOf {
|
|
|
1910
1873
|
tracing?: Record<string, string>;
|
|
1911
1874
|
}
|
|
1912
1875
|
/** @oneof */
|
|
1913
|
-
|
|
1876
|
+
interface DetailsKindOneOf {
|
|
1914
1877
|
applicationError?: ApplicationError;
|
|
1915
1878
|
validationError?: ValidationError;
|
|
1916
1879
|
systemError?: SystemError;
|
|
@@ -1947,10 +1910,10 @@ export interface DetailsKindOneOf {
|
|
|
1947
1910
|
* ]
|
|
1948
1911
|
* }
|
|
1949
1912
|
*/
|
|
1950
|
-
|
|
1913
|
+
interface ValidationError {
|
|
1951
1914
|
fieldViolations?: FieldViolation[];
|
|
1952
1915
|
}
|
|
1953
|
-
|
|
1916
|
+
declare enum RuleType {
|
|
1954
1917
|
VALIDATION = "VALIDATION",
|
|
1955
1918
|
OTHER = "OTHER",
|
|
1956
1919
|
MAX = "MAX",
|
|
@@ -1973,7 +1936,7 @@ export declare enum RuleType {
|
|
|
1973
1936
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1974
1937
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1975
1938
|
}
|
|
1976
|
-
|
|
1939
|
+
interface FieldViolation {
|
|
1977
1940
|
field?: string;
|
|
1978
1941
|
description?: string;
|
|
1979
1942
|
violatedRule?: RuleType;
|
|
@@ -1981,21 +1944,21 @@ export interface FieldViolation {
|
|
|
1981
1944
|
ruleName?: string | null;
|
|
1982
1945
|
data?: Record<string, any> | null;
|
|
1983
1946
|
}
|
|
1984
|
-
|
|
1947
|
+
interface SystemError {
|
|
1985
1948
|
/** Error code. */
|
|
1986
1949
|
errorCode?: string | null;
|
|
1987
1950
|
}
|
|
1988
|
-
|
|
1951
|
+
interface CarrierErrors {
|
|
1989
1952
|
/** Carrier errors. */
|
|
1990
1953
|
errors?: CarrierError[];
|
|
1991
1954
|
}
|
|
1992
|
-
|
|
1955
|
+
interface CarrierError {
|
|
1993
1956
|
/** Carrier ID. */
|
|
1994
1957
|
carrierId?: string;
|
|
1995
1958
|
/** Error details. */
|
|
1996
1959
|
error?: Details;
|
|
1997
1960
|
}
|
|
1998
|
-
|
|
1961
|
+
interface MembershipOptions {
|
|
1999
1962
|
/**
|
|
2000
1963
|
* List of payment options that can be used.
|
|
2001
1964
|
* @maxSize 300
|
|
@@ -2012,13 +1975,13 @@ export interface MembershipOptions {
|
|
|
2012
1975
|
*/
|
|
2013
1976
|
selectedMemberships?: HostSelectedMembership[];
|
|
2014
1977
|
}
|
|
2015
|
-
|
|
1978
|
+
interface Membership {
|
|
2016
1979
|
/**
|
|
2017
1980
|
* Membership ID.
|
|
2018
1981
|
* @minLength 1
|
|
2019
1982
|
* @maxLength 100
|
|
2020
1983
|
*/
|
|
2021
|
-
|
|
1984
|
+
_id?: string;
|
|
2022
1985
|
/**
|
|
2023
1986
|
* ID of the application providing this payment option.
|
|
2024
1987
|
* @format GUID
|
|
@@ -2041,7 +2004,7 @@ export interface Membership {
|
|
|
2041
2004
|
/** Additional data about this membership. */
|
|
2042
2005
|
additionalData?: Record<string, any> | null;
|
|
2043
2006
|
}
|
|
2044
|
-
|
|
2007
|
+
interface MembershipName {
|
|
2045
2008
|
/**
|
|
2046
2009
|
* Membership name.
|
|
2047
2010
|
* @maxLength 100
|
|
@@ -2053,7 +2016,7 @@ export interface MembershipName {
|
|
|
2053
2016
|
*/
|
|
2054
2017
|
translated?: string | null;
|
|
2055
2018
|
}
|
|
2056
|
-
|
|
2019
|
+
interface MembershipPaymentCredits {
|
|
2057
2020
|
/**
|
|
2058
2021
|
* Membership's total amount of credits.
|
|
2059
2022
|
* @min 1
|
|
@@ -2062,7 +2025,7 @@ export interface MembershipPaymentCredits {
|
|
|
2062
2025
|
/** Membership's remaining amount of credits. */
|
|
2063
2026
|
remaining?: number;
|
|
2064
2027
|
}
|
|
2065
|
-
|
|
2028
|
+
interface InvalidMembership {
|
|
2066
2029
|
/** Membership details. */
|
|
2067
2030
|
membership?: Membership;
|
|
2068
2031
|
/**
|
|
@@ -2072,7 +2035,7 @@ export interface InvalidMembership {
|
|
|
2072
2035
|
*/
|
|
2073
2036
|
reason?: string;
|
|
2074
2037
|
}
|
|
2075
|
-
|
|
2038
|
+
interface AdditionalFee {
|
|
2076
2039
|
/**
|
|
2077
2040
|
* Additional fee's unique code (or ID) for future processing.
|
|
2078
2041
|
* @minLength 1
|
|
@@ -2108,7 +2071,7 @@ export interface AdditionalFee {
|
|
|
2108
2071
|
/** the source the additional fee was added from */
|
|
2109
2072
|
source?: AdditionalFeeSource;
|
|
2110
2073
|
}
|
|
2111
|
-
|
|
2074
|
+
declare enum AdditionalFeeSource {
|
|
2112
2075
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
2113
2076
|
/** The additional fee was added by an additional fee service plugin */
|
|
2114
2077
|
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
@@ -2117,7 +2080,7 @@ export declare enum AdditionalFeeSource {
|
|
|
2117
2080
|
/** The additional fee was added manually on the request */
|
|
2118
2081
|
MANUAL = "MANUAL"
|
|
2119
2082
|
}
|
|
2120
|
-
|
|
2083
|
+
interface Violation {
|
|
2121
2084
|
/** 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. */
|
|
2122
2085
|
severity?: Severity;
|
|
2123
2086
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
@@ -2129,7 +2092,7 @@ export interface Violation {
|
|
|
2129
2092
|
*/
|
|
2130
2093
|
description?: string | null;
|
|
2131
2094
|
}
|
|
2132
|
-
|
|
2095
|
+
declare enum Severity {
|
|
2133
2096
|
/** The user is allowed to move forward in the flow. */
|
|
2134
2097
|
WARNING = "WARNING",
|
|
2135
2098
|
/**
|
|
@@ -2138,48 +2101,48 @@ export declare enum Severity {
|
|
|
2138
2101
|
*/
|
|
2139
2102
|
ERROR = "ERROR"
|
|
2140
2103
|
}
|
|
2141
|
-
|
|
2104
|
+
interface Target extends TargetTargetTypeOneOf {
|
|
2142
2105
|
/** General (other) violation. */
|
|
2143
2106
|
other?: Other;
|
|
2144
2107
|
/** Specific line item violation. */
|
|
2145
2108
|
lineItem?: TargetLineItem;
|
|
2146
2109
|
}
|
|
2147
2110
|
/** @oneof */
|
|
2148
|
-
|
|
2111
|
+
interface TargetTargetTypeOneOf {
|
|
2149
2112
|
/** General (other) violation. */
|
|
2150
2113
|
other?: Other;
|
|
2151
2114
|
/** Specific line item violation. */
|
|
2152
2115
|
lineItem?: TargetLineItem;
|
|
2153
2116
|
}
|
|
2154
2117
|
/** Available locations on the webpage */
|
|
2155
|
-
|
|
2118
|
+
declare enum NameInOther {
|
|
2156
2119
|
/** Default location, in case no specific location is specified. */
|
|
2157
2120
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
2158
2121
|
}
|
|
2159
2122
|
/** Available locations on the line item */
|
|
2160
|
-
|
|
2123
|
+
declare enum NameInLineItem {
|
|
2161
2124
|
/** Default location, in case no specific location is specified. */
|
|
2162
2125
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
2163
2126
|
}
|
|
2164
|
-
|
|
2127
|
+
declare enum SuggestedFix {
|
|
2165
2128
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
2166
2129
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
2167
2130
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
2168
2131
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
2169
2132
|
}
|
|
2170
2133
|
/** General (other) violation. */
|
|
2171
|
-
|
|
2134
|
+
interface Other {
|
|
2172
2135
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
2173
2136
|
name?: NameInOther;
|
|
2174
2137
|
}
|
|
2175
2138
|
/** Specific line item violation. */
|
|
2176
|
-
|
|
2139
|
+
interface TargetLineItem {
|
|
2177
2140
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
2178
2141
|
name?: NameInLineItem;
|
|
2179
2142
|
/** ID of the line item containing the violation. */
|
|
2180
|
-
|
|
2143
|
+
_id?: string | null;
|
|
2181
2144
|
}
|
|
2182
|
-
|
|
2145
|
+
interface RemoveLineItemsFromCurrentCartRequest {
|
|
2183
2146
|
/**
|
|
2184
2147
|
* Line item IDs to remove from cart.
|
|
2185
2148
|
* @format GUID
|
|
@@ -2188,11 +2151,11 @@ export interface RemoveLineItemsFromCurrentCartRequest {
|
|
|
2188
2151
|
*/
|
|
2189
2152
|
lineItemIds?: string[];
|
|
2190
2153
|
}
|
|
2191
|
-
|
|
2154
|
+
interface RemoveLineItemsResponse {
|
|
2192
2155
|
/** Updated cart. */
|
|
2193
2156
|
cart?: Cart;
|
|
2194
2157
|
}
|
|
2195
|
-
|
|
2158
|
+
interface CreateCheckoutFromCurrentCartRequest {
|
|
2196
2159
|
/** __Required.__ Sales channel type. */
|
|
2197
2160
|
channelType?: ChannelType;
|
|
2198
2161
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
@@ -2207,7 +2170,7 @@ export interface CreateCheckoutFromCurrentCartRequest {
|
|
|
2207
2170
|
*/
|
|
2208
2171
|
email?: string | null;
|
|
2209
2172
|
}
|
|
2210
|
-
|
|
2173
|
+
declare enum ChannelType {
|
|
2211
2174
|
/** Unspecified sales channel. This value is not supported. */
|
|
2212
2175
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2213
2176
|
/** A web client. */
|
|
@@ -2241,17 +2204,17 @@ export declare enum ChannelType {
|
|
|
2241
2204
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2242
2205
|
FAIRE_COM = "FAIRE_COM"
|
|
2243
2206
|
}
|
|
2244
|
-
|
|
2207
|
+
interface CreateCheckoutResponse {
|
|
2245
2208
|
/** The newly created checkout's ID. */
|
|
2246
2209
|
checkoutId?: string;
|
|
2247
2210
|
}
|
|
2248
|
-
|
|
2211
|
+
interface RemoveCouponFromCurrentCartRequest {
|
|
2249
2212
|
}
|
|
2250
|
-
|
|
2213
|
+
interface RemoveCouponResponse {
|
|
2251
2214
|
/** Updated cart. */
|
|
2252
2215
|
cart?: Cart;
|
|
2253
2216
|
}
|
|
2254
|
-
|
|
2217
|
+
interface UpdateCurrentCartLineItemQuantityRequest {
|
|
2255
2218
|
/**
|
|
2256
2219
|
* Line item IDs and their new quantity.
|
|
2257
2220
|
* @minSize 1
|
|
@@ -2259,12 +2222,12 @@ export interface UpdateCurrentCartLineItemQuantityRequest {
|
|
|
2259
2222
|
*/
|
|
2260
2223
|
lineItems?: LineItemQuantityUpdate[];
|
|
2261
2224
|
}
|
|
2262
|
-
|
|
2225
|
+
interface LineItemQuantityUpdate {
|
|
2263
2226
|
/**
|
|
2264
2227
|
* *Required.** Line item ID.
|
|
2265
2228
|
* @format GUID
|
|
2266
2229
|
*/
|
|
2267
|
-
|
|
2230
|
+
_id?: string;
|
|
2268
2231
|
/**
|
|
2269
2232
|
* *Required.** New quantity. Number must be 1 or higher.
|
|
2270
2233
|
* @min 1
|
|
@@ -2272,11 +2235,11 @@ export interface LineItemQuantityUpdate {
|
|
|
2272
2235
|
*/
|
|
2273
2236
|
quantity?: number;
|
|
2274
2237
|
}
|
|
2275
|
-
|
|
2238
|
+
interface UpdateLineItemsQuantityResponse {
|
|
2276
2239
|
/** Updated cart. */
|
|
2277
2240
|
cart?: Cart;
|
|
2278
2241
|
}
|
|
2279
|
-
|
|
2242
|
+
interface EstimateCurrentCartTotalsRequest {
|
|
2280
2243
|
/** Selected shipping option. */
|
|
2281
2244
|
selectedShippingOption?: SelectedShippingOption;
|
|
2282
2245
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
@@ -2298,11 +2261,11 @@ export interface EstimateCurrentCartTotalsRequest {
|
|
|
2298
2261
|
*/
|
|
2299
2262
|
calculateShipping?: boolean | null;
|
|
2300
2263
|
}
|
|
2301
|
-
|
|
2264
|
+
interface DeleteCurrentCartRequest {
|
|
2302
2265
|
}
|
|
2303
|
-
|
|
2266
|
+
interface DeleteCartResponse {
|
|
2304
2267
|
}
|
|
2305
|
-
|
|
2268
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2306
2269
|
createdEvent?: EntityCreatedEvent;
|
|
2307
2270
|
updatedEvent?: EntityUpdatedEvent;
|
|
2308
2271
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -2311,7 +2274,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2311
2274
|
* Unique event ID.
|
|
2312
2275
|
* Allows clients to ignore duplicate webhooks.
|
|
2313
2276
|
*/
|
|
2314
|
-
|
|
2277
|
+
_id?: string;
|
|
2315
2278
|
/**
|
|
2316
2279
|
* Assumes actions are also always typed to an entity_type
|
|
2317
2280
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -2345,36 +2308,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2345
2308
|
entityEventSequence?: string | null;
|
|
2346
2309
|
}
|
|
2347
2310
|
/** @oneof */
|
|
2348
|
-
|
|
2311
|
+
interface DomainEventBodyOneOf {
|
|
2349
2312
|
createdEvent?: EntityCreatedEvent;
|
|
2350
2313
|
updatedEvent?: EntityUpdatedEvent;
|
|
2351
2314
|
deletedEvent?: EntityDeletedEvent;
|
|
2352
2315
|
actionEvent?: ActionEvent;
|
|
2353
2316
|
}
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2357
|
-
restoreInfo?: RestoreInfo;
|
|
2317
|
+
interface EntityCreatedEvent {
|
|
2318
|
+
entity?: string;
|
|
2358
2319
|
}
|
|
2359
|
-
|
|
2320
|
+
interface RestoreInfo {
|
|
2360
2321
|
deletedDate?: Date | null;
|
|
2361
2322
|
}
|
|
2362
|
-
|
|
2323
|
+
interface EntityUpdatedEvent {
|
|
2363
2324
|
/**
|
|
2364
2325
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2365
2326
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2366
2327
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2367
2328
|
*/
|
|
2368
|
-
|
|
2329
|
+
currentEntity?: string;
|
|
2369
2330
|
}
|
|
2370
|
-
|
|
2331
|
+
interface EntityDeletedEvent {
|
|
2371
2332
|
/** Entity that was deleted */
|
|
2372
|
-
|
|
2333
|
+
deletedEntity?: string | null;
|
|
2373
2334
|
}
|
|
2374
|
-
|
|
2375
|
-
|
|
2335
|
+
interface ActionEvent {
|
|
2336
|
+
body?: string;
|
|
2376
2337
|
}
|
|
2377
|
-
|
|
2338
|
+
interface MessageEnvelope {
|
|
2378
2339
|
/**
|
|
2379
2340
|
* App instance ID.
|
|
2380
2341
|
* @format GUID
|
|
@@ -2390,7 +2351,7 @@ export interface MessageEnvelope {
|
|
|
2390
2351
|
/** Stringify payload. */
|
|
2391
2352
|
data?: string;
|
|
2392
2353
|
}
|
|
2393
|
-
|
|
2354
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2394
2355
|
/**
|
|
2395
2356
|
* ID of a site visitor that has not logged in to the site.
|
|
2396
2357
|
* @format GUID
|
|
@@ -2415,7 +2376,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2415
2376
|
identityType?: WebhookIdentityType;
|
|
2416
2377
|
}
|
|
2417
2378
|
/** @oneof */
|
|
2418
|
-
|
|
2379
|
+
interface IdentificationDataIdOneOf {
|
|
2419
2380
|
/**
|
|
2420
2381
|
* ID of a site visitor that has not logged in to the site.
|
|
2421
2382
|
* @format GUID
|
|
@@ -2437,14 +2398,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
2437
2398
|
*/
|
|
2438
2399
|
appId?: string;
|
|
2439
2400
|
}
|
|
2440
|
-
|
|
2401
|
+
declare enum WebhookIdentityType {
|
|
2441
2402
|
UNKNOWN = "UNKNOWN",
|
|
2442
2403
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2443
2404
|
MEMBER = "MEMBER",
|
|
2444
2405
|
WIX_USER = "WIX_USER",
|
|
2445
2406
|
APP = "APP"
|
|
2446
2407
|
}
|
|
2447
|
-
|
|
2408
|
+
interface CreateCartRequest {
|
|
2448
2409
|
/** Cart info. */
|
|
2449
2410
|
cartInfo?: Cart;
|
|
2450
2411
|
/** Code of an existing coupon to apply to cart. For more information, see the Coupons API. */
|
|
@@ -2468,38 +2429,38 @@ export interface CreateCartRequest {
|
|
|
2468
2429
|
*/
|
|
2469
2430
|
customLineItems?: CustomLineItem[];
|
|
2470
2431
|
}
|
|
2471
|
-
|
|
2432
|
+
interface CreateCartResponse {
|
|
2472
2433
|
/** Cart. */
|
|
2473
2434
|
cart?: Cart;
|
|
2474
2435
|
}
|
|
2475
|
-
|
|
2436
|
+
interface GetCartRequest {
|
|
2476
2437
|
/**
|
|
2477
2438
|
* Cart ID.
|
|
2478
2439
|
* @format GUID
|
|
2479
2440
|
*/
|
|
2480
|
-
|
|
2441
|
+
_id: string;
|
|
2481
2442
|
}
|
|
2482
|
-
|
|
2443
|
+
interface GetCartResponse {
|
|
2483
2444
|
/** Retrieved cart. */
|
|
2484
2445
|
cart?: Cart;
|
|
2485
2446
|
}
|
|
2486
|
-
|
|
2447
|
+
interface GetCartByCheckoutIdRequest {
|
|
2487
2448
|
/**
|
|
2488
2449
|
* Checkout ID.
|
|
2489
2450
|
* @format GUID
|
|
2490
2451
|
*/
|
|
2491
|
-
|
|
2452
|
+
_id: string;
|
|
2492
2453
|
}
|
|
2493
|
-
|
|
2454
|
+
interface GetCartByCheckoutIdResponse {
|
|
2494
2455
|
/** Retrieved cart. */
|
|
2495
2456
|
cart?: Cart;
|
|
2496
2457
|
}
|
|
2497
|
-
|
|
2458
|
+
interface AddToCartRequest {
|
|
2498
2459
|
/**
|
|
2499
2460
|
* Cart ID.
|
|
2500
2461
|
* @format GUID
|
|
2501
2462
|
*/
|
|
2502
|
-
|
|
2463
|
+
_id: string;
|
|
2503
2464
|
/**
|
|
2504
2465
|
* Catalog line items.
|
|
2505
2466
|
* @maxSize 100
|
|
@@ -2522,12 +2483,12 @@ export interface AddToCartRequest {
|
|
|
2522
2483
|
*/
|
|
2523
2484
|
businessLocationId?: string | null;
|
|
2524
2485
|
}
|
|
2525
|
-
|
|
2486
|
+
interface RemoveLineItemsRequest {
|
|
2526
2487
|
/**
|
|
2527
2488
|
* Cart ID.
|
|
2528
2489
|
* @format GUID
|
|
2529
2490
|
*/
|
|
2530
|
-
|
|
2491
|
+
_id: string;
|
|
2531
2492
|
/**
|
|
2532
2493
|
* Line item IDs to remove from cart.
|
|
2533
2494
|
* @format GUID
|
|
@@ -2536,12 +2497,12 @@ export interface RemoveLineItemsRequest {
|
|
|
2536
2497
|
*/
|
|
2537
2498
|
lineItemIds: string[];
|
|
2538
2499
|
}
|
|
2539
|
-
|
|
2500
|
+
interface CreateCheckoutRequest {
|
|
2540
2501
|
/**
|
|
2541
2502
|
* Cart ID.
|
|
2542
2503
|
* @format GUID
|
|
2543
2504
|
*/
|
|
2544
|
-
|
|
2505
|
+
_id: string;
|
|
2545
2506
|
/** __Required.__ Sales channel type. */
|
|
2546
2507
|
channelType?: ChannelType;
|
|
2547
2508
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
@@ -2556,19 +2517,19 @@ export interface CreateCheckoutRequest {
|
|
|
2556
2517
|
*/
|
|
2557
2518
|
email?: string | null;
|
|
2558
2519
|
}
|
|
2559
|
-
|
|
2520
|
+
interface RemoveCouponRequest {
|
|
2560
2521
|
/**
|
|
2561
2522
|
* Cart ID.
|
|
2562
2523
|
* @format GUID
|
|
2563
2524
|
*/
|
|
2564
|
-
|
|
2525
|
+
_id: string;
|
|
2565
2526
|
}
|
|
2566
|
-
|
|
2527
|
+
interface UpdateLineItemsQuantityRequest {
|
|
2567
2528
|
/**
|
|
2568
2529
|
* Cart ID.
|
|
2569
2530
|
* @format GUID
|
|
2570
2531
|
*/
|
|
2571
|
-
|
|
2532
|
+
_id: string;
|
|
2572
2533
|
/**
|
|
2573
2534
|
* Line item IDs and their new quantity.
|
|
2574
2535
|
* @minSize 1
|
|
@@ -2576,12 +2537,12 @@ export interface UpdateLineItemsQuantityRequest {
|
|
|
2576
2537
|
*/
|
|
2577
2538
|
lineItems: LineItemQuantityUpdate[];
|
|
2578
2539
|
}
|
|
2579
|
-
|
|
2540
|
+
interface EstimateTotalsRequest {
|
|
2580
2541
|
/**
|
|
2581
2542
|
* Cart ID.
|
|
2582
2543
|
* @format GUID
|
|
2583
2544
|
*/
|
|
2584
|
-
|
|
2545
|
+
_id: string;
|
|
2585
2546
|
/** Selected shipping option. */
|
|
2586
2547
|
selectedShippingOption?: SelectedShippingOption;
|
|
2587
2548
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
@@ -2603,23 +2564,297 @@ export interface EstimateTotalsRequest {
|
|
|
2603
2564
|
*/
|
|
2604
2565
|
calculateShipping?: boolean | null;
|
|
2605
2566
|
}
|
|
2606
|
-
|
|
2567
|
+
interface DeleteCartRequest {
|
|
2607
2568
|
/**
|
|
2608
2569
|
* ID of the cart to delete.
|
|
2609
2570
|
* @format GUID
|
|
2610
2571
|
*/
|
|
2611
|
-
|
|
2572
|
+
_id: string;
|
|
2612
2573
|
}
|
|
2613
|
-
|
|
2574
|
+
interface Empty {
|
|
2614
2575
|
}
|
|
2615
|
-
|
|
2576
|
+
interface RemoveBusinessLocationRequest {
|
|
2616
2577
|
/**
|
|
2617
2578
|
* Cart ID.
|
|
2618
2579
|
* @format GUID
|
|
2619
2580
|
*/
|
|
2620
|
-
|
|
2581
|
+
_id: string;
|
|
2621
2582
|
}
|
|
2622
|
-
|
|
2583
|
+
interface RemoveBusinessLocationResponse {
|
|
2623
2584
|
/** Updated cart. */
|
|
2624
2585
|
cart?: Cart;
|
|
2625
2586
|
}
|
|
2587
|
+
interface BaseEventMetadata {
|
|
2588
|
+
/**
|
|
2589
|
+
* App instance ID.
|
|
2590
|
+
* @format GUID
|
|
2591
|
+
*/
|
|
2592
|
+
instanceId?: string | null;
|
|
2593
|
+
/**
|
|
2594
|
+
* Event type.
|
|
2595
|
+
* @maxLength 150
|
|
2596
|
+
*/
|
|
2597
|
+
eventType?: string;
|
|
2598
|
+
/** The identification type and identity data. */
|
|
2599
|
+
identity?: IdentificationData;
|
|
2600
|
+
}
|
|
2601
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
2602
|
+
/**
|
|
2603
|
+
* Unique event ID.
|
|
2604
|
+
* Allows clients to ignore duplicate webhooks.
|
|
2605
|
+
*/
|
|
2606
|
+
_id?: string;
|
|
2607
|
+
/**
|
|
2608
|
+
* Assumes actions are also always typed to an entity_type
|
|
2609
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2610
|
+
*/
|
|
2611
|
+
entityFqdn?: string;
|
|
2612
|
+
/**
|
|
2613
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2614
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2615
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2616
|
+
*/
|
|
2617
|
+
slug?: string;
|
|
2618
|
+
/** ID of the entity associated with the event. */
|
|
2619
|
+
entityId?: string;
|
|
2620
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2621
|
+
eventTime?: Date | null;
|
|
2622
|
+
/**
|
|
2623
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2624
|
+
* (for example, GDPR).
|
|
2625
|
+
*/
|
|
2626
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2627
|
+
/** If present, indicates the action that triggered the event. */
|
|
2628
|
+
originatedFrom?: string | null;
|
|
2629
|
+
/**
|
|
2630
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2631
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2632
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2633
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2634
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2635
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2636
|
+
*/
|
|
2637
|
+
entityEventSequence?: string | null;
|
|
2638
|
+
}
|
|
2639
|
+
interface CartDeletedEnvelope {
|
|
2640
|
+
metadata: EventMetadata;
|
|
2641
|
+
}
|
|
2642
|
+
interface CartUpdatedEnvelope {
|
|
2643
|
+
entity: Cart;
|
|
2644
|
+
metadata: EventMetadata;
|
|
2645
|
+
}
|
|
2646
|
+
interface CartCreatedEnvelope {
|
|
2647
|
+
entity: Cart;
|
|
2648
|
+
metadata: EventMetadata;
|
|
2649
|
+
}
|
|
2650
|
+
interface CreateCartOptions {
|
|
2651
|
+
/** Cart info. */
|
|
2652
|
+
cartInfo?: Cart;
|
|
2653
|
+
/** Code of an existing coupon to apply to cart. For more information, see the Coupons API. */
|
|
2654
|
+
couponCode?: string | null;
|
|
2655
|
+
/**
|
|
2656
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
|
|
2657
|
+
* @maxSize 100
|
|
2658
|
+
*/
|
|
2659
|
+
merchantDiscounts?: MerchantDiscountInput[];
|
|
2660
|
+
/**
|
|
2661
|
+
* Catalog line items.
|
|
2662
|
+
* @maxSize 300
|
|
2663
|
+
*/
|
|
2664
|
+
lineItems?: LineItem[];
|
|
2665
|
+
/**
|
|
2666
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2667
|
+
*
|
|
2668
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2669
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2670
|
+
* @maxSize 300
|
|
2671
|
+
*/
|
|
2672
|
+
customLineItems?: CustomLineItem[];
|
|
2673
|
+
}
|
|
2674
|
+
interface UpdateCartOptions {
|
|
2675
|
+
/** The information for the cart being updated. */
|
|
2676
|
+
cartInfo: {
|
|
2677
|
+
/**
|
|
2678
|
+
* Cart ID.
|
|
2679
|
+
* @format GUID
|
|
2680
|
+
*/
|
|
2681
|
+
_id?: string | null;
|
|
2682
|
+
/**
|
|
2683
|
+
* Line items.
|
|
2684
|
+
* @minSize 1
|
|
2685
|
+
* @maxSize 300
|
|
2686
|
+
* @readonly
|
|
2687
|
+
*/
|
|
2688
|
+
lineItems?: LineItem[];
|
|
2689
|
+
/**
|
|
2690
|
+
* [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
|
|
2691
|
+
* @maxLength 1000
|
|
2692
|
+
*/
|
|
2693
|
+
buyerNote?: string | null;
|
|
2694
|
+
/** Buyer information. */
|
|
2695
|
+
buyerInfo?: BuyerInfo;
|
|
2696
|
+
/**
|
|
2697
|
+
* Currency used for pricing.
|
|
2698
|
+
* @format CURRENCY
|
|
2699
|
+
* @readonly
|
|
2700
|
+
*/
|
|
2701
|
+
currency?: string;
|
|
2702
|
+
/**
|
|
2703
|
+
* Currency code used for all the converted prices that are returned.
|
|
2704
|
+
* For a site that supports multiple currencies, this is the currency the buyer selected.
|
|
2705
|
+
* @readonly
|
|
2706
|
+
* @format CURRENCY
|
|
2707
|
+
*/
|
|
2708
|
+
conversionCurrency?: string;
|
|
2709
|
+
/**
|
|
2710
|
+
* Language for communication with the buyer. Defaults to the site language.
|
|
2711
|
+
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
2712
|
+
* @readonly
|
|
2713
|
+
*/
|
|
2714
|
+
buyerLanguage?: string | null;
|
|
2715
|
+
/**
|
|
2716
|
+
* Site language in which original values are displayed.
|
|
2717
|
+
* @readonly
|
|
2718
|
+
*/
|
|
2719
|
+
siteLanguage?: string | null;
|
|
2720
|
+
/**
|
|
2721
|
+
* Whether tax is included in line item prices.
|
|
2722
|
+
* @readonly
|
|
2723
|
+
*/
|
|
2724
|
+
taxIncludedInPrices?: boolean | null;
|
|
2725
|
+
/**
|
|
2726
|
+
* Weight measurement unit - defaults to site's weight unit.
|
|
2727
|
+
* @readonly
|
|
2728
|
+
*/
|
|
2729
|
+
weightUnit?: WeightUnit;
|
|
2730
|
+
/**
|
|
2731
|
+
* ID of the checkout that originated from this cart.
|
|
2732
|
+
* @readonly
|
|
2733
|
+
* @format GUID
|
|
2734
|
+
*/
|
|
2735
|
+
checkoutId?: string | null;
|
|
2736
|
+
/**
|
|
2737
|
+
* Cart discounts.
|
|
2738
|
+
* @readonly
|
|
2739
|
+
*/
|
|
2740
|
+
appliedDiscounts?: CartDiscount[];
|
|
2741
|
+
/**
|
|
2742
|
+
* Date and time the cart was created.
|
|
2743
|
+
* @readonly
|
|
2744
|
+
*/
|
|
2745
|
+
_createdDate?: Date | null;
|
|
2746
|
+
/**
|
|
2747
|
+
* Date and time the cart was updated.
|
|
2748
|
+
* @readonly
|
|
2749
|
+
*/
|
|
2750
|
+
_updatedDate?: Date | null;
|
|
2751
|
+
/** Contact info. */
|
|
2752
|
+
contactInfo?: AddressWithContact;
|
|
2753
|
+
/**
|
|
2754
|
+
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2755
|
+
*
|
|
2756
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
2757
|
+
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2758
|
+
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2759
|
+
* @maxLength 1000
|
|
2760
|
+
*/
|
|
2761
|
+
overrideCheckoutUrl?: string | null;
|
|
2762
|
+
/**
|
|
2763
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
2764
|
+
* @format GUID
|
|
2765
|
+
* @readonly
|
|
2766
|
+
*/
|
|
2767
|
+
purchaseFlowId?: string | null;
|
|
2768
|
+
/** Selected shipping option. */
|
|
2769
|
+
selectedShippingOption?: SelectedShippingOption;
|
|
2770
|
+
/**
|
|
2771
|
+
* The business location ID associated with the cart.
|
|
2772
|
+
*
|
|
2773
|
+
* To learn more, see the Locations API.
|
|
2774
|
+
* @format GUID
|
|
2775
|
+
*/
|
|
2776
|
+
businessLocationId?: string | null;
|
|
2777
|
+
};
|
|
2778
|
+
/** Coupon code. For more information, see the Coupons API. */
|
|
2779
|
+
couponCode?: string | null;
|
|
2780
|
+
/**
|
|
2781
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
|
|
2782
|
+
* @maxSize 100
|
|
2783
|
+
*/
|
|
2784
|
+
merchantDiscounts?: MerchantDiscountInput[];
|
|
2785
|
+
/**
|
|
2786
|
+
* Catalog line items.
|
|
2787
|
+
* @maxSize 300
|
|
2788
|
+
*/
|
|
2789
|
+
lineItems?: LineItem[];
|
|
2790
|
+
/**
|
|
2791
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2792
|
+
*
|
|
2793
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2794
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2795
|
+
* @maxSize 300
|
|
2796
|
+
*/
|
|
2797
|
+
customLineItems?: CustomLineItem[];
|
|
2798
|
+
}
|
|
2799
|
+
interface AddToCartOptions {
|
|
2800
|
+
/**
|
|
2801
|
+
* Catalog line items.
|
|
2802
|
+
* @maxSize 100
|
|
2803
|
+
*/
|
|
2804
|
+
lineItems?: LineItem[];
|
|
2805
|
+
/**
|
|
2806
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2807
|
+
*
|
|
2808
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2809
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2810
|
+
* @maxSize 100
|
|
2811
|
+
*/
|
|
2812
|
+
customLineItems?: CustomLineItem[];
|
|
2813
|
+
/**
|
|
2814
|
+
* The business location ID associated with the cart.
|
|
2815
|
+
*
|
|
2816
|
+
* The `businessLocationId` field cannot be passed if one already exists on the cart. To update a cart's business location ID, use the Update Cart method.
|
|
2817
|
+
* To learn more, see the Locations API.
|
|
2818
|
+
* @format GUID
|
|
2819
|
+
*/
|
|
2820
|
+
businessLocationId?: string | null;
|
|
2821
|
+
}
|
|
2822
|
+
interface CreateCheckoutOptions {
|
|
2823
|
+
/** __Required.__ Sales channel type. */
|
|
2824
|
+
channelType?: ChannelType;
|
|
2825
|
+
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
2826
|
+
shippingAddress?: Address;
|
|
2827
|
+
/** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
|
|
2828
|
+
billingAddress?: Address;
|
|
2829
|
+
/** Selected shipping option. */
|
|
2830
|
+
selectedShippingOption?: SelectedShippingOption;
|
|
2831
|
+
/**
|
|
2832
|
+
* Required when setting a billing or shipping address if the site visitor isn't logged in.
|
|
2833
|
+
* @format EMAIL
|
|
2834
|
+
*/
|
|
2835
|
+
email?: string | null;
|
|
2836
|
+
}
|
|
2837
|
+
interface EstimateTotalsOptions {
|
|
2838
|
+
/** Selected shipping option. */
|
|
2839
|
+
selectedShippingOption?: SelectedShippingOption;
|
|
2840
|
+
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
2841
|
+
shippingAddress?: Address;
|
|
2842
|
+
/** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
|
|
2843
|
+
billingAddress?: Address;
|
|
2844
|
+
/** The selected membership payment options and which line items they apply to. */
|
|
2845
|
+
selectedMemberships?: SelectedMemberships;
|
|
2846
|
+
/**
|
|
2847
|
+
* Whether to calculate tax in the calculation request.
|
|
2848
|
+
*
|
|
2849
|
+
* Default: `true`
|
|
2850
|
+
*/
|
|
2851
|
+
calculateTax?: boolean | null;
|
|
2852
|
+
/**
|
|
2853
|
+
* Whether to calculate shipping in the calculation request.
|
|
2854
|
+
*
|
|
2855
|
+
* Default: `true`
|
|
2856
|
+
*/
|
|
2857
|
+
calculateShipping?: boolean | null;
|
|
2858
|
+
}
|
|
2859
|
+
|
|
2860
|
+
export { type Group as $, type AddToCartOptions as A, type DescriptionLine as B, type CreateCartOptions as C, DescriptionLineType as D, type EstimateTotalsOptions as E, FileType as F, type DescriptionLineValueOneOf as G, type DescriptionLineDescriptionLineValueOneOf as H, ItemAvailabilityStatus as I, JurisdictionType as J, type DescriptionLineName as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, type PlainTextValue as O, PaymentOptionType as P, type Color as Q, type RemoveLineItemsResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCartOptions as U, VatType as V, WeightUnit as W, type FocalPoint as X, type ItemAvailabilityInfo as Y, type PhysicalProperties as Z, type Scope as _, type Cart as a, type DeliveryTimeSlot as a$, type ItemType as a0, type ItemTypeItemTypeDataOneOf as a1, type SubscriptionOptionInfo as a2, type SubscriptionSettings as a3, type FreeTrialPeriod as a4, type Title as a5, type Description as a6, type SecuredMedia as a7, type ServiceProperties as a8, type PriceDescription as a9, type GetCurrentCartResponse as aA, type UpdateCartRequest as aB, type MerchantDiscountInput as aC, type CustomLineItem as aD, type UpdateCartResponse as aE, type AddToCurrentCartRequest as aF, type AddToCurrentCartAndEstimateTotalsRequest as aG, type SelectedMemberships as aH, type HostSelectedMembership as aI, type CalculatedLineItem as aJ, type LineItemPricesData as aK, type ItemTaxFullDetails as aL, type TaxRateBreakdown as aM, type TaxBreakdown as aN, type PriceSummary as aO, type GiftCard as aP, type TaxSummary as aQ, type TaxCalculationDetails as aR, type TaxCalculationDetailsCalculationDetailsOneOf as aS, type AutoTaxFallbackCalculationDetails as aT, type ApplicationError as aU, type AggregatedTaxBreakdown as aV, type ShippingInformation as aW, type ShippingRegion as aX, type SelectedCarrierServiceOption as aY, type DeliveryLogistics as aZ, type PickupDetails as a_, type SelectedMembership as aa, type CatalogOverrideFields as ab, type PaymentOption as ac, type TaxableAddress as ad, type TaxableAddressTaxableAddressDataOneOf as ae, type ExtendedFields as af, type Policy as ag, type ModifierGroup as ah, type TranslatableString as ai, type ItemModifier as aj, type BuyerInfo as ak, type BuyerInfoIdOneOf as al, type CartDiscount as am, type CartDiscountDiscountSourceOneOf as an, type Coupon as ao, type MerchantDiscount as ap, type DiscountRule as aq, type DiscountRuleName as ar, type AddressWithContact as as, type Address as at, type StreetAddress as au, type AddressLocation as av, type FullAddressContactDetails as aw, type VatId as ax, type SelectedShippingOption as ay, type GetCurrentCartRequest as az, type AddToCartResponse as b, type RemoveCouponRequest as b$, type SelectedCarrierServiceOptionPrices as b0, type SelectedCarrierServiceOptionOtherCharge as b1, type DeliveryAllocation as b2, type Carrier as b3, type Region as b4, type ApplicableLineItems as b5, type CarrierServiceOption as b6, type ShippingOption as b7, type ShippingPrice as b8, type OtherCharge as b9, type TargetLineItem as bA, type RemoveLineItemsFromCurrentCartRequest as bB, type CreateCheckoutFromCurrentCartRequest as bC, type RemoveCouponFromCurrentCartRequest as bD, type UpdateCurrentCartLineItemQuantityRequest as bE, type EstimateCurrentCartTotalsRequest as bF, type DeleteCurrentCartRequest as bG, type DeleteCartResponse as bH, type DomainEvent as bI, type DomainEventBodyOneOf as bJ, type EntityCreatedEvent as bK, type RestoreInfo as bL, type EntityUpdatedEvent as bM, type EntityDeletedEvent as bN, type ActionEvent as bO, type MessageEnvelope as bP, type IdentificationData as bQ, type IdentificationDataIdOneOf as bR, type CreateCartRequest as bS, type CreateCartResponse as bT, type GetCartRequest as bU, type GetCartResponse as bV, type GetCartByCheckoutIdRequest as bW, type GetCartByCheckoutIdResponse as bX, type AddToCartRequest as bY, type RemoveLineItemsRequest as bZ, type CreateCheckoutRequest as b_, type AppliedDiscount as ba, type AppliedDiscountDiscountSourceOneOf as bb, type V1Coupon as bc, type V1MerchantDiscount as bd, type V1DiscountRule as be, type V1DiscountRuleName as bf, type LineItemDiscount as bg, type CalculationErrors as bh, type CalculationErrorsShippingCalculationErrorOneOf as bi, type Details as bj, type DetailsKindOneOf as bk, type ValidationError as bl, type FieldViolation as bm, type SystemError as bn, type CarrierErrors as bo, type CarrierError as bp, type MembershipOptions as bq, type Membership as br, type MembershipName as bs, type MembershipPaymentCredits as bt, type InvalidMembership as bu, type AdditionalFee as bv, type Violation as bw, type Target as bx, type TargetTargetTypeOneOf as by, type Other as bz, type CreateCheckoutOptions as c, type UpdateLineItemsQuantityRequest as c0, type EstimateTotalsRequest as c1, type DeleteCartRequest as c2, type Empty as c3, type RemoveBusinessLocationRequest as c4, type BaseEventMetadata as c5, type EventMetadata as c6, type CartDeletedEnvelope as c7, type CartUpdatedEnvelope as c8, type CartCreatedEnvelope as c9, type CreateCheckoutResponse as d, type RemoveCouponResponse as e, type UpdateLineItemsQuantityResponse as f, type EstimateTotalsResponse as g, type RemoveBusinessLocationResponse as h, ItemTypeItemType as i, DiscountType as j, RateType as k, FallbackReason as l, PickupMethod as m, ChargeType as n, AppliedDiscountDiscountType as o, RuleType as p, AdditionalFeeSource as q, Severity as r, NameInLineItem as s, SuggestedFix as t, ChannelType as u, WebhookIdentityType as v, type LineItem as w, type CatalogReference as x, type ProductName as y, type MultiCurrencyPrice as z };
|