@wix/auto_sdk_ecom_checkout 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-checkout-checkout.context.d.ts +1 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js +12 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js +5 -0
- package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.types.d.ts +994 -228
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1055 -248
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +9 -4
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.http.js +12 -0
- package/build/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.public.js +5 -0
- package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +994 -228
- package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +1055 -248
- package/build/es/src/ecom-v1-checkout-checkout.universal.js +9 -4
- package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +12 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +5 -0
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +1004 -228
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1089 -253
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +9 -4
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +12 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +5 -0
- package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +1004 -228
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +1089 -253
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +9 -4
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export interface Checkout {
|
|
2
2
|
/**
|
|
3
3
|
* Checkout ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string | null;
|
|
@@ -8,6 +9,8 @@ export interface Checkout {
|
|
|
8
9
|
* Line items.
|
|
9
10
|
*
|
|
10
11
|
* Max: 300 items
|
|
12
|
+
* @minSize 1
|
|
13
|
+
* @maxSize 300
|
|
11
14
|
* @readonly
|
|
12
15
|
*/
|
|
13
16
|
lineItems?: LineItem[];
|
|
@@ -15,13 +18,17 @@ export interface Checkout {
|
|
|
15
18
|
billingInfo?: AddressWithContact;
|
|
16
19
|
/** Shipping information. */
|
|
17
20
|
shippingInfo?: ShippingInfo;
|
|
18
|
-
/**
|
|
21
|
+
/**
|
|
22
|
+
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
23
|
+
* @maxLength 1000
|
|
24
|
+
*/
|
|
19
25
|
buyerNote?: string | null;
|
|
20
26
|
/** Buyer information. */
|
|
21
27
|
buyerInfo?: BuyerInfo;
|
|
22
28
|
/**
|
|
23
29
|
* All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
24
30
|
* @readonly
|
|
31
|
+
* @format CURRENCY
|
|
25
32
|
*/
|
|
26
33
|
conversionCurrency?: string;
|
|
27
34
|
/**
|
|
@@ -60,6 +67,7 @@ export interface Checkout {
|
|
|
60
67
|
taxSummary?: TaxSummary;
|
|
61
68
|
/**
|
|
62
69
|
* The currency used when submitting the order.
|
|
70
|
+
* @format CURRENCY
|
|
63
71
|
* @readonly
|
|
64
72
|
*/
|
|
65
73
|
currency?: string;
|
|
@@ -117,9 +125,15 @@ export interface Checkout {
|
|
|
117
125
|
payLater?: PriceSummary;
|
|
118
126
|
/** Memberships to apply when creating the order. */
|
|
119
127
|
membershipOptions?: MembershipOptions;
|
|
120
|
-
/**
|
|
128
|
+
/**
|
|
129
|
+
* Additional Fees.
|
|
130
|
+
* @maxSize 100
|
|
131
|
+
*/
|
|
121
132
|
additionalFees?: AdditionalFee[];
|
|
122
|
-
/**
|
|
133
|
+
/**
|
|
134
|
+
* Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
|
|
135
|
+
* @format GUID
|
|
136
|
+
*/
|
|
123
137
|
cartId?: string | null;
|
|
124
138
|
/**
|
|
125
139
|
* List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
|
|
@@ -134,6 +148,7 @@ export interface Checkout {
|
|
|
134
148
|
extendedFields?: ExtendedFields;
|
|
135
149
|
/**
|
|
136
150
|
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
151
|
+
* @format GUID
|
|
137
152
|
* @readonly
|
|
138
153
|
*/
|
|
139
154
|
purchaseFlowId?: string | null;
|
|
@@ -141,6 +156,7 @@ export interface Checkout {
|
|
|
141
156
|
* Additional settings for customization of the checkout process.
|
|
142
157
|
*
|
|
143
158
|
* Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
|
|
159
|
+
* @immutable
|
|
144
160
|
*/
|
|
145
161
|
customSettings?: CustomSettings;
|
|
146
162
|
/**
|
|
@@ -155,6 +171,7 @@ export interface Checkout {
|
|
|
155
171
|
*
|
|
156
172
|
* This field is empty until the checkout completes and becomes an order.
|
|
157
173
|
* @internal
|
|
174
|
+
* @format GUID
|
|
158
175
|
* @readonly
|
|
159
176
|
*/
|
|
160
177
|
orderId?: string | null;
|
|
@@ -167,6 +184,7 @@ export interface Checkout {
|
|
|
167
184
|
/**
|
|
168
185
|
* The business location ID associated with the checkout.
|
|
169
186
|
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
187
|
+
* @format GUID
|
|
170
188
|
*/
|
|
171
189
|
businessLocationId?: string | null;
|
|
172
190
|
/**
|
|
@@ -179,10 +197,18 @@ export interface Checkout {
|
|
|
179
197
|
* @readonly
|
|
180
198
|
*/
|
|
181
199
|
paymentRequired?: boolean;
|
|
200
|
+
/**
|
|
201
|
+
* Charges information for each subscription in the Checkout.
|
|
202
|
+
* @internal
|
|
203
|
+
* @readonly
|
|
204
|
+
* @maxSize 100
|
|
205
|
+
*/
|
|
206
|
+
subscriptionCharges?: SubscriptionCharges[];
|
|
182
207
|
}
|
|
183
208
|
export interface LineItem {
|
|
184
209
|
/**
|
|
185
210
|
* Line item ID.
|
|
211
|
+
* @format GUID
|
|
186
212
|
* @readonly
|
|
187
213
|
*/
|
|
188
214
|
_id?: string | null;
|
|
@@ -191,6 +217,8 @@ export interface LineItem {
|
|
|
191
217
|
*
|
|
192
218
|
* Min: `"1"`
|
|
193
219
|
* Max: `"100000"`
|
|
220
|
+
* @min 1
|
|
221
|
+
* @max 100000
|
|
194
222
|
*/
|
|
195
223
|
quantity?: number;
|
|
196
224
|
/** 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. */
|
|
@@ -297,6 +325,8 @@ export interface LineItem {
|
|
|
297
325
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
298
326
|
* + In most cases, this field has the same value as `catalogReference.catalogItemId`.
|
|
299
327
|
* + Used in membership validation.
|
|
328
|
+
* @minLength 1
|
|
329
|
+
* @maxLength 36
|
|
300
330
|
* @readonly
|
|
301
331
|
*/
|
|
302
332
|
rootCatalogItemId?: string | null;
|
|
@@ -311,8 +341,8 @@ export interface LineItem {
|
|
|
311
341
|
*/
|
|
312
342
|
depositAmount?: MultiCurrencyPrice;
|
|
313
343
|
/**
|
|
314
|
-
* Delivery
|
|
315
|
-
* @
|
|
344
|
+
* Delivery profile ID.
|
|
345
|
+
* @format GUID
|
|
316
346
|
* @readonly
|
|
317
347
|
*/
|
|
318
348
|
deliveryProfileId?: string | null;
|
|
@@ -323,6 +353,8 @@ export interface LineItem {
|
|
|
323
353
|
customLineItem?: boolean;
|
|
324
354
|
/**
|
|
325
355
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
356
|
+
* @minLength 1
|
|
357
|
+
* @maxLength 2500
|
|
326
358
|
* @readonly
|
|
327
359
|
*/
|
|
328
360
|
consentRequiredPaymentPolicy?: string | null;
|
|
@@ -353,7 +385,7 @@ export interface LineItem {
|
|
|
353
385
|
*/
|
|
354
386
|
savePaymentMethod?: boolean;
|
|
355
387
|
/**
|
|
356
|
-
* Address to
|
|
388
|
+
* Address to use for tax calculation purposes.
|
|
357
389
|
* @internal
|
|
358
390
|
*/
|
|
359
391
|
taxableAddress?: TaxableAddress;
|
|
@@ -368,11 +400,13 @@ export interface LineItem {
|
|
|
368
400
|
* Policies to be displayed to the customer on the checkout page.
|
|
369
401
|
* @internal
|
|
370
402
|
* @readonly
|
|
403
|
+
* @maxSize 5
|
|
371
404
|
*/
|
|
372
405
|
policies?: Policy[];
|
|
373
406
|
/**
|
|
374
407
|
* ID of the app managing the inventory.
|
|
375
408
|
* @internal
|
|
409
|
+
* @format GUID
|
|
376
410
|
*/
|
|
377
411
|
inventoryAppId?: string | null;
|
|
378
412
|
/**
|
|
@@ -386,7 +420,11 @@ export interface LineItem {
|
|
|
386
420
|
}
|
|
387
421
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
388
422
|
export interface CatalogReference {
|
|
389
|
-
/**
|
|
423
|
+
/**
|
|
424
|
+
* ID of the item within the catalog it belongs to.
|
|
425
|
+
* @minLength 1
|
|
426
|
+
* @maxLength 36
|
|
427
|
+
*/
|
|
390
428
|
catalogItemId?: string;
|
|
391
429
|
/**
|
|
392
430
|
* ID of the app providing the catalog.
|
|
@@ -397,6 +435,7 @@ export interface CatalogReference {
|
|
|
397
435
|
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
398
436
|
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
399
437
|
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
438
|
+
* @minLength 1
|
|
400
439
|
*/
|
|
401
440
|
appId?: string;
|
|
402
441
|
/**
|
|
@@ -414,6 +453,8 @@ export interface ProductName {
|
|
|
414
453
|
*
|
|
415
454
|
* Min: 1 character.
|
|
416
455
|
* Max: 200 characters.
|
|
456
|
+
* @minLength 1
|
|
457
|
+
* @maxLength 200
|
|
417
458
|
*/
|
|
418
459
|
original?: string;
|
|
419
460
|
/**
|
|
@@ -422,15 +463,21 @@ export interface ProductName {
|
|
|
422
463
|
* Min: 1 character.
|
|
423
464
|
* Max: 400 characters.
|
|
424
465
|
* Default: Same as `original`.
|
|
466
|
+
* @minLength 1
|
|
467
|
+
* @maxLength 400
|
|
425
468
|
*/
|
|
426
469
|
translated?: string | null;
|
|
427
470
|
}
|
|
428
471
|
export interface MultiCurrencyPrice {
|
|
429
|
-
/**
|
|
472
|
+
/**
|
|
473
|
+
* Amount.
|
|
474
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
475
|
+
*/
|
|
430
476
|
amount?: string;
|
|
431
477
|
/**
|
|
432
478
|
* Converted amount.
|
|
433
479
|
* @readonly
|
|
480
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
434
481
|
*/
|
|
435
482
|
convertedAmount?: string;
|
|
436
483
|
/**
|
|
@@ -447,7 +494,10 @@ export interface MultiCurrencyPrice {
|
|
|
447
494
|
export interface ItemTaxFullDetails {
|
|
448
495
|
/** Amount for which tax is calculated. */
|
|
449
496
|
taxableAmount?: MultiCurrencyPrice;
|
|
450
|
-
/**
|
|
497
|
+
/**
|
|
498
|
+
* Tax rate %, as a decimal point between 0 and 1.
|
|
499
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
500
|
+
*/
|
|
451
501
|
taxRate?: string;
|
|
452
502
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
453
503
|
totalTax?: MultiCurrencyPrice;
|
|
@@ -459,9 +509,15 @@ export interface ItemTaxFullDetails {
|
|
|
459
509
|
rateBreakdown?: TaxRateBreakdown[];
|
|
460
510
|
}
|
|
461
511
|
export interface TaxRateBreakdown {
|
|
462
|
-
/**
|
|
512
|
+
/**
|
|
513
|
+
* Name of tax against which the calculation was performed.
|
|
514
|
+
* @maxLength 100
|
|
515
|
+
*/
|
|
463
516
|
name?: string;
|
|
464
|
-
/**
|
|
517
|
+
/**
|
|
518
|
+
* Rate at which this tax detail was calculated.
|
|
519
|
+
* @decimalValue options { gte:0, lte:1, maxScale:6 }
|
|
520
|
+
*/
|
|
465
521
|
rate?: string;
|
|
466
522
|
/** Amount of tax for this tax detail. */
|
|
467
523
|
tax?: MultiCurrencyPrice;
|
|
@@ -471,21 +527,31 @@ export interface TaxRateBreakdown {
|
|
|
471
527
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
472
528
|
*/
|
|
473
529
|
export interface TaxBreakdown {
|
|
474
|
-
/**
|
|
530
|
+
/**
|
|
531
|
+
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
532
|
+
* @maxLength 200
|
|
533
|
+
*/
|
|
475
534
|
jurisdiction?: string | null;
|
|
476
535
|
/** The amount of this line item price that was considered nontaxable. (Decimal value) */
|
|
477
536
|
nonTaxableAmount?: MultiCurrencyPrice;
|
|
478
|
-
/**
|
|
537
|
+
/**
|
|
538
|
+
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
|
|
539
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
540
|
+
*/
|
|
479
541
|
rate?: string | null;
|
|
480
542
|
/** The amount of tax estimated for this line item. (Decimal value) */
|
|
481
543
|
taxAmount?: MultiCurrencyPrice;
|
|
482
544
|
/** The taxable amount of this line item. */
|
|
483
545
|
taxableAmount?: MultiCurrencyPrice;
|
|
484
|
-
/**
|
|
546
|
+
/**
|
|
547
|
+
* The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
|
|
548
|
+
* @maxLength 200
|
|
549
|
+
*/
|
|
485
550
|
taxType?: string | null;
|
|
486
551
|
/**
|
|
487
552
|
* The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
|
|
488
553
|
* This name should be explicit enough to allow the merchant to understand what tax was calculated.
|
|
554
|
+
* @maxLength 200
|
|
489
555
|
*/
|
|
490
556
|
taxName?: string | null;
|
|
491
557
|
/** The type of the jurisdiction in which this tax detail applies. */
|
|
@@ -519,32 +585,44 @@ export interface DescriptionLineValueOneOf {
|
|
|
519
585
|
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
520
586
|
}
|
|
521
587
|
export interface DescriptionLineName {
|
|
522
|
-
/**
|
|
588
|
+
/**
|
|
589
|
+
* 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).
|
|
590
|
+
* @maxLength 100
|
|
591
|
+
*/
|
|
523
592
|
original?: string;
|
|
524
593
|
/**
|
|
525
594
|
* Description line name translated into the buyer's language.
|
|
526
595
|
*
|
|
527
596
|
* Default: Same as `original`.
|
|
597
|
+
* @maxLength 200
|
|
528
598
|
*/
|
|
529
599
|
translated?: string | null;
|
|
530
600
|
}
|
|
531
601
|
export interface PlainTextValue {
|
|
532
|
-
/**
|
|
602
|
+
/**
|
|
603
|
+
* 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).
|
|
604
|
+
* @maxLength 600
|
|
605
|
+
*/
|
|
533
606
|
original?: string;
|
|
534
607
|
/**
|
|
535
608
|
* Description line plain text value translated into the buyer's language.
|
|
536
609
|
*
|
|
537
610
|
* Default: Same as `original`.
|
|
611
|
+
* @maxLength 600
|
|
538
612
|
*/
|
|
539
613
|
translated?: string | null;
|
|
540
614
|
}
|
|
541
615
|
export interface Color {
|
|
542
|
-
/**
|
|
616
|
+
/**
|
|
617
|
+
* 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).
|
|
618
|
+
* @maxLength 500
|
|
619
|
+
*/
|
|
543
620
|
original?: string;
|
|
544
621
|
/**
|
|
545
622
|
* Description line color name translated into the buyer's language.
|
|
546
623
|
*
|
|
547
624
|
* Default: Same as `original`.
|
|
625
|
+
* @maxLength 500
|
|
548
626
|
*/
|
|
549
627
|
translated?: string | null;
|
|
550
628
|
/** HEX or RGB color code for display. */
|
|
@@ -586,7 +664,10 @@ export declare enum ItemAvailabilityStatus {
|
|
|
586
664
|
export interface PhysicalProperties {
|
|
587
665
|
/** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
|
|
588
666
|
weight?: number | null;
|
|
589
|
-
/**
|
|
667
|
+
/**
|
|
668
|
+
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
669
|
+
* @maxLength 40
|
|
670
|
+
*/
|
|
590
671
|
sku?: string | null;
|
|
591
672
|
/** Whether this line item is shippable. */
|
|
592
673
|
shippable?: boolean;
|
|
@@ -639,11 +720,16 @@ export interface SubscriptionSettings {
|
|
|
639
720
|
*
|
|
640
721
|
* Default: `1`.
|
|
641
722
|
* If SubscriptionFrequency is Day the minimum interval is 7
|
|
723
|
+
* @min 1
|
|
724
|
+
* @max 50
|
|
642
725
|
*/
|
|
643
726
|
interval?: number | null;
|
|
644
727
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
645
728
|
autoRenewal?: boolean;
|
|
646
|
-
/**
|
|
729
|
+
/**
|
|
730
|
+
* Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
|
|
731
|
+
* @min 1
|
|
732
|
+
*/
|
|
647
733
|
billingCycles?: number | null;
|
|
648
734
|
/**
|
|
649
735
|
* Whether to allow the customer to cancel the subscription..
|
|
@@ -673,29 +759,53 @@ export declare enum SubscriptionFrequency {
|
|
|
673
759
|
export interface FreeTrialPeriod {
|
|
674
760
|
/** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
|
|
675
761
|
frequency?: SubscriptionFrequency;
|
|
676
|
-
/**
|
|
762
|
+
/**
|
|
763
|
+
* interval of period
|
|
764
|
+
* @min 1
|
|
765
|
+
* @max 50
|
|
766
|
+
*/
|
|
677
767
|
interval?: number;
|
|
678
768
|
}
|
|
679
769
|
export interface Title {
|
|
680
|
-
/**
|
|
770
|
+
/**
|
|
771
|
+
* 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).
|
|
772
|
+
* @minLength 1
|
|
773
|
+
* @maxLength 150
|
|
774
|
+
*/
|
|
681
775
|
original?: string;
|
|
682
776
|
/**
|
|
683
777
|
* Subscription option name translated into the buyer's language.
|
|
684
778
|
*
|
|
685
779
|
* Default: Same as `original`.
|
|
780
|
+
* @minLength 1
|
|
781
|
+
* @maxLength 150
|
|
686
782
|
*/
|
|
687
783
|
translated?: string | null;
|
|
688
784
|
}
|
|
689
785
|
export interface Description {
|
|
690
|
-
/**
|
|
786
|
+
/**
|
|
787
|
+
* Subscription option description.
|
|
788
|
+
* @maxLength 500
|
|
789
|
+
*/
|
|
691
790
|
original?: string;
|
|
692
|
-
/**
|
|
791
|
+
/**
|
|
792
|
+
* Translated subscription option description.
|
|
793
|
+
* @maxLength 500
|
|
794
|
+
*/
|
|
693
795
|
translated?: string | null;
|
|
694
796
|
}
|
|
695
797
|
export interface SecuredMedia {
|
|
696
|
-
/**
|
|
798
|
+
/**
|
|
799
|
+
* Media ID in Wix Media Manager.
|
|
800
|
+
* @minLength 1
|
|
801
|
+
* @maxLength 100
|
|
802
|
+
*/
|
|
697
803
|
_id?: string;
|
|
698
|
-
/**
|
|
804
|
+
/**
|
|
805
|
+
* Original filename.
|
|
806
|
+
* @minLength 1
|
|
807
|
+
* @maxLength 1000
|
|
808
|
+
*/
|
|
699
809
|
fileName?: string;
|
|
700
810
|
/** File type. */
|
|
701
811
|
fileType?: FileType;
|
|
@@ -727,27 +837,46 @@ export interface ServiceProperties {
|
|
|
727
837
|
* For example, the start time of a class.
|
|
728
838
|
*/
|
|
729
839
|
scheduledDate?: Date | null;
|
|
730
|
-
/**
|
|
840
|
+
/**
|
|
841
|
+
* 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.
|
|
842
|
+
* @min 1
|
|
843
|
+
* @max 10000
|
|
844
|
+
*/
|
|
731
845
|
numberOfParticipants?: number | null;
|
|
732
846
|
}
|
|
733
847
|
export interface PriceDescription {
|
|
734
|
-
/**
|
|
848
|
+
/**
|
|
849
|
+
* __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).
|
|
850
|
+
* @minLength 1
|
|
851
|
+
* @maxLength 100
|
|
852
|
+
*/
|
|
735
853
|
original?: string;
|
|
736
854
|
/**
|
|
737
855
|
* Price description translated into the buyer's language.
|
|
738
856
|
*
|
|
739
857
|
* Default: Same as `original`.
|
|
858
|
+
* @minLength 1
|
|
859
|
+
* @maxLength 100
|
|
740
860
|
*/
|
|
741
861
|
translated?: string | null;
|
|
742
862
|
}
|
|
743
863
|
export interface CatalogOverrideFields {
|
|
744
864
|
/** Item name. */
|
|
745
865
|
productName?: ProductName;
|
|
746
|
-
/**
|
|
866
|
+
/**
|
|
867
|
+
* Item price **after** discounts.
|
|
868
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
869
|
+
*/
|
|
747
870
|
price?: string | null;
|
|
748
|
-
/**
|
|
871
|
+
/**
|
|
872
|
+
* Item price **before** discounts.
|
|
873
|
+
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
874
|
+
*/
|
|
749
875
|
fullPrice?: string | null;
|
|
750
|
-
/**
|
|
876
|
+
/**
|
|
877
|
+
* Item description lines. Used when displaying the line item to customers.
|
|
878
|
+
* @maxSize 20
|
|
879
|
+
*/
|
|
751
880
|
descriptionLines?: DescriptionLine[];
|
|
752
881
|
/** Physical properties of the item. */
|
|
753
882
|
physicalProperties?: PhysicalProperties;
|
|
@@ -755,7 +884,11 @@ export interface CatalogOverrideFields {
|
|
|
755
884
|
image?: string;
|
|
756
885
|
/** Payment method selected for the item. */
|
|
757
886
|
paymentOption?: PaymentOption;
|
|
758
|
-
/**
|
|
887
|
+
/**
|
|
888
|
+
* Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
|
|
889
|
+
* @format DECIMAL_VALUE
|
|
890
|
+
* @decimalValue options { gt:0, lte:999999999, maxScale:3 }
|
|
891
|
+
*/
|
|
759
892
|
depositAmount?: string | null;
|
|
760
893
|
/**
|
|
761
894
|
* Whether to save the payment method on the order.
|
|
@@ -766,11 +899,9 @@ export interface CatalogOverrideFields {
|
|
|
766
899
|
}
|
|
767
900
|
export interface PaymentOption {
|
|
768
901
|
/**
|
|
769
|
-
*
|
|
770
|
-
*
|
|
771
|
-
*
|
|
772
|
-
* + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
|
|
773
|
-
* + `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`.
|
|
902
|
+
* Type of selected payment option for current item.
|
|
903
|
+
*
|
|
904
|
+
* Default: `FULL_PAYMENT_ONLINE`
|
|
774
905
|
*/
|
|
775
906
|
value?: PaymentOptionType;
|
|
776
907
|
}
|
|
@@ -801,9 +932,17 @@ export interface ExtendedFields {
|
|
|
801
932
|
namespaces?: Record<string, Record<string, any>>;
|
|
802
933
|
}
|
|
803
934
|
export interface Policy {
|
|
804
|
-
/**
|
|
935
|
+
/**
|
|
936
|
+
* Policy title - should be translated
|
|
937
|
+
* @minLength 1
|
|
938
|
+
* @maxLength 29
|
|
939
|
+
*/
|
|
805
940
|
title?: string | null;
|
|
806
|
-
/**
|
|
941
|
+
/**
|
|
942
|
+
* Policy content - should be translated
|
|
943
|
+
* @minLength 1
|
|
944
|
+
* @maxLength 3000
|
|
945
|
+
*/
|
|
807
946
|
content?: string;
|
|
808
947
|
}
|
|
809
948
|
/** Billing Info and shipping details */
|
|
@@ -815,19 +954,37 @@ export interface AddressWithContact {
|
|
|
815
954
|
}
|
|
816
955
|
/** Physical address */
|
|
817
956
|
export interface ApiAddress {
|
|
818
|
-
/**
|
|
957
|
+
/**
|
|
958
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
959
|
+
* @format COUNTRY
|
|
960
|
+
*/
|
|
819
961
|
country?: string | null;
|
|
820
|
-
/**
|
|
962
|
+
/**
|
|
963
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
964
|
+
* @maxLength 50
|
|
965
|
+
*/
|
|
821
966
|
subdivision?: string | null;
|
|
822
|
-
/**
|
|
967
|
+
/**
|
|
968
|
+
* City name.
|
|
969
|
+
* @maxLength 50
|
|
970
|
+
*/
|
|
823
971
|
city?: string | null;
|
|
824
|
-
/**
|
|
972
|
+
/**
|
|
973
|
+
* Postal or zip code.
|
|
974
|
+
* @maxLength 50
|
|
975
|
+
*/
|
|
825
976
|
postalCode?: string | null;
|
|
826
977
|
/** Street address. */
|
|
827
978
|
streetAddress?: StreetAddress;
|
|
828
|
-
/**
|
|
979
|
+
/**
|
|
980
|
+
* Main address line (usually street name and number).
|
|
981
|
+
* @maxLength 150
|
|
982
|
+
*/
|
|
829
983
|
addressLine1?: string | null;
|
|
830
|
-
/**
|
|
984
|
+
/**
|
|
985
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
986
|
+
* @maxLength 100
|
|
987
|
+
*/
|
|
831
988
|
addressLine2?: string | null;
|
|
832
989
|
/**
|
|
833
990
|
* Country's full name.
|
|
@@ -854,13 +1011,25 @@ export interface AddressLocation {
|
|
|
854
1011
|
}
|
|
855
1012
|
/** Full contact details for an address */
|
|
856
1013
|
export interface FullAddressContactDetails {
|
|
857
|
-
/**
|
|
1014
|
+
/**
|
|
1015
|
+
* First name.
|
|
1016
|
+
* @maxLength 100
|
|
1017
|
+
*/
|
|
858
1018
|
firstName?: string | null;
|
|
859
|
-
/**
|
|
1019
|
+
/**
|
|
1020
|
+
* Last name.
|
|
1021
|
+
* @maxLength 100
|
|
1022
|
+
*/
|
|
860
1023
|
lastName?: string | null;
|
|
861
|
-
/**
|
|
1024
|
+
/**
|
|
1025
|
+
* Phone number.
|
|
1026
|
+
* @format PHONE
|
|
1027
|
+
*/
|
|
862
1028
|
phone?: string | null;
|
|
863
|
-
/**
|
|
1029
|
+
/**
|
|
1030
|
+
* Company name.
|
|
1031
|
+
* @maxLength 1000
|
|
1032
|
+
*/
|
|
864
1033
|
company?: string | null;
|
|
865
1034
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
866
1035
|
vatId?: CommonVatId;
|
|
@@ -902,11 +1071,15 @@ export interface ShippingInfo {
|
|
|
902
1071
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
903
1072
|
}
|
|
904
1073
|
export interface SelectedCarrierServiceOption {
|
|
905
|
-
/**
|
|
1074
|
+
/**
|
|
1075
|
+
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1076
|
+
* @maxLength 100
|
|
1077
|
+
*/
|
|
906
1078
|
code?: string;
|
|
907
1079
|
/**
|
|
908
1080
|
* Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
|
|
909
1081
|
* For example, "Standard" or "First-Class Package International".
|
|
1082
|
+
* @maxLength 250
|
|
910
1083
|
* @readonly
|
|
911
1084
|
*/
|
|
912
1085
|
title?: string;
|
|
@@ -927,17 +1100,29 @@ export interface SelectedCarrierServiceOption {
|
|
|
927
1100
|
requestedShippingOption?: boolean;
|
|
928
1101
|
/** Other charges */
|
|
929
1102
|
otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
|
|
930
|
-
/**
|
|
1103
|
+
/**
|
|
1104
|
+
* This carrier's unique ID
|
|
1105
|
+
* @format GUID
|
|
1106
|
+
*/
|
|
931
1107
|
carrierId?: string | null;
|
|
932
|
-
/**
|
|
1108
|
+
/**
|
|
1109
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
1110
|
+
* @maxSize 300
|
|
1111
|
+
*/
|
|
933
1112
|
deliveryAllocations?: DeliveryAllocation[];
|
|
934
1113
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
935
1114
|
partial?: boolean | null;
|
|
936
1115
|
}
|
|
937
1116
|
export interface DeliveryLogistics {
|
|
938
|
-
/**
|
|
1117
|
+
/**
|
|
1118
|
+
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
1119
|
+
* @maxLength 500
|
|
1120
|
+
*/
|
|
939
1121
|
deliveryTime?: string | null;
|
|
940
|
-
/**
|
|
1122
|
+
/**
|
|
1123
|
+
* Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
|
|
1124
|
+
* @maxLength 1000
|
|
1125
|
+
*/
|
|
941
1126
|
instructions?: string | null;
|
|
942
1127
|
/** Pickup details. */
|
|
943
1128
|
pickupDetails?: PickupDetails;
|
|
@@ -979,7 +1164,10 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
979
1164
|
export interface SelectedCarrierServiceOptionOtherCharge {
|
|
980
1165
|
/** Type of additional cost. */
|
|
981
1166
|
type?: ChargeType;
|
|
982
|
-
/**
|
|
1167
|
+
/**
|
|
1168
|
+
* Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
|
|
1169
|
+
* @maxLength 200
|
|
1170
|
+
*/
|
|
983
1171
|
details?: string | null;
|
|
984
1172
|
/** Price of added charge. */
|
|
985
1173
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
@@ -997,32 +1185,56 @@ export interface DeliveryAllocation {
|
|
|
997
1185
|
applicableLineItems?: ApplicableLineItems;
|
|
998
1186
|
}
|
|
999
1187
|
export interface Carrier {
|
|
1000
|
-
/**
|
|
1188
|
+
/**
|
|
1189
|
+
* The carrier app id
|
|
1190
|
+
* @format GUID
|
|
1191
|
+
*/
|
|
1001
1192
|
appId?: string | null;
|
|
1002
|
-
/**
|
|
1193
|
+
/**
|
|
1194
|
+
* Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
|
|
1195
|
+
* @maxLength 250
|
|
1196
|
+
*/
|
|
1003
1197
|
code?: string;
|
|
1004
1198
|
}
|
|
1005
1199
|
export interface Region {
|
|
1006
|
-
/**
|
|
1200
|
+
/**
|
|
1201
|
+
* The delivery region id.
|
|
1202
|
+
* @format GUID
|
|
1203
|
+
*/
|
|
1007
1204
|
_id?: string | null;
|
|
1008
|
-
/**
|
|
1205
|
+
/**
|
|
1206
|
+
* The delivery region name.
|
|
1207
|
+
* @maxLength 100
|
|
1208
|
+
*/
|
|
1009
1209
|
name?: string | null;
|
|
1010
1210
|
}
|
|
1011
1211
|
export interface ApplicableLineItems {
|
|
1012
|
-
/**
|
|
1212
|
+
/**
|
|
1213
|
+
* Line items that the delivery solution is for.
|
|
1214
|
+
* @maxSize 300
|
|
1215
|
+
* @minLength 1
|
|
1216
|
+
* @maxLength 100
|
|
1217
|
+
*/
|
|
1013
1218
|
lineItemIds?: string[];
|
|
1014
1219
|
}
|
|
1015
1220
|
export interface ShippingRegion {
|
|
1016
1221
|
/**
|
|
1017
1222
|
* Shipping region ID.
|
|
1223
|
+
* @format GUID
|
|
1018
1224
|
* @readonly
|
|
1019
1225
|
*/
|
|
1020
1226
|
_id?: string;
|
|
1021
|
-
/**
|
|
1227
|
+
/**
|
|
1228
|
+
* Shipping region name.
|
|
1229
|
+
* @maxLength 100
|
|
1230
|
+
*/
|
|
1022
1231
|
name?: string;
|
|
1023
1232
|
}
|
|
1024
1233
|
export interface CarrierServiceOption {
|
|
1025
|
-
/**
|
|
1234
|
+
/**
|
|
1235
|
+
* Carrier ID.
|
|
1236
|
+
* @format GUID
|
|
1237
|
+
*/
|
|
1026
1238
|
carrierId?: string;
|
|
1027
1239
|
/** Shipping options offered by this carrier for this request. */
|
|
1028
1240
|
shippingOptions?: ShippingOption[];
|
|
@@ -1031,18 +1243,23 @@ export interface ShippingOption {
|
|
|
1031
1243
|
/**
|
|
1032
1244
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
1033
1245
|
* For legacy calculators this would be the UUID of the option.
|
|
1246
|
+
* @maxLength 100
|
|
1034
1247
|
*/
|
|
1035
1248
|
code?: string;
|
|
1036
1249
|
/**
|
|
1037
1250
|
* Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
|
|
1038
1251
|
* For example, "Standard" or "First-Class Package International".
|
|
1252
|
+
* @maxLength 250
|
|
1039
1253
|
*/
|
|
1040
1254
|
title?: string;
|
|
1041
1255
|
/** Delivery logistics. */
|
|
1042
1256
|
logistics?: DeliveryLogistics;
|
|
1043
1257
|
/** Sipping price information. */
|
|
1044
1258
|
cost?: ShippingPrice;
|
|
1045
|
-
/**
|
|
1259
|
+
/**
|
|
1260
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
1261
|
+
* @maxSize 300
|
|
1262
|
+
*/
|
|
1046
1263
|
deliveryAllocations?: DeliveryAllocation[];
|
|
1047
1264
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1048
1265
|
partial?: boolean | null;
|
|
@@ -1062,31 +1279,39 @@ export interface OtherCharge {
|
|
|
1062
1279
|
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1063
1280
|
/**
|
|
1064
1281
|
* Visitor ID - if the buyer is **not** a site member.
|
|
1282
|
+
* @format GUID
|
|
1065
1283
|
* @readonly
|
|
1066
1284
|
*/
|
|
1067
1285
|
visitorId?: string;
|
|
1068
1286
|
/**
|
|
1069
1287
|
* Member ID - If the buyer is a site member.
|
|
1288
|
+
* @format GUID
|
|
1070
1289
|
* @readonly
|
|
1071
1290
|
*/
|
|
1072
1291
|
memberId?: string;
|
|
1073
1292
|
/**
|
|
1074
1293
|
* Contact ID. For more information, see the Contacts API.
|
|
1294
|
+
* @format GUID
|
|
1075
1295
|
* @readonly
|
|
1076
1296
|
*/
|
|
1077
1297
|
contactId?: string | null;
|
|
1078
|
-
/**
|
|
1298
|
+
/**
|
|
1299
|
+
* Buyer email address.
|
|
1300
|
+
* @format EMAIL
|
|
1301
|
+
*/
|
|
1079
1302
|
email?: string | null;
|
|
1080
1303
|
}
|
|
1081
1304
|
/** @oneof */
|
|
1082
1305
|
export interface BuyerInfoIdOneOf {
|
|
1083
1306
|
/**
|
|
1084
1307
|
* Visitor ID - if the buyer is **not** a site member.
|
|
1308
|
+
* @format GUID
|
|
1085
1309
|
* @readonly
|
|
1086
1310
|
*/
|
|
1087
1311
|
visitorId?: string;
|
|
1088
1312
|
/**
|
|
1089
1313
|
* Member ID - If the buyer is a site member.
|
|
1314
|
+
* @format GUID
|
|
1090
1315
|
* @readonly
|
|
1091
1316
|
*/
|
|
1092
1317
|
memberId?: string;
|
|
@@ -1247,11 +1472,16 @@ export interface GiftCard {
|
|
|
1247
1472
|
obfuscatedCode?: string;
|
|
1248
1473
|
/** Gift card value. */
|
|
1249
1474
|
amount?: MultiCurrencyPrice;
|
|
1250
|
-
/**
|
|
1475
|
+
/**
|
|
1476
|
+
* App ID of the gift card provider.
|
|
1477
|
+
* @format GUID
|
|
1478
|
+
*/
|
|
1251
1479
|
appId?: string;
|
|
1252
1480
|
/**
|
|
1253
1481
|
* External ID in the gift card provider's system.
|
|
1254
1482
|
* Used for integration and tracking across different platforms.
|
|
1483
|
+
* @minLength 1
|
|
1484
|
+
* @maxLength 50
|
|
1255
1485
|
*/
|
|
1256
1486
|
externalId?: string | null;
|
|
1257
1487
|
}
|
|
@@ -1266,6 +1496,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1266
1496
|
discountType?: DiscountType;
|
|
1267
1497
|
/**
|
|
1268
1498
|
* IDs of the line items the discount applies to.
|
|
1499
|
+
* @format GUID
|
|
1269
1500
|
* @deprecated IDs of line items the discount applies to.
|
|
1270
1501
|
* @replacedBy line_items_discounts
|
|
1271
1502
|
* @targetRemovalDate 2024-06-01
|
|
@@ -1275,6 +1506,8 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1275
1506
|
* Number of subscription cycle this discount applies to
|
|
1276
1507
|
* default None - all billing cycle
|
|
1277
1508
|
* @internal
|
|
1509
|
+
* @min 1
|
|
1510
|
+
* @max 999
|
|
1278
1511
|
*/
|
|
1279
1512
|
subscriptionCycles?: number | null;
|
|
1280
1513
|
}
|
|
@@ -1306,11 +1539,18 @@ export interface Coupon {
|
|
|
1306
1539
|
export interface MerchantDiscount {
|
|
1307
1540
|
/** Discount value. */
|
|
1308
1541
|
amount?: MultiCurrencyPrice;
|
|
1309
|
-
/**
|
|
1542
|
+
/**
|
|
1543
|
+
* Discount Percentage. Will be calculated from items price before other discounts.
|
|
1544
|
+
* @min 1
|
|
1545
|
+
* @max 100
|
|
1546
|
+
*/
|
|
1310
1547
|
percentage?: number | null;
|
|
1311
1548
|
}
|
|
1312
1549
|
export interface DiscountRule {
|
|
1313
|
-
/**
|
|
1550
|
+
/**
|
|
1551
|
+
* Discount rule ID
|
|
1552
|
+
* @format GUID
|
|
1553
|
+
*/
|
|
1314
1554
|
_id?: string;
|
|
1315
1555
|
/** Discount rule name */
|
|
1316
1556
|
name?: DiscountRuleName;
|
|
@@ -1318,13 +1558,24 @@ export interface DiscountRule {
|
|
|
1318
1558
|
amount?: MultiCurrencyPrice;
|
|
1319
1559
|
}
|
|
1320
1560
|
export interface DiscountRuleName {
|
|
1321
|
-
/**
|
|
1561
|
+
/**
|
|
1562
|
+
* Original discount rule name (in site's default language).
|
|
1563
|
+
* @minLength 1
|
|
1564
|
+
* @maxLength 256
|
|
1565
|
+
*/
|
|
1322
1566
|
original?: string;
|
|
1323
|
-
/**
|
|
1567
|
+
/**
|
|
1568
|
+
* Translated discount rule name according to buyer language. Defaults to `original` when not provided.
|
|
1569
|
+
* @minLength 1
|
|
1570
|
+
* @maxLength 500
|
|
1571
|
+
*/
|
|
1324
1572
|
translated?: string | null;
|
|
1325
1573
|
}
|
|
1326
1574
|
export interface LineItemDiscount {
|
|
1327
|
-
/**
|
|
1575
|
+
/**
|
|
1576
|
+
* ID of line item the discount applies to.
|
|
1577
|
+
* @format GUID
|
|
1578
|
+
*/
|
|
1328
1579
|
_id?: string;
|
|
1329
1580
|
/** Discount value. */
|
|
1330
1581
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
@@ -1332,9 +1583,17 @@ export interface LineItemDiscount {
|
|
|
1332
1583
|
export interface CustomField {
|
|
1333
1584
|
/** Custom field value. */
|
|
1334
1585
|
value?: any;
|
|
1335
|
-
/**
|
|
1586
|
+
/**
|
|
1587
|
+
* Custom field title.
|
|
1588
|
+
* @minLength 1
|
|
1589
|
+
* @maxLength 500
|
|
1590
|
+
*/
|
|
1336
1591
|
title?: string;
|
|
1337
|
-
/**
|
|
1592
|
+
/**
|
|
1593
|
+
* Translated custom field title.
|
|
1594
|
+
* @minLength 1
|
|
1595
|
+
* @maxLength 500
|
|
1596
|
+
*/
|
|
1338
1597
|
translatedTitle?: string | null;
|
|
1339
1598
|
}
|
|
1340
1599
|
export declare enum WeightUnit {
|
|
@@ -1410,15 +1669,27 @@ export declare enum FallbackReason {
|
|
|
1410
1669
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1411
1670
|
*/
|
|
1412
1671
|
export interface AggregatedTaxBreakdown {
|
|
1413
|
-
/**
|
|
1672
|
+
/**
|
|
1673
|
+
* The name of the tax against which this tax amount was calculated.
|
|
1674
|
+
* @maxLength 200
|
|
1675
|
+
*/
|
|
1414
1676
|
taxName?: string;
|
|
1415
|
-
/**
|
|
1677
|
+
/**
|
|
1678
|
+
* The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
|
|
1679
|
+
* @maxLength 200
|
|
1680
|
+
*/
|
|
1416
1681
|
taxType?: string;
|
|
1417
|
-
/**
|
|
1682
|
+
/**
|
|
1683
|
+
* The name of the jurisdiction in which this tax detail applies.
|
|
1684
|
+
* @maxLength 200
|
|
1685
|
+
*/
|
|
1418
1686
|
jurisdiction?: string;
|
|
1419
1687
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1420
1688
|
jurisdictionTypeEnum?: JurisdictionType;
|
|
1421
|
-
/**
|
|
1689
|
+
/**
|
|
1690
|
+
* The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
|
|
1691
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
1692
|
+
*/
|
|
1422
1693
|
rate?: string;
|
|
1423
1694
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1424
1695
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
@@ -1461,13 +1732,23 @@ export interface CreatedBy extends CreatedByIdOneOf {
|
|
|
1461
1732
|
/**
|
|
1462
1733
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1463
1734
|
* For example, via POS (point of service).
|
|
1735
|
+
* @format GUID
|
|
1464
1736
|
*/
|
|
1465
1737
|
userId?: string;
|
|
1466
|
-
/**
|
|
1738
|
+
/**
|
|
1739
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
1740
|
+
* @format GUID
|
|
1741
|
+
*/
|
|
1467
1742
|
memberId?: string;
|
|
1468
|
-
/**
|
|
1743
|
+
/**
|
|
1744
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
1745
|
+
* @format GUID
|
|
1746
|
+
*/
|
|
1469
1747
|
visitorId?: string;
|
|
1470
|
-
/**
|
|
1748
|
+
/**
|
|
1749
|
+
* App ID - when the order was created by an external application or Wix service.
|
|
1750
|
+
* @format GUID
|
|
1751
|
+
*/
|
|
1471
1752
|
appId?: string;
|
|
1472
1753
|
}
|
|
1473
1754
|
/** @oneof */
|
|
@@ -1475,13 +1756,23 @@ export interface CreatedByIdOneOf {
|
|
|
1475
1756
|
/**
|
|
1476
1757
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1477
1758
|
* For example, via POS (point of service).
|
|
1759
|
+
* @format GUID
|
|
1478
1760
|
*/
|
|
1479
1761
|
userId?: string;
|
|
1480
|
-
/**
|
|
1762
|
+
/**
|
|
1763
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
1764
|
+
* @format GUID
|
|
1765
|
+
*/
|
|
1481
1766
|
memberId?: string;
|
|
1482
|
-
/**
|
|
1767
|
+
/**
|
|
1768
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
1769
|
+
* @format GUID
|
|
1770
|
+
*/
|
|
1483
1771
|
visitorId?: string;
|
|
1484
|
-
/**
|
|
1772
|
+
/**
|
|
1773
|
+
* App ID - when the order was created by an external application or Wix service.
|
|
1774
|
+
* @format GUID
|
|
1775
|
+
*/
|
|
1485
1776
|
appId?: string;
|
|
1486
1777
|
}
|
|
1487
1778
|
/** Reserved for internal use. */
|
|
@@ -1489,24 +1780,39 @@ export interface MembershipOptions {
|
|
|
1489
1780
|
/**
|
|
1490
1781
|
* Reserved for internal use.
|
|
1491
1782
|
* @readonly
|
|
1783
|
+
* @maxSize 300
|
|
1492
1784
|
*/
|
|
1493
1785
|
eligibleMemberships?: Membership[];
|
|
1494
1786
|
/**
|
|
1495
1787
|
* Reserved for internal use.
|
|
1496
1788
|
* @readonly
|
|
1789
|
+
* @maxSize 300
|
|
1497
1790
|
*/
|
|
1498
1791
|
invalidMemberships?: InvalidMembership[];
|
|
1499
1792
|
/** Selected membership to apply to this checkout. */
|
|
1500
1793
|
selectedMemberships?: SelectedMemberships;
|
|
1501
1794
|
}
|
|
1502
1795
|
export interface Membership {
|
|
1503
|
-
/**
|
|
1796
|
+
/**
|
|
1797
|
+
* Membership ID.
|
|
1798
|
+
* @minLength 1
|
|
1799
|
+
* @maxLength 100
|
|
1800
|
+
*/
|
|
1504
1801
|
_id?: string;
|
|
1505
|
-
/**
|
|
1802
|
+
/**
|
|
1803
|
+
* ID of the application providing this payment option.
|
|
1804
|
+
* @format GUID
|
|
1805
|
+
*/
|
|
1506
1806
|
appId?: string;
|
|
1507
1807
|
/** The name of this membership. */
|
|
1508
1808
|
name?: MembershipName;
|
|
1509
|
-
/**
|
|
1809
|
+
/**
|
|
1810
|
+
* Line item IDs which are "paid for" by this membership.
|
|
1811
|
+
* @minSize 1
|
|
1812
|
+
* @maxSize 300
|
|
1813
|
+
* @minLength 1
|
|
1814
|
+
* @maxLength 100
|
|
1815
|
+
*/
|
|
1510
1816
|
lineItemIds?: string[];
|
|
1511
1817
|
/** Optional - For a membership that has limited credits, information about credit usage. */
|
|
1512
1818
|
credits?: MembershipPaymentCredits;
|
|
@@ -1516,13 +1822,22 @@ export interface Membership {
|
|
|
1516
1822
|
additionalData?: Record<string, any> | null;
|
|
1517
1823
|
}
|
|
1518
1824
|
export interface MembershipName {
|
|
1519
|
-
/**
|
|
1825
|
+
/**
|
|
1826
|
+
* Membership name.
|
|
1827
|
+
* @maxLength 100
|
|
1828
|
+
*/
|
|
1520
1829
|
original?: string;
|
|
1521
|
-
/**
|
|
1830
|
+
/**
|
|
1831
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
1832
|
+
* @maxLength 100
|
|
1833
|
+
*/
|
|
1522
1834
|
translated?: string | null;
|
|
1523
1835
|
}
|
|
1524
1836
|
export interface MembershipPaymentCredits {
|
|
1525
|
-
/**
|
|
1837
|
+
/**
|
|
1838
|
+
* Membership's total amount of credits.
|
|
1839
|
+
* @min 1
|
|
1840
|
+
*/
|
|
1526
1841
|
total?: number;
|
|
1527
1842
|
/** Membership's remaining amount of credits. */
|
|
1528
1843
|
remaining?: number;
|
|
@@ -1530,31 +1845,63 @@ export interface MembershipPaymentCredits {
|
|
|
1530
1845
|
export interface InvalidMembership {
|
|
1531
1846
|
/** Membership details. */
|
|
1532
1847
|
membership?: Membership;
|
|
1533
|
-
/**
|
|
1848
|
+
/**
|
|
1849
|
+
* Reason why this membership is invalid and cannot be used.
|
|
1850
|
+
* @minLength 1
|
|
1851
|
+
* @maxLength 100
|
|
1852
|
+
*/
|
|
1534
1853
|
reason?: string;
|
|
1535
1854
|
}
|
|
1536
1855
|
export interface SelectedMemberships {
|
|
1537
|
-
/**
|
|
1856
|
+
/**
|
|
1857
|
+
* Selected memberships.
|
|
1858
|
+
* @maxSize 300
|
|
1859
|
+
*/
|
|
1538
1860
|
memberships?: SelectedMembership[];
|
|
1539
1861
|
}
|
|
1540
1862
|
export interface SelectedMembership {
|
|
1541
|
-
/**
|
|
1863
|
+
/**
|
|
1864
|
+
* Membership ID.
|
|
1865
|
+
* @minLength 1
|
|
1866
|
+
* @maxLength 100
|
|
1867
|
+
*/
|
|
1542
1868
|
_id?: string;
|
|
1543
|
-
/**
|
|
1869
|
+
/**
|
|
1870
|
+
* ID of the app providing this payment option.
|
|
1871
|
+
* @format GUID
|
|
1872
|
+
*/
|
|
1544
1873
|
appId?: string;
|
|
1545
|
-
/**
|
|
1874
|
+
/**
|
|
1875
|
+
* IDs of the line items this membership applies to.
|
|
1876
|
+
* @minSize 1
|
|
1877
|
+
* @maxSize 300
|
|
1878
|
+
* @minLength 1
|
|
1879
|
+
* @maxLength 100
|
|
1880
|
+
*/
|
|
1546
1881
|
lineItemIds?: string[];
|
|
1547
1882
|
}
|
|
1548
1883
|
export interface AdditionalFee {
|
|
1549
|
-
/**
|
|
1884
|
+
/**
|
|
1885
|
+
* Additional fee's unique code (or ID) for future processing.
|
|
1886
|
+
* @minLength 1
|
|
1887
|
+
* @maxLength 100
|
|
1888
|
+
*/
|
|
1550
1889
|
code?: string | null;
|
|
1551
|
-
/**
|
|
1890
|
+
/**
|
|
1891
|
+
* Translated additional fee's name.
|
|
1892
|
+
* @minLength 1
|
|
1893
|
+
* @maxLength 50
|
|
1894
|
+
*/
|
|
1552
1895
|
name?: string;
|
|
1553
1896
|
/** Additional fee's price. */
|
|
1554
1897
|
price?: MultiCurrencyPrice;
|
|
1555
1898
|
/** Tax details. */
|
|
1556
1899
|
taxDetails?: ItemTaxFullDetails;
|
|
1557
|
-
/**
|
|
1900
|
+
/**
|
|
1901
|
+
* Provider's app id.
|
|
1902
|
+
* @minLength 1
|
|
1903
|
+
* @maxLength 100
|
|
1904
|
+
*/
|
|
1558
1905
|
providerAppId?: string | null;
|
|
1559
1906
|
/** Additional fee's price before tax. */
|
|
1560
1907
|
priceBeforeTax?: MultiCurrencyPrice;
|
|
@@ -1563,12 +1910,15 @@ export interface AdditionalFee {
|
|
|
1563
1910
|
/**
|
|
1564
1911
|
* Optional - Line items associated with this additional fee.
|
|
1565
1912
|
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
1913
|
+
* @format GUID
|
|
1566
1914
|
*/
|
|
1567
1915
|
lineItemIds?: string[];
|
|
1568
1916
|
/**
|
|
1569
1917
|
* Number of subscription cycle this fee applies to
|
|
1570
1918
|
* default None - all billing cycle
|
|
1571
1919
|
* @internal
|
|
1920
|
+
* @min 1
|
|
1921
|
+
* @max 999
|
|
1572
1922
|
*/
|
|
1573
1923
|
subscriptionCycles?: number | null;
|
|
1574
1924
|
/** the source the additional fee was added from */
|
|
@@ -1587,11 +1937,13 @@ export interface ConversionInfo {
|
|
|
1587
1937
|
/**
|
|
1588
1938
|
* The site currency.
|
|
1589
1939
|
* @readonly
|
|
1940
|
+
* @format CURRENCY
|
|
1590
1941
|
*/
|
|
1591
1942
|
siteCurrency?: string;
|
|
1592
1943
|
/**
|
|
1593
1944
|
* The rate used when converting from the site currency to the checkout currency.
|
|
1594
1945
|
* @readonly
|
|
1946
|
+
* @decimalValue options { gt:0, lte:1000000000000000 }
|
|
1595
1947
|
*/
|
|
1596
1948
|
conversionRate?: string;
|
|
1597
1949
|
}
|
|
@@ -1600,7 +1952,11 @@ export interface Violation {
|
|
|
1600
1952
|
severity?: Severity;
|
|
1601
1953
|
/** Target location on a checkout or cart page where the violation will be displayed. */
|
|
1602
1954
|
target?: Target;
|
|
1603
|
-
/**
|
|
1955
|
+
/**
|
|
1956
|
+
* 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>`.
|
|
1957
|
+
* @minLength 1
|
|
1958
|
+
* @maxLength 1000
|
|
1959
|
+
*/
|
|
1604
1960
|
description?: string | null;
|
|
1605
1961
|
}
|
|
1606
1962
|
export declare enum Severity {
|
|
@@ -1689,12 +2045,14 @@ export interface CustomContentReference {
|
|
|
1689
2045
|
* ID of the app providing the content.
|
|
1690
2046
|
*
|
|
1691
2047
|
* You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
|
|
2048
|
+
* @format GUID
|
|
1692
2049
|
*/
|
|
1693
2050
|
appId?: string;
|
|
1694
2051
|
/**
|
|
1695
2052
|
* ID of the component within the app it belongs to.
|
|
1696
2053
|
*
|
|
1697
2054
|
* You can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
|
|
2055
|
+
* @format GUID
|
|
1698
2056
|
*/
|
|
1699
2057
|
componentId?: string;
|
|
1700
2058
|
}
|
|
@@ -1702,14 +2060,49 @@ export interface ExternalReference {
|
|
|
1702
2060
|
/**
|
|
1703
2061
|
* ID of the app associated with the purchase flow.
|
|
1704
2062
|
* For example, the Wix Pay Links app ID.
|
|
2063
|
+
* @format GUID
|
|
2064
|
+
* @immutable
|
|
1705
2065
|
*/
|
|
1706
2066
|
appId?: string;
|
|
1707
2067
|
/**
|
|
1708
2068
|
* Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
|
|
1709
2069
|
* For example, a Wix Pay Link ID.
|
|
2070
|
+
* @minLength 1
|
|
2071
|
+
* @maxLength 100
|
|
2072
|
+
* @immutable
|
|
1710
2073
|
*/
|
|
1711
2074
|
resourceId?: string | null;
|
|
1712
2075
|
}
|
|
2076
|
+
export interface SubscriptionCharges {
|
|
2077
|
+
/**
|
|
2078
|
+
* ids of the items the subscription is defined on
|
|
2079
|
+
* @format GUID
|
|
2080
|
+
* @minSize 1
|
|
2081
|
+
* @maxSize 300
|
|
2082
|
+
*/
|
|
2083
|
+
lineItemIds?: string[];
|
|
2084
|
+
/**
|
|
2085
|
+
* Generated description explaining future charges amount and schedule.
|
|
2086
|
+
* Translated to subscription order buyer language, or to site language if was not provided.
|
|
2087
|
+
* @maxLength 1000
|
|
2088
|
+
*/
|
|
2089
|
+
description?: string | null;
|
|
2090
|
+
/**
|
|
2091
|
+
* Charges for subscription.
|
|
2092
|
+
* @maxSize 50
|
|
2093
|
+
*/
|
|
2094
|
+
charges?: Charge[];
|
|
2095
|
+
}
|
|
2096
|
+
export interface Charge {
|
|
2097
|
+
/** The cycle number from which the charge starts. */
|
|
2098
|
+
cycleFrom?: number;
|
|
2099
|
+
/** The number of cycles for which the charge is applicable. */
|
|
2100
|
+
cycleCount?: number | null;
|
|
2101
|
+
/** Charge summary. */
|
|
2102
|
+
priceSummary?: PriceSummary;
|
|
2103
|
+
/** The billing date from which the charge starts. */
|
|
2104
|
+
cycleBillingDate?: Date | null;
|
|
2105
|
+
}
|
|
1713
2106
|
export interface UpdatedCheckoutMessage {
|
|
1714
2107
|
/** Previous checkout. */
|
|
1715
2108
|
oldCheckout?: Checkout;
|
|
@@ -1721,28 +2114,20 @@ export interface CreateCheckoutRequest {
|
|
|
1721
2114
|
checkoutInfo?: Checkout;
|
|
1722
2115
|
/** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
1723
2116
|
couponCode?: string | null;
|
|
1724
|
-
/**
|
|
2117
|
+
/**
|
|
2118
|
+
* Catalog line items to add to the checkout.
|
|
2119
|
+
* @maxSize 300
|
|
2120
|
+
*/
|
|
1725
2121
|
lineItems?: LineItem[];
|
|
1726
2122
|
/**
|
|
1727
2123
|
* Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
|
|
1728
2124
|
*
|
|
1729
2125
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
1730
2126
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2127
|
+
* @maxSize 300
|
|
1731
2128
|
*/
|
|
1732
2129
|
customLineItems?: CustomLineItem[];
|
|
1733
|
-
/**
|
|
1734
|
-
* Sales channel that submitted the order.
|
|
1735
|
-
* + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
|
|
1736
|
-
* + `"WEB"`: A web client.
|
|
1737
|
-
* + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
|
|
1738
|
-
* + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
|
|
1739
|
-
* + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
|
|
1740
|
-
* + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
|
|
1741
|
-
* + `"WIX_INVOICES"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
|
|
1742
|
-
* + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
|
|
1743
|
-
* + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
|
|
1744
|
-
* + `"OTHER_PLATFORM"`: Other sales platform.
|
|
1745
|
-
*/
|
|
2130
|
+
/** Sales channel that submitted the order. */
|
|
1746
2131
|
channelType: ChannelType;
|
|
1747
2132
|
/**
|
|
1748
2133
|
* Gift card code.
|
|
@@ -1756,6 +2141,7 @@ export interface CreateCheckoutRequest {
|
|
|
1756
2141
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
1757
2142
|
*
|
|
1758
2143
|
* 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`.
|
|
2144
|
+
* @maxLength 1000
|
|
1759
2145
|
*/
|
|
1760
2146
|
overrideCheckoutUrl?: string | null;
|
|
1761
2147
|
}
|
|
@@ -1765,13 +2151,22 @@ export interface CustomLineItem {
|
|
|
1765
2151
|
*
|
|
1766
2152
|
* Min: `1`
|
|
1767
2153
|
* Max: `100000`
|
|
2154
|
+
* @min 1
|
|
2155
|
+
* @max 100000
|
|
1768
2156
|
*/
|
|
1769
2157
|
quantity?: number;
|
|
1770
|
-
/**
|
|
2158
|
+
/**
|
|
2159
|
+
* Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend.
|
|
2160
|
+
* @format DECIMAL_VALUE
|
|
2161
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
2162
|
+
*/
|
|
1771
2163
|
price?: string;
|
|
1772
2164
|
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
1773
2165
|
priceDescription?: PriceDescription;
|
|
1774
|
-
/**
|
|
2166
|
+
/**
|
|
2167
|
+
* Custom line item description lines. Used for displaying the cart, checkout and order.
|
|
2168
|
+
* @maxSize 10
|
|
2169
|
+
*/
|
|
1775
2170
|
descriptionLines?: DescriptionLine[];
|
|
1776
2171
|
/**
|
|
1777
2172
|
* Custom line item media.
|
|
@@ -1783,9 +2178,13 @@ export interface CustomLineItem {
|
|
|
1783
2178
|
* Custom line item ID. If passed, `id` must be unique.
|
|
1784
2179
|
*
|
|
1785
2180
|
* Default: auto-generated ID
|
|
2181
|
+
* @format GUID
|
|
1786
2182
|
*/
|
|
1787
2183
|
_id?: string | null;
|
|
1788
|
-
/**
|
|
2184
|
+
/**
|
|
2185
|
+
* Tax group ID for this custom line item.
|
|
2186
|
+
* @format GUID
|
|
2187
|
+
*/
|
|
1789
2188
|
taxGroupId?: string | null;
|
|
1790
2189
|
/** Name of the item or product. */
|
|
1791
2190
|
productName?: ProductName;
|
|
@@ -1793,11 +2192,15 @@ export interface CustomLineItem {
|
|
|
1793
2192
|
url?: string;
|
|
1794
2193
|
/** Item type. Either a preset type or custom. */
|
|
1795
2194
|
itemType?: ItemType;
|
|
1796
|
-
/**
|
|
2195
|
+
/**
|
|
2196
|
+
* Item price **before** catalog-defined discount. Defaults to `price` when not provided.
|
|
2197
|
+
* @format DECIMAL_VALUE
|
|
2198
|
+
*/
|
|
1797
2199
|
fullPrice?: string | null;
|
|
1798
2200
|
/**
|
|
1799
2201
|
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
1800
2202
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
2203
|
+
* @max 100000
|
|
1801
2204
|
*/
|
|
1802
2205
|
quantityAvailable?: number | null;
|
|
1803
2206
|
/** Physical properties of the item. */
|
|
@@ -1822,6 +2225,8 @@ export interface CustomLineItem {
|
|
|
1822
2225
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
1823
2226
|
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
1824
2227
|
* + Used in membership validation.
|
|
2228
|
+
* @minLength 1
|
|
2229
|
+
* @maxLength 36
|
|
1825
2230
|
*/
|
|
1826
2231
|
rootCatalogItemId?: string | null;
|
|
1827
2232
|
/**
|
|
@@ -1829,11 +2234,12 @@ export interface CustomLineItem {
|
|
|
1829
2234
|
*
|
|
1830
2235
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
1831
2236
|
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
2237
|
+
* @format DECIMAL_VALUE
|
|
1832
2238
|
*/
|
|
1833
2239
|
depositAmount?: string | null;
|
|
1834
2240
|
/**
|
|
1835
|
-
* Delivery
|
|
1836
|
-
* @
|
|
2241
|
+
* Delivery profile ID.
|
|
2242
|
+
* @format GUID
|
|
1837
2243
|
*/
|
|
1838
2244
|
deliveryProfileId?: string | null;
|
|
1839
2245
|
/** 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. */
|
|
@@ -1854,6 +2260,8 @@ export interface CustomLineItem {
|
|
|
1854
2260
|
fixedQuantity?: boolean;
|
|
1855
2261
|
/**
|
|
1856
2262
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
2263
|
+
* @minLength 1
|
|
2264
|
+
* @maxLength 1000
|
|
1857
2265
|
* @readonly
|
|
1858
2266
|
*/
|
|
1859
2267
|
consentRequiredPaymentPolicy?: string | null;
|
|
@@ -1867,11 +2275,13 @@ export interface CustomLineItem {
|
|
|
1867
2275
|
/**
|
|
1868
2276
|
* Policies to be displayed to the customer on the checkout page.
|
|
1869
2277
|
* @internal
|
|
2278
|
+
* @maxSize 5
|
|
1870
2279
|
*/
|
|
1871
2280
|
policies?: Policy[];
|
|
1872
2281
|
/**
|
|
1873
2282
|
* ID of the app managing the inventory.
|
|
1874
2283
|
* @internal
|
|
2284
|
+
* @format GUID
|
|
1875
2285
|
*/
|
|
1876
2286
|
inventoryAppId?: string | null;
|
|
1877
2287
|
/**
|
|
@@ -1881,11 +2291,23 @@ export interface CustomLineItem {
|
|
|
1881
2291
|
* @internal
|
|
1882
2292
|
*/
|
|
1883
2293
|
membersOnly?: boolean;
|
|
2294
|
+
/**
|
|
2295
|
+
* Address to use for tax calculation purposes.
|
|
2296
|
+
* @internal
|
|
2297
|
+
*/
|
|
2298
|
+
taxableAddress?: TaxableAddress;
|
|
1884
2299
|
}
|
|
1885
2300
|
export interface MerchantDiscountInput {
|
|
1886
|
-
/**
|
|
2301
|
+
/**
|
|
2302
|
+
* Discount amount.
|
|
2303
|
+
* @decimalValue options { gte:0 }
|
|
2304
|
+
*/
|
|
1887
2305
|
amount?: string;
|
|
1888
|
-
/**
|
|
2306
|
+
/**
|
|
2307
|
+
* IDs of the line items the discount applies to.
|
|
2308
|
+
* @format GUID
|
|
2309
|
+
* @maxSize 300
|
|
2310
|
+
*/
|
|
1889
2311
|
lineItemIds?: string[];
|
|
1890
2312
|
}
|
|
1891
2313
|
export interface CreateCheckoutResponse {
|
|
@@ -1902,7 +2324,10 @@ export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
|
|
|
1902
2324
|
carrierErrors?: CarrierErrors;
|
|
1903
2325
|
}
|
|
1904
2326
|
export interface GetCheckoutRequest {
|
|
1905
|
-
/**
|
|
2327
|
+
/**
|
|
2328
|
+
* Checkout ID.
|
|
2329
|
+
* @format GUID
|
|
2330
|
+
*/
|
|
1906
2331
|
_id: string;
|
|
1907
2332
|
}
|
|
1908
2333
|
export interface GetCheckoutResponse {
|
|
@@ -1910,7 +2335,10 @@ export interface GetCheckoutResponse {
|
|
|
1910
2335
|
checkout?: Checkout;
|
|
1911
2336
|
}
|
|
1912
2337
|
export interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
1913
|
-
/**
|
|
2338
|
+
/**
|
|
2339
|
+
* Checkout ID.
|
|
2340
|
+
* @format GUID
|
|
2341
|
+
*/
|
|
1914
2342
|
_id?: string;
|
|
1915
2343
|
}
|
|
1916
2344
|
export interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
@@ -1918,7 +2346,10 @@ export interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
|
1918
2346
|
checkout?: Checkout;
|
|
1919
2347
|
}
|
|
1920
2348
|
export interface GetCheckoutByCartIdRequest {
|
|
1921
|
-
/**
|
|
2349
|
+
/**
|
|
2350
|
+
* Cart ID.
|
|
2351
|
+
* @format GUID
|
|
2352
|
+
*/
|
|
1922
2353
|
_id: string;
|
|
1923
2354
|
}
|
|
1924
2355
|
export interface GetCheckoutByCartIdResponse {
|
|
@@ -1926,7 +2357,10 @@ export interface GetCheckoutByCartIdResponse {
|
|
|
1926
2357
|
checkout?: Checkout;
|
|
1927
2358
|
}
|
|
1928
2359
|
export interface GetWixCheckoutURLRequest {
|
|
1929
|
-
/**
|
|
2360
|
+
/**
|
|
2361
|
+
* Checkout ID.
|
|
2362
|
+
* @format GUID
|
|
2363
|
+
*/
|
|
1930
2364
|
_id: string;
|
|
1931
2365
|
}
|
|
1932
2366
|
export interface GetWixCheckoutURLResponse {
|
|
@@ -1934,7 +2368,10 @@ export interface GetWixCheckoutURLResponse {
|
|
|
1934
2368
|
checkoutUrl?: string;
|
|
1935
2369
|
}
|
|
1936
2370
|
export interface GetCheckoutURLRequest {
|
|
1937
|
-
/**
|
|
2371
|
+
/**
|
|
2372
|
+
* Checkout ID.
|
|
2373
|
+
* @format GUID
|
|
2374
|
+
*/
|
|
1938
2375
|
_id: string;
|
|
1939
2376
|
}
|
|
1940
2377
|
export interface GetCheckoutURLResponse {
|
|
@@ -1952,15 +2389,20 @@ export interface UpdateCheckoutRequest {
|
|
|
1952
2389
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
1953
2390
|
*
|
|
1954
2391
|
* 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`.
|
|
2392
|
+
* @maxLength 1000
|
|
1955
2393
|
*/
|
|
1956
2394
|
overrideCheckoutUrl?: string | null;
|
|
1957
|
-
/**
|
|
2395
|
+
/**
|
|
2396
|
+
* Catalog line items.
|
|
2397
|
+
* @maxSize 300
|
|
2398
|
+
*/
|
|
1958
2399
|
lineItems?: LineItem[];
|
|
1959
2400
|
/**
|
|
1960
2401
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
1961
2402
|
*
|
|
1962
2403
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
1963
2404
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2405
|
+
* @maxSize 300
|
|
1964
2406
|
*/
|
|
1965
2407
|
customLineItems?: CustomLineItem[];
|
|
1966
2408
|
}
|
|
@@ -1969,7 +2411,10 @@ export interface UpdateCheckoutResponse {
|
|
|
1969
2411
|
checkout?: Checkout;
|
|
1970
2412
|
}
|
|
1971
2413
|
export interface RemoveCouponRequest {
|
|
1972
|
-
/**
|
|
2414
|
+
/**
|
|
2415
|
+
* ID of the checkout to remove the coupon from.
|
|
2416
|
+
* @format GUID
|
|
2417
|
+
*/
|
|
1973
2418
|
_id: string;
|
|
1974
2419
|
}
|
|
1975
2420
|
export interface RemoveCouponResponse {
|
|
@@ -1977,7 +2422,10 @@ export interface RemoveCouponResponse {
|
|
|
1977
2422
|
checkout?: Checkout;
|
|
1978
2423
|
}
|
|
1979
2424
|
export interface RemoveGiftCardRequest {
|
|
1980
|
-
/**
|
|
2425
|
+
/**
|
|
2426
|
+
* ID of the checkout to remove the gift card from.
|
|
2427
|
+
* @format GUID
|
|
2428
|
+
*/
|
|
1981
2429
|
_id: string;
|
|
1982
2430
|
}
|
|
1983
2431
|
export interface RemoveGiftCardResponse {
|
|
@@ -1985,7 +2433,10 @@ export interface RemoveGiftCardResponse {
|
|
|
1985
2433
|
checkout?: Checkout;
|
|
1986
2434
|
}
|
|
1987
2435
|
export interface RemoveOverrideCheckoutUrlRequest {
|
|
1988
|
-
/**
|
|
2436
|
+
/**
|
|
2437
|
+
* ID of the checkout to remove the override checkout url from.
|
|
2438
|
+
* @format GUID
|
|
2439
|
+
*/
|
|
1989
2440
|
_id: string;
|
|
1990
2441
|
}
|
|
1991
2442
|
export interface RemoveOverrideCheckoutUrlResponse {
|
|
@@ -1993,15 +2444,22 @@ export interface RemoveOverrideCheckoutUrlResponse {
|
|
|
1993
2444
|
checkout?: Checkout;
|
|
1994
2445
|
}
|
|
1995
2446
|
export interface AddToCheckoutRequest {
|
|
1996
|
-
/**
|
|
2447
|
+
/**
|
|
2448
|
+
* Checkout ID.
|
|
2449
|
+
* @format GUID
|
|
2450
|
+
*/
|
|
1997
2451
|
_id: string;
|
|
1998
|
-
/**
|
|
2452
|
+
/**
|
|
2453
|
+
* Catalog line items.
|
|
2454
|
+
* @maxSize 100
|
|
2455
|
+
*/
|
|
1999
2456
|
lineItems?: LineItem[];
|
|
2000
2457
|
/**
|
|
2001
2458
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
2002
2459
|
*
|
|
2003
2460
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
2004
2461
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
2462
|
+
* @maxSize 100
|
|
2005
2463
|
*/
|
|
2006
2464
|
customLineItems?: CustomLineItem[];
|
|
2007
2465
|
}
|
|
@@ -2010,9 +2468,17 @@ export interface AddToCheckoutResponse {
|
|
|
2010
2468
|
checkout?: Checkout;
|
|
2011
2469
|
}
|
|
2012
2470
|
export interface RemoveLineItemsRequest {
|
|
2013
|
-
/**
|
|
2471
|
+
/**
|
|
2472
|
+
* ID of the checkout to remove line items from.
|
|
2473
|
+
* @format GUID
|
|
2474
|
+
*/
|
|
2014
2475
|
_id: string;
|
|
2015
|
-
/**
|
|
2476
|
+
/**
|
|
2477
|
+
* IDs of the line items to remove from the checkout.
|
|
2478
|
+
* @format GUID
|
|
2479
|
+
* @minSize 1
|
|
2480
|
+
* @maxSize 300
|
|
2481
|
+
*/
|
|
2016
2482
|
lineItemIds: string[];
|
|
2017
2483
|
}
|
|
2018
2484
|
export interface RemoveLineItemsResponse {
|
|
@@ -2020,7 +2486,10 @@ export interface RemoveLineItemsResponse {
|
|
|
2020
2486
|
checkout?: Checkout;
|
|
2021
2487
|
}
|
|
2022
2488
|
export interface CreateOrderRequest {
|
|
2023
|
-
/**
|
|
2489
|
+
/**
|
|
2490
|
+
* Checkout ID.
|
|
2491
|
+
* @format GUID
|
|
2492
|
+
*/
|
|
2024
2493
|
_id: string;
|
|
2025
2494
|
/** Indicates the payment method should be saved on the order */
|
|
2026
2495
|
savePaymentMethod?: boolean;
|
|
@@ -2028,9 +2497,15 @@ export interface CreateOrderRequest {
|
|
|
2028
2497
|
delayCapture?: boolean;
|
|
2029
2498
|
}
|
|
2030
2499
|
export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
2031
|
-
/**
|
|
2500
|
+
/**
|
|
2501
|
+
* ID of the newly created order.
|
|
2502
|
+
* @format GUID
|
|
2503
|
+
*/
|
|
2032
2504
|
orderId?: string;
|
|
2033
|
-
/**
|
|
2505
|
+
/**
|
|
2506
|
+
* ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions).
|
|
2507
|
+
* @format GUID
|
|
2508
|
+
*/
|
|
2034
2509
|
subscriptionId?: string;
|
|
2035
2510
|
/**
|
|
2036
2511
|
* Payment gateway order ID.
|
|
@@ -2045,9 +2520,15 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
|
2045
2520
|
}
|
|
2046
2521
|
/** @oneof */
|
|
2047
2522
|
export interface CreateOrderResponseIdOneOf {
|
|
2048
|
-
/**
|
|
2523
|
+
/**
|
|
2524
|
+
* ID of newly created order.
|
|
2525
|
+
* @format GUID
|
|
2526
|
+
*/
|
|
2049
2527
|
orderId?: string;
|
|
2050
|
-
/**
|
|
2528
|
+
/**
|
|
2529
|
+
* ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions).
|
|
2530
|
+
* @format GUID
|
|
2531
|
+
*/
|
|
2051
2532
|
subscriptionId?: string;
|
|
2052
2533
|
}
|
|
2053
2534
|
export interface PaymentErrorResponseData {
|
|
@@ -2056,12 +2537,16 @@ export interface PaymentErrorResponseData {
|
|
|
2056
2537
|
failureDetails?: string | null;
|
|
2057
2538
|
}
|
|
2058
2539
|
export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
|
|
2540
|
+
/** @format GUID */
|
|
2059
2541
|
orderId?: string;
|
|
2542
|
+
/** @format GUID */
|
|
2060
2543
|
subscriptionId?: string;
|
|
2061
2544
|
}
|
|
2062
2545
|
/** @oneof */
|
|
2063
2546
|
export interface DoublePaymentErrorDataIdOneOf {
|
|
2547
|
+
/** @format GUID */
|
|
2064
2548
|
orderId?: string;
|
|
2549
|
+
/** @format GUID */
|
|
2065
2550
|
subscriptionId?: string;
|
|
2066
2551
|
}
|
|
2067
2552
|
export interface RedeemErrorData {
|
|
@@ -2072,7 +2557,10 @@ export interface ViolationsList {
|
|
|
2072
2557
|
violations?: Violation[];
|
|
2073
2558
|
}
|
|
2074
2559
|
export interface CreateOrderAndChargeRequest {
|
|
2075
|
-
/**
|
|
2560
|
+
/**
|
|
2561
|
+
* Checkout ID.
|
|
2562
|
+
* @format GUID
|
|
2563
|
+
*/
|
|
2076
2564
|
_id: string;
|
|
2077
2565
|
/** Payment token. */
|
|
2078
2566
|
paymentToken?: string | null;
|
|
@@ -2082,9 +2570,15 @@ export interface CreateOrderAndChargeRequest {
|
|
|
2082
2570
|
delayCapture?: boolean;
|
|
2083
2571
|
}
|
|
2084
2572
|
export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
2085
|
-
/**
|
|
2573
|
+
/**
|
|
2574
|
+
* ID of newly created order.
|
|
2575
|
+
* @format GUID
|
|
2576
|
+
*/
|
|
2086
2577
|
orderId?: string;
|
|
2087
|
-
/**
|
|
2578
|
+
/**
|
|
2579
|
+
* ID of newly created subscription.
|
|
2580
|
+
* @format GUID
|
|
2581
|
+
*/
|
|
2088
2582
|
subscriptionId?: string;
|
|
2089
2583
|
/** Payment response token. */
|
|
2090
2584
|
paymentResponseToken?: string | null;
|
|
@@ -2100,17 +2594,27 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
|
|
|
2100
2594
|
}
|
|
2101
2595
|
/** @oneof */
|
|
2102
2596
|
export interface CreateOrderAndChargeResponseIdOneOf {
|
|
2103
|
-
/**
|
|
2597
|
+
/**
|
|
2598
|
+
* ID of newly created order.
|
|
2599
|
+
* @format GUID
|
|
2600
|
+
*/
|
|
2104
2601
|
orderId?: string;
|
|
2105
|
-
/**
|
|
2602
|
+
/**
|
|
2603
|
+
* ID of newly created subscription.
|
|
2604
|
+
* @format GUID
|
|
2605
|
+
*/
|
|
2106
2606
|
subscriptionId?: string;
|
|
2107
2607
|
}
|
|
2108
2608
|
export interface MarkCheckoutAsCompletedRequest {
|
|
2109
|
-
/**
|
|
2609
|
+
/**
|
|
2610
|
+
* Checkout ID.
|
|
2611
|
+
* @format GUID
|
|
2612
|
+
*/
|
|
2110
2613
|
_id: string;
|
|
2111
2614
|
/**
|
|
2112
2615
|
* Order ID.
|
|
2113
2616
|
* @internal
|
|
2617
|
+
* @format GUID
|
|
2114
2618
|
*/
|
|
2115
2619
|
orderId?: string | null;
|
|
2116
2620
|
}
|
|
@@ -2121,13 +2625,23 @@ export interface CheckoutMarkedAsCompleted {
|
|
|
2121
2625
|
checkout?: Checkout;
|
|
2122
2626
|
}
|
|
2123
2627
|
export interface UpdateLineItemsQuantityRequest {
|
|
2124
|
-
/**
|
|
2628
|
+
/**
|
|
2629
|
+
* Checkout ID.
|
|
2630
|
+
* @format GUID
|
|
2631
|
+
*/
|
|
2125
2632
|
_id: string;
|
|
2126
|
-
/**
|
|
2633
|
+
/**
|
|
2634
|
+
* Line item info to update.
|
|
2635
|
+
* @minSize 1
|
|
2636
|
+
* @maxSize 100
|
|
2637
|
+
*/
|
|
2127
2638
|
lineItems: LineItemQuantityUpdate[];
|
|
2128
2639
|
}
|
|
2129
2640
|
export interface LineItemQuantityUpdate {
|
|
2130
|
-
/**
|
|
2641
|
+
/**
|
|
2642
|
+
* ID of the line item to update.
|
|
2643
|
+
* @format GUID
|
|
2644
|
+
*/
|
|
2131
2645
|
_id?: string;
|
|
2132
2646
|
/**
|
|
2133
2647
|
* New total amount of the line item,
|
|
@@ -2136,6 +2650,8 @@ export interface LineItemQuantityUpdate {
|
|
|
2136
2650
|
* Min: `1`
|
|
2137
2651
|
*
|
|
2138
2652
|
* Max: `100000`
|
|
2653
|
+
* @min 1
|
|
2654
|
+
* @max 100000
|
|
2139
2655
|
*/
|
|
2140
2656
|
quantity?: number;
|
|
2141
2657
|
}
|
|
@@ -2144,7 +2660,10 @@ export interface UpdateLineItemsQuantityResponse {
|
|
|
2144
2660
|
checkout?: Checkout;
|
|
2145
2661
|
}
|
|
2146
2662
|
export interface GetCheckoutPaymentSettingsRequest {
|
|
2147
|
-
/**
|
|
2663
|
+
/**
|
|
2664
|
+
* Checkout ID.
|
|
2665
|
+
* @format GUID
|
|
2666
|
+
*/
|
|
2148
2667
|
_id: string;
|
|
2149
2668
|
}
|
|
2150
2669
|
export interface GetCheckoutPaymentSettingsResponse {
|
|
@@ -2155,7 +2674,10 @@ export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
|
|
|
2155
2674
|
MANUAL = "MANUAL"
|
|
2156
2675
|
}
|
|
2157
2676
|
export interface DeleteCheckoutRequest {
|
|
2158
|
-
/**
|
|
2677
|
+
/**
|
|
2678
|
+
* ID of the checkout to delete.
|
|
2679
|
+
* @format GUID
|
|
2680
|
+
*/
|
|
2159
2681
|
_id?: string;
|
|
2160
2682
|
}
|
|
2161
2683
|
export interface DeleteCheckoutResponse {
|
|
@@ -2169,20 +2691,33 @@ export interface Subscription {
|
|
|
2169
2691
|
* @readonly
|
|
2170
2692
|
*/
|
|
2171
2693
|
_id?: string;
|
|
2172
|
-
/**
|
|
2694
|
+
/**
|
|
2695
|
+
* id of subscription in external system
|
|
2696
|
+
* @format GUID
|
|
2697
|
+
*/
|
|
2173
2698
|
externalId?: string | null;
|
|
2174
2699
|
/**
|
|
2175
2700
|
* Subscription creation date
|
|
2176
2701
|
* @readonly
|
|
2177
2702
|
*/
|
|
2178
2703
|
dateCreated?: Date | null;
|
|
2179
|
-
/**
|
|
2704
|
+
/**
|
|
2705
|
+
* The id of the cart this order was created from
|
|
2706
|
+
* @format GUID
|
|
2707
|
+
*/
|
|
2180
2708
|
cartId?: string | null;
|
|
2181
|
-
/**
|
|
2709
|
+
/**
|
|
2710
|
+
* The id of the checkout this subscriptions was created from
|
|
2711
|
+
* @format GUID
|
|
2712
|
+
*/
|
|
2182
2713
|
checkoutId?: string | null;
|
|
2183
2714
|
/** member or contact */
|
|
2184
2715
|
buyerInfo?: V1BuyerInfo;
|
|
2185
|
-
/**
|
|
2716
|
+
/**
|
|
2717
|
+
* Line items ordered
|
|
2718
|
+
* @minSize 1
|
|
2719
|
+
* @maxSize 1
|
|
2720
|
+
*/
|
|
2186
2721
|
lineItems?: V1LineItem[];
|
|
2187
2722
|
/** Totals for subscription's line items */
|
|
2188
2723
|
totals?: Totals;
|
|
@@ -2194,7 +2729,10 @@ export interface Subscription {
|
|
|
2194
2729
|
shippingInfo?: V1ShippingInfo;
|
|
2195
2730
|
/** Coupon that was applied to subscription */
|
|
2196
2731
|
appliedCoupon?: AppliedCoupon;
|
|
2197
|
-
/**
|
|
2732
|
+
/**
|
|
2733
|
+
* Message from the customer (e.g., customization request)
|
|
2734
|
+
* @maxLength 1000
|
|
2735
|
+
*/
|
|
2198
2736
|
buyerNote?: string | null;
|
|
2199
2737
|
/** Custom field */
|
|
2200
2738
|
customField?: V1CustomField;
|
|
@@ -2212,7 +2750,10 @@ export interface Subscription {
|
|
|
2212
2750
|
}
|
|
2213
2751
|
/** Buyer Info */
|
|
2214
2752
|
export interface V1BuyerInfo {
|
|
2215
|
-
/**
|
|
2753
|
+
/**
|
|
2754
|
+
* Wix customer ID
|
|
2755
|
+
* @format GUID
|
|
2756
|
+
*/
|
|
2216
2757
|
_id?: string;
|
|
2217
2758
|
/** Customer type */
|
|
2218
2759
|
identityType?: IdentityType;
|
|
@@ -2227,13 +2768,26 @@ export declare enum IdentityType {
|
|
|
2227
2768
|
export interface V1LineItem {
|
|
2228
2769
|
/** Line item ID (auto-generated) */
|
|
2229
2770
|
index?: number;
|
|
2230
|
-
/**
|
|
2771
|
+
/**
|
|
2772
|
+
* Line item quantity
|
|
2773
|
+
* @min 1
|
|
2774
|
+
* @max 100000
|
|
2775
|
+
*/
|
|
2231
2776
|
quantity?: number;
|
|
2232
|
-
/**
|
|
2777
|
+
/**
|
|
2778
|
+
* Line item variantId (from Stores Catalog)
|
|
2779
|
+
* @format GUID
|
|
2780
|
+
*/
|
|
2233
2781
|
variantId?: string | null;
|
|
2234
|
-
/**
|
|
2782
|
+
/**
|
|
2783
|
+
* Line item options ordered
|
|
2784
|
+
* @maxSize 6
|
|
2785
|
+
*/
|
|
2235
2786
|
options?: OptionSelection[];
|
|
2236
|
-
/**
|
|
2787
|
+
/**
|
|
2788
|
+
* Line item custom text field selections
|
|
2789
|
+
* @maxSize 20
|
|
2790
|
+
*/
|
|
2237
2791
|
customTextFields?: CustomTextFieldSelection[];
|
|
2238
2792
|
/** Charges details */
|
|
2239
2793
|
chargeDetails?: ChargeDetails;
|
|
@@ -2241,53 +2795,109 @@ export interface V1LineItem {
|
|
|
2241
2795
|
productDetails?: ProductDetails;
|
|
2242
2796
|
}
|
|
2243
2797
|
export interface OptionSelection {
|
|
2244
|
-
/**
|
|
2798
|
+
/**
|
|
2799
|
+
* Option name
|
|
2800
|
+
* @maxLength 200
|
|
2801
|
+
*/
|
|
2245
2802
|
option?: string;
|
|
2246
|
-
/**
|
|
2803
|
+
/**
|
|
2804
|
+
* Selected choice for this option
|
|
2805
|
+
* @maxLength 500
|
|
2806
|
+
*/
|
|
2247
2807
|
selection?: string;
|
|
2248
2808
|
}
|
|
2249
2809
|
export interface CustomTextFieldSelection {
|
|
2250
|
-
/**
|
|
2810
|
+
/**
|
|
2811
|
+
* Custom text field name
|
|
2812
|
+
* @maxLength 100
|
|
2813
|
+
*/
|
|
2251
2814
|
title?: string;
|
|
2252
|
-
/**
|
|
2815
|
+
/**
|
|
2816
|
+
* Custom text field value
|
|
2817
|
+
* @maxLength 500
|
|
2818
|
+
*/
|
|
2253
2819
|
value?: string;
|
|
2254
2820
|
}
|
|
2255
2821
|
export interface ChargeDetails {
|
|
2256
|
-
/**
|
|
2822
|
+
/**
|
|
2823
|
+
* price of line item (depends on subscription option)
|
|
2824
|
+
* @max 999999999.99
|
|
2825
|
+
*/
|
|
2257
2826
|
price?: number;
|
|
2258
|
-
/**
|
|
2827
|
+
/**
|
|
2828
|
+
* Total price charged to the customer (for this line items) after computation of quantity and discount
|
|
2829
|
+
* @max 999999999.99
|
|
2830
|
+
*/
|
|
2259
2831
|
totalPrice?: number | null;
|
|
2260
|
-
/**
|
|
2832
|
+
/**
|
|
2833
|
+
* Discount applied for this line item
|
|
2834
|
+
* @max 999999999.99
|
|
2835
|
+
*/
|
|
2261
2836
|
discount?: number | null;
|
|
2262
|
-
/**
|
|
2837
|
+
/**
|
|
2838
|
+
* Tax applied for this line item
|
|
2839
|
+
* @max 999999999.99
|
|
2840
|
+
*/
|
|
2263
2841
|
tax?: number | null;
|
|
2264
2842
|
/** Is tax applied for this line item */
|
|
2265
2843
|
taxIncludedInPrice?: boolean;
|
|
2266
|
-
/**
|
|
2844
|
+
/**
|
|
2845
|
+
* Tax rate %, as a decimal point >= 0
|
|
2846
|
+
* @decimalValue options { maxScale:6, gte:0 }
|
|
2847
|
+
*/
|
|
2267
2848
|
taxRate?: string | null;
|
|
2268
2849
|
}
|
|
2269
2850
|
export interface ProductDetails {
|
|
2270
|
-
/**
|
|
2851
|
+
/**
|
|
2852
|
+
* Line item product ID (optional for POS orders)
|
|
2853
|
+
* @minLength 1
|
|
2854
|
+
*/
|
|
2271
2855
|
productId?: string | null;
|
|
2272
|
-
/**
|
|
2856
|
+
/**
|
|
2857
|
+
* Line item name
|
|
2858
|
+
* @minLength 1
|
|
2859
|
+
* @maxLength 100
|
|
2860
|
+
*/
|
|
2273
2861
|
name?: string;
|
|
2274
|
-
/**
|
|
2862
|
+
/**
|
|
2863
|
+
* Line item name translated to buyer's language
|
|
2864
|
+
* @minLength 1
|
|
2865
|
+
* @maxLength 100
|
|
2866
|
+
*/
|
|
2275
2867
|
translatedName?: string | null;
|
|
2276
2868
|
/** Line item type (may be extended) */
|
|
2277
2869
|
lineItemType?: LineItemType;
|
|
2278
2870
|
/** Line item primary media for preview */
|
|
2279
2871
|
mediaItem?: MediaItem;
|
|
2280
|
-
/**
|
|
2872
|
+
/**
|
|
2873
|
+
* Line item SKU
|
|
2874
|
+
* @maxLength 40
|
|
2875
|
+
*/
|
|
2281
2876
|
sku?: string | null;
|
|
2282
|
-
/**
|
|
2877
|
+
/**
|
|
2878
|
+
* Line item weight
|
|
2879
|
+
* @max 999999999.99
|
|
2880
|
+
*/
|
|
2283
2881
|
weight?: number | null;
|
|
2284
|
-
/**
|
|
2882
|
+
/**
|
|
2883
|
+
* Line item notes
|
|
2884
|
+
* @maxLength 1000
|
|
2885
|
+
*/
|
|
2285
2886
|
notes?: string | null;
|
|
2286
|
-
/**
|
|
2887
|
+
/**
|
|
2888
|
+
* Line item fulfillerId from stores fulfillers. No value means self fulfilled
|
|
2889
|
+
* @format GUID
|
|
2890
|
+
*/
|
|
2287
2891
|
fulfillerId?: string | null;
|
|
2288
|
-
/**
|
|
2892
|
+
/**
|
|
2893
|
+
* Tax group id
|
|
2894
|
+
* @format GUID
|
|
2895
|
+
*/
|
|
2289
2896
|
taxGroupId?: string | null;
|
|
2290
|
-
/**
|
|
2897
|
+
/**
|
|
2898
|
+
* App id from the catalog reference
|
|
2899
|
+
* @format GUID
|
|
2900
|
+
*/
|
|
2291
2901
|
appId?: string | null;
|
|
2292
2902
|
}
|
|
2293
2903
|
export declare enum LineItemType {
|
|
@@ -2308,16 +2918,19 @@ export interface MediaItem {
|
|
|
2308
2918
|
mediaType?: MediaItemType;
|
|
2309
2919
|
/**
|
|
2310
2920
|
* Media URL
|
|
2921
|
+
* @format WEB_URL
|
|
2311
2922
|
* @readonly
|
|
2312
2923
|
*/
|
|
2313
2924
|
url?: string;
|
|
2314
2925
|
/**
|
|
2315
2926
|
* Media item width
|
|
2927
|
+
* @max 5000
|
|
2316
2928
|
* @readonly
|
|
2317
2929
|
*/
|
|
2318
2930
|
width?: number;
|
|
2319
2931
|
/**
|
|
2320
2932
|
* Media item height
|
|
2933
|
+
* @max 5000
|
|
2321
2934
|
* @readonly
|
|
2322
2935
|
*/
|
|
2323
2936
|
height?: number;
|
|
@@ -2325,7 +2938,10 @@ export interface MediaItem {
|
|
|
2325
2938
|
_id?: string | null;
|
|
2326
2939
|
/** Media external URL */
|
|
2327
2940
|
externalImageUrl?: string | null;
|
|
2328
|
-
/**
|
|
2941
|
+
/**
|
|
2942
|
+
* Alternative text for presentation when media cannot be displayed
|
|
2943
|
+
* @maxLength 256
|
|
2944
|
+
*/
|
|
2329
2945
|
altText?: string | null;
|
|
2330
2946
|
}
|
|
2331
2947
|
export declare enum MediaItemType {
|
|
@@ -2335,17 +2951,35 @@ export declare enum MediaItemType {
|
|
|
2335
2951
|
IMAGE = "IMAGE"
|
|
2336
2952
|
}
|
|
2337
2953
|
export interface Totals {
|
|
2338
|
-
/**
|
|
2954
|
+
/**
|
|
2955
|
+
* Subtotal of all line items, before tax
|
|
2956
|
+
* @max 999999999.99
|
|
2957
|
+
*/
|
|
2339
2958
|
subtotal?: number;
|
|
2340
|
-
/**
|
|
2959
|
+
/**
|
|
2960
|
+
* Total shipping price, including tax
|
|
2961
|
+
* @max 999999999.99
|
|
2962
|
+
*/
|
|
2341
2963
|
shipping?: number;
|
|
2342
|
-
/**
|
|
2964
|
+
/**
|
|
2965
|
+
* Total tax
|
|
2966
|
+
* @max 999999999.99
|
|
2967
|
+
*/
|
|
2343
2968
|
tax?: number;
|
|
2344
|
-
/**
|
|
2969
|
+
/**
|
|
2970
|
+
* Total calculated discount value
|
|
2971
|
+
* @max 999999999.99
|
|
2972
|
+
*/
|
|
2345
2973
|
discount?: number;
|
|
2346
|
-
/**
|
|
2974
|
+
/**
|
|
2975
|
+
* Total price
|
|
2976
|
+
* @max 999999999.99
|
|
2977
|
+
*/
|
|
2347
2978
|
total?: number;
|
|
2348
|
-
/**
|
|
2979
|
+
/**
|
|
2980
|
+
* Total weight
|
|
2981
|
+
* @max 999999999.99
|
|
2982
|
+
*/
|
|
2349
2983
|
weight?: number | null;
|
|
2350
2984
|
/**
|
|
2351
2985
|
* Total line items quantity
|
|
@@ -2354,7 +2988,11 @@ export interface Totals {
|
|
|
2354
2988
|
quantity?: number;
|
|
2355
2989
|
}
|
|
2356
2990
|
export interface StoreSettings {
|
|
2357
|
-
/**
|
|
2991
|
+
/**
|
|
2992
|
+
* Currency used for pricing in this store
|
|
2993
|
+
* @maxLength 3
|
|
2994
|
+
* @format CURRENCY
|
|
2995
|
+
*/
|
|
2358
2996
|
currency?: string | null;
|
|
2359
2997
|
/** Weight unit used in this store */
|
|
2360
2998
|
weightUnit?: WeightUnit;
|
|
@@ -2362,56 +3000,103 @@ export interface StoreSettings {
|
|
|
2362
3000
|
* The language to be used when communicating with the buyer
|
|
2363
3001
|
* For a site that support multiple languages, this would be the language the buyer selected
|
|
2364
3002
|
* Otherwise this would be the site language
|
|
3003
|
+
* @minLength 2
|
|
3004
|
+
* @maxLength 2
|
|
2365
3005
|
*/
|
|
2366
3006
|
buyerLanguage?: string | null;
|
|
2367
3007
|
}
|
|
2368
3008
|
export interface Address extends AddressAddressLine1OptionsOneOf {
|
|
2369
|
-
/**
|
|
3009
|
+
/**
|
|
3010
|
+
* Address line 1 (free text)
|
|
3011
|
+
* @maxLength 1000
|
|
3012
|
+
*/
|
|
2370
3013
|
addressLine1?: string;
|
|
2371
3014
|
/** Address line 1 (street) */
|
|
2372
3015
|
street?: Street;
|
|
2373
3016
|
/** Addressee name */
|
|
2374
3017
|
fullName?: FullName;
|
|
2375
|
-
/**
|
|
3018
|
+
/**
|
|
3019
|
+
* Country code (2 letters)
|
|
3020
|
+
* @format COUNTRY
|
|
3021
|
+
*/
|
|
2376
3022
|
country?: string | null;
|
|
2377
|
-
/**
|
|
3023
|
+
/**
|
|
3024
|
+
* State or district
|
|
3025
|
+
* @maxLength 50
|
|
3026
|
+
*/
|
|
2378
3027
|
subdivision?: string | null;
|
|
2379
|
-
/**
|
|
3028
|
+
/**
|
|
3029
|
+
* City name
|
|
3030
|
+
* @maxLength 150
|
|
3031
|
+
*/
|
|
2380
3032
|
city?: string | null;
|
|
2381
|
-
/**
|
|
3033
|
+
/**
|
|
3034
|
+
* ZIP/postal code
|
|
3035
|
+
* @maxLength 200
|
|
3036
|
+
*/
|
|
2382
3037
|
zipCode?: string | null;
|
|
2383
|
-
/**
|
|
3038
|
+
/**
|
|
3039
|
+
* Phone number
|
|
3040
|
+
* @maxLength 200
|
|
3041
|
+
*/
|
|
2384
3042
|
phone?: string | null;
|
|
2385
|
-
/**
|
|
3043
|
+
/**
|
|
3044
|
+
* Company name
|
|
3045
|
+
* @maxLength 500
|
|
3046
|
+
*/
|
|
2386
3047
|
company?: string | null;
|
|
2387
|
-
/**
|
|
3048
|
+
/**
|
|
3049
|
+
* Email address
|
|
3050
|
+
* @maxLength 500
|
|
3051
|
+
*/
|
|
2388
3052
|
email?: string | null;
|
|
2389
|
-
/**
|
|
3053
|
+
/**
|
|
3054
|
+
* address line
|
|
3055
|
+
* @maxLength 250
|
|
3056
|
+
*/
|
|
2390
3057
|
addressLine2?: string | null;
|
|
2391
3058
|
/** Tax information (for Brazil only) */
|
|
2392
3059
|
vatId?: VatId;
|
|
2393
3060
|
}
|
|
2394
3061
|
/** @oneof */
|
|
2395
3062
|
export interface AddressAddressLine1OptionsOneOf {
|
|
2396
|
-
/**
|
|
3063
|
+
/**
|
|
3064
|
+
* Address line 1 (free text)
|
|
3065
|
+
* @maxLength 1000
|
|
3066
|
+
*/
|
|
2397
3067
|
addressLine1?: string;
|
|
2398
3068
|
/** Address line 1 (street) */
|
|
2399
3069
|
street?: Street;
|
|
2400
3070
|
}
|
|
2401
3071
|
export interface FullName {
|
|
2402
|
-
/**
|
|
3072
|
+
/**
|
|
3073
|
+
* Customer's first name
|
|
3074
|
+
* @maxLength 1000
|
|
3075
|
+
*/
|
|
2403
3076
|
firstName?: string;
|
|
2404
|
-
/**
|
|
3077
|
+
/**
|
|
3078
|
+
* Customer's last name
|
|
3079
|
+
* @maxLength 1000
|
|
3080
|
+
*/
|
|
2405
3081
|
lastName?: string;
|
|
2406
3082
|
}
|
|
2407
3083
|
export interface Street {
|
|
2408
|
-
/**
|
|
3084
|
+
/**
|
|
3085
|
+
* Street number
|
|
3086
|
+
* @maxLength 500
|
|
3087
|
+
*/
|
|
2409
3088
|
number?: string;
|
|
2410
|
-
/**
|
|
3089
|
+
/**
|
|
3090
|
+
* Street name
|
|
3091
|
+
* @maxLength 1000
|
|
3092
|
+
*/
|
|
2411
3093
|
name?: string;
|
|
2412
3094
|
}
|
|
2413
3095
|
export interface VatId {
|
|
2414
|
-
/**
|
|
3096
|
+
/**
|
|
3097
|
+
* Customer's tax ID.
|
|
3098
|
+
* @maxLength 50
|
|
3099
|
+
*/
|
|
2415
3100
|
number?: string;
|
|
2416
3101
|
/**
|
|
2417
3102
|
* Tax type.
|
|
@@ -2434,9 +3119,15 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
|
|
|
2434
3119
|
shipmentDetails?: ShipmentDetails;
|
|
2435
3120
|
/** Pickup details (when this object describes pickup) */
|
|
2436
3121
|
pickupDetails?: V1PickupDetails;
|
|
2437
|
-
/**
|
|
3122
|
+
/**
|
|
3123
|
+
* Delivery option name
|
|
3124
|
+
* @maxLength 250
|
|
3125
|
+
*/
|
|
2438
3126
|
deliveryOption?: string;
|
|
2439
|
-
/**
|
|
3127
|
+
/**
|
|
3128
|
+
* Delivery option delivery time
|
|
3129
|
+
* @maxLength 500
|
|
3130
|
+
*/
|
|
2440
3131
|
estimatedDeliveryTime?: string | null;
|
|
2441
3132
|
}
|
|
2442
3133
|
/** @oneof */
|
|
@@ -2449,53 +3140,101 @@ export interface V1ShippingInfoDetailsOneOf {
|
|
|
2449
3140
|
export interface ShipmentDetails {
|
|
2450
3141
|
/** Shipping destination address */
|
|
2451
3142
|
address?: Address;
|
|
2452
|
-
/**
|
|
3143
|
+
/**
|
|
3144
|
+
* Discount applied for shipping
|
|
3145
|
+
* @max 999999999.99
|
|
3146
|
+
*/
|
|
2453
3147
|
discount?: number | null;
|
|
2454
|
-
/**
|
|
3148
|
+
/**
|
|
3149
|
+
* Tax applied for shipping
|
|
3150
|
+
* @max 999999999.99
|
|
3151
|
+
*/
|
|
2455
3152
|
tax?: number | null;
|
|
2456
3153
|
/** Whether tax is included in the price */
|
|
2457
3154
|
taxIncludedInPrice?: boolean;
|
|
2458
|
-
/**
|
|
3155
|
+
/**
|
|
3156
|
+
* Tax rate % for shipping, as a decimal point >= 0
|
|
3157
|
+
* @decimalValue options { maxScale:6, gte:0 }
|
|
3158
|
+
*/
|
|
2459
3159
|
taxRate?: string | null;
|
|
2460
3160
|
}
|
|
2461
3161
|
export interface V1PickupDetails {
|
|
2462
3162
|
/** Pickup address */
|
|
2463
3163
|
address?: PickupAddress;
|
|
2464
|
-
/**
|
|
3164
|
+
/**
|
|
3165
|
+
* Store owner's pickup instructions
|
|
3166
|
+
* @maxLength 1000
|
|
3167
|
+
*/
|
|
2465
3168
|
pickupInstructions?: string | null;
|
|
2466
3169
|
}
|
|
2467
3170
|
export interface PickupAddress {
|
|
2468
|
-
/**
|
|
3171
|
+
/**
|
|
3172
|
+
* Country code (2 letters)
|
|
3173
|
+
* @format COUNTRY
|
|
3174
|
+
*/
|
|
2469
3175
|
country?: string;
|
|
2470
|
-
/**
|
|
3176
|
+
/**
|
|
3177
|
+
* State/District
|
|
3178
|
+
* @maxLength 50
|
|
3179
|
+
*/
|
|
2471
3180
|
subdivision?: string | null;
|
|
2472
|
-
/**
|
|
3181
|
+
/**
|
|
3182
|
+
* Address
|
|
3183
|
+
* @maxLength 200
|
|
3184
|
+
*/
|
|
2473
3185
|
addressLine?: string;
|
|
2474
|
-
/**
|
|
3186
|
+
/**
|
|
3187
|
+
* City
|
|
3188
|
+
* @maxLength 85
|
|
3189
|
+
*/
|
|
2475
3190
|
city?: string;
|
|
2476
|
-
/**
|
|
3191
|
+
/**
|
|
3192
|
+
* ZIP/postal code
|
|
3193
|
+
* @maxLength 50
|
|
3194
|
+
*/
|
|
2477
3195
|
zipCode?: string;
|
|
2478
3196
|
}
|
|
2479
3197
|
export interface AppliedCoupon {
|
|
2480
3198
|
/** Coupon ID */
|
|
2481
3199
|
couponId?: string;
|
|
2482
|
-
/**
|
|
3200
|
+
/**
|
|
3201
|
+
* Coupon name
|
|
3202
|
+
* @maxLength 100
|
|
3203
|
+
*/
|
|
2483
3204
|
name?: string;
|
|
2484
|
-
/**
|
|
3205
|
+
/**
|
|
3206
|
+
* Coupon code
|
|
3207
|
+
* @maxLength 100
|
|
3208
|
+
*/
|
|
2485
3209
|
code?: string;
|
|
2486
3210
|
}
|
|
2487
3211
|
/** Custom field */
|
|
2488
3212
|
export interface V1CustomField {
|
|
2489
|
-
/**
|
|
3213
|
+
/**
|
|
3214
|
+
* Free text that the customer entered in the custom field during the checkout process
|
|
3215
|
+
* @maxLength 250
|
|
3216
|
+
*/
|
|
2490
3217
|
value?: string;
|
|
2491
|
-
/**
|
|
3218
|
+
/**
|
|
3219
|
+
* Title for the custom field
|
|
3220
|
+
* @maxLength 200
|
|
3221
|
+
*/
|
|
2492
3222
|
title?: string;
|
|
2493
|
-
/**
|
|
3223
|
+
/**
|
|
3224
|
+
* The title translated according to the buyer language
|
|
3225
|
+
* @maxLength 200
|
|
3226
|
+
*/
|
|
2494
3227
|
translatedTitle?: string;
|
|
2495
3228
|
}
|
|
2496
3229
|
export interface V1SubscriptionOptionInfo {
|
|
3230
|
+
/** @format GUID */
|
|
2497
3231
|
_id?: string | null;
|
|
3232
|
+
/**
|
|
3233
|
+
* @minLength 1
|
|
3234
|
+
* @maxLength 20
|
|
3235
|
+
*/
|
|
2498
3236
|
title?: string;
|
|
3237
|
+
/** @maxLength 60 */
|
|
2499
3238
|
description?: string | null;
|
|
2500
3239
|
discount?: Discount;
|
|
2501
3240
|
}
|
|
@@ -2526,15 +3265,28 @@ export interface V1SubscriptionSettings {
|
|
|
2526
3265
|
frequency?: SubscriptionFrequency;
|
|
2527
3266
|
/** Whether subscription is renewed automatically at the end of each period. */
|
|
2528
3267
|
autoRenewal?: boolean;
|
|
2529
|
-
/**
|
|
3268
|
+
/**
|
|
3269
|
+
* Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
|
|
3270
|
+
* @min 2
|
|
3271
|
+
* @max 999
|
|
3272
|
+
*/
|
|
2530
3273
|
billingCycles?: number | null;
|
|
2531
3274
|
}
|
|
2532
3275
|
export interface BillingInfo {
|
|
2533
|
-
/**
|
|
3276
|
+
/**
|
|
3277
|
+
* Payment method used for this order
|
|
3278
|
+
* @maxLength 50
|
|
3279
|
+
*/
|
|
2534
3280
|
paymentMethod?: string | null;
|
|
2535
|
-
/**
|
|
3281
|
+
/**
|
|
3282
|
+
* Transaction ID from payment gateway (e.g., Wix Payments)
|
|
3283
|
+
* @maxLength 100
|
|
3284
|
+
*/
|
|
2536
3285
|
paymentGatewayTransactionId?: string | null;
|
|
2537
|
-
/**
|
|
3286
|
+
/**
|
|
3287
|
+
* Order ID from payment gateway (e.g., Wix Payments)
|
|
3288
|
+
* @maxLength 100
|
|
3289
|
+
*/
|
|
2538
3290
|
paymentGatewayOrderId?: string | null;
|
|
2539
3291
|
}
|
|
2540
3292
|
export interface Empty {
|
|
@@ -2610,9 +3362,15 @@ export interface ActionEvent {
|
|
|
2610
3362
|
body?: string;
|
|
2611
3363
|
}
|
|
2612
3364
|
export interface MessageEnvelope {
|
|
2613
|
-
/**
|
|
3365
|
+
/**
|
|
3366
|
+
* App instance ID.
|
|
3367
|
+
* @format GUID
|
|
3368
|
+
*/
|
|
2614
3369
|
instanceId?: string | null;
|
|
2615
|
-
/**
|
|
3370
|
+
/**
|
|
3371
|
+
* Event type.
|
|
3372
|
+
* @maxLength 150
|
|
3373
|
+
*/
|
|
2616
3374
|
eventType?: string;
|
|
2617
3375
|
/** The identification type and identity data. */
|
|
2618
3376
|
identity?: IdentificationData;
|
|
@@ -2620,26 +3378,50 @@ export interface MessageEnvelope {
|
|
|
2620
3378
|
data?: string;
|
|
2621
3379
|
}
|
|
2622
3380
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2623
|
-
/**
|
|
3381
|
+
/**
|
|
3382
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3383
|
+
* @format GUID
|
|
3384
|
+
*/
|
|
2624
3385
|
anonymousVisitorId?: string;
|
|
2625
|
-
/**
|
|
3386
|
+
/**
|
|
3387
|
+
* ID of a site visitor that has logged in to the site.
|
|
3388
|
+
* @format GUID
|
|
3389
|
+
*/
|
|
2626
3390
|
memberId?: string;
|
|
2627
|
-
/**
|
|
3391
|
+
/**
|
|
3392
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3393
|
+
* @format GUID
|
|
3394
|
+
*/
|
|
2628
3395
|
wixUserId?: string;
|
|
2629
|
-
/**
|
|
3396
|
+
/**
|
|
3397
|
+
* ID of an app.
|
|
3398
|
+
* @format GUID
|
|
3399
|
+
*/
|
|
2630
3400
|
appId?: string;
|
|
2631
3401
|
/** @readonly */
|
|
2632
3402
|
identityType?: WebhookIdentityType;
|
|
2633
3403
|
}
|
|
2634
3404
|
/** @oneof */
|
|
2635
3405
|
export interface IdentificationDataIdOneOf {
|
|
2636
|
-
/**
|
|
3406
|
+
/**
|
|
3407
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3408
|
+
* @format GUID
|
|
3409
|
+
*/
|
|
2637
3410
|
anonymousVisitorId?: string;
|
|
2638
|
-
/**
|
|
3411
|
+
/**
|
|
3412
|
+
* ID of a site visitor that has logged in to the site.
|
|
3413
|
+
* @format GUID
|
|
3414
|
+
*/
|
|
2639
3415
|
memberId?: string;
|
|
2640
|
-
/**
|
|
3416
|
+
/**
|
|
3417
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3418
|
+
* @format GUID
|
|
3419
|
+
*/
|
|
2641
3420
|
wixUserId?: string;
|
|
2642
|
-
/**
|
|
3421
|
+
/**
|
|
3422
|
+
* ID of an app.
|
|
3423
|
+
* @format GUID
|
|
3424
|
+
*/
|
|
2643
3425
|
appId?: string;
|
|
2644
3426
|
}
|
|
2645
3427
|
export declare enum WebhookIdentityType {
|
|
@@ -3080,6 +3862,14 @@ interface CustomContentReferenceNonNullableFields {
|
|
|
3080
3862
|
interface ExternalReferenceNonNullableFields {
|
|
3081
3863
|
appId: string;
|
|
3082
3864
|
}
|
|
3865
|
+
interface ChargeNonNullableFields {
|
|
3866
|
+
cycleFrom: number;
|
|
3867
|
+
priceSummary?: PriceSummaryNonNullableFields;
|
|
3868
|
+
}
|
|
3869
|
+
interface SubscriptionChargesNonNullableFields {
|
|
3870
|
+
lineItemIds: string[];
|
|
3871
|
+
charges: ChargeNonNullableFields[];
|
|
3872
|
+
}
|
|
3083
3873
|
export interface CheckoutNonNullableFields {
|
|
3084
3874
|
lineItems: LineItemNonNullableFields[];
|
|
3085
3875
|
billingInfo?: AddressWithContactNonNullableFields;
|
|
@@ -3115,6 +3905,8 @@ export interface CheckoutNonNullableFields {
|
|
|
3115
3905
|
payAfterFreeTrial?: PriceSummaryNonNullableFields;
|
|
3116
3906
|
/** @internal */
|
|
3117
3907
|
paymentRequired: boolean;
|
|
3908
|
+
/** @internal */
|
|
3909
|
+
subscriptionCharges: SubscriptionChargesNonNullableFields[];
|
|
3118
3910
|
}
|
|
3119
3911
|
export interface CreateCheckoutResponseNonNullableFields {
|
|
3120
3912
|
checkout?: CheckoutNonNullableFields;
|
|
@@ -3164,9 +3956,15 @@ export interface GetCheckoutPaymentSettingsResponseNonNullableFields {
|
|
|
3164
3956
|
blockedPaymentOptions: GetCheckoutPaymentSettingsResponsePaymentOption[];
|
|
3165
3957
|
}
|
|
3166
3958
|
export interface BaseEventMetadata {
|
|
3167
|
-
/**
|
|
3959
|
+
/**
|
|
3960
|
+
* App instance ID.
|
|
3961
|
+
* @format GUID
|
|
3962
|
+
*/
|
|
3168
3963
|
instanceId?: string | null;
|
|
3169
|
-
/**
|
|
3964
|
+
/**
|
|
3965
|
+
* Event type.
|
|
3966
|
+
* @maxLength 150
|
|
3967
|
+
*/
|
|
3170
3968
|
eventType?: string;
|
|
3171
3969
|
/** The identification type and identity data. */
|
|
3172
3970
|
identity?: IdentificationData;
|
|
@@ -3233,6 +4031,8 @@ export interface CheckoutCompletedEnvelope {
|
|
|
3233
4031
|
* @permissionId ECOM.READ_CHECKOUTS
|
|
3234
4032
|
* @webhook
|
|
3235
4033
|
* @eventType wix.ecom.v1.checkout_completed
|
|
4034
|
+
* @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
|
|
4035
|
+
* @slug completed
|
|
3236
4036
|
*/
|
|
3237
4037
|
export declare function onCheckoutCompleted(handler: (event: CheckoutCompletedEnvelope) => void | Promise<void>): void;
|
|
3238
4038
|
export interface CheckoutCreatedEnvelope {
|
|
@@ -3258,6 +4058,8 @@ export interface CheckoutCreatedEnvelope {
|
|
|
3258
4058
|
* @permissionId ECOM.READ_CHECKOUTS
|
|
3259
4059
|
* @webhook
|
|
3260
4060
|
* @eventType wix.ecom.v1.checkout_created
|
|
4061
|
+
* @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
|
|
4062
|
+
* @slug created
|
|
3261
4063
|
*/
|
|
3262
4064
|
export declare function onCheckoutCreated(handler: (event: CheckoutCreatedEnvelope) => void | Promise<void>): void;
|
|
3263
4065
|
export interface CheckoutUpdatedEnvelope {
|
|
@@ -3283,6 +4085,8 @@ export interface CheckoutUpdatedEnvelope {
|
|
|
3283
4085
|
* @permissionId ECOM.READ_CHECKOUTS
|
|
3284
4086
|
* @webhook
|
|
3285
4087
|
* @eventType wix.ecom.v1.checkout_updated
|
|
4088
|
+
* @serviceIdentifier com.wix.ecom.checkout.api.v1.CheckoutService
|
|
4089
|
+
* @slug updated
|
|
3286
4090
|
*/
|
|
3287
4091
|
export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelope) => void | Promise<void>): void;
|
|
3288
4092
|
/**
|
|
@@ -3302,8 +4106,8 @@ export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelo
|
|
|
3302
4106
|
* @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id
|
|
3303
4107
|
* @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId
|
|
3304
4108
|
* @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds
|
|
3305
|
-
* @requiredField options.customLineItems.descriptionLines
|
|
3306
4109
|
* @requiredField options.customLineItems.descriptionLines.name
|
|
4110
|
+
* @requiredField options.customLineItems.descriptionLines.value
|
|
3307
4111
|
* @requiredField options.customLineItems.itemType
|
|
3308
4112
|
* @requiredField options.customLineItems.price
|
|
3309
4113
|
* @requiredField options.customLineItems.productName
|
|
@@ -3327,6 +4131,8 @@ export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelo
|
|
|
3327
4131
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3328
4132
|
* @permissionScope Manage eCommerce - Admin Permissions
|
|
3329
4133
|
* @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
|
|
4134
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4135
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3330
4136
|
* @permissionScope Manage eCommerce - all permissions
|
|
3331
4137
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3332
4138
|
* @applicableIdentity APP
|
|
@@ -3340,28 +4146,20 @@ export interface CreateCheckoutOptions {
|
|
|
3340
4146
|
checkoutInfo?: Checkout;
|
|
3341
4147
|
/** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
3342
4148
|
couponCode?: string | null;
|
|
3343
|
-
/**
|
|
4149
|
+
/**
|
|
4150
|
+
* Catalog line items to add to the checkout.
|
|
4151
|
+
* @maxSize 300
|
|
4152
|
+
*/
|
|
3344
4153
|
lineItems?: LineItem[];
|
|
3345
4154
|
/**
|
|
3346
4155
|
* Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
|
|
3347
4156
|
*
|
|
3348
4157
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3349
4158
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
4159
|
+
* @maxSize 300
|
|
3350
4160
|
*/
|
|
3351
4161
|
customLineItems?: CustomLineItem[];
|
|
3352
|
-
/**
|
|
3353
|
-
* Sales channel that submitted the order.
|
|
3354
|
-
* + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
|
|
3355
|
-
* + `"WEB"`: A web client.
|
|
3356
|
-
* + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
|
|
3357
|
-
* + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
|
|
3358
|
-
* + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
|
|
3359
|
-
* + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
|
|
3360
|
-
* + `"WIX_INVOICES"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
|
|
3361
|
-
* + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
|
|
3362
|
-
* + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
|
|
3363
|
-
* + `"OTHER_PLATFORM"`: Other sales platform.
|
|
3364
|
-
*/
|
|
4162
|
+
/** Sales channel that submitted the order. */
|
|
3365
4163
|
channelType: ChannelType;
|
|
3366
4164
|
/**
|
|
3367
4165
|
* Gift card code.
|
|
@@ -3375,6 +4173,7 @@ export interface CreateCheckoutOptions {
|
|
|
3375
4173
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
3376
4174
|
*
|
|
3377
4175
|
* 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`.
|
|
4176
|
+
* @maxLength 1000
|
|
3378
4177
|
*/
|
|
3379
4178
|
overrideCheckoutUrl?: string | null;
|
|
3380
4179
|
}
|
|
@@ -3411,7 +4210,6 @@ export declare function getCheckout(_id: string): Promise<Checkout & CheckoutNon
|
|
|
3411
4210
|
* Retrieves the checkout associated with a specified cart.
|
|
3412
4211
|
* @param _id - Cart ID.
|
|
3413
4212
|
* @public
|
|
3414
|
-
* @documentationMaturity preview
|
|
3415
4213
|
* @requiredField _id
|
|
3416
4214
|
* @permissionId ECOM.READ_CHECKOUTS
|
|
3417
4215
|
* @permissionScope Manage Stores - all permissions
|
|
@@ -3504,8 +4302,8 @@ export declare function getCheckoutUrl(_id: string): Promise<GetCheckoutURLRespo
|
|
|
3504
4302
|
* @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
|
|
3505
4303
|
* @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
|
|
3506
4304
|
* @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
|
|
3507
|
-
* @requiredField options.customLineItems.descriptionLines
|
|
3508
4305
|
* @requiredField options.customLineItems.descriptionLines.name
|
|
4306
|
+
* @requiredField options.customLineItems.descriptionLines.value
|
|
3509
4307
|
* @requiredField options.customLineItems.itemType
|
|
3510
4308
|
* @requiredField options.customLineItems.productName
|
|
3511
4309
|
* @requiredField options.customLineItems.quantity
|
|
@@ -3528,6 +4326,8 @@ export declare function getCheckoutUrl(_id: string): Promise<GetCheckoutURLRespo
|
|
|
3528
4326
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3529
4327
|
* @permissionScope Manage eCommerce - Admin Permissions
|
|
3530
4328
|
* @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
|
|
4329
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4330
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3531
4331
|
* @permissionScope Manage eCommerce - all permissions
|
|
3532
4332
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3533
4333
|
* @applicableIdentity APP
|
|
@@ -3539,6 +4339,7 @@ export declare function updateCheckout(_id: string | null, checkout: UpdateCheck
|
|
|
3539
4339
|
export interface UpdateCheckout {
|
|
3540
4340
|
/**
|
|
3541
4341
|
* Checkout ID.
|
|
4342
|
+
* @format GUID
|
|
3542
4343
|
* @readonly
|
|
3543
4344
|
*/
|
|
3544
4345
|
_id?: string | null;
|
|
@@ -3546,6 +4347,8 @@ export interface UpdateCheckout {
|
|
|
3546
4347
|
* Line items.
|
|
3547
4348
|
*
|
|
3548
4349
|
* Max: 300 items
|
|
4350
|
+
* @minSize 1
|
|
4351
|
+
* @maxSize 300
|
|
3549
4352
|
* @readonly
|
|
3550
4353
|
*/
|
|
3551
4354
|
lineItems?: LineItem[];
|
|
@@ -3553,13 +4356,17 @@ export interface UpdateCheckout {
|
|
|
3553
4356
|
billingInfo?: AddressWithContact;
|
|
3554
4357
|
/** Shipping information. */
|
|
3555
4358
|
shippingInfo?: ShippingInfo;
|
|
3556
|
-
/**
|
|
4359
|
+
/**
|
|
4360
|
+
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
4361
|
+
* @maxLength 1000
|
|
4362
|
+
*/
|
|
3557
4363
|
buyerNote?: string | null;
|
|
3558
4364
|
/** Buyer information. */
|
|
3559
4365
|
buyerInfo?: BuyerInfo;
|
|
3560
4366
|
/**
|
|
3561
4367
|
* All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
3562
4368
|
* @readonly
|
|
4369
|
+
* @format CURRENCY
|
|
3563
4370
|
*/
|
|
3564
4371
|
conversionCurrency?: string;
|
|
3565
4372
|
/**
|
|
@@ -3598,6 +4405,7 @@ export interface UpdateCheckout {
|
|
|
3598
4405
|
taxSummary?: TaxSummary;
|
|
3599
4406
|
/**
|
|
3600
4407
|
* The currency used when submitting the order.
|
|
4408
|
+
* @format CURRENCY
|
|
3601
4409
|
* @readonly
|
|
3602
4410
|
*/
|
|
3603
4411
|
currency?: string;
|
|
@@ -3655,9 +4463,15 @@ export interface UpdateCheckout {
|
|
|
3655
4463
|
payLater?: PriceSummary;
|
|
3656
4464
|
/** Memberships to apply when creating the order. */
|
|
3657
4465
|
membershipOptions?: MembershipOptions;
|
|
3658
|
-
/**
|
|
4466
|
+
/**
|
|
4467
|
+
* Additional Fees.
|
|
4468
|
+
* @maxSize 100
|
|
4469
|
+
*/
|
|
3659
4470
|
additionalFees?: AdditionalFee[];
|
|
3660
|
-
/**
|
|
4471
|
+
/**
|
|
4472
|
+
* Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
|
|
4473
|
+
* @format GUID
|
|
4474
|
+
*/
|
|
3661
4475
|
cartId?: string | null;
|
|
3662
4476
|
/**
|
|
3663
4477
|
* List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
|
|
@@ -3672,6 +4486,7 @@ export interface UpdateCheckout {
|
|
|
3672
4486
|
extendedFields?: ExtendedFields;
|
|
3673
4487
|
/**
|
|
3674
4488
|
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
4489
|
+
* @format GUID
|
|
3675
4490
|
* @readonly
|
|
3676
4491
|
*/
|
|
3677
4492
|
purchaseFlowId?: string | null;
|
|
@@ -3679,6 +4494,7 @@ export interface UpdateCheckout {
|
|
|
3679
4494
|
* Additional settings for customization of the checkout process.
|
|
3680
4495
|
*
|
|
3681
4496
|
* Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
|
|
4497
|
+
* @immutable
|
|
3682
4498
|
*/
|
|
3683
4499
|
customSettings?: CustomSettings;
|
|
3684
4500
|
/**
|
|
@@ -3693,6 +4509,7 @@ export interface UpdateCheckout {
|
|
|
3693
4509
|
*
|
|
3694
4510
|
* This field is empty until the checkout completes and becomes an order.
|
|
3695
4511
|
* @internal
|
|
4512
|
+
* @format GUID
|
|
3696
4513
|
* @readonly
|
|
3697
4514
|
*/
|
|
3698
4515
|
orderId?: string | null;
|
|
@@ -3705,6 +4522,7 @@ export interface UpdateCheckout {
|
|
|
3705
4522
|
/**
|
|
3706
4523
|
* The business location ID associated with the checkout.
|
|
3707
4524
|
* Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
4525
|
+
* @format GUID
|
|
3708
4526
|
*/
|
|
3709
4527
|
businessLocationId?: string | null;
|
|
3710
4528
|
/**
|
|
@@ -3717,6 +4535,13 @@ export interface UpdateCheckout {
|
|
|
3717
4535
|
* @readonly
|
|
3718
4536
|
*/
|
|
3719
4537
|
paymentRequired?: boolean;
|
|
4538
|
+
/**
|
|
4539
|
+
* Charges information for each subscription in the Checkout.
|
|
4540
|
+
* @internal
|
|
4541
|
+
* @readonly
|
|
4542
|
+
* @maxSize 100
|
|
4543
|
+
*/
|
|
4544
|
+
subscriptionCharges?: SubscriptionCharges[];
|
|
3720
4545
|
}
|
|
3721
4546
|
export interface UpdateCheckoutOptions {
|
|
3722
4547
|
/** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
@@ -3727,15 +4552,20 @@ export interface UpdateCheckoutOptions {
|
|
|
3727
4552
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
3728
4553
|
*
|
|
3729
4554
|
* 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`.
|
|
4555
|
+
* @maxLength 1000
|
|
3730
4556
|
*/
|
|
3731
4557
|
overrideCheckoutUrl?: string | null;
|
|
3732
|
-
/**
|
|
4558
|
+
/**
|
|
4559
|
+
* Catalog line items.
|
|
4560
|
+
* @maxSize 300
|
|
4561
|
+
*/
|
|
3733
4562
|
lineItems?: LineItem[];
|
|
3734
4563
|
/**
|
|
3735
4564
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
3736
4565
|
*
|
|
3737
4566
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3738
4567
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
4568
|
+
* @maxSize 300
|
|
3739
4569
|
*/
|
|
3740
4570
|
customLineItems?: CustomLineItem[];
|
|
3741
4571
|
}
|
|
@@ -3818,8 +4648,8 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOv
|
|
|
3818
4648
|
* @param _id - Checkout ID.
|
|
3819
4649
|
* @public
|
|
3820
4650
|
* @requiredField _id
|
|
3821
|
-
* @requiredField options.customLineItems.descriptionLines
|
|
3822
4651
|
* @requiredField options.customLineItems.descriptionLines.name
|
|
4652
|
+
* @requiredField options.customLineItems.descriptionLines.value
|
|
3823
4653
|
* @requiredField options.customLineItems.itemType
|
|
3824
4654
|
* @requiredField options.customLineItems.productName
|
|
3825
4655
|
* @requiredField options.customLineItems.quantity
|
|
@@ -3842,6 +4672,8 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOv
|
|
|
3842
4672
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
3843
4673
|
* @permissionScope Manage eCommerce - Admin Permissions
|
|
3844
4674
|
* @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
|
|
4675
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4676
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
3845
4677
|
* @permissionScope Manage eCommerce - all permissions
|
|
3846
4678
|
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
3847
4679
|
* @applicableIdentity APP
|
|
@@ -3850,13 +4682,17 @@ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOv
|
|
|
3850
4682
|
*/
|
|
3851
4683
|
export declare function addToCheckout(_id: string, options?: AddToCheckoutOptions): Promise<AddToCheckoutResponse & AddToCheckoutResponseNonNullableFields>;
|
|
3852
4684
|
export interface AddToCheckoutOptions {
|
|
3853
|
-
/**
|
|
4685
|
+
/**
|
|
4686
|
+
* Catalog line items.
|
|
4687
|
+
* @maxSize 100
|
|
4688
|
+
*/
|
|
3854
4689
|
lineItems?: LineItem[];
|
|
3855
4690
|
/**
|
|
3856
4691
|
* Custom line items. Custom line items don't trigger the Catalog service plugin.
|
|
3857
4692
|
*
|
|
3858
4693
|
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3859
4694
|
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
4695
|
+
* @maxSize 100
|
|
3860
4696
|
*/
|
|
3861
4697
|
customLineItems?: CustomLineItem[];
|
|
3862
4698
|
}
|