@wix/ecom 1.0.713 → 1.0.715
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/package.json +6 -6
- package/type-bundles/context.bundle.d.ts +257 -99
- package/type-bundles/index.bundle.d.ts +257 -99
- package/type-bundles/meta.bundle.d.ts +400 -130
|
@@ -3060,6 +3060,13 @@ interface LineItem$7 {
|
|
|
3060
3060
|
* @readonly
|
|
3061
3061
|
*/
|
|
3062
3062
|
consentRequiredPaymentPolicy?: string | null;
|
|
3063
|
+
/**
|
|
3064
|
+
* Overriding values for catalog item properties.
|
|
3065
|
+
*
|
|
3066
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3067
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3068
|
+
*/
|
|
3069
|
+
catalogOverrideFields?: CatalogOverrideFields$7;
|
|
3063
3070
|
/**
|
|
3064
3071
|
* Whether to save the payment method on the order.
|
|
3065
3072
|
*
|
|
@@ -3312,6 +3319,20 @@ interface SelectedMembership$7 {
|
|
|
3312
3319
|
/** ID of the app providing this payment option. */
|
|
3313
3320
|
appId?: string;
|
|
3314
3321
|
}
|
|
3322
|
+
interface CatalogOverrideFields$7 {
|
|
3323
|
+
/** Item name. */
|
|
3324
|
+
productName?: ProductName$b;
|
|
3325
|
+
/** Item price **after** discounts. */
|
|
3326
|
+
price?: string | null;
|
|
3327
|
+
/** Item price **before** discounts. */
|
|
3328
|
+
fullPrice?: string | null;
|
|
3329
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
3330
|
+
descriptionLines?: DescriptionLine$b[];
|
|
3331
|
+
/** Physical properties of the item. */
|
|
3332
|
+
physicalProperties?: PhysicalProperties$d;
|
|
3333
|
+
/** Item image. */
|
|
3334
|
+
image?: Image$6;
|
|
3335
|
+
}
|
|
3315
3336
|
interface Image$6 {
|
|
3316
3337
|
/** WixMedia image ID. */
|
|
3317
3338
|
id?: string;
|
|
@@ -3483,7 +3504,12 @@ interface UpdateCartRequest$3 {
|
|
|
3483
3504
|
merchantDiscounts?: MerchantDiscountInput$5[];
|
|
3484
3505
|
/** Catalog line items. */
|
|
3485
3506
|
lineItems?: LineItem$7[];
|
|
3486
|
-
/**
|
|
3507
|
+
/**
|
|
3508
|
+
* Custom line items.
|
|
3509
|
+
*
|
|
3510
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
3511
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
3512
|
+
*/
|
|
3487
3513
|
customLineItems?: CustomLineItem$9[];
|
|
3488
3514
|
}
|
|
3489
3515
|
interface MerchantDiscountInput$5 {
|
|
@@ -3514,31 +3540,30 @@ interface CustomLineItem$9 {
|
|
|
3514
3540
|
media?: Image$6;
|
|
3515
3541
|
/**
|
|
3516
3542
|
* Custom line item ID. If passed, `id` must be unique.
|
|
3517
|
-
*
|
|
3543
|
+
*
|
|
3544
|
+
* Default: auto-generated ID
|
|
3518
3545
|
*/
|
|
3519
3546
|
id?: string | null;
|
|
3520
3547
|
/** Tax group ID for this custom line item. */
|
|
3521
3548
|
taxGroupId?: string | null;
|
|
3522
3549
|
/** Name of the item or product. */
|
|
3523
3550
|
productName?: ProductName$b;
|
|
3524
|
-
/**
|
|
3525
|
-
* Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
|
|
3526
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
3527
|
-
*/
|
|
3551
|
+
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
3528
3552
|
url?: PageUrlV2$4;
|
|
3529
3553
|
/** Item type. Either a preset type or custom. */
|
|
3530
3554
|
itemType?: ItemType$d;
|
|
3531
|
-
/**
|
|
3555
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
3532
3556
|
fullPrice?: string | null;
|
|
3533
3557
|
/**
|
|
3534
|
-
*
|
|
3558
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
3535
3559
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
3536
3560
|
*/
|
|
3537
3561
|
quantityAvailable?: number | null;
|
|
3538
|
-
/**
|
|
3562
|
+
/** Physical properties of the item. */
|
|
3539
3563
|
physicalProperties?: PhysicalProperties$d;
|
|
3540
3564
|
/**
|
|
3541
|
-
*
|
|
3565
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
3566
|
+
*
|
|
3542
3567
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
3543
3568
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
3544
3569
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -3546,21 +3571,23 @@ interface CustomLineItem$9 {
|
|
|
3546
3571
|
*/
|
|
3547
3572
|
paymentOption?: PaymentOptionType$d;
|
|
3548
3573
|
/**
|
|
3549
|
-
*
|
|
3574
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
3550
3575
|
* Used, among other things, when checking for valid memberships.
|
|
3551
3576
|
*/
|
|
3552
3577
|
serviceProperties?: ServiceProperties$9;
|
|
3553
3578
|
/**
|
|
3554
|
-
*
|
|
3579
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
3580
|
+
*
|
|
3555
3581
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
3556
|
-
* +
|
|
3582
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
3557
3583
|
* + Used in membership validation.
|
|
3558
3584
|
*/
|
|
3559
3585
|
rootCatalogItemId?: string | null;
|
|
3560
3586
|
/**
|
|
3561
|
-
*
|
|
3587
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
3588
|
+
*
|
|
3562
3589
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
3563
|
-
*
|
|
3590
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
3564
3591
|
*/
|
|
3565
3592
|
depositAmount?: string | null;
|
|
3566
3593
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -4262,7 +4289,12 @@ interface CreateCartRequest$1 {
|
|
|
4262
4289
|
merchantDiscounts?: MerchantDiscountInput$5[];
|
|
4263
4290
|
/** Catalog line items. */
|
|
4264
4291
|
lineItems?: LineItem$7[];
|
|
4265
|
-
/**
|
|
4292
|
+
/**
|
|
4293
|
+
* Custom line items.
|
|
4294
|
+
*
|
|
4295
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
4296
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
4297
|
+
*/
|
|
4266
4298
|
customLineItems?: CustomLineItem$9[];
|
|
4267
4299
|
}
|
|
4268
4300
|
interface CreateCartResponse$1 {
|
|
@@ -4282,7 +4314,12 @@ interface AddToCartRequest$1 {
|
|
|
4282
4314
|
id: string;
|
|
4283
4315
|
/** Catalog line items. */
|
|
4284
4316
|
lineItems?: LineItem$7[];
|
|
4285
|
-
/**
|
|
4317
|
+
/**
|
|
4318
|
+
* Custom line items.
|
|
4319
|
+
*
|
|
4320
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
4321
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
4322
|
+
*/
|
|
4286
4323
|
customLineItems?: CustomLineItem$9[];
|
|
4287
4324
|
}
|
|
4288
4325
|
interface RemoveLineItemsRequest$3 {
|
|
@@ -4973,6 +5010,13 @@ interface LineItem$6 {
|
|
|
4973
5010
|
* @readonly
|
|
4974
5011
|
*/
|
|
4975
5012
|
consentRequiredPaymentPolicy?: string | null;
|
|
5013
|
+
/**
|
|
5014
|
+
* Overriding values for catalog item properties.
|
|
5015
|
+
*
|
|
5016
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
5017
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
5018
|
+
*/
|
|
5019
|
+
catalogOverrideFields?: CatalogOverrideFields$6;
|
|
4976
5020
|
/**
|
|
4977
5021
|
* Whether to save the payment method on the order.
|
|
4978
5022
|
*
|
|
@@ -5175,6 +5219,20 @@ interface SelectedMembership$6 {
|
|
|
5175
5219
|
/** ID of the app providing this payment option. */
|
|
5176
5220
|
appId?: string;
|
|
5177
5221
|
}
|
|
5222
|
+
interface CatalogOverrideFields$6 {
|
|
5223
|
+
/** Item name. */
|
|
5224
|
+
productName?: ProductName$a;
|
|
5225
|
+
/** Item price **after** discounts. */
|
|
5226
|
+
price?: string | null;
|
|
5227
|
+
/** Item price **before** discounts. */
|
|
5228
|
+
fullPrice?: string | null;
|
|
5229
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
5230
|
+
descriptionLines?: DescriptionLine$a[];
|
|
5231
|
+
/** Physical properties of the item. */
|
|
5232
|
+
physicalProperties?: PhysicalProperties$c;
|
|
5233
|
+
/** Item image. */
|
|
5234
|
+
image?: string;
|
|
5235
|
+
}
|
|
5178
5236
|
/** Buyer Info */
|
|
5179
5237
|
interface BuyerInfo$8 extends BuyerInfoIdOneOf$8 {
|
|
5180
5238
|
/**
|
|
@@ -5324,7 +5382,12 @@ interface UpdateCartRequest$2 {
|
|
|
5324
5382
|
merchantDiscounts?: MerchantDiscountInput$4[];
|
|
5325
5383
|
/** Catalog line items. */
|
|
5326
5384
|
lineItems?: LineItem$6[];
|
|
5327
|
-
/**
|
|
5385
|
+
/**
|
|
5386
|
+
* Custom line items.
|
|
5387
|
+
*
|
|
5388
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
5389
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
5390
|
+
*/
|
|
5328
5391
|
customLineItems?: CustomLineItem$8[];
|
|
5329
5392
|
}
|
|
5330
5393
|
interface MerchantDiscountInput$4 {
|
|
@@ -5359,31 +5422,30 @@ interface CustomLineItem$8 {
|
|
|
5359
5422
|
media?: string;
|
|
5360
5423
|
/**
|
|
5361
5424
|
* Custom line item ID. If passed, `id` must be unique.
|
|
5362
|
-
*
|
|
5425
|
+
*
|
|
5426
|
+
* Default: auto-generated ID
|
|
5363
5427
|
*/
|
|
5364
5428
|
_id?: string | null;
|
|
5365
5429
|
/** Tax group ID for this custom line item. */
|
|
5366
5430
|
taxGroupId?: string | null;
|
|
5367
5431
|
/** Name of the item or product. */
|
|
5368
5432
|
productName?: ProductName$a;
|
|
5369
|
-
/**
|
|
5370
|
-
* Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
|
|
5371
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
5372
|
-
*/
|
|
5433
|
+
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
5373
5434
|
url?: string;
|
|
5374
5435
|
/** Item type. Either a preset type or custom. */
|
|
5375
5436
|
itemType?: ItemType$c;
|
|
5376
|
-
/**
|
|
5437
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
5377
5438
|
fullPrice?: string | null;
|
|
5378
5439
|
/**
|
|
5379
|
-
*
|
|
5440
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
5380
5441
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
5381
5442
|
*/
|
|
5382
5443
|
quantityAvailable?: number | null;
|
|
5383
|
-
/**
|
|
5444
|
+
/** Physical properties of the item. */
|
|
5384
5445
|
physicalProperties?: PhysicalProperties$c;
|
|
5385
5446
|
/**
|
|
5386
|
-
*
|
|
5447
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
5448
|
+
*
|
|
5387
5449
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
5388
5450
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
5389
5451
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -5391,21 +5453,23 @@ interface CustomLineItem$8 {
|
|
|
5391
5453
|
*/
|
|
5392
5454
|
paymentOption?: PaymentOptionType$c;
|
|
5393
5455
|
/**
|
|
5394
|
-
*
|
|
5456
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
5395
5457
|
* Used, among other things, when checking for valid memberships.
|
|
5396
5458
|
*/
|
|
5397
5459
|
serviceProperties?: ServiceProperties$8;
|
|
5398
5460
|
/**
|
|
5399
|
-
*
|
|
5461
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
5462
|
+
*
|
|
5400
5463
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
5401
|
-
* +
|
|
5464
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
5402
5465
|
* + Used in membership validation.
|
|
5403
5466
|
*/
|
|
5404
5467
|
rootCatalogItemId?: string | null;
|
|
5405
5468
|
/**
|
|
5406
|
-
*
|
|
5469
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
5470
|
+
*
|
|
5407
5471
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
5408
|
-
*
|
|
5472
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
5409
5473
|
*/
|
|
5410
5474
|
depositAmount?: string | null;
|
|
5411
5475
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -6116,7 +6180,12 @@ interface CreateCartRequest {
|
|
|
6116
6180
|
merchantDiscounts?: MerchantDiscountInput$4[];
|
|
6117
6181
|
/** Catalog line items. */
|
|
6118
6182
|
lineItems?: LineItem$6[];
|
|
6119
|
-
/**
|
|
6183
|
+
/**
|
|
6184
|
+
* Custom line items.
|
|
6185
|
+
*
|
|
6186
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
6187
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
6188
|
+
*/
|
|
6120
6189
|
customLineItems?: CustomLineItem$8[];
|
|
6121
6190
|
}
|
|
6122
6191
|
interface CreateCartResponse {
|
|
@@ -6136,7 +6205,12 @@ interface AddToCartRequest {
|
|
|
6136
6205
|
_id: string;
|
|
6137
6206
|
/** Catalog line items. */
|
|
6138
6207
|
lineItems?: LineItem$6[];
|
|
6139
|
-
/**
|
|
6208
|
+
/**
|
|
6209
|
+
* Custom line items.
|
|
6210
|
+
*
|
|
6211
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
6212
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
6213
|
+
*/
|
|
6140
6214
|
customLineItems?: CustomLineItem$8[];
|
|
6141
6215
|
}
|
|
6142
6216
|
interface RemoveLineItemsRequest$2 {
|
|
@@ -6866,6 +6940,13 @@ interface LineItem$5 {
|
|
|
6866
6940
|
* @readonly
|
|
6867
6941
|
*/
|
|
6868
6942
|
consentRequiredPaymentPolicy?: string | null;
|
|
6943
|
+
/**
|
|
6944
|
+
* Overriding values for catalog item properties.
|
|
6945
|
+
*
|
|
6946
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
6947
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
6948
|
+
*/
|
|
6949
|
+
catalogOverrideFields?: CatalogOverrideFields$5;
|
|
6869
6950
|
/**
|
|
6870
6951
|
* Whether to save the payment method on the order.
|
|
6871
6952
|
*
|
|
@@ -7118,6 +7199,20 @@ interface SelectedMembership$5 {
|
|
|
7118
7199
|
/** ID of the app providing this payment option. */
|
|
7119
7200
|
appId?: string;
|
|
7120
7201
|
}
|
|
7202
|
+
interface CatalogOverrideFields$5 {
|
|
7203
|
+
/** Item name. */
|
|
7204
|
+
productName?: ProductName$9;
|
|
7205
|
+
/** Item price **after** discounts. */
|
|
7206
|
+
price?: string | null;
|
|
7207
|
+
/** Item price **before** discounts. */
|
|
7208
|
+
fullPrice?: string | null;
|
|
7209
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
7210
|
+
descriptionLines?: DescriptionLine$9[];
|
|
7211
|
+
/** Physical properties of the item. */
|
|
7212
|
+
physicalProperties?: PhysicalProperties$b;
|
|
7213
|
+
/** Item image. */
|
|
7214
|
+
image?: Image$5;
|
|
7215
|
+
}
|
|
7121
7216
|
interface Image$5 {
|
|
7122
7217
|
/** WixMedia image ID. */
|
|
7123
7218
|
id?: string;
|
|
@@ -7295,7 +7390,12 @@ interface UpdateCartRequest$1 {
|
|
|
7295
7390
|
merchantDiscounts?: MerchantDiscountInput$3[];
|
|
7296
7391
|
/** Catalog line items. */
|
|
7297
7392
|
lineItems?: LineItem$5[];
|
|
7298
|
-
/**
|
|
7393
|
+
/**
|
|
7394
|
+
* Custom line items.
|
|
7395
|
+
*
|
|
7396
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
7397
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
7398
|
+
*/
|
|
7299
7399
|
customLineItems?: CustomLineItem$7[];
|
|
7300
7400
|
}
|
|
7301
7401
|
interface MerchantDiscountInput$3 {
|
|
@@ -7326,31 +7426,30 @@ interface CustomLineItem$7 {
|
|
|
7326
7426
|
media?: Image$5;
|
|
7327
7427
|
/**
|
|
7328
7428
|
* Custom line item ID. If passed, `id` must be unique.
|
|
7329
|
-
*
|
|
7429
|
+
*
|
|
7430
|
+
* Default: auto-generated ID
|
|
7330
7431
|
*/
|
|
7331
7432
|
id?: string | null;
|
|
7332
7433
|
/** Tax group ID for this custom line item. */
|
|
7333
7434
|
taxGroupId?: string | null;
|
|
7334
7435
|
/** Name of the item or product. */
|
|
7335
7436
|
productName?: ProductName$9;
|
|
7336
|
-
/**
|
|
7337
|
-
* Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
|
|
7338
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
7339
|
-
*/
|
|
7437
|
+
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
7340
7438
|
url?: PageUrlV2$3;
|
|
7341
7439
|
/** Item type. Either a preset type or custom. */
|
|
7342
7440
|
itemType?: ItemType$b;
|
|
7343
|
-
/**
|
|
7441
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
7344
7442
|
fullPrice?: string | null;
|
|
7345
7443
|
/**
|
|
7346
|
-
*
|
|
7444
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
7347
7445
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
7348
7446
|
*/
|
|
7349
7447
|
quantityAvailable?: number | null;
|
|
7350
|
-
/**
|
|
7448
|
+
/** Physical properties of the item. */
|
|
7351
7449
|
physicalProperties?: PhysicalProperties$b;
|
|
7352
7450
|
/**
|
|
7353
|
-
*
|
|
7451
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
7452
|
+
*
|
|
7354
7453
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
7355
7454
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
7356
7455
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -7358,21 +7457,23 @@ interface CustomLineItem$7 {
|
|
|
7358
7457
|
*/
|
|
7359
7458
|
paymentOption?: PaymentOptionType$b;
|
|
7360
7459
|
/**
|
|
7361
|
-
*
|
|
7460
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
7362
7461
|
* Used, among other things, when checking for valid memberships.
|
|
7363
7462
|
*/
|
|
7364
7463
|
serviceProperties?: ServiceProperties$7;
|
|
7365
7464
|
/**
|
|
7366
|
-
*
|
|
7465
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
7466
|
+
*
|
|
7367
7467
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
7368
|
-
* +
|
|
7468
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
7369
7469
|
* + Used in membership validation.
|
|
7370
7470
|
*/
|
|
7371
7471
|
rootCatalogItemId?: string | null;
|
|
7372
7472
|
/**
|
|
7373
|
-
*
|
|
7473
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
7474
|
+
*
|
|
7374
7475
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
7375
|
-
*
|
|
7476
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
7376
7477
|
*/
|
|
7377
7478
|
depositAmount?: string | null;
|
|
7378
7479
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -7385,7 +7486,12 @@ interface UpdateCartResponse$1 {
|
|
|
7385
7486
|
interface AddToCurrentCartRequest$1 {
|
|
7386
7487
|
/** Catalog line items. */
|
|
7387
7488
|
lineItems?: LineItem$5[];
|
|
7388
|
-
/**
|
|
7489
|
+
/**
|
|
7490
|
+
* Custom line items.
|
|
7491
|
+
*
|
|
7492
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
7493
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
7494
|
+
*/
|
|
7389
7495
|
customLineItems?: CustomLineItem$7[];
|
|
7390
7496
|
}
|
|
7391
7497
|
interface AddToCartResponse$1 {
|
|
@@ -8744,6 +8850,13 @@ interface LineItem$4 {
|
|
|
8744
8850
|
* @readonly
|
|
8745
8851
|
*/
|
|
8746
8852
|
consentRequiredPaymentPolicy?: string | null;
|
|
8853
|
+
/**
|
|
8854
|
+
* Overriding values for catalog item properties.
|
|
8855
|
+
*
|
|
8856
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
8857
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
8858
|
+
*/
|
|
8859
|
+
catalogOverrideFields?: CatalogOverrideFields$4;
|
|
8747
8860
|
/**
|
|
8748
8861
|
* Whether to save the payment method on the order.
|
|
8749
8862
|
*
|
|
@@ -8946,6 +9059,20 @@ interface SelectedMembership$4 {
|
|
|
8946
9059
|
/** ID of the app providing this payment option. */
|
|
8947
9060
|
appId?: string;
|
|
8948
9061
|
}
|
|
9062
|
+
interface CatalogOverrideFields$4 {
|
|
9063
|
+
/** Item name. */
|
|
9064
|
+
productName?: ProductName$8;
|
|
9065
|
+
/** Item price **after** discounts. */
|
|
9066
|
+
price?: string | null;
|
|
9067
|
+
/** Item price **before** discounts. */
|
|
9068
|
+
fullPrice?: string | null;
|
|
9069
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
9070
|
+
descriptionLines?: DescriptionLine$8[];
|
|
9071
|
+
/** Physical properties of the item. */
|
|
9072
|
+
physicalProperties?: PhysicalProperties$a;
|
|
9073
|
+
/** Item image. */
|
|
9074
|
+
image?: string;
|
|
9075
|
+
}
|
|
8949
9076
|
/** Buyer Info */
|
|
8950
9077
|
interface BuyerInfo$6 extends BuyerInfoIdOneOf$6 {
|
|
8951
9078
|
/**
|
|
@@ -9101,7 +9228,12 @@ interface UpdateCartRequest {
|
|
|
9101
9228
|
merchantDiscounts?: MerchantDiscountInput$2[];
|
|
9102
9229
|
/** Catalog line items. */
|
|
9103
9230
|
lineItems?: LineItem$4[];
|
|
9104
|
-
/**
|
|
9231
|
+
/**
|
|
9232
|
+
* Custom line items.
|
|
9233
|
+
*
|
|
9234
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
9235
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
9236
|
+
*/
|
|
9105
9237
|
customLineItems?: CustomLineItem$6[];
|
|
9106
9238
|
}
|
|
9107
9239
|
interface MerchantDiscountInput$2 {
|
|
@@ -9136,31 +9268,30 @@ interface CustomLineItem$6 {
|
|
|
9136
9268
|
media?: string;
|
|
9137
9269
|
/**
|
|
9138
9270
|
* Custom line item ID. If passed, `id` must be unique.
|
|
9139
|
-
*
|
|
9271
|
+
*
|
|
9272
|
+
* Default: auto-generated ID
|
|
9140
9273
|
*/
|
|
9141
9274
|
_id?: string | null;
|
|
9142
9275
|
/** Tax group ID for this custom line item. */
|
|
9143
9276
|
taxGroupId?: string | null;
|
|
9144
9277
|
/** Name of the item or product. */
|
|
9145
9278
|
productName?: ProductName$8;
|
|
9146
|
-
/**
|
|
9147
|
-
* Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
|
|
9148
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
9149
|
-
*/
|
|
9279
|
+
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
9150
9280
|
url?: string;
|
|
9151
9281
|
/** Item type. Either a preset type or custom. */
|
|
9152
9282
|
itemType?: ItemType$a;
|
|
9153
|
-
/**
|
|
9283
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
9154
9284
|
fullPrice?: string | null;
|
|
9155
9285
|
/**
|
|
9156
|
-
*
|
|
9286
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
9157
9287
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
9158
9288
|
*/
|
|
9159
9289
|
quantityAvailable?: number | null;
|
|
9160
|
-
/**
|
|
9290
|
+
/** Physical properties of the item. */
|
|
9161
9291
|
physicalProperties?: PhysicalProperties$a;
|
|
9162
9292
|
/**
|
|
9163
|
-
*
|
|
9293
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
9294
|
+
*
|
|
9164
9295
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
9165
9296
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
9166
9297
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -9168,21 +9299,23 @@ interface CustomLineItem$6 {
|
|
|
9168
9299
|
*/
|
|
9169
9300
|
paymentOption?: PaymentOptionType$a;
|
|
9170
9301
|
/**
|
|
9171
|
-
*
|
|
9302
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
9172
9303
|
* Used, among other things, when checking for valid memberships.
|
|
9173
9304
|
*/
|
|
9174
9305
|
serviceProperties?: ServiceProperties$6;
|
|
9175
9306
|
/**
|
|
9176
|
-
*
|
|
9307
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
9308
|
+
*
|
|
9177
9309
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
9178
|
-
* +
|
|
9310
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
9179
9311
|
* + Used in membership validation.
|
|
9180
9312
|
*/
|
|
9181
9313
|
rootCatalogItemId?: string | null;
|
|
9182
9314
|
/**
|
|
9183
|
-
*
|
|
9315
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
9316
|
+
*
|
|
9184
9317
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
9185
|
-
*
|
|
9318
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
9186
9319
|
*/
|
|
9187
9320
|
depositAmount?: string | null;
|
|
9188
9321
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -9195,7 +9328,12 @@ interface UpdateCartResponse {
|
|
|
9195
9328
|
interface AddToCurrentCartRequest {
|
|
9196
9329
|
/** Catalog line items. */
|
|
9197
9330
|
lineItems?: LineItem$4[];
|
|
9198
|
-
/**
|
|
9331
|
+
/**
|
|
9332
|
+
* Custom line items.
|
|
9333
|
+
*
|
|
9334
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
9335
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
9336
|
+
*/
|
|
9199
9337
|
customLineItems?: CustomLineItem$6[];
|
|
9200
9338
|
}
|
|
9201
9339
|
interface AddToCartResponse {
|
|
@@ -10689,11 +10827,23 @@ interface LineItem$3 {
|
|
|
10689
10827
|
* @readonly
|
|
10690
10828
|
*/
|
|
10691
10829
|
depositAmount?: MultiCurrencyPrice$3;
|
|
10830
|
+
/**
|
|
10831
|
+
* Whether the line item is custom or from catalog.
|
|
10832
|
+
* @readonly
|
|
10833
|
+
*/
|
|
10834
|
+
customLineItem?: boolean;
|
|
10692
10835
|
/**
|
|
10693
10836
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
10694
10837
|
* @readonly
|
|
10695
10838
|
*/
|
|
10696
10839
|
consentRequiredPaymentPolicy?: string | null;
|
|
10840
|
+
/**
|
|
10841
|
+
* Overriding values for catalog item properties.
|
|
10842
|
+
*
|
|
10843
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
10844
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
10845
|
+
*/
|
|
10846
|
+
catalogOverrideFields?: CatalogOverrideFields$3;
|
|
10697
10847
|
/**
|
|
10698
10848
|
* Whether to save the payment method on the order.
|
|
10699
10849
|
*
|
|
@@ -10970,6 +11120,20 @@ interface PriceDescription$7 {
|
|
|
10970
11120
|
*/
|
|
10971
11121
|
translated?: string | null;
|
|
10972
11122
|
}
|
|
11123
|
+
interface CatalogOverrideFields$3 {
|
|
11124
|
+
/** Item name. */
|
|
11125
|
+
productName?: ProductName$7;
|
|
11126
|
+
/** Item price **after** discounts. */
|
|
11127
|
+
price?: string | null;
|
|
11128
|
+
/** Item price **before** discounts. */
|
|
11129
|
+
fullPrice?: string | null;
|
|
11130
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
11131
|
+
descriptionLines?: DescriptionLine$7[];
|
|
11132
|
+
/** Physical properties of the item. */
|
|
11133
|
+
physicalProperties?: PhysicalProperties$9;
|
|
11134
|
+
/** Item image. */
|
|
11135
|
+
image?: Image$4;
|
|
11136
|
+
}
|
|
10973
11137
|
interface Image$4 {
|
|
10974
11138
|
/** WixMedia image ID. */
|
|
10975
11139
|
id?: string;
|
|
@@ -11758,9 +11922,14 @@ interface CreateCheckoutRequest$1 {
|
|
|
11758
11922
|
checkoutInfo?: Checkout$1;
|
|
11759
11923
|
/** Coupon code. */
|
|
11760
11924
|
couponCode?: string | null;
|
|
11761
|
-
/** Line items to
|
|
11925
|
+
/** Line items to add to the checkout. */
|
|
11762
11926
|
lineItems?: LineItem$3[];
|
|
11763
|
-
/**
|
|
11927
|
+
/**
|
|
11928
|
+
* Custom line items to add to the checkout.
|
|
11929
|
+
*
|
|
11930
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
11931
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
11932
|
+
*/
|
|
11764
11933
|
customLineItems?: CustomLineItem$5[];
|
|
11765
11934
|
/**
|
|
11766
11935
|
* Sales channel that submitted the order.
|
|
@@ -11815,31 +11984,30 @@ interface CustomLineItem$5 {
|
|
|
11815
11984
|
media?: Image$4;
|
|
11816
11985
|
/**
|
|
11817
11986
|
* Custom line item ID. If passed, `id` must be unique.
|
|
11818
|
-
*
|
|
11987
|
+
*
|
|
11988
|
+
* Default: auto-generated ID
|
|
11819
11989
|
*/
|
|
11820
11990
|
id?: string | null;
|
|
11821
11991
|
/** Tax group ID for this custom line item. */
|
|
11822
11992
|
taxGroupId?: string | null;
|
|
11823
11993
|
/** Name of the item or product. */
|
|
11824
11994
|
productName?: ProductName$7;
|
|
11825
|
-
/**
|
|
11826
|
-
* Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
|
|
11827
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
11828
|
-
*/
|
|
11995
|
+
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
11829
11996
|
url?: PageUrlV2$2;
|
|
11830
11997
|
/** Item type. Either a preset type or custom. */
|
|
11831
11998
|
itemType?: ItemType$9;
|
|
11832
|
-
/**
|
|
11999
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
11833
12000
|
fullPrice?: string | null;
|
|
11834
12001
|
/**
|
|
11835
|
-
*
|
|
12002
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
11836
12003
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
11837
12004
|
*/
|
|
11838
12005
|
quantityAvailable?: number | null;
|
|
11839
|
-
/**
|
|
12006
|
+
/** Physical properties of the item. */
|
|
11840
12007
|
physicalProperties?: PhysicalProperties$9;
|
|
11841
12008
|
/**
|
|
11842
|
-
*
|
|
12009
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
12010
|
+
*
|
|
11843
12011
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
11844
12012
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
11845
12013
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -11847,21 +12015,23 @@ interface CustomLineItem$5 {
|
|
|
11847
12015
|
*/
|
|
11848
12016
|
paymentOption?: PaymentOptionType$9;
|
|
11849
12017
|
/**
|
|
11850
|
-
*
|
|
12018
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
11851
12019
|
* Used, among other things, when checking for valid memberships.
|
|
11852
12020
|
*/
|
|
11853
12021
|
serviceProperties?: ServiceProperties$5;
|
|
11854
12022
|
/**
|
|
11855
|
-
*
|
|
12023
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
12024
|
+
*
|
|
11856
12025
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
11857
|
-
* +
|
|
12026
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
11858
12027
|
* + Used in membership validation.
|
|
11859
12028
|
*/
|
|
11860
12029
|
rootCatalogItemId?: string | null;
|
|
11861
12030
|
/**
|
|
11862
|
-
*
|
|
12031
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
12032
|
+
*
|
|
11863
12033
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
11864
|
-
*
|
|
12034
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
11865
12035
|
*/
|
|
11866
12036
|
depositAmount?: string | null;
|
|
11867
12037
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -11914,7 +12084,14 @@ interface UpdateCheckoutRequest$1 {
|
|
|
11914
12084
|
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
11915
12085
|
*/
|
|
11916
12086
|
overrideCheckoutUrl?: string | null;
|
|
11917
|
-
/**
|
|
12087
|
+
/** Line items. */
|
|
12088
|
+
lineItems?: LineItem$3[];
|
|
12089
|
+
/**
|
|
12090
|
+
* Custom line items.
|
|
12091
|
+
*
|
|
12092
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
12093
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
12094
|
+
*/
|
|
11918
12095
|
customLineItems?: CustomLineItem$5[];
|
|
11919
12096
|
}
|
|
11920
12097
|
interface UpdateCheckoutResponse$1 {
|
|
@@ -11950,7 +12127,12 @@ interface AddToCheckoutRequest$1 {
|
|
|
11950
12127
|
id: string;
|
|
11951
12128
|
/** Catalog line items. */
|
|
11952
12129
|
lineItems?: LineItem$3[];
|
|
11953
|
-
/**
|
|
12130
|
+
/**
|
|
12131
|
+
* Custom line items.
|
|
12132
|
+
*
|
|
12133
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
12134
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
12135
|
+
*/
|
|
11954
12136
|
customLineItems?: CustomLineItem$5[];
|
|
11955
12137
|
}
|
|
11956
12138
|
interface AddToCheckoutResponse$1 {
|
|
@@ -12790,11 +12972,23 @@ interface LineItem$2 {
|
|
|
12790
12972
|
* @readonly
|
|
12791
12973
|
*/
|
|
12792
12974
|
depositAmount?: MultiCurrencyPrice$2;
|
|
12975
|
+
/**
|
|
12976
|
+
* Whether the line item is custom or from catalog.
|
|
12977
|
+
* @readonly
|
|
12978
|
+
*/
|
|
12979
|
+
customLineItem?: boolean;
|
|
12793
12980
|
/**
|
|
12794
12981
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
12795
12982
|
* @readonly
|
|
12796
12983
|
*/
|
|
12797
12984
|
consentRequiredPaymentPolicy?: string | null;
|
|
12985
|
+
/**
|
|
12986
|
+
* Overriding values for catalog item properties.
|
|
12987
|
+
*
|
|
12988
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
12989
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
12990
|
+
*/
|
|
12991
|
+
catalogOverrideFields?: CatalogOverrideFields$2;
|
|
12798
12992
|
/**
|
|
12799
12993
|
* Whether to save the payment method on the order.
|
|
12800
12994
|
*
|
|
@@ -13044,6 +13238,20 @@ interface PriceDescription$6 {
|
|
|
13044
13238
|
*/
|
|
13045
13239
|
translated?: string | null;
|
|
13046
13240
|
}
|
|
13241
|
+
interface CatalogOverrideFields$2 {
|
|
13242
|
+
/** Item name. */
|
|
13243
|
+
productName?: ProductName$6;
|
|
13244
|
+
/** Item price **after** discounts. */
|
|
13245
|
+
price?: string | null;
|
|
13246
|
+
/** Item price **before** discounts. */
|
|
13247
|
+
fullPrice?: string | null;
|
|
13248
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
13249
|
+
descriptionLines?: DescriptionLine$6[];
|
|
13250
|
+
/** Physical properties of the item. */
|
|
13251
|
+
physicalProperties?: PhysicalProperties$8;
|
|
13252
|
+
/** Item image. */
|
|
13253
|
+
image?: string;
|
|
13254
|
+
}
|
|
13047
13255
|
/** Billing Info and shipping details */
|
|
13048
13256
|
interface AddressWithContact$4 {
|
|
13049
13257
|
/** Address. */
|
|
@@ -13810,9 +14018,14 @@ interface CreateCheckoutRequest {
|
|
|
13810
14018
|
checkoutInfo?: Checkout;
|
|
13811
14019
|
/** 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). */
|
|
13812
14020
|
couponCode?: string | null;
|
|
13813
|
-
/** Line items to
|
|
14021
|
+
/** Line items to add to the checkout. */
|
|
13814
14022
|
lineItems?: LineItem$2[];
|
|
13815
|
-
/**
|
|
14023
|
+
/**
|
|
14024
|
+
* Custom line items to add to the checkout.
|
|
14025
|
+
*
|
|
14026
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
14027
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
14028
|
+
*/
|
|
13816
14029
|
customLineItems?: CustomLineItem$4[];
|
|
13817
14030
|
/**
|
|
13818
14031
|
* **Required**
|
|
@@ -13856,31 +14069,30 @@ interface CustomLineItem$4 {
|
|
|
13856
14069
|
media?: string;
|
|
13857
14070
|
/**
|
|
13858
14071
|
* Custom line item ID. If passed, `id` must be unique.
|
|
13859
|
-
*
|
|
14072
|
+
*
|
|
14073
|
+
* Default: auto-generated ID
|
|
13860
14074
|
*/
|
|
13861
14075
|
_id?: string | null;
|
|
13862
14076
|
/** Tax group ID for this custom line item. */
|
|
13863
14077
|
taxGroupId?: string | null;
|
|
13864
14078
|
/** Name of the item or product. */
|
|
13865
14079
|
productName?: ProductName$6;
|
|
13866
|
-
/**
|
|
13867
|
-
* Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
|
|
13868
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
13869
|
-
*/
|
|
14080
|
+
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
13870
14081
|
url?: string;
|
|
13871
14082
|
/** Item type. Either a preset type or custom. */
|
|
13872
14083
|
itemType?: ItemType$8;
|
|
13873
|
-
/**
|
|
14084
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
13874
14085
|
fullPrice?: string | null;
|
|
13875
14086
|
/**
|
|
13876
|
-
*
|
|
14087
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
13877
14088
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
13878
14089
|
*/
|
|
13879
14090
|
quantityAvailable?: number | null;
|
|
13880
|
-
/**
|
|
14091
|
+
/** Physical properties of the item. */
|
|
13881
14092
|
physicalProperties?: PhysicalProperties$8;
|
|
13882
14093
|
/**
|
|
13883
|
-
*
|
|
14094
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
14095
|
+
*
|
|
13884
14096
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
13885
14097
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
13886
14098
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -13888,21 +14100,23 @@ interface CustomLineItem$4 {
|
|
|
13888
14100
|
*/
|
|
13889
14101
|
paymentOption?: PaymentOptionType$8;
|
|
13890
14102
|
/**
|
|
13891
|
-
*
|
|
14103
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
13892
14104
|
* Used, among other things, when checking for valid memberships.
|
|
13893
14105
|
*/
|
|
13894
14106
|
serviceProperties?: ServiceProperties$4;
|
|
13895
14107
|
/**
|
|
13896
|
-
*
|
|
14108
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
14109
|
+
*
|
|
13897
14110
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
13898
|
-
* +
|
|
14111
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
13899
14112
|
* + Used in membership validation.
|
|
13900
14113
|
*/
|
|
13901
14114
|
rootCatalogItemId?: string | null;
|
|
13902
14115
|
/**
|
|
13903
|
-
*
|
|
14116
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
14117
|
+
*
|
|
13904
14118
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
13905
|
-
*
|
|
14119
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
13906
14120
|
*/
|
|
13907
14121
|
depositAmount?: string | null;
|
|
13908
14122
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -13949,7 +14163,14 @@ interface UpdateCheckoutRequest {
|
|
|
13949
14163
|
* 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`.
|
|
13950
14164
|
*/
|
|
13951
14165
|
overrideCheckoutUrl?: string | null;
|
|
13952
|
-
/**
|
|
14166
|
+
/** Line items. */
|
|
14167
|
+
lineItems?: LineItem$2[];
|
|
14168
|
+
/**
|
|
14169
|
+
* Custom line items.
|
|
14170
|
+
*
|
|
14171
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
14172
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
14173
|
+
*/
|
|
13953
14174
|
customLineItems?: CustomLineItem$4[];
|
|
13954
14175
|
}
|
|
13955
14176
|
interface UpdateCheckoutResponse {
|
|
@@ -13985,7 +14206,12 @@ interface AddToCheckoutRequest {
|
|
|
13985
14206
|
_id: string;
|
|
13986
14207
|
/** Catalog line items. */
|
|
13987
14208
|
lineItems?: LineItem$2[];
|
|
13988
|
-
/**
|
|
14209
|
+
/**
|
|
14210
|
+
* Custom line items.
|
|
14211
|
+
*
|
|
14212
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
14213
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
14214
|
+
*/
|
|
13989
14215
|
customLineItems?: CustomLineItem$4[];
|
|
13990
14216
|
}
|
|
13991
14217
|
interface AddToCheckoutResponse {
|
|
@@ -15052,6 +15278,13 @@ interface V1LineItem$1 {
|
|
|
15052
15278
|
* > **Note:** For more information on what to pass to `lineItems.catalogReference`, see [eCommerce Integration in the Wix Stores Catalog API](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration).
|
|
15053
15279
|
*/
|
|
15054
15280
|
catalogReference?: CatalogReference$7;
|
|
15281
|
+
/**
|
|
15282
|
+
* Overriding values for catalog item properties.
|
|
15283
|
+
*
|
|
15284
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
15285
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
15286
|
+
*/
|
|
15287
|
+
catalogOverrideFields?: CatalogOverrideFields$1;
|
|
15055
15288
|
}
|
|
15056
15289
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
15057
15290
|
interface CatalogReference$7 {
|
|
@@ -15075,6 +15308,20 @@ interface CatalogReference$7 {
|
|
|
15075
15308
|
*/
|
|
15076
15309
|
options?: Record<string, any> | null;
|
|
15077
15310
|
}
|
|
15311
|
+
interface CatalogOverrideFields$1 {
|
|
15312
|
+
/** Item name. */
|
|
15313
|
+
productName?: ProductName$5;
|
|
15314
|
+
/** Item price **after** discounts. */
|
|
15315
|
+
price?: string | null;
|
|
15316
|
+
/** Item price **before** discounts. */
|
|
15317
|
+
fullPrice?: string | null;
|
|
15318
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
15319
|
+
descriptionLines?: DescriptionLine$5[];
|
|
15320
|
+
/** Physical properties of the item. */
|
|
15321
|
+
physicalProperties?: PhysicalProperties$7;
|
|
15322
|
+
/** Item image. */
|
|
15323
|
+
image?: Image$3;
|
|
15324
|
+
}
|
|
15078
15325
|
interface ProductName$5 {
|
|
15079
15326
|
/**
|
|
15080
15327
|
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
@@ -15189,31 +15436,30 @@ interface CustomLineItem$3 {
|
|
|
15189
15436
|
media?: Image$3;
|
|
15190
15437
|
/**
|
|
15191
15438
|
* Custom line item ID. If passed, `id` must be unique.
|
|
15192
|
-
*
|
|
15439
|
+
*
|
|
15440
|
+
* Default: auto-generated ID
|
|
15193
15441
|
*/
|
|
15194
15442
|
id?: string | null;
|
|
15195
15443
|
/** Tax group ID for this custom line item. */
|
|
15196
15444
|
taxGroupId?: string | null;
|
|
15197
15445
|
/** Name of the item or product. */
|
|
15198
15446
|
productName?: ProductName$5;
|
|
15199
|
-
/**
|
|
15200
|
-
* Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
|
|
15201
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
15202
|
-
*/
|
|
15447
|
+
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
15203
15448
|
url?: PageUrlV2$1;
|
|
15204
15449
|
/** Item type. Either a preset type or custom. */
|
|
15205
15450
|
itemType?: ItemType$7;
|
|
15206
|
-
/**
|
|
15451
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
15207
15452
|
fullPrice?: string | null;
|
|
15208
15453
|
/**
|
|
15209
|
-
*
|
|
15454
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
15210
15455
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
15211
15456
|
*/
|
|
15212
15457
|
quantityAvailable?: number | null;
|
|
15213
|
-
/**
|
|
15458
|
+
/** Physical properties of the item. */
|
|
15214
15459
|
physicalProperties?: PhysicalProperties$7;
|
|
15215
15460
|
/**
|
|
15216
|
-
*
|
|
15461
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
15462
|
+
*
|
|
15217
15463
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
15218
15464
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
15219
15465
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -15221,21 +15467,23 @@ interface CustomLineItem$3 {
|
|
|
15221
15467
|
*/
|
|
15222
15468
|
paymentOption?: PaymentOptionType$7;
|
|
15223
15469
|
/**
|
|
15224
|
-
*
|
|
15470
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
15225
15471
|
* Used, among other things, when checking for valid memberships.
|
|
15226
15472
|
*/
|
|
15227
15473
|
serviceProperties?: ServiceProperties$3;
|
|
15228
15474
|
/**
|
|
15229
|
-
*
|
|
15475
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
15476
|
+
*
|
|
15230
15477
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
15231
|
-
* +
|
|
15478
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
15232
15479
|
* + Used in membership validation.
|
|
15233
15480
|
*/
|
|
15234
15481
|
rootCatalogItemId?: string | null;
|
|
15235
15482
|
/**
|
|
15236
|
-
*
|
|
15483
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
15484
|
+
*
|
|
15237
15485
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
15238
|
-
*
|
|
15486
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
15239
15487
|
*/
|
|
15240
15488
|
depositAmount?: string | null;
|
|
15241
15489
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -15712,6 +15960,13 @@ interface V1LineItem {
|
|
|
15712
15960
|
* > **Note:** For more information on what to pass to `lineItems.catalogReference`, see [eCommerce Integration in the Wix Stores Catalog API](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration).
|
|
15713
15961
|
*/
|
|
15714
15962
|
catalogReference?: CatalogReference$6;
|
|
15963
|
+
/**
|
|
15964
|
+
* Overriding values for catalog item properties.
|
|
15965
|
+
*
|
|
15966
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
15967
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
15968
|
+
*/
|
|
15969
|
+
catalogOverrideFields?: CatalogOverrideFields;
|
|
15715
15970
|
}
|
|
15716
15971
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
15717
15972
|
interface CatalogReference$6 {
|
|
@@ -15735,6 +15990,20 @@ interface CatalogReference$6 {
|
|
|
15735
15990
|
*/
|
|
15736
15991
|
options?: Record<string, any> | null;
|
|
15737
15992
|
}
|
|
15993
|
+
interface CatalogOverrideFields {
|
|
15994
|
+
/** Item name. */
|
|
15995
|
+
productName?: ProductName$4;
|
|
15996
|
+
/** Item price **after** discounts. */
|
|
15997
|
+
price?: string | null;
|
|
15998
|
+
/** Item price **before** discounts. */
|
|
15999
|
+
fullPrice?: string | null;
|
|
16000
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
16001
|
+
descriptionLines?: DescriptionLine$4[];
|
|
16002
|
+
/** Physical properties of the item. */
|
|
16003
|
+
physicalProperties?: PhysicalProperties$6;
|
|
16004
|
+
/** Item image. */
|
|
16005
|
+
image?: string;
|
|
16006
|
+
}
|
|
15738
16007
|
interface ProductName$4 {
|
|
15739
16008
|
/**
|
|
15740
16009
|
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
@@ -15837,31 +16106,30 @@ interface CustomLineItem$2 {
|
|
|
15837
16106
|
media?: string;
|
|
15838
16107
|
/**
|
|
15839
16108
|
* Custom line item ID. If passed, `id` must be unique.
|
|
15840
|
-
*
|
|
16109
|
+
*
|
|
16110
|
+
* Default: auto-generated ID
|
|
15841
16111
|
*/
|
|
15842
16112
|
_id?: string | null;
|
|
15843
16113
|
/** Tax group ID for this custom line item. */
|
|
15844
16114
|
taxGroupId?: string | null;
|
|
15845
16115
|
/** Name of the item or product. */
|
|
15846
16116
|
productName?: ProductName$4;
|
|
15847
|
-
/**
|
|
15848
|
-
* Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.
|
|
15849
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
15850
|
-
*/
|
|
16117
|
+
/** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
|
|
15851
16118
|
url?: string;
|
|
15852
16119
|
/** Item type. Either a preset type or custom. */
|
|
15853
16120
|
itemType?: ItemType$6;
|
|
15854
|
-
/**
|
|
16121
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
15855
16122
|
fullPrice?: string | null;
|
|
15856
16123
|
/**
|
|
15857
|
-
*
|
|
16124
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
15858
16125
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
15859
16126
|
*/
|
|
15860
16127
|
quantityAvailable?: number | null;
|
|
15861
|
-
/**
|
|
16128
|
+
/** Physical properties of the item. */
|
|
15862
16129
|
physicalProperties?: PhysicalProperties$6;
|
|
15863
16130
|
/**
|
|
15864
|
-
*
|
|
16131
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
16132
|
+
*
|
|
15865
16133
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
15866
16134
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
15867
16135
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -15869,21 +16137,23 @@ interface CustomLineItem$2 {
|
|
|
15869
16137
|
*/
|
|
15870
16138
|
paymentOption?: PaymentOptionType$6;
|
|
15871
16139
|
/**
|
|
15872
|
-
*
|
|
16140
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
15873
16141
|
* Used, among other things, when checking for valid memberships.
|
|
15874
16142
|
*/
|
|
15875
16143
|
serviceProperties?: ServiceProperties$2;
|
|
15876
16144
|
/**
|
|
15877
|
-
*
|
|
16145
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
16146
|
+
*
|
|
15878
16147
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
15879
|
-
* +
|
|
16148
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
15880
16149
|
* + Used in membership validation.
|
|
15881
16150
|
*/
|
|
15882
16151
|
rootCatalogItemId?: string | null;
|
|
15883
16152
|
/**
|
|
15884
|
-
*
|
|
16153
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
16154
|
+
*
|
|
15885
16155
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
15886
|
-
*
|
|
16156
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
15887
16157
|
*/
|
|
15888
16158
|
depositAmount?: string | null;
|
|
15889
16159
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|