@wix/ecom 1.0.713 → 1.0.714
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 +243 -99
- package/type-bundles/index.bundle.d.ts +243 -99
- package/type-bundles/meta.bundle.d.ts +316 -130
|
@@ -4038,17 +4038,17 @@ interface SelectedMembership$4 {
|
|
|
4038
4038
|
appId?: string;
|
|
4039
4039
|
}
|
|
4040
4040
|
interface CatalogOverrideFields$3 {
|
|
4041
|
-
/** Item
|
|
4041
|
+
/** Item name. */
|
|
4042
4042
|
productName?: ProductName$5;
|
|
4043
4043
|
/** Item price **after** discounts. */
|
|
4044
4044
|
price?: string | null;
|
|
4045
|
-
/** Item price **before**
|
|
4045
|
+
/** Item price **before** discounts. */
|
|
4046
4046
|
fullPrice?: string | null;
|
|
4047
|
-
/**
|
|
4047
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
4048
4048
|
descriptionLines?: DescriptionLine$5[];
|
|
4049
|
-
/** Physical properties of the item.
|
|
4049
|
+
/** Physical properties of the item. */
|
|
4050
4050
|
physicalProperties?: PhysicalProperties$6;
|
|
4051
|
-
/**
|
|
4051
|
+
/** Item image. */
|
|
4052
4052
|
image?: string;
|
|
4053
4053
|
}
|
|
4054
4054
|
/** Buyer Info */
|
|
@@ -4223,7 +4223,12 @@ interface UpdateCartRequest$1 {
|
|
|
4223
4223
|
merchantDiscounts?: MerchantDiscountInput$3[];
|
|
4224
4224
|
/** Catalog line items. */
|
|
4225
4225
|
lineItems?: LineItem$6[];
|
|
4226
|
-
/**
|
|
4226
|
+
/**
|
|
4227
|
+
* Custom line items.
|
|
4228
|
+
*
|
|
4229
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
4230
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
4231
|
+
*/
|
|
4227
4232
|
customLineItems?: CustomLineItem$4[];
|
|
4228
4233
|
}
|
|
4229
4234
|
interface MerchantDiscountInput$3 {
|
|
@@ -4258,31 +4263,30 @@ interface CustomLineItem$4 {
|
|
|
4258
4263
|
media?: string;
|
|
4259
4264
|
/**
|
|
4260
4265
|
* Custom line item ID. If passed, `id` must be unique.
|
|
4261
|
-
*
|
|
4266
|
+
*
|
|
4267
|
+
* Default: auto-generated ID
|
|
4262
4268
|
*/
|
|
4263
4269
|
_id?: string | null;
|
|
4264
4270
|
/** Tax group ID for this custom line item. */
|
|
4265
4271
|
taxGroupId?: string | null;
|
|
4266
4272
|
/** Name of the item or product. */
|
|
4267
4273
|
productName?: ProductName$5;
|
|
4268
|
-
/**
|
|
4269
|
-
* 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.
|
|
4270
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
4271
|
-
*/
|
|
4274
|
+
/** 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. */
|
|
4272
4275
|
url?: string;
|
|
4273
4276
|
/** Item type. Either a preset type or custom. */
|
|
4274
4277
|
itemType?: ItemType$6;
|
|
4275
|
-
/**
|
|
4278
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
4276
4279
|
fullPrice?: string | null;
|
|
4277
4280
|
/**
|
|
4278
|
-
*
|
|
4281
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
4279
4282
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
4280
4283
|
*/
|
|
4281
4284
|
quantityAvailable?: number | null;
|
|
4282
|
-
/**
|
|
4285
|
+
/** Physical properties of the item. */
|
|
4283
4286
|
physicalProperties?: PhysicalProperties$6;
|
|
4284
4287
|
/**
|
|
4285
|
-
*
|
|
4288
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
4289
|
+
*
|
|
4286
4290
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
4287
4291
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
4288
4292
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -4290,21 +4294,23 @@ interface CustomLineItem$4 {
|
|
|
4290
4294
|
*/
|
|
4291
4295
|
paymentOption?: PaymentOptionType$6;
|
|
4292
4296
|
/**
|
|
4293
|
-
*
|
|
4297
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
4294
4298
|
* Used, among other things, when checking for valid memberships.
|
|
4295
4299
|
*/
|
|
4296
4300
|
serviceProperties?: ServiceProperties$5;
|
|
4297
4301
|
/**
|
|
4298
|
-
*
|
|
4302
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
4303
|
+
*
|
|
4299
4304
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
4300
|
-
* +
|
|
4305
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
4301
4306
|
* + Used in membership validation.
|
|
4302
4307
|
*/
|
|
4303
4308
|
rootCatalogItemId?: string | null;
|
|
4304
4309
|
/**
|
|
4305
|
-
*
|
|
4310
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
4311
|
+
*
|
|
4306
4312
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
4307
|
-
*
|
|
4313
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
4308
4314
|
*/
|
|
4309
4315
|
depositAmount?: string | null;
|
|
4310
4316
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -4317,7 +4323,12 @@ interface UpdateCartResponse$1 {
|
|
|
4317
4323
|
interface AddToCurrentCartRequest$1 {
|
|
4318
4324
|
/** Catalog line items. */
|
|
4319
4325
|
lineItems?: LineItem$6[];
|
|
4320
|
-
/**
|
|
4326
|
+
/**
|
|
4327
|
+
* Custom line items.
|
|
4328
|
+
*
|
|
4329
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
4330
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
4331
|
+
*/
|
|
4321
4332
|
customLineItems?: CustomLineItem$4[];
|
|
4322
4333
|
}
|
|
4323
4334
|
interface AddToCartResponse$1 {
|
|
@@ -4327,7 +4338,12 @@ interface AddToCartResponse$1 {
|
|
|
4327
4338
|
interface AddToCurrentCartAndEstimateTotalsRequest$1 {
|
|
4328
4339
|
/** Catalog line items. */
|
|
4329
4340
|
lineItems?: LineItem$6[];
|
|
4330
|
-
/**
|
|
4341
|
+
/**
|
|
4342
|
+
* Custom line items.
|
|
4343
|
+
*
|
|
4344
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
4345
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
4346
|
+
*/
|
|
4331
4347
|
customLineItems?: CustomLineItem$4[];
|
|
4332
4348
|
/** Selected shipping option. */
|
|
4333
4349
|
selectedShippingOption?: SelectedShippingOption$2;
|
|
@@ -5234,7 +5250,12 @@ interface CreateCartRequest$1 {
|
|
|
5234
5250
|
merchantDiscounts?: MerchantDiscountInput$3[];
|
|
5235
5251
|
/** Catalog line items. */
|
|
5236
5252
|
lineItems?: LineItem$6[];
|
|
5237
|
-
/**
|
|
5253
|
+
/**
|
|
5254
|
+
* Custom line items.
|
|
5255
|
+
*
|
|
5256
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
5257
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
5258
|
+
*/
|
|
5238
5259
|
customLineItems?: CustomLineItem$4[];
|
|
5239
5260
|
}
|
|
5240
5261
|
interface CreateCartResponse$1 {
|
|
@@ -5262,7 +5283,12 @@ interface AddToCartRequest$1 {
|
|
|
5262
5283
|
_id: string;
|
|
5263
5284
|
/** Catalog line items. */
|
|
5264
5285
|
lineItems?: LineItem$6[];
|
|
5265
|
-
/**
|
|
5286
|
+
/**
|
|
5287
|
+
* Custom line items.
|
|
5288
|
+
*
|
|
5289
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
5290
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
5291
|
+
*/
|
|
5266
5292
|
customLineItems?: CustomLineItem$4[];
|
|
5267
5293
|
}
|
|
5268
5294
|
interface RemoveLineItemsRequest$2 {
|
|
@@ -5823,7 +5849,12 @@ interface CreateCartOptions {
|
|
|
5823
5849
|
merchantDiscounts?: MerchantDiscountInput$3[];
|
|
5824
5850
|
/** Catalog line items. */
|
|
5825
5851
|
lineItems?: LineItem$6[];
|
|
5826
|
-
/**
|
|
5852
|
+
/**
|
|
5853
|
+
* Custom line items.
|
|
5854
|
+
*
|
|
5855
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
5856
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
5857
|
+
*/
|
|
5827
5858
|
customLineItems?: CustomLineItem$4[];
|
|
5828
5859
|
}
|
|
5829
5860
|
interface UpdateCartOptions {
|
|
@@ -5914,13 +5945,23 @@ interface UpdateCartOptions {
|
|
|
5914
5945
|
merchantDiscounts?: MerchantDiscountInput$3[];
|
|
5915
5946
|
/** Catalog line items. */
|
|
5916
5947
|
lineItems?: LineItem$6[];
|
|
5917
|
-
/**
|
|
5948
|
+
/**
|
|
5949
|
+
* Custom line items.
|
|
5950
|
+
*
|
|
5951
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
5952
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
5953
|
+
*/
|
|
5918
5954
|
customLineItems?: CustomLineItem$4[];
|
|
5919
5955
|
}
|
|
5920
5956
|
interface AddToCartOptions {
|
|
5921
5957
|
/** Catalog line items. */
|
|
5922
5958
|
lineItems?: LineItem$6[];
|
|
5923
|
-
/**
|
|
5959
|
+
/**
|
|
5960
|
+
* Custom line items.
|
|
5961
|
+
*
|
|
5962
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
5963
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
5964
|
+
*/
|
|
5924
5965
|
customLineItems?: CustomLineItem$4[];
|
|
5925
5966
|
}
|
|
5926
5967
|
interface CreateCheckoutOptions$1 {
|
|
@@ -6597,17 +6638,17 @@ interface SelectedMembership$3 {
|
|
|
6597
6638
|
appId?: string;
|
|
6598
6639
|
}
|
|
6599
6640
|
interface CatalogOverrideFields$2 {
|
|
6600
|
-
/** Item
|
|
6641
|
+
/** Item name. */
|
|
6601
6642
|
productName?: ProductName$4;
|
|
6602
6643
|
/** Item price **after** discounts. */
|
|
6603
6644
|
price?: string | null;
|
|
6604
|
-
/** Item price **before**
|
|
6645
|
+
/** Item price **before** discounts. */
|
|
6605
6646
|
fullPrice?: string | null;
|
|
6606
|
-
/**
|
|
6647
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
6607
6648
|
descriptionLines?: DescriptionLine$4[];
|
|
6608
|
-
/** Physical properties of the item.
|
|
6649
|
+
/** Physical properties of the item. */
|
|
6609
6650
|
physicalProperties?: PhysicalProperties$5;
|
|
6610
|
-
/**
|
|
6651
|
+
/** Item image. */
|
|
6611
6652
|
image?: string;
|
|
6612
6653
|
}
|
|
6613
6654
|
/** Buyer Info */
|
|
@@ -6782,7 +6823,12 @@ interface UpdateCartRequest {
|
|
|
6782
6823
|
merchantDiscounts?: MerchantDiscountInput$2[];
|
|
6783
6824
|
/** Catalog line items. */
|
|
6784
6825
|
lineItems?: LineItem$5[];
|
|
6785
|
-
/**
|
|
6826
|
+
/**
|
|
6827
|
+
* Custom line items.
|
|
6828
|
+
*
|
|
6829
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
6830
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
6831
|
+
*/
|
|
6786
6832
|
customLineItems?: CustomLineItem$3[];
|
|
6787
6833
|
}
|
|
6788
6834
|
interface MerchantDiscountInput$2 {
|
|
@@ -6817,31 +6863,30 @@ interface CustomLineItem$3 {
|
|
|
6817
6863
|
media?: string;
|
|
6818
6864
|
/**
|
|
6819
6865
|
* Custom line item ID. If passed, `id` must be unique.
|
|
6820
|
-
*
|
|
6866
|
+
*
|
|
6867
|
+
* Default: auto-generated ID
|
|
6821
6868
|
*/
|
|
6822
6869
|
_id?: string | null;
|
|
6823
6870
|
/** Tax group ID for this custom line item. */
|
|
6824
6871
|
taxGroupId?: string | null;
|
|
6825
6872
|
/** Name of the item or product. */
|
|
6826
6873
|
productName?: ProductName$4;
|
|
6827
|
-
/**
|
|
6828
|
-
* 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.
|
|
6829
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
6830
|
-
*/
|
|
6874
|
+
/** 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. */
|
|
6831
6875
|
url?: string;
|
|
6832
6876
|
/** Item type. Either a preset type or custom. */
|
|
6833
6877
|
itemType?: ItemType$5;
|
|
6834
|
-
/**
|
|
6878
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
6835
6879
|
fullPrice?: string | null;
|
|
6836
6880
|
/**
|
|
6837
|
-
*
|
|
6881
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
6838
6882
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
6839
6883
|
*/
|
|
6840
6884
|
quantityAvailable?: number | null;
|
|
6841
|
-
/**
|
|
6885
|
+
/** Physical properties of the item. */
|
|
6842
6886
|
physicalProperties?: PhysicalProperties$5;
|
|
6843
6887
|
/**
|
|
6844
|
-
*
|
|
6888
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
6889
|
+
*
|
|
6845
6890
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
6846
6891
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
6847
6892
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -6849,21 +6894,23 @@ interface CustomLineItem$3 {
|
|
|
6849
6894
|
*/
|
|
6850
6895
|
paymentOption?: PaymentOptionType$5;
|
|
6851
6896
|
/**
|
|
6852
|
-
*
|
|
6897
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
6853
6898
|
* Used, among other things, when checking for valid memberships.
|
|
6854
6899
|
*/
|
|
6855
6900
|
serviceProperties?: ServiceProperties$4;
|
|
6856
6901
|
/**
|
|
6857
|
-
*
|
|
6902
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
6903
|
+
*
|
|
6858
6904
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
6859
|
-
* +
|
|
6905
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
6860
6906
|
* + Used in membership validation.
|
|
6861
6907
|
*/
|
|
6862
6908
|
rootCatalogItemId?: string | null;
|
|
6863
6909
|
/**
|
|
6864
|
-
*
|
|
6910
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
6911
|
+
*
|
|
6865
6912
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
6866
|
-
*
|
|
6913
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
6867
6914
|
*/
|
|
6868
6915
|
depositAmount?: string | null;
|
|
6869
6916
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -6876,7 +6923,12 @@ interface UpdateCartResponse {
|
|
|
6876
6923
|
interface AddToCurrentCartRequest {
|
|
6877
6924
|
/** Catalog line items. */
|
|
6878
6925
|
lineItems?: LineItem$5[];
|
|
6879
|
-
/**
|
|
6926
|
+
/**
|
|
6927
|
+
* Custom line items.
|
|
6928
|
+
*
|
|
6929
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
6930
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
6931
|
+
*/
|
|
6880
6932
|
customLineItems?: CustomLineItem$3[];
|
|
6881
6933
|
}
|
|
6882
6934
|
interface AddToCartResponse {
|
|
@@ -6886,7 +6938,12 @@ interface AddToCartResponse {
|
|
|
6886
6938
|
interface AddToCurrentCartAndEstimateTotalsRequest {
|
|
6887
6939
|
/** Catalog line items. */
|
|
6888
6940
|
lineItems?: LineItem$5[];
|
|
6889
|
-
/**
|
|
6941
|
+
/**
|
|
6942
|
+
* Custom line items.
|
|
6943
|
+
*
|
|
6944
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
6945
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
6946
|
+
*/
|
|
6890
6947
|
customLineItems?: CustomLineItem$3[];
|
|
6891
6948
|
/** Selected shipping option. */
|
|
6892
6949
|
selectedShippingOption?: SelectedShippingOption$1;
|
|
@@ -7793,7 +7850,12 @@ interface CreateCartRequest {
|
|
|
7793
7850
|
merchantDiscounts?: MerchantDiscountInput$2[];
|
|
7794
7851
|
/** Catalog line items. */
|
|
7795
7852
|
lineItems?: LineItem$5[];
|
|
7796
|
-
/**
|
|
7853
|
+
/**
|
|
7854
|
+
* Custom line items.
|
|
7855
|
+
*
|
|
7856
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
7857
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
7858
|
+
*/
|
|
7797
7859
|
customLineItems?: CustomLineItem$3[];
|
|
7798
7860
|
}
|
|
7799
7861
|
interface CreateCartResponse {
|
|
@@ -7821,7 +7883,12 @@ interface AddToCartRequest {
|
|
|
7821
7883
|
_id: string;
|
|
7822
7884
|
/** Catalog line items. */
|
|
7823
7885
|
lineItems?: LineItem$5[];
|
|
7824
|
-
/**
|
|
7886
|
+
/**
|
|
7887
|
+
* Custom line items.
|
|
7888
|
+
*
|
|
7889
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
7890
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
7891
|
+
*/
|
|
7825
7892
|
customLineItems?: CustomLineItem$3[];
|
|
7826
7893
|
}
|
|
7827
7894
|
interface RemoveLineItemsRequest$1 {
|
|
@@ -8382,13 +8449,23 @@ interface UpdateCurrentCartOptions {
|
|
|
8382
8449
|
merchantDiscounts?: MerchantDiscountInput$2[];
|
|
8383
8450
|
/** Catalog line items. */
|
|
8384
8451
|
lineItems?: LineItem$5[];
|
|
8385
|
-
/**
|
|
8452
|
+
/**
|
|
8453
|
+
* Custom line items.
|
|
8454
|
+
*
|
|
8455
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
8456
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
8457
|
+
*/
|
|
8386
8458
|
customLineItems?: CustomLineItem$3[];
|
|
8387
8459
|
}
|
|
8388
8460
|
interface AddToCurrentCartOptions {
|
|
8389
8461
|
/** Catalog line items. */
|
|
8390
8462
|
lineItems?: LineItem$5[];
|
|
8391
|
-
/**
|
|
8463
|
+
/**
|
|
8464
|
+
* Custom line items.
|
|
8465
|
+
*
|
|
8466
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
8467
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
8468
|
+
*/
|
|
8392
8469
|
customLineItems?: CustomLineItem$3[];
|
|
8393
8470
|
}
|
|
8394
8471
|
interface CreateCheckoutFromCurrentCartOptions {
|
|
@@ -8937,11 +9014,23 @@ interface LineItem$4 {
|
|
|
8937
9014
|
* @readonly
|
|
8938
9015
|
*/
|
|
8939
9016
|
depositAmount?: MultiCurrencyPrice$2;
|
|
9017
|
+
/**
|
|
9018
|
+
* Whether the line item is custom or from catalog.
|
|
9019
|
+
* @readonly
|
|
9020
|
+
*/
|
|
9021
|
+
customLineItem?: boolean;
|
|
8940
9022
|
/**
|
|
8941
9023
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
8942
9024
|
* @readonly
|
|
8943
9025
|
*/
|
|
8944
9026
|
consentRequiredPaymentPolicy?: string | null;
|
|
9027
|
+
/**
|
|
9028
|
+
* Overriding values for catalog item properties.
|
|
9029
|
+
*
|
|
9030
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
9031
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
9032
|
+
*/
|
|
9033
|
+
catalogOverrideFields?: CatalogOverrideFields$1;
|
|
8945
9034
|
/**
|
|
8946
9035
|
* Whether to save the payment method on the order.
|
|
8947
9036
|
*
|
|
@@ -9269,17 +9358,17 @@ interface PriceDescription$3 {
|
|
|
9269
9358
|
translated?: string | null;
|
|
9270
9359
|
}
|
|
9271
9360
|
interface CatalogOverrideFields$1 {
|
|
9272
|
-
/** Item
|
|
9361
|
+
/** Item name. */
|
|
9273
9362
|
productName?: ProductName$3;
|
|
9274
9363
|
/** Item price **after** discounts. */
|
|
9275
9364
|
price?: string | null;
|
|
9276
|
-
/** Item price **before**
|
|
9365
|
+
/** Item price **before** discounts. */
|
|
9277
9366
|
fullPrice?: string | null;
|
|
9278
|
-
/**
|
|
9367
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
9279
9368
|
descriptionLines?: DescriptionLine$3[];
|
|
9280
|
-
/** Physical properties of the item.
|
|
9369
|
+
/** Physical properties of the item. */
|
|
9281
9370
|
physicalProperties?: PhysicalProperties$4;
|
|
9282
|
-
/**
|
|
9371
|
+
/** Item image. */
|
|
9283
9372
|
image?: string;
|
|
9284
9373
|
}
|
|
9285
9374
|
/** Billing Info and shipping details */
|
|
@@ -10102,9 +10191,14 @@ interface CreateCheckoutRequest {
|
|
|
10102
10191
|
checkoutInfo?: Checkout$1;
|
|
10103
10192
|
/** 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). */
|
|
10104
10193
|
couponCode?: string | null;
|
|
10105
|
-
/** Line items to
|
|
10194
|
+
/** Line items to add to the checkout. */
|
|
10106
10195
|
lineItems?: LineItem$4[];
|
|
10107
|
-
/**
|
|
10196
|
+
/**
|
|
10197
|
+
* Custom line items to add to the checkout.
|
|
10198
|
+
*
|
|
10199
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
10200
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
10201
|
+
*/
|
|
10108
10202
|
customLineItems?: CustomLineItem$2[];
|
|
10109
10203
|
/**
|
|
10110
10204
|
* **Required**
|
|
@@ -10148,31 +10242,30 @@ interface CustomLineItem$2 {
|
|
|
10148
10242
|
media?: string;
|
|
10149
10243
|
/**
|
|
10150
10244
|
* Custom line item ID. If passed, `id` must be unique.
|
|
10151
|
-
*
|
|
10245
|
+
*
|
|
10246
|
+
* Default: auto-generated ID
|
|
10152
10247
|
*/
|
|
10153
10248
|
_id?: string | null;
|
|
10154
10249
|
/** Tax group ID for this custom line item. */
|
|
10155
10250
|
taxGroupId?: string | null;
|
|
10156
10251
|
/** Name of the item or product. */
|
|
10157
10252
|
productName?: ProductName$3;
|
|
10158
|
-
/**
|
|
10159
|
-
* 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.
|
|
10160
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
10161
|
-
*/
|
|
10253
|
+
/** 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. */
|
|
10162
10254
|
url?: string;
|
|
10163
10255
|
/** Item type. Either a preset type or custom. */
|
|
10164
10256
|
itemType?: ItemType$4;
|
|
10165
|
-
/**
|
|
10257
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
10166
10258
|
fullPrice?: string | null;
|
|
10167
10259
|
/**
|
|
10168
|
-
*
|
|
10260
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
10169
10261
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
10170
10262
|
*/
|
|
10171
10263
|
quantityAvailable?: number | null;
|
|
10172
|
-
/**
|
|
10264
|
+
/** Physical properties of the item. */
|
|
10173
10265
|
physicalProperties?: PhysicalProperties$4;
|
|
10174
10266
|
/**
|
|
10175
|
-
*
|
|
10267
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
10268
|
+
*
|
|
10176
10269
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
10177
10270
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
10178
10271
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -10180,21 +10273,23 @@ interface CustomLineItem$2 {
|
|
|
10180
10273
|
*/
|
|
10181
10274
|
paymentOption?: PaymentOptionType$4;
|
|
10182
10275
|
/**
|
|
10183
|
-
*
|
|
10276
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
10184
10277
|
* Used, among other things, when checking for valid memberships.
|
|
10185
10278
|
*/
|
|
10186
10279
|
serviceProperties?: ServiceProperties$3;
|
|
10187
10280
|
/**
|
|
10188
|
-
*
|
|
10281
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
10282
|
+
*
|
|
10189
10283
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
10190
|
-
* +
|
|
10284
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
10191
10285
|
* + Used in membership validation.
|
|
10192
10286
|
*/
|
|
10193
10287
|
rootCatalogItemId?: string | null;
|
|
10194
10288
|
/**
|
|
10195
|
-
*
|
|
10289
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
10290
|
+
*
|
|
10196
10291
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
10197
|
-
*
|
|
10292
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
10198
10293
|
*/
|
|
10199
10294
|
depositAmount?: string | null;
|
|
10200
10295
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -10272,7 +10367,14 @@ interface UpdateCheckoutRequest {
|
|
|
10272
10367
|
* 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`.
|
|
10273
10368
|
*/
|
|
10274
10369
|
overrideCheckoutUrl?: string | null;
|
|
10275
|
-
/**
|
|
10370
|
+
/** Line items. */
|
|
10371
|
+
lineItems?: LineItem$4[];
|
|
10372
|
+
/**
|
|
10373
|
+
* Custom line items.
|
|
10374
|
+
*
|
|
10375
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
10376
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
10377
|
+
*/
|
|
10276
10378
|
customLineItems?: CustomLineItem$2[];
|
|
10277
10379
|
}
|
|
10278
10380
|
interface UpdateCheckoutResponse {
|
|
@@ -10308,7 +10410,12 @@ interface AddToCheckoutRequest {
|
|
|
10308
10410
|
_id: string;
|
|
10309
10411
|
/** Catalog line items. */
|
|
10310
10412
|
lineItems?: LineItem$4[];
|
|
10311
|
-
/**
|
|
10413
|
+
/**
|
|
10414
|
+
* Custom line items.
|
|
10415
|
+
*
|
|
10416
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
10417
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
10418
|
+
*/
|
|
10312
10419
|
customLineItems?: CustomLineItem$2[];
|
|
10313
10420
|
}
|
|
10314
10421
|
interface AddToCheckoutResponse {
|
|
@@ -11447,9 +11554,14 @@ interface CreateCheckoutOptions {
|
|
|
11447
11554
|
checkoutInfo?: Checkout$1;
|
|
11448
11555
|
/** 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). */
|
|
11449
11556
|
couponCode?: string | null;
|
|
11450
|
-
/** Line items to
|
|
11557
|
+
/** Line items to add to the checkout. */
|
|
11451
11558
|
lineItems?: LineItem$4[];
|
|
11452
|
-
/**
|
|
11559
|
+
/**
|
|
11560
|
+
* Custom line items to add to the checkout.
|
|
11561
|
+
*
|
|
11562
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
11563
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
11564
|
+
*/
|
|
11453
11565
|
customLineItems?: CustomLineItem$2[];
|
|
11454
11566
|
/**
|
|
11455
11567
|
* **Required**
|
|
@@ -11649,13 +11761,25 @@ interface UpdateCheckoutOptions {
|
|
|
11649
11761
|
* 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`.
|
|
11650
11762
|
*/
|
|
11651
11763
|
overrideCheckoutUrl?: string | null;
|
|
11652
|
-
/**
|
|
11764
|
+
/** Line items. */
|
|
11765
|
+
lineItems?: LineItem$4[];
|
|
11766
|
+
/**
|
|
11767
|
+
* Custom line items.
|
|
11768
|
+
*
|
|
11769
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
11770
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
11771
|
+
*/
|
|
11653
11772
|
customLineItems?: CustomLineItem$2[];
|
|
11654
11773
|
}
|
|
11655
11774
|
interface AddToCheckoutOptions {
|
|
11656
11775
|
/** Catalog line items. */
|
|
11657
11776
|
lineItems?: LineItem$4[];
|
|
11658
|
-
/**
|
|
11777
|
+
/**
|
|
11778
|
+
* Custom line items.
|
|
11779
|
+
*
|
|
11780
|
+
* To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
11781
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
11782
|
+
*/
|
|
11659
11783
|
customLineItems?: CustomLineItem$2[];
|
|
11660
11784
|
}
|
|
11661
11785
|
|
|
@@ -12559,6 +12683,13 @@ interface V1LineItem {
|
|
|
12559
12683
|
* > **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).
|
|
12560
12684
|
*/
|
|
12561
12685
|
catalogReference?: CatalogReference$3;
|
|
12686
|
+
/**
|
|
12687
|
+
* Overriding values for catalog item properties.
|
|
12688
|
+
*
|
|
12689
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
12690
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
12691
|
+
*/
|
|
12692
|
+
catalogOverrideFields?: CatalogOverrideFields;
|
|
12562
12693
|
}
|
|
12563
12694
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
12564
12695
|
interface CatalogReference$3 {
|
|
@@ -12583,17 +12714,17 @@ interface CatalogReference$3 {
|
|
|
12583
12714
|
options?: Record<string, any> | null;
|
|
12584
12715
|
}
|
|
12585
12716
|
interface CatalogOverrideFields {
|
|
12586
|
-
/** Item
|
|
12717
|
+
/** Item name. */
|
|
12587
12718
|
productName?: ProductName$2;
|
|
12588
12719
|
/** Item price **after** discounts. */
|
|
12589
12720
|
price?: string | null;
|
|
12590
|
-
/** Item price **before**
|
|
12721
|
+
/** Item price **before** discounts. */
|
|
12591
12722
|
fullPrice?: string | null;
|
|
12592
|
-
/**
|
|
12723
|
+
/** Item description lines. Used when displaying the line item to customers. */
|
|
12593
12724
|
descriptionLines?: DescriptionLine$2[];
|
|
12594
|
-
/** Physical properties of the item.
|
|
12725
|
+
/** Physical properties of the item. */
|
|
12595
12726
|
physicalProperties?: PhysicalProperties$3;
|
|
12596
|
-
/**
|
|
12727
|
+
/** Item image. */
|
|
12597
12728
|
image?: string;
|
|
12598
12729
|
}
|
|
12599
12730
|
interface ProductName$2 {
|
|
@@ -12698,31 +12829,30 @@ interface CustomLineItem$1 {
|
|
|
12698
12829
|
media?: string;
|
|
12699
12830
|
/**
|
|
12700
12831
|
* Custom line item ID. If passed, `id` must be unique.
|
|
12701
|
-
*
|
|
12832
|
+
*
|
|
12833
|
+
* Default: auto-generated ID
|
|
12702
12834
|
*/
|
|
12703
12835
|
_id?: string | null;
|
|
12704
12836
|
/** Tax group ID for this custom line item. */
|
|
12705
12837
|
taxGroupId?: string | null;
|
|
12706
12838
|
/** Name of the item or product. */
|
|
12707
12839
|
productName?: ProductName$2;
|
|
12708
|
-
/**
|
|
12709
|
-
* 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.
|
|
12710
|
-
* The URL is optional and if not provided, the site URL will be used.
|
|
12711
|
-
*/
|
|
12840
|
+
/** 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. */
|
|
12712
12841
|
url?: string;
|
|
12713
12842
|
/** Item type. Either a preset type or custom. */
|
|
12714
12843
|
itemType?: ItemType$3;
|
|
12715
|
-
/**
|
|
12844
|
+
/** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
12716
12845
|
fullPrice?: string | null;
|
|
12717
12846
|
/**
|
|
12718
|
-
*
|
|
12847
|
+
* Item quantity available for purchase. Only return this if inventory is managed.
|
|
12719
12848
|
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
12720
12849
|
*/
|
|
12721
12850
|
quantityAvailable?: number | null;
|
|
12722
|
-
/**
|
|
12851
|
+
/** Physical properties of the item. */
|
|
12723
12852
|
physicalProperties?: PhysicalProperties$3;
|
|
12724
12853
|
/**
|
|
12725
|
-
*
|
|
12854
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
12855
|
+
*
|
|
12726
12856
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
12727
12857
|
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
12728
12858
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
@@ -12730,21 +12860,23 @@ interface CustomLineItem$1 {
|
|
|
12730
12860
|
*/
|
|
12731
12861
|
paymentOption?: PaymentOptionType$3;
|
|
12732
12862
|
/**
|
|
12733
|
-
*
|
|
12863
|
+
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
12734
12864
|
* Used, among other things, when checking for valid memberships.
|
|
12735
12865
|
*/
|
|
12736
12866
|
serviceProperties?: ServiceProperties$2;
|
|
12737
12867
|
/**
|
|
12738
|
-
*
|
|
12868
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
12869
|
+
*
|
|
12739
12870
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
12740
|
-
* +
|
|
12871
|
+
* + In most cases, this field is the same as `catalogReference.catalogItemId`.
|
|
12741
12872
|
* + Used in membership validation.
|
|
12742
12873
|
*/
|
|
12743
12874
|
rootCatalogItemId?: string | null;
|
|
12744
12875
|
/**
|
|
12745
|
-
*
|
|
12876
|
+
* Partial payment for the given item to be paid upfront during the checkout.
|
|
12877
|
+
*
|
|
12746
12878
|
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
12747
|
-
*
|
|
12879
|
+
* When omitted, the item's price will not be split and is expected to be paid in a single installment.
|
|
12748
12880
|
*/
|
|
12749
12881
|
depositAmount?: string | null;
|
|
12750
12882
|
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
@@ -13307,11 +13439,23 @@ interface LineItem$3 {
|
|
|
13307
13439
|
* @readonly
|
|
13308
13440
|
*/
|
|
13309
13441
|
depositAmount?: MultiCurrencyPrice$1;
|
|
13442
|
+
/**
|
|
13443
|
+
* Whether the line item is custom or from catalog.
|
|
13444
|
+
* @readonly
|
|
13445
|
+
*/
|
|
13446
|
+
customLineItem?: boolean;
|
|
13310
13447
|
/**
|
|
13311
13448
|
* Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
|
|
13312
13449
|
* @readonly
|
|
13313
13450
|
*/
|
|
13314
13451
|
consentRequiredPaymentPolicy?: string | null;
|
|
13452
|
+
/**
|
|
13453
|
+
* Overriding values for catalog item properties.
|
|
13454
|
+
*
|
|
13455
|
+
* To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
|
|
13456
|
+
* Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
13457
|
+
*/
|
|
13458
|
+
catalogOverrideFields?: CatalogOverrideFields;
|
|
13315
13459
|
/**
|
|
13316
13460
|
* Whether to save the payment method on the order.
|
|
13317
13461
|
*
|