@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
|
@@ -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
|
|
@@ -143,6 +143,12 @@ export interface LineItem {
|
|
|
143
143
|
* @readonly
|
|
144
144
|
*/
|
|
145
145
|
priceBeforeDiscounts?: MultiCurrencyPrice;
|
|
146
|
+
/**
|
|
147
|
+
* Total price **after** catalog-defined discount and line item discounts.
|
|
148
|
+
* @internal
|
|
149
|
+
* @readonly
|
|
150
|
+
*/
|
|
151
|
+
lineItemPrice?: MultiCurrencyPrice;
|
|
146
152
|
/**
|
|
147
153
|
* Line item description lines. Used for displaying the cart, checkout and order.
|
|
148
154
|
* @readonly
|
|
@@ -152,7 +158,7 @@ export interface LineItem {
|
|
|
152
158
|
* Line item image details.
|
|
153
159
|
* @readonly
|
|
154
160
|
*/
|
|
155
|
-
image?:
|
|
161
|
+
image?: string;
|
|
156
162
|
/**
|
|
157
163
|
* Item availability details.
|
|
158
164
|
* @readonly
|
|
@@ -226,6 +232,18 @@ export interface LineItem {
|
|
|
226
232
|
* @readonly
|
|
227
233
|
*/
|
|
228
234
|
consentRequiredPaymentPolicy?: string | null;
|
|
235
|
+
/**
|
|
236
|
+
* Whether the price is not yet defined, and will be updated after the order is created.
|
|
237
|
+
* @internal
|
|
238
|
+
* @readonly
|
|
239
|
+
*/
|
|
240
|
+
priceUndetermined?: boolean;
|
|
241
|
+
/**
|
|
242
|
+
* Whether the line item quantity is fixed and cannot be changed.
|
|
243
|
+
* @internal
|
|
244
|
+
* @readonly
|
|
245
|
+
*/
|
|
246
|
+
fixedQuantity?: boolean;
|
|
229
247
|
/**
|
|
230
248
|
* Overriding values for catalog item properties.
|
|
231
249
|
*
|
|
@@ -240,9 +258,55 @@ export interface LineItem {
|
|
|
240
258
|
* @readonly
|
|
241
259
|
*/
|
|
242
260
|
savePaymentMethod?: boolean;
|
|
261
|
+
/**
|
|
262
|
+
* Address to use for tax calculation purposes.
|
|
263
|
+
* @internal
|
|
264
|
+
*/
|
|
265
|
+
taxableAddress?: TaxableAddress;
|
|
266
|
+
/**
|
|
267
|
+
* Custom extended fields for the line item object.
|
|
268
|
+
*
|
|
269
|
+
* [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.
|
|
270
|
+
* @internal
|
|
271
|
+
*/
|
|
272
|
+
extendedFields?: ExtendedFields;
|
|
273
|
+
/**
|
|
274
|
+
* Policies to be displayed to the customer on the checkout page.
|
|
275
|
+
* @internal
|
|
276
|
+
* @readonly
|
|
277
|
+
* @maxSize 5
|
|
278
|
+
*/
|
|
279
|
+
policies?: Policy[];
|
|
280
|
+
/**
|
|
281
|
+
* ID of the app managing the inventory.
|
|
282
|
+
* @internal
|
|
283
|
+
* @format GUID
|
|
284
|
+
*/
|
|
285
|
+
inventoryAppId?: string | null;
|
|
286
|
+
/**
|
|
287
|
+
* Whether the item can only be purchased by site members.
|
|
288
|
+
*
|
|
289
|
+
* Default: `false`
|
|
290
|
+
* @internal
|
|
291
|
+
* @readonly
|
|
292
|
+
*/
|
|
293
|
+
membersOnly?: boolean;
|
|
294
|
+
/**
|
|
295
|
+
* Modifier groups that were added to the item.
|
|
296
|
+
* @internal
|
|
297
|
+
* @readonly
|
|
298
|
+
* @maxSize 10
|
|
299
|
+
*/
|
|
300
|
+
modifierGroups?: ModifierGroup[];
|
|
301
|
+
/**
|
|
302
|
+
* Total price of all item modifiers. Included in the item price.
|
|
303
|
+
* @internal
|
|
304
|
+
* @readonly
|
|
305
|
+
*/
|
|
306
|
+
modifiersTotalPrice?: MultiCurrencyPrice;
|
|
243
307
|
}
|
|
244
308
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
245
|
-
|
|
309
|
+
interface CatalogReference {
|
|
246
310
|
/**
|
|
247
311
|
* ID of the item within the catalog it belongs to.
|
|
248
312
|
* @minLength 1
|
|
@@ -268,7 +332,7 @@ export interface CatalogReference {
|
|
|
268
332
|
*/
|
|
269
333
|
options?: Record<string, any> | null;
|
|
270
334
|
}
|
|
271
|
-
|
|
335
|
+
interface ProductName {
|
|
272
336
|
/**
|
|
273
337
|
* __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
338
|
*
|
|
@@ -289,13 +353,7 @@ export interface ProductName {
|
|
|
289
353
|
*/
|
|
290
354
|
translated?: string | null;
|
|
291
355
|
}
|
|
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 {
|
|
356
|
+
interface MultiCurrencyPrice {
|
|
299
357
|
/**
|
|
300
358
|
* Amount.
|
|
301
359
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -318,7 +376,7 @@ export interface MultiCurrencyPrice {
|
|
|
318
376
|
*/
|
|
319
377
|
formattedConvertedAmount?: string;
|
|
320
378
|
}
|
|
321
|
-
|
|
379
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
322
380
|
/** Description line plain text value. */
|
|
323
381
|
plainText?: PlainTextValue;
|
|
324
382
|
/** Description line color value. */
|
|
@@ -327,16 +385,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
327
385
|
name?: DescriptionLineName;
|
|
328
386
|
}
|
|
329
387
|
/** @oneof */
|
|
330
|
-
|
|
388
|
+
interface DescriptionLineValueOneOf {
|
|
331
389
|
/** Description line plain text value. */
|
|
332
390
|
plainText?: PlainTextValue;
|
|
333
391
|
/** Description line color value. */
|
|
334
392
|
colorInfo?: Color;
|
|
335
393
|
}
|
|
336
394
|
/** @oneof */
|
|
337
|
-
|
|
395
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
338
396
|
}
|
|
339
|
-
|
|
397
|
+
interface DescriptionLineName {
|
|
340
398
|
/**
|
|
341
399
|
* 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
400
|
* @maxLength 100
|
|
@@ -350,7 +408,7 @@ export interface DescriptionLineName {
|
|
|
350
408
|
*/
|
|
351
409
|
translated?: string | null;
|
|
352
410
|
}
|
|
353
|
-
|
|
411
|
+
interface PlainTextValue {
|
|
354
412
|
/**
|
|
355
413
|
* 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
414
|
* @maxLength 600
|
|
@@ -364,7 +422,7 @@ export interface PlainTextValue {
|
|
|
364
422
|
*/
|
|
365
423
|
translated?: string | null;
|
|
366
424
|
}
|
|
367
|
-
|
|
425
|
+
interface Color {
|
|
368
426
|
/**
|
|
369
427
|
* 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
428
|
* @maxLength 500
|
|
@@ -380,7 +438,7 @@ export interface Color {
|
|
|
380
438
|
/** HEX or RGB color code for display. */
|
|
381
439
|
code?: string | null;
|
|
382
440
|
}
|
|
383
|
-
|
|
441
|
+
declare enum DescriptionLineType {
|
|
384
442
|
/** Unrecognized type. */
|
|
385
443
|
UNRECOGNISED = "UNRECOGNISED",
|
|
386
444
|
/** Plain text type. */
|
|
@@ -388,30 +446,7 @@ export declare enum DescriptionLineType {
|
|
|
388
446
|
/** Color type. */
|
|
389
447
|
COLOR = "COLOR"
|
|
390
448
|
}
|
|
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 {
|
|
449
|
+
interface FocalPoint {
|
|
415
450
|
/** X-coordinate of the focal point. */
|
|
416
451
|
x?: number;
|
|
417
452
|
/** Y-coordinate of the focal point. */
|
|
@@ -421,13 +456,13 @@ export interface FocalPoint {
|
|
|
421
456
|
/** crop by width */
|
|
422
457
|
width?: number | null;
|
|
423
458
|
}
|
|
424
|
-
|
|
459
|
+
interface ItemAvailabilityInfo {
|
|
425
460
|
/** Item availability status. */
|
|
426
461
|
status?: ItemAvailabilityStatus;
|
|
427
462
|
/** Quantity available. */
|
|
428
463
|
quantityAvailable?: number | null;
|
|
429
464
|
}
|
|
430
|
-
|
|
465
|
+
declare enum ItemAvailabilityStatus {
|
|
431
466
|
AVAILABLE = "AVAILABLE",
|
|
432
467
|
/** Item does not exist. */
|
|
433
468
|
NOT_FOUND = "NOT_FOUND",
|
|
@@ -436,7 +471,7 @@ export declare enum ItemAvailabilityStatus {
|
|
|
436
471
|
/** Available quantity is less than requested. */
|
|
437
472
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
438
473
|
}
|
|
439
|
-
|
|
474
|
+
interface PhysicalProperties {
|
|
440
475
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
441
476
|
weight?: number | null;
|
|
442
477
|
/**
|
|
@@ -447,39 +482,39 @@ export interface PhysicalProperties {
|
|
|
447
482
|
/** Whether this line item is shippable. */
|
|
448
483
|
shippable?: boolean;
|
|
449
484
|
}
|
|
450
|
-
|
|
485
|
+
interface Scope {
|
|
451
486
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
452
487
|
namespace?: string;
|
|
453
488
|
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
454
489
|
group?: Group;
|
|
455
490
|
}
|
|
456
|
-
|
|
491
|
+
interface Group {
|
|
457
492
|
/** 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
493
|
name?: string;
|
|
459
494
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
460
495
|
entityId?: string | null;
|
|
461
496
|
}
|
|
462
|
-
|
|
497
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
463
498
|
/** Preset item type. */
|
|
464
499
|
preset?: ItemTypeItemType;
|
|
465
500
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
466
501
|
custom?: string;
|
|
467
502
|
}
|
|
468
503
|
/** @oneof */
|
|
469
|
-
|
|
504
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
470
505
|
/** Preset item type. */
|
|
471
506
|
preset?: ItemTypeItemType;
|
|
472
507
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
473
508
|
custom?: string;
|
|
474
509
|
}
|
|
475
|
-
|
|
510
|
+
declare enum ItemTypeItemType {
|
|
476
511
|
UNRECOGNISED = "UNRECOGNISED",
|
|
477
512
|
PHYSICAL = "PHYSICAL",
|
|
478
513
|
DIGITAL = "DIGITAL",
|
|
479
514
|
GIFT_CARD = "GIFT_CARD",
|
|
480
515
|
SERVICE = "SERVICE"
|
|
481
516
|
}
|
|
482
|
-
|
|
517
|
+
interface SubscriptionOptionInfo {
|
|
483
518
|
/** Subscription option settings. */
|
|
484
519
|
subscriptionSettings?: SubscriptionSettings;
|
|
485
520
|
/** Subscription option title. */
|
|
@@ -487,7 +522,7 @@ export interface SubscriptionOptionInfo {
|
|
|
487
522
|
/** Subscription option description. */
|
|
488
523
|
description?: Description;
|
|
489
524
|
}
|
|
490
|
-
|
|
525
|
+
interface SubscriptionSettings {
|
|
491
526
|
/** Frequency of recurring payment. */
|
|
492
527
|
frequency?: SubscriptionFrequency;
|
|
493
528
|
/**
|
|
@@ -506,16 +541,32 @@ export interface SubscriptionSettings {
|
|
|
506
541
|
* @min 1
|
|
507
542
|
*/
|
|
508
543
|
billingCycles?: number | null;
|
|
544
|
+
/**
|
|
545
|
+
* Whether to allow the customer to cancel the subscription..
|
|
546
|
+
* @internal
|
|
547
|
+
*/
|
|
548
|
+
enableCustomerCancellation?: boolean;
|
|
549
|
+
/**
|
|
550
|
+
* Period until first cycle starts. If applied payNow will be 0
|
|
551
|
+
* If None => no free trial
|
|
552
|
+
* @internal
|
|
553
|
+
*/
|
|
554
|
+
freeTrialPeriod?: FreeTrialPeriod;
|
|
555
|
+
/**
|
|
556
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
557
|
+
* @internal
|
|
558
|
+
*/
|
|
559
|
+
startDate?: Date | null;
|
|
509
560
|
}
|
|
510
561
|
/** Frequency unit of recurring payment */
|
|
511
|
-
|
|
562
|
+
declare enum SubscriptionFrequency {
|
|
512
563
|
UNDEFINED = "UNDEFINED",
|
|
513
564
|
DAY = "DAY",
|
|
514
565
|
WEEK = "WEEK",
|
|
515
566
|
MONTH = "MONTH",
|
|
516
567
|
YEAR = "YEAR"
|
|
517
568
|
}
|
|
518
|
-
|
|
569
|
+
interface FreeTrialPeriod {
|
|
519
570
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
520
571
|
frequency?: SubscriptionFrequency;
|
|
521
572
|
/**
|
|
@@ -525,7 +576,7 @@ export interface FreeTrialPeriod {
|
|
|
525
576
|
*/
|
|
526
577
|
interval?: number;
|
|
527
578
|
}
|
|
528
|
-
|
|
579
|
+
interface Title {
|
|
529
580
|
/**
|
|
530
581
|
* 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
582
|
* @minLength 1
|
|
@@ -541,7 +592,7 @@ export interface Title {
|
|
|
541
592
|
*/
|
|
542
593
|
translated?: string | null;
|
|
543
594
|
}
|
|
544
|
-
|
|
595
|
+
interface Description {
|
|
545
596
|
/**
|
|
546
597
|
* Subscription option description.
|
|
547
598
|
* @maxLength 500
|
|
@@ -553,13 +604,13 @@ export interface Description {
|
|
|
553
604
|
*/
|
|
554
605
|
translated?: string | null;
|
|
555
606
|
}
|
|
556
|
-
|
|
607
|
+
interface SecuredMedia {
|
|
557
608
|
/**
|
|
558
609
|
* Media ID in Wix Media Manager.
|
|
559
610
|
* @minLength 1
|
|
560
611
|
* @maxLength 100
|
|
561
612
|
*/
|
|
562
|
-
|
|
613
|
+
_id?: string;
|
|
563
614
|
/**
|
|
564
615
|
* Original filename.
|
|
565
616
|
* @minLength 1
|
|
@@ -569,7 +620,7 @@ export interface SecuredMedia {
|
|
|
569
620
|
/** File type. */
|
|
570
621
|
fileType?: FileType;
|
|
571
622
|
}
|
|
572
|
-
|
|
623
|
+
declare enum FileType {
|
|
573
624
|
UNSPECIFIED = "UNSPECIFIED",
|
|
574
625
|
SECURE_PICTURE = "SECURE_PICTURE",
|
|
575
626
|
SECURE_VIDEO = "SECURE_VIDEO",
|
|
@@ -578,7 +629,7 @@ export declare enum FileType {
|
|
|
578
629
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
579
630
|
}
|
|
580
631
|
/** Type of selected payment option for catalog item */
|
|
581
|
-
|
|
632
|
+
declare enum PaymentOptionType {
|
|
582
633
|
/** The entire payment for this item happens as part of the checkout. */
|
|
583
634
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
584
635
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -590,7 +641,7 @@ export declare enum PaymentOptionType {
|
|
|
590
641
|
/** 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
642
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
592
643
|
}
|
|
593
|
-
|
|
644
|
+
interface ServiceProperties {
|
|
594
645
|
/**
|
|
595
646
|
* 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
647
|
* For example, the start time of a class.
|
|
@@ -603,7 +654,7 @@ export interface ServiceProperties {
|
|
|
603
654
|
*/
|
|
604
655
|
numberOfParticipants?: number | null;
|
|
605
656
|
}
|
|
606
|
-
|
|
657
|
+
interface PriceDescription {
|
|
607
658
|
/**
|
|
608
659
|
* __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
660
|
* @minLength 1
|
|
@@ -620,20 +671,20 @@ export interface PriceDescription {
|
|
|
620
671
|
translated?: string | null;
|
|
621
672
|
}
|
|
622
673
|
/** Selected Membership */
|
|
623
|
-
|
|
674
|
+
interface SelectedMembership {
|
|
624
675
|
/**
|
|
625
676
|
* Membership ID.
|
|
626
677
|
* @minLength 1
|
|
627
678
|
* @maxLength 100
|
|
628
679
|
*/
|
|
629
|
-
|
|
680
|
+
_id?: string;
|
|
630
681
|
/**
|
|
631
682
|
* ID of the app providing this payment option.
|
|
632
683
|
* @format GUID
|
|
633
684
|
*/
|
|
634
685
|
appId?: string;
|
|
635
686
|
}
|
|
636
|
-
|
|
687
|
+
interface CatalogOverrideFields {
|
|
637
688
|
/** Item name. */
|
|
638
689
|
productName?: ProductName;
|
|
639
690
|
/**
|
|
@@ -654,7 +705,7 @@ export interface CatalogOverrideFields {
|
|
|
654
705
|
/** Physical properties of the item. */
|
|
655
706
|
physicalProperties?: PhysicalProperties;
|
|
656
707
|
/** Item image. */
|
|
657
|
-
image?:
|
|
708
|
+
image?: string;
|
|
658
709
|
/** Payment method selected for the item. */
|
|
659
710
|
paymentOption?: PaymentOption;
|
|
660
711
|
/**
|
|
@@ -670,19 +721,7 @@ export interface CatalogOverrideFields {
|
|
|
670
721
|
*/
|
|
671
722
|
savePaymentMethod?: boolean | null;
|
|
672
723
|
}
|
|
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 {
|
|
724
|
+
interface PaymentOption {
|
|
686
725
|
/**
|
|
687
726
|
* Type of selected payment option for current item.
|
|
688
727
|
*
|
|
@@ -690,22 +729,22 @@ export interface PaymentOption {
|
|
|
690
729
|
*/
|
|
691
730
|
value?: PaymentOptionType;
|
|
692
731
|
}
|
|
693
|
-
|
|
732
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
694
733
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
695
734
|
addressType?: TaxableAddressType;
|
|
696
735
|
}
|
|
697
736
|
/** @oneof */
|
|
698
|
-
|
|
737
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
699
738
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
700
739
|
addressType?: TaxableAddressType;
|
|
701
740
|
}
|
|
702
|
-
|
|
741
|
+
declare enum TaxableAddressType {
|
|
703
742
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
704
743
|
BUSINESS = "BUSINESS",
|
|
705
744
|
BILLING = "BILLING",
|
|
706
745
|
SHIPPING = "SHIPPING"
|
|
707
746
|
}
|
|
708
|
-
|
|
747
|
+
interface ExtendedFields {
|
|
709
748
|
/**
|
|
710
749
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
711
750
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -716,7 +755,7 @@ export interface ExtendedFields {
|
|
|
716
755
|
*/
|
|
717
756
|
namespaces?: Record<string, Record<string, any>>;
|
|
718
757
|
}
|
|
719
|
-
|
|
758
|
+
interface Policy {
|
|
720
759
|
/**
|
|
721
760
|
* Policy title - should be translated
|
|
722
761
|
* @minLength 1
|
|
@@ -730,13 +769,13 @@ export interface Policy {
|
|
|
730
769
|
*/
|
|
731
770
|
content?: string;
|
|
732
771
|
}
|
|
733
|
-
|
|
772
|
+
interface ModifierGroup {
|
|
734
773
|
/**
|
|
735
774
|
* Modifier group id.
|
|
736
775
|
* @minLength 1
|
|
737
776
|
* @maxLength 36
|
|
738
777
|
*/
|
|
739
|
-
|
|
778
|
+
_id?: string;
|
|
740
779
|
/** Modifier group name. */
|
|
741
780
|
name?: TranslatableString;
|
|
742
781
|
/**
|
|
@@ -746,7 +785,7 @@ export interface ModifierGroup {
|
|
|
746
785
|
*/
|
|
747
786
|
modifiers?: ItemModifier[];
|
|
748
787
|
}
|
|
749
|
-
|
|
788
|
+
interface TranslatableString {
|
|
750
789
|
/**
|
|
751
790
|
* __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
791
|
*
|
|
@@ -767,13 +806,13 @@ export interface TranslatableString {
|
|
|
767
806
|
*/
|
|
768
807
|
translated?: string | null;
|
|
769
808
|
}
|
|
770
|
-
|
|
809
|
+
interface ItemModifier {
|
|
771
810
|
/**
|
|
772
811
|
* Modifier ID.
|
|
773
812
|
* @minLength 1
|
|
774
813
|
* @maxLength 36
|
|
775
814
|
*/
|
|
776
|
-
|
|
815
|
+
_id?: string;
|
|
777
816
|
/**
|
|
778
817
|
* The quantity of this modifier.
|
|
779
818
|
* @min 1
|
|
@@ -788,7 +827,7 @@ export interface ItemModifier {
|
|
|
788
827
|
price?: MultiCurrencyPrice;
|
|
789
828
|
}
|
|
790
829
|
/** Buyer Info */
|
|
791
|
-
|
|
830
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
792
831
|
/**
|
|
793
832
|
* Visitor ID. If the buyer is **not** a site member.
|
|
794
833
|
* @format GUID
|
|
@@ -819,7 +858,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
819
858
|
email?: string | null;
|
|
820
859
|
}
|
|
821
860
|
/** @oneof */
|
|
822
|
-
|
|
861
|
+
interface BuyerInfoIdOneOf {
|
|
823
862
|
/**
|
|
824
863
|
* Visitor ID. If the buyer is **not** a site member.
|
|
825
864
|
* @format GUID
|
|
@@ -839,7 +878,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
839
878
|
*/
|
|
840
879
|
userId?: string;
|
|
841
880
|
}
|
|
842
|
-
|
|
881
|
+
declare enum WeightUnit {
|
|
843
882
|
/** Weight unit can't be classified due to an error. */
|
|
844
883
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
845
884
|
/** Kilograms. */
|
|
@@ -847,41 +886,61 @@ export declare enum WeightUnit {
|
|
|
847
886
|
/** Pounds. */
|
|
848
887
|
LB = "LB"
|
|
849
888
|
}
|
|
850
|
-
|
|
889
|
+
interface CartDiscount extends CartDiscountDiscountSourceOneOf {
|
|
851
890
|
/** Coupon details. */
|
|
852
891
|
coupon?: Coupon;
|
|
853
892
|
/** Merchant discount. */
|
|
854
893
|
merchantDiscount?: MerchantDiscount;
|
|
894
|
+
/**
|
|
895
|
+
* Discount rule
|
|
896
|
+
* @internal
|
|
897
|
+
*/
|
|
898
|
+
discountRule?: DiscountRule;
|
|
899
|
+
/**
|
|
900
|
+
* Discount type.
|
|
901
|
+
* @internal
|
|
902
|
+
*/
|
|
903
|
+
discountType?: DiscountType;
|
|
855
904
|
}
|
|
856
905
|
/** @oneof */
|
|
857
|
-
|
|
906
|
+
interface CartDiscountDiscountSourceOneOf {
|
|
858
907
|
/** Coupon details. */
|
|
859
908
|
coupon?: Coupon;
|
|
860
909
|
/** Merchant discount. */
|
|
861
910
|
merchantDiscount?: MerchantDiscount;
|
|
911
|
+
/**
|
|
912
|
+
* Discount rule
|
|
913
|
+
* @internal
|
|
914
|
+
*/
|
|
915
|
+
discountRule?: DiscountRule;
|
|
862
916
|
}
|
|
863
|
-
|
|
917
|
+
interface Coupon {
|
|
864
918
|
/** Coupon ID. */
|
|
865
|
-
|
|
919
|
+
_id?: string;
|
|
866
920
|
/** Coupon code. */
|
|
867
921
|
code?: string;
|
|
922
|
+
/**
|
|
923
|
+
* Coupon value.
|
|
924
|
+
* @internal
|
|
925
|
+
*/
|
|
926
|
+
amount?: MultiCurrencyPrice;
|
|
868
927
|
}
|
|
869
|
-
|
|
928
|
+
interface MerchantDiscount {
|
|
870
929
|
/** Discount value. */
|
|
871
930
|
amount?: MultiCurrencyPrice;
|
|
872
931
|
}
|
|
873
|
-
|
|
932
|
+
interface DiscountRule {
|
|
874
933
|
/**
|
|
875
934
|
* Discount rule ID
|
|
876
935
|
* @format GUID
|
|
877
936
|
*/
|
|
878
|
-
|
|
937
|
+
_id?: string;
|
|
879
938
|
/** Discount rule name */
|
|
880
939
|
name?: DiscountRuleName;
|
|
881
940
|
/** Discount value. */
|
|
882
941
|
amount?: MultiCurrencyPrice;
|
|
883
942
|
}
|
|
884
|
-
|
|
943
|
+
interface DiscountRuleName {
|
|
885
944
|
/**
|
|
886
945
|
* Original discount rule name (in site's default language).
|
|
887
946
|
* @minLength 1
|
|
@@ -895,7 +954,7 @@ export interface DiscountRuleName {
|
|
|
895
954
|
*/
|
|
896
955
|
translated?: string | null;
|
|
897
956
|
}
|
|
898
|
-
|
|
957
|
+
declare enum DiscountType {
|
|
899
958
|
/** "GLOBAL" - discount applies to entire order. */
|
|
900
959
|
GLOBAL = "GLOBAL",
|
|
901
960
|
/** "SPECIFIC-ITEMS" - discount applies to specific items. */
|
|
@@ -904,14 +963,14 @@ export declare enum DiscountType {
|
|
|
904
963
|
SHIPPING = "SHIPPING"
|
|
905
964
|
}
|
|
906
965
|
/** Billing Info and shipping details */
|
|
907
|
-
|
|
966
|
+
interface AddressWithContact {
|
|
908
967
|
/** Address. */
|
|
909
968
|
address?: Address;
|
|
910
969
|
/** Contact details. */
|
|
911
970
|
contactDetails?: FullAddressContactDetails;
|
|
912
971
|
}
|
|
913
972
|
/** Physical address */
|
|
914
|
-
|
|
973
|
+
interface Address {
|
|
915
974
|
/**
|
|
916
975
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
917
976
|
* @format COUNTRY
|
|
@@ -938,7 +997,7 @@ export interface Address {
|
|
|
938
997
|
* Main address line (usually street name and number).
|
|
939
998
|
* @maxLength 150
|
|
940
999
|
*/
|
|
941
|
-
|
|
1000
|
+
addressLine1?: string | null;
|
|
942
1001
|
/**
|
|
943
1002
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
944
1003
|
* @maxLength 100
|
|
@@ -955,20 +1014,20 @@ export interface Address {
|
|
|
955
1014
|
*/
|
|
956
1015
|
subdivisionFullname?: string | null;
|
|
957
1016
|
}
|
|
958
|
-
|
|
1017
|
+
interface StreetAddress {
|
|
959
1018
|
/** Street number. */
|
|
960
1019
|
number?: string;
|
|
961
1020
|
/** Street name. */
|
|
962
1021
|
name?: string;
|
|
963
1022
|
}
|
|
964
|
-
|
|
1023
|
+
interface AddressLocation {
|
|
965
1024
|
/** Address latitude. */
|
|
966
1025
|
latitude?: number | null;
|
|
967
1026
|
/** Address longitude. */
|
|
968
1027
|
longitude?: number | null;
|
|
969
1028
|
}
|
|
970
1029
|
/** Full contact details for an address */
|
|
971
|
-
|
|
1030
|
+
interface FullAddressContactDetails {
|
|
972
1031
|
/**
|
|
973
1032
|
* First name.
|
|
974
1033
|
* @maxLength 100
|
|
@@ -992,9 +1051,9 @@ export interface FullAddressContactDetails {
|
|
|
992
1051
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
993
1052
|
vatId?: VatId;
|
|
994
1053
|
}
|
|
995
|
-
|
|
1054
|
+
interface VatId {
|
|
996
1055
|
/** Customer's tax ID. */
|
|
997
|
-
|
|
1056
|
+
_id?: string;
|
|
998
1057
|
/**
|
|
999
1058
|
* Tax type.
|
|
1000
1059
|
*
|
|
@@ -1005,14 +1064,14 @@ export interface VatId {
|
|
|
1005
1064
|
type?: VatType;
|
|
1006
1065
|
}
|
|
1007
1066
|
/** tax info types */
|
|
1008
|
-
|
|
1067
|
+
declare enum VatType {
|
|
1009
1068
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1010
1069
|
/** CPF - for individual tax payers. */
|
|
1011
1070
|
CPF = "CPF",
|
|
1012
1071
|
/** CNPJ - for corporations */
|
|
1013
1072
|
CNPJ = "CNPJ"
|
|
1014
1073
|
}
|
|
1015
|
-
|
|
1074
|
+
interface SelectedShippingOption {
|
|
1016
1075
|
/**
|
|
1017
1076
|
* Carrier ID.
|
|
1018
1077
|
* @format GUID
|
|
@@ -1025,13 +1084,13 @@ export interface SelectedShippingOption {
|
|
|
1025
1084
|
*/
|
|
1026
1085
|
code?: string;
|
|
1027
1086
|
}
|
|
1028
|
-
|
|
1087
|
+
interface GetCurrentCartRequest {
|
|
1029
1088
|
}
|
|
1030
|
-
|
|
1089
|
+
interface GetCurrentCartResponse {
|
|
1031
1090
|
/** Current session's active cart. */
|
|
1032
1091
|
cart?: Cart;
|
|
1033
1092
|
}
|
|
1034
|
-
|
|
1093
|
+
interface UpdateCartRequest {
|
|
1035
1094
|
/** Cart info. */
|
|
1036
1095
|
cartInfo?: Cart;
|
|
1037
1096
|
/** Coupon code. For more information, see the Coupons API. */
|
|
@@ -1055,7 +1114,7 @@ export interface UpdateCartRequest {
|
|
|
1055
1114
|
*/
|
|
1056
1115
|
customLineItems?: CustomLineItem[];
|
|
1057
1116
|
}
|
|
1058
|
-
|
|
1117
|
+
interface MerchantDiscountInput {
|
|
1059
1118
|
/**
|
|
1060
1119
|
* Discount amount.
|
|
1061
1120
|
* @decimalValue options { gte:0 }
|
|
@@ -1068,7 +1127,7 @@ export interface MerchantDiscountInput {
|
|
|
1068
1127
|
*/
|
|
1069
1128
|
lineItemIds?: string[];
|
|
1070
1129
|
}
|
|
1071
|
-
|
|
1130
|
+
interface CustomLineItem {
|
|
1072
1131
|
/**
|
|
1073
1132
|
* Custom line item quantity.
|
|
1074
1133
|
*
|
|
@@ -1093,15 +1152,19 @@ export interface CustomLineItem {
|
|
|
1093
1152
|
* @maxSize 10
|
|
1094
1153
|
*/
|
|
1095
1154
|
descriptionLines?: DescriptionLine[];
|
|
1096
|
-
/**
|
|
1097
|
-
|
|
1155
|
+
/**
|
|
1156
|
+
* Custom line item media. Supported formats:
|
|
1157
|
+
* + 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"`.
|
|
1158
|
+
* + An image from the web - `"http(s)://<image url>"`.
|
|
1159
|
+
*/
|
|
1160
|
+
media?: string;
|
|
1098
1161
|
/**
|
|
1099
1162
|
* Custom line item ID. If passed, `id` must be unique.
|
|
1100
1163
|
*
|
|
1101
1164
|
* Default: auto-generated ID
|
|
1102
1165
|
* @format GUID
|
|
1103
1166
|
*/
|
|
1104
|
-
|
|
1167
|
+
_id?: string | null;
|
|
1105
1168
|
/**
|
|
1106
1169
|
* Tax group ID for this custom line item.
|
|
1107
1170
|
* @format GUID
|
|
@@ -1110,7 +1173,7 @@ export interface CustomLineItem {
|
|
|
1110
1173
|
/** Name of the item or product. */
|
|
1111
1174
|
productName?: ProductName;
|
|
1112
1175
|
/** 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?:
|
|
1176
|
+
url?: string;
|
|
1114
1177
|
/** Item type. Either a preset type or custom. */
|
|
1115
1178
|
itemType?: ItemType;
|
|
1116
1179
|
/**
|
|
@@ -1165,6 +1228,20 @@ export interface CustomLineItem {
|
|
|
1165
1228
|
deliveryProfileId?: string | null;
|
|
1166
1229
|
/** 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. */
|
|
1167
1230
|
catalogReference?: CatalogReference;
|
|
1231
|
+
/**
|
|
1232
|
+
* Whether the price is not yet defined, and will be updated after the order is created.
|
|
1233
|
+
*
|
|
1234
|
+
* Default: `false`
|
|
1235
|
+
* @internal
|
|
1236
|
+
*/
|
|
1237
|
+
priceUndetermined?: boolean;
|
|
1238
|
+
/**
|
|
1239
|
+
* Whether the line item quantity is fixed and cannot be changed.
|
|
1240
|
+
*
|
|
1241
|
+
* Default: `false`
|
|
1242
|
+
* @internal
|
|
1243
|
+
*/
|
|
1244
|
+
fixedQuantity?: boolean;
|
|
1168
1245
|
/**
|
|
1169
1246
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
1170
1247
|
* @minLength 1
|
|
@@ -1179,12 +1256,36 @@ export interface CustomLineItem {
|
|
|
1179
1256
|
* @readonly
|
|
1180
1257
|
*/
|
|
1181
1258
|
savePaymentMethod?: boolean;
|
|
1259
|
+
/**
|
|
1260
|
+
* Policies to be displayed to the customer on the checkout page.
|
|
1261
|
+
* @internal
|
|
1262
|
+
* @maxSize 5
|
|
1263
|
+
*/
|
|
1264
|
+
policies?: Policy[];
|
|
1265
|
+
/**
|
|
1266
|
+
* ID of the app managing the inventory.
|
|
1267
|
+
* @internal
|
|
1268
|
+
* @format GUID
|
|
1269
|
+
*/
|
|
1270
|
+
inventoryAppId?: string | null;
|
|
1271
|
+
/**
|
|
1272
|
+
* Whether the item can only be purchased by site members.
|
|
1273
|
+
*
|
|
1274
|
+
* Default: `false`
|
|
1275
|
+
* @internal
|
|
1276
|
+
*/
|
|
1277
|
+
membersOnly?: boolean;
|
|
1278
|
+
/**
|
|
1279
|
+
* Address to use for tax calculation purposes.
|
|
1280
|
+
* @internal
|
|
1281
|
+
*/
|
|
1282
|
+
taxableAddress?: TaxableAddress;
|
|
1182
1283
|
}
|
|
1183
|
-
|
|
1284
|
+
interface UpdateCartResponse {
|
|
1184
1285
|
/** Updated Cart. */
|
|
1185
1286
|
cart?: Cart;
|
|
1186
1287
|
}
|
|
1187
|
-
|
|
1288
|
+
interface AddToCurrentCartRequest {
|
|
1188
1289
|
/**
|
|
1189
1290
|
* Catalog line items.
|
|
1190
1291
|
* @maxSize 100
|
|
@@ -1206,11 +1307,11 @@ export interface AddToCurrentCartRequest {
|
|
|
1206
1307
|
*/
|
|
1207
1308
|
businessLocationId?: string | null;
|
|
1208
1309
|
}
|
|
1209
|
-
|
|
1310
|
+
interface AddToCartResponse {
|
|
1210
1311
|
/** Updated cart. */
|
|
1211
1312
|
cart?: Cart;
|
|
1212
1313
|
}
|
|
1213
|
-
|
|
1314
|
+
interface AddToCurrentCartAndEstimateTotalsRequest {
|
|
1214
1315
|
/**
|
|
1215
1316
|
* Catalog line items.
|
|
1216
1317
|
* @maxSize 100
|
|
@@ -1245,20 +1346,20 @@ export interface AddToCurrentCartAndEstimateTotalsRequest {
|
|
|
1245
1346
|
*/
|
|
1246
1347
|
calculateShipping?: boolean | null;
|
|
1247
1348
|
}
|
|
1248
|
-
|
|
1349
|
+
interface SelectedMemberships {
|
|
1249
1350
|
/**
|
|
1250
1351
|
* Selected memberships.
|
|
1251
1352
|
* @maxSize 300
|
|
1252
1353
|
*/
|
|
1253
1354
|
memberships?: HostSelectedMembership[];
|
|
1254
1355
|
}
|
|
1255
|
-
|
|
1356
|
+
interface HostSelectedMembership {
|
|
1256
1357
|
/**
|
|
1257
1358
|
* Membership ID.
|
|
1258
1359
|
* @minLength 1
|
|
1259
1360
|
* @maxLength 100
|
|
1260
1361
|
*/
|
|
1261
|
-
|
|
1362
|
+
_id?: string;
|
|
1262
1363
|
/**
|
|
1263
1364
|
* ID of the app providing this payment option.
|
|
1264
1365
|
* @format GUID
|
|
@@ -1273,7 +1374,7 @@ export interface HostSelectedMembership {
|
|
|
1273
1374
|
*/
|
|
1274
1375
|
lineItemIds?: string[];
|
|
1275
1376
|
}
|
|
1276
|
-
|
|
1377
|
+
interface EstimateTotalsResponse {
|
|
1277
1378
|
/** Cart. */
|
|
1278
1379
|
cart?: Cart;
|
|
1279
1380
|
/** Calculated line items. */
|
|
@@ -1320,7 +1421,7 @@ export interface EstimateTotalsResponse {
|
|
|
1320
1421
|
*/
|
|
1321
1422
|
violations?: Violation[];
|
|
1322
1423
|
}
|
|
1323
|
-
|
|
1424
|
+
interface CalculatedLineItem {
|
|
1324
1425
|
/** Line item ID. */
|
|
1325
1426
|
lineItemId?: string;
|
|
1326
1427
|
/** Price breakdown for this line item. */
|
|
@@ -1333,8 +1434,13 @@ export interface CalculatedLineItem {
|
|
|
1333
1434
|
* + `"DEPOSIT_ONLINE"` - Partial payment of the given item will happen as part of the checkout. Amount to be paid is defined by deposit_amount field.
|
|
1334
1435
|
*/
|
|
1335
1436
|
paymentOption?: PaymentOptionType;
|
|
1437
|
+
/**
|
|
1438
|
+
* tax calculation address.
|
|
1439
|
+
* @internal
|
|
1440
|
+
*/
|
|
1441
|
+
taxableAddress?: TaxableAddress;
|
|
1336
1442
|
}
|
|
1337
|
-
|
|
1443
|
+
interface LineItemPricesData {
|
|
1338
1444
|
/** Total price after discounts, tax, and modifiers. */
|
|
1339
1445
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1340
1446
|
/** Total price after discounts and modifiers, and before tax. */
|
|
@@ -1360,7 +1466,7 @@ export interface LineItemPricesData {
|
|
|
1360
1466
|
/** Total price of all item modifiers. */
|
|
1361
1467
|
modifiers?: MultiCurrencyPrice;
|
|
1362
1468
|
}
|
|
1363
|
-
|
|
1469
|
+
interface ItemTaxFullDetails {
|
|
1364
1470
|
/** Amount for which tax is calculated. */
|
|
1365
1471
|
taxableAmount?: MultiCurrencyPrice;
|
|
1366
1472
|
/**
|
|
@@ -1377,7 +1483,7 @@ export interface ItemTaxFullDetails {
|
|
|
1377
1483
|
*/
|
|
1378
1484
|
rateBreakdown?: TaxRateBreakdown[];
|
|
1379
1485
|
}
|
|
1380
|
-
|
|
1486
|
+
interface TaxRateBreakdown {
|
|
1381
1487
|
/**
|
|
1382
1488
|
* Name of tax against which the calculation was performed.
|
|
1383
1489
|
* @maxLength 100
|
|
@@ -1395,7 +1501,7 @@ export interface TaxRateBreakdown {
|
|
|
1395
1501
|
* TaxBreakdown represents tax information for a line item.
|
|
1396
1502
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
1397
1503
|
*/
|
|
1398
|
-
|
|
1504
|
+
interface TaxBreakdown {
|
|
1399
1505
|
/**
|
|
1400
1506
|
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
1401
1507
|
* @maxLength 200
|
|
@@ -1427,7 +1533,7 @@ export interface TaxBreakdown {
|
|
|
1427
1533
|
jurisdictionType?: JurisdictionType;
|
|
1428
1534
|
}
|
|
1429
1535
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1430
|
-
|
|
1536
|
+
declare enum JurisdictionType {
|
|
1431
1537
|
UNDEFINED = "UNDEFINED",
|
|
1432
1538
|
COUNTRY = "COUNTRY",
|
|
1433
1539
|
STATE = "STATE",
|
|
@@ -1435,7 +1541,7 @@ export declare enum JurisdictionType {
|
|
|
1435
1541
|
CITY = "CITY",
|
|
1436
1542
|
SPECIAL = "SPECIAL"
|
|
1437
1543
|
}
|
|
1438
|
-
|
|
1544
|
+
interface PriceSummary {
|
|
1439
1545
|
/** Subtotal of all line items, before discounts and before tax. */
|
|
1440
1546
|
subtotal?: MultiCurrencyPrice;
|
|
1441
1547
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1449,12 +1555,12 @@ export interface PriceSummary {
|
|
|
1449
1555
|
/** Total additional fees price before tax. */
|
|
1450
1556
|
additionalFees?: MultiCurrencyPrice;
|
|
1451
1557
|
}
|
|
1452
|
-
|
|
1558
|
+
interface GiftCard {
|
|
1453
1559
|
/**
|
|
1454
1560
|
* Gift Card ID.
|
|
1455
1561
|
* @deprecated
|
|
1456
1562
|
*/
|
|
1457
|
-
|
|
1563
|
+
_id?: string;
|
|
1458
1564
|
/** Gift card obfuscated code. */
|
|
1459
1565
|
obfuscatedCode?: string;
|
|
1460
1566
|
/** Gift card value. */
|
|
@@ -1472,7 +1578,7 @@ export interface GiftCard {
|
|
|
1472
1578
|
*/
|
|
1473
1579
|
externalId?: string | null;
|
|
1474
1580
|
}
|
|
1475
|
-
|
|
1581
|
+
interface TaxSummary {
|
|
1476
1582
|
/**
|
|
1477
1583
|
* Amount for which tax is calculated, added from line items.
|
|
1478
1584
|
* @readonly
|
|
@@ -1489,7 +1595,7 @@ export interface TaxSummary {
|
|
|
1489
1595
|
*/
|
|
1490
1596
|
calculationDetails?: TaxCalculationDetails;
|
|
1491
1597
|
}
|
|
1492
|
-
|
|
1598
|
+
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1493
1599
|
/** Reason the manual calculation was used. */
|
|
1494
1600
|
manualRateReason?: ManualCalculationReason;
|
|
1495
1601
|
/** Details of the fallback rate calculation. */
|
|
@@ -1498,13 +1604,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
|
|
|
1498
1604
|
rateType?: RateType;
|
|
1499
1605
|
}
|
|
1500
1606
|
/** @oneof */
|
|
1501
|
-
|
|
1607
|
+
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1502
1608
|
/** Reason the manual calculation was used. */
|
|
1503
1609
|
manualRateReason?: ManualCalculationReason;
|
|
1504
1610
|
/** Details of the fallback rate calculation. */
|
|
1505
1611
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1506
1612
|
}
|
|
1507
|
-
|
|
1613
|
+
declare enum RateType {
|
|
1508
1614
|
/** no tax being collected for this request due to location of purchase */
|
|
1509
1615
|
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
1510
1616
|
/** manual rate used for calculation */
|
|
@@ -1514,25 +1620,25 @@ export declare enum RateType {
|
|
|
1514
1620
|
/** fallback rate used for calculation */
|
|
1515
1621
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1516
1622
|
}
|
|
1517
|
-
|
|
1623
|
+
declare enum ManualCalculationReason {
|
|
1518
1624
|
/** user set calculator in Business Manager to be Manual */
|
|
1519
1625
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1520
1626
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1521
1627
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1522
1628
|
}
|
|
1523
|
-
|
|
1629
|
+
interface AutoTaxFallbackCalculationDetails {
|
|
1524
1630
|
/** reason for fallback */
|
|
1525
1631
|
fallbackReason?: FallbackReason;
|
|
1526
1632
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1527
1633
|
error?: ApplicationError;
|
|
1528
1634
|
}
|
|
1529
|
-
|
|
1635
|
+
declare enum FallbackReason {
|
|
1530
1636
|
/** auto-tax failed to be calculated */
|
|
1531
1637
|
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
1532
1638
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
1533
1639
|
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
1534
1640
|
}
|
|
1535
|
-
|
|
1641
|
+
interface ApplicationError {
|
|
1536
1642
|
/** Error code. */
|
|
1537
1643
|
code?: string;
|
|
1538
1644
|
/** Description of the error. */
|
|
@@ -1544,7 +1650,7 @@ export interface ApplicationError {
|
|
|
1544
1650
|
* 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
1651
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1546
1652
|
*/
|
|
1547
|
-
|
|
1653
|
+
interface AggregatedTaxBreakdown {
|
|
1548
1654
|
/**
|
|
1549
1655
|
* The name of the tax against which this tax amount was calculated.
|
|
1550
1656
|
* @maxLength 200
|
|
@@ -1570,7 +1676,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
1570
1676
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1571
1677
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
1572
1678
|
}
|
|
1573
|
-
|
|
1679
|
+
interface ShippingInformation {
|
|
1574
1680
|
/** Shipping region. */
|
|
1575
1681
|
region?: ShippingRegion;
|
|
1576
1682
|
/** Selected shipping option. */
|
|
@@ -1578,20 +1684,20 @@ export interface ShippingInformation {
|
|
|
1578
1684
|
/** All shipping options. */
|
|
1579
1685
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
1580
1686
|
}
|
|
1581
|
-
|
|
1687
|
+
interface ShippingRegion {
|
|
1582
1688
|
/**
|
|
1583
1689
|
* Shipping region ID.
|
|
1584
1690
|
* @format GUID
|
|
1585
1691
|
* @readonly
|
|
1586
1692
|
*/
|
|
1587
|
-
|
|
1693
|
+
_id?: string;
|
|
1588
1694
|
/**
|
|
1589
1695
|
* Shipping region name.
|
|
1590
1696
|
* @maxLength 100
|
|
1591
1697
|
*/
|
|
1592
1698
|
name?: string;
|
|
1593
1699
|
}
|
|
1594
|
-
|
|
1700
|
+
interface SelectedCarrierServiceOption {
|
|
1595
1701
|
/**
|
|
1596
1702
|
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1597
1703
|
* @maxLength 100
|
|
@@ -1634,7 +1740,7 @@ export interface SelectedCarrierServiceOption {
|
|
|
1634
1740
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1635
1741
|
partial?: boolean | null;
|
|
1636
1742
|
}
|
|
1637
|
-
|
|
1743
|
+
interface DeliveryLogistics {
|
|
1638
1744
|
/**
|
|
1639
1745
|
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1640
1746
|
* @maxLength 500
|
|
@@ -1648,7 +1754,7 @@ export interface DeliveryLogistics {
|
|
|
1648
1754
|
/** Pickup details. */
|
|
1649
1755
|
pickupDetails?: PickupDetails;
|
|
1650
1756
|
}
|
|
1651
|
-
|
|
1757
|
+
interface PickupDetails {
|
|
1652
1758
|
/** Pickup address. */
|
|
1653
1759
|
address?: Address;
|
|
1654
1760
|
/**
|
|
@@ -1659,18 +1765,18 @@ export interface PickupDetails {
|
|
|
1659
1765
|
/** Pickup method */
|
|
1660
1766
|
pickupMethod?: PickupMethod;
|
|
1661
1767
|
}
|
|
1662
|
-
|
|
1768
|
+
declare enum PickupMethod {
|
|
1663
1769
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1664
1770
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1665
1771
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1666
1772
|
}
|
|
1667
|
-
|
|
1773
|
+
interface DeliveryTimeSlot {
|
|
1668
1774
|
/** starting time of the delivery time slot */
|
|
1669
1775
|
from?: Date | null;
|
|
1670
1776
|
/** ending time of the delivery time slot */
|
|
1671
1777
|
to?: Date | null;
|
|
1672
1778
|
}
|
|
1673
|
-
|
|
1779
|
+
interface SelectedCarrierServiceOptionPrices {
|
|
1674
1780
|
/** Total shipping price, after discount and after tax. */
|
|
1675
1781
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1676
1782
|
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
@@ -1682,7 +1788,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1682
1788
|
/** Shipping price before discount and before tax. */
|
|
1683
1789
|
price?: MultiCurrencyPrice;
|
|
1684
1790
|
}
|
|
1685
|
-
|
|
1791
|
+
interface SelectedCarrierServiceOptionOtherCharge {
|
|
1686
1792
|
/** Type of additional cost. */
|
|
1687
1793
|
type?: ChargeType;
|
|
1688
1794
|
/**
|
|
@@ -1693,11 +1799,11 @@ export interface SelectedCarrierServiceOptionOtherCharge {
|
|
|
1693
1799
|
/** Price of added charge. */
|
|
1694
1800
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
1695
1801
|
}
|
|
1696
|
-
|
|
1802
|
+
declare enum ChargeType {
|
|
1697
1803
|
HANDLING_FEE = "HANDLING_FEE",
|
|
1698
1804
|
INSURANCE = "INSURANCE"
|
|
1699
1805
|
}
|
|
1700
|
-
|
|
1806
|
+
interface DeliveryAllocation {
|
|
1701
1807
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
1702
1808
|
deliveryCarrier?: Carrier;
|
|
1703
1809
|
/** The delivery region that are relevant for this delivery solution. */
|
|
@@ -1705,7 +1811,7 @@ export interface DeliveryAllocation {
|
|
|
1705
1811
|
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
1706
1812
|
applicableLineItems?: ApplicableLineItems;
|
|
1707
1813
|
}
|
|
1708
|
-
|
|
1814
|
+
interface Carrier {
|
|
1709
1815
|
/**
|
|
1710
1816
|
* The carrier app id
|
|
1711
1817
|
* @format GUID
|
|
@@ -1717,19 +1823,19 @@ export interface Carrier {
|
|
|
1717
1823
|
*/
|
|
1718
1824
|
code?: string;
|
|
1719
1825
|
}
|
|
1720
|
-
|
|
1826
|
+
interface Region {
|
|
1721
1827
|
/**
|
|
1722
1828
|
* The delivery region id.
|
|
1723
1829
|
* @format GUID
|
|
1724
1830
|
*/
|
|
1725
|
-
|
|
1831
|
+
_id?: string | null;
|
|
1726
1832
|
/**
|
|
1727
1833
|
* The delivery region name.
|
|
1728
1834
|
* @maxLength 100
|
|
1729
1835
|
*/
|
|
1730
1836
|
name?: string | null;
|
|
1731
1837
|
}
|
|
1732
|
-
|
|
1838
|
+
interface ApplicableLineItems {
|
|
1733
1839
|
/**
|
|
1734
1840
|
* Line items that the delivery solution is for.
|
|
1735
1841
|
* @maxSize 300
|
|
@@ -1738,7 +1844,7 @@ export interface ApplicableLineItems {
|
|
|
1738
1844
|
*/
|
|
1739
1845
|
lineItemIds?: string[];
|
|
1740
1846
|
}
|
|
1741
|
-
|
|
1847
|
+
interface CarrierServiceOption {
|
|
1742
1848
|
/**
|
|
1743
1849
|
* Carrier ID.
|
|
1744
1850
|
* @format GUID
|
|
@@ -1747,7 +1853,7 @@ export interface CarrierServiceOption {
|
|
|
1747
1853
|
/** Shipping options offered by this carrier for this request. */
|
|
1748
1854
|
shippingOptions?: ShippingOption[];
|
|
1749
1855
|
}
|
|
1750
|
-
|
|
1856
|
+
interface ShippingOption {
|
|
1751
1857
|
/**
|
|
1752
1858
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1753
1859
|
* For legacy calculators this would be the UUID of the option.
|
|
@@ -1772,19 +1878,19 @@ export interface ShippingOption {
|
|
|
1772
1878
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1773
1879
|
partial?: boolean | null;
|
|
1774
1880
|
}
|
|
1775
|
-
|
|
1881
|
+
interface ShippingPrice {
|
|
1776
1882
|
/** Shipping price. */
|
|
1777
1883
|
price?: MultiCurrencyPrice;
|
|
1778
1884
|
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
1779
1885
|
otherCharges?: OtherCharge[];
|
|
1780
1886
|
}
|
|
1781
|
-
|
|
1887
|
+
interface OtherCharge {
|
|
1782
1888
|
/** Type of additional cost. */
|
|
1783
1889
|
type?: ChargeType;
|
|
1784
1890
|
/** Price of added cost. */
|
|
1785
1891
|
price?: MultiCurrencyPrice;
|
|
1786
1892
|
}
|
|
1787
|
-
|
|
1893
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1788
1894
|
/** Coupon details. */
|
|
1789
1895
|
coupon?: V1Coupon;
|
|
1790
1896
|
/** Merchant discount. */
|
|
@@ -1801,9 +1907,17 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1801
1907
|
* @targetRemovalDate 2024-06-01
|
|
1802
1908
|
*/
|
|
1803
1909
|
lineItemIds?: string[];
|
|
1910
|
+
/**
|
|
1911
|
+
* Number of subscription cycle this discount applies to
|
|
1912
|
+
* default None - all billing cycle
|
|
1913
|
+
* @internal
|
|
1914
|
+
* @min 1
|
|
1915
|
+
* @max 999
|
|
1916
|
+
*/
|
|
1917
|
+
subscriptionCycles?: number | null;
|
|
1804
1918
|
}
|
|
1805
1919
|
/** @oneof */
|
|
1806
|
-
|
|
1920
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1807
1921
|
/** Coupon details. */
|
|
1808
1922
|
coupon?: V1Coupon;
|
|
1809
1923
|
/** Merchant discount. */
|
|
@@ -1811,15 +1925,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1811
1925
|
/** Discount rule */
|
|
1812
1926
|
discountRule?: V1DiscountRule;
|
|
1813
1927
|
}
|
|
1814
|
-
|
|
1928
|
+
declare enum AppliedDiscountDiscountType {
|
|
1815
1929
|
GLOBAL = "GLOBAL",
|
|
1816
1930
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1817
1931
|
SHIPPING = "SHIPPING"
|
|
1818
1932
|
}
|
|
1819
1933
|
/** Coupon */
|
|
1820
|
-
|
|
1934
|
+
interface V1Coupon {
|
|
1821
1935
|
/** Coupon ID. */
|
|
1822
|
-
|
|
1936
|
+
_id?: string;
|
|
1823
1937
|
/** Coupon code. */
|
|
1824
1938
|
code?: string;
|
|
1825
1939
|
/** Coupon value. */
|
|
@@ -1827,7 +1941,7 @@ export interface V1Coupon {
|
|
|
1827
1941
|
/** Coupon name. */
|
|
1828
1942
|
name?: string;
|
|
1829
1943
|
}
|
|
1830
|
-
|
|
1944
|
+
interface V1MerchantDiscount {
|
|
1831
1945
|
/** Discount value. */
|
|
1832
1946
|
amount?: MultiCurrencyPrice;
|
|
1833
1947
|
/**
|
|
@@ -1837,18 +1951,18 @@ export interface V1MerchantDiscount {
|
|
|
1837
1951
|
*/
|
|
1838
1952
|
percentage?: number | null;
|
|
1839
1953
|
}
|
|
1840
|
-
|
|
1954
|
+
interface V1DiscountRule {
|
|
1841
1955
|
/**
|
|
1842
1956
|
* Discount rule ID
|
|
1843
1957
|
* @format GUID
|
|
1844
1958
|
*/
|
|
1845
|
-
|
|
1959
|
+
_id?: string;
|
|
1846
1960
|
/** Discount rule name */
|
|
1847
1961
|
name?: V1DiscountRuleName;
|
|
1848
1962
|
/** Discount value. */
|
|
1849
1963
|
amount?: MultiCurrencyPrice;
|
|
1850
1964
|
}
|
|
1851
|
-
|
|
1965
|
+
interface V1DiscountRuleName {
|
|
1852
1966
|
/**
|
|
1853
1967
|
* Original discount rule name (in site's default language).
|
|
1854
1968
|
* @minLength 1
|
|
@@ -1862,16 +1976,16 @@ export interface V1DiscountRuleName {
|
|
|
1862
1976
|
*/
|
|
1863
1977
|
translated?: string | null;
|
|
1864
1978
|
}
|
|
1865
|
-
|
|
1979
|
+
interface LineItemDiscount {
|
|
1866
1980
|
/**
|
|
1867
1981
|
* ID of line item the discount applies to.
|
|
1868
1982
|
* @format GUID
|
|
1869
1983
|
*/
|
|
1870
|
-
|
|
1984
|
+
_id?: string;
|
|
1871
1985
|
/** Discount value. */
|
|
1872
1986
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
1873
1987
|
}
|
|
1874
|
-
|
|
1988
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1875
1989
|
/** General shipping calculation error. */
|
|
1876
1990
|
generalShippingCalculationError?: Details;
|
|
1877
1991
|
/** Carrier errors. */
|
|
@@ -1893,13 +2007,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
1893
2007
|
discountsCalculationError?: Details;
|
|
1894
2008
|
}
|
|
1895
2009
|
/** @oneof */
|
|
1896
|
-
|
|
2010
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1897
2011
|
/** General shipping calculation error. */
|
|
1898
2012
|
generalShippingCalculationError?: Details;
|
|
1899
2013
|
/** Carrier errors. */
|
|
1900
2014
|
carrierErrors?: CarrierErrors;
|
|
1901
2015
|
}
|
|
1902
|
-
|
|
2016
|
+
interface Details extends DetailsKindOneOf {
|
|
1903
2017
|
applicationError?: ApplicationError;
|
|
1904
2018
|
validationError?: ValidationError;
|
|
1905
2019
|
systemError?: SystemError;
|
|
@@ -1910,7 +2024,7 @@ export interface Details extends DetailsKindOneOf {
|
|
|
1910
2024
|
tracing?: Record<string, string>;
|
|
1911
2025
|
}
|
|
1912
2026
|
/** @oneof */
|
|
1913
|
-
|
|
2027
|
+
interface DetailsKindOneOf {
|
|
1914
2028
|
applicationError?: ApplicationError;
|
|
1915
2029
|
validationError?: ValidationError;
|
|
1916
2030
|
systemError?: SystemError;
|
|
@@ -1947,10 +2061,10 @@ export interface DetailsKindOneOf {
|
|
|
1947
2061
|
* ]
|
|
1948
2062
|
* }
|
|
1949
2063
|
*/
|
|
1950
|
-
|
|
2064
|
+
interface ValidationError {
|
|
1951
2065
|
fieldViolations?: FieldViolation[];
|
|
1952
2066
|
}
|
|
1953
|
-
|
|
2067
|
+
declare enum RuleType {
|
|
1954
2068
|
VALIDATION = "VALIDATION",
|
|
1955
2069
|
OTHER = "OTHER",
|
|
1956
2070
|
MAX = "MAX",
|
|
@@ -1973,7 +2087,7 @@ export declare enum RuleType {
|
|
|
1973
2087
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1974
2088
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1975
2089
|
}
|
|
1976
|
-
|
|
2090
|
+
interface FieldViolation {
|
|
1977
2091
|
field?: string;
|
|
1978
2092
|
description?: string;
|
|
1979
2093
|
violatedRule?: RuleType;
|
|
@@ -1981,21 +2095,21 @@ export interface FieldViolation {
|
|
|
1981
2095
|
ruleName?: string | null;
|
|
1982
2096
|
data?: Record<string, any> | null;
|
|
1983
2097
|
}
|
|
1984
|
-
|
|
2098
|
+
interface SystemError {
|
|
1985
2099
|
/** Error code. */
|
|
1986
2100
|
errorCode?: string | null;
|
|
1987
2101
|
}
|
|
1988
|
-
|
|
2102
|
+
interface CarrierErrors {
|
|
1989
2103
|
/** Carrier errors. */
|
|
1990
2104
|
errors?: CarrierError[];
|
|
1991
2105
|
}
|
|
1992
|
-
|
|
2106
|
+
interface CarrierError {
|
|
1993
2107
|
/** Carrier ID. */
|
|
1994
2108
|
carrierId?: string;
|
|
1995
2109
|
/** Error details. */
|
|
1996
2110
|
error?: Details;
|
|
1997
2111
|
}
|
|
1998
|
-
|
|
2112
|
+
interface MembershipOptions {
|
|
1999
2113
|
/**
|
|
2000
2114
|
* List of payment options that can be used.
|
|
2001
2115
|
* @maxSize 300
|
|
@@ -2012,13 +2126,13 @@ export interface MembershipOptions {
|
|
|
2012
2126
|
*/
|
|
2013
2127
|
selectedMemberships?: HostSelectedMembership[];
|
|
2014
2128
|
}
|
|
2015
|
-
|
|
2129
|
+
interface Membership {
|
|
2016
2130
|
/**
|
|
2017
2131
|
* Membership ID.
|
|
2018
2132
|
* @minLength 1
|
|
2019
2133
|
* @maxLength 100
|
|
2020
2134
|
*/
|
|
2021
|
-
|
|
2135
|
+
_id?: string;
|
|
2022
2136
|
/**
|
|
2023
2137
|
* ID of the application providing this payment option.
|
|
2024
2138
|
* @format GUID
|
|
@@ -2041,7 +2155,7 @@ export interface Membership {
|
|
|
2041
2155
|
/** Additional data about this membership. */
|
|
2042
2156
|
additionalData?: Record<string, any> | null;
|
|
2043
2157
|
}
|
|
2044
|
-
|
|
2158
|
+
interface MembershipName {
|
|
2045
2159
|
/**
|
|
2046
2160
|
* Membership name.
|
|
2047
2161
|
* @maxLength 100
|
|
@@ -2053,7 +2167,7 @@ export interface MembershipName {
|
|
|
2053
2167
|
*/
|
|
2054
2168
|
translated?: string | null;
|
|
2055
2169
|
}
|
|
2056
|
-
|
|
2170
|
+
interface MembershipPaymentCredits {
|
|
2057
2171
|
/**
|
|
2058
2172
|
* Membership's total amount of credits.
|
|
2059
2173
|
* @min 1
|
|
@@ -2062,7 +2176,7 @@ export interface MembershipPaymentCredits {
|
|
|
2062
2176
|
/** Membership's remaining amount of credits. */
|
|
2063
2177
|
remaining?: number;
|
|
2064
2178
|
}
|
|
2065
|
-
|
|
2179
|
+
interface InvalidMembership {
|
|
2066
2180
|
/** Membership details. */
|
|
2067
2181
|
membership?: Membership;
|
|
2068
2182
|
/**
|
|
@@ -2072,7 +2186,7 @@ export interface InvalidMembership {
|
|
|
2072
2186
|
*/
|
|
2073
2187
|
reason?: string;
|
|
2074
2188
|
}
|
|
2075
|
-
|
|
2189
|
+
interface AdditionalFee {
|
|
2076
2190
|
/**
|
|
2077
2191
|
* Additional fee's unique code (or ID) for future processing.
|
|
2078
2192
|
* @minLength 1
|
|
@@ -2105,10 +2219,18 @@ export interface AdditionalFee {
|
|
|
2105
2219
|
* @format GUID
|
|
2106
2220
|
*/
|
|
2107
2221
|
lineItemIds?: string[];
|
|
2222
|
+
/**
|
|
2223
|
+
* Number of subscription cycle this fee applies to
|
|
2224
|
+
* default None - all billing cycle
|
|
2225
|
+
* @internal
|
|
2226
|
+
* @min 1
|
|
2227
|
+
* @max 999
|
|
2228
|
+
*/
|
|
2229
|
+
subscriptionCycles?: number | null;
|
|
2108
2230
|
/** the source the additional fee was added from */
|
|
2109
2231
|
source?: AdditionalFeeSource;
|
|
2110
2232
|
}
|
|
2111
|
-
|
|
2233
|
+
declare enum AdditionalFeeSource {
|
|
2112
2234
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
2113
2235
|
/** The additional fee was added by an additional fee service plugin */
|
|
2114
2236
|
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
@@ -2117,7 +2239,7 @@ export declare enum AdditionalFeeSource {
|
|
|
2117
2239
|
/** The additional fee was added manually on the request */
|
|
2118
2240
|
MANUAL = "MANUAL"
|
|
2119
2241
|
}
|
|
2120
|
-
|
|
2242
|
+
interface Violation {
|
|
2121
2243
|
/** 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
2244
|
severity?: Severity;
|
|
2123
2245
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
@@ -2129,7 +2251,7 @@ export interface Violation {
|
|
|
2129
2251
|
*/
|
|
2130
2252
|
description?: string | null;
|
|
2131
2253
|
}
|
|
2132
|
-
|
|
2254
|
+
declare enum Severity {
|
|
2133
2255
|
/** The user is allowed to move forward in the flow. */
|
|
2134
2256
|
WARNING = "WARNING",
|
|
2135
2257
|
/**
|
|
@@ -2138,48 +2260,53 @@ export declare enum Severity {
|
|
|
2138
2260
|
*/
|
|
2139
2261
|
ERROR = "ERROR"
|
|
2140
2262
|
}
|
|
2141
|
-
|
|
2263
|
+
interface Target extends TargetTargetTypeOneOf {
|
|
2142
2264
|
/** General (other) violation. */
|
|
2143
2265
|
other?: Other;
|
|
2144
2266
|
/** Specific line item violation. */
|
|
2145
2267
|
lineItem?: TargetLineItem;
|
|
2146
2268
|
}
|
|
2147
2269
|
/** @oneof */
|
|
2148
|
-
|
|
2270
|
+
interface TargetTargetTypeOneOf {
|
|
2149
2271
|
/** General (other) violation. */
|
|
2150
2272
|
other?: Other;
|
|
2151
2273
|
/** Specific line item violation. */
|
|
2152
2274
|
lineItem?: TargetLineItem;
|
|
2153
2275
|
}
|
|
2154
2276
|
/** Available locations on the webpage */
|
|
2155
|
-
|
|
2277
|
+
declare enum NameInOther {
|
|
2156
2278
|
/** Default location, in case no specific location is specified. */
|
|
2157
2279
|
OTHER_DEFAULT = "OTHER_DEFAULT"
|
|
2158
2280
|
}
|
|
2159
2281
|
/** Available locations on the line item */
|
|
2160
|
-
|
|
2282
|
+
declare enum NameInLineItem {
|
|
2161
2283
|
/** Default location, in case no specific location is specified. */
|
|
2162
2284
|
LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
|
|
2163
2285
|
}
|
|
2164
|
-
|
|
2286
|
+
declare enum SuggestedFix {
|
|
2165
2287
|
/** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
|
|
2166
2288
|
UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
|
|
2167
2289
|
/** The line item should be removed from the cart or checkout to resolve the violation. */
|
|
2168
2290
|
REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
|
|
2169
2291
|
}
|
|
2170
2292
|
/** General (other) violation. */
|
|
2171
|
-
|
|
2293
|
+
interface Other {
|
|
2172
2294
|
/** Location on a checkout or a cart page where a general (other) violation will be displayed. */
|
|
2173
2295
|
name?: NameInOther;
|
|
2174
2296
|
}
|
|
2175
2297
|
/** Specific line item violation. */
|
|
2176
|
-
|
|
2298
|
+
interface TargetLineItem {
|
|
2177
2299
|
/** Location on a checkout or a cart page where the specific line item violation will be displayed. */
|
|
2178
2300
|
name?: NameInLineItem;
|
|
2179
2301
|
/** ID of the line item containing the violation. */
|
|
2180
|
-
|
|
2302
|
+
_id?: string | null;
|
|
2303
|
+
/**
|
|
2304
|
+
* Suggested fix for resolving the line item violation.
|
|
2305
|
+
* @internal
|
|
2306
|
+
*/
|
|
2307
|
+
suggestedFix?: SuggestedFix;
|
|
2181
2308
|
}
|
|
2182
|
-
|
|
2309
|
+
interface RemoveLineItemsFromCurrentCartRequest {
|
|
2183
2310
|
/**
|
|
2184
2311
|
* Line item IDs to remove from cart.
|
|
2185
2312
|
* @format GUID
|
|
@@ -2188,11 +2315,11 @@ export interface RemoveLineItemsFromCurrentCartRequest {
|
|
|
2188
2315
|
*/
|
|
2189
2316
|
lineItemIds?: string[];
|
|
2190
2317
|
}
|
|
2191
|
-
|
|
2318
|
+
interface RemoveLineItemsResponse {
|
|
2192
2319
|
/** Updated cart. */
|
|
2193
2320
|
cart?: Cart;
|
|
2194
2321
|
}
|
|
2195
|
-
|
|
2322
|
+
interface CreateCheckoutFromCurrentCartRequest {
|
|
2196
2323
|
/** __Required.__ Sales channel type. */
|
|
2197
2324
|
channelType?: ChannelType;
|
|
2198
2325
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
@@ -2207,7 +2334,7 @@ export interface CreateCheckoutFromCurrentCartRequest {
|
|
|
2207
2334
|
*/
|
|
2208
2335
|
email?: string | null;
|
|
2209
2336
|
}
|
|
2210
|
-
|
|
2337
|
+
declare enum ChannelType {
|
|
2211
2338
|
/** Unspecified sales channel. This value is not supported. */
|
|
2212
2339
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2213
2340
|
/** A web client. */
|
|
@@ -2241,17 +2368,17 @@ export declare enum ChannelType {
|
|
|
2241
2368
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2242
2369
|
FAIRE_COM = "FAIRE_COM"
|
|
2243
2370
|
}
|
|
2244
|
-
|
|
2371
|
+
interface CreateCheckoutResponse {
|
|
2245
2372
|
/** The newly created checkout's ID. */
|
|
2246
2373
|
checkoutId?: string;
|
|
2247
2374
|
}
|
|
2248
|
-
|
|
2375
|
+
interface RemoveCouponFromCurrentCartRequest {
|
|
2249
2376
|
}
|
|
2250
|
-
|
|
2377
|
+
interface RemoveCouponResponse {
|
|
2251
2378
|
/** Updated cart. */
|
|
2252
2379
|
cart?: Cart;
|
|
2253
2380
|
}
|
|
2254
|
-
|
|
2381
|
+
interface UpdateCurrentCartLineItemQuantityRequest {
|
|
2255
2382
|
/**
|
|
2256
2383
|
* Line item IDs and their new quantity.
|
|
2257
2384
|
* @minSize 1
|
|
@@ -2259,12 +2386,12 @@ export interface UpdateCurrentCartLineItemQuantityRequest {
|
|
|
2259
2386
|
*/
|
|
2260
2387
|
lineItems?: LineItemQuantityUpdate[];
|
|
2261
2388
|
}
|
|
2262
|
-
|
|
2389
|
+
interface LineItemQuantityUpdate {
|
|
2263
2390
|
/**
|
|
2264
2391
|
* *Required.** Line item ID.
|
|
2265
2392
|
* @format GUID
|
|
2266
2393
|
*/
|
|
2267
|
-
|
|
2394
|
+
_id?: string;
|
|
2268
2395
|
/**
|
|
2269
2396
|
* *Required.** New quantity. Number must be 1 or higher.
|
|
2270
2397
|
* @min 1
|
|
@@ -2272,11 +2399,11 @@ export interface LineItemQuantityUpdate {
|
|
|
2272
2399
|
*/
|
|
2273
2400
|
quantity?: number;
|
|
2274
2401
|
}
|
|
2275
|
-
|
|
2402
|
+
interface UpdateLineItemsQuantityResponse {
|
|
2276
2403
|
/** Updated cart. */
|
|
2277
2404
|
cart?: Cart;
|
|
2278
2405
|
}
|
|
2279
|
-
|
|
2406
|
+
interface EstimateCurrentCartTotalsRequest {
|
|
2280
2407
|
/** Selected shipping option. */
|
|
2281
2408
|
selectedShippingOption?: SelectedShippingOption;
|
|
2282
2409
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
@@ -2298,11 +2425,11 @@ export interface EstimateCurrentCartTotalsRequest {
|
|
|
2298
2425
|
*/
|
|
2299
2426
|
calculateShipping?: boolean | null;
|
|
2300
2427
|
}
|
|
2301
|
-
|
|
2428
|
+
interface DeleteCurrentCartRequest {
|
|
2302
2429
|
}
|
|
2303
|
-
|
|
2430
|
+
interface DeleteCartResponse {
|
|
2304
2431
|
}
|
|
2305
|
-
|
|
2432
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2306
2433
|
createdEvent?: EntityCreatedEvent;
|
|
2307
2434
|
updatedEvent?: EntityUpdatedEvent;
|
|
2308
2435
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -2311,7 +2438,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2311
2438
|
* Unique event ID.
|
|
2312
2439
|
* Allows clients to ignore duplicate webhooks.
|
|
2313
2440
|
*/
|
|
2314
|
-
|
|
2441
|
+
_id?: string;
|
|
2315
2442
|
/**
|
|
2316
2443
|
* Assumes actions are also always typed to an entity_type
|
|
2317
2444
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -2345,36 +2472,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2345
2472
|
entityEventSequence?: string | null;
|
|
2346
2473
|
}
|
|
2347
2474
|
/** @oneof */
|
|
2348
|
-
|
|
2475
|
+
interface DomainEventBodyOneOf {
|
|
2349
2476
|
createdEvent?: EntityCreatedEvent;
|
|
2350
2477
|
updatedEvent?: EntityUpdatedEvent;
|
|
2351
2478
|
deletedEvent?: EntityDeletedEvent;
|
|
2352
2479
|
actionEvent?: ActionEvent;
|
|
2353
2480
|
}
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2357
|
-
restoreInfo?: RestoreInfo;
|
|
2481
|
+
interface EntityCreatedEvent {
|
|
2482
|
+
entity?: string;
|
|
2358
2483
|
}
|
|
2359
|
-
|
|
2484
|
+
interface RestoreInfo {
|
|
2360
2485
|
deletedDate?: Date | null;
|
|
2361
2486
|
}
|
|
2362
|
-
|
|
2487
|
+
interface EntityUpdatedEvent {
|
|
2363
2488
|
/**
|
|
2364
2489
|
* 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
2490
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2366
2491
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2367
2492
|
*/
|
|
2368
|
-
|
|
2493
|
+
currentEntity?: string;
|
|
2369
2494
|
}
|
|
2370
|
-
|
|
2495
|
+
interface EntityDeletedEvent {
|
|
2371
2496
|
/** Entity that was deleted */
|
|
2372
|
-
|
|
2497
|
+
deletedEntity?: string | null;
|
|
2373
2498
|
}
|
|
2374
|
-
|
|
2375
|
-
|
|
2499
|
+
interface ActionEvent {
|
|
2500
|
+
body?: string;
|
|
2376
2501
|
}
|
|
2377
|
-
|
|
2502
|
+
interface MessageEnvelope {
|
|
2378
2503
|
/**
|
|
2379
2504
|
* App instance ID.
|
|
2380
2505
|
* @format GUID
|
|
@@ -2390,7 +2515,7 @@ export interface MessageEnvelope {
|
|
|
2390
2515
|
/** Stringify payload. */
|
|
2391
2516
|
data?: string;
|
|
2392
2517
|
}
|
|
2393
|
-
|
|
2518
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2394
2519
|
/**
|
|
2395
2520
|
* ID of a site visitor that has not logged in to the site.
|
|
2396
2521
|
* @format GUID
|
|
@@ -2415,7 +2540,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2415
2540
|
identityType?: WebhookIdentityType;
|
|
2416
2541
|
}
|
|
2417
2542
|
/** @oneof */
|
|
2418
|
-
|
|
2543
|
+
interface IdentificationDataIdOneOf {
|
|
2419
2544
|
/**
|
|
2420
2545
|
* ID of a site visitor that has not logged in to the site.
|
|
2421
2546
|
* @format GUID
|
|
@@ -2437,14 +2562,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
2437
2562
|
*/
|
|
2438
2563
|
appId?: string;
|
|
2439
2564
|
}
|
|
2440
|
-
|
|
2565
|
+
declare enum WebhookIdentityType {
|
|
2441
2566
|
UNKNOWN = "UNKNOWN",
|
|
2442
2567
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2443
2568
|
MEMBER = "MEMBER",
|
|
2444
2569
|
WIX_USER = "WIX_USER",
|
|
2445
2570
|
APP = "APP"
|
|
2446
2571
|
}
|
|
2447
|
-
|
|
2572
|
+
interface CreateCartRequest {
|
|
2448
2573
|
/** Cart info. */
|
|
2449
2574
|
cartInfo?: Cart;
|
|
2450
2575
|
/** Code of an existing coupon to apply to cart. For more information, see the Coupons API. */
|
|
@@ -2468,38 +2593,38 @@ export interface CreateCartRequest {
|
|
|
2468
2593
|
*/
|
|
2469
2594
|
customLineItems?: CustomLineItem[];
|
|
2470
2595
|
}
|
|
2471
|
-
|
|
2596
|
+
interface CreateCartResponse {
|
|
2472
2597
|
/** Cart. */
|
|
2473
2598
|
cart?: Cart;
|
|
2474
2599
|
}
|
|
2475
|
-
|
|
2600
|
+
interface GetCartRequest {
|
|
2476
2601
|
/**
|
|
2477
2602
|
* Cart ID.
|
|
2478
2603
|
* @format GUID
|
|
2479
2604
|
*/
|
|
2480
|
-
|
|
2605
|
+
_id: string;
|
|
2481
2606
|
}
|
|
2482
|
-
|
|
2607
|
+
interface GetCartResponse {
|
|
2483
2608
|
/** Retrieved cart. */
|
|
2484
2609
|
cart?: Cart;
|
|
2485
2610
|
}
|
|
2486
|
-
|
|
2611
|
+
interface GetCartByCheckoutIdRequest {
|
|
2487
2612
|
/**
|
|
2488
2613
|
* Checkout ID.
|
|
2489
2614
|
* @format GUID
|
|
2490
2615
|
*/
|
|
2491
|
-
|
|
2616
|
+
_id: string;
|
|
2492
2617
|
}
|
|
2493
|
-
|
|
2618
|
+
interface GetCartByCheckoutIdResponse {
|
|
2494
2619
|
/** Retrieved cart. */
|
|
2495
2620
|
cart?: Cart;
|
|
2496
2621
|
}
|
|
2497
|
-
|
|
2622
|
+
interface AddToCartRequest {
|
|
2498
2623
|
/**
|
|
2499
2624
|
* Cart ID.
|
|
2500
2625
|
* @format GUID
|
|
2501
2626
|
*/
|
|
2502
|
-
|
|
2627
|
+
_id: string;
|
|
2503
2628
|
/**
|
|
2504
2629
|
* Catalog line items.
|
|
2505
2630
|
* @maxSize 100
|
|
@@ -2522,12 +2647,12 @@ export interface AddToCartRequest {
|
|
|
2522
2647
|
*/
|
|
2523
2648
|
businessLocationId?: string | null;
|
|
2524
2649
|
}
|
|
2525
|
-
|
|
2650
|
+
interface RemoveLineItemsRequest {
|
|
2526
2651
|
/**
|
|
2527
2652
|
* Cart ID.
|
|
2528
2653
|
* @format GUID
|
|
2529
2654
|
*/
|
|
2530
|
-
|
|
2655
|
+
_id: string;
|
|
2531
2656
|
/**
|
|
2532
2657
|
* Line item IDs to remove from cart.
|
|
2533
2658
|
* @format GUID
|
|
@@ -2536,12 +2661,12 @@ export interface RemoveLineItemsRequest {
|
|
|
2536
2661
|
*/
|
|
2537
2662
|
lineItemIds: string[];
|
|
2538
2663
|
}
|
|
2539
|
-
|
|
2664
|
+
interface CreateCheckoutRequest {
|
|
2540
2665
|
/**
|
|
2541
2666
|
* Cart ID.
|
|
2542
2667
|
* @format GUID
|
|
2543
2668
|
*/
|
|
2544
|
-
|
|
2669
|
+
_id: string;
|
|
2545
2670
|
/** __Required.__ Sales channel type. */
|
|
2546
2671
|
channelType?: ChannelType;
|
|
2547
2672
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
@@ -2556,19 +2681,19 @@ export interface CreateCheckoutRequest {
|
|
|
2556
2681
|
*/
|
|
2557
2682
|
email?: string | null;
|
|
2558
2683
|
}
|
|
2559
|
-
|
|
2684
|
+
interface RemoveCouponRequest {
|
|
2560
2685
|
/**
|
|
2561
2686
|
* Cart ID.
|
|
2562
2687
|
* @format GUID
|
|
2563
2688
|
*/
|
|
2564
|
-
|
|
2689
|
+
_id: string;
|
|
2565
2690
|
}
|
|
2566
|
-
|
|
2691
|
+
interface UpdateLineItemsQuantityRequest {
|
|
2567
2692
|
/**
|
|
2568
2693
|
* Cart ID.
|
|
2569
2694
|
* @format GUID
|
|
2570
2695
|
*/
|
|
2571
|
-
|
|
2696
|
+
_id: string;
|
|
2572
2697
|
/**
|
|
2573
2698
|
* Line item IDs and their new quantity.
|
|
2574
2699
|
* @minSize 1
|
|
@@ -2576,12 +2701,12 @@ export interface UpdateLineItemsQuantityRequest {
|
|
|
2576
2701
|
*/
|
|
2577
2702
|
lineItems: LineItemQuantityUpdate[];
|
|
2578
2703
|
}
|
|
2579
|
-
|
|
2704
|
+
interface EstimateTotalsRequest {
|
|
2580
2705
|
/**
|
|
2581
2706
|
* Cart ID.
|
|
2582
2707
|
* @format GUID
|
|
2583
2708
|
*/
|
|
2584
|
-
|
|
2709
|
+
_id: string;
|
|
2585
2710
|
/** Selected shipping option. */
|
|
2586
2711
|
selectedShippingOption?: SelectedShippingOption;
|
|
2587
2712
|
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
@@ -2603,23 +2728,297 @@ export interface EstimateTotalsRequest {
|
|
|
2603
2728
|
*/
|
|
2604
2729
|
calculateShipping?: boolean | null;
|
|
2605
2730
|
}
|
|
2606
|
-
|
|
2731
|
+
interface DeleteCartRequest {
|
|
2607
2732
|
/**
|
|
2608
2733
|
* ID of the cart to delete.
|
|
2609
2734
|
* @format GUID
|
|
2610
2735
|
*/
|
|
2611
|
-
|
|
2736
|
+
_id: string;
|
|
2612
2737
|
}
|
|
2613
|
-
|
|
2738
|
+
interface Empty {
|
|
2614
2739
|
}
|
|
2615
|
-
|
|
2740
|
+
interface RemoveBusinessLocationRequest {
|
|
2616
2741
|
/**
|
|
2617
2742
|
* Cart ID.
|
|
2618
2743
|
* @format GUID
|
|
2619
2744
|
*/
|
|
2620
|
-
|
|
2745
|
+
_id: string;
|
|
2621
2746
|
}
|
|
2622
|
-
|
|
2747
|
+
interface RemoveBusinessLocationResponse {
|
|
2623
2748
|
/** Updated cart. */
|
|
2624
2749
|
cart?: Cart;
|
|
2625
2750
|
}
|
|
2751
|
+
interface BaseEventMetadata {
|
|
2752
|
+
/**
|
|
2753
|
+
* App instance ID.
|
|
2754
|
+
* @format GUID
|
|
2755
|
+
*/
|
|
2756
|
+
instanceId?: string | null;
|
|
2757
|
+
/**
|
|
2758
|
+
* Event type.
|
|
2759
|
+
* @maxLength 150
|
|
2760
|
+
*/
|
|
2761
|
+
eventType?: string;
|
|
2762
|
+
/** The identification type and identity data. */
|
|
2763
|
+
identity?: IdentificationData;
|
|
2764
|
+
}
|
|
2765
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
2766
|
+
/**
|
|
2767
|
+
* Unique event ID.
|
|
2768
|
+
* Allows clients to ignore duplicate webhooks.
|
|
2769
|
+
*/
|
|
2770
|
+
_id?: string;
|
|
2771
|
+
/**
|
|
2772
|
+
* Assumes actions are also always typed to an entity_type
|
|
2773
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2774
|
+
*/
|
|
2775
|
+
entityFqdn?: string;
|
|
2776
|
+
/**
|
|
2777
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2778
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2779
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2780
|
+
*/
|
|
2781
|
+
slug?: string;
|
|
2782
|
+
/** ID of the entity associated with the event. */
|
|
2783
|
+
entityId?: string;
|
|
2784
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2785
|
+
eventTime?: Date | null;
|
|
2786
|
+
/**
|
|
2787
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2788
|
+
* (for example, GDPR).
|
|
2789
|
+
*/
|
|
2790
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2791
|
+
/** If present, indicates the action that triggered the event. */
|
|
2792
|
+
originatedFrom?: string | null;
|
|
2793
|
+
/**
|
|
2794
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2795
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2796
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2797
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2798
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2799
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2800
|
+
*/
|
|
2801
|
+
entityEventSequence?: string | null;
|
|
2802
|
+
}
|
|
2803
|
+
interface CartDeletedEnvelope {
|
|
2804
|
+
metadata: EventMetadata;
|
|
2805
|
+
}
|
|
2806
|
+
interface CartUpdatedEnvelope {
|
|
2807
|
+
entity: Cart;
|
|
2808
|
+
metadata: EventMetadata;
|
|
2809
|
+
}
|
|
2810
|
+
interface CartCreatedEnvelope {
|
|
2811
|
+
entity: Cart;
|
|
2812
|
+
metadata: EventMetadata;
|
|
2813
|
+
}
|
|
2814
|
+
interface CreateCartOptions {
|
|
2815
|
+
/** Cart info. */
|
|
2816
|
+
cartInfo?: Cart;
|
|
2817
|
+
/** Code of an existing coupon to apply to cart. For more information, see the Coupons API. */
|
|
2818
|
+
couponCode?: string | null;
|
|
2819
|
+
/**
|
|
2820
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
|
|
2821
|
+
* @maxSize 100
|
|
2822
|
+
*/
|
|
2823
|
+
merchantDiscounts?: MerchantDiscountInput[];
|
|
2824
|
+
/**
|
|
2825
|
+
* Catalog line items.
|
|
2826
|
+
* @maxSize 300
|
|
2827
|
+
*/
|
|
2828
|
+
lineItems?: LineItem[];
|
|
2829
|
+
/**
|
|
2830
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2831
|
+
*
|
|
2832
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2833
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2834
|
+
* @maxSize 300
|
|
2835
|
+
*/
|
|
2836
|
+
customLineItems?: CustomLineItem[];
|
|
2837
|
+
}
|
|
2838
|
+
interface UpdateCartOptions {
|
|
2839
|
+
/** The information for the cart being updated. */
|
|
2840
|
+
cartInfo: {
|
|
2841
|
+
/**
|
|
2842
|
+
* Cart ID.
|
|
2843
|
+
* @format GUID
|
|
2844
|
+
*/
|
|
2845
|
+
_id?: string | null;
|
|
2846
|
+
/**
|
|
2847
|
+
* Line items.
|
|
2848
|
+
* @minSize 1
|
|
2849
|
+
* @maxSize 300
|
|
2850
|
+
* @readonly
|
|
2851
|
+
*/
|
|
2852
|
+
lineItems?: LineItem[];
|
|
2853
|
+
/**
|
|
2854
|
+
* [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
|
|
2855
|
+
* @maxLength 1000
|
|
2856
|
+
*/
|
|
2857
|
+
buyerNote?: string | null;
|
|
2858
|
+
/** Buyer information. */
|
|
2859
|
+
buyerInfo?: BuyerInfo;
|
|
2860
|
+
/**
|
|
2861
|
+
* Currency used for pricing.
|
|
2862
|
+
* @format CURRENCY
|
|
2863
|
+
* @readonly
|
|
2864
|
+
*/
|
|
2865
|
+
currency?: string;
|
|
2866
|
+
/**
|
|
2867
|
+
* Currency code used for all the converted prices that are returned.
|
|
2868
|
+
* For a site that supports multiple currencies, this is the currency the buyer selected.
|
|
2869
|
+
* @readonly
|
|
2870
|
+
* @format CURRENCY
|
|
2871
|
+
*/
|
|
2872
|
+
conversionCurrency?: string;
|
|
2873
|
+
/**
|
|
2874
|
+
* Language for communication with the buyer. Defaults to the site language.
|
|
2875
|
+
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
2876
|
+
* @readonly
|
|
2877
|
+
*/
|
|
2878
|
+
buyerLanguage?: string | null;
|
|
2879
|
+
/**
|
|
2880
|
+
* Site language in which original values are displayed.
|
|
2881
|
+
* @readonly
|
|
2882
|
+
*/
|
|
2883
|
+
siteLanguage?: string | null;
|
|
2884
|
+
/**
|
|
2885
|
+
* Whether tax is included in line item prices.
|
|
2886
|
+
* @readonly
|
|
2887
|
+
*/
|
|
2888
|
+
taxIncludedInPrices?: boolean | null;
|
|
2889
|
+
/**
|
|
2890
|
+
* Weight measurement unit - defaults to site's weight unit.
|
|
2891
|
+
* @readonly
|
|
2892
|
+
*/
|
|
2893
|
+
weightUnit?: WeightUnit;
|
|
2894
|
+
/**
|
|
2895
|
+
* ID of the checkout that originated from this cart.
|
|
2896
|
+
* @readonly
|
|
2897
|
+
* @format GUID
|
|
2898
|
+
*/
|
|
2899
|
+
checkoutId?: string | null;
|
|
2900
|
+
/**
|
|
2901
|
+
* Cart discounts.
|
|
2902
|
+
* @readonly
|
|
2903
|
+
*/
|
|
2904
|
+
appliedDiscounts?: CartDiscount[];
|
|
2905
|
+
/**
|
|
2906
|
+
* Date and time the cart was created.
|
|
2907
|
+
* @readonly
|
|
2908
|
+
*/
|
|
2909
|
+
_createdDate?: Date | null;
|
|
2910
|
+
/**
|
|
2911
|
+
* Date and time the cart was updated.
|
|
2912
|
+
* @readonly
|
|
2913
|
+
*/
|
|
2914
|
+
_updatedDate?: Date | null;
|
|
2915
|
+
/** Contact info. */
|
|
2916
|
+
contactInfo?: AddressWithContact;
|
|
2917
|
+
/**
|
|
2918
|
+
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2919
|
+
*
|
|
2920
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
2921
|
+
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2922
|
+
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2923
|
+
* @maxLength 1000
|
|
2924
|
+
*/
|
|
2925
|
+
overrideCheckoutUrl?: string | null;
|
|
2926
|
+
/**
|
|
2927
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
2928
|
+
* @format GUID
|
|
2929
|
+
* @readonly
|
|
2930
|
+
*/
|
|
2931
|
+
purchaseFlowId?: string | null;
|
|
2932
|
+
/** Selected shipping option. */
|
|
2933
|
+
selectedShippingOption?: SelectedShippingOption;
|
|
2934
|
+
/**
|
|
2935
|
+
* The business location ID associated with the cart.
|
|
2936
|
+
*
|
|
2937
|
+
* To learn more, see the Locations API.
|
|
2938
|
+
* @format GUID
|
|
2939
|
+
*/
|
|
2940
|
+
businessLocationId?: string | null;
|
|
2941
|
+
};
|
|
2942
|
+
/** Coupon code. For more information, see the Coupons API. */
|
|
2943
|
+
couponCode?: string | null;
|
|
2944
|
+
/**
|
|
2945
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
|
|
2946
|
+
* @maxSize 100
|
|
2947
|
+
*/
|
|
2948
|
+
merchantDiscounts?: MerchantDiscountInput[];
|
|
2949
|
+
/**
|
|
2950
|
+
* Catalog line items.
|
|
2951
|
+
* @maxSize 300
|
|
2952
|
+
*/
|
|
2953
|
+
lineItems?: LineItem[];
|
|
2954
|
+
/**
|
|
2955
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2956
|
+
*
|
|
2957
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2958
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2959
|
+
* @maxSize 300
|
|
2960
|
+
*/
|
|
2961
|
+
customLineItems?: CustomLineItem[];
|
|
2962
|
+
}
|
|
2963
|
+
interface AddToCartOptions {
|
|
2964
|
+
/**
|
|
2965
|
+
* Catalog line items.
|
|
2966
|
+
* @maxSize 100
|
|
2967
|
+
*/
|
|
2968
|
+
lineItems?: LineItem[];
|
|
2969
|
+
/**
|
|
2970
|
+
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2971
|
+
*
|
|
2972
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2973
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2974
|
+
* @maxSize 100
|
|
2975
|
+
*/
|
|
2976
|
+
customLineItems?: CustomLineItem[];
|
|
2977
|
+
/**
|
|
2978
|
+
* The business location ID associated with the cart.
|
|
2979
|
+
*
|
|
2980
|
+
* 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.
|
|
2981
|
+
* To learn more, see the Locations API.
|
|
2982
|
+
* @format GUID
|
|
2983
|
+
*/
|
|
2984
|
+
businessLocationId?: string | null;
|
|
2985
|
+
}
|
|
2986
|
+
interface CreateCheckoutOptions {
|
|
2987
|
+
/** __Required.__ Sales channel type. */
|
|
2988
|
+
channelType?: ChannelType;
|
|
2989
|
+
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
2990
|
+
shippingAddress?: Address;
|
|
2991
|
+
/** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
|
|
2992
|
+
billingAddress?: Address;
|
|
2993
|
+
/** Selected shipping option. */
|
|
2994
|
+
selectedShippingOption?: SelectedShippingOption;
|
|
2995
|
+
/**
|
|
2996
|
+
* Required when setting a billing or shipping address if the site visitor isn't logged in.
|
|
2997
|
+
* @format EMAIL
|
|
2998
|
+
*/
|
|
2999
|
+
email?: string | null;
|
|
3000
|
+
}
|
|
3001
|
+
interface EstimateTotalsOptions {
|
|
3002
|
+
/** Selected shipping option. */
|
|
3003
|
+
selectedShippingOption?: SelectedShippingOption;
|
|
3004
|
+
/** Shipping address. Used for calculating tax and shipping (when applicable). */
|
|
3005
|
+
shippingAddress?: Address;
|
|
3006
|
+
/** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
|
|
3007
|
+
billingAddress?: Address;
|
|
3008
|
+
/** The selected membership payment options and which line items they apply to. */
|
|
3009
|
+
selectedMemberships?: SelectedMemberships;
|
|
3010
|
+
/**
|
|
3011
|
+
* Whether to calculate tax in the calculation request.
|
|
3012
|
+
*
|
|
3013
|
+
* Default: `true`
|
|
3014
|
+
*/
|
|
3015
|
+
calculateTax?: boolean | null;
|
|
3016
|
+
/**
|
|
3017
|
+
* Whether to calculate shipping in the calculation request.
|
|
3018
|
+
*
|
|
3019
|
+
* Default: `true`
|
|
3020
|
+
*/
|
|
3021
|
+
calculateShipping?: boolean | null;
|
|
3022
|
+
}
|
|
3023
|
+
|
|
3024
|
+
export { type Scope as $, type AddToCartOptions as A, type DescriptionLine as B, type CreateCartOptions as C, DescriptionLineType as D, type EstimateTotalsOptions as E, FileType as F, type GetCartByCheckoutIdResponse as G, type DescriptionLineValueOneOf as H, ItemAvailabilityStatus as I, JurisdictionType as J, type DescriptionLineDescriptionLineValueOneOf as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, type DescriptionLineName as O, PaymentOptionType as P, type PlainTextValue as Q, type RemoveLineItemsResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCartOptions as U, VatType as V, WeightUnit as W, type Color as X, type FocalPoint as Y, type ItemAvailabilityInfo as Z, type PhysicalProperties as _, type Cart as a, type PickupDetails as a$, type Group as a0, type ItemType as a1, type ItemTypeItemTypeDataOneOf as a2, type SubscriptionOptionInfo as a3, type SubscriptionSettings as a4, type FreeTrialPeriod as a5, type Title as a6, type Description as a7, type SecuredMedia as a8, type ServiceProperties as a9, type GetCurrentCartRequest as aA, type GetCurrentCartResponse as aB, type UpdateCartRequest as aC, type MerchantDiscountInput as aD, type CustomLineItem as aE, type UpdateCartResponse as aF, type AddToCurrentCartRequest as aG, type AddToCurrentCartAndEstimateTotalsRequest as aH, type SelectedMemberships as aI, type HostSelectedMembership as aJ, type CalculatedLineItem as aK, type LineItemPricesData as aL, type ItemTaxFullDetails as aM, type TaxRateBreakdown as aN, type TaxBreakdown as aO, type PriceSummary as aP, type GiftCard as aQ, type TaxSummary as aR, type TaxCalculationDetails as aS, type TaxCalculationDetailsCalculationDetailsOneOf as aT, type AutoTaxFallbackCalculationDetails as aU, type ApplicationError as aV, type AggregatedTaxBreakdown as aW, type ShippingInformation as aX, type ShippingRegion as aY, type SelectedCarrierServiceOption as aZ, type DeliveryLogistics as a_, type PriceDescription as aa, type SelectedMembership as ab, type CatalogOverrideFields as ac, type PaymentOption as ad, type TaxableAddress as ae, type TaxableAddressTaxableAddressDataOneOf as af, type ExtendedFields as ag, type Policy as ah, type ModifierGroup as ai, type TranslatableString as aj, type ItemModifier as ak, type BuyerInfo as al, type BuyerInfoIdOneOf as am, type CartDiscount as an, type CartDiscountDiscountSourceOneOf as ao, type Coupon as ap, type MerchantDiscount as aq, type DiscountRule as ar, type DiscountRuleName as as, type AddressWithContact as at, type Address as au, type StreetAddress as av, type AddressLocation as aw, type FullAddressContactDetails as ax, type VatId as ay, type SelectedShippingOption as az, type AddToCartResponse as b, type RemoveCouponRequest as b$, type DeliveryTimeSlot as b0, type SelectedCarrierServiceOptionPrices as b1, type SelectedCarrierServiceOptionOtherCharge as b2, type DeliveryAllocation as b3, type Carrier as b4, type Region as b5, type ApplicableLineItems as b6, type CarrierServiceOption as b7, type ShippingOption as b8, type ShippingPrice as b9, type Other as bA, type TargetLineItem as bB, type RemoveLineItemsFromCurrentCartRequest as bC, type CreateCheckoutFromCurrentCartRequest as bD, type RemoveCouponFromCurrentCartRequest as bE, type UpdateCurrentCartLineItemQuantityRequest as bF, type EstimateCurrentCartTotalsRequest as bG, type DeleteCurrentCartRequest as bH, type DeleteCartResponse as bI, type DomainEvent as bJ, type DomainEventBodyOneOf as bK, type EntityCreatedEvent as bL, type RestoreInfo as bM, type EntityUpdatedEvent as bN, type EntityDeletedEvent as bO, type ActionEvent as bP, type MessageEnvelope as bQ, type IdentificationData as bR, type IdentificationDataIdOneOf as bS, type CreateCartRequest as bT, type CreateCartResponse as bU, type GetCartRequest as bV, type GetCartResponse as bW, type GetCartByCheckoutIdRequest as bX, type AddToCartRequest as bY, type RemoveLineItemsRequest as bZ, type CreateCheckoutRequest as b_, type OtherCharge as ba, type AppliedDiscount as bb, type AppliedDiscountDiscountSourceOneOf as bc, type V1Coupon as bd, type V1MerchantDiscount as be, type V1DiscountRule as bf, type V1DiscountRuleName as bg, type LineItemDiscount as bh, type CalculationErrors as bi, type CalculationErrorsShippingCalculationErrorOneOf as bj, type Details as bk, type DetailsKindOneOf as bl, type ValidationError as bm, type FieldViolation as bn, type SystemError as bo, type CarrierErrors as bp, type CarrierError as bq, type MembershipOptions as br, type Membership as bs, type MembershipName as bt, type MembershipPaymentCredits as bu, type InvalidMembership as bv, type AdditionalFee as bw, type Violation as bx, type Target as by, type TargetTargetTypeOneOf 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 };
|