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