@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.
@@ -3783,6 +3783,13 @@ interface LineItem$6 {
3783
3783
  * @readonly
3784
3784
  */
3785
3785
  consentRequiredPaymentPolicy?: string | null;
3786
+ /**
3787
+ * Overriding values for catalog item properties.
3788
+ *
3789
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3790
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3791
+ */
3792
+ catalogOverrideFields?: CatalogOverrideFields$3;
3786
3793
  /**
3787
3794
  * Whether to save the payment method on the order.
3788
3795
  *
@@ -4038,17 +4045,17 @@ interface SelectedMembership$4 {
4038
4045
  appId?: string;
4039
4046
  }
4040
4047
  interface CatalogOverrideFields$3 {
4041
- /** Item product name */
4048
+ /** Item name. */
4042
4049
  productName?: ProductName$5;
4043
4050
  /** Item price **after** discounts. */
4044
4051
  price?: string | null;
4045
- /** Item price **before** discount. */
4052
+ /** Item price **before** discounts. */
4046
4053
  fullPrice?: string | null;
4047
- /** Line item description lines. Used for displaying the cart, checkout and order. */
4054
+ /** Item description lines. Used when displaying the line item to customers. */
4048
4055
  descriptionLines?: DescriptionLine$5[];
4049
- /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
4056
+ /** Physical properties of the item. */
4050
4057
  physicalProperties?: PhysicalProperties$6;
4051
- /** Line item image details. */
4058
+ /** Item image. */
4052
4059
  image?: string;
4053
4060
  }
4054
4061
  /** Buyer Info */
@@ -4223,7 +4230,12 @@ interface UpdateCartRequest$1 {
4223
4230
  merchantDiscounts?: MerchantDiscountInput$3[];
4224
4231
  /** Catalog line items. */
4225
4232
  lineItems?: LineItem$6[];
4226
- /** Custom line items. */
4233
+ /**
4234
+ * Custom line items.
4235
+ *
4236
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
4237
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4238
+ */
4227
4239
  customLineItems?: CustomLineItem$4[];
4228
4240
  }
4229
4241
  interface MerchantDiscountInput$3 {
@@ -4258,31 +4270,30 @@ interface CustomLineItem$4 {
4258
4270
  media?: string;
4259
4271
  /**
4260
4272
  * Custom line item ID. If passed, `id` must be unique.
4261
- * Default: auto-generated ID.
4273
+ *
4274
+ * Default: auto-generated ID
4262
4275
  */
4263
4276
  _id?: string | null;
4264
4277
  /** Tax group ID for this custom line item. */
4265
4278
  taxGroupId?: string | null;
4266
4279
  /** Name of the item or product. */
4267
4280
  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
- */
4281
+ /** 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
4282
  url?: string;
4273
4283
  /** Item type. Either a preset type or custom. */
4274
4284
  itemType?: ItemType$6;
4275
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
4285
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
4276
4286
  fullPrice?: string | null;
4277
4287
  /**
4278
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
4288
+ * Item quantity available for purchase. Only return this if inventory is managed.
4279
4289
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
4280
4290
  */
4281
4291
  quantityAvailable?: number | null;
4282
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
4292
+ /** Physical properties of the item. */
4283
4293
  physicalProperties?: PhysicalProperties$6;
4284
4294
  /**
4285
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
4295
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
4296
+ *
4286
4297
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
4287
4298
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
4288
4299
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -4290,21 +4301,23 @@ interface CustomLineItem$4 {
4290
4301
  */
4291
4302
  paymentOption?: PaymentOptionType$6;
4292
4303
  /**
4293
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
4304
+ * Service properties. When relevant, this contains information such as date and number of participants.
4294
4305
  * Used, among other things, when checking for valid memberships.
4295
4306
  */
4296
4307
  serviceProperties?: ServiceProperties$5;
4297
4308
  /**
4298
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
4309
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
4310
+ *
4299
4311
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
4300
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
4312
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
4301
4313
  * + Used in membership validation.
4302
4314
  */
4303
4315
  rootCatalogItemId?: string | null;
4304
4316
  /**
4305
- * Optional - partial payment for the given item to be paid upfront during the checkout.
4317
+ * Partial payment for the given item to be paid upfront during the checkout.
4318
+ *
4306
4319
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
4307
- * If omitted - item's price will not be split and is expected to be paid in single installment
4320
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
4308
4321
  */
4309
4322
  depositAmount?: string | null;
4310
4323
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -4317,7 +4330,12 @@ interface UpdateCartResponse$1 {
4317
4330
  interface AddToCurrentCartRequest$1 {
4318
4331
  /** Catalog line items. */
4319
4332
  lineItems?: LineItem$6[];
4320
- /** Custom line items. */
4333
+ /**
4334
+ * Custom line items.
4335
+ *
4336
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
4337
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4338
+ */
4321
4339
  customLineItems?: CustomLineItem$4[];
4322
4340
  }
4323
4341
  interface AddToCartResponse$1 {
@@ -4327,7 +4345,12 @@ interface AddToCartResponse$1 {
4327
4345
  interface AddToCurrentCartAndEstimateTotalsRequest$1 {
4328
4346
  /** Catalog line items. */
4329
4347
  lineItems?: LineItem$6[];
4330
- /** Custom line items. */
4348
+ /**
4349
+ * Custom line items.
4350
+ *
4351
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
4352
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4353
+ */
4331
4354
  customLineItems?: CustomLineItem$4[];
4332
4355
  /** Selected shipping option. */
4333
4356
  selectedShippingOption?: SelectedShippingOption$2;
@@ -5234,7 +5257,12 @@ interface CreateCartRequest$1 {
5234
5257
  merchantDiscounts?: MerchantDiscountInput$3[];
5235
5258
  /** Catalog line items. */
5236
5259
  lineItems?: LineItem$6[];
5237
- /** Custom line items. */
5260
+ /**
5261
+ * Custom line items.
5262
+ *
5263
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
5264
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
5265
+ */
5238
5266
  customLineItems?: CustomLineItem$4[];
5239
5267
  }
5240
5268
  interface CreateCartResponse$1 {
@@ -5262,7 +5290,12 @@ interface AddToCartRequest$1 {
5262
5290
  _id: string;
5263
5291
  /** Catalog line items. */
5264
5292
  lineItems?: LineItem$6[];
5265
- /** Custom line items. */
5293
+ /**
5294
+ * Custom line items.
5295
+ *
5296
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
5297
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
5298
+ */
5266
5299
  customLineItems?: CustomLineItem$4[];
5267
5300
  }
5268
5301
  interface RemoveLineItemsRequest$2 {
@@ -5823,7 +5856,12 @@ interface CreateCartOptions {
5823
5856
  merchantDiscounts?: MerchantDiscountInput$3[];
5824
5857
  /** Catalog line items. */
5825
5858
  lineItems?: LineItem$6[];
5826
- /** Custom line items. */
5859
+ /**
5860
+ * Custom line items.
5861
+ *
5862
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
5863
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
5864
+ */
5827
5865
  customLineItems?: CustomLineItem$4[];
5828
5866
  }
5829
5867
  interface UpdateCartOptions {
@@ -5914,13 +5952,23 @@ interface UpdateCartOptions {
5914
5952
  merchantDiscounts?: MerchantDiscountInput$3[];
5915
5953
  /** Catalog line items. */
5916
5954
  lineItems?: LineItem$6[];
5917
- /** Custom line items. */
5955
+ /**
5956
+ * Custom line items.
5957
+ *
5958
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
5959
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
5960
+ */
5918
5961
  customLineItems?: CustomLineItem$4[];
5919
5962
  }
5920
5963
  interface AddToCartOptions {
5921
5964
  /** Catalog line items. */
5922
5965
  lineItems?: LineItem$6[];
5923
- /** Custom line items. */
5966
+ /**
5967
+ * Custom line items.
5968
+ *
5969
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
5970
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
5971
+ */
5924
5972
  customLineItems?: CustomLineItem$4[];
5925
5973
  }
5926
5974
  interface CreateCheckoutOptions$1 {
@@ -6342,6 +6390,13 @@ interface LineItem$5 {
6342
6390
  * @readonly
6343
6391
  */
6344
6392
  consentRequiredPaymentPolicy?: string | null;
6393
+ /**
6394
+ * Overriding values for catalog item properties.
6395
+ *
6396
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
6397
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
6398
+ */
6399
+ catalogOverrideFields?: CatalogOverrideFields$2;
6345
6400
  /**
6346
6401
  * Whether to save the payment method on the order.
6347
6402
  *
@@ -6597,17 +6652,17 @@ interface SelectedMembership$3 {
6597
6652
  appId?: string;
6598
6653
  }
6599
6654
  interface CatalogOverrideFields$2 {
6600
- /** Item product name */
6655
+ /** Item name. */
6601
6656
  productName?: ProductName$4;
6602
6657
  /** Item price **after** discounts. */
6603
6658
  price?: string | null;
6604
- /** Item price **before** discount. */
6659
+ /** Item price **before** discounts. */
6605
6660
  fullPrice?: string | null;
6606
- /** Line item description lines. Used for displaying the cart, checkout and order. */
6661
+ /** Item description lines. Used when displaying the line item to customers. */
6607
6662
  descriptionLines?: DescriptionLine$4[];
6608
- /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
6663
+ /** Physical properties of the item. */
6609
6664
  physicalProperties?: PhysicalProperties$5;
6610
- /** Line item image details. */
6665
+ /** Item image. */
6611
6666
  image?: string;
6612
6667
  }
6613
6668
  /** Buyer Info */
@@ -6782,7 +6837,12 @@ interface UpdateCartRequest {
6782
6837
  merchantDiscounts?: MerchantDiscountInput$2[];
6783
6838
  /** Catalog line items. */
6784
6839
  lineItems?: LineItem$5[];
6785
- /** Custom line items. */
6840
+ /**
6841
+ * Custom line items.
6842
+ *
6843
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
6844
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
6845
+ */
6786
6846
  customLineItems?: CustomLineItem$3[];
6787
6847
  }
6788
6848
  interface MerchantDiscountInput$2 {
@@ -6817,31 +6877,30 @@ interface CustomLineItem$3 {
6817
6877
  media?: string;
6818
6878
  /**
6819
6879
  * Custom line item ID. If passed, `id` must be unique.
6820
- * Default: auto-generated ID.
6880
+ *
6881
+ * Default: auto-generated ID
6821
6882
  */
6822
6883
  _id?: string | null;
6823
6884
  /** Tax group ID for this custom line item. */
6824
6885
  taxGroupId?: string | null;
6825
6886
  /** Name of the item or product. */
6826
6887
  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
- */
6888
+ /** 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
6889
  url?: string;
6832
6890
  /** Item type. Either a preset type or custom. */
6833
6891
  itemType?: ItemType$5;
6834
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
6892
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
6835
6893
  fullPrice?: string | null;
6836
6894
  /**
6837
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
6895
+ * Item quantity available for purchase. Only return this if inventory is managed.
6838
6896
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
6839
6897
  */
6840
6898
  quantityAvailable?: number | null;
6841
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
6899
+ /** Physical properties of the item. */
6842
6900
  physicalProperties?: PhysicalProperties$5;
6843
6901
  /**
6844
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
6902
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
6903
+ *
6845
6904
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
6846
6905
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
6847
6906
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -6849,21 +6908,23 @@ interface CustomLineItem$3 {
6849
6908
  */
6850
6909
  paymentOption?: PaymentOptionType$5;
6851
6910
  /**
6852
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
6911
+ * Service properties. When relevant, this contains information such as date and number of participants.
6853
6912
  * Used, among other things, when checking for valid memberships.
6854
6913
  */
6855
6914
  serviceProperties?: ServiceProperties$4;
6856
6915
  /**
6857
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
6916
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
6917
+ *
6858
6918
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
6859
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
6919
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
6860
6920
  * + Used in membership validation.
6861
6921
  */
6862
6922
  rootCatalogItemId?: string | null;
6863
6923
  /**
6864
- * Optional - partial payment for the given item to be paid upfront during the checkout.
6924
+ * Partial payment for the given item to be paid upfront during the checkout.
6925
+ *
6865
6926
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
6866
- * If omitted - item's price will not be split and is expected to be paid in single installment
6927
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
6867
6928
  */
6868
6929
  depositAmount?: string | null;
6869
6930
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -6876,7 +6937,12 @@ interface UpdateCartResponse {
6876
6937
  interface AddToCurrentCartRequest {
6877
6938
  /** Catalog line items. */
6878
6939
  lineItems?: LineItem$5[];
6879
- /** Custom line items. */
6940
+ /**
6941
+ * Custom line items.
6942
+ *
6943
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
6944
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
6945
+ */
6880
6946
  customLineItems?: CustomLineItem$3[];
6881
6947
  }
6882
6948
  interface AddToCartResponse {
@@ -6886,7 +6952,12 @@ interface AddToCartResponse {
6886
6952
  interface AddToCurrentCartAndEstimateTotalsRequest {
6887
6953
  /** Catalog line items. */
6888
6954
  lineItems?: LineItem$5[];
6889
- /** Custom line items. */
6955
+ /**
6956
+ * Custom line items.
6957
+ *
6958
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
6959
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
6960
+ */
6890
6961
  customLineItems?: CustomLineItem$3[];
6891
6962
  /** Selected shipping option. */
6892
6963
  selectedShippingOption?: SelectedShippingOption$1;
@@ -7793,7 +7864,12 @@ interface CreateCartRequest {
7793
7864
  merchantDiscounts?: MerchantDiscountInput$2[];
7794
7865
  /** Catalog line items. */
7795
7866
  lineItems?: LineItem$5[];
7796
- /** Custom line items. */
7867
+ /**
7868
+ * Custom line items.
7869
+ *
7870
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
7871
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
7872
+ */
7797
7873
  customLineItems?: CustomLineItem$3[];
7798
7874
  }
7799
7875
  interface CreateCartResponse {
@@ -7821,7 +7897,12 @@ interface AddToCartRequest {
7821
7897
  _id: string;
7822
7898
  /** Catalog line items. */
7823
7899
  lineItems?: LineItem$5[];
7824
- /** Custom line items. */
7900
+ /**
7901
+ * Custom line items.
7902
+ *
7903
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
7904
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
7905
+ */
7825
7906
  customLineItems?: CustomLineItem$3[];
7826
7907
  }
7827
7908
  interface RemoveLineItemsRequest$1 {
@@ -8382,13 +8463,23 @@ interface UpdateCurrentCartOptions {
8382
8463
  merchantDiscounts?: MerchantDiscountInput$2[];
8383
8464
  /** Catalog line items. */
8384
8465
  lineItems?: LineItem$5[];
8385
- /** Custom line items. */
8466
+ /**
8467
+ * Custom line items.
8468
+ *
8469
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
8470
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
8471
+ */
8386
8472
  customLineItems?: CustomLineItem$3[];
8387
8473
  }
8388
8474
  interface AddToCurrentCartOptions {
8389
8475
  /** Catalog line items. */
8390
8476
  lineItems?: LineItem$5[];
8391
- /** Custom line items. */
8477
+ /**
8478
+ * Custom line items.
8479
+ *
8480
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
8481
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
8482
+ */
8392
8483
  customLineItems?: CustomLineItem$3[];
8393
8484
  }
8394
8485
  interface CreateCheckoutFromCurrentCartOptions {
@@ -8937,11 +9028,23 @@ interface LineItem$4 {
8937
9028
  * @readonly
8938
9029
  */
8939
9030
  depositAmount?: MultiCurrencyPrice$2;
9031
+ /**
9032
+ * Whether the line item is custom or from catalog.
9033
+ * @readonly
9034
+ */
9035
+ customLineItem?: boolean;
8940
9036
  /**
8941
9037
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
8942
9038
  * @readonly
8943
9039
  */
8944
9040
  consentRequiredPaymentPolicy?: string | null;
9041
+ /**
9042
+ * Overriding values for catalog item properties.
9043
+ *
9044
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
9045
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
9046
+ */
9047
+ catalogOverrideFields?: CatalogOverrideFields$1;
8945
9048
  /**
8946
9049
  * Whether to save the payment method on the order.
8947
9050
  *
@@ -9269,17 +9372,17 @@ interface PriceDescription$3 {
9269
9372
  translated?: string | null;
9270
9373
  }
9271
9374
  interface CatalogOverrideFields$1 {
9272
- /** Item product name */
9375
+ /** Item name. */
9273
9376
  productName?: ProductName$3;
9274
9377
  /** Item price **after** discounts. */
9275
9378
  price?: string | null;
9276
- /** Item price **before** discount. */
9379
+ /** Item price **before** discounts. */
9277
9380
  fullPrice?: string | null;
9278
- /** Line item description lines. Used for displaying the cart, checkout and order. */
9381
+ /** Item description lines. Used when displaying the line item to customers. */
9279
9382
  descriptionLines?: DescriptionLine$3[];
9280
- /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
9383
+ /** Physical properties of the item. */
9281
9384
  physicalProperties?: PhysicalProperties$4;
9282
- /** Line item image details. */
9385
+ /** Item image. */
9283
9386
  image?: string;
9284
9387
  }
9285
9388
  /** Billing Info and shipping details */
@@ -10102,9 +10205,14 @@ interface CreateCheckoutRequest {
10102
10205
  checkoutInfo?: Checkout$1;
10103
10206
  /** 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
10207
  couponCode?: string | null;
10105
- /** Line items to be added to checkout. */
10208
+ /** Line items to add to the checkout. */
10106
10209
  lineItems?: LineItem$4[];
10107
- /** Custom line items to be added to checkout. */
10210
+ /**
10211
+ * Custom line items to add to the checkout.
10212
+ *
10213
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
10214
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
10215
+ */
10108
10216
  customLineItems?: CustomLineItem$2[];
10109
10217
  /**
10110
10218
  * **Required**
@@ -10148,31 +10256,30 @@ interface CustomLineItem$2 {
10148
10256
  media?: string;
10149
10257
  /**
10150
10258
  * Custom line item ID. If passed, `id` must be unique.
10151
- * Default: auto-generated ID.
10259
+ *
10260
+ * Default: auto-generated ID
10152
10261
  */
10153
10262
  _id?: string | null;
10154
10263
  /** Tax group ID for this custom line item. */
10155
10264
  taxGroupId?: string | null;
10156
10265
  /** Name of the item or product. */
10157
10266
  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
- */
10267
+ /** 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
10268
  url?: string;
10163
10269
  /** Item type. Either a preset type or custom. */
10164
10270
  itemType?: ItemType$4;
10165
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
10271
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
10166
10272
  fullPrice?: string | null;
10167
10273
  /**
10168
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
10274
+ * Item quantity available for purchase. Only return this if inventory is managed.
10169
10275
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
10170
10276
  */
10171
10277
  quantityAvailable?: number | null;
10172
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
10278
+ /** Physical properties of the item. */
10173
10279
  physicalProperties?: PhysicalProperties$4;
10174
10280
  /**
10175
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
10281
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
10282
+ *
10176
10283
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
10177
10284
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
10178
10285
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -10180,21 +10287,23 @@ interface CustomLineItem$2 {
10180
10287
  */
10181
10288
  paymentOption?: PaymentOptionType$4;
10182
10289
  /**
10183
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
10290
+ * Service properties. When relevant, this contains information such as date and number of participants.
10184
10291
  * Used, among other things, when checking for valid memberships.
10185
10292
  */
10186
10293
  serviceProperties?: ServiceProperties$3;
10187
10294
  /**
10188
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
10295
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
10296
+ *
10189
10297
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
10190
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
10298
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
10191
10299
  * + Used in membership validation.
10192
10300
  */
10193
10301
  rootCatalogItemId?: string | null;
10194
10302
  /**
10195
- * Optional - partial payment for the given item to be paid upfront during the checkout.
10303
+ * Partial payment for the given item to be paid upfront during the checkout.
10304
+ *
10196
10305
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
10197
- * If omitted - item's price will not be split and is expected to be paid in single installment
10306
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
10198
10307
  */
10199
10308
  depositAmount?: string | null;
10200
10309
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -10272,7 +10381,14 @@ interface UpdateCheckoutRequest {
10272
10381
  * 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
10382
  */
10274
10383
  overrideCheckoutUrl?: string | null;
10275
- /** Custom line items to be saved on checkout. */
10384
+ /** Line items. */
10385
+ lineItems?: LineItem$4[];
10386
+ /**
10387
+ * Custom line items.
10388
+ *
10389
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
10390
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
10391
+ */
10276
10392
  customLineItems?: CustomLineItem$2[];
10277
10393
  }
10278
10394
  interface UpdateCheckoutResponse {
@@ -10308,7 +10424,12 @@ interface AddToCheckoutRequest {
10308
10424
  _id: string;
10309
10425
  /** Catalog line items. */
10310
10426
  lineItems?: LineItem$4[];
10311
- /** Custom line items. */
10427
+ /**
10428
+ * Custom line items.
10429
+ *
10430
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
10431
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
10432
+ */
10312
10433
  customLineItems?: CustomLineItem$2[];
10313
10434
  }
10314
10435
  interface AddToCheckoutResponse {
@@ -11447,9 +11568,14 @@ interface CreateCheckoutOptions {
11447
11568
  checkoutInfo?: Checkout$1;
11448
11569
  /** 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
11570
  couponCode?: string | null;
11450
- /** Line items to be added to checkout. */
11571
+ /** Line items to add to the checkout. */
11451
11572
  lineItems?: LineItem$4[];
11452
- /** Custom line items to be added to checkout. */
11573
+ /**
11574
+ * Custom line items to add to the checkout.
11575
+ *
11576
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
11577
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
11578
+ */
11453
11579
  customLineItems?: CustomLineItem$2[];
11454
11580
  /**
11455
11581
  * **Required**
@@ -11649,13 +11775,25 @@ interface UpdateCheckoutOptions {
11649
11775
  * 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
11776
  */
11651
11777
  overrideCheckoutUrl?: string | null;
11652
- /** Custom line items to be saved on checkout. */
11778
+ /** Line items. */
11779
+ lineItems?: LineItem$4[];
11780
+ /**
11781
+ * Custom line items.
11782
+ *
11783
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
11784
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
11785
+ */
11653
11786
  customLineItems?: CustomLineItem$2[];
11654
11787
  }
11655
11788
  interface AddToCheckoutOptions {
11656
11789
  /** Catalog line items. */
11657
11790
  lineItems?: LineItem$4[];
11658
- /** Custom line items. */
11791
+ /**
11792
+ * Custom line items.
11793
+ *
11794
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
11795
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
11796
+ */
11659
11797
  customLineItems?: CustomLineItem$2[];
11660
11798
  }
11661
11799
 
@@ -12559,6 +12697,13 @@ interface V1LineItem {
12559
12697
  * > **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
12698
  */
12561
12699
  catalogReference?: CatalogReference$3;
12700
+ /**
12701
+ * Overriding values for catalog item properties.
12702
+ *
12703
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
12704
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
12705
+ */
12706
+ catalogOverrideFields?: CatalogOverrideFields;
12562
12707
  }
12563
12708
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
12564
12709
  interface CatalogReference$3 {
@@ -12583,17 +12728,17 @@ interface CatalogReference$3 {
12583
12728
  options?: Record<string, any> | null;
12584
12729
  }
12585
12730
  interface CatalogOverrideFields {
12586
- /** Item product name */
12731
+ /** Item name. */
12587
12732
  productName?: ProductName$2;
12588
12733
  /** Item price **after** discounts. */
12589
12734
  price?: string | null;
12590
- /** Item price **before** discount. */
12735
+ /** Item price **before** discounts. */
12591
12736
  fullPrice?: string | null;
12592
- /** Line item description lines. Used for displaying the cart, checkout and order. */
12737
+ /** Item description lines. Used when displaying the line item to customers. */
12593
12738
  descriptionLines?: DescriptionLine$2[];
12594
- /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
12739
+ /** Physical properties of the item. */
12595
12740
  physicalProperties?: PhysicalProperties$3;
12596
- /** Line item image details. */
12741
+ /** Item image. */
12597
12742
  image?: string;
12598
12743
  }
12599
12744
  interface ProductName$2 {
@@ -12698,31 +12843,30 @@ interface CustomLineItem$1 {
12698
12843
  media?: string;
12699
12844
  /**
12700
12845
  * Custom line item ID. If passed, `id` must be unique.
12701
- * Default: auto-generated ID.
12846
+ *
12847
+ * Default: auto-generated ID
12702
12848
  */
12703
12849
  _id?: string | null;
12704
12850
  /** Tax group ID for this custom line item. */
12705
12851
  taxGroupId?: string | null;
12706
12852
  /** Name of the item or product. */
12707
12853
  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
- */
12854
+ /** 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
12855
  url?: string;
12713
12856
  /** Item type. Either a preset type or custom. */
12714
12857
  itemType?: ItemType$3;
12715
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
12858
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
12716
12859
  fullPrice?: string | null;
12717
12860
  /**
12718
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
12861
+ * Item quantity available for purchase. Only return this if inventory is managed.
12719
12862
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
12720
12863
  */
12721
12864
  quantityAvailable?: number | null;
12722
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
12865
+ /** Physical properties of the item. */
12723
12866
  physicalProperties?: PhysicalProperties$3;
12724
12867
  /**
12725
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
12868
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
12869
+ *
12726
12870
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
12727
12871
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
12728
12872
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -12730,21 +12874,23 @@ interface CustomLineItem$1 {
12730
12874
  */
12731
12875
  paymentOption?: PaymentOptionType$3;
12732
12876
  /**
12733
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
12877
+ * Service properties. When relevant, this contains information such as date and number of participants.
12734
12878
  * Used, among other things, when checking for valid memberships.
12735
12879
  */
12736
12880
  serviceProperties?: ServiceProperties$2;
12737
12881
  /**
12738
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
12882
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
12883
+ *
12739
12884
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
12740
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
12885
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
12741
12886
  * + Used in membership validation.
12742
12887
  */
12743
12888
  rootCatalogItemId?: string | null;
12744
12889
  /**
12745
- * Optional - partial payment for the given item to be paid upfront during the checkout.
12890
+ * Partial payment for the given item to be paid upfront during the checkout.
12891
+ *
12746
12892
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
12747
- * If omitted - item's price will not be split and is expected to be paid in single installment
12893
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
12748
12894
  */
12749
12895
  depositAmount?: string | null;
12750
12896
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -13307,11 +13453,23 @@ interface LineItem$3 {
13307
13453
  * @readonly
13308
13454
  */
13309
13455
  depositAmount?: MultiCurrencyPrice$1;
13456
+ /**
13457
+ * Whether the line item is custom or from catalog.
13458
+ * @readonly
13459
+ */
13460
+ customLineItem?: boolean;
13310
13461
  /**
13311
13462
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
13312
13463
  * @readonly
13313
13464
  */
13314
13465
  consentRequiredPaymentPolicy?: string | null;
13466
+ /**
13467
+ * Overriding values for catalog item properties.
13468
+ *
13469
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
13470
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
13471
+ */
13472
+ catalogOverrideFields?: CatalogOverrideFields;
13315
13473
  /**
13316
13474
  * Whether to save the payment method on the order.
13317
13475
  *