@wix/auto_sdk_ecom_cart 1.0.3 → 1.0.4
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.http.d.ts +7 -12
- package/build/cjs/src/ecom-v1-cart-cart.http.js +13 -12
- package/build/cjs/src/ecom-v1-cart-cart.http.js.map +1 -1
- package/build/cjs/src/ecom-v1-cart-cart.public.d.ts +7 -12
- package/build/cjs/src/ecom-v1-cart-cart.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-cart-cart.types.d.ts +652 -144
- package/build/cjs/src/ecom-v1-cart-cart.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-cart-cart.universal.d.ts +753 -168
- package/build/cjs/src/ecom-v1-cart-cart.universal.js +32 -15
- package/build/cjs/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/build/es/src/ecom-v1-cart-cart.http.d.ts +7 -12
- package/build/es/src/ecom-v1-cart-cart.http.js +13 -12
- package/build/es/src/ecom-v1-cart-cart.http.js.map +1 -1
- package/build/es/src/ecom-v1-cart-cart.public.d.ts +7 -12
- package/build/es/src/ecom-v1-cart-cart.public.js.map +1 -1
- package/build/es/src/ecom-v1-cart-cart.types.d.ts +652 -144
- package/build/es/src/ecom-v1-cart-cart.types.js.map +1 -1
- package/build/es/src/ecom-v1-cart-cart.universal.d.ts +753 -168
- package/build/es/src/ecom-v1-cart-cart.universal.js +32 -15
- package/build/es/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.http.d.ts +7 -12
- package/build/internal/cjs/src/ecom-v1-cart-cart.http.js +13 -12
- package/build/internal/cjs/src/ecom-v1-cart-cart.http.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.public.d.ts +7 -12
- package/build/internal/cjs/src/ecom-v1-cart-cart.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.types.d.ts +652 -144
- package/build/internal/cjs/src/ecom-v1-cart-cart.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.d.ts +760 -173
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js +32 -15
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-cart-cart.http.d.ts +7 -12
- package/build/internal/es/src/ecom-v1-cart-cart.http.js +13 -12
- package/build/internal/es/src/ecom-v1-cart-cart.http.js.map +1 -1
- package/build/internal/es/src/ecom-v1-cart-cart.public.d.ts +7 -12
- package/build/internal/es/src/ecom-v1-cart-cart.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-cart-cart.types.d.ts +652 -144
- package/build/internal/es/src/ecom-v1-cart-cart.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-cart-cart.universal.d.ts +760 -173
- package/build/internal/es/src/ecom-v1-cart-cart.universal.js +32 -15
- package/build/internal/es/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,17 +1,26 @@
|
|
|
1
1
|
export interface Cart {
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* Cart ID.
|
|
4
|
+
* @format GUID
|
|
5
|
+
*/
|
|
3
6
|
_id?: string | null;
|
|
4
7
|
/**
|
|
5
8
|
* Line items.
|
|
9
|
+
* @minSize 1
|
|
10
|
+
* @maxSize 300
|
|
6
11
|
* @readonly
|
|
7
12
|
*/
|
|
8
13
|
lineItems?: LineItem[];
|
|
9
|
-
/**
|
|
14
|
+
/**
|
|
15
|
+
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
16
|
+
* @maxLength 1000
|
|
17
|
+
*/
|
|
10
18
|
buyerNote?: string | null;
|
|
11
19
|
/** Buyer information. */
|
|
12
20
|
buyerInfo?: BuyerInfo;
|
|
13
21
|
/**
|
|
14
22
|
* Currency used for pricing.
|
|
23
|
+
* @format CURRENCY
|
|
15
24
|
* @readonly
|
|
16
25
|
*/
|
|
17
26
|
currency?: string;
|
|
@@ -19,6 +28,7 @@ export interface Cart {
|
|
|
19
28
|
* Currency code used for all the converted prices that are returned.
|
|
20
29
|
* For a site that supports multiple currencies, this is the currency the buyer selected.
|
|
21
30
|
* @readonly
|
|
31
|
+
* @format CURRENCY
|
|
22
32
|
*/
|
|
23
33
|
conversionCurrency?: string;
|
|
24
34
|
/**
|
|
@@ -45,6 +55,7 @@ export interface Cart {
|
|
|
45
55
|
/**
|
|
46
56
|
* ID of the checkout that originated from this cart.
|
|
47
57
|
* @readonly
|
|
58
|
+
* @format GUID
|
|
48
59
|
*/
|
|
49
60
|
checkoutId?: string | null;
|
|
50
61
|
/**
|
|
@@ -68,10 +79,12 @@ export interface Cart {
|
|
|
68
79
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
69
80
|
*
|
|
70
81
|
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
82
|
+
* @maxLength 1000
|
|
71
83
|
*/
|
|
72
84
|
overrideCheckoutUrl?: string | null;
|
|
73
85
|
/**
|
|
74
86
|
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
87
|
+
* @format GUID
|
|
75
88
|
* @readonly
|
|
76
89
|
*/
|
|
77
90
|
purchaseFlowId?: string | null;
|
|
@@ -80,16 +93,22 @@ export interface Cart {
|
|
|
80
93
|
/**
|
|
81
94
|
* The business location ID associated with the cart.
|
|
82
95
|
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
96
|
+
* @format GUID
|
|
83
97
|
*/
|
|
84
98
|
businessLocationId?: string | null;
|
|
85
99
|
}
|
|
86
100
|
export interface LineItem {
|
|
87
101
|
/**
|
|
88
102
|
* Line item ID.
|
|
103
|
+
* @format GUID
|
|
89
104
|
* @readonly
|
|
90
105
|
*/
|
|
91
106
|
_id?: string | null;
|
|
92
|
-
/**
|
|
107
|
+
/**
|
|
108
|
+
* Item quantity.
|
|
109
|
+
* @min 1
|
|
110
|
+
* @max 100000
|
|
111
|
+
*/
|
|
93
112
|
quantity?: number;
|
|
94
113
|
/** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
|
|
95
114
|
catalogReference?: CatalogReference;
|
|
@@ -164,6 +183,8 @@ export interface LineItem {
|
|
|
164
183
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
165
184
|
* + in most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
166
185
|
* + Used in membership validation.
|
|
186
|
+
* @minLength 1
|
|
187
|
+
* @maxLength 36
|
|
167
188
|
* @readonly
|
|
168
189
|
*/
|
|
169
190
|
rootCatalogItemId?: string | null;
|
|
@@ -179,8 +200,15 @@ export interface LineItem {
|
|
|
179
200
|
depositAmount?: MultiCurrencyPrice;
|
|
180
201
|
/** Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`. */
|
|
181
202
|
selectedMembership?: SelectedMembership;
|
|
203
|
+
/**
|
|
204
|
+
* Delivery profile ID.
|
|
205
|
+
* @format GUID
|
|
206
|
+
* @readonly
|
|
207
|
+
*/
|
|
208
|
+
deliveryProfileId?: string | null;
|
|
182
209
|
/**
|
|
183
210
|
* Tax group ID for this line item.
|
|
211
|
+
* @format GUID
|
|
184
212
|
* @readonly
|
|
185
213
|
*/
|
|
186
214
|
taxGroupId?: string | null;
|
|
@@ -191,6 +219,8 @@ export interface LineItem {
|
|
|
191
219
|
customLineItem?: boolean;
|
|
192
220
|
/**
|
|
193
221
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
222
|
+
* @minLength 1
|
|
223
|
+
* @maxLength 2500
|
|
194
224
|
* @readonly
|
|
195
225
|
*/
|
|
196
226
|
consentRequiredPaymentPolicy?: string | null;
|
|
@@ -211,7 +241,11 @@ export interface LineItem {
|
|
|
211
241
|
}
|
|
212
242
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
213
243
|
export interface CatalogReference {
|
|
214
|
-
/**
|
|
244
|
+
/**
|
|
245
|
+
* ID of the item within the catalog it belongs to.
|
|
246
|
+
* @minLength 1
|
|
247
|
+
* @maxLength 36
|
|
248
|
+
*/
|
|
215
249
|
catalogItemId?: string;
|
|
216
250
|
/**
|
|
217
251
|
* ID of the app providing the catalog.
|
|
@@ -222,6 +256,7 @@ export interface CatalogReference {
|
|
|
222
256
|
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
223
257
|
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
224
258
|
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
259
|
+
* @minLength 1
|
|
225
260
|
*/
|
|
226
261
|
appId?: string;
|
|
227
262
|
/**
|
|
@@ -234,17 +269,29 @@ export interface CatalogReference {
|
|
|
234
269
|
options?: Record<string, any> | null;
|
|
235
270
|
}
|
|
236
271
|
export interface ProductName {
|
|
237
|
-
/**
|
|
272
|
+
/**
|
|
273
|
+
* **Required** - Original product name (in site's default language).
|
|
274
|
+
* @minLength 1
|
|
275
|
+
* @maxLength 200
|
|
276
|
+
*/
|
|
238
277
|
original?: string;
|
|
239
|
-
/**
|
|
278
|
+
/**
|
|
279
|
+
* Description product name translated into buyer's language. Defaults to `original` when not defined.
|
|
280
|
+
* @minLength 1
|
|
281
|
+
* @maxLength 400
|
|
282
|
+
*/
|
|
240
283
|
translated?: string | null;
|
|
241
284
|
}
|
|
242
285
|
export interface MultiCurrencyPrice {
|
|
243
|
-
/**
|
|
286
|
+
/**
|
|
287
|
+
* Amount.
|
|
288
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
289
|
+
*/
|
|
244
290
|
amount?: string;
|
|
245
291
|
/**
|
|
246
292
|
* Converted amount.
|
|
247
293
|
* @readonly
|
|
294
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
248
295
|
*/
|
|
249
296
|
convertedAmount?: string;
|
|
250
297
|
/**
|
|
@@ -277,21 +324,39 @@ export interface DescriptionLineValueOneOf {
|
|
|
277
324
|
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
278
325
|
}
|
|
279
326
|
export interface DescriptionLineName {
|
|
280
|
-
/**
|
|
327
|
+
/**
|
|
328
|
+
* Description line name in site's default language.
|
|
329
|
+
* @maxLength 100
|
|
330
|
+
*/
|
|
281
331
|
original?: string;
|
|
282
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* Description line name translated into buyer's language. Defaults to `original` when not defined.
|
|
334
|
+
* @maxLength 200
|
|
335
|
+
*/
|
|
283
336
|
translated?: string | null;
|
|
284
337
|
}
|
|
285
338
|
export interface PlainTextValue {
|
|
286
|
-
/**
|
|
339
|
+
/**
|
|
340
|
+
* Description line plain text value in site's default language.
|
|
341
|
+
* @maxLength 600
|
|
342
|
+
*/
|
|
287
343
|
original?: string;
|
|
288
|
-
/**
|
|
344
|
+
/**
|
|
345
|
+
* Description line plain text value translated into buyer's language. Defaults to `original` when not defined.
|
|
346
|
+
* @maxLength 600
|
|
347
|
+
*/
|
|
289
348
|
translated?: string | null;
|
|
290
349
|
}
|
|
291
350
|
export interface Color {
|
|
292
|
-
/**
|
|
351
|
+
/**
|
|
352
|
+
* Description line color name in site's default language.
|
|
353
|
+
* @maxLength 500
|
|
354
|
+
*/
|
|
293
355
|
original?: string;
|
|
294
|
-
/**
|
|
356
|
+
/**
|
|
357
|
+
* Description line color name translated into buyer's language. Defaults to `original` when not defined.
|
|
358
|
+
* @maxLength 500
|
|
359
|
+
*/
|
|
295
360
|
translated?: string | null;
|
|
296
361
|
/**
|
|
297
362
|
* HEX or RGB color code for display.
|
|
@@ -341,7 +406,10 @@ export declare enum ItemAvailabilityStatus {
|
|
|
341
406
|
export interface PhysicalProperties {
|
|
342
407
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
343
408
|
weight?: number | null;
|
|
344
|
-
/**
|
|
409
|
+
/**
|
|
410
|
+
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
411
|
+
* @maxLength 40
|
|
412
|
+
*/
|
|
345
413
|
sku?: string | null;
|
|
346
414
|
/** Whether this line item is shippable. */
|
|
347
415
|
shippable?: boolean;
|
|
@@ -394,11 +462,16 @@ export interface SubscriptionSettings {
|
|
|
394
462
|
*
|
|
395
463
|
* Default: `1`.
|
|
396
464
|
* If SubscriptionFrequency is Day the minimum interval is 7
|
|
465
|
+
* @min 1
|
|
466
|
+
* @max 50
|
|
397
467
|
*/
|
|
398
468
|
interval?: number | null;
|
|
399
469
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
400
470
|
autoRenewal?: boolean;
|
|
401
|
-
/**
|
|
471
|
+
/**
|
|
472
|
+
* Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
|
|
473
|
+
* @min 1
|
|
474
|
+
*/
|
|
402
475
|
billingCycles?: number | null;
|
|
403
476
|
}
|
|
404
477
|
/** Frequency unit of recurring payment */
|
|
@@ -412,29 +485,53 @@ export declare enum SubscriptionFrequency {
|
|
|
412
485
|
export interface FreeTrialPeriod {
|
|
413
486
|
/** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
|
|
414
487
|
frequency?: SubscriptionFrequency;
|
|
415
|
-
/**
|
|
488
|
+
/**
|
|
489
|
+
* interval of period
|
|
490
|
+
* @min 1
|
|
491
|
+
* @max 50
|
|
492
|
+
*/
|
|
416
493
|
interval?: number;
|
|
417
494
|
}
|
|
418
495
|
export interface Title {
|
|
419
|
-
/**
|
|
496
|
+
/**
|
|
497
|
+
* 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).
|
|
498
|
+
* @minLength 1
|
|
499
|
+
* @maxLength 150
|
|
500
|
+
*/
|
|
420
501
|
original?: string;
|
|
421
502
|
/**
|
|
422
503
|
* Subscription option name translated into the buyer's language.
|
|
423
504
|
*
|
|
424
505
|
* Default: Same as `original`.
|
|
506
|
+
* @minLength 1
|
|
507
|
+
* @maxLength 150
|
|
425
508
|
*/
|
|
426
509
|
translated?: string | null;
|
|
427
510
|
}
|
|
428
511
|
export interface Description {
|
|
429
|
-
/**
|
|
512
|
+
/**
|
|
513
|
+
* Subscription option description.
|
|
514
|
+
* @maxLength 500
|
|
515
|
+
*/
|
|
430
516
|
original?: string;
|
|
431
|
-
/**
|
|
517
|
+
/**
|
|
518
|
+
* Translated subscription option description.
|
|
519
|
+
* @maxLength 500
|
|
520
|
+
*/
|
|
432
521
|
translated?: string | null;
|
|
433
522
|
}
|
|
434
523
|
export interface SecuredMedia {
|
|
435
|
-
/**
|
|
524
|
+
/**
|
|
525
|
+
* Media ID in Wix Media Manager.
|
|
526
|
+
* @minLength 1
|
|
527
|
+
* @maxLength 100
|
|
528
|
+
*/
|
|
436
529
|
_id?: string;
|
|
437
|
-
/**
|
|
530
|
+
/**
|
|
531
|
+
* Original filename.
|
|
532
|
+
* @minLength 1
|
|
533
|
+
* @maxLength 1000
|
|
534
|
+
*/
|
|
438
535
|
fileName?: string;
|
|
439
536
|
/** File type. */
|
|
440
537
|
fileType?: FileType;
|
|
@@ -463,33 +560,59 @@ export declare enum PaymentOptionType {
|
|
|
463
560
|
export interface ServiceProperties {
|
|
464
561
|
/** The date and time for which the service is supposed to be provided. For example, the time of the class. */
|
|
465
562
|
scheduledDate?: Date | null;
|
|
466
|
-
/**
|
|
563
|
+
/**
|
|
564
|
+
* The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room.
|
|
565
|
+
* @min 1
|
|
566
|
+
* @max 10000
|
|
567
|
+
*/
|
|
467
568
|
numberOfParticipants?: number | null;
|
|
468
569
|
}
|
|
469
570
|
export interface PriceDescription {
|
|
470
571
|
/**
|
|
471
572
|
* **Required** - Original price description (in site's default language).
|
|
472
573
|
*
|
|
574
|
+
* @minLength 1
|
|
575
|
+
* @maxLength 100
|
|
473
576
|
*/
|
|
474
577
|
original?: string;
|
|
475
|
-
/**
|
|
578
|
+
/**
|
|
579
|
+
* Product name translated into buyer's language. Defaults to `original` when not defined.
|
|
580
|
+
* @minLength 1
|
|
581
|
+
* @maxLength 100
|
|
582
|
+
*/
|
|
476
583
|
translated?: string | null;
|
|
477
584
|
}
|
|
478
585
|
/** Selected Membership */
|
|
479
586
|
export interface SelectedMembership {
|
|
480
|
-
/**
|
|
587
|
+
/**
|
|
588
|
+
* Membership ID.
|
|
589
|
+
* @minLength 1
|
|
590
|
+
* @maxLength 100
|
|
591
|
+
*/
|
|
481
592
|
_id?: string;
|
|
482
|
-
/**
|
|
593
|
+
/**
|
|
594
|
+
* ID of the app providing this payment option.
|
|
595
|
+
* @format GUID
|
|
596
|
+
*/
|
|
483
597
|
appId?: string;
|
|
484
598
|
}
|
|
485
599
|
export interface CatalogOverrideFields {
|
|
486
600
|
/** Item name. */
|
|
487
601
|
productName?: ProductName;
|
|
488
|
-
/**
|
|
602
|
+
/**
|
|
603
|
+
* Item price **after** discounts.
|
|
604
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
605
|
+
*/
|
|
489
606
|
price?: string | null;
|
|
490
|
-
/**
|
|
607
|
+
/**
|
|
608
|
+
* Item price **before** discounts.
|
|
609
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
610
|
+
*/
|
|
491
611
|
fullPrice?: string | null;
|
|
492
|
-
/**
|
|
612
|
+
/**
|
|
613
|
+
* Item description lines. Used when displaying the line item to customers.
|
|
614
|
+
* @maxSize 20
|
|
615
|
+
*/
|
|
493
616
|
descriptionLines?: DescriptionLine[];
|
|
494
617
|
/** Physical properties of the item. */
|
|
495
618
|
physicalProperties?: PhysicalProperties;
|
|
@@ -497,7 +620,11 @@ export interface CatalogOverrideFields {
|
|
|
497
620
|
image?: string;
|
|
498
621
|
/** Payment method selected for the item. */
|
|
499
622
|
paymentOption?: PaymentOption;
|
|
500
|
-
/**
|
|
623
|
+
/**
|
|
624
|
+
* Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
|
|
625
|
+
* @format DECIMAL_VALUE
|
|
626
|
+
* @decimalValue options { gt:0, lte:999999999, maxScale:3 }
|
|
627
|
+
*/
|
|
501
628
|
depositAmount?: string | null;
|
|
502
629
|
/**
|
|
503
630
|
* Whether to save the payment method on the order.
|
|
@@ -508,11 +635,9 @@ export interface CatalogOverrideFields {
|
|
|
508
635
|
}
|
|
509
636
|
export interface PaymentOption {
|
|
510
637
|
/**
|
|
511
|
-
*
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
-
* + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
|
|
515
|
-
* + `MEMBERSHIP_OFFLINE`: 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`.
|
|
638
|
+
* Type of selected payment option for current item.
|
|
639
|
+
*
|
|
640
|
+
* Default: `FULL_PAYMENT_ONLINE`
|
|
516
641
|
*/
|
|
517
642
|
value?: PaymentOptionType;
|
|
518
643
|
}
|
|
@@ -543,47 +668,67 @@ export interface ExtendedFields {
|
|
|
543
668
|
namespaces?: Record<string, Record<string, any>>;
|
|
544
669
|
}
|
|
545
670
|
export interface Policy {
|
|
546
|
-
/**
|
|
671
|
+
/**
|
|
672
|
+
* Policy title - should be translated
|
|
673
|
+
* @minLength 1
|
|
674
|
+
* @maxLength 29
|
|
675
|
+
*/
|
|
547
676
|
title?: string | null;
|
|
548
|
-
/**
|
|
677
|
+
/**
|
|
678
|
+
* Policy content - should be translated
|
|
679
|
+
* @minLength 1
|
|
680
|
+
* @maxLength 3000
|
|
681
|
+
*/
|
|
549
682
|
content?: string;
|
|
550
683
|
}
|
|
551
684
|
/** Buyer Info */
|
|
552
685
|
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
553
686
|
/**
|
|
554
687
|
* Visitor ID - if the buyer is **not** a site member.
|
|
688
|
+
* @format GUID
|
|
555
689
|
* @readonly
|
|
556
690
|
*/
|
|
557
691
|
visitorId?: string;
|
|
558
692
|
/**
|
|
559
693
|
* Member ID - if the buyer is a site member.
|
|
694
|
+
* @format GUID
|
|
560
695
|
* @readonly
|
|
561
696
|
*/
|
|
562
697
|
memberId?: string;
|
|
563
698
|
/**
|
|
564
699
|
* User ID - if the cart owner is a Wix user.
|
|
700
|
+
* @format GUID
|
|
565
701
|
* @readonly
|
|
566
702
|
*/
|
|
567
703
|
userId?: string;
|
|
568
|
-
/**
|
|
704
|
+
/**
|
|
705
|
+
* Contact ID. For more information, see the Contacts API.
|
|
706
|
+
* @format GUID
|
|
707
|
+
*/
|
|
569
708
|
contactId?: string | null;
|
|
570
|
-
/**
|
|
709
|
+
/**
|
|
710
|
+
* Buyer email address.
|
|
711
|
+
* @format EMAIL
|
|
712
|
+
*/
|
|
571
713
|
email?: string | null;
|
|
572
714
|
}
|
|
573
715
|
/** @oneof */
|
|
574
716
|
export interface BuyerInfoIdOneOf {
|
|
575
717
|
/**
|
|
576
718
|
* Visitor ID - if the buyer is **not** a site member.
|
|
719
|
+
* @format GUID
|
|
577
720
|
* @readonly
|
|
578
721
|
*/
|
|
579
722
|
visitorId?: string;
|
|
580
723
|
/**
|
|
581
724
|
* Member ID - if the buyer is a site member.
|
|
725
|
+
* @format GUID
|
|
582
726
|
* @readonly
|
|
583
727
|
*/
|
|
584
728
|
memberId?: string;
|
|
585
729
|
/**
|
|
586
730
|
* User ID - if the cart owner is a Wix user.
|
|
731
|
+
* @format GUID
|
|
587
732
|
* @readonly
|
|
588
733
|
*/
|
|
589
734
|
userId?: string;
|
|
@@ -620,7 +765,10 @@ export interface MerchantDiscount {
|
|
|
620
765
|
amount?: MultiCurrencyPrice;
|
|
621
766
|
}
|
|
622
767
|
export interface DiscountRule {
|
|
623
|
-
/**
|
|
768
|
+
/**
|
|
769
|
+
* Discount rule ID
|
|
770
|
+
* @format GUID
|
|
771
|
+
*/
|
|
624
772
|
_id?: string;
|
|
625
773
|
/** Discount rule name */
|
|
626
774
|
name?: DiscountRuleName;
|
|
@@ -628,9 +776,17 @@ export interface DiscountRule {
|
|
|
628
776
|
amount?: MultiCurrencyPrice;
|
|
629
777
|
}
|
|
630
778
|
export interface DiscountRuleName {
|
|
631
|
-
/**
|
|
779
|
+
/**
|
|
780
|
+
* Original discount rule name (in site's default language).
|
|
781
|
+
* @minLength 1
|
|
782
|
+
* @maxLength 256
|
|
783
|
+
*/
|
|
632
784
|
original?: string;
|
|
633
|
-
/**
|
|
785
|
+
/**
|
|
786
|
+
* Discount rule name translated into buyer's language. Defaults to `original` when not defined.
|
|
787
|
+
* @minLength 1
|
|
788
|
+
* @maxLength 500
|
|
789
|
+
*/
|
|
634
790
|
translated?: string | null;
|
|
635
791
|
}
|
|
636
792
|
export declare enum DiscountType {
|
|
@@ -650,19 +806,37 @@ export interface AddressWithContact {
|
|
|
650
806
|
}
|
|
651
807
|
/** Physical address */
|
|
652
808
|
export interface Address {
|
|
653
|
-
/**
|
|
809
|
+
/**
|
|
810
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
811
|
+
* @format COUNTRY
|
|
812
|
+
*/
|
|
654
813
|
country?: string | null;
|
|
655
|
-
/**
|
|
814
|
+
/**
|
|
815
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
816
|
+
* @maxLength 50
|
|
817
|
+
*/
|
|
656
818
|
subdivision?: string | null;
|
|
657
|
-
/**
|
|
819
|
+
/**
|
|
820
|
+
* City name.
|
|
821
|
+
* @maxLength 50
|
|
822
|
+
*/
|
|
658
823
|
city?: string | null;
|
|
659
|
-
/**
|
|
824
|
+
/**
|
|
825
|
+
* Postal or zip code.
|
|
826
|
+
* @maxLength 50
|
|
827
|
+
*/
|
|
660
828
|
postalCode?: string | null;
|
|
661
829
|
/** Street address. */
|
|
662
830
|
streetAddress?: StreetAddress;
|
|
663
|
-
/**
|
|
831
|
+
/**
|
|
832
|
+
* Main address line (usually street name and number).
|
|
833
|
+
* @maxLength 150
|
|
834
|
+
*/
|
|
664
835
|
addressLine1?: string | null;
|
|
665
|
-
/**
|
|
836
|
+
/**
|
|
837
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
838
|
+
* @maxLength 100
|
|
839
|
+
*/
|
|
666
840
|
addressLine2?: string | null;
|
|
667
841
|
/**
|
|
668
842
|
* Country's full name.
|
|
@@ -689,13 +863,25 @@ export interface AddressLocation {
|
|
|
689
863
|
}
|
|
690
864
|
/** Full contact details for an address */
|
|
691
865
|
export interface FullAddressContactDetails {
|
|
692
|
-
/**
|
|
866
|
+
/**
|
|
867
|
+
* First name.
|
|
868
|
+
* @maxLength 100
|
|
869
|
+
*/
|
|
693
870
|
firstName?: string | null;
|
|
694
|
-
/**
|
|
871
|
+
/**
|
|
872
|
+
* Last name.
|
|
873
|
+
* @maxLength 100
|
|
874
|
+
*/
|
|
695
875
|
lastName?: string | null;
|
|
696
|
-
/**
|
|
876
|
+
/**
|
|
877
|
+
* Phone number.
|
|
878
|
+
* @format PHONE
|
|
879
|
+
*/
|
|
697
880
|
phone?: string | null;
|
|
698
|
-
/**
|
|
881
|
+
/**
|
|
882
|
+
* Company name.
|
|
883
|
+
* @maxLength 1000
|
|
884
|
+
*/
|
|
699
885
|
company?: string | null;
|
|
700
886
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
701
887
|
vatId?: VatId;
|
|
@@ -721,9 +907,16 @@ export declare enum VatType {
|
|
|
721
907
|
CNPJ = "CNPJ"
|
|
722
908
|
}
|
|
723
909
|
export interface SelectedShippingOption {
|
|
724
|
-
/**
|
|
910
|
+
/**
|
|
911
|
+
* Carrier ID.
|
|
912
|
+
* @format GUID
|
|
913
|
+
*/
|
|
725
914
|
carrierId?: string | null;
|
|
726
|
-
/**
|
|
915
|
+
/**
|
|
916
|
+
* Selected shipping option code. For example, "usps_std_overnight".
|
|
917
|
+
* @minLength 1
|
|
918
|
+
* @maxLength 100
|
|
919
|
+
*/
|
|
727
920
|
code?: string;
|
|
728
921
|
}
|
|
729
922
|
export interface GetCurrentCartRequest {
|
|
@@ -737,22 +930,36 @@ export interface UpdateCartRequest {
|
|
|
737
930
|
cartInfo?: Cart;
|
|
738
931
|
/** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
739
932
|
couponCode?: string | null;
|
|
740
|
-
/**
|
|
933
|
+
/**
|
|
934
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
|
|
935
|
+
* @maxSize 100
|
|
936
|
+
*/
|
|
741
937
|
merchantDiscounts?: MerchantDiscountInput[];
|
|
742
|
-
/**
|
|
938
|
+
/**
|
|
939
|
+
* Catalog line items.
|
|
940
|
+
* @maxSize 300
|
|
941
|
+
*/
|
|
743
942
|
lineItems?: LineItem[];
|
|
744
943
|
/**
|
|
745
944
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
746
945
|
*
|
|
747
946
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
748
947
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
948
|
+
* @maxSize 300
|
|
749
949
|
*/
|
|
750
950
|
customLineItems?: CustomLineItem[];
|
|
751
951
|
}
|
|
752
952
|
export interface MerchantDiscountInput {
|
|
753
|
-
/**
|
|
953
|
+
/**
|
|
954
|
+
* Discount amount.
|
|
955
|
+
* @decimalValue options { gte:0 }
|
|
956
|
+
*/
|
|
754
957
|
amount?: string;
|
|
755
|
-
/**
|
|
958
|
+
/**
|
|
959
|
+
* IDs of the line items the discount applies to.
|
|
960
|
+
* @format GUID
|
|
961
|
+
* @maxSize 300
|
|
962
|
+
*/
|
|
756
963
|
lineItemIds?: string[];
|
|
757
964
|
}
|
|
758
965
|
export interface CustomLineItem {
|
|
@@ -761,17 +968,24 @@ export interface CustomLineItem {
|
|
|
761
968
|
*
|
|
762
969
|
* Min: `1`
|
|
763
970
|
* Max: `100000`
|
|
971
|
+
* @min 1
|
|
972
|
+
* @max 100000
|
|
764
973
|
*/
|
|
765
974
|
quantity?: number;
|
|
766
975
|
/**
|
|
767
976
|
* Custom line item price.
|
|
768
977
|
*
|
|
769
978
|
* Must be a number or a decimal without symbols.
|
|
979
|
+
* @format DECIMAL_VALUE
|
|
980
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
770
981
|
*/
|
|
771
982
|
price?: string;
|
|
772
983
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
773
984
|
priceDescription?: PriceDescription;
|
|
774
|
-
/**
|
|
985
|
+
/**
|
|
986
|
+
* Custom line item description lines. Used for displaying the cart, checkout and order.
|
|
987
|
+
* @maxSize 10
|
|
988
|
+
*/
|
|
775
989
|
descriptionLines?: DescriptionLine[];
|
|
776
990
|
/**
|
|
777
991
|
* Custom line item media. Supported formats:
|
|
@@ -783,9 +997,13 @@ export interface CustomLineItem {
|
|
|
783
997
|
* Custom line item ID. If passed, `id` must be unique.
|
|
784
998
|
*
|
|
785
999
|
* Default: auto-generated ID
|
|
1000
|
+
* @format GUID
|
|
786
1001
|
*/
|
|
787
1002
|
_id?: string | null;
|
|
788
|
-
/**
|
|
1003
|
+
/**
|
|
1004
|
+
* Tax group ID for this custom line item.
|
|
1005
|
+
* @format GUID
|
|
1006
|
+
*/
|
|
789
1007
|
taxGroupId?: string | null;
|
|
790
1008
|
/** Name of the item or product. */
|
|
791
1009
|
productName?: ProductName;
|
|
@@ -793,11 +1011,15 @@ export interface CustomLineItem {
|
|
|
793
1011
|
url?: string;
|
|
794
1012
|
/** Item type. Either a preset type or custom. */
|
|
795
1013
|
itemType?: ItemType;
|
|
796
|
-
/**
|
|
1014
|
+
/**
|
|
1015
|
+
* Item price **before** catalog-defined discount. Defaults to `price` when not provided.
|
|
1016
|
+
* @format DECIMAL_VALUE
|
|
1017
|
+
*/
|
|
797
1018
|
fullPrice?: string | null;
|
|
798
1019
|
/**
|
|
799
1020
|
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
800
1021
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
1022
|
+
* @max 100000
|
|
801
1023
|
*/
|
|
802
1024
|
quantityAvailable?: number | null;
|
|
803
1025
|
/** Physical properties of the item. */
|
|
@@ -822,6 +1044,8 @@ export interface CustomLineItem {
|
|
|
822
1044
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
823
1045
|
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
824
1046
|
* + Used in membership validation.
|
|
1047
|
+
* @minLength 1
|
|
1048
|
+
* @maxLength 36
|
|
825
1049
|
*/
|
|
826
1050
|
rootCatalogItemId?: string | null;
|
|
827
1051
|
/**
|
|
@@ -829,12 +1053,20 @@ export interface CustomLineItem {
|
|
|
829
1053
|
*
|
|
830
1054
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
831
1055
|
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
1056
|
+
* @format DECIMAL_VALUE
|
|
832
1057
|
*/
|
|
833
1058
|
depositAmount?: string | null;
|
|
1059
|
+
/**
|
|
1060
|
+
* Delivery profile ID.
|
|
1061
|
+
* @format GUID
|
|
1062
|
+
*/
|
|
1063
|
+
deliveryProfileId?: string | null;
|
|
834
1064
|
/** 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. */
|
|
835
1065
|
catalogReference?: CatalogReference;
|
|
836
1066
|
/**
|
|
837
1067
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
1068
|
+
* @minLength 1
|
|
1069
|
+
* @maxLength 1000
|
|
838
1070
|
* @readonly
|
|
839
1071
|
*/
|
|
840
1072
|
consentRequiredPaymentPolicy?: string | null;
|
|
@@ -851,19 +1083,24 @@ export interface UpdateCartResponse {
|
|
|
851
1083
|
cart?: Cart;
|
|
852
1084
|
}
|
|
853
1085
|
export interface AddToCurrentCartRequest {
|
|
854
|
-
/**
|
|
1086
|
+
/**
|
|
1087
|
+
* Catalog line items.
|
|
1088
|
+
* @maxSize 100
|
|
1089
|
+
*/
|
|
855
1090
|
lineItems?: LineItem[];
|
|
856
1091
|
/**
|
|
857
1092
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
858
1093
|
*
|
|
859
1094
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
860
1095
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
1096
|
+
* @maxSize 100
|
|
861
1097
|
*/
|
|
862
1098
|
customLineItems?: CustomLineItem[];
|
|
863
1099
|
/**
|
|
864
1100
|
* Business location ID.
|
|
865
1101
|
* To update a cart's business location ID, use the UpdateCart method.
|
|
866
1102
|
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1103
|
+
* @format GUID
|
|
867
1104
|
*/
|
|
868
1105
|
businessLocationId?: string | null;
|
|
869
1106
|
}
|
|
@@ -872,13 +1109,17 @@ export interface AddToCartResponse {
|
|
|
872
1109
|
cart?: Cart;
|
|
873
1110
|
}
|
|
874
1111
|
export interface AddToCurrentCartAndEstimateTotalsRequest {
|
|
875
|
-
/**
|
|
1112
|
+
/**
|
|
1113
|
+
* Catalog line items.
|
|
1114
|
+
* @maxSize 100
|
|
1115
|
+
*/
|
|
876
1116
|
lineItems?: LineItem[];
|
|
877
1117
|
/**
|
|
878
1118
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
879
1119
|
*
|
|
880
1120
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
881
1121
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
1122
|
+
* @maxSize 100
|
|
882
1123
|
*/
|
|
883
1124
|
customLineItems?: CustomLineItem[];
|
|
884
1125
|
/** Selected shipping option. */
|
|
@@ -903,15 +1144,31 @@ export interface AddToCurrentCartAndEstimateTotalsRequest {
|
|
|
903
1144
|
calculateShipping?: boolean | null;
|
|
904
1145
|
}
|
|
905
1146
|
export interface SelectedMemberships {
|
|
906
|
-
/**
|
|
1147
|
+
/**
|
|
1148
|
+
* Selected memberships.
|
|
1149
|
+
* @maxSize 300
|
|
1150
|
+
*/
|
|
907
1151
|
memberships?: HostSelectedMembership[];
|
|
908
1152
|
}
|
|
909
1153
|
export interface HostSelectedMembership {
|
|
910
|
-
/**
|
|
1154
|
+
/**
|
|
1155
|
+
* Membership ID.
|
|
1156
|
+
* @minLength 1
|
|
1157
|
+
* @maxLength 100
|
|
1158
|
+
*/
|
|
911
1159
|
_id?: string;
|
|
912
|
-
/**
|
|
1160
|
+
/**
|
|
1161
|
+
* ID of the app providing this payment option.
|
|
1162
|
+
* @format GUID
|
|
1163
|
+
*/
|
|
913
1164
|
appId?: string;
|
|
914
|
-
/**
|
|
1165
|
+
/**
|
|
1166
|
+
* IDs of the line items this membership applies to.
|
|
1167
|
+
* @minSize 1
|
|
1168
|
+
* @maxSize 300
|
|
1169
|
+
* @minLength 1
|
|
1170
|
+
* @maxLength 100
|
|
1171
|
+
*/
|
|
915
1172
|
lineItemIds?: string[];
|
|
916
1173
|
}
|
|
917
1174
|
export interface EstimateTotalsResponse {
|
|
@@ -933,7 +1190,10 @@ export interface EstimateTotalsResponse {
|
|
|
933
1190
|
calculationErrors?: CalculationErrors;
|
|
934
1191
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
935
1192
|
weightUnit?: WeightUnit;
|
|
936
|
-
/**
|
|
1193
|
+
/**
|
|
1194
|
+
* Currency used for pricing in this store.
|
|
1195
|
+
* @format CURRENCY
|
|
1196
|
+
*/
|
|
937
1197
|
currency?: string;
|
|
938
1198
|
/**
|
|
939
1199
|
* Minimal amount to pay in order to place the order.
|
|
@@ -947,7 +1207,10 @@ export interface EstimateTotalsResponse {
|
|
|
947
1207
|
payLater?: PriceSummary;
|
|
948
1208
|
/** Information about valid and invalid memberships, and which ones are selected for usage. */
|
|
949
1209
|
membershipOptions?: MembershipOptions;
|
|
950
|
-
/**
|
|
1210
|
+
/**
|
|
1211
|
+
* Additional fees
|
|
1212
|
+
* @maxSize 100
|
|
1213
|
+
*/
|
|
951
1214
|
additionalFees?: AdditionalFee[];
|
|
952
1215
|
/**
|
|
953
1216
|
* List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
|
|
@@ -989,7 +1252,10 @@ export interface LineItemPricesData {
|
|
|
989
1252
|
export interface ItemTaxFullDetails {
|
|
990
1253
|
/** Amount for which tax is calculated. */
|
|
991
1254
|
taxableAmount?: MultiCurrencyPrice;
|
|
992
|
-
/**
|
|
1255
|
+
/**
|
|
1256
|
+
* Tax rate %, as a decimal point between 0 and 1.
|
|
1257
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
1258
|
+
*/
|
|
993
1259
|
taxRate?: string;
|
|
994
1260
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
995
1261
|
totalTax?: MultiCurrencyPrice;
|
|
@@ -1001,9 +1267,15 @@ export interface ItemTaxFullDetails {
|
|
|
1001
1267
|
rateBreakdown?: TaxRateBreakdown[];
|
|
1002
1268
|
}
|
|
1003
1269
|
export interface TaxRateBreakdown {
|
|
1004
|
-
/**
|
|
1270
|
+
/**
|
|
1271
|
+
* Name of tax against which the calculation was performed.
|
|
1272
|
+
* @maxLength 100
|
|
1273
|
+
*/
|
|
1005
1274
|
name?: string;
|
|
1006
|
-
/**
|
|
1275
|
+
/**
|
|
1276
|
+
* Rate at which this tax detail was calculated.
|
|
1277
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
1278
|
+
*/
|
|
1007
1279
|
rate?: string;
|
|
1008
1280
|
/** Amount of tax for this tax detail. */
|
|
1009
1281
|
tax?: MultiCurrencyPrice;
|
|
@@ -1013,21 +1285,31 @@ export interface TaxRateBreakdown {
|
|
|
1013
1285
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
1014
1286
|
*/
|
|
1015
1287
|
export interface TaxBreakdown {
|
|
1016
|
-
/**
|
|
1288
|
+
/**
|
|
1289
|
+
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
1290
|
+
* @maxLength 200
|
|
1291
|
+
*/
|
|
1017
1292
|
jurisdiction?: string | null;
|
|
1018
1293
|
/** The amount of this line item price that was considered nontaxable. (Decimal value) */
|
|
1019
1294
|
nonTaxableAmount?: MultiCurrencyPrice;
|
|
1020
|
-
/**
|
|
1295
|
+
/**
|
|
1296
|
+
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
|
|
1297
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
1298
|
+
*/
|
|
1021
1299
|
rate?: string | null;
|
|
1022
1300
|
/** The amount of tax estimated for this line item. (Decimal value) */
|
|
1023
1301
|
taxAmount?: MultiCurrencyPrice;
|
|
1024
1302
|
/** The taxable amount of this line item. */
|
|
1025
1303
|
taxableAmount?: MultiCurrencyPrice;
|
|
1026
|
-
/**
|
|
1304
|
+
/**
|
|
1305
|
+
* The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
|
|
1306
|
+
* @maxLength 200
|
|
1307
|
+
*/
|
|
1027
1308
|
taxType?: string | null;
|
|
1028
1309
|
/**
|
|
1029
1310
|
* The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
|
|
1030
1311
|
* This name should be explicit enough to allow the merchant to understand what tax was calculated.
|
|
1312
|
+
* @maxLength 200
|
|
1031
1313
|
*/
|
|
1032
1314
|
taxName?: string | null;
|
|
1033
1315
|
/** The type of the jurisdiction in which this tax detail applies. */
|
|
@@ -1066,11 +1348,16 @@ export interface GiftCard {
|
|
|
1066
1348
|
obfuscatedCode?: string;
|
|
1067
1349
|
/** Gift card value. */
|
|
1068
1350
|
amount?: MultiCurrencyPrice;
|
|
1069
|
-
/**
|
|
1351
|
+
/**
|
|
1352
|
+
* App ID of the gift card provider.
|
|
1353
|
+
* @format GUID
|
|
1354
|
+
*/
|
|
1070
1355
|
appId?: string;
|
|
1071
1356
|
/**
|
|
1072
1357
|
* External ID in the gift card provider's system.
|
|
1073
1358
|
* Used for integration and tracking across different platforms.
|
|
1359
|
+
* @minLength 1
|
|
1360
|
+
* @maxLength 50
|
|
1074
1361
|
*/
|
|
1075
1362
|
externalId?: string | null;
|
|
1076
1363
|
}
|
|
@@ -1157,15 +1444,27 @@ export interface ApplicationError {
|
|
|
1157
1444
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1158
1445
|
*/
|
|
1159
1446
|
export interface AggregatedTaxBreakdown {
|
|
1160
|
-
/**
|
|
1447
|
+
/**
|
|
1448
|
+
* The name of the tax against which this tax amount was calculated.
|
|
1449
|
+
* @maxLength 200
|
|
1450
|
+
*/
|
|
1161
1451
|
taxName?: string;
|
|
1162
|
-
/**
|
|
1452
|
+
/**
|
|
1453
|
+
* The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
|
|
1454
|
+
* @maxLength 200
|
|
1455
|
+
*/
|
|
1163
1456
|
taxType?: string;
|
|
1164
|
-
/**
|
|
1457
|
+
/**
|
|
1458
|
+
* The name of the jurisdiction in which this tax detail applies.
|
|
1459
|
+
* @maxLength 200
|
|
1460
|
+
*/
|
|
1165
1461
|
jurisdiction?: string;
|
|
1166
1462
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1167
1463
|
jurisdictionTypeEnum?: JurisdictionType;
|
|
1168
|
-
/**
|
|
1464
|
+
/**
|
|
1465
|
+
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
|
|
1466
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
1467
|
+
*/
|
|
1169
1468
|
rate?: string;
|
|
1170
1469
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1171
1470
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
@@ -1181,18 +1480,26 @@ export interface ShippingInformation {
|
|
|
1181
1480
|
export interface ShippingRegion {
|
|
1182
1481
|
/**
|
|
1183
1482
|
* Shipping region ID.
|
|
1483
|
+
* @format GUID
|
|
1184
1484
|
* @readonly
|
|
1185
1485
|
*/
|
|
1186
1486
|
_id?: string;
|
|
1187
|
-
/**
|
|
1487
|
+
/**
|
|
1488
|
+
* Shipping region name.
|
|
1489
|
+
* @maxLength 100
|
|
1490
|
+
*/
|
|
1188
1491
|
name?: string;
|
|
1189
1492
|
}
|
|
1190
1493
|
export interface SelectedCarrierServiceOption {
|
|
1191
|
-
/**
|
|
1494
|
+
/**
|
|
1495
|
+
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1496
|
+
* @maxLength 100
|
|
1497
|
+
*/
|
|
1192
1498
|
code?: string;
|
|
1193
1499
|
/**
|
|
1194
1500
|
* Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
|
|
1195
1501
|
* For example, "Standard" or "First-Class Package International".
|
|
1502
|
+
* @maxLength 250
|
|
1196
1503
|
* @readonly
|
|
1197
1504
|
*/
|
|
1198
1505
|
title?: string;
|
|
@@ -1213,17 +1520,29 @@ export interface SelectedCarrierServiceOption {
|
|
|
1213
1520
|
requestedShippingOption?: boolean;
|
|
1214
1521
|
/** Other charges */
|
|
1215
1522
|
otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
|
|
1216
|
-
/**
|
|
1523
|
+
/**
|
|
1524
|
+
* This carrier's unique ID
|
|
1525
|
+
* @format GUID
|
|
1526
|
+
*/
|
|
1217
1527
|
carrierId?: string | null;
|
|
1218
|
-
/**
|
|
1528
|
+
/**
|
|
1529
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
1530
|
+
* @maxSize 300
|
|
1531
|
+
*/
|
|
1219
1532
|
deliveryAllocations?: DeliveryAllocation[];
|
|
1220
1533
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1221
1534
|
partial?: boolean | null;
|
|
1222
1535
|
}
|
|
1223
1536
|
export interface DeliveryLogistics {
|
|
1224
|
-
/**
|
|
1537
|
+
/**
|
|
1538
|
+
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1539
|
+
* @maxLength 500
|
|
1540
|
+
*/
|
|
1225
1541
|
deliveryTime?: string | null;
|
|
1226
|
-
/**
|
|
1542
|
+
/**
|
|
1543
|
+
* Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
|
|
1544
|
+
* @maxLength 1000
|
|
1545
|
+
*/
|
|
1227
1546
|
instructions?: string | null;
|
|
1228
1547
|
/** Pickup details. */
|
|
1229
1548
|
pickupDetails?: PickupDetails;
|
|
@@ -1265,7 +1584,10 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1265
1584
|
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1266
1585
|
/** Type of additional cost. */
|
|
1267
1586
|
type?: ChargeType;
|
|
1268
|
-
/**
|
|
1587
|
+
/**
|
|
1588
|
+
* Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
|
|
1589
|
+
* @maxLength 200
|
|
1590
|
+
*/
|
|
1269
1591
|
details?: string | null;
|
|
1270
1592
|
/** Price of added charge. */
|
|
1271
1593
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
@@ -1283,23 +1605,43 @@ export interface DeliveryAllocation {
|
|
|
1283
1605
|
applicableLineItems?: ApplicableLineItems;
|
|
1284
1606
|
}
|
|
1285
1607
|
export interface Carrier {
|
|
1286
|
-
/**
|
|
1608
|
+
/**
|
|
1609
|
+
* The carrier app id
|
|
1610
|
+
* @format GUID
|
|
1611
|
+
*/
|
|
1287
1612
|
appId?: string | null;
|
|
1288
|
-
/**
|
|
1613
|
+
/**
|
|
1614
|
+
* Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
|
|
1615
|
+
* @maxLength 250
|
|
1616
|
+
*/
|
|
1289
1617
|
code?: string;
|
|
1290
1618
|
}
|
|
1291
1619
|
export interface Region {
|
|
1292
|
-
/**
|
|
1620
|
+
/**
|
|
1621
|
+
* The delivery region id.
|
|
1622
|
+
* @format GUID
|
|
1623
|
+
*/
|
|
1293
1624
|
_id?: string | null;
|
|
1294
|
-
/**
|
|
1625
|
+
/**
|
|
1626
|
+
* The delivery region name.
|
|
1627
|
+
* @maxLength 100
|
|
1628
|
+
*/
|
|
1295
1629
|
name?: string | null;
|
|
1296
1630
|
}
|
|
1297
1631
|
export interface ApplicableLineItems {
|
|
1298
|
-
/**
|
|
1632
|
+
/**
|
|
1633
|
+
* Line items that the delivery solution is for.
|
|
1634
|
+
* @maxSize 300
|
|
1635
|
+
* @minLength 1
|
|
1636
|
+
* @maxLength 100
|
|
1637
|
+
*/
|
|
1299
1638
|
lineItemIds?: string[];
|
|
1300
1639
|
}
|
|
1301
1640
|
export interface CarrierServiceOption {
|
|
1302
|
-
/**
|
|
1641
|
+
/**
|
|
1642
|
+
* Carrier ID.
|
|
1643
|
+
* @format GUID
|
|
1644
|
+
*/
|
|
1303
1645
|
carrierId?: string;
|
|
1304
1646
|
/** Shipping options offered by this carrier for this request. */
|
|
1305
1647
|
shippingOptions?: ShippingOption[];
|
|
@@ -1308,18 +1650,23 @@ export interface ShippingOption {
|
|
|
1308
1650
|
/**
|
|
1309
1651
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1310
1652
|
* For legacy calculators this would be the UUID of the option.
|
|
1653
|
+
* @maxLength 100
|
|
1311
1654
|
*/
|
|
1312
1655
|
code?: string;
|
|
1313
1656
|
/**
|
|
1314
1657
|
* Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
|
|
1315
1658
|
* For example, "Standard" or "First-Class Package International".
|
|
1659
|
+
* @maxLength 250
|
|
1316
1660
|
*/
|
|
1317
1661
|
title?: string;
|
|
1318
1662
|
/** Delivery logistics. */
|
|
1319
1663
|
logistics?: DeliveryLogistics;
|
|
1320
1664
|
/** Sipping price information. */
|
|
1321
1665
|
cost?: ShippingPrice;
|
|
1322
|
-
/**
|
|
1666
|
+
/**
|
|
1667
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
1668
|
+
* @maxSize 300
|
|
1669
|
+
*/
|
|
1323
1670
|
deliveryAllocations?: DeliveryAllocation[];
|
|
1324
1671
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1325
1672
|
partial?: boolean | null;
|
|
@@ -1347,6 +1694,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1347
1694
|
discountType?: AppliedDiscountDiscountType;
|
|
1348
1695
|
/**
|
|
1349
1696
|
* IDs of the line items the discount applies to.
|
|
1697
|
+
* @format GUID
|
|
1350
1698
|
* @deprecated IDs of line items the discount applies to.
|
|
1351
1699
|
* @replacedBy line_items_discounts
|
|
1352
1700
|
* @targetRemovalDate 2024-06-01
|
|
@@ -1381,11 +1729,18 @@ export interface V1Coupon {
|
|
|
1381
1729
|
export interface V1MerchantDiscount {
|
|
1382
1730
|
/** Discount value. */
|
|
1383
1731
|
amount?: MultiCurrencyPrice;
|
|
1384
|
-
/**
|
|
1732
|
+
/**
|
|
1733
|
+
* Discount Percentage. Will be calculated from items price before other discounts.
|
|
1734
|
+
* @min 1
|
|
1735
|
+
* @max 100
|
|
1736
|
+
*/
|
|
1385
1737
|
percentage?: number | null;
|
|
1386
1738
|
}
|
|
1387
1739
|
export interface V1DiscountRule {
|
|
1388
|
-
/**
|
|
1740
|
+
/**
|
|
1741
|
+
* Discount rule ID
|
|
1742
|
+
* @format GUID
|
|
1743
|
+
*/
|
|
1389
1744
|
_id?: string;
|
|
1390
1745
|
/** Discount rule name */
|
|
1391
1746
|
name?: V1DiscountRuleName;
|
|
@@ -1393,13 +1748,24 @@ export interface V1DiscountRule {
|
|
|
1393
1748
|
amount?: MultiCurrencyPrice;
|
|
1394
1749
|
}
|
|
1395
1750
|
export interface V1DiscountRuleName {
|
|
1396
|
-
/**
|
|
1751
|
+
/**
|
|
1752
|
+
* Original discount rule name (in site's default language).
|
|
1753
|
+
* @minLength 1
|
|
1754
|
+
* @maxLength 256
|
|
1755
|
+
*/
|
|
1397
1756
|
original?: string;
|
|
1398
|
-
/**
|
|
1757
|
+
/**
|
|
1758
|
+
* Translated discount rule name according to buyer language. Defaults to `original` when not provided.
|
|
1759
|
+
* @minLength 1
|
|
1760
|
+
* @maxLength 500
|
|
1761
|
+
*/
|
|
1399
1762
|
translated?: string | null;
|
|
1400
1763
|
}
|
|
1401
1764
|
export interface LineItemDiscount {
|
|
1402
|
-
/**
|
|
1765
|
+
/**
|
|
1766
|
+
* ID of line item the discount applies to.
|
|
1767
|
+
* @format GUID
|
|
1768
|
+
*/
|
|
1403
1769
|
_id?: string;
|
|
1404
1770
|
/** Discount value. */
|
|
1405
1771
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
@@ -1529,21 +1895,43 @@ export interface CarrierError {
|
|
|
1529
1895
|
error?: Details;
|
|
1530
1896
|
}
|
|
1531
1897
|
export interface MembershipOptions {
|
|
1532
|
-
/**
|
|
1898
|
+
/**
|
|
1899
|
+
* List of payment options that can be used.
|
|
1900
|
+
* @maxSize 300
|
|
1901
|
+
*/
|
|
1533
1902
|
eligibleMemberships?: Membership[];
|
|
1534
|
-
/**
|
|
1903
|
+
/**
|
|
1904
|
+
* List of payment options that are owned by the member, but cannot be used due to reason provided.
|
|
1905
|
+
* @maxSize 300
|
|
1906
|
+
*/
|
|
1535
1907
|
invalidMemberships?: InvalidMembership[];
|
|
1536
|
-
/**
|
|
1908
|
+
/**
|
|
1909
|
+
* The selected membership payment options and which line items they apply to.
|
|
1910
|
+
* @maxSize 300
|
|
1911
|
+
*/
|
|
1537
1912
|
selectedMemberships?: HostSelectedMembership[];
|
|
1538
1913
|
}
|
|
1539
1914
|
export interface Membership {
|
|
1540
|
-
/**
|
|
1915
|
+
/**
|
|
1916
|
+
* Membership ID.
|
|
1917
|
+
* @minLength 1
|
|
1918
|
+
* @maxLength 100
|
|
1919
|
+
*/
|
|
1541
1920
|
_id?: string;
|
|
1542
|
-
/**
|
|
1921
|
+
/**
|
|
1922
|
+
* ID of the application providing this payment option.
|
|
1923
|
+
* @format GUID
|
|
1924
|
+
*/
|
|
1543
1925
|
appId?: string;
|
|
1544
1926
|
/** The name of this membership. */
|
|
1545
1927
|
name?: MembershipName;
|
|
1546
|
-
/**
|
|
1928
|
+
/**
|
|
1929
|
+
* Line item IDs which are "paid" for by this membership.
|
|
1930
|
+
* @minSize 1
|
|
1931
|
+
* @maxSize 300
|
|
1932
|
+
* @minLength 1
|
|
1933
|
+
* @maxLength 100
|
|
1934
|
+
*/
|
|
1547
1935
|
lineItemIds?: string[];
|
|
1548
1936
|
/** Optional - For a membership that has limited credits, information about credit usage. */
|
|
1549
1937
|
credits?: MembershipPaymentCredits;
|
|
@@ -1553,13 +1941,22 @@ export interface Membership {
|
|
|
1553
1941
|
additionalData?: Record<string, any> | null;
|
|
1554
1942
|
}
|
|
1555
1943
|
export interface MembershipName {
|
|
1556
|
-
/**
|
|
1944
|
+
/**
|
|
1945
|
+
* Membership name.
|
|
1946
|
+
* @maxLength 100
|
|
1947
|
+
*/
|
|
1557
1948
|
original?: string;
|
|
1558
|
-
/**
|
|
1949
|
+
/**
|
|
1950
|
+
* Membership name translated into buyer's language. Defaults to `original` when not defined.
|
|
1951
|
+
* @maxLength 100
|
|
1952
|
+
*/
|
|
1559
1953
|
translated?: string | null;
|
|
1560
1954
|
}
|
|
1561
1955
|
export interface MembershipPaymentCredits {
|
|
1562
|
-
/**
|
|
1956
|
+
/**
|
|
1957
|
+
* Membership's total amount of credits.
|
|
1958
|
+
* @min 1
|
|
1959
|
+
*/
|
|
1563
1960
|
total?: number;
|
|
1564
1961
|
/** Membership's remaining amount of credits. */
|
|
1565
1962
|
remaining?: number;
|
|
@@ -1567,19 +1964,35 @@ export interface MembershipPaymentCredits {
|
|
|
1567
1964
|
export interface InvalidMembership {
|
|
1568
1965
|
/** Membership details. */
|
|
1569
1966
|
membership?: Membership;
|
|
1570
|
-
/**
|
|
1967
|
+
/**
|
|
1968
|
+
* Reason why this membership is invalid and cannot be used.
|
|
1969
|
+
* @minLength 1
|
|
1970
|
+
* @maxLength 100
|
|
1971
|
+
*/
|
|
1571
1972
|
reason?: string;
|
|
1572
1973
|
}
|
|
1573
1974
|
export interface AdditionalFee {
|
|
1574
|
-
/**
|
|
1975
|
+
/**
|
|
1976
|
+
* Additional fee's unique code (or ID) for future processing.
|
|
1977
|
+
* @minLength 1
|
|
1978
|
+
* @maxLength 100
|
|
1979
|
+
*/
|
|
1575
1980
|
code?: string | null;
|
|
1576
|
-
/**
|
|
1981
|
+
/**
|
|
1982
|
+
* Translated additional fee's name.
|
|
1983
|
+
* @minLength 1
|
|
1984
|
+
* @maxLength 50
|
|
1985
|
+
*/
|
|
1577
1986
|
name?: string;
|
|
1578
1987
|
/** Additional fee's price. */
|
|
1579
1988
|
price?: MultiCurrencyPrice;
|
|
1580
1989
|
/** Tax details. */
|
|
1581
1990
|
taxDetails?: ItemTaxFullDetails;
|
|
1582
|
-
/**
|
|
1991
|
+
/**
|
|
1992
|
+
* Provider's app id.
|
|
1993
|
+
* @minLength 1
|
|
1994
|
+
* @maxLength 100
|
|
1995
|
+
*/
|
|
1583
1996
|
providerAppId?: string | null;
|
|
1584
1997
|
/** Additional fee's price before tax. */
|
|
1585
1998
|
priceBeforeTax?: MultiCurrencyPrice;
|
|
@@ -1588,6 +2001,7 @@ export interface AdditionalFee {
|
|
|
1588
2001
|
/**
|
|
1589
2002
|
* Optional - Line items associated with this additional fee.
|
|
1590
2003
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
2004
|
+
* @format GUID
|
|
1591
2005
|
*/
|
|
1592
2006
|
lineItemIds?: string[];
|
|
1593
2007
|
/** the source the additional fee was added from */
|
|
@@ -1607,7 +2021,11 @@ export interface Violation {
|
|
|
1607
2021
|
severity?: Severity;
|
|
1608
2022
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
1609
2023
|
target?: Target;
|
|
1610
|
-
/**
|
|
2024
|
+
/**
|
|
2025
|
+
* Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`.
|
|
2026
|
+
* @minLength 1
|
|
2027
|
+
* @maxLength 1000
|
|
2028
|
+
*/
|
|
1611
2029
|
description?: string | null;
|
|
1612
2030
|
}
|
|
1613
2031
|
export declare enum Severity {
|
|
@@ -1661,7 +2079,12 @@ export interface TargetLineItem {
|
|
|
1661
2079
|
_id?: string | null;
|
|
1662
2080
|
}
|
|
1663
2081
|
export interface RemoveLineItemsFromCurrentCartRequest {
|
|
1664
|
-
/**
|
|
2082
|
+
/**
|
|
2083
|
+
* IDs of the line items to remove from the cart.
|
|
2084
|
+
* @format GUID
|
|
2085
|
+
* @minSize 1
|
|
2086
|
+
* @maxSize 100
|
|
2087
|
+
*/
|
|
1665
2088
|
lineItemIds?: string[];
|
|
1666
2089
|
}
|
|
1667
2090
|
export interface RemoveLineItemsResponse {
|
|
@@ -1677,7 +2100,10 @@ export interface CreateCheckoutFromCurrentCartRequest {
|
|
|
1677
2100
|
billingAddress?: Address;
|
|
1678
2101
|
/** Selected shipping option. */
|
|
1679
2102
|
selectedShippingOption?: SelectedShippingOption;
|
|
1680
|
-
/**
|
|
2103
|
+
/**
|
|
2104
|
+
* Mandatory when setting a billing or shipping address if the site visitor isn't logged in.
|
|
2105
|
+
* @format EMAIL
|
|
2106
|
+
*/
|
|
1681
2107
|
email?: string | null;
|
|
1682
2108
|
}
|
|
1683
2109
|
export declare enum ChannelType {
|
|
@@ -1725,13 +2151,24 @@ export interface RemoveCouponResponse {
|
|
|
1725
2151
|
cart?: Cart;
|
|
1726
2152
|
}
|
|
1727
2153
|
export interface UpdateCurrentCartLineItemQuantityRequest {
|
|
1728
|
-
/**
|
|
2154
|
+
/**
|
|
2155
|
+
* Line item IDs and their new quantity.
|
|
2156
|
+
* @minSize 1
|
|
2157
|
+
* @maxSize 100
|
|
2158
|
+
*/
|
|
1729
2159
|
lineItems?: LineItemQuantityUpdate[];
|
|
1730
2160
|
}
|
|
1731
2161
|
export interface LineItemQuantityUpdate {
|
|
1732
|
-
/**
|
|
2162
|
+
/**
|
|
2163
|
+
* Line item ID. Required.
|
|
2164
|
+
* @format GUID
|
|
2165
|
+
*/
|
|
1733
2166
|
_id?: string;
|
|
1734
|
-
/**
|
|
2167
|
+
/**
|
|
2168
|
+
* New quantity. Number must be 1 or higher. Required.
|
|
2169
|
+
* @min 1
|
|
2170
|
+
* @max 100000
|
|
2171
|
+
*/
|
|
1735
2172
|
quantity?: number;
|
|
1736
2173
|
}
|
|
1737
2174
|
export interface UpdateLineItemsQuantityResponse {
|
|
@@ -1835,9 +2272,15 @@ export interface ActionEvent {
|
|
|
1835
2272
|
body?: string;
|
|
1836
2273
|
}
|
|
1837
2274
|
export interface MessageEnvelope {
|
|
1838
|
-
/**
|
|
2275
|
+
/**
|
|
2276
|
+
* App instance ID.
|
|
2277
|
+
* @format GUID
|
|
2278
|
+
*/
|
|
1839
2279
|
instanceId?: string | null;
|
|
1840
|
-
/**
|
|
2280
|
+
/**
|
|
2281
|
+
* Event type.
|
|
2282
|
+
* @maxLength 150
|
|
2283
|
+
*/
|
|
1841
2284
|
eventType?: string;
|
|
1842
2285
|
/** The identification type and identity data. */
|
|
1843
2286
|
identity?: IdentificationData;
|
|
@@ -1845,26 +2288,50 @@ export interface MessageEnvelope {
|
|
|
1845
2288
|
data?: string;
|
|
1846
2289
|
}
|
|
1847
2290
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1848
|
-
/**
|
|
2291
|
+
/**
|
|
2292
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2293
|
+
* @format GUID
|
|
2294
|
+
*/
|
|
1849
2295
|
anonymousVisitorId?: string;
|
|
1850
|
-
/**
|
|
2296
|
+
/**
|
|
2297
|
+
* ID of a site visitor that has logged in to the site.
|
|
2298
|
+
* @format GUID
|
|
2299
|
+
*/
|
|
1851
2300
|
memberId?: string;
|
|
1852
|
-
/**
|
|
2301
|
+
/**
|
|
2302
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2303
|
+
* @format GUID
|
|
2304
|
+
*/
|
|
1853
2305
|
wixUserId?: string;
|
|
1854
|
-
/**
|
|
2306
|
+
/**
|
|
2307
|
+
* ID of an app.
|
|
2308
|
+
* @format GUID
|
|
2309
|
+
*/
|
|
1855
2310
|
appId?: string;
|
|
1856
2311
|
/** @readonly */
|
|
1857
2312
|
identityType?: WebhookIdentityType;
|
|
1858
2313
|
}
|
|
1859
2314
|
/** @oneof */
|
|
1860
2315
|
export interface IdentificationDataIdOneOf {
|
|
1861
|
-
/**
|
|
2316
|
+
/**
|
|
2317
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2318
|
+
* @format GUID
|
|
2319
|
+
*/
|
|
1862
2320
|
anonymousVisitorId?: string;
|
|
1863
|
-
/**
|
|
2321
|
+
/**
|
|
2322
|
+
* ID of a site visitor that has logged in to the site.
|
|
2323
|
+
* @format GUID
|
|
2324
|
+
*/
|
|
1864
2325
|
memberId?: string;
|
|
1865
|
-
/**
|
|
2326
|
+
/**
|
|
2327
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2328
|
+
* @format GUID
|
|
2329
|
+
*/
|
|
1866
2330
|
wixUserId?: string;
|
|
1867
|
-
/**
|
|
2331
|
+
/**
|
|
2332
|
+
* ID of an app.
|
|
2333
|
+
* @format GUID
|
|
2334
|
+
*/
|
|
1868
2335
|
appId?: string;
|
|
1869
2336
|
}
|
|
1870
2337
|
export declare enum WebhookIdentityType {
|
|
@@ -1879,15 +2346,22 @@ export interface CreateCartRequest {
|
|
|
1879
2346
|
cartInfo?: Cart;
|
|
1880
2347
|
/** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
1881
2348
|
couponCode?: string | null;
|
|
1882
|
-
/**
|
|
2349
|
+
/**
|
|
2350
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will apply to the whole cart.
|
|
2351
|
+
* @maxSize 100
|
|
2352
|
+
*/
|
|
1883
2353
|
merchantDiscounts?: MerchantDiscountInput[];
|
|
1884
|
-
/**
|
|
2354
|
+
/**
|
|
2355
|
+
* Catalog line items.
|
|
2356
|
+
* @maxSize 300
|
|
2357
|
+
*/
|
|
1885
2358
|
lineItems?: LineItem[];
|
|
1886
2359
|
/**
|
|
1887
2360
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
1888
2361
|
*
|
|
1889
2362
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
1890
2363
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2364
|
+
* @maxSize 300
|
|
1891
2365
|
*/
|
|
1892
2366
|
customLineItems?: CustomLineItem[];
|
|
1893
2367
|
}
|
|
@@ -1896,7 +2370,10 @@ export interface CreateCartResponse {
|
|
|
1896
2370
|
cart?: Cart;
|
|
1897
2371
|
}
|
|
1898
2372
|
export interface GetCartRequest {
|
|
1899
|
-
/**
|
|
2373
|
+
/**
|
|
2374
|
+
* ID of the cart to retrieve.
|
|
2375
|
+
* @format GUID
|
|
2376
|
+
*/
|
|
1900
2377
|
_id: string;
|
|
1901
2378
|
}
|
|
1902
2379
|
export interface GetCartResponse {
|
|
@@ -1904,7 +2381,10 @@ export interface GetCartResponse {
|
|
|
1904
2381
|
cart?: Cart;
|
|
1905
2382
|
}
|
|
1906
2383
|
export interface GetCartByCheckoutIdRequest {
|
|
1907
|
-
/**
|
|
2384
|
+
/**
|
|
2385
|
+
* Checkout ID.
|
|
2386
|
+
* @format GUID
|
|
2387
|
+
*/
|
|
1908
2388
|
_id: string;
|
|
1909
2389
|
}
|
|
1910
2390
|
export interface GetCartByCheckoutIdResponse {
|
|
@@ -1912,32 +2392,51 @@ export interface GetCartByCheckoutIdResponse {
|
|
|
1912
2392
|
cart?: Cart;
|
|
1913
2393
|
}
|
|
1914
2394
|
export interface AddToCartRequest {
|
|
1915
|
-
/**
|
|
2395
|
+
/**
|
|
2396
|
+
* Cart ID.
|
|
2397
|
+
* @format GUID
|
|
2398
|
+
*/
|
|
1916
2399
|
_id: string;
|
|
1917
|
-
/**
|
|
2400
|
+
/**
|
|
2401
|
+
* Catalog line items.
|
|
2402
|
+
* @maxSize 100
|
|
2403
|
+
*/
|
|
1918
2404
|
lineItems?: LineItem[];
|
|
1919
2405
|
/**
|
|
1920
2406
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
1921
2407
|
*
|
|
1922
2408
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
1923
2409
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2410
|
+
* @maxSize 100
|
|
1924
2411
|
*/
|
|
1925
2412
|
customLineItems?: CustomLineItem[];
|
|
1926
2413
|
/**
|
|
1927
2414
|
* The business location ID associated with the cart.
|
|
1928
2415
|
* The `businessLocationId` field cannot be passed if one already exists on the cart. To update a cart's business location ID, use the UpdateCart method.
|
|
1929
2416
|
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
2417
|
+
* @format GUID
|
|
1930
2418
|
*/
|
|
1931
2419
|
businessLocationId?: string | null;
|
|
1932
2420
|
}
|
|
1933
2421
|
export interface RemoveLineItemsRequest {
|
|
1934
|
-
/**
|
|
2422
|
+
/**
|
|
2423
|
+
* Cart ID.
|
|
2424
|
+
* @format GUID
|
|
2425
|
+
*/
|
|
1935
2426
|
_id: string;
|
|
1936
|
-
/**
|
|
2427
|
+
/**
|
|
2428
|
+
* IDs of the line items to remove from the cart.
|
|
2429
|
+
* @format GUID
|
|
2430
|
+
* @minSize 1
|
|
2431
|
+
* @maxSize 100
|
|
2432
|
+
*/
|
|
1937
2433
|
lineItemIds: string[];
|
|
1938
2434
|
}
|
|
1939
2435
|
export interface CreateCheckoutRequest {
|
|
1940
|
-
/**
|
|
2436
|
+
/**
|
|
2437
|
+
* Cart ID.
|
|
2438
|
+
* @format GUID
|
|
2439
|
+
*/
|
|
1941
2440
|
_id: string;
|
|
1942
2441
|
/** **Required**. Sales channel type. */
|
|
1943
2442
|
channelType?: ChannelType;
|
|
@@ -1947,21 +2446,37 @@ export interface CreateCheckoutRequest {
|
|
|
1947
2446
|
billingAddress?: Address;
|
|
1948
2447
|
/** Selected shipping option. */
|
|
1949
2448
|
selectedShippingOption?: SelectedShippingOption;
|
|
1950
|
-
/**
|
|
2449
|
+
/**
|
|
2450
|
+
* Mandatory when setting a billing or shipping address if the site visitor isn't logged in.
|
|
2451
|
+
* @format EMAIL
|
|
2452
|
+
*/
|
|
1951
2453
|
email?: string | null;
|
|
1952
2454
|
}
|
|
1953
2455
|
export interface RemoveCouponRequest {
|
|
1954
|
-
/**
|
|
2456
|
+
/**
|
|
2457
|
+
* Cart ID.
|
|
2458
|
+
* @format GUID
|
|
2459
|
+
*/
|
|
1955
2460
|
_id: string;
|
|
1956
2461
|
}
|
|
1957
2462
|
export interface UpdateLineItemsQuantityRequest {
|
|
1958
|
-
/**
|
|
2463
|
+
/**
|
|
2464
|
+
* Cart ID.
|
|
2465
|
+
* @format GUID
|
|
2466
|
+
*/
|
|
1959
2467
|
_id: string;
|
|
1960
|
-
/**
|
|
2468
|
+
/**
|
|
2469
|
+
* Line item IDs and their new quantity.
|
|
2470
|
+
* @minSize 1
|
|
2471
|
+
* @maxSize 100
|
|
2472
|
+
*/
|
|
1961
2473
|
lineItems: LineItemQuantityUpdate[];
|
|
1962
2474
|
}
|
|
1963
2475
|
export interface EstimateTotalsRequest {
|
|
1964
|
-
/**
|
|
2476
|
+
/**
|
|
2477
|
+
* Cart ID.
|
|
2478
|
+
* @format GUID
|
|
2479
|
+
*/
|
|
1965
2480
|
_id: string;
|
|
1966
2481
|
/** Selected shipping option. */
|
|
1967
2482
|
selectedShippingOption?: SelectedShippingOption;
|
|
@@ -1985,13 +2500,19 @@ export interface EstimateTotalsRequest {
|
|
|
1985
2500
|
calculateShipping?: boolean | null;
|
|
1986
2501
|
}
|
|
1987
2502
|
export interface DeleteCartRequest {
|
|
1988
|
-
/**
|
|
2503
|
+
/**
|
|
2504
|
+
* ID of the cart to delete.
|
|
2505
|
+
* @format GUID
|
|
2506
|
+
*/
|
|
1989
2507
|
_id: string;
|
|
1990
2508
|
}
|
|
1991
2509
|
export interface Empty {
|
|
1992
2510
|
}
|
|
1993
2511
|
export interface RemoveBusinessLocationRequest {
|
|
1994
|
-
/**
|
|
2512
|
+
/**
|
|
2513
|
+
* Cart ID.
|
|
2514
|
+
* @format GUID
|
|
2515
|
+
*/
|
|
1995
2516
|
_id: string;
|
|
1996
2517
|
}
|
|
1997
2518
|
export interface RemoveBusinessLocationResponse {
|
|
@@ -2452,9 +2973,15 @@ export interface RemoveBusinessLocationResponseNonNullableFields {
|
|
|
2452
2973
|
cart?: CartNonNullableFields;
|
|
2453
2974
|
}
|
|
2454
2975
|
export interface BaseEventMetadata {
|
|
2455
|
-
/**
|
|
2976
|
+
/**
|
|
2977
|
+
* App instance ID.
|
|
2978
|
+
* @format GUID
|
|
2979
|
+
*/
|
|
2456
2980
|
instanceId?: string | null;
|
|
2457
|
-
/**
|
|
2981
|
+
/**
|
|
2982
|
+
* Event type.
|
|
2983
|
+
* @maxLength 150
|
|
2984
|
+
*/
|
|
2458
2985
|
eventType?: string;
|
|
2459
2986
|
/** The identification type and identity data. */
|
|
2460
2987
|
identity?: IdentificationData;
|
|
@@ -2519,6 +3046,8 @@ export interface CartDeletedEnvelope {
|
|
|
2519
3046
|
* @permissionId ECOM.READ_CARTS
|
|
2520
3047
|
* @webhook
|
|
2521
3048
|
* @eventType wix.ecom.v1.cart_deleted
|
|
3049
|
+
* @serviceIdentifier com.wix.ecom.cart.api.v1.CurrentCartService
|
|
3050
|
+
* @slug deleted
|
|
2522
3051
|
*/
|
|
2523
3052
|
export declare function onCartDeleted(handler: (event: CartDeletedEnvelope) => void | Promise<void>): void;
|
|
2524
3053
|
export interface CartUpdatedEnvelope {
|
|
@@ -2542,6 +3071,7 @@ export interface CartUpdatedEnvelope {
|
|
|
2542
3071
|
* @permissionId ECOM.READ_CARTS
|
|
2543
3072
|
* @webhook
|
|
2544
3073
|
* @eventType wix.ecom.v1.cart_updated
|
|
3074
|
+
* @slug updated
|
|
2545
3075
|
*/
|
|
2546
3076
|
export declare function onCartUpdated(handler: (event: CartUpdatedEnvelope) => void | Promise<void>): void;
|
|
2547
3077
|
export interface CartCreatedEnvelope {
|
|
@@ -2567,6 +3097,8 @@ export interface CartCreatedEnvelope {
|
|
|
2567
3097
|
* @permissionId ECOM.READ_CARTS
|
|
2568
3098
|
* @webhook
|
|
2569
3099
|
* @eventType wix.ecom.v1.cart_created
|
|
3100
|
+
* @serviceIdentifier com.wix.ecom.cart.api.v1.CartService
|
|
3101
|
+
* @slug created
|
|
2570
3102
|
*/
|
|
2571
3103
|
export declare function onCartCreated(handler: (event: CartCreatedEnvelope) => void | Promise<void>): void;
|
|
2572
3104
|
/**
|
|
@@ -2577,8 +3109,8 @@ export declare function onCartCreated(handler: (event: CartCreatedEnvelope) => v
|
|
|
2577
3109
|
*
|
|
2578
3110
|
* > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
|
|
2579
3111
|
* @public
|
|
2580
|
-
* @requiredField options.customLineItems.descriptionLines
|
|
2581
3112
|
* @requiredField options.customLineItems.descriptionLines.name
|
|
3113
|
+
* @requiredField options.customLineItems.descriptionLines.value
|
|
2582
3114
|
* @requiredField options.customLineItems.itemType
|
|
2583
3115
|
* @requiredField options.customLineItems.price
|
|
2584
3116
|
* @requiredField options.customLineItems.productName
|
|
@@ -2592,12 +3124,16 @@ export declare function onCartCreated(handler: (event: CartCreatedEnvelope) => v
|
|
|
2592
3124
|
* @permissionId ECOM.ADMIN_MODIFY_CARTS
|
|
2593
3125
|
* @permissionScope Manage Stores - all permissions
|
|
2594
3126
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3127
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3128
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2595
3129
|
* @permissionScope Manage eCommerce - all permissions
|
|
2596
3130
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2597
3131
|
* @permissionScope Manage Stores - all permissions
|
|
2598
3132
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2599
3133
|
* @permissionScope Manage eCommerce - Admin Permissions
|
|
2600
3134
|
* @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
|
|
3135
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3136
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2601
3137
|
* @permissionScope Manage eCommerce - all permissions
|
|
2602
3138
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2603
3139
|
* @applicableIdentity APP
|
|
@@ -2611,29 +3147,35 @@ export interface CreateCartOptions {
|
|
|
2611
3147
|
cartInfo?: Cart;
|
|
2612
3148
|
/** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
2613
3149
|
couponCode?: string | null;
|
|
2614
|
-
/**
|
|
3150
|
+
/**
|
|
3151
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will apply to the whole cart.
|
|
3152
|
+
* @maxSize 100
|
|
3153
|
+
*/
|
|
2615
3154
|
merchantDiscounts?: MerchantDiscountInput[];
|
|
2616
|
-
/**
|
|
3155
|
+
/**
|
|
3156
|
+
* Catalog line items.
|
|
3157
|
+
* @maxSize 300
|
|
3158
|
+
*/
|
|
2617
3159
|
lineItems?: LineItem[];
|
|
2618
3160
|
/**
|
|
2619
3161
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2620
3162
|
*
|
|
2621
3163
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2622
3164
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3165
|
+
* @maxSize 300
|
|
2623
3166
|
*/
|
|
2624
3167
|
customLineItems?: CustomLineItem[];
|
|
2625
3168
|
}
|
|
2626
3169
|
/**
|
|
2627
3170
|
* Updates a specified cart's properties.
|
|
2628
3171
|
*
|
|
2629
|
-
*
|
|
2630
|
-
* The `updateCart()` function returns a Promise that resolves when the specified cart's properties are updated.
|
|
3172
|
+
* After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
|
|
2631
3173
|
*
|
|
2632
3174
|
* > **Note:** When updating catalog items, `options.lineItems.catalogReference` is required.
|
|
2633
3175
|
* @public
|
|
2634
3176
|
* @requiredField _id
|
|
2635
|
-
* @requiredField options.customLineItems.descriptionLines
|
|
2636
3177
|
* @requiredField options.customLineItems.descriptionLines.name
|
|
3178
|
+
* @requiredField options.customLineItems.descriptionLines.value
|
|
2637
3179
|
* @requiredField options.customLineItems.itemType
|
|
2638
3180
|
* @requiredField options.customLineItems.productName
|
|
2639
3181
|
* @requiredField options.lineItems.catalogReference
|
|
@@ -2643,12 +3185,16 @@ export interface CreateCartOptions {
|
|
|
2643
3185
|
* @permissionId ECOM.ADMIN_MODIFY_CARTS
|
|
2644
3186
|
* @permissionScope Manage Stores - all permissions
|
|
2645
3187
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3188
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3189
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2646
3190
|
* @permissionScope Manage eCommerce - all permissions
|
|
2647
3191
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2648
3192
|
* @permissionScope Manage Stores - all permissions
|
|
2649
3193
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2650
3194
|
* @permissionScope Manage eCommerce - Admin Permissions
|
|
2651
3195
|
* @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
|
|
3196
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3197
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2652
3198
|
* @permissionScope Manage eCommerce - all permissions
|
|
2653
3199
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2654
3200
|
* @applicableIdentity APP
|
|
@@ -2660,19 +3206,28 @@ export declare function updateCart(_id: string | null, options?: UpdateCartOptio
|
|
|
2660
3206
|
export interface UpdateCartOptions {
|
|
2661
3207
|
/** The information for the cart being updated. */
|
|
2662
3208
|
cartInfo: {
|
|
2663
|
-
/**
|
|
3209
|
+
/**
|
|
3210
|
+
* ID of the cart to be updated.
|
|
3211
|
+
* @format GUID
|
|
3212
|
+
*/
|
|
2664
3213
|
_id?: string | null;
|
|
2665
3214
|
/**
|
|
2666
3215
|
* Line items.
|
|
3216
|
+
* @minSize 1
|
|
3217
|
+
* @maxSize 300
|
|
2667
3218
|
* @readonly
|
|
2668
3219
|
*/
|
|
2669
3220
|
lineItems?: LineItem[];
|
|
2670
|
-
/**
|
|
3221
|
+
/**
|
|
3222
|
+
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
3223
|
+
* @maxLength 1000
|
|
3224
|
+
*/
|
|
2671
3225
|
buyerNote?: string | null;
|
|
2672
3226
|
/** Buyer information. */
|
|
2673
3227
|
buyerInfo?: BuyerInfo;
|
|
2674
3228
|
/**
|
|
2675
3229
|
* Currency used for pricing.
|
|
3230
|
+
* @format CURRENCY
|
|
2676
3231
|
* @readonly
|
|
2677
3232
|
*/
|
|
2678
3233
|
currency?: string;
|
|
@@ -2680,6 +3235,7 @@ export interface UpdateCartOptions {
|
|
|
2680
3235
|
* Currency code used for all the converted prices that are returned.
|
|
2681
3236
|
* For a site that supports multiple currencies, this is the currency the buyer selected.
|
|
2682
3237
|
* @readonly
|
|
3238
|
+
* @format CURRENCY
|
|
2683
3239
|
*/
|
|
2684
3240
|
conversionCurrency?: string;
|
|
2685
3241
|
/**
|
|
@@ -2706,6 +3262,7 @@ export interface UpdateCartOptions {
|
|
|
2706
3262
|
/**
|
|
2707
3263
|
* ID of the checkout that originated from this cart.
|
|
2708
3264
|
* @readonly
|
|
3265
|
+
* @format GUID
|
|
2709
3266
|
*/
|
|
2710
3267
|
checkoutId?: string | null;
|
|
2711
3268
|
/**
|
|
@@ -2729,10 +3286,12 @@ export interface UpdateCartOptions {
|
|
|
2729
3286
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2730
3287
|
*
|
|
2731
3288
|
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
3289
|
+
* @maxLength 1000
|
|
2732
3290
|
*/
|
|
2733
3291
|
overrideCheckoutUrl?: string | null;
|
|
2734
3292
|
/**
|
|
2735
3293
|
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
3294
|
+
* @format GUID
|
|
2736
3295
|
* @readonly
|
|
2737
3296
|
*/
|
|
2738
3297
|
purchaseFlowId?: string | null;
|
|
@@ -2741,20 +3300,28 @@ export interface UpdateCartOptions {
|
|
|
2741
3300
|
/**
|
|
2742
3301
|
* The business location ID associated with the cart.
|
|
2743
3302
|
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
3303
|
+
* @format GUID
|
|
2744
3304
|
*/
|
|
2745
3305
|
businessLocationId?: string | null;
|
|
2746
3306
|
};
|
|
2747
3307
|
/** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
2748
3308
|
couponCode?: string | null;
|
|
2749
|
-
/**
|
|
3309
|
+
/**
|
|
3310
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
|
|
3311
|
+
* @maxSize 100
|
|
3312
|
+
*/
|
|
2750
3313
|
merchantDiscounts?: MerchantDiscountInput[];
|
|
2751
|
-
/**
|
|
3314
|
+
/**
|
|
3315
|
+
* Catalog line items.
|
|
3316
|
+
* @maxSize 300
|
|
3317
|
+
*/
|
|
2752
3318
|
lineItems?: LineItem[];
|
|
2753
3319
|
/**
|
|
2754
3320
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2755
3321
|
*
|
|
2756
3322
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2757
3323
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3324
|
+
* @maxSize 300
|
|
2758
3325
|
*/
|
|
2759
3326
|
customLineItems?: CustomLineItem[];
|
|
2760
3327
|
}
|
|
@@ -2790,15 +3357,14 @@ export declare function getCart(_id: string): Promise<Cart & CartNonNullableFiel
|
|
|
2790
3357
|
/**
|
|
2791
3358
|
* Adds catalog line items to a cart.
|
|
2792
3359
|
*
|
|
2793
|
-
*
|
|
2794
|
-
* The `addToCart()` function returns a Promise that resolves to the updated cart when the specified items have been added.
|
|
3360
|
+
* After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
|
|
2795
3361
|
*
|
|
2796
3362
|
* > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
|
|
2797
3363
|
* @param _id - Cart ID.
|
|
2798
3364
|
* @public
|
|
2799
3365
|
* @requiredField _id
|
|
2800
|
-
* @requiredField options.customLineItems.descriptionLines
|
|
2801
3366
|
* @requiredField options.customLineItems.descriptionLines.name
|
|
3367
|
+
* @requiredField options.customLineItems.descriptionLines.value
|
|
2802
3368
|
* @requiredField options.customLineItems.itemType
|
|
2803
3369
|
* @requiredField options.customLineItems.price
|
|
2804
3370
|
* @requiredField options.customLineItems.productName
|
|
@@ -2811,12 +3377,16 @@ export declare function getCart(_id: string): Promise<Cart & CartNonNullableFiel
|
|
|
2811
3377
|
* @permissionId ECOM.ADMIN_MODIFY_CARTS
|
|
2812
3378
|
* @permissionScope Manage Stores - all permissions
|
|
2813
3379
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3380
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3381
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2814
3382
|
* @permissionScope Manage eCommerce - all permissions
|
|
2815
3383
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2816
3384
|
* @permissionScope Manage Stores - all permissions
|
|
2817
3385
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2818
3386
|
* @permissionScope Manage eCommerce - Admin Permissions
|
|
2819
3387
|
* @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
|
|
3388
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3389
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2820
3390
|
* @permissionScope Manage eCommerce - all permissions
|
|
2821
3391
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2822
3392
|
* @applicableIdentity APP
|
|
@@ -2826,27 +3396,31 @@ export declare function getCart(_id: string): Promise<Cart & CartNonNullableFiel
|
|
|
2826
3396
|
*/
|
|
2827
3397
|
export declare function addToCart(_id: string, options?: AddToCartOptions): Promise<AddToCartResponse & AddToCartResponseNonNullableFields>;
|
|
2828
3398
|
export interface AddToCartOptions {
|
|
2829
|
-
/**
|
|
3399
|
+
/**
|
|
3400
|
+
* Catalog line items.
|
|
3401
|
+
* @maxSize 100
|
|
3402
|
+
*/
|
|
2830
3403
|
lineItems?: LineItem[];
|
|
2831
3404
|
/**
|
|
2832
3405
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2833
3406
|
*
|
|
2834
3407
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2835
3408
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3409
|
+
* @maxSize 100
|
|
2836
3410
|
*/
|
|
2837
3411
|
customLineItems?: CustomLineItem[];
|
|
2838
3412
|
/**
|
|
2839
3413
|
* The business location ID associated with the cart.
|
|
2840
3414
|
* The `businessLocationId` field cannot be passed if one already exists on the cart. To update a cart's business location ID, use the UpdateCart method.
|
|
2841
3415
|
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
3416
|
+
* @format GUID
|
|
2842
3417
|
*/
|
|
2843
3418
|
businessLocationId?: string | null;
|
|
2844
3419
|
}
|
|
2845
3420
|
/**
|
|
2846
3421
|
* Removes line items from the specified cart.
|
|
2847
3422
|
*
|
|
2848
|
-
*
|
|
2849
|
-
* The `removeLineItems()` function returns a Promise that resolves to the updated cart when the line items are removed from the specified cart.
|
|
3423
|
+
* After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
|
|
2850
3424
|
* @public
|
|
2851
3425
|
* @requiredField _id
|
|
2852
3426
|
* @requiredField lineItemIds
|
|
@@ -2855,6 +3429,8 @@ export interface AddToCartOptions {
|
|
|
2855
3429
|
* @permissionId ECOM.MODIFY_CARTS
|
|
2856
3430
|
* @permissionScope Manage Stores - all permissions
|
|
2857
3431
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3432
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3433
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2858
3434
|
* @permissionScope Manage eCommerce - all permissions
|
|
2859
3435
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2860
3436
|
* @applicableIdentity APP
|
|
@@ -2901,20 +3477,24 @@ export interface CreateCheckoutOptions {
|
|
|
2901
3477
|
billingAddress?: Address;
|
|
2902
3478
|
/** Selected shipping option. */
|
|
2903
3479
|
selectedShippingOption?: SelectedShippingOption;
|
|
2904
|
-
/**
|
|
3480
|
+
/**
|
|
3481
|
+
* Mandatory when setting a billing or shipping address if the site visitor isn't logged in.
|
|
3482
|
+
* @format EMAIL
|
|
3483
|
+
*/
|
|
2905
3484
|
email?: string | null;
|
|
2906
3485
|
}
|
|
2907
3486
|
/**
|
|
2908
3487
|
* Removes the coupon from a specified cart.
|
|
2909
3488
|
*
|
|
2910
|
-
*
|
|
2911
|
-
* The `removeCoupon()` function returns a Promise that resolves to the updated cart when the coupon is removed from the specified cart.
|
|
3489
|
+
* After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
|
|
2912
3490
|
* @param _id - Cart ID.
|
|
2913
3491
|
* @public
|
|
2914
3492
|
* @requiredField _id
|
|
2915
3493
|
* @permissionId ECOM.MODIFY_CARTS
|
|
2916
3494
|
* @permissionScope Manage Stores - all permissions
|
|
2917
3495
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3496
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3497
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2918
3498
|
* @permissionScope Manage eCommerce - all permissions
|
|
2919
3499
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2920
3500
|
* @applicableIdentity APP
|
|
@@ -2926,12 +3506,11 @@ export declare function removeCoupon(_id: string): Promise<RemoveCouponResponse
|
|
|
2926
3506
|
/**
|
|
2927
3507
|
* Updates the quantity of one or more line items in a specified cart.
|
|
2928
3508
|
*
|
|
3509
|
+
* After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
|
|
2929
3510
|
*
|
|
2930
|
-
*
|
|
3511
|
+
* This method is only for updating the quantity of line items. To entirely remove a line item from the cart, use `removeLineItems()`. To add a new line item to the cart, use `addToCart()`.
|
|
2931
3512
|
*
|
|
2932
|
-
* This
|
|
2933
|
-
*
|
|
2934
|
-
* This endpoint checks the amount of stock remaining for this line item. If the specified `quantity` is greater than the remaining stock, then the `quantity` returned in the response is the total amount of remaining stock.
|
|
3513
|
+
* This method checks the amount of stock remaining for this line item. If the specified `quantity` is greater than the remaining stock, then the `quantity` returned in the response is the total amount of remaining stock.
|
|
2935
3514
|
* @param _id - Cart ID.
|
|
2936
3515
|
* @param lineItems - Line item IDs and their new quantity.
|
|
2937
3516
|
* @public
|
|
@@ -2940,6 +3519,8 @@ export declare function removeCoupon(_id: string): Promise<RemoveCouponResponse
|
|
|
2940
3519
|
* @permissionId ECOM.MODIFY_CARTS
|
|
2941
3520
|
* @permissionScope Manage Stores - all permissions
|
|
2942
3521
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3522
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3523
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2943
3524
|
* @permissionScope Manage eCommerce - all permissions
|
|
2944
3525
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2945
3526
|
* @applicableIdentity APP
|
|
@@ -3013,6 +3594,8 @@ export interface EstimateTotalsOptions {
|
|
|
3013
3594
|
* @permissionId ECOM.MODIFY_CARTS
|
|
3014
3595
|
* @permissionScope Manage Stores - all permissions
|
|
3015
3596
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3597
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3598
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3016
3599
|
* @permissionScope Manage eCommerce - all permissions
|
|
3017
3600
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3018
3601
|
* @applicableIdentity APP
|
|
@@ -3030,6 +3613,8 @@ export declare function deleteCart(_id: string): Promise<void>;
|
|
|
3030
3613
|
* @permissionId ECOM.MODIFY_CARTS
|
|
3031
3614
|
* @permissionScope Manage Stores - all permissions
|
|
3032
3615
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3616
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
3617
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3033
3618
|
* @permissionScope Manage eCommerce - all permissions
|
|
3034
3619
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3035
3620
|
* @applicableIdentity APP
|