@wix/ecom 1.0.712 → 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.
@@ -3483,7 +3483,12 @@ interface UpdateCartRequest$3 {
3483
3483
  merchantDiscounts?: MerchantDiscountInput$5[];
3484
3484
  /** Catalog line items. */
3485
3485
  lineItems?: LineItem$7[];
3486
- /** Custom line items. */
3486
+ /**
3487
+ * Custom line items.
3488
+ *
3489
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3490
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3491
+ */
3487
3492
  customLineItems?: CustomLineItem$9[];
3488
3493
  }
3489
3494
  interface MerchantDiscountInput$5 {
@@ -3514,31 +3519,30 @@ interface CustomLineItem$9 {
3514
3519
  media?: Image$6;
3515
3520
  /**
3516
3521
  * Custom line item ID. If passed, `id` must be unique.
3517
- * Default: auto-generated ID.
3522
+ *
3523
+ * Default: auto-generated ID
3518
3524
  */
3519
3525
  id?: string | null;
3520
3526
  /** Tax group ID for this custom line item. */
3521
3527
  taxGroupId?: string | null;
3522
3528
  /** Name of the item or product. */
3523
3529
  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
- */
3530
+ /** 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
3531
  url?: PageUrlV2$4;
3529
3532
  /** Item type. Either a preset type or custom. */
3530
3533
  itemType?: ItemType$d;
3531
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
3534
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
3532
3535
  fullPrice?: string | null;
3533
3536
  /**
3534
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
3537
+ * Item quantity available for purchase. Only return this if inventory is managed.
3535
3538
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
3536
3539
  */
3537
3540
  quantityAvailable?: number | null;
3538
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
3541
+ /** Physical properties of the item. */
3539
3542
  physicalProperties?: PhysicalProperties$d;
3540
3543
  /**
3541
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
3544
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
3545
+ *
3542
3546
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
3543
3547
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
3544
3548
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -3546,21 +3550,23 @@ interface CustomLineItem$9 {
3546
3550
  */
3547
3551
  paymentOption?: PaymentOptionType$d;
3548
3552
  /**
3549
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
3553
+ * Service properties. When relevant, this contains information such as date and number of participants.
3550
3554
  * Used, among other things, when checking for valid memberships.
3551
3555
  */
3552
3556
  serviceProperties?: ServiceProperties$9;
3553
3557
  /**
3554
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
3558
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
3559
+ *
3555
3560
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
3556
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
3561
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
3557
3562
  * + Used in membership validation.
3558
3563
  */
3559
3564
  rootCatalogItemId?: string | null;
3560
3565
  /**
3561
- * Optional - partial payment for the given item to be paid upfront during the checkout.
3566
+ * Partial payment for the given item to be paid upfront during the checkout.
3567
+ *
3562
3568
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
3563
- * If omitted - item's price will not be split and is expected to be paid in single installment
3569
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
3564
3570
  */
3565
3571
  depositAmount?: string | null;
3566
3572
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -4262,7 +4268,12 @@ interface CreateCartRequest$1 {
4262
4268
  merchantDiscounts?: MerchantDiscountInput$5[];
4263
4269
  /** Catalog line items. */
4264
4270
  lineItems?: LineItem$7[];
4265
- /** Custom line items. */
4271
+ /**
4272
+ * Custom line items.
4273
+ *
4274
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
4275
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4276
+ */
4266
4277
  customLineItems?: CustomLineItem$9[];
4267
4278
  }
4268
4279
  interface CreateCartResponse$1 {
@@ -4282,7 +4293,12 @@ interface AddToCartRequest$1 {
4282
4293
  id: string;
4283
4294
  /** Catalog line items. */
4284
4295
  lineItems?: LineItem$7[];
4285
- /** Custom line items. */
4296
+ /**
4297
+ * Custom line items.
4298
+ *
4299
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
4300
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4301
+ */
4286
4302
  customLineItems?: CustomLineItem$9[];
4287
4303
  }
4288
4304
  interface RemoveLineItemsRequest$3 {
@@ -5324,7 +5340,12 @@ interface UpdateCartRequest$2 {
5324
5340
  merchantDiscounts?: MerchantDiscountInput$4[];
5325
5341
  /** Catalog line items. */
5326
5342
  lineItems?: LineItem$6[];
5327
- /** Custom line items. */
5343
+ /**
5344
+ * Custom line items.
5345
+ *
5346
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
5347
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
5348
+ */
5328
5349
  customLineItems?: CustomLineItem$8[];
5329
5350
  }
5330
5351
  interface MerchantDiscountInput$4 {
@@ -5359,31 +5380,30 @@ interface CustomLineItem$8 {
5359
5380
  media?: string;
5360
5381
  /**
5361
5382
  * Custom line item ID. If passed, `id` must be unique.
5362
- * Default: auto-generated ID.
5383
+ *
5384
+ * Default: auto-generated ID
5363
5385
  */
5364
5386
  _id?: string | null;
5365
5387
  /** Tax group ID for this custom line item. */
5366
5388
  taxGroupId?: string | null;
5367
5389
  /** Name of the item or product. */
5368
5390
  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
- */
5391
+ /** 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
5392
  url?: string;
5374
5393
  /** Item type. Either a preset type or custom. */
5375
5394
  itemType?: ItemType$c;
5376
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
5395
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
5377
5396
  fullPrice?: string | null;
5378
5397
  /**
5379
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
5398
+ * Item quantity available for purchase. Only return this if inventory is managed.
5380
5399
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
5381
5400
  */
5382
5401
  quantityAvailable?: number | null;
5383
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
5402
+ /** Physical properties of the item. */
5384
5403
  physicalProperties?: PhysicalProperties$c;
5385
5404
  /**
5386
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
5405
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
5406
+ *
5387
5407
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
5388
5408
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
5389
5409
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -5391,21 +5411,23 @@ interface CustomLineItem$8 {
5391
5411
  */
5392
5412
  paymentOption?: PaymentOptionType$c;
5393
5413
  /**
5394
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
5414
+ * Service properties. When relevant, this contains information such as date and number of participants.
5395
5415
  * Used, among other things, when checking for valid memberships.
5396
5416
  */
5397
5417
  serviceProperties?: ServiceProperties$8;
5398
5418
  /**
5399
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
5419
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
5420
+ *
5400
5421
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
5401
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
5422
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
5402
5423
  * + Used in membership validation.
5403
5424
  */
5404
5425
  rootCatalogItemId?: string | null;
5405
5426
  /**
5406
- * Optional - partial payment for the given item to be paid upfront during the checkout.
5427
+ * Partial payment for the given item to be paid upfront during the checkout.
5428
+ *
5407
5429
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
5408
- * If omitted - item's price will not be split and is expected to be paid in single installment
5430
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
5409
5431
  */
5410
5432
  depositAmount?: string | null;
5411
5433
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -6116,7 +6138,12 @@ interface CreateCartRequest {
6116
6138
  merchantDiscounts?: MerchantDiscountInput$4[];
6117
6139
  /** Catalog line items. */
6118
6140
  lineItems?: LineItem$6[];
6119
- /** Custom line items. */
6141
+ /**
6142
+ * Custom line items.
6143
+ *
6144
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
6145
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
6146
+ */
6120
6147
  customLineItems?: CustomLineItem$8[];
6121
6148
  }
6122
6149
  interface CreateCartResponse {
@@ -6136,7 +6163,12 @@ interface AddToCartRequest {
6136
6163
  _id: string;
6137
6164
  /** Catalog line items. */
6138
6165
  lineItems?: LineItem$6[];
6139
- /** Custom line items. */
6166
+ /**
6167
+ * Custom line items.
6168
+ *
6169
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
6170
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
6171
+ */
6140
6172
  customLineItems?: CustomLineItem$8[];
6141
6173
  }
6142
6174
  interface RemoveLineItemsRequest$2 {
@@ -7295,7 +7327,12 @@ interface UpdateCartRequest$1 {
7295
7327
  merchantDiscounts?: MerchantDiscountInput$3[];
7296
7328
  /** Catalog line items. */
7297
7329
  lineItems?: LineItem$5[];
7298
- /** Custom line items. */
7330
+ /**
7331
+ * Custom line items.
7332
+ *
7333
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
7334
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
7335
+ */
7299
7336
  customLineItems?: CustomLineItem$7[];
7300
7337
  }
7301
7338
  interface MerchantDiscountInput$3 {
@@ -7326,31 +7363,30 @@ interface CustomLineItem$7 {
7326
7363
  media?: Image$5;
7327
7364
  /**
7328
7365
  * Custom line item ID. If passed, `id` must be unique.
7329
- * Default: auto-generated ID.
7366
+ *
7367
+ * Default: auto-generated ID
7330
7368
  */
7331
7369
  id?: string | null;
7332
7370
  /** Tax group ID for this custom line item. */
7333
7371
  taxGroupId?: string | null;
7334
7372
  /** Name of the item or product. */
7335
7373
  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
- */
7374
+ /** 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
7375
  url?: PageUrlV2$3;
7341
7376
  /** Item type. Either a preset type or custom. */
7342
7377
  itemType?: ItemType$b;
7343
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
7378
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
7344
7379
  fullPrice?: string | null;
7345
7380
  /**
7346
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
7381
+ * Item quantity available for purchase. Only return this if inventory is managed.
7347
7382
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
7348
7383
  */
7349
7384
  quantityAvailable?: number | null;
7350
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
7385
+ /** Physical properties of the item. */
7351
7386
  physicalProperties?: PhysicalProperties$b;
7352
7387
  /**
7353
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
7388
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
7389
+ *
7354
7390
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
7355
7391
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
7356
7392
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -7358,21 +7394,23 @@ interface CustomLineItem$7 {
7358
7394
  */
7359
7395
  paymentOption?: PaymentOptionType$b;
7360
7396
  /**
7361
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
7397
+ * Service properties. When relevant, this contains information such as date and number of participants.
7362
7398
  * Used, among other things, when checking for valid memberships.
7363
7399
  */
7364
7400
  serviceProperties?: ServiceProperties$7;
7365
7401
  /**
7366
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
7402
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
7403
+ *
7367
7404
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
7368
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
7405
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
7369
7406
  * + Used in membership validation.
7370
7407
  */
7371
7408
  rootCatalogItemId?: string | null;
7372
7409
  /**
7373
- * Optional - partial payment for the given item to be paid upfront during the checkout.
7410
+ * Partial payment for the given item to be paid upfront during the checkout.
7411
+ *
7374
7412
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
7375
- * If omitted - item's price will not be split and is expected to be paid in single installment
7413
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
7376
7414
  */
7377
7415
  depositAmount?: string | null;
7378
7416
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -7385,7 +7423,12 @@ interface UpdateCartResponse$1 {
7385
7423
  interface AddToCurrentCartRequest$1 {
7386
7424
  /** Catalog line items. */
7387
7425
  lineItems?: LineItem$5[];
7388
- /** Custom line items. */
7426
+ /**
7427
+ * Custom line items.
7428
+ *
7429
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
7430
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
7431
+ */
7389
7432
  customLineItems?: CustomLineItem$7[];
7390
7433
  }
7391
7434
  interface AddToCartResponse$1 {
@@ -9101,7 +9144,12 @@ interface UpdateCartRequest {
9101
9144
  merchantDiscounts?: MerchantDiscountInput$2[];
9102
9145
  /** Catalog line items. */
9103
9146
  lineItems?: LineItem$4[];
9104
- /** Custom line items. */
9147
+ /**
9148
+ * Custom line items.
9149
+ *
9150
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
9151
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
9152
+ */
9105
9153
  customLineItems?: CustomLineItem$6[];
9106
9154
  }
9107
9155
  interface MerchantDiscountInput$2 {
@@ -9136,31 +9184,30 @@ interface CustomLineItem$6 {
9136
9184
  media?: string;
9137
9185
  /**
9138
9186
  * Custom line item ID. If passed, `id` must be unique.
9139
- * Default: auto-generated ID.
9187
+ *
9188
+ * Default: auto-generated ID
9140
9189
  */
9141
9190
  _id?: string | null;
9142
9191
  /** Tax group ID for this custom line item. */
9143
9192
  taxGroupId?: string | null;
9144
9193
  /** Name of the item or product. */
9145
9194
  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
- */
9195
+ /** 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
9196
  url?: string;
9151
9197
  /** Item type. Either a preset type or custom. */
9152
9198
  itemType?: ItemType$a;
9153
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
9199
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
9154
9200
  fullPrice?: string | null;
9155
9201
  /**
9156
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
9202
+ * Item quantity available for purchase. Only return this if inventory is managed.
9157
9203
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
9158
9204
  */
9159
9205
  quantityAvailable?: number | null;
9160
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
9206
+ /** Physical properties of the item. */
9161
9207
  physicalProperties?: PhysicalProperties$a;
9162
9208
  /**
9163
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
9209
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
9210
+ *
9164
9211
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
9165
9212
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
9166
9213
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -9168,21 +9215,23 @@ interface CustomLineItem$6 {
9168
9215
  */
9169
9216
  paymentOption?: PaymentOptionType$a;
9170
9217
  /**
9171
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
9218
+ * Service properties. When relevant, this contains information such as date and number of participants.
9172
9219
  * Used, among other things, when checking for valid memberships.
9173
9220
  */
9174
9221
  serviceProperties?: ServiceProperties$6;
9175
9222
  /**
9176
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
9223
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
9224
+ *
9177
9225
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
9178
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
9226
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
9179
9227
  * + Used in membership validation.
9180
9228
  */
9181
9229
  rootCatalogItemId?: string | null;
9182
9230
  /**
9183
- * Optional - partial payment for the given item to be paid upfront during the checkout.
9231
+ * Partial payment for the given item to be paid upfront during the checkout.
9232
+ *
9184
9233
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
9185
- * If omitted - item's price will not be split and is expected to be paid in single installment
9234
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
9186
9235
  */
9187
9236
  depositAmount?: string | null;
9188
9237
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -9195,7 +9244,12 @@ interface UpdateCartResponse {
9195
9244
  interface AddToCurrentCartRequest {
9196
9245
  /** Catalog line items. */
9197
9246
  lineItems?: LineItem$4[];
9198
- /** Custom line items. */
9247
+ /**
9248
+ * Custom line items.
9249
+ *
9250
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
9251
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
9252
+ */
9199
9253
  customLineItems?: CustomLineItem$6[];
9200
9254
  }
9201
9255
  interface AddToCartResponse {
@@ -10689,11 +10743,23 @@ interface LineItem$3 {
10689
10743
  * @readonly
10690
10744
  */
10691
10745
  depositAmount?: MultiCurrencyPrice$3;
10746
+ /**
10747
+ * Whether the line item is custom or from catalog.
10748
+ * @readonly
10749
+ */
10750
+ customLineItem?: boolean;
10692
10751
  /**
10693
10752
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
10694
10753
  * @readonly
10695
10754
  */
10696
10755
  consentRequiredPaymentPolicy?: string | null;
10756
+ /**
10757
+ * Overriding values for catalog item properties.
10758
+ *
10759
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
10760
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
10761
+ */
10762
+ catalogOverrideFields?: CatalogOverrideFields$3;
10697
10763
  /**
10698
10764
  * Whether to save the payment method on the order.
10699
10765
  *
@@ -10970,6 +11036,20 @@ interface PriceDescription$7 {
10970
11036
  */
10971
11037
  translated?: string | null;
10972
11038
  }
11039
+ interface CatalogOverrideFields$3 {
11040
+ /** Item name. */
11041
+ productName?: ProductName$7;
11042
+ /** Item price **after** discounts. */
11043
+ price?: string | null;
11044
+ /** Item price **before** discounts. */
11045
+ fullPrice?: string | null;
11046
+ /** Item description lines. Used when displaying the line item to customers. */
11047
+ descriptionLines?: DescriptionLine$7[];
11048
+ /** Physical properties of the item. */
11049
+ physicalProperties?: PhysicalProperties$9;
11050
+ /** Item image. */
11051
+ image?: Image$4;
11052
+ }
10973
11053
  interface Image$4 {
10974
11054
  /** WixMedia image ID. */
10975
11055
  id?: string;
@@ -11758,9 +11838,14 @@ interface CreateCheckoutRequest$1 {
11758
11838
  checkoutInfo?: Checkout$1;
11759
11839
  /** Coupon code. */
11760
11840
  couponCode?: string | null;
11761
- /** Line items to be added to checkout. */
11841
+ /** Line items to add to the checkout. */
11762
11842
  lineItems?: LineItem$3[];
11763
- /** Custom line items to be added to checkout. */
11843
+ /**
11844
+ * Custom line items to add to the checkout.
11845
+ *
11846
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
11847
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
11848
+ */
11764
11849
  customLineItems?: CustomLineItem$5[];
11765
11850
  /**
11766
11851
  * Sales channel that submitted the order.
@@ -11815,31 +11900,30 @@ interface CustomLineItem$5 {
11815
11900
  media?: Image$4;
11816
11901
  /**
11817
11902
  * Custom line item ID. If passed, `id` must be unique.
11818
- * Default: auto-generated ID.
11903
+ *
11904
+ * Default: auto-generated ID
11819
11905
  */
11820
11906
  id?: string | null;
11821
11907
  /** Tax group ID for this custom line item. */
11822
11908
  taxGroupId?: string | null;
11823
11909
  /** Name of the item or product. */
11824
11910
  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
- */
11911
+ /** 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
11912
  url?: PageUrlV2$2;
11830
11913
  /** Item type. Either a preset type or custom. */
11831
11914
  itemType?: ItemType$9;
11832
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
11915
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
11833
11916
  fullPrice?: string | null;
11834
11917
  /**
11835
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
11918
+ * Item quantity available for purchase. Only return this if inventory is managed.
11836
11919
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
11837
11920
  */
11838
11921
  quantityAvailable?: number | null;
11839
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
11922
+ /** Physical properties of the item. */
11840
11923
  physicalProperties?: PhysicalProperties$9;
11841
11924
  /**
11842
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
11925
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
11926
+ *
11843
11927
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
11844
11928
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
11845
11929
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -11847,21 +11931,23 @@ interface CustomLineItem$5 {
11847
11931
  */
11848
11932
  paymentOption?: PaymentOptionType$9;
11849
11933
  /**
11850
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
11934
+ * Service properties. When relevant, this contains information such as date and number of participants.
11851
11935
  * Used, among other things, when checking for valid memberships.
11852
11936
  */
11853
11937
  serviceProperties?: ServiceProperties$5;
11854
11938
  /**
11855
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
11939
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
11940
+ *
11856
11941
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
11857
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
11942
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
11858
11943
  * + Used in membership validation.
11859
11944
  */
11860
11945
  rootCatalogItemId?: string | null;
11861
11946
  /**
11862
- * Optional - partial payment for the given item to be paid upfront during the checkout.
11947
+ * Partial payment for the given item to be paid upfront during the checkout.
11948
+ *
11863
11949
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
11864
- * If omitted - item's price will not be split and is expected to be paid in single installment
11950
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
11865
11951
  */
11866
11952
  depositAmount?: string | null;
11867
11953
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -11914,7 +12000,14 @@ interface UpdateCheckoutRequest$1 {
11914
12000
  * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
11915
12001
  */
11916
12002
  overrideCheckoutUrl?: string | null;
11917
- /** Custom line items to be saved on checkout. */
12003
+ /** Line items. */
12004
+ lineItems?: LineItem$3[];
12005
+ /**
12006
+ * Custom line items.
12007
+ *
12008
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
12009
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
12010
+ */
11918
12011
  customLineItems?: CustomLineItem$5[];
11919
12012
  }
11920
12013
  interface UpdateCheckoutResponse$1 {
@@ -11950,7 +12043,12 @@ interface AddToCheckoutRequest$1 {
11950
12043
  id: string;
11951
12044
  /** Catalog line items. */
11952
12045
  lineItems?: LineItem$3[];
11953
- /** Custom line items. */
12046
+ /**
12047
+ * Custom line items.
12048
+ *
12049
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
12050
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
12051
+ */
11954
12052
  customLineItems?: CustomLineItem$5[];
11955
12053
  }
11956
12054
  interface AddToCheckoutResponse$1 {
@@ -12790,11 +12888,23 @@ interface LineItem$2 {
12790
12888
  * @readonly
12791
12889
  */
12792
12890
  depositAmount?: MultiCurrencyPrice$2;
12891
+ /**
12892
+ * Whether the line item is custom or from catalog.
12893
+ * @readonly
12894
+ */
12895
+ customLineItem?: boolean;
12793
12896
  /**
12794
12897
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
12795
12898
  * @readonly
12796
12899
  */
12797
12900
  consentRequiredPaymentPolicy?: string | null;
12901
+ /**
12902
+ * Overriding values for catalog item properties.
12903
+ *
12904
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
12905
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
12906
+ */
12907
+ catalogOverrideFields?: CatalogOverrideFields$2;
12798
12908
  /**
12799
12909
  * Whether to save the payment method on the order.
12800
12910
  *
@@ -13044,6 +13154,20 @@ interface PriceDescription$6 {
13044
13154
  */
13045
13155
  translated?: string | null;
13046
13156
  }
13157
+ interface CatalogOverrideFields$2 {
13158
+ /** Item name. */
13159
+ productName?: ProductName$6;
13160
+ /** Item price **after** discounts. */
13161
+ price?: string | null;
13162
+ /** Item price **before** discounts. */
13163
+ fullPrice?: string | null;
13164
+ /** Item description lines. Used when displaying the line item to customers. */
13165
+ descriptionLines?: DescriptionLine$6[];
13166
+ /** Physical properties of the item. */
13167
+ physicalProperties?: PhysicalProperties$8;
13168
+ /** Item image. */
13169
+ image?: string;
13170
+ }
13047
13171
  /** Billing Info and shipping details */
13048
13172
  interface AddressWithContact$4 {
13049
13173
  /** Address. */
@@ -13810,9 +13934,14 @@ interface CreateCheckoutRequest {
13810
13934
  checkoutInfo?: Checkout;
13811
13935
  /** 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
13936
  couponCode?: string | null;
13813
- /** Line items to be added to checkout. */
13937
+ /** Line items to add to the checkout. */
13814
13938
  lineItems?: LineItem$2[];
13815
- /** Custom line items to be added to checkout. */
13939
+ /**
13940
+ * Custom line items to add to the checkout.
13941
+ *
13942
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
13943
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
13944
+ */
13816
13945
  customLineItems?: CustomLineItem$4[];
13817
13946
  /**
13818
13947
  * **Required**
@@ -13856,31 +13985,30 @@ interface CustomLineItem$4 {
13856
13985
  media?: string;
13857
13986
  /**
13858
13987
  * Custom line item ID. If passed, `id` must be unique.
13859
- * Default: auto-generated ID.
13988
+ *
13989
+ * Default: auto-generated ID
13860
13990
  */
13861
13991
  _id?: string | null;
13862
13992
  /** Tax group ID for this custom line item. */
13863
13993
  taxGroupId?: string | null;
13864
13994
  /** Name of the item or product. */
13865
13995
  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
- */
13996
+ /** 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
13997
  url?: string;
13871
13998
  /** Item type. Either a preset type or custom. */
13872
13999
  itemType?: ItemType$8;
13873
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
14000
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
13874
14001
  fullPrice?: string | null;
13875
14002
  /**
13876
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
14003
+ * Item quantity available for purchase. Only return this if inventory is managed.
13877
14004
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
13878
14005
  */
13879
14006
  quantityAvailable?: number | null;
13880
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
14007
+ /** Physical properties of the item. */
13881
14008
  physicalProperties?: PhysicalProperties$8;
13882
14009
  /**
13883
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
14010
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
14011
+ *
13884
14012
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
13885
14013
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
13886
14014
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -13888,21 +14016,23 @@ interface CustomLineItem$4 {
13888
14016
  */
13889
14017
  paymentOption?: PaymentOptionType$8;
13890
14018
  /**
13891
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
14019
+ * Service properties. When relevant, this contains information such as date and number of participants.
13892
14020
  * Used, among other things, when checking for valid memberships.
13893
14021
  */
13894
14022
  serviceProperties?: ServiceProperties$4;
13895
14023
  /**
13896
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
14024
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
14025
+ *
13897
14026
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
13898
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
14027
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
13899
14028
  * + Used in membership validation.
13900
14029
  */
13901
14030
  rootCatalogItemId?: string | null;
13902
14031
  /**
13903
- * Optional - partial payment for the given item to be paid upfront during the checkout.
14032
+ * Partial payment for the given item to be paid upfront during the checkout.
14033
+ *
13904
14034
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
13905
- * If omitted - item's price will not be split and is expected to be paid in single installment
14035
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
13906
14036
  */
13907
14037
  depositAmount?: string | null;
13908
14038
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -13949,7 +14079,14 @@ interface UpdateCheckoutRequest {
13949
14079
  * 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
14080
  */
13951
14081
  overrideCheckoutUrl?: string | null;
13952
- /** Custom line items to be saved on checkout. */
14082
+ /** Line items. */
14083
+ lineItems?: LineItem$2[];
14084
+ /**
14085
+ * Custom line items.
14086
+ *
14087
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
14088
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
14089
+ */
13953
14090
  customLineItems?: CustomLineItem$4[];
13954
14091
  }
13955
14092
  interface UpdateCheckoutResponse {
@@ -13985,7 +14122,12 @@ interface AddToCheckoutRequest {
13985
14122
  _id: string;
13986
14123
  /** Catalog line items. */
13987
14124
  lineItems?: LineItem$2[];
13988
- /** Custom line items. */
14125
+ /**
14126
+ * Custom line items.
14127
+ *
14128
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
14129
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
14130
+ */
13989
14131
  customLineItems?: CustomLineItem$4[];
13990
14132
  }
13991
14133
  interface AddToCheckoutResponse {
@@ -15052,6 +15194,13 @@ interface V1LineItem$1 {
15052
15194
  * > **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
15195
  */
15054
15196
  catalogReference?: CatalogReference$7;
15197
+ /**
15198
+ * Overriding values for catalog item properties.
15199
+ *
15200
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
15201
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
15202
+ */
15203
+ catalogOverrideFields?: CatalogOverrideFields$1;
15055
15204
  }
15056
15205
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
15057
15206
  interface CatalogReference$7 {
@@ -15075,6 +15224,20 @@ interface CatalogReference$7 {
15075
15224
  */
15076
15225
  options?: Record<string, any> | null;
15077
15226
  }
15227
+ interface CatalogOverrideFields$1 {
15228
+ /** Item name. */
15229
+ productName?: ProductName$5;
15230
+ /** Item price **after** discounts. */
15231
+ price?: string | null;
15232
+ /** Item price **before** discounts. */
15233
+ fullPrice?: string | null;
15234
+ /** Item description lines. Used when displaying the line item to customers. */
15235
+ descriptionLines?: DescriptionLine$5[];
15236
+ /** Physical properties of the item. */
15237
+ physicalProperties?: PhysicalProperties$7;
15238
+ /** Item image. */
15239
+ image?: Image$3;
15240
+ }
15078
15241
  interface ProductName$5 {
15079
15242
  /**
15080
15243
  * __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 +15352,30 @@ interface CustomLineItem$3 {
15189
15352
  media?: Image$3;
15190
15353
  /**
15191
15354
  * Custom line item ID. If passed, `id` must be unique.
15192
- * Default: auto-generated ID.
15355
+ *
15356
+ * Default: auto-generated ID
15193
15357
  */
15194
15358
  id?: string | null;
15195
15359
  /** Tax group ID for this custom line item. */
15196
15360
  taxGroupId?: string | null;
15197
15361
  /** Name of the item or product. */
15198
15362
  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
- */
15363
+ /** 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
15364
  url?: PageUrlV2$1;
15204
15365
  /** Item type. Either a preset type or custom. */
15205
15366
  itemType?: ItemType$7;
15206
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
15367
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
15207
15368
  fullPrice?: string | null;
15208
15369
  /**
15209
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
15370
+ * Item quantity available for purchase. Only return this if inventory is managed.
15210
15371
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
15211
15372
  */
15212
15373
  quantityAvailable?: number | null;
15213
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
15374
+ /** Physical properties of the item. */
15214
15375
  physicalProperties?: PhysicalProperties$7;
15215
15376
  /**
15216
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
15377
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
15378
+ *
15217
15379
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
15218
15380
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
15219
15381
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -15221,21 +15383,23 @@ interface CustomLineItem$3 {
15221
15383
  */
15222
15384
  paymentOption?: PaymentOptionType$7;
15223
15385
  /**
15224
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
15386
+ * Service properties. When relevant, this contains information such as date and number of participants.
15225
15387
  * Used, among other things, when checking for valid memberships.
15226
15388
  */
15227
15389
  serviceProperties?: ServiceProperties$3;
15228
15390
  /**
15229
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
15391
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
15392
+ *
15230
15393
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
15231
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
15394
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
15232
15395
  * + Used in membership validation.
15233
15396
  */
15234
15397
  rootCatalogItemId?: string | null;
15235
15398
  /**
15236
- * Optional - partial payment for the given item to be paid upfront during the checkout.
15399
+ * Partial payment for the given item to be paid upfront during the checkout.
15400
+ *
15237
15401
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
15238
- * If omitted - item's price will not be split and is expected to be paid in single installment
15402
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
15239
15403
  */
15240
15404
  depositAmount?: string | null;
15241
15405
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
@@ -15712,6 +15876,13 @@ interface V1LineItem {
15712
15876
  * > **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
15877
  */
15714
15878
  catalogReference?: CatalogReference$6;
15879
+ /**
15880
+ * Overriding values for catalog item properties.
15881
+ *
15882
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
15883
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
15884
+ */
15885
+ catalogOverrideFields?: CatalogOverrideFields;
15715
15886
  }
15716
15887
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
15717
15888
  interface CatalogReference$6 {
@@ -15735,6 +15906,20 @@ interface CatalogReference$6 {
15735
15906
  */
15736
15907
  options?: Record<string, any> | null;
15737
15908
  }
15909
+ interface CatalogOverrideFields {
15910
+ /** Item name. */
15911
+ productName?: ProductName$4;
15912
+ /** Item price **after** discounts. */
15913
+ price?: string | null;
15914
+ /** Item price **before** discounts. */
15915
+ fullPrice?: string | null;
15916
+ /** Item description lines. Used when displaying the line item to customers. */
15917
+ descriptionLines?: DescriptionLine$4[];
15918
+ /** Physical properties of the item. */
15919
+ physicalProperties?: PhysicalProperties$6;
15920
+ /** Item image. */
15921
+ image?: string;
15922
+ }
15738
15923
  interface ProductName$4 {
15739
15924
  /**
15740
15925
  * __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 +16022,30 @@ interface CustomLineItem$2 {
15837
16022
  media?: string;
15838
16023
  /**
15839
16024
  * Custom line item ID. If passed, `id` must be unique.
15840
- * Default: auto-generated ID.
16025
+ *
16026
+ * Default: auto-generated ID
15841
16027
  */
15842
16028
  _id?: string | null;
15843
16029
  /** Tax group ID for this custom line item. */
15844
16030
  taxGroupId?: string | null;
15845
16031
  /** Name of the item or product. */
15846
16032
  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
- */
16033
+ /** 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
16034
  url?: string;
15852
16035
  /** Item type. Either a preset type or custom. */
15853
16036
  itemType?: ItemType$6;
15854
- /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
16037
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
15855
16038
  fullPrice?: string | null;
15856
16039
  /**
15857
- * Optional - Item quantity available for purchase. Only return this if inventory is managed.
16040
+ * Item quantity available for purchase. Only return this if inventory is managed.
15858
16041
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
15859
16042
  */
15860
16043
  quantityAvailable?: number | null;
15861
- /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
16044
+ /** Physical properties of the item. */
15862
16045
  physicalProperties?: PhysicalProperties$6;
15863
16046
  /**
15864
- * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
16047
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
16048
+ *
15865
16049
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
15866
16050
  * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
15867
16051
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
@@ -15869,21 +16053,23 @@ interface CustomLineItem$2 {
15869
16053
  */
15870
16054
  paymentOption?: PaymentOptionType$6;
15871
16055
  /**
15872
- * Optional - Service properties. When relevant, this contains information such as date and number of participants.
16056
+ * Service properties. When relevant, this contains information such as date and number of participants.
15873
16057
  * Used, among other things, when checking for valid memberships.
15874
16058
  */
15875
16059
  serviceProperties?: ServiceProperties$2;
15876
16060
  /**
15877
- * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
16061
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
16062
+ *
15878
16063
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
15879
- * + in most cases, this field is the name as `catalogReference.catalogItemId`.
16064
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
15880
16065
  * + Used in membership validation.
15881
16066
  */
15882
16067
  rootCatalogItemId?: string | null;
15883
16068
  /**
15884
- * Optional - partial payment for the given item to be paid upfront during the checkout.
16069
+ * Partial payment for the given item to be paid upfront during the checkout.
16070
+ *
15885
16071
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
15886
- * If omitted - item's price will not be split and is expected to be paid in single installment
16072
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
15887
16073
  */
15888
16074
  depositAmount?: string | null;
15889
16075
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */