@wix/auto_sdk_ecom_cart 1.0.2 → 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.context.d.ts +2 -1
- package/build/cjs/src/ecom-v1-cart-cart.context.js +0 -1
- package/build/cjs/src/ecom-v1-cart-cart.context.js.map +1 -1
- 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 +16 -13
- package/build/cjs/src/ecom-v1-cart-cart.public.js +0 -1
- package/build/cjs/src/ecom-v1-cart-cart.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-cart-cart.types.d.ts +669 -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 +797 -168
- package/build/cjs/src/ecom-v1-cart-cart.universal.js +35 -16
- package/build/cjs/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/build/es/src/ecom-v1-cart-cart.context.d.ts +2 -1
- package/build/es/src/ecom-v1-cart-cart.context.js +0 -1
- package/build/es/src/ecom-v1-cart-cart.context.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 +16 -13
- package/build/es/src/ecom-v1-cart-cart.public.js +0 -1
- package/build/es/src/ecom-v1-cart-cart.public.js.map +1 -1
- package/build/es/src/ecom-v1-cart-cart.types.d.ts +669 -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 +797 -168
- package/build/es/src/ecom-v1-cart-cart.universal.js +35 -16
- package/build/es/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.context.d.ts +0 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.context.js +0 -1
- package/build/internal/cjs/src/ecom-v1-cart-cart.context.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 -13
- package/build/internal/cjs/src/ecom-v1-cart-cart.public.js +0 -1
- 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 +669 -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 +770 -176
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js +35 -16
- package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-cart-cart.context.d.ts +0 -1
- package/build/internal/es/src/ecom-v1-cart-cart.context.js +0 -1
- package/build/internal/es/src/ecom-v1-cart-cart.context.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 -13
- package/build/internal/es/src/ecom-v1-cart-cart.public.js +0 -1
- 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 +669 -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 +770 -176
- package/build/internal/es/src/ecom-v1-cart-cart.universal.js +35 -16
- 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
|
+
* Note left by the buyer/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
|
/**
|
|
@@ -70,23 +81,36 @@ export interface Cart {
|
|
|
70
81
|
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the [Abandoned Checkout API](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/abandoned-checkout/introduction)
|
|
71
82
|
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
72
83
|
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
84
|
+
* @maxLength 1000
|
|
73
85
|
*/
|
|
74
86
|
overrideCheckoutUrl?: string | null;
|
|
75
87
|
/**
|
|
76
88
|
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
89
|
+
* @format GUID
|
|
77
90
|
* @readonly
|
|
78
91
|
*/
|
|
79
92
|
purchaseFlowId?: string | null;
|
|
80
93
|
/** Selected shipping option. */
|
|
81
94
|
selectedShippingOption?: SelectedShippingOption;
|
|
95
|
+
/**
|
|
96
|
+
* The business location ID associated with the cart.
|
|
97
|
+
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
98
|
+
* @format GUID
|
|
99
|
+
*/
|
|
100
|
+
businessLocationId?: string | null;
|
|
82
101
|
}
|
|
83
102
|
export interface LineItem {
|
|
84
103
|
/**
|
|
85
104
|
* Line item ID.
|
|
105
|
+
* @format GUID
|
|
86
106
|
* @readonly
|
|
87
107
|
*/
|
|
88
108
|
id?: string | null;
|
|
89
|
-
/**
|
|
109
|
+
/**
|
|
110
|
+
* Item quantity.
|
|
111
|
+
* @min 1
|
|
112
|
+
* @max 100000
|
|
113
|
+
*/
|
|
90
114
|
quantity?: number;
|
|
91
115
|
/** 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. */
|
|
92
116
|
catalogReference?: CatalogReference;
|
|
@@ -144,12 +168,9 @@ export interface LineItem {
|
|
|
144
168
|
*/
|
|
145
169
|
itemType?: ItemType;
|
|
146
170
|
/**
|
|
147
|
-
* Type of selected payment option for current item.
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
151
|
-
* + `DEPOSIT_ONLINE` - Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is defined by `lineItem.deposit`.
|
|
152
|
-
* + `MEMBERSHIP_OFFLINE` - Payment for this item can only be performed by using a membership and must be manually redeemed in the dashboard by the site owner. When this option is used, `lineItem.price.amount` is 0.
|
|
171
|
+
* Type of selected payment option for current item.
|
|
172
|
+
*
|
|
173
|
+
* Default: `FULL_PAYMENT_ONLINE`
|
|
153
174
|
* @readonly
|
|
154
175
|
*/
|
|
155
176
|
paymentOption?: PaymentOptionType;
|
|
@@ -163,6 +184,8 @@ export interface LineItem {
|
|
|
163
184
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
164
185
|
* + in most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
165
186
|
* + Used in membership validation.
|
|
187
|
+
* @minLength 1
|
|
188
|
+
* @maxLength 36
|
|
166
189
|
* @readonly
|
|
167
190
|
*/
|
|
168
191
|
rootCatalogItemId?: string | null;
|
|
@@ -178,8 +201,15 @@ export interface LineItem {
|
|
|
178
201
|
depositAmount?: MultiCurrencyPrice;
|
|
179
202
|
/** 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`. */
|
|
180
203
|
selectedMembership?: SelectedMembership;
|
|
204
|
+
/**
|
|
205
|
+
* Delivery profile ID.
|
|
206
|
+
* @format GUID
|
|
207
|
+
* @readonly
|
|
208
|
+
*/
|
|
209
|
+
deliveryProfileId?: string | null;
|
|
181
210
|
/**
|
|
182
211
|
* Tax group ID for this line item.
|
|
212
|
+
* @format GUID
|
|
183
213
|
* @readonly
|
|
184
214
|
*/
|
|
185
215
|
taxGroupId?: string | null;
|
|
@@ -190,6 +220,8 @@ export interface LineItem {
|
|
|
190
220
|
customLineItem?: boolean;
|
|
191
221
|
/**
|
|
192
222
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
223
|
+
* @minLength 1
|
|
224
|
+
* @maxLength 2500
|
|
193
225
|
* @readonly
|
|
194
226
|
*/
|
|
195
227
|
consentRequiredPaymentPolicy?: string | null;
|
|
@@ -210,7 +242,11 @@ export interface LineItem {
|
|
|
210
242
|
}
|
|
211
243
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
212
244
|
export interface CatalogReference {
|
|
213
|
-
/**
|
|
245
|
+
/**
|
|
246
|
+
* ID of the item within the catalog it belongs to.
|
|
247
|
+
* @minLength 1
|
|
248
|
+
* @maxLength 36
|
|
249
|
+
*/
|
|
214
250
|
catalogItemId?: string;
|
|
215
251
|
/**
|
|
216
252
|
* ID of the app providing the catalog.
|
|
@@ -221,6 +257,7 @@ export interface CatalogReference {
|
|
|
221
257
|
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
222
258
|
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
223
259
|
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
260
|
+
* @minLength 1
|
|
224
261
|
*/
|
|
225
262
|
appId?: string;
|
|
226
263
|
/**
|
|
@@ -236,6 +273,8 @@ export interface ProductName {
|
|
|
236
273
|
*
|
|
237
274
|
* Min: 1 character.
|
|
238
275
|
* Max: 200 characters.
|
|
276
|
+
* @minLength 1
|
|
277
|
+
* @maxLength 200
|
|
239
278
|
*/
|
|
240
279
|
original?: string;
|
|
241
280
|
/**
|
|
@@ -244,6 +283,8 @@ export interface ProductName {
|
|
|
244
283
|
* Min: 1 character.
|
|
245
284
|
* Max: 400 characters.
|
|
246
285
|
* Default: Same as `original`.
|
|
286
|
+
* @minLength 1
|
|
287
|
+
* @maxLength 400
|
|
247
288
|
*/
|
|
248
289
|
translated?: string | null;
|
|
249
290
|
}
|
|
@@ -254,11 +295,15 @@ export interface PageUrlV2 {
|
|
|
254
295
|
url?: string | null;
|
|
255
296
|
}
|
|
256
297
|
export interface MultiCurrencyPrice {
|
|
257
|
-
/**
|
|
298
|
+
/**
|
|
299
|
+
* Amount.
|
|
300
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
301
|
+
*/
|
|
258
302
|
amount?: string;
|
|
259
303
|
/**
|
|
260
304
|
* Converted amount.
|
|
261
305
|
* @readonly
|
|
306
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
262
307
|
*/
|
|
263
308
|
convertedAmount?: string;
|
|
264
309
|
/**
|
|
@@ -291,32 +336,44 @@ export interface DescriptionLineValueOneOf {
|
|
|
291
336
|
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
292
337
|
}
|
|
293
338
|
export interface DescriptionLineName {
|
|
294
|
-
/**
|
|
339
|
+
/**
|
|
340
|
+
* 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).
|
|
341
|
+
* @maxLength 100
|
|
342
|
+
*/
|
|
295
343
|
original?: string;
|
|
296
344
|
/**
|
|
297
345
|
* Description line name translated into the buyer's language.
|
|
298
346
|
*
|
|
299
347
|
* Default: Same as `original`.
|
|
348
|
+
* @maxLength 200
|
|
300
349
|
*/
|
|
301
350
|
translated?: string | null;
|
|
302
351
|
}
|
|
303
352
|
export interface PlainTextValue {
|
|
304
|
-
/**
|
|
353
|
+
/**
|
|
354
|
+
* 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).
|
|
355
|
+
* @maxLength 600
|
|
356
|
+
*/
|
|
305
357
|
original?: string;
|
|
306
358
|
/**
|
|
307
359
|
* Description line plain text value translated into the buyer's language.
|
|
308
360
|
*
|
|
309
361
|
* Default: Same as `original`.
|
|
362
|
+
* @maxLength 600
|
|
310
363
|
*/
|
|
311
364
|
translated?: string | null;
|
|
312
365
|
}
|
|
313
366
|
export interface Color {
|
|
314
|
-
/**
|
|
367
|
+
/**
|
|
368
|
+
* 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).
|
|
369
|
+
* @maxLength 500
|
|
370
|
+
*/
|
|
315
371
|
original?: string;
|
|
316
372
|
/**
|
|
317
373
|
* Description line color name translated into the buyer's language.
|
|
318
374
|
*
|
|
319
375
|
* Default: Same as `original`.
|
|
376
|
+
* @maxLength 500
|
|
320
377
|
*/
|
|
321
378
|
translated?: string | null;
|
|
322
379
|
/** HEX or RGB color code for display. */
|
|
@@ -381,7 +438,10 @@ export declare enum ItemAvailabilityStatus {
|
|
|
381
438
|
export interface PhysicalProperties {
|
|
382
439
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
383
440
|
weight?: number | null;
|
|
384
|
-
/**
|
|
441
|
+
/**
|
|
442
|
+
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
443
|
+
* @maxLength 40
|
|
444
|
+
*/
|
|
385
445
|
sku?: string | null;
|
|
386
446
|
/** Whether this line item is shippable. */
|
|
387
447
|
shippable?: boolean;
|
|
@@ -434,11 +494,16 @@ export interface SubscriptionSettings {
|
|
|
434
494
|
*
|
|
435
495
|
* Default: `1`.
|
|
436
496
|
* If SubscriptionFrequency is Day the minimum interval is 7
|
|
497
|
+
* @min 1
|
|
498
|
+
* @max 50
|
|
437
499
|
*/
|
|
438
500
|
interval?: number | null;
|
|
439
501
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
440
502
|
autoRenewal?: boolean;
|
|
441
|
-
/**
|
|
503
|
+
/**
|
|
504
|
+
* Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
|
|
505
|
+
* @min 1
|
|
506
|
+
*/
|
|
442
507
|
billingCycles?: number | null;
|
|
443
508
|
}
|
|
444
509
|
/** Frequency unit of recurring payment */
|
|
@@ -452,29 +517,53 @@ export declare enum SubscriptionFrequency {
|
|
|
452
517
|
export interface FreeTrialPeriod {
|
|
453
518
|
/** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
|
|
454
519
|
frequency?: SubscriptionFrequency;
|
|
455
|
-
/**
|
|
520
|
+
/**
|
|
521
|
+
* interval of period
|
|
522
|
+
* @min 1
|
|
523
|
+
* @max 50
|
|
524
|
+
*/
|
|
456
525
|
interval?: number;
|
|
457
526
|
}
|
|
458
527
|
export interface Title {
|
|
459
|
-
/**
|
|
528
|
+
/**
|
|
529
|
+
* 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).
|
|
530
|
+
* @minLength 1
|
|
531
|
+
* @maxLength 150
|
|
532
|
+
*/
|
|
460
533
|
original?: string;
|
|
461
534
|
/**
|
|
462
535
|
* Subscription option name translated into the buyer's language.
|
|
463
536
|
*
|
|
464
537
|
* Default: Same as `original`.
|
|
538
|
+
* @minLength 1
|
|
539
|
+
* @maxLength 150
|
|
465
540
|
*/
|
|
466
541
|
translated?: string | null;
|
|
467
542
|
}
|
|
468
543
|
export interface Description {
|
|
469
|
-
/**
|
|
544
|
+
/**
|
|
545
|
+
* Subscription option description.
|
|
546
|
+
* @maxLength 500
|
|
547
|
+
*/
|
|
470
548
|
original?: string;
|
|
471
|
-
/**
|
|
549
|
+
/**
|
|
550
|
+
* Translated subscription option description.
|
|
551
|
+
* @maxLength 500
|
|
552
|
+
*/
|
|
472
553
|
translated?: string | null;
|
|
473
554
|
}
|
|
474
555
|
export interface SecuredMedia {
|
|
475
|
-
/**
|
|
556
|
+
/**
|
|
557
|
+
* Media ID in Wix Media Manager.
|
|
558
|
+
* @minLength 1
|
|
559
|
+
* @maxLength 100
|
|
560
|
+
*/
|
|
476
561
|
id?: string;
|
|
477
|
-
/**
|
|
562
|
+
/**
|
|
563
|
+
* Original filename.
|
|
564
|
+
* @minLength 1
|
|
565
|
+
* @maxLength 1000
|
|
566
|
+
*/
|
|
478
567
|
fileName?: string;
|
|
479
568
|
/** File type. */
|
|
480
569
|
fileType?: FileType;
|
|
@@ -506,34 +595,60 @@ export interface ServiceProperties {
|
|
|
506
595
|
* For example, the start time of a class.
|
|
507
596
|
*/
|
|
508
597
|
scheduledDate?: Date | null;
|
|
509
|
-
/**
|
|
598
|
+
/**
|
|
599
|
+
* The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
|
|
600
|
+
* @min 1
|
|
601
|
+
* @max 10000
|
|
602
|
+
*/
|
|
510
603
|
numberOfParticipants?: number | null;
|
|
511
604
|
}
|
|
512
605
|
export interface PriceDescription {
|
|
513
|
-
/**
|
|
606
|
+
/**
|
|
607
|
+
* __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).
|
|
608
|
+
* @minLength 1
|
|
609
|
+
* @maxLength 100
|
|
610
|
+
*/
|
|
514
611
|
original?: string;
|
|
515
612
|
/**
|
|
516
613
|
* Price description translated into the buyer's language.
|
|
517
614
|
*
|
|
518
615
|
* Default: Same as `original`.
|
|
616
|
+
* @minLength 1
|
|
617
|
+
* @maxLength 100
|
|
519
618
|
*/
|
|
520
619
|
translated?: string | null;
|
|
521
620
|
}
|
|
522
621
|
/** Selected Membership */
|
|
523
622
|
export interface SelectedMembership {
|
|
524
|
-
/**
|
|
623
|
+
/**
|
|
624
|
+
* Membership ID.
|
|
625
|
+
* @minLength 1
|
|
626
|
+
* @maxLength 100
|
|
627
|
+
*/
|
|
525
628
|
id?: string;
|
|
526
|
-
/**
|
|
629
|
+
/**
|
|
630
|
+
* ID of the app providing this payment option.
|
|
631
|
+
* @format GUID
|
|
632
|
+
*/
|
|
527
633
|
appId?: string;
|
|
528
634
|
}
|
|
529
635
|
export interface CatalogOverrideFields {
|
|
530
636
|
/** Item name. */
|
|
531
637
|
productName?: ProductName;
|
|
532
|
-
/**
|
|
638
|
+
/**
|
|
639
|
+
* Item price **after** discounts.
|
|
640
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
641
|
+
*/
|
|
533
642
|
price?: string | null;
|
|
534
|
-
/**
|
|
643
|
+
/**
|
|
644
|
+
* Item price **before** discounts.
|
|
645
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
646
|
+
*/
|
|
535
647
|
fullPrice?: string | null;
|
|
536
|
-
/**
|
|
648
|
+
/**
|
|
649
|
+
* Item description lines. Used when displaying the line item to customers.
|
|
650
|
+
* @maxSize 20
|
|
651
|
+
*/
|
|
537
652
|
descriptionLines?: DescriptionLine[];
|
|
538
653
|
/** Physical properties of the item. */
|
|
539
654
|
physicalProperties?: PhysicalProperties;
|
|
@@ -541,7 +656,11 @@ export interface CatalogOverrideFields {
|
|
|
541
656
|
image?: Image;
|
|
542
657
|
/** Payment method selected for the item. */
|
|
543
658
|
paymentOption?: PaymentOption;
|
|
544
|
-
/**
|
|
659
|
+
/**
|
|
660
|
+
* Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
|
|
661
|
+
* @format DECIMAL_VALUE
|
|
662
|
+
* @decimalValue options { gt:0, lte:999999999, maxScale:3 }
|
|
663
|
+
*/
|
|
545
664
|
depositAmount?: string | null;
|
|
546
665
|
/**
|
|
547
666
|
* Whether to save the payment method on the order.
|
|
@@ -564,11 +683,9 @@ export interface Image {
|
|
|
564
683
|
}
|
|
565
684
|
export interface PaymentOption {
|
|
566
685
|
/**
|
|
567
|
-
*
|
|
568
|
-
*
|
|
569
|
-
*
|
|
570
|
-
* + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
|
|
571
|
-
* + `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`.
|
|
686
|
+
* Type of selected payment option for current item.
|
|
687
|
+
*
|
|
688
|
+
* Default: `FULL_PAYMENT_ONLINE`
|
|
572
689
|
*/
|
|
573
690
|
value?: PaymentOptionType;
|
|
574
691
|
}
|
|
@@ -599,47 +716,67 @@ export interface ExtendedFields {
|
|
|
599
716
|
namespaces?: Record<string, Record<string, any>>;
|
|
600
717
|
}
|
|
601
718
|
export interface Policy {
|
|
602
|
-
/**
|
|
719
|
+
/**
|
|
720
|
+
* Policy title - should be translated
|
|
721
|
+
* @minLength 1
|
|
722
|
+
* @maxLength 29
|
|
723
|
+
*/
|
|
603
724
|
title?: string | null;
|
|
604
|
-
/**
|
|
725
|
+
/**
|
|
726
|
+
* Policy content - should be translated
|
|
727
|
+
* @minLength 1
|
|
728
|
+
* @maxLength 3000
|
|
729
|
+
*/
|
|
605
730
|
content?: string;
|
|
606
731
|
}
|
|
607
732
|
/** Buyer Info */
|
|
608
733
|
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
609
734
|
/**
|
|
610
735
|
* Visitor ID - if the buyer is **not** a site member.
|
|
736
|
+
* @format GUID
|
|
611
737
|
* @readonly
|
|
612
738
|
*/
|
|
613
739
|
visitorId?: string;
|
|
614
740
|
/**
|
|
615
741
|
* Member ID - if the buyer is a site member.
|
|
742
|
+
* @format GUID
|
|
616
743
|
* @readonly
|
|
617
744
|
*/
|
|
618
745
|
memberId?: string;
|
|
619
746
|
/**
|
|
620
747
|
* User ID - if the buyer (or cart owner) is a Wix user.
|
|
748
|
+
* @format GUID
|
|
621
749
|
* @readonly
|
|
622
750
|
*/
|
|
623
751
|
userId?: string;
|
|
624
|
-
/**
|
|
752
|
+
/**
|
|
753
|
+
* Contact ID. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
|
|
754
|
+
* @format GUID
|
|
755
|
+
*/
|
|
625
756
|
contactId?: string | null;
|
|
626
|
-
/**
|
|
757
|
+
/**
|
|
758
|
+
* Buyer email address.
|
|
759
|
+
* @format EMAIL
|
|
760
|
+
*/
|
|
627
761
|
email?: string | null;
|
|
628
762
|
}
|
|
629
763
|
/** @oneof */
|
|
630
764
|
export interface BuyerInfoIdOneOf {
|
|
631
765
|
/**
|
|
632
766
|
* Visitor ID - if the buyer is **not** a site member.
|
|
767
|
+
* @format GUID
|
|
633
768
|
* @readonly
|
|
634
769
|
*/
|
|
635
770
|
visitorId?: string;
|
|
636
771
|
/**
|
|
637
772
|
* Member ID - if the buyer is a site member.
|
|
773
|
+
* @format GUID
|
|
638
774
|
* @readonly
|
|
639
775
|
*/
|
|
640
776
|
memberId?: string;
|
|
641
777
|
/**
|
|
642
778
|
* User ID - if the buyer (or cart owner) is a Wix user.
|
|
779
|
+
* @format GUID
|
|
643
780
|
* @readonly
|
|
644
781
|
*/
|
|
645
782
|
userId?: string;
|
|
@@ -676,7 +813,10 @@ export interface MerchantDiscount {
|
|
|
676
813
|
amount?: MultiCurrencyPrice;
|
|
677
814
|
}
|
|
678
815
|
export interface DiscountRule {
|
|
679
|
-
/**
|
|
816
|
+
/**
|
|
817
|
+
* Discount rule ID
|
|
818
|
+
* @format GUID
|
|
819
|
+
*/
|
|
680
820
|
id?: string;
|
|
681
821
|
/** Discount rule name */
|
|
682
822
|
name?: DiscountRuleName;
|
|
@@ -684,9 +824,17 @@ export interface DiscountRule {
|
|
|
684
824
|
amount?: MultiCurrencyPrice;
|
|
685
825
|
}
|
|
686
826
|
export interface DiscountRuleName {
|
|
687
|
-
/**
|
|
827
|
+
/**
|
|
828
|
+
* Original discount rule name (in site's default language).
|
|
829
|
+
* @minLength 1
|
|
830
|
+
* @maxLength 256
|
|
831
|
+
*/
|
|
688
832
|
original?: string;
|
|
689
|
-
/**
|
|
833
|
+
/**
|
|
834
|
+
* Translated discount rule name according to buyer language. Defaults to `original` when not provided.
|
|
835
|
+
* @minLength 1
|
|
836
|
+
* @maxLength 500
|
|
837
|
+
*/
|
|
690
838
|
translated?: string | null;
|
|
691
839
|
}
|
|
692
840
|
export declare enum DiscountType {
|
|
@@ -706,19 +854,37 @@ export interface AddressWithContact {
|
|
|
706
854
|
}
|
|
707
855
|
/** Physical address */
|
|
708
856
|
export interface Address {
|
|
709
|
-
/**
|
|
857
|
+
/**
|
|
858
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
859
|
+
* @format COUNTRY
|
|
860
|
+
*/
|
|
710
861
|
country?: string | null;
|
|
711
|
-
/**
|
|
862
|
+
/**
|
|
863
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
864
|
+
* @maxLength 50
|
|
865
|
+
*/
|
|
712
866
|
subdivision?: string | null;
|
|
713
|
-
/**
|
|
867
|
+
/**
|
|
868
|
+
* City name.
|
|
869
|
+
* @maxLength 50
|
|
870
|
+
*/
|
|
714
871
|
city?: string | null;
|
|
715
|
-
/**
|
|
872
|
+
/**
|
|
873
|
+
* Postal or zip code.
|
|
874
|
+
* @maxLength 50
|
|
875
|
+
*/
|
|
716
876
|
postalCode?: string | null;
|
|
717
877
|
/** Street address. */
|
|
718
878
|
streetAddress?: StreetAddress;
|
|
719
|
-
/**
|
|
879
|
+
/**
|
|
880
|
+
* Main address line (usually street name and number).
|
|
881
|
+
* @maxLength 150
|
|
882
|
+
*/
|
|
720
883
|
addressLine?: string | null;
|
|
721
|
-
/**
|
|
884
|
+
/**
|
|
885
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
886
|
+
* @maxLength 100
|
|
887
|
+
*/
|
|
722
888
|
addressLine2?: string | null;
|
|
723
889
|
/**
|
|
724
890
|
* Country's full name.
|
|
@@ -745,13 +911,25 @@ export interface AddressLocation {
|
|
|
745
911
|
}
|
|
746
912
|
/** Full contact details for an address */
|
|
747
913
|
export interface FullAddressContactDetails {
|
|
748
|
-
/**
|
|
914
|
+
/**
|
|
915
|
+
* First name.
|
|
916
|
+
* @maxLength 100
|
|
917
|
+
*/
|
|
749
918
|
firstName?: string | null;
|
|
750
|
-
/**
|
|
919
|
+
/**
|
|
920
|
+
* Last name.
|
|
921
|
+
* @maxLength 100
|
|
922
|
+
*/
|
|
751
923
|
lastName?: string | null;
|
|
752
|
-
/**
|
|
924
|
+
/**
|
|
925
|
+
* Phone number.
|
|
926
|
+
* @format PHONE
|
|
927
|
+
*/
|
|
753
928
|
phone?: string | null;
|
|
754
|
-
/**
|
|
929
|
+
/**
|
|
930
|
+
* Company name.
|
|
931
|
+
* @maxLength 1000
|
|
932
|
+
*/
|
|
755
933
|
company?: string | null;
|
|
756
934
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
757
935
|
vatId?: VatId;
|
|
@@ -777,9 +955,16 @@ export declare enum VatType {
|
|
|
777
955
|
CNPJ = "CNPJ"
|
|
778
956
|
}
|
|
779
957
|
export interface SelectedShippingOption {
|
|
780
|
-
/**
|
|
958
|
+
/**
|
|
959
|
+
* Carrier ID.
|
|
960
|
+
* @format GUID
|
|
961
|
+
*/
|
|
781
962
|
carrierId?: string | null;
|
|
782
|
-
/**
|
|
963
|
+
/**
|
|
964
|
+
* Selected shipping option code. For example, "usps_std_overnight".
|
|
965
|
+
* @minLength 1
|
|
966
|
+
* @maxLength 100
|
|
967
|
+
*/
|
|
783
968
|
code?: string;
|
|
784
969
|
}
|
|
785
970
|
export interface GetCurrentCartRequest {
|
|
@@ -793,22 +978,36 @@ export interface UpdateCartRequest {
|
|
|
793
978
|
cartInfo?: Cart;
|
|
794
979
|
/** Coupon code. For more information, see [Coupons API](https://dev.wix.com/api/rest/wix-coupons/coupons/introduction). */
|
|
795
980
|
couponCode?: string | null;
|
|
796
|
-
/**
|
|
981
|
+
/**
|
|
982
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
|
|
983
|
+
* @maxSize 100
|
|
984
|
+
*/
|
|
797
985
|
merchantDiscounts?: MerchantDiscountInput[];
|
|
798
|
-
/**
|
|
986
|
+
/**
|
|
987
|
+
* Catalog line items.
|
|
988
|
+
* @maxSize 300
|
|
989
|
+
*/
|
|
799
990
|
lineItems?: LineItem[];
|
|
800
991
|
/**
|
|
801
992
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
802
993
|
*
|
|
803
994
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
804
995
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
996
|
+
* @maxSize 300
|
|
805
997
|
*/
|
|
806
998
|
customLineItems?: CustomLineItem[];
|
|
807
999
|
}
|
|
808
1000
|
export interface MerchantDiscountInput {
|
|
809
|
-
/**
|
|
1001
|
+
/**
|
|
1002
|
+
* Discount amount.
|
|
1003
|
+
* @decimalValue options { gte:0 }
|
|
1004
|
+
*/
|
|
810
1005
|
amount?: string;
|
|
811
|
-
/**
|
|
1006
|
+
/**
|
|
1007
|
+
* IDs of line items the discount applies to.
|
|
1008
|
+
* @format GUID
|
|
1009
|
+
* @maxSize 300
|
|
1010
|
+
*/
|
|
812
1011
|
lineItemIds?: string[];
|
|
813
1012
|
}
|
|
814
1013
|
export interface CustomLineItem {
|
|
@@ -817,17 +1016,24 @@ export interface CustomLineItem {
|
|
|
817
1016
|
*
|
|
818
1017
|
* Min: `1`
|
|
819
1018
|
* Max: `100000`
|
|
1019
|
+
* @min 1
|
|
1020
|
+
* @max 100000
|
|
820
1021
|
*/
|
|
821
1022
|
quantity?: number;
|
|
822
1023
|
/**
|
|
823
1024
|
* Custom line item price.
|
|
824
1025
|
*
|
|
825
1026
|
* Must be a number or a decimal without symbols.
|
|
1027
|
+
* @format DECIMAL_VALUE
|
|
1028
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
826
1029
|
*/
|
|
827
1030
|
price?: string;
|
|
828
1031
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
829
1032
|
priceDescription?: PriceDescription;
|
|
830
|
-
/**
|
|
1033
|
+
/**
|
|
1034
|
+
* Custom line item description lines. Used for display purposes for the cart, checkout and order.
|
|
1035
|
+
* @maxSize 10
|
|
1036
|
+
*/
|
|
831
1037
|
descriptionLines?: DescriptionLine[];
|
|
832
1038
|
/** Custom line item's media. */
|
|
833
1039
|
media?: Image;
|
|
@@ -835,9 +1041,13 @@ export interface CustomLineItem {
|
|
|
835
1041
|
* Custom line item ID. If passed, `id` must be unique.
|
|
836
1042
|
*
|
|
837
1043
|
* Default: auto-generated ID
|
|
1044
|
+
* @format GUID
|
|
838
1045
|
*/
|
|
839
1046
|
id?: string | null;
|
|
840
|
-
/**
|
|
1047
|
+
/**
|
|
1048
|
+
* Tax group ID for this custom line item.
|
|
1049
|
+
* @format GUID
|
|
1050
|
+
*/
|
|
841
1051
|
taxGroupId?: string | null;
|
|
842
1052
|
/** Name of the item or product. */
|
|
843
1053
|
productName?: ProductName;
|
|
@@ -845,11 +1055,15 @@ export interface CustomLineItem {
|
|
|
845
1055
|
url?: PageUrlV2;
|
|
846
1056
|
/** Item type. Either a preset type or custom. */
|
|
847
1057
|
itemType?: ItemType;
|
|
848
|
-
/**
|
|
1058
|
+
/**
|
|
1059
|
+
* Item price **before** catalog-defined discount. Defaults to `price` when not provided.
|
|
1060
|
+
* @format DECIMAL_VALUE
|
|
1061
|
+
*/
|
|
849
1062
|
fullPrice?: string | null;
|
|
850
1063
|
/**
|
|
851
1064
|
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
852
1065
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
1066
|
+
* @max 100000
|
|
853
1067
|
*/
|
|
854
1068
|
quantityAvailable?: number | null;
|
|
855
1069
|
/** Physical properties of the item. */
|
|
@@ -874,6 +1088,8 @@ export interface CustomLineItem {
|
|
|
874
1088
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
875
1089
|
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
876
1090
|
* + Used in membership validation.
|
|
1091
|
+
* @minLength 1
|
|
1092
|
+
* @maxLength 36
|
|
877
1093
|
*/
|
|
878
1094
|
rootCatalogItemId?: string | null;
|
|
879
1095
|
/**
|
|
@@ -881,12 +1097,20 @@ export interface CustomLineItem {
|
|
|
881
1097
|
*
|
|
882
1098
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
883
1099
|
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
1100
|
+
* @format DECIMAL_VALUE
|
|
884
1101
|
*/
|
|
885
1102
|
depositAmount?: string | null;
|
|
1103
|
+
/**
|
|
1104
|
+
* Delivery profile ID.
|
|
1105
|
+
* @format GUID
|
|
1106
|
+
*/
|
|
1107
|
+
deliveryProfileId?: string | null;
|
|
886
1108
|
/** 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. */
|
|
887
1109
|
catalogReference?: CatalogReference;
|
|
888
1110
|
/**
|
|
889
1111
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
1112
|
+
* @minLength 1
|
|
1113
|
+
* @maxLength 1000
|
|
890
1114
|
* @readonly
|
|
891
1115
|
*/
|
|
892
1116
|
consentRequiredPaymentPolicy?: string | null;
|
|
@@ -903,28 +1127,43 @@ export interface UpdateCartResponse {
|
|
|
903
1127
|
cart?: Cart;
|
|
904
1128
|
}
|
|
905
1129
|
export interface AddToCurrentCartRequest {
|
|
906
|
-
/**
|
|
1130
|
+
/**
|
|
1131
|
+
* Catalog line items.
|
|
1132
|
+
* @maxSize 100
|
|
1133
|
+
*/
|
|
907
1134
|
lineItems?: LineItem[];
|
|
908
1135
|
/**
|
|
909
1136
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
910
1137
|
*
|
|
911
1138
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
912
1139
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
1140
|
+
* @maxSize 100
|
|
913
1141
|
*/
|
|
914
1142
|
customLineItems?: CustomLineItem[];
|
|
1143
|
+
/**
|
|
1144
|
+
* Business location ID.
|
|
1145
|
+
* To update a cart's business location ID, use the UpdateCart method.
|
|
1146
|
+
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1147
|
+
* @format GUID
|
|
1148
|
+
*/
|
|
1149
|
+
businessLocationId?: string | null;
|
|
915
1150
|
}
|
|
916
1151
|
export interface AddToCartResponse {
|
|
917
1152
|
/** Updated cart. */
|
|
918
1153
|
cart?: Cart;
|
|
919
1154
|
}
|
|
920
1155
|
export interface AddToCurrentCartAndEstimateTotalsRequest {
|
|
921
|
-
/**
|
|
1156
|
+
/**
|
|
1157
|
+
* Catalog line items.
|
|
1158
|
+
* @maxSize 100
|
|
1159
|
+
*/
|
|
922
1160
|
lineItems?: LineItem[];
|
|
923
1161
|
/**
|
|
924
1162
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
925
1163
|
*
|
|
926
1164
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
927
1165
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
1166
|
+
* @maxSize 100
|
|
928
1167
|
*/
|
|
929
1168
|
customLineItems?: CustomLineItem[];
|
|
930
1169
|
/** Selected shipping option. */
|
|
@@ -949,15 +1188,31 @@ export interface AddToCurrentCartAndEstimateTotalsRequest {
|
|
|
949
1188
|
calculateShipping?: boolean | null;
|
|
950
1189
|
}
|
|
951
1190
|
export interface SelectedMemberships {
|
|
952
|
-
/**
|
|
1191
|
+
/**
|
|
1192
|
+
* Selected memberships.
|
|
1193
|
+
* @maxSize 300
|
|
1194
|
+
*/
|
|
953
1195
|
memberships?: HostSelectedMembership[];
|
|
954
1196
|
}
|
|
955
1197
|
export interface HostSelectedMembership {
|
|
956
|
-
/**
|
|
1198
|
+
/**
|
|
1199
|
+
* Membership ID.
|
|
1200
|
+
* @minLength 1
|
|
1201
|
+
* @maxLength 100
|
|
1202
|
+
*/
|
|
957
1203
|
id?: string;
|
|
958
|
-
/**
|
|
1204
|
+
/**
|
|
1205
|
+
* ID of the app providing this payment option.
|
|
1206
|
+
* @format GUID
|
|
1207
|
+
*/
|
|
959
1208
|
appId?: string;
|
|
960
|
-
/**
|
|
1209
|
+
/**
|
|
1210
|
+
* IDs of the line items this membership applies to.
|
|
1211
|
+
* @minSize 1
|
|
1212
|
+
* @maxSize 300
|
|
1213
|
+
* @minLength 1
|
|
1214
|
+
* @maxLength 100
|
|
1215
|
+
*/
|
|
961
1216
|
lineItemIds?: string[];
|
|
962
1217
|
}
|
|
963
1218
|
export interface EstimateTotalsResponse {
|
|
@@ -979,7 +1234,10 @@ export interface EstimateTotalsResponse {
|
|
|
979
1234
|
calculationErrors?: CalculationErrors;
|
|
980
1235
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
981
1236
|
weightUnit?: WeightUnit;
|
|
982
|
-
/**
|
|
1237
|
+
/**
|
|
1238
|
+
* Currency used for pricing in this store.
|
|
1239
|
+
* @format CURRENCY
|
|
1240
|
+
*/
|
|
983
1241
|
currency?: string;
|
|
984
1242
|
/**
|
|
985
1243
|
* Minimal amount to pay in order to place the order.
|
|
@@ -993,7 +1251,10 @@ export interface EstimateTotalsResponse {
|
|
|
993
1251
|
payLater?: PriceSummary;
|
|
994
1252
|
/** Information about valid and invalid memberships, and which ones are selected for usage. */
|
|
995
1253
|
membershipOptions?: MembershipOptions;
|
|
996
|
-
/**
|
|
1254
|
+
/**
|
|
1255
|
+
* Additional fees
|
|
1256
|
+
* @maxSize 100
|
|
1257
|
+
*/
|
|
997
1258
|
additionalFees?: AdditionalFee[];
|
|
998
1259
|
/**
|
|
999
1260
|
* List of validation violations raised by the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
|
|
@@ -1036,7 +1297,10 @@ export interface LineItemPricesData {
|
|
|
1036
1297
|
export interface ItemTaxFullDetails {
|
|
1037
1298
|
/** Amount for which tax is calculated. */
|
|
1038
1299
|
taxableAmount?: MultiCurrencyPrice;
|
|
1039
|
-
/**
|
|
1300
|
+
/**
|
|
1301
|
+
* Tax rate %, as a decimal point between 0 and 1.
|
|
1302
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
1303
|
+
*/
|
|
1040
1304
|
taxRate?: string;
|
|
1041
1305
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
1042
1306
|
totalTax?: MultiCurrencyPrice;
|
|
@@ -1048,9 +1312,15 @@ export interface ItemTaxFullDetails {
|
|
|
1048
1312
|
rateBreakdown?: TaxRateBreakdown[];
|
|
1049
1313
|
}
|
|
1050
1314
|
export interface TaxRateBreakdown {
|
|
1051
|
-
/**
|
|
1315
|
+
/**
|
|
1316
|
+
* Name of tax against which the calculation was performed.
|
|
1317
|
+
* @maxLength 100
|
|
1318
|
+
*/
|
|
1052
1319
|
name?: string;
|
|
1053
|
-
/**
|
|
1320
|
+
/**
|
|
1321
|
+
* Rate at which this tax detail was calculated.
|
|
1322
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
1323
|
+
*/
|
|
1054
1324
|
rate?: string;
|
|
1055
1325
|
/** Amount of tax for this tax detail. */
|
|
1056
1326
|
tax?: MultiCurrencyPrice;
|
|
@@ -1060,21 +1330,31 @@ export interface TaxRateBreakdown {
|
|
|
1060
1330
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
1061
1331
|
*/
|
|
1062
1332
|
export interface TaxBreakdown {
|
|
1063
|
-
/**
|
|
1333
|
+
/**
|
|
1334
|
+
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
1335
|
+
* @maxLength 200
|
|
1336
|
+
*/
|
|
1064
1337
|
jurisdiction?: string | null;
|
|
1065
1338
|
/** The amount of this line item price that was considered nontaxable. (Decimal value) */
|
|
1066
1339
|
nonTaxableAmount?: MultiCurrencyPrice;
|
|
1067
|
-
/**
|
|
1340
|
+
/**
|
|
1341
|
+
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
|
|
1342
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
1343
|
+
*/
|
|
1068
1344
|
rate?: string | null;
|
|
1069
1345
|
/** The amount of tax estimated for this line item. (Decimal value) */
|
|
1070
1346
|
taxAmount?: MultiCurrencyPrice;
|
|
1071
1347
|
/** The taxable amount of this line item. */
|
|
1072
1348
|
taxableAmount?: MultiCurrencyPrice;
|
|
1073
|
-
/**
|
|
1349
|
+
/**
|
|
1350
|
+
* The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
|
|
1351
|
+
* @maxLength 200
|
|
1352
|
+
*/
|
|
1074
1353
|
taxType?: string | null;
|
|
1075
1354
|
/**
|
|
1076
1355
|
* The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
|
|
1077
1356
|
* This name should be explicit enough to allow the merchant to understand what tax was calculated.
|
|
1357
|
+
* @maxLength 200
|
|
1078
1358
|
*/
|
|
1079
1359
|
taxName?: string | null;
|
|
1080
1360
|
/** The type of the jurisdiction in which this tax detail applies. */
|
|
@@ -1113,11 +1393,16 @@ export interface GiftCard {
|
|
|
1113
1393
|
obfuscatedCode?: string;
|
|
1114
1394
|
/** Gift card value. */
|
|
1115
1395
|
amount?: MultiCurrencyPrice;
|
|
1116
|
-
/**
|
|
1396
|
+
/**
|
|
1397
|
+
* App ID of the gift card provider.
|
|
1398
|
+
* @format GUID
|
|
1399
|
+
*/
|
|
1117
1400
|
appId?: string;
|
|
1118
1401
|
/**
|
|
1119
1402
|
* External ID in the gift card provider's system.
|
|
1120
1403
|
* Used for integration and tracking across different platforms.
|
|
1404
|
+
* @minLength 1
|
|
1405
|
+
* @maxLength 50
|
|
1121
1406
|
*/
|
|
1122
1407
|
externalId?: string | null;
|
|
1123
1408
|
}
|
|
@@ -1194,15 +1479,27 @@ export interface ApplicationError {
|
|
|
1194
1479
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1195
1480
|
*/
|
|
1196
1481
|
export interface AggregatedTaxBreakdown {
|
|
1197
|
-
/**
|
|
1482
|
+
/**
|
|
1483
|
+
* The name of the tax against which this tax amount was calculated.
|
|
1484
|
+
* @maxLength 200
|
|
1485
|
+
*/
|
|
1198
1486
|
taxName?: string;
|
|
1199
|
-
/**
|
|
1487
|
+
/**
|
|
1488
|
+
* The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
|
|
1489
|
+
* @maxLength 200
|
|
1490
|
+
*/
|
|
1200
1491
|
taxType?: string;
|
|
1201
|
-
/**
|
|
1492
|
+
/**
|
|
1493
|
+
* The name of the jurisdiction in which this tax detail applies.
|
|
1494
|
+
* @maxLength 200
|
|
1495
|
+
*/
|
|
1202
1496
|
jurisdiction?: string;
|
|
1203
1497
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1204
1498
|
jurisdictionTypeEnum?: JurisdictionType;
|
|
1205
|
-
/**
|
|
1499
|
+
/**
|
|
1500
|
+
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
|
|
1501
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
1502
|
+
*/
|
|
1206
1503
|
rate?: string;
|
|
1207
1504
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1208
1505
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
@@ -1218,18 +1515,26 @@ export interface ShippingInformation {
|
|
|
1218
1515
|
export interface ShippingRegion {
|
|
1219
1516
|
/**
|
|
1220
1517
|
* Shipping region ID.
|
|
1518
|
+
* @format GUID
|
|
1221
1519
|
* @readonly
|
|
1222
1520
|
*/
|
|
1223
1521
|
id?: string;
|
|
1224
|
-
/**
|
|
1522
|
+
/**
|
|
1523
|
+
* Shipping region name.
|
|
1524
|
+
* @maxLength 100
|
|
1525
|
+
*/
|
|
1225
1526
|
name?: string;
|
|
1226
1527
|
}
|
|
1227
1528
|
export interface SelectedCarrierServiceOption {
|
|
1228
|
-
/**
|
|
1529
|
+
/**
|
|
1530
|
+
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1531
|
+
* @maxLength 100
|
|
1532
|
+
*/
|
|
1229
1533
|
code?: string;
|
|
1230
1534
|
/**
|
|
1231
1535
|
* Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
|
|
1232
1536
|
* For example, "Standard" or "First-Class Package International".
|
|
1537
|
+
* @maxLength 250
|
|
1233
1538
|
* @readonly
|
|
1234
1539
|
*/
|
|
1235
1540
|
title?: string;
|
|
@@ -1250,17 +1555,29 @@ export interface SelectedCarrierServiceOption {
|
|
|
1250
1555
|
requestedShippingOption?: boolean;
|
|
1251
1556
|
/** Other charges */
|
|
1252
1557
|
otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
|
|
1253
|
-
/**
|
|
1558
|
+
/**
|
|
1559
|
+
* This carrier's unique ID
|
|
1560
|
+
* @format GUID
|
|
1561
|
+
*/
|
|
1254
1562
|
carrierId?: string | null;
|
|
1255
|
-
/**
|
|
1563
|
+
/**
|
|
1564
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
1565
|
+
* @maxSize 300
|
|
1566
|
+
*/
|
|
1256
1567
|
deliveryAllocations?: DeliveryAllocation[];
|
|
1257
1568
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1258
1569
|
partial?: boolean | null;
|
|
1259
1570
|
}
|
|
1260
1571
|
export interface DeliveryLogistics {
|
|
1261
|
-
/**
|
|
1572
|
+
/**
|
|
1573
|
+
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1574
|
+
* @maxLength 500
|
|
1575
|
+
*/
|
|
1262
1576
|
deliveryTime?: string | null;
|
|
1263
|
-
/**
|
|
1577
|
+
/**
|
|
1578
|
+
* Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
|
|
1579
|
+
* @maxLength 1000
|
|
1580
|
+
*/
|
|
1264
1581
|
instructions?: string | null;
|
|
1265
1582
|
/** Pickup details. */
|
|
1266
1583
|
pickupDetails?: PickupDetails;
|
|
@@ -1302,7 +1619,10 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1302
1619
|
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
1303
1620
|
/** Type of additional cost. */
|
|
1304
1621
|
type?: ChargeType;
|
|
1305
|
-
/**
|
|
1622
|
+
/**
|
|
1623
|
+
* Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
|
|
1624
|
+
* @maxLength 200
|
|
1625
|
+
*/
|
|
1306
1626
|
details?: string | null;
|
|
1307
1627
|
/** Price of added charge. */
|
|
1308
1628
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
@@ -1320,23 +1640,43 @@ export interface DeliveryAllocation {
|
|
|
1320
1640
|
applicableLineItems?: ApplicableLineItems;
|
|
1321
1641
|
}
|
|
1322
1642
|
export interface Carrier {
|
|
1323
|
-
/**
|
|
1643
|
+
/**
|
|
1644
|
+
* The carrier app id
|
|
1645
|
+
* @format GUID
|
|
1646
|
+
*/
|
|
1324
1647
|
appId?: string | null;
|
|
1325
|
-
/**
|
|
1648
|
+
/**
|
|
1649
|
+
* Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
|
|
1650
|
+
* @maxLength 250
|
|
1651
|
+
*/
|
|
1326
1652
|
code?: string;
|
|
1327
1653
|
}
|
|
1328
1654
|
export interface Region {
|
|
1329
|
-
/**
|
|
1655
|
+
/**
|
|
1656
|
+
* The delivery region id.
|
|
1657
|
+
* @format GUID
|
|
1658
|
+
*/
|
|
1330
1659
|
id?: string | null;
|
|
1331
|
-
/**
|
|
1660
|
+
/**
|
|
1661
|
+
* The delivery region name.
|
|
1662
|
+
* @maxLength 100
|
|
1663
|
+
*/
|
|
1332
1664
|
name?: string | null;
|
|
1333
1665
|
}
|
|
1334
1666
|
export interface ApplicableLineItems {
|
|
1335
|
-
/**
|
|
1667
|
+
/**
|
|
1668
|
+
* Line items that the delivery solution is for.
|
|
1669
|
+
* @maxSize 300
|
|
1670
|
+
* @minLength 1
|
|
1671
|
+
* @maxLength 100
|
|
1672
|
+
*/
|
|
1336
1673
|
lineItemIds?: string[];
|
|
1337
1674
|
}
|
|
1338
1675
|
export interface CarrierServiceOption {
|
|
1339
|
-
/**
|
|
1676
|
+
/**
|
|
1677
|
+
* Carrier ID.
|
|
1678
|
+
* @format GUID
|
|
1679
|
+
*/
|
|
1340
1680
|
carrierId?: string;
|
|
1341
1681
|
/** Shipping options offered by this carrier for this request. */
|
|
1342
1682
|
shippingOptions?: ShippingOption[];
|
|
@@ -1345,18 +1685,23 @@ export interface ShippingOption {
|
|
|
1345
1685
|
/**
|
|
1346
1686
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1347
1687
|
* For legacy calculators this would be the UUID of the option.
|
|
1688
|
+
* @maxLength 100
|
|
1348
1689
|
*/
|
|
1349
1690
|
code?: string;
|
|
1350
1691
|
/**
|
|
1351
1692
|
* Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
|
|
1352
1693
|
* For example, "Standard" or "First-Class Package International".
|
|
1694
|
+
* @maxLength 250
|
|
1353
1695
|
*/
|
|
1354
1696
|
title?: string;
|
|
1355
1697
|
/** Delivery logistics. */
|
|
1356
1698
|
logistics?: DeliveryLogistics;
|
|
1357
1699
|
/** Sipping price information. */
|
|
1358
1700
|
cost?: ShippingPrice;
|
|
1359
|
-
/**
|
|
1701
|
+
/**
|
|
1702
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
1703
|
+
* @maxSize 300
|
|
1704
|
+
*/
|
|
1360
1705
|
deliveryAllocations?: DeliveryAllocation[];
|
|
1361
1706
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1362
1707
|
partial?: boolean | null;
|
|
@@ -1384,6 +1729,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1384
1729
|
discountType?: AppliedDiscountDiscountType;
|
|
1385
1730
|
/**
|
|
1386
1731
|
* IDs of line items the discount applies to.
|
|
1732
|
+
* @format GUID
|
|
1387
1733
|
* @deprecated IDs of line items the discount applies to.
|
|
1388
1734
|
* @replacedBy line_items_discounts
|
|
1389
1735
|
* @targetRemovalDate 2024-06-01
|
|
@@ -1418,11 +1764,18 @@ export interface V1Coupon {
|
|
|
1418
1764
|
export interface V1MerchantDiscount {
|
|
1419
1765
|
/** Discount value. */
|
|
1420
1766
|
amount?: MultiCurrencyPrice;
|
|
1421
|
-
/**
|
|
1767
|
+
/**
|
|
1768
|
+
* Discount Percentage. Will be calculated from items price before other discounts.
|
|
1769
|
+
* @min 1
|
|
1770
|
+
* @max 100
|
|
1771
|
+
*/
|
|
1422
1772
|
percentage?: number | null;
|
|
1423
1773
|
}
|
|
1424
1774
|
export interface V1DiscountRule {
|
|
1425
|
-
/**
|
|
1775
|
+
/**
|
|
1776
|
+
* Discount rule ID
|
|
1777
|
+
* @format GUID
|
|
1778
|
+
*/
|
|
1426
1779
|
id?: string;
|
|
1427
1780
|
/** Discount rule name */
|
|
1428
1781
|
name?: V1DiscountRuleName;
|
|
@@ -1430,13 +1783,24 @@ export interface V1DiscountRule {
|
|
|
1430
1783
|
amount?: MultiCurrencyPrice;
|
|
1431
1784
|
}
|
|
1432
1785
|
export interface V1DiscountRuleName {
|
|
1433
|
-
/**
|
|
1786
|
+
/**
|
|
1787
|
+
* Original discount rule name (in site's default language).
|
|
1788
|
+
* @minLength 1
|
|
1789
|
+
* @maxLength 256
|
|
1790
|
+
*/
|
|
1434
1791
|
original?: string;
|
|
1435
|
-
/**
|
|
1792
|
+
/**
|
|
1793
|
+
* Translated discount rule name according to buyer language. Defaults to `original` when not provided.
|
|
1794
|
+
* @minLength 1
|
|
1795
|
+
* @maxLength 500
|
|
1796
|
+
*/
|
|
1436
1797
|
translated?: string | null;
|
|
1437
1798
|
}
|
|
1438
1799
|
export interface LineItemDiscount {
|
|
1439
|
-
/**
|
|
1800
|
+
/**
|
|
1801
|
+
* ID of line item the discount applies to.
|
|
1802
|
+
* @format GUID
|
|
1803
|
+
*/
|
|
1440
1804
|
id?: string;
|
|
1441
1805
|
/** Discount value. */
|
|
1442
1806
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
@@ -1566,21 +1930,43 @@ export interface CarrierError {
|
|
|
1566
1930
|
error?: Details;
|
|
1567
1931
|
}
|
|
1568
1932
|
export interface MembershipOptions {
|
|
1569
|
-
/**
|
|
1933
|
+
/**
|
|
1934
|
+
* List of payment options that can be used.
|
|
1935
|
+
* @maxSize 300
|
|
1936
|
+
*/
|
|
1570
1937
|
eligibleMemberships?: Membership[];
|
|
1571
|
-
/**
|
|
1938
|
+
/**
|
|
1939
|
+
* List of payment options that are owned by the member, but cannot be used due to reason provided.
|
|
1940
|
+
* @maxSize 300
|
|
1941
|
+
*/
|
|
1572
1942
|
invalidMemberships?: InvalidMembership[];
|
|
1573
|
-
/**
|
|
1943
|
+
/**
|
|
1944
|
+
* The selected membership payment options and which line items they apply to.
|
|
1945
|
+
* @maxSize 300
|
|
1946
|
+
*/
|
|
1574
1947
|
selectedMemberships?: HostSelectedMembership[];
|
|
1575
1948
|
}
|
|
1576
1949
|
export interface Membership {
|
|
1577
|
-
/**
|
|
1950
|
+
/**
|
|
1951
|
+
* Membership ID.
|
|
1952
|
+
* @minLength 1
|
|
1953
|
+
* @maxLength 100
|
|
1954
|
+
*/
|
|
1578
1955
|
id?: string;
|
|
1579
|
-
/**
|
|
1956
|
+
/**
|
|
1957
|
+
* ID of the application providing this payment option.
|
|
1958
|
+
* @format GUID
|
|
1959
|
+
*/
|
|
1580
1960
|
appId?: string;
|
|
1581
1961
|
/** The name of this membership. */
|
|
1582
1962
|
name?: MembershipName;
|
|
1583
|
-
/**
|
|
1963
|
+
/**
|
|
1964
|
+
* Line item IDs which are "paid" for by this membership.
|
|
1965
|
+
* @minSize 1
|
|
1966
|
+
* @maxSize 300
|
|
1967
|
+
* @minLength 1
|
|
1968
|
+
* @maxLength 100
|
|
1969
|
+
*/
|
|
1584
1970
|
lineItemIds?: string[];
|
|
1585
1971
|
/** Optional - For a membership that has limited credits, information about credit usage. */
|
|
1586
1972
|
credits?: MembershipPaymentCredits;
|
|
@@ -1590,13 +1976,22 @@ export interface Membership {
|
|
|
1590
1976
|
additionalData?: Record<string, any> | null;
|
|
1591
1977
|
}
|
|
1592
1978
|
export interface MembershipName {
|
|
1593
|
-
/**
|
|
1979
|
+
/**
|
|
1980
|
+
* Membership name.
|
|
1981
|
+
* @maxLength 100
|
|
1982
|
+
*/
|
|
1594
1983
|
original?: string;
|
|
1595
|
-
/**
|
|
1984
|
+
/**
|
|
1985
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
1986
|
+
* @maxLength 100
|
|
1987
|
+
*/
|
|
1596
1988
|
translated?: string | null;
|
|
1597
1989
|
}
|
|
1598
1990
|
export interface MembershipPaymentCredits {
|
|
1599
|
-
/**
|
|
1991
|
+
/**
|
|
1992
|
+
* Membership's total amount of credits.
|
|
1993
|
+
* @min 1
|
|
1994
|
+
*/
|
|
1600
1995
|
total?: number;
|
|
1601
1996
|
/** Membership's remaining amount of credits. */
|
|
1602
1997
|
remaining?: number;
|
|
@@ -1604,19 +1999,35 @@ export interface MembershipPaymentCredits {
|
|
|
1604
1999
|
export interface InvalidMembership {
|
|
1605
2000
|
/** Membership details. */
|
|
1606
2001
|
membership?: Membership;
|
|
1607
|
-
/**
|
|
2002
|
+
/**
|
|
2003
|
+
* Reason why this membership is invalid and cannot be used.
|
|
2004
|
+
* @minLength 1
|
|
2005
|
+
* @maxLength 100
|
|
2006
|
+
*/
|
|
1608
2007
|
reason?: string;
|
|
1609
2008
|
}
|
|
1610
2009
|
export interface AdditionalFee {
|
|
1611
|
-
/**
|
|
2010
|
+
/**
|
|
2011
|
+
* Additional fee's unique code (or ID) for future processing.
|
|
2012
|
+
* @minLength 1
|
|
2013
|
+
* @maxLength 100
|
|
2014
|
+
*/
|
|
1612
2015
|
code?: string | null;
|
|
1613
|
-
/**
|
|
2016
|
+
/**
|
|
2017
|
+
* Translated additional fee's name.
|
|
2018
|
+
* @minLength 1
|
|
2019
|
+
* @maxLength 50
|
|
2020
|
+
*/
|
|
1614
2021
|
name?: string;
|
|
1615
2022
|
/** Additional fee's price. */
|
|
1616
2023
|
price?: MultiCurrencyPrice;
|
|
1617
2024
|
/** Tax details. */
|
|
1618
2025
|
taxDetails?: ItemTaxFullDetails;
|
|
1619
|
-
/**
|
|
2026
|
+
/**
|
|
2027
|
+
* Provider's app id.
|
|
2028
|
+
* @minLength 1
|
|
2029
|
+
* @maxLength 100
|
|
2030
|
+
*/
|
|
1620
2031
|
providerAppId?: string | null;
|
|
1621
2032
|
/** Additional fee's price before tax. */
|
|
1622
2033
|
priceBeforeTax?: MultiCurrencyPrice;
|
|
@@ -1625,6 +2036,7 @@ export interface AdditionalFee {
|
|
|
1625
2036
|
/**
|
|
1626
2037
|
* Optional - Line items associated with this additional fee.
|
|
1627
2038
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
2039
|
+
* @format GUID
|
|
1628
2040
|
*/
|
|
1629
2041
|
lineItemIds?: string[];
|
|
1630
2042
|
/** the source the additional fee was added from */
|
|
@@ -1644,7 +2056,11 @@ export interface Violation {
|
|
|
1644
2056
|
severity?: Severity;
|
|
1645
2057
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
1646
2058
|
target?: Target;
|
|
1647
|
-
/**
|
|
2059
|
+
/**
|
|
2060
|
+
* 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>`.
|
|
2061
|
+
* @minLength 1
|
|
2062
|
+
* @maxLength 1000
|
|
2063
|
+
*/
|
|
1648
2064
|
description?: string | null;
|
|
1649
2065
|
}
|
|
1650
2066
|
export declare enum Severity {
|
|
@@ -1698,7 +2114,12 @@ export interface TargetLineItem {
|
|
|
1698
2114
|
id?: string | null;
|
|
1699
2115
|
}
|
|
1700
2116
|
export interface RemoveLineItemsFromCurrentCartRequest {
|
|
1701
|
-
/**
|
|
2117
|
+
/**
|
|
2118
|
+
* Line item IDs to remove from cart.
|
|
2119
|
+
* @format GUID
|
|
2120
|
+
* @minSize 1
|
|
2121
|
+
* @maxSize 100
|
|
2122
|
+
*/
|
|
1702
2123
|
lineItemIds?: string[];
|
|
1703
2124
|
}
|
|
1704
2125
|
export interface RemoveLineItemsResponse {
|
|
@@ -1714,7 +2135,10 @@ export interface CreateCheckoutFromCurrentCartRequest {
|
|
|
1714
2135
|
billingAddress?: Address;
|
|
1715
2136
|
/** Selected shipping option. */
|
|
1716
2137
|
selectedShippingOption?: SelectedShippingOption;
|
|
1717
|
-
/**
|
|
2138
|
+
/**
|
|
2139
|
+
* Mandatory when setting billing or shipping address and user is not logged in.
|
|
2140
|
+
* @format EMAIL
|
|
2141
|
+
*/
|
|
1718
2142
|
email?: string | null;
|
|
1719
2143
|
}
|
|
1720
2144
|
export declare enum ChannelType {
|
|
@@ -1762,13 +2186,24 @@ export interface RemoveCouponResponse {
|
|
|
1762
2186
|
cart?: Cart;
|
|
1763
2187
|
}
|
|
1764
2188
|
export interface UpdateCurrentCartLineItemQuantityRequest {
|
|
1765
|
-
/**
|
|
2189
|
+
/**
|
|
2190
|
+
* Line item IDs and their new quantity.
|
|
2191
|
+
* @minSize 1
|
|
2192
|
+
* @maxSize 100
|
|
2193
|
+
*/
|
|
1766
2194
|
lineItems?: LineItemQuantityUpdate[];
|
|
1767
2195
|
}
|
|
1768
2196
|
export interface LineItemQuantityUpdate {
|
|
1769
|
-
/**
|
|
2197
|
+
/**
|
|
2198
|
+
* Line item ID. Required.
|
|
2199
|
+
* @format GUID
|
|
2200
|
+
*/
|
|
1770
2201
|
id?: string;
|
|
1771
|
-
/**
|
|
2202
|
+
/**
|
|
2203
|
+
* New quantity. Number must be 1 or higher. Required.
|
|
2204
|
+
* @min 1
|
|
2205
|
+
* @max 100000
|
|
2206
|
+
*/
|
|
1772
2207
|
quantity?: number;
|
|
1773
2208
|
}
|
|
1774
2209
|
export interface UpdateLineItemsQuantityResponse {
|
|
@@ -1874,9 +2309,15 @@ export interface ActionEvent {
|
|
|
1874
2309
|
bodyAsJson?: string;
|
|
1875
2310
|
}
|
|
1876
2311
|
export interface MessageEnvelope {
|
|
1877
|
-
/**
|
|
2312
|
+
/**
|
|
2313
|
+
* App instance ID.
|
|
2314
|
+
* @format GUID
|
|
2315
|
+
*/
|
|
1878
2316
|
instanceId?: string | null;
|
|
1879
|
-
/**
|
|
2317
|
+
/**
|
|
2318
|
+
* Event type.
|
|
2319
|
+
* @maxLength 150
|
|
2320
|
+
*/
|
|
1880
2321
|
eventType?: string;
|
|
1881
2322
|
/** The identification type and identity data. */
|
|
1882
2323
|
identity?: IdentificationData;
|
|
@@ -1884,26 +2325,50 @@ export interface MessageEnvelope {
|
|
|
1884
2325
|
data?: string;
|
|
1885
2326
|
}
|
|
1886
2327
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1887
|
-
/**
|
|
2328
|
+
/**
|
|
2329
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2330
|
+
* @format GUID
|
|
2331
|
+
*/
|
|
1888
2332
|
anonymousVisitorId?: string;
|
|
1889
|
-
/**
|
|
2333
|
+
/**
|
|
2334
|
+
* ID of a site visitor that has logged in to the site.
|
|
2335
|
+
* @format GUID
|
|
2336
|
+
*/
|
|
1890
2337
|
memberId?: string;
|
|
1891
|
-
/**
|
|
2338
|
+
/**
|
|
2339
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2340
|
+
* @format GUID
|
|
2341
|
+
*/
|
|
1892
2342
|
wixUserId?: string;
|
|
1893
|
-
/**
|
|
2343
|
+
/**
|
|
2344
|
+
* ID of an app.
|
|
2345
|
+
* @format GUID
|
|
2346
|
+
*/
|
|
1894
2347
|
appId?: string;
|
|
1895
2348
|
/** @readonly */
|
|
1896
2349
|
identityType?: WebhookIdentityType;
|
|
1897
2350
|
}
|
|
1898
2351
|
/** @oneof */
|
|
1899
2352
|
export interface IdentificationDataIdOneOf {
|
|
1900
|
-
/**
|
|
2353
|
+
/**
|
|
2354
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2355
|
+
* @format GUID
|
|
2356
|
+
*/
|
|
1901
2357
|
anonymousVisitorId?: string;
|
|
1902
|
-
/**
|
|
2358
|
+
/**
|
|
2359
|
+
* ID of a site visitor that has logged in to the site.
|
|
2360
|
+
* @format GUID
|
|
2361
|
+
*/
|
|
1903
2362
|
memberId?: string;
|
|
1904
|
-
/**
|
|
2363
|
+
/**
|
|
2364
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2365
|
+
* @format GUID
|
|
2366
|
+
*/
|
|
1905
2367
|
wixUserId?: string;
|
|
1906
|
-
/**
|
|
2368
|
+
/**
|
|
2369
|
+
* ID of an app.
|
|
2370
|
+
* @format GUID
|
|
2371
|
+
*/
|
|
1907
2372
|
appId?: string;
|
|
1908
2373
|
}
|
|
1909
2374
|
export declare enum WebhookIdentityType {
|
|
@@ -1918,15 +2383,22 @@ export interface CreateCartRequest {
|
|
|
1918
2383
|
cartInfo?: Cart;
|
|
1919
2384
|
/** Code of an existing coupon to apply to cart. For more information, see the [Coupons API](https://dev.wix.com/api/rest/coupons/coupons/introduction). */
|
|
1920
2385
|
couponCode?: string | null;
|
|
1921
|
-
/**
|
|
2386
|
+
/**
|
|
2387
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
|
|
2388
|
+
* @maxSize 100
|
|
2389
|
+
*/
|
|
1922
2390
|
merchantDiscounts?: MerchantDiscountInput[];
|
|
1923
|
-
/**
|
|
2391
|
+
/**
|
|
2392
|
+
* Catalog line items.
|
|
2393
|
+
* @maxSize 300
|
|
2394
|
+
*/
|
|
1924
2395
|
lineItems?: LineItem[];
|
|
1925
2396
|
/**
|
|
1926
2397
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
1927
2398
|
*
|
|
1928
2399
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
1929
2400
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2401
|
+
* @maxSize 300
|
|
1930
2402
|
*/
|
|
1931
2403
|
customLineItems?: CustomLineItem[];
|
|
1932
2404
|
}
|
|
@@ -1935,7 +2407,10 @@ export interface CreateCartResponse {
|
|
|
1935
2407
|
cart?: Cart;
|
|
1936
2408
|
}
|
|
1937
2409
|
export interface GetCartRequest {
|
|
1938
|
-
/**
|
|
2410
|
+
/**
|
|
2411
|
+
* Cart ID.
|
|
2412
|
+
* @format GUID
|
|
2413
|
+
*/
|
|
1939
2414
|
id: string;
|
|
1940
2415
|
}
|
|
1941
2416
|
export interface GetCartResponse {
|
|
@@ -1943,7 +2418,10 @@ export interface GetCartResponse {
|
|
|
1943
2418
|
cart?: Cart;
|
|
1944
2419
|
}
|
|
1945
2420
|
export interface GetCartByCheckoutIdRequest {
|
|
1946
|
-
/**
|
|
2421
|
+
/**
|
|
2422
|
+
* Checkout ID.
|
|
2423
|
+
* @format GUID
|
|
2424
|
+
*/
|
|
1947
2425
|
id: string;
|
|
1948
2426
|
}
|
|
1949
2427
|
export interface GetCartByCheckoutIdResponse {
|
|
@@ -1951,26 +2429,51 @@ export interface GetCartByCheckoutIdResponse {
|
|
|
1951
2429
|
cart?: Cart;
|
|
1952
2430
|
}
|
|
1953
2431
|
export interface AddToCartRequest {
|
|
1954
|
-
/**
|
|
2432
|
+
/**
|
|
2433
|
+
* Cart ID.
|
|
2434
|
+
* @format GUID
|
|
2435
|
+
*/
|
|
1955
2436
|
id: string;
|
|
1956
|
-
/**
|
|
2437
|
+
/**
|
|
2438
|
+
* Catalog line items.
|
|
2439
|
+
* @maxSize 100
|
|
2440
|
+
*/
|
|
1957
2441
|
lineItems?: LineItem[];
|
|
1958
2442
|
/**
|
|
1959
2443
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
1960
2444
|
*
|
|
1961
2445
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
1962
2446
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2447
|
+
* @maxSize 100
|
|
1963
2448
|
*/
|
|
1964
2449
|
customLineItems?: CustomLineItem[];
|
|
2450
|
+
/**
|
|
2451
|
+
* The business location ID associated with the cart.
|
|
2452
|
+
* 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.
|
|
2453
|
+
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
2454
|
+
* @format GUID
|
|
2455
|
+
*/
|
|
2456
|
+
businessLocationId?: string | null;
|
|
1965
2457
|
}
|
|
1966
2458
|
export interface RemoveLineItemsRequest {
|
|
1967
|
-
/**
|
|
2459
|
+
/**
|
|
2460
|
+
* Cart ID.
|
|
2461
|
+
* @format GUID
|
|
2462
|
+
*/
|
|
1968
2463
|
id: string;
|
|
1969
|
-
/**
|
|
2464
|
+
/**
|
|
2465
|
+
* Line item IDs to remove from cart.
|
|
2466
|
+
* @format GUID
|
|
2467
|
+
* @minSize 1
|
|
2468
|
+
* @maxSize 100
|
|
2469
|
+
*/
|
|
1970
2470
|
lineItemIds: string[];
|
|
1971
2471
|
}
|
|
1972
2472
|
export interface CreateCheckoutRequest {
|
|
1973
|
-
/**
|
|
2473
|
+
/**
|
|
2474
|
+
* Cart ID.
|
|
2475
|
+
* @format GUID
|
|
2476
|
+
*/
|
|
1974
2477
|
id: string;
|
|
1975
2478
|
/** __Required.__ Sales channel type. */
|
|
1976
2479
|
channelType?: ChannelType;
|
|
@@ -1980,21 +2483,37 @@ export interface CreateCheckoutRequest {
|
|
|
1980
2483
|
billingAddress?: Address;
|
|
1981
2484
|
/** Selected shipping option. */
|
|
1982
2485
|
selectedShippingOption?: SelectedShippingOption;
|
|
1983
|
-
/**
|
|
2486
|
+
/**
|
|
2487
|
+
* Required when setting a billing or shipping address if the site visitor isn't logged in.
|
|
2488
|
+
* @format EMAIL
|
|
2489
|
+
*/
|
|
1984
2490
|
email?: string | null;
|
|
1985
2491
|
}
|
|
1986
2492
|
export interface RemoveCouponRequest {
|
|
1987
|
-
/**
|
|
2493
|
+
/**
|
|
2494
|
+
* Cart ID.
|
|
2495
|
+
* @format GUID
|
|
2496
|
+
*/
|
|
1988
2497
|
id: string;
|
|
1989
2498
|
}
|
|
1990
2499
|
export interface UpdateLineItemsQuantityRequest {
|
|
1991
|
-
/**
|
|
2500
|
+
/**
|
|
2501
|
+
* Cart ID.
|
|
2502
|
+
* @format GUID
|
|
2503
|
+
*/
|
|
1992
2504
|
id: string;
|
|
1993
|
-
/**
|
|
2505
|
+
/**
|
|
2506
|
+
* Line item IDs and their new quantity.
|
|
2507
|
+
* @minSize 1
|
|
2508
|
+
* @maxSize 100
|
|
2509
|
+
*/
|
|
1994
2510
|
lineItems: LineItemQuantityUpdate[];
|
|
1995
2511
|
}
|
|
1996
2512
|
export interface EstimateTotalsRequest {
|
|
1997
|
-
/**
|
|
2513
|
+
/**
|
|
2514
|
+
* Cart ID.
|
|
2515
|
+
* @format GUID
|
|
2516
|
+
*/
|
|
1998
2517
|
id: string;
|
|
1999
2518
|
/** Selected shipping option. */
|
|
2000
2519
|
selectedShippingOption?: SelectedShippingOption;
|
|
@@ -2018,13 +2537,19 @@ export interface EstimateTotalsRequest {
|
|
|
2018
2537
|
calculateShipping?: boolean | null;
|
|
2019
2538
|
}
|
|
2020
2539
|
export interface DeleteCartRequest {
|
|
2021
|
-
/**
|
|
2540
|
+
/**
|
|
2541
|
+
* ID of the cart to delete.
|
|
2542
|
+
* @format GUID
|
|
2543
|
+
*/
|
|
2022
2544
|
id: string;
|
|
2023
2545
|
}
|
|
2024
2546
|
export interface Empty {
|
|
2025
2547
|
}
|
|
2026
2548
|
export interface RemoveBusinessLocationRequest {
|
|
2027
|
-
/**
|
|
2549
|
+
/**
|
|
2550
|
+
* Cart ID.
|
|
2551
|
+
* @format GUID
|
|
2552
|
+
*/
|
|
2028
2553
|
id: string;
|
|
2029
2554
|
}
|
|
2030
2555
|
export interface RemoveBusinessLocationResponse {
|