@wix/ecom 1.0.688 → 1.0.689

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.
@@ -2123,9 +2123,9 @@ interface BackInStockItemDetails$1 {
2123
2123
  /** Item price. */
2124
2124
  price?: string;
2125
2125
  /** Item image. */
2126
- image?: Image$5;
2126
+ image?: Image$7;
2127
2127
  }
2128
- interface Image$5 {
2128
+ interface Image$7 {
2129
2129
  /** WixMedia image ID. */
2130
2130
  id?: string;
2131
2131
  /** Image URL. */
@@ -2863,12 +2863,12 @@ interface LineItem$5 {
2863
2863
  * + Events - `ticket.name`
2864
2864
  * @readonly
2865
2865
  */
2866
- productName?: ProductName$9;
2866
+ productName?: ProductName$b;
2867
2867
  /**
2868
2868
  * URL to the item's page on the site.
2869
2869
  * @readonly
2870
2870
  */
2871
- url?: PageUrlV2$3;
2871
+ url?: PageUrlV2$4;
2872
2872
  /**
2873
2873
  * Item price **after** catalog-defined discount and line item discounts.
2874
2874
  * @readonly
@@ -2888,7 +2888,7 @@ interface LineItem$5 {
2888
2888
  * Line item description lines. Used for displaying the cart, checkout and order.
2889
2889
  * @readonly
2890
2890
  */
2891
- descriptionLines?: DescriptionLine$9[];
2891
+ descriptionLines?: DescriptionLine$b[];
2892
2892
  /**
2893
2893
  * Line item image details.
2894
2894
  * @readonly
@@ -2903,12 +2903,12 @@ interface LineItem$5 {
2903
2903
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
2904
2904
  * @readonly
2905
2905
  */
2906
- physicalProperties?: PhysicalProperties$9;
2906
+ physicalProperties?: PhysicalProperties$b;
2907
2907
  /**
2908
2908
  * Item type. Either a preset type or custom.
2909
2909
  * @readonly
2910
2910
  */
2911
- itemType?: ItemType$9;
2911
+ itemType?: ItemType$b;
2912
2912
  /**
2913
2913
  * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
2914
2914
  * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
@@ -2923,7 +2923,7 @@ interface LineItem$5 {
2923
2923
  * Service properties. When relevant, this contains information such as date and number of participants.
2924
2924
  * @readonly
2925
2925
  */
2926
- serviceProperties?: ServiceProperties$5;
2926
+ serviceProperties?: ServiceProperties$7;
2927
2927
  /**
2928
2928
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
2929
2929
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -2936,7 +2936,7 @@ interface LineItem$5 {
2936
2936
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
2937
2937
  * @readonly
2938
2938
  */
2939
- priceDescription?: PriceDescription$9;
2939
+ priceDescription?: PriceDescription$b;
2940
2940
  /**
2941
2941
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
2942
2942
  * @readonly
@@ -2972,7 +2972,7 @@ interface CatalogReference$b {
2972
2972
  */
2973
2973
  options?: Record<string, any> | null;
2974
2974
  }
2975
- interface ProductName$9 {
2975
+ interface ProductName$b {
2976
2976
  /**
2977
2977
  * __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).
2978
2978
  *
@@ -2989,7 +2989,7 @@ interface ProductName$9 {
2989
2989
  */
2990
2990
  translated?: string | null;
2991
2991
  }
2992
- interface PageUrlV2$3 {
2992
+ interface PageUrlV2$4 {
2993
2993
  /** The relative path for the page within the site. For example, `/product-page/a-product`. */
2994
2994
  relativePath?: string;
2995
2995
  /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
@@ -3014,25 +3014,25 @@ interface MultiCurrencyPrice$5 {
3014
3014
  */
3015
3015
  formattedConvertedAmount?: string;
3016
3016
  }
3017
- interface DescriptionLine$9 extends DescriptionLineValueOneOf$9, DescriptionLineDescriptionLineValueOneOf$9 {
3017
+ interface DescriptionLine$b extends DescriptionLineValueOneOf$b, DescriptionLineDescriptionLineValueOneOf$b {
3018
3018
  /** Description line plain text value. */
3019
- plainText?: PlainTextValue$9;
3019
+ plainText?: PlainTextValue$b;
3020
3020
  /** Description line color value. */
3021
- colorInfo?: Color$9;
3021
+ colorInfo?: Color$b;
3022
3022
  /** Description line name. */
3023
- name?: DescriptionLineName$9;
3023
+ name?: DescriptionLineName$b;
3024
3024
  }
3025
3025
  /** @oneof */
3026
- interface DescriptionLineValueOneOf$9 {
3026
+ interface DescriptionLineValueOneOf$b {
3027
3027
  /** Description line plain text value. */
3028
- plainText?: PlainTextValue$9;
3028
+ plainText?: PlainTextValue$b;
3029
3029
  /** Description line color value. */
3030
- colorInfo?: Color$9;
3030
+ colorInfo?: Color$b;
3031
3031
  }
3032
3032
  /** @oneof */
3033
- interface DescriptionLineDescriptionLineValueOneOf$9 {
3033
+ interface DescriptionLineDescriptionLineValueOneOf$b {
3034
3034
  }
3035
- interface DescriptionLineName$9 {
3035
+ interface DescriptionLineName$b {
3036
3036
  /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
3037
3037
  original?: string;
3038
3038
  /**
@@ -3042,7 +3042,7 @@ interface DescriptionLineName$9 {
3042
3042
  */
3043
3043
  translated?: string | null;
3044
3044
  }
3045
- interface PlainTextValue$9 {
3045
+ interface PlainTextValue$b {
3046
3046
  /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
3047
3047
  original?: string;
3048
3048
  /**
@@ -3052,7 +3052,7 @@ interface PlainTextValue$9 {
3052
3052
  */
3053
3053
  translated?: string | null;
3054
3054
  }
3055
- interface Color$9 {
3055
+ interface Color$b {
3056
3056
  /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
3057
3057
  original?: string;
3058
3058
  /**
@@ -3111,7 +3111,7 @@ declare enum ItemAvailabilityStatus$5 {
3111
3111
  /** Available quantity is less than requested */
3112
3112
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
3113
3113
  }
3114
- interface PhysicalProperties$9 {
3114
+ interface PhysicalProperties$b {
3115
3115
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
3116
3116
  weight?: number | null;
3117
3117
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -3119,14 +3119,14 @@ interface PhysicalProperties$9 {
3119
3119
  /** Whether this line item is shippable. */
3120
3120
  shippable?: boolean;
3121
3121
  }
3122
- interface ItemType$9 extends ItemTypeItemTypeDataOneOf$9 {
3122
+ interface ItemType$b extends ItemTypeItemTypeDataOneOf$b {
3123
3123
  /** Preset item type. */
3124
3124
  preset?: ItemTypeItemType$b;
3125
3125
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
3126
3126
  custom?: string;
3127
3127
  }
3128
3128
  /** @oneof */
3129
- interface ItemTypeItemTypeDataOneOf$9 {
3129
+ interface ItemTypeItemTypeDataOneOf$b {
3130
3130
  /** Preset item type. */
3131
3131
  preset?: ItemTypeItemType$b;
3132
3132
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -3168,7 +3168,7 @@ declare enum PaymentOptionType$b {
3168
3168
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
3169
3169
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
3170
3170
  }
3171
- interface ServiceProperties$5 {
3171
+ interface ServiceProperties$7 {
3172
3172
  /**
3173
3173
  * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
3174
3174
  * For example, the start time of a class.
@@ -3177,7 +3177,7 @@ interface ServiceProperties$5 {
3177
3177
  /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
3178
3178
  numberOfParticipants?: number | null;
3179
3179
  }
3180
- interface PriceDescription$9 {
3180
+ interface PriceDescription$b {
3181
3181
  /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
3182
3182
  original?: string;
3183
3183
  /**
@@ -3194,7 +3194,7 @@ interface SelectedMembership$5 {
3194
3194
  /** ID of the app providing this payment option. */
3195
3195
  appId?: string;
3196
3196
  }
3197
- interface Image$4 {
3197
+ interface Image$6 {
3198
3198
  /** WixMedia image ID. */
3199
3199
  id?: string;
3200
3200
  /** Original image height. */
@@ -3366,7 +3366,7 @@ interface UpdateCartRequest$3 {
3366
3366
  /** Catalog line items. */
3367
3367
  lineItems?: LineItem$5[];
3368
3368
  /** Custom line items. */
3369
- customLineItems?: CustomLineItem$5[];
3369
+ customLineItems?: CustomLineItem$9[];
3370
3370
  }
3371
3371
  interface MerchantDiscountInput$3 {
3372
3372
  /** Discount amount. */
@@ -3374,7 +3374,7 @@ interface MerchantDiscountInput$3 {
3374
3374
  /** IDs of line items the discount applies to. */
3375
3375
  lineItemIds?: string[];
3376
3376
  }
3377
- interface CustomLineItem$5 {
3377
+ interface CustomLineItem$9 {
3378
3378
  /**
3379
3379
  * Custom line item quantity.
3380
3380
  *
@@ -3389,11 +3389,11 @@ interface CustomLineItem$5 {
3389
3389
  */
3390
3390
  price?: string;
3391
3391
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
3392
- priceDescription?: PriceDescription$9;
3392
+ priceDescription?: PriceDescription$b;
3393
3393
  /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
3394
- descriptionLines?: DescriptionLine$9[];
3394
+ descriptionLines?: DescriptionLine$b[];
3395
3395
  /** Custom line item's media. */
3396
- media?: Image$4;
3396
+ media?: Image$6;
3397
3397
  /**
3398
3398
  * Custom line item ID. If passed, `id` must be unique.
3399
3399
  * Default: auto-generated ID.
@@ -3402,14 +3402,14 @@ interface CustomLineItem$5 {
3402
3402
  /** Tax group ID for this custom line item. */
3403
3403
  taxGroupId?: string | null;
3404
3404
  /** Name of the item or product. */
3405
- productName?: ProductName$9;
3405
+ productName?: ProductName$b;
3406
3406
  /**
3407
3407
  * 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.
3408
3408
  * The URL is optional and if not provided, the site URL will be used.
3409
3409
  */
3410
- url?: PageUrlV2$3;
3410
+ url?: PageUrlV2$4;
3411
3411
  /** Item type. Either a preset type or custom. */
3412
- itemType?: ItemType$9;
3412
+ itemType?: ItemType$b;
3413
3413
  /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
3414
3414
  fullPrice?: string | null;
3415
3415
  /**
@@ -3418,7 +3418,7 @@ interface CustomLineItem$5 {
3418
3418
  */
3419
3419
  quantityAvailable?: number | null;
3420
3420
  /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
3421
- physicalProperties?: PhysicalProperties$9;
3421
+ physicalProperties?: PhysicalProperties$b;
3422
3422
  /**
3423
3423
  * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
3424
3424
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
@@ -3431,7 +3431,7 @@ interface CustomLineItem$5 {
3431
3431
  * Optional - Service properties. When relevant, this contains information such as date and number of participants.
3432
3432
  * Used, among other things, when checking for valid memberships.
3433
3433
  */
3434
- serviceProperties?: ServiceProperties$5;
3434
+ serviceProperties?: ServiceProperties$7;
3435
3435
  /**
3436
3436
  * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
3437
3437
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -4143,7 +4143,7 @@ interface CreateCartRequest$1 {
4143
4143
  /** Catalog line items. */
4144
4144
  lineItems?: LineItem$5[];
4145
4145
  /** Custom line items. */
4146
- customLineItems?: CustomLineItem$5[];
4146
+ customLineItems?: CustomLineItem$9[];
4147
4147
  }
4148
4148
  interface CreateCartResponse$1 {
4149
4149
  /** Cart. */
@@ -4163,7 +4163,7 @@ interface AddToCartRequest$1 {
4163
4163
  /** Catalog line items. */
4164
4164
  lineItems?: LineItem$5[];
4165
4165
  /** Custom line items. */
4166
- customLineItems?: CustomLineItem$5[];
4166
+ customLineItems?: CustomLineItem$9[];
4167
4167
  }
4168
4168
  interface RemoveLineItemsRequest$3 {
4169
4169
  /** Cart ID. */
@@ -4763,7 +4763,7 @@ interface LineItem$4 {
4763
4763
  * + Events - `ticket.name`
4764
4764
  * @readonly
4765
4765
  */
4766
- productName?: ProductName$8;
4766
+ productName?: ProductName$a;
4767
4767
  /**
4768
4768
  * URL to the item's page on the site.
4769
4769
  * @readonly
@@ -4788,7 +4788,7 @@ interface LineItem$4 {
4788
4788
  * Line item description lines. Used for displaying the cart, checkout and order.
4789
4789
  * @readonly
4790
4790
  */
4791
- descriptionLines?: DescriptionLine$8[];
4791
+ descriptionLines?: DescriptionLine$a[];
4792
4792
  /**
4793
4793
  * Line item image details.
4794
4794
  * @readonly
@@ -4803,12 +4803,12 @@ interface LineItem$4 {
4803
4803
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
4804
4804
  * @readonly
4805
4805
  */
4806
- physicalProperties?: PhysicalProperties$8;
4806
+ physicalProperties?: PhysicalProperties$a;
4807
4807
  /**
4808
4808
  * Item type. Either a preset type or custom.
4809
4809
  * @readonly
4810
4810
  */
4811
- itemType?: ItemType$8;
4811
+ itemType?: ItemType$a;
4812
4812
  /**
4813
4813
  * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
4814
4814
  * + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item happens as part of the checkout.
@@ -4821,7 +4821,7 @@ interface LineItem$4 {
4821
4821
  * Service properties. When relevant, this contains information such as date and number of participants.
4822
4822
  * @readonly
4823
4823
  */
4824
- serviceProperties?: ServiceProperties$4;
4824
+ serviceProperties?: ServiceProperties$6;
4825
4825
  /**
4826
4826
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
4827
4827
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -4834,7 +4834,7 @@ interface LineItem$4 {
4834
4834
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
4835
4835
  * @readonly
4836
4836
  */
4837
- priceDescription?: PriceDescription$8;
4837
+ priceDescription?: PriceDescription$a;
4838
4838
  /**
4839
4839
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
4840
4840
  * @readonly
@@ -4872,7 +4872,7 @@ interface CatalogReference$a {
4872
4872
  */
4873
4873
  options?: Record<string, any> | null;
4874
4874
  }
4875
- interface ProductName$8 {
4875
+ interface ProductName$a {
4876
4876
  /** **Required** - Original product name (in site's default language). */
4877
4877
  original?: string;
4878
4878
  /** Description product name translated into buyer's language. Defaults to `original` when not defined. */
@@ -4897,37 +4897,37 @@ interface MultiCurrencyPrice$4 {
4897
4897
  */
4898
4898
  formattedConvertedAmount?: string;
4899
4899
  }
4900
- interface DescriptionLine$8 extends DescriptionLineValueOneOf$8, DescriptionLineDescriptionLineValueOneOf$8 {
4900
+ interface DescriptionLine$a extends DescriptionLineValueOneOf$a, DescriptionLineDescriptionLineValueOneOf$a {
4901
4901
  /** Description line plain text value. */
4902
- plainText?: PlainTextValue$8;
4902
+ plainText?: PlainTextValue$a;
4903
4903
  /** Description line color value. */
4904
- colorInfo?: Color$8;
4904
+ colorInfo?: Color$a;
4905
4905
  /** Description line name. */
4906
- name?: DescriptionLineName$8;
4906
+ name?: DescriptionLineName$a;
4907
4907
  }
4908
4908
  /** @oneof */
4909
- interface DescriptionLineValueOneOf$8 {
4909
+ interface DescriptionLineValueOneOf$a {
4910
4910
  /** Description line plain text value. */
4911
- plainText?: PlainTextValue$8;
4911
+ plainText?: PlainTextValue$a;
4912
4912
  /** Description line color value. */
4913
- colorInfo?: Color$8;
4913
+ colorInfo?: Color$a;
4914
4914
  }
4915
4915
  /** @oneof */
4916
- interface DescriptionLineDescriptionLineValueOneOf$8 {
4916
+ interface DescriptionLineDescriptionLineValueOneOf$a {
4917
4917
  }
4918
- interface DescriptionLineName$8 {
4918
+ interface DescriptionLineName$a {
4919
4919
  /** Description line name in site's default language. */
4920
4920
  original?: string;
4921
4921
  /** Description line name translated into buyer's language. Defaults to `original` when not defined. */
4922
4922
  translated?: string | null;
4923
4923
  }
4924
- interface PlainTextValue$8 {
4924
+ interface PlainTextValue$a {
4925
4925
  /** Description line plain text value in site's default language. */
4926
4926
  original?: string;
4927
4927
  /** Description line plain text value translated into buyer's language. Defaults to `original` when not defined. */
4928
4928
  translated?: string | null;
4929
4929
  }
4930
- interface Color$8 {
4930
+ interface Color$a {
4931
4931
  /** Description line color name in site's default language. */
4932
4932
  original?: string;
4933
4933
  /** Description line color name translated into buyer's language. Defaults to `original` when not defined. */
@@ -4963,7 +4963,7 @@ declare enum ItemAvailabilityStatus$4 {
4963
4963
  /** Available quantity is less than requested */
4964
4964
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
4965
4965
  }
4966
- interface PhysicalProperties$8 {
4966
+ interface PhysicalProperties$a {
4967
4967
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
4968
4968
  weight?: number | null;
4969
4969
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -4971,14 +4971,14 @@ interface PhysicalProperties$8 {
4971
4971
  /** Whether this line item is shippable. */
4972
4972
  shippable?: boolean;
4973
4973
  }
4974
- interface ItemType$8 extends ItemTypeItemTypeDataOneOf$8 {
4974
+ interface ItemType$a extends ItemTypeItemTypeDataOneOf$a {
4975
4975
  /** Preset item type. */
4976
4976
  preset?: ItemTypeItemType$a;
4977
4977
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
4978
4978
  custom?: string;
4979
4979
  }
4980
4980
  /** @oneof */
4981
- interface ItemTypeItemTypeDataOneOf$8 {
4981
+ interface ItemTypeItemTypeDataOneOf$a {
4982
4982
  /** Preset item type. */
4983
4983
  preset?: ItemTypeItemType$a;
4984
4984
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -5020,13 +5020,13 @@ declare enum PaymentOptionType$a {
5020
5020
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
5021
5021
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
5022
5022
  }
5023
- interface ServiceProperties$4 {
5023
+ interface ServiceProperties$6 {
5024
5024
  /** The date and time for which the service is supposed to be provided. For example, the time of the class. */
5025
5025
  scheduledDate?: Date;
5026
5026
  /** The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room. */
5027
5027
  numberOfParticipants?: number | null;
5028
5028
  }
5029
- interface PriceDescription$8 {
5029
+ interface PriceDescription$a {
5030
5030
  /**
5031
5031
  * **Required** - Original price description (in site's default language).
5032
5032
  *
@@ -5192,7 +5192,7 @@ interface UpdateCartRequest$2 {
5192
5192
  /** Catalog line items. */
5193
5193
  lineItems?: LineItem$4[];
5194
5194
  /** Custom line items. */
5195
- customLineItems?: CustomLineItem$4[];
5195
+ customLineItems?: CustomLineItem$8[];
5196
5196
  }
5197
5197
  interface MerchantDiscountInput$2 {
5198
5198
  /** Discount amount. */
@@ -5200,7 +5200,7 @@ interface MerchantDiscountInput$2 {
5200
5200
  /** IDs of the line items the discount applies to. */
5201
5201
  lineItemIds?: string[];
5202
5202
  }
5203
- interface CustomLineItem$4 {
5203
+ interface CustomLineItem$8 {
5204
5204
  /**
5205
5205
  * Custom line item quantity.
5206
5206
  *
@@ -5215,9 +5215,9 @@ interface CustomLineItem$4 {
5215
5215
  */
5216
5216
  price?: string;
5217
5217
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
5218
- priceDescription?: PriceDescription$8;
5218
+ priceDescription?: PriceDescription$a;
5219
5219
  /** Custom line item description lines. Used for displaying the cart, checkout and order. */
5220
- descriptionLines?: DescriptionLine$8[];
5220
+ descriptionLines?: DescriptionLine$a[];
5221
5221
  /**
5222
5222
  * Custom line item media. Supported formats:
5223
5223
  * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
@@ -5232,14 +5232,14 @@ interface CustomLineItem$4 {
5232
5232
  /** Tax group ID for this custom line item. */
5233
5233
  taxGroupId?: string | null;
5234
5234
  /** Name of the item or product. */
5235
- productName?: ProductName$8;
5235
+ productName?: ProductName$a;
5236
5236
  /**
5237
5237
  * 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.
5238
5238
  * The URL is optional and if not provided, the site URL will be used.
5239
5239
  */
5240
5240
  url?: string;
5241
5241
  /** Item type. Either a preset type or custom. */
5242
- itemType?: ItemType$8;
5242
+ itemType?: ItemType$a;
5243
5243
  /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
5244
5244
  fullPrice?: string | null;
5245
5245
  /**
@@ -5248,7 +5248,7 @@ interface CustomLineItem$4 {
5248
5248
  */
5249
5249
  quantityAvailable?: number | null;
5250
5250
  /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
5251
- physicalProperties?: PhysicalProperties$8;
5251
+ physicalProperties?: PhysicalProperties$a;
5252
5252
  /**
5253
5253
  * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
5254
5254
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
@@ -5261,7 +5261,7 @@ interface CustomLineItem$4 {
5261
5261
  * Optional - Service properties. When relevant, this contains information such as date and number of participants.
5262
5262
  * Used, among other things, when checking for valid memberships.
5263
5263
  */
5264
- serviceProperties?: ServiceProperties$4;
5264
+ serviceProperties?: ServiceProperties$6;
5265
5265
  /**
5266
5266
  * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
5267
5267
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -5982,7 +5982,7 @@ interface CreateCartRequest {
5982
5982
  /** Catalog line items. */
5983
5983
  lineItems?: LineItem$4[];
5984
5984
  /** Custom line items. */
5985
- customLineItems?: CustomLineItem$4[];
5985
+ customLineItems?: CustomLineItem$8[];
5986
5986
  }
5987
5987
  interface CreateCartResponse {
5988
5988
  /** Cart. */
@@ -6002,7 +6002,7 @@ interface AddToCartRequest {
6002
6002
  /** Catalog line items. */
6003
6003
  lineItems?: LineItem$4[];
6004
6004
  /** Custom line items. */
6005
- customLineItems?: CustomLineItem$4[];
6005
+ customLineItems?: CustomLineItem$8[];
6006
6006
  }
6007
6007
  interface RemoveLineItemsRequest$2 {
6008
6008
  /** Cart ID. */
@@ -6639,12 +6639,12 @@ interface LineItem$3 {
6639
6639
  * + Events - `ticket.name`
6640
6640
  * @readonly
6641
6641
  */
6642
- productName?: ProductName$7;
6642
+ productName?: ProductName$9;
6643
6643
  /**
6644
6644
  * URL to the item's page on the site.
6645
6645
  * @readonly
6646
6646
  */
6647
- url?: PageUrlV2$2;
6647
+ url?: PageUrlV2$3;
6648
6648
  /**
6649
6649
  * Item price **after** catalog-defined discount and line item discounts.
6650
6650
  * @readonly
@@ -6664,7 +6664,7 @@ interface LineItem$3 {
6664
6664
  * Line item description lines. Used for displaying the cart, checkout and order.
6665
6665
  * @readonly
6666
6666
  */
6667
- descriptionLines?: DescriptionLine$7[];
6667
+ descriptionLines?: DescriptionLine$9[];
6668
6668
  /**
6669
6669
  * Line item image details.
6670
6670
  * @readonly
@@ -6679,12 +6679,12 @@ interface LineItem$3 {
6679
6679
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
6680
6680
  * @readonly
6681
6681
  */
6682
- physicalProperties?: PhysicalProperties$7;
6682
+ physicalProperties?: PhysicalProperties$9;
6683
6683
  /**
6684
6684
  * Item type. Either a preset type or custom.
6685
6685
  * @readonly
6686
6686
  */
6687
- itemType?: ItemType$7;
6687
+ itemType?: ItemType$9;
6688
6688
  /**
6689
6689
  * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
6690
6690
  * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
@@ -6699,7 +6699,7 @@ interface LineItem$3 {
6699
6699
  * Service properties. When relevant, this contains information such as date and number of participants.
6700
6700
  * @readonly
6701
6701
  */
6702
- serviceProperties?: ServiceProperties$3;
6702
+ serviceProperties?: ServiceProperties$5;
6703
6703
  /**
6704
6704
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
6705
6705
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -6712,7 +6712,7 @@ interface LineItem$3 {
6712
6712
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
6713
6713
  * @readonly
6714
6714
  */
6715
- priceDescription?: PriceDescription$7;
6715
+ priceDescription?: PriceDescription$9;
6716
6716
  /**
6717
6717
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
6718
6718
  * @readonly
@@ -6748,7 +6748,7 @@ interface CatalogReference$9 {
6748
6748
  */
6749
6749
  options?: Record<string, any> | null;
6750
6750
  }
6751
- interface ProductName$7 {
6751
+ interface ProductName$9 {
6752
6752
  /**
6753
6753
  * __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).
6754
6754
  *
@@ -6765,7 +6765,7 @@ interface ProductName$7 {
6765
6765
  */
6766
6766
  translated?: string | null;
6767
6767
  }
6768
- interface PageUrlV2$2 {
6768
+ interface PageUrlV2$3 {
6769
6769
  /** The relative path for the page within the site. For example, `/product-page/a-product`. */
6770
6770
  relativePath?: string;
6771
6771
  /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
@@ -6790,25 +6790,25 @@ interface MultiCurrencyPrice$3 {
6790
6790
  */
6791
6791
  formattedConvertedAmount?: string;
6792
6792
  }
6793
- interface DescriptionLine$7 extends DescriptionLineValueOneOf$7, DescriptionLineDescriptionLineValueOneOf$7 {
6793
+ interface DescriptionLine$9 extends DescriptionLineValueOneOf$9, DescriptionLineDescriptionLineValueOneOf$9 {
6794
6794
  /** Description line plain text value. */
6795
- plainText?: PlainTextValue$7;
6795
+ plainText?: PlainTextValue$9;
6796
6796
  /** Description line color value. */
6797
- colorInfo?: Color$7;
6797
+ colorInfo?: Color$9;
6798
6798
  /** Description line name. */
6799
- name?: DescriptionLineName$7;
6799
+ name?: DescriptionLineName$9;
6800
6800
  }
6801
6801
  /** @oneof */
6802
- interface DescriptionLineValueOneOf$7 {
6802
+ interface DescriptionLineValueOneOf$9 {
6803
6803
  /** Description line plain text value. */
6804
- plainText?: PlainTextValue$7;
6804
+ plainText?: PlainTextValue$9;
6805
6805
  /** Description line color value. */
6806
- colorInfo?: Color$7;
6806
+ colorInfo?: Color$9;
6807
6807
  }
6808
6808
  /** @oneof */
6809
- interface DescriptionLineDescriptionLineValueOneOf$7 {
6809
+ interface DescriptionLineDescriptionLineValueOneOf$9 {
6810
6810
  }
6811
- interface DescriptionLineName$7 {
6811
+ interface DescriptionLineName$9 {
6812
6812
  /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
6813
6813
  original?: string;
6814
6814
  /**
@@ -6818,7 +6818,7 @@ interface DescriptionLineName$7 {
6818
6818
  */
6819
6819
  translated?: string | null;
6820
6820
  }
6821
- interface PlainTextValue$7 {
6821
+ interface PlainTextValue$9 {
6822
6822
  /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
6823
6823
  original?: string;
6824
6824
  /**
@@ -6828,7 +6828,7 @@ interface PlainTextValue$7 {
6828
6828
  */
6829
6829
  translated?: string | null;
6830
6830
  }
6831
- interface Color$7 {
6831
+ interface Color$9 {
6832
6832
  /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
6833
6833
  original?: string;
6834
6834
  /**
@@ -6887,7 +6887,7 @@ declare enum ItemAvailabilityStatus$3 {
6887
6887
  /** Available quantity is less than requested */
6888
6888
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
6889
6889
  }
6890
- interface PhysicalProperties$7 {
6890
+ interface PhysicalProperties$9 {
6891
6891
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
6892
6892
  weight?: number | null;
6893
6893
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -6895,14 +6895,14 @@ interface PhysicalProperties$7 {
6895
6895
  /** Whether this line item is shippable. */
6896
6896
  shippable?: boolean;
6897
6897
  }
6898
- interface ItemType$7 extends ItemTypeItemTypeDataOneOf$7 {
6898
+ interface ItemType$9 extends ItemTypeItemTypeDataOneOf$9 {
6899
6899
  /** Preset item type. */
6900
6900
  preset?: ItemTypeItemType$9;
6901
6901
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
6902
6902
  custom?: string;
6903
6903
  }
6904
6904
  /** @oneof */
6905
- interface ItemTypeItemTypeDataOneOf$7 {
6905
+ interface ItemTypeItemTypeDataOneOf$9 {
6906
6906
  /** Preset item type. */
6907
6907
  preset?: ItemTypeItemType$9;
6908
6908
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -6944,7 +6944,7 @@ declare enum PaymentOptionType$9 {
6944
6944
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
6945
6945
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
6946
6946
  }
6947
- interface ServiceProperties$3 {
6947
+ interface ServiceProperties$5 {
6948
6948
  /**
6949
6949
  * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6950
6950
  * For example, the start time of a class.
@@ -6953,7 +6953,7 @@ interface ServiceProperties$3 {
6953
6953
  /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
6954
6954
  numberOfParticipants?: number | null;
6955
6955
  }
6956
- interface PriceDescription$7 {
6956
+ interface PriceDescription$9 {
6957
6957
  /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
6958
6958
  original?: string;
6959
6959
  /**
@@ -6970,7 +6970,7 @@ interface SelectedMembership$3 {
6970
6970
  /** ID of the app providing this payment option. */
6971
6971
  appId?: string;
6972
6972
  }
6973
- interface Image$3 {
6973
+ interface Image$5 {
6974
6974
  /** WixMedia image ID. */
6975
6975
  id?: string;
6976
6976
  /** Original image height. */
@@ -7148,7 +7148,7 @@ interface UpdateCartRequest$1 {
7148
7148
  /** Catalog line items. */
7149
7149
  lineItems?: LineItem$3[];
7150
7150
  /** Custom line items. */
7151
- customLineItems?: CustomLineItem$3[];
7151
+ customLineItems?: CustomLineItem$7[];
7152
7152
  }
7153
7153
  interface MerchantDiscountInput$1 {
7154
7154
  /** Discount amount. */
@@ -7156,7 +7156,7 @@ interface MerchantDiscountInput$1 {
7156
7156
  /** IDs of line items the discount applies to. */
7157
7157
  lineItemIds?: string[];
7158
7158
  }
7159
- interface CustomLineItem$3 {
7159
+ interface CustomLineItem$7 {
7160
7160
  /**
7161
7161
  * Custom line item quantity.
7162
7162
  *
@@ -7171,11 +7171,11 @@ interface CustomLineItem$3 {
7171
7171
  */
7172
7172
  price?: string;
7173
7173
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
7174
- priceDescription?: PriceDescription$7;
7174
+ priceDescription?: PriceDescription$9;
7175
7175
  /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
7176
- descriptionLines?: DescriptionLine$7[];
7176
+ descriptionLines?: DescriptionLine$9[];
7177
7177
  /** Custom line item's media. */
7178
- media?: Image$3;
7178
+ media?: Image$5;
7179
7179
  /**
7180
7180
  * Custom line item ID. If passed, `id` must be unique.
7181
7181
  * Default: auto-generated ID.
@@ -7184,14 +7184,14 @@ interface CustomLineItem$3 {
7184
7184
  /** Tax group ID for this custom line item. */
7185
7185
  taxGroupId?: string | null;
7186
7186
  /** Name of the item or product. */
7187
- productName?: ProductName$7;
7187
+ productName?: ProductName$9;
7188
7188
  /**
7189
7189
  * 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.
7190
7190
  * The URL is optional and if not provided, the site URL will be used.
7191
7191
  */
7192
- url?: PageUrlV2$2;
7192
+ url?: PageUrlV2$3;
7193
7193
  /** Item type. Either a preset type or custom. */
7194
- itemType?: ItemType$7;
7194
+ itemType?: ItemType$9;
7195
7195
  /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
7196
7196
  fullPrice?: string | null;
7197
7197
  /**
@@ -7200,7 +7200,7 @@ interface CustomLineItem$3 {
7200
7200
  */
7201
7201
  quantityAvailable?: number | null;
7202
7202
  /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
7203
- physicalProperties?: PhysicalProperties$7;
7203
+ physicalProperties?: PhysicalProperties$9;
7204
7204
  /**
7205
7205
  * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
7206
7206
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
@@ -7213,7 +7213,7 @@ interface CustomLineItem$3 {
7213
7213
  * Optional - Service properties. When relevant, this contains information such as date and number of participants.
7214
7214
  * Used, among other things, when checking for valid memberships.
7215
7215
  */
7216
- serviceProperties?: ServiceProperties$3;
7216
+ serviceProperties?: ServiceProperties$5;
7217
7217
  /**
7218
7218
  * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
7219
7219
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -7238,7 +7238,7 @@ interface AddToCurrentCartRequest$1 {
7238
7238
  /** Catalog line items. */
7239
7239
  lineItems?: LineItem$3[];
7240
7240
  /** Custom line items. */
7241
- customLineItems?: CustomLineItem$3[];
7241
+ customLineItems?: CustomLineItem$7[];
7242
7242
  }
7243
7243
  interface AddToCartResponse$1 {
7244
7244
  /** Updated cart. */
@@ -8504,7 +8504,7 @@ interface LineItem$2 {
8504
8504
  * + Events - `ticket.name`
8505
8505
  * @readonly
8506
8506
  */
8507
- productName?: ProductName$6;
8507
+ productName?: ProductName$8;
8508
8508
  /**
8509
8509
  * URL to the item's page on the site.
8510
8510
  * @readonly
@@ -8529,7 +8529,7 @@ interface LineItem$2 {
8529
8529
  * Line item description lines. Used for displaying the cart, checkout and order.
8530
8530
  * @readonly
8531
8531
  */
8532
- descriptionLines?: DescriptionLine$6[];
8532
+ descriptionLines?: DescriptionLine$8[];
8533
8533
  /**
8534
8534
  * Line item image details.
8535
8535
  * @readonly
@@ -8544,12 +8544,12 @@ interface LineItem$2 {
8544
8544
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
8545
8545
  * @readonly
8546
8546
  */
8547
- physicalProperties?: PhysicalProperties$6;
8547
+ physicalProperties?: PhysicalProperties$8;
8548
8548
  /**
8549
8549
  * Item type. Either a preset type or custom.
8550
8550
  * @readonly
8551
8551
  */
8552
- itemType?: ItemType$6;
8552
+ itemType?: ItemType$8;
8553
8553
  /**
8554
8554
  * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
8555
8555
  * + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item happens as part of the checkout.
@@ -8562,7 +8562,7 @@ interface LineItem$2 {
8562
8562
  * Service properties. When relevant, this contains information such as date and number of participants.
8563
8563
  * @readonly
8564
8564
  */
8565
- serviceProperties?: ServiceProperties$2;
8565
+ serviceProperties?: ServiceProperties$4;
8566
8566
  /**
8567
8567
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
8568
8568
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -8575,7 +8575,7 @@ interface LineItem$2 {
8575
8575
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
8576
8576
  * @readonly
8577
8577
  */
8578
- priceDescription?: PriceDescription$6;
8578
+ priceDescription?: PriceDescription$8;
8579
8579
  /**
8580
8580
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
8581
8581
  * @readonly
@@ -8613,7 +8613,7 @@ interface CatalogReference$8 {
8613
8613
  */
8614
8614
  options?: Record<string, any> | null;
8615
8615
  }
8616
- interface ProductName$6 {
8616
+ interface ProductName$8 {
8617
8617
  /** **Required** - Original product name (in site's default language). */
8618
8618
  original?: string;
8619
8619
  /** Description product name translated into buyer's language. Defaults to `original` when not defined. */
@@ -8638,37 +8638,37 @@ interface MultiCurrencyPrice$2 {
8638
8638
  */
8639
8639
  formattedConvertedAmount?: string;
8640
8640
  }
8641
- interface DescriptionLine$6 extends DescriptionLineValueOneOf$6, DescriptionLineDescriptionLineValueOneOf$6 {
8641
+ interface DescriptionLine$8 extends DescriptionLineValueOneOf$8, DescriptionLineDescriptionLineValueOneOf$8 {
8642
8642
  /** Description line plain text value. */
8643
- plainText?: PlainTextValue$6;
8643
+ plainText?: PlainTextValue$8;
8644
8644
  /** Description line color value. */
8645
- colorInfo?: Color$6;
8645
+ colorInfo?: Color$8;
8646
8646
  /** Description line name. */
8647
- name?: DescriptionLineName$6;
8647
+ name?: DescriptionLineName$8;
8648
8648
  }
8649
8649
  /** @oneof */
8650
- interface DescriptionLineValueOneOf$6 {
8650
+ interface DescriptionLineValueOneOf$8 {
8651
8651
  /** Description line plain text value. */
8652
- plainText?: PlainTextValue$6;
8652
+ plainText?: PlainTextValue$8;
8653
8653
  /** Description line color value. */
8654
- colorInfo?: Color$6;
8654
+ colorInfo?: Color$8;
8655
8655
  }
8656
8656
  /** @oneof */
8657
- interface DescriptionLineDescriptionLineValueOneOf$6 {
8657
+ interface DescriptionLineDescriptionLineValueOneOf$8 {
8658
8658
  }
8659
- interface DescriptionLineName$6 {
8659
+ interface DescriptionLineName$8 {
8660
8660
  /** Description line name in site's default language. */
8661
8661
  original?: string;
8662
8662
  /** Description line name translated into buyer's language. Defaults to `original` when not defined. */
8663
8663
  translated?: string | null;
8664
8664
  }
8665
- interface PlainTextValue$6 {
8665
+ interface PlainTextValue$8 {
8666
8666
  /** Description line plain text value in site's default language. */
8667
8667
  original?: string;
8668
8668
  /** Description line plain text value translated into buyer's language. Defaults to `original` when not defined. */
8669
8669
  translated?: string | null;
8670
8670
  }
8671
- interface Color$6 {
8671
+ interface Color$8 {
8672
8672
  /** Description line color name in site's default language. */
8673
8673
  original?: string;
8674
8674
  /** Description line color name translated into buyer's language. Defaults to `original` when not defined. */
@@ -8704,7 +8704,7 @@ declare enum ItemAvailabilityStatus$2 {
8704
8704
  /** Available quantity is less than requested */
8705
8705
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
8706
8706
  }
8707
- interface PhysicalProperties$6 {
8707
+ interface PhysicalProperties$8 {
8708
8708
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
8709
8709
  weight?: number | null;
8710
8710
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -8712,14 +8712,14 @@ interface PhysicalProperties$6 {
8712
8712
  /** Whether this line item is shippable. */
8713
8713
  shippable?: boolean;
8714
8714
  }
8715
- interface ItemType$6 extends ItemTypeItemTypeDataOneOf$6 {
8715
+ interface ItemType$8 extends ItemTypeItemTypeDataOneOf$8 {
8716
8716
  /** Preset item type. */
8717
8717
  preset?: ItemTypeItemType$8;
8718
8718
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
8719
8719
  custom?: string;
8720
8720
  }
8721
8721
  /** @oneof */
8722
- interface ItemTypeItemTypeDataOneOf$6 {
8722
+ interface ItemTypeItemTypeDataOneOf$8 {
8723
8723
  /** Preset item type. */
8724
8724
  preset?: ItemTypeItemType$8;
8725
8725
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -8761,13 +8761,13 @@ declare enum PaymentOptionType$8 {
8761
8761
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
8762
8762
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
8763
8763
  }
8764
- interface ServiceProperties$2 {
8764
+ interface ServiceProperties$4 {
8765
8765
  /** The date and time for which the service is supposed to be provided. For example, the time of the class. */
8766
8766
  scheduledDate?: Date;
8767
8767
  /** The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room. */
8768
8768
  numberOfParticipants?: number | null;
8769
8769
  }
8770
- interface PriceDescription$6 {
8770
+ interface PriceDescription$8 {
8771
8771
  /**
8772
8772
  * **Required** - Original price description (in site's default language).
8773
8773
  *
@@ -8939,7 +8939,7 @@ interface UpdateCartRequest {
8939
8939
  /** Catalog line items. */
8940
8940
  lineItems?: LineItem$2[];
8941
8941
  /** Custom line items. */
8942
- customLineItems?: CustomLineItem$2[];
8942
+ customLineItems?: CustomLineItem$6[];
8943
8943
  }
8944
8944
  interface MerchantDiscountInput {
8945
8945
  /** Discount amount. */
@@ -8947,7 +8947,7 @@ interface MerchantDiscountInput {
8947
8947
  /** IDs of the line items the discount applies to. */
8948
8948
  lineItemIds?: string[];
8949
8949
  }
8950
- interface CustomLineItem$2 {
8950
+ interface CustomLineItem$6 {
8951
8951
  /**
8952
8952
  * Custom line item quantity.
8953
8953
  *
@@ -8962,9 +8962,9 @@ interface CustomLineItem$2 {
8962
8962
  */
8963
8963
  price?: string;
8964
8964
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
8965
- priceDescription?: PriceDescription$6;
8965
+ priceDescription?: PriceDescription$8;
8966
8966
  /** Custom line item description lines. Used for displaying the cart, checkout and order. */
8967
- descriptionLines?: DescriptionLine$6[];
8967
+ descriptionLines?: DescriptionLine$8[];
8968
8968
  /**
8969
8969
  * Custom line item media. Supported formats:
8970
8970
  * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
@@ -8979,14 +8979,14 @@ interface CustomLineItem$2 {
8979
8979
  /** Tax group ID for this custom line item. */
8980
8980
  taxGroupId?: string | null;
8981
8981
  /** Name of the item or product. */
8982
- productName?: ProductName$6;
8982
+ productName?: ProductName$8;
8983
8983
  /**
8984
8984
  * 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.
8985
8985
  * The URL is optional and if not provided, the site URL will be used.
8986
8986
  */
8987
8987
  url?: string;
8988
8988
  /** Item type. Either a preset type or custom. */
8989
- itemType?: ItemType$6;
8989
+ itemType?: ItemType$8;
8990
8990
  /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
8991
8991
  fullPrice?: string | null;
8992
8992
  /**
@@ -8995,7 +8995,7 @@ interface CustomLineItem$2 {
8995
8995
  */
8996
8996
  quantityAvailable?: number | null;
8997
8997
  /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
8998
- physicalProperties?: PhysicalProperties$6;
8998
+ physicalProperties?: PhysicalProperties$8;
8999
8999
  /**
9000
9000
  * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
9001
9001
  * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
@@ -9008,7 +9008,7 @@ interface CustomLineItem$2 {
9008
9008
  * Optional - Service properties. When relevant, this contains information such as date and number of participants.
9009
9009
  * Used, among other things, when checking for valid memberships.
9010
9010
  */
9011
- serviceProperties?: ServiceProperties$2;
9011
+ serviceProperties?: ServiceProperties$4;
9012
9012
  /**
9013
9013
  * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
9014
9014
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -9033,7 +9033,7 @@ interface AddToCurrentCartRequest {
9033
9033
  /** Catalog line items. */
9034
9034
  lineItems?: LineItem$2[];
9035
9035
  /** Custom line items. */
9036
- customLineItems?: CustomLineItem$2[];
9036
+ customLineItems?: CustomLineItem$6[];
9037
9037
  }
9038
9038
  interface AddToCartResponse {
9039
9039
  /** Updated cart. */
@@ -10385,6 +10385,12 @@ interface Checkout$1 {
10385
10385
  * Custom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout).
10386
10386
  */
10387
10387
  customSettings?: CustomSettings$1;
10388
+ /**
10389
+ * Customize the content of the checkout page.
10390
+ *
10391
+ * Includes IDs for the app and the component providing the content
10392
+ */
10393
+ customContentReference?: CustomContentReference$3;
10388
10394
  }
10389
10395
  interface LineItem$1 {
10390
10396
  /**
@@ -10408,12 +10414,12 @@ interface LineItem$1 {
10408
10414
  * + Events - `ticket.name`
10409
10415
  * @readonly
10410
10416
  */
10411
- productName?: ProductName$5;
10417
+ productName?: ProductName$7;
10412
10418
  /**
10413
10419
  * URL to the item's page on the site.
10414
10420
  * @readonly
10415
10421
  */
10416
- url?: PageUrlV2$1;
10422
+ url?: PageUrlV2$2;
10417
10423
  /**
10418
10424
  * Item price **after** catalog-defined discount and line item discounts.
10419
10425
  * @readonly
@@ -10458,7 +10464,7 @@ interface LineItem$1 {
10458
10464
  * Line item description lines. Used for display purposes for the cart, checkout and order.
10459
10465
  * @readonly
10460
10466
  */
10461
- descriptionLines?: DescriptionLine$5[];
10467
+ descriptionLines?: DescriptionLine$7[];
10462
10468
  /**
10463
10469
  * Line item image details.
10464
10470
  * @readonly
@@ -10473,12 +10479,12 @@ interface LineItem$1 {
10473
10479
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
10474
10480
  * @readonly
10475
10481
  */
10476
- physicalProperties?: PhysicalProperties$5;
10482
+ physicalProperties?: PhysicalProperties$7;
10477
10483
  /**
10478
10484
  * Item type. Either a preset type or custom.
10479
10485
  * @readonly
10480
10486
  */
10481
- itemType?: ItemType$5;
10487
+ itemType?: ItemType$7;
10482
10488
  /**
10483
10489
  * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
10484
10490
  * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
@@ -10493,7 +10499,7 @@ interface LineItem$1 {
10493
10499
  * Service properties. When relevant, this contains information such as date and number of participants.
10494
10500
  * @readonly
10495
10501
  */
10496
- serviceProperties?: ServiceProperties$1;
10502
+ serviceProperties?: ServiceProperties$3;
10497
10503
  /**
10498
10504
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
10499
10505
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -10506,7 +10512,7 @@ interface LineItem$1 {
10506
10512
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
10507
10513
  * @readonly
10508
10514
  */
10509
- priceDescription?: PriceDescription$5;
10515
+ priceDescription?: PriceDescription$7;
10510
10516
  /**
10511
10517
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
10512
10518
  * @readonly
@@ -10535,7 +10541,7 @@ interface CatalogReference$7 {
10535
10541
  */
10536
10542
  options?: Record<string, any> | null;
10537
10543
  }
10538
- interface ProductName$5 {
10544
+ interface ProductName$7 {
10539
10545
  /**
10540
10546
  * __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).
10541
10547
  *
@@ -10552,7 +10558,7 @@ interface ProductName$5 {
10552
10558
  */
10553
10559
  translated?: string | null;
10554
10560
  }
10555
- interface PageUrlV2$1 {
10561
+ interface PageUrlV2$2 {
10556
10562
  /** The relative path for the page within the site. For example, `/product-page/a-product`. */
10557
10563
  relativePath?: string;
10558
10564
  /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
@@ -10608,25 +10614,25 @@ declare enum JurisdictionType$5 {
10608
10614
  CITY = "CITY",
10609
10615
  SPECIAL = "SPECIAL"
10610
10616
  }
10611
- interface DescriptionLine$5 extends DescriptionLineValueOneOf$5, DescriptionLineDescriptionLineValueOneOf$5 {
10617
+ interface DescriptionLine$7 extends DescriptionLineValueOneOf$7, DescriptionLineDescriptionLineValueOneOf$7 {
10612
10618
  /** Description line plain text value. */
10613
- plainText?: PlainTextValue$5;
10619
+ plainText?: PlainTextValue$7;
10614
10620
  /** Description line color value. */
10615
- colorInfo?: Color$5;
10621
+ colorInfo?: Color$7;
10616
10622
  /** Description line name. */
10617
- name?: DescriptionLineName$5;
10623
+ name?: DescriptionLineName$7;
10618
10624
  }
10619
10625
  /** @oneof */
10620
- interface DescriptionLineValueOneOf$5 {
10626
+ interface DescriptionLineValueOneOf$7 {
10621
10627
  /** Description line plain text value. */
10622
- plainText?: PlainTextValue$5;
10628
+ plainText?: PlainTextValue$7;
10623
10629
  /** Description line color value. */
10624
- colorInfo?: Color$5;
10630
+ colorInfo?: Color$7;
10625
10631
  }
10626
10632
  /** @oneof */
10627
- interface DescriptionLineDescriptionLineValueOneOf$5 {
10633
+ interface DescriptionLineDescriptionLineValueOneOf$7 {
10628
10634
  }
10629
- interface DescriptionLineName$5 {
10635
+ interface DescriptionLineName$7 {
10630
10636
  /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
10631
10637
  original?: string;
10632
10638
  /**
@@ -10636,7 +10642,7 @@ interface DescriptionLineName$5 {
10636
10642
  */
10637
10643
  translated?: string | null;
10638
10644
  }
10639
- interface PlainTextValue$5 {
10645
+ interface PlainTextValue$7 {
10640
10646
  /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
10641
10647
  original?: string;
10642
10648
  /**
@@ -10646,7 +10652,7 @@ interface PlainTextValue$5 {
10646
10652
  */
10647
10653
  translated?: string | null;
10648
10654
  }
10649
- interface Color$5 {
10655
+ interface Color$7 {
10650
10656
  /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
10651
10657
  original?: string;
10652
10658
  /**
@@ -10705,7 +10711,7 @@ declare enum ItemAvailabilityStatus$1 {
10705
10711
  /** Available quantity is less than requested */
10706
10712
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
10707
10713
  }
10708
- interface PhysicalProperties$5 {
10714
+ interface PhysicalProperties$7 {
10709
10715
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
10710
10716
  weight?: number | null;
10711
10717
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -10713,14 +10719,14 @@ interface PhysicalProperties$5 {
10713
10719
  /** Whether this line item is shippable. */
10714
10720
  shippable?: boolean;
10715
10721
  }
10716
- interface ItemType$5 extends ItemTypeItemTypeDataOneOf$5 {
10722
+ interface ItemType$7 extends ItemTypeItemTypeDataOneOf$7 {
10717
10723
  /** Preset item type. */
10718
10724
  preset?: ItemTypeItemType$7;
10719
10725
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
10720
10726
  custom?: string;
10721
10727
  }
10722
10728
  /** @oneof */
10723
- interface ItemTypeItemTypeDataOneOf$5 {
10729
+ interface ItemTypeItemTypeDataOneOf$7 {
10724
10730
  /** Preset item type. */
10725
10731
  preset?: ItemTypeItemType$7;
10726
10732
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -10762,7 +10768,7 @@ declare enum PaymentOptionType$7 {
10762
10768
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
10763
10769
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
10764
10770
  }
10765
- interface ServiceProperties$1 {
10771
+ interface ServiceProperties$3 {
10766
10772
  /**
10767
10773
  * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
10768
10774
  * For example, the start time of a class.
@@ -10771,7 +10777,7 @@ interface ServiceProperties$1 {
10771
10777
  /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
10772
10778
  numberOfParticipants?: number | null;
10773
10779
  }
10774
- interface PriceDescription$5 {
10780
+ interface PriceDescription$7 {
10775
10781
  /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
10776
10782
  original?: string;
10777
10783
  /**
@@ -10781,6 +10787,18 @@ interface PriceDescription$5 {
10781
10787
  */
10782
10788
  translated?: string | null;
10783
10789
  }
10790
+ interface Image$4 {
10791
+ /** WixMedia image ID. */
10792
+ id?: string;
10793
+ /** Original image height. */
10794
+ height?: number;
10795
+ /** Original image width. */
10796
+ width?: number;
10797
+ /** Image alt text. Optional. */
10798
+ altText?: string | null;
10799
+ /** Image filename. Optional. */
10800
+ filename?: string | null;
10801
+ }
10784
10802
  /** Billing Info and shipping details */
10785
10803
  interface AddressWithContact$5 {
10786
10804
  /** Address. */
@@ -11530,6 +11548,20 @@ interface CustomSettings$1 {
11530
11548
  */
11531
11549
  disabledManualPayment?: boolean;
11532
11550
  }
11551
+ interface CustomContentReference$3 {
11552
+ /**
11553
+ * ID of the app providing the content.
11554
+ *
11555
+ * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
11556
+ */
11557
+ appId?: string;
11558
+ /**
11559
+ * ID of the component within the app it belongs to.
11560
+ *
11561
+ * You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
11562
+ */
11563
+ componentId?: string;
11564
+ }
11533
11565
  interface CreateCheckoutRequest$1 {
11534
11566
  /** Checkout information. */
11535
11567
  checkoutInfo?: Checkout$1;
@@ -11537,6 +11569,8 @@ interface CreateCheckoutRequest$1 {
11537
11569
  couponCode?: string | null;
11538
11570
  /** Line items to be added to checkout. */
11539
11571
  lineItems?: LineItem$1[];
11572
+ /** Custom line items to be added to checkout. */
11573
+ customLineItems?: CustomLineItem$5[];
11540
11574
  /**
11541
11575
  * Sales channel that submitted the order.
11542
11576
  * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
@@ -11568,6 +11602,80 @@ interface CreateCheckoutRequest$1 {
11568
11602
  */
11569
11603
  overrideCheckoutUrl?: string | null;
11570
11604
  }
11605
+ interface CustomLineItem$5 {
11606
+ /**
11607
+ * Custom line item quantity.
11608
+ *
11609
+ * Min: `1`
11610
+ * Max: `100000`
11611
+ */
11612
+ quantity?: number;
11613
+ /**
11614
+ * Custom line item price.
11615
+ *
11616
+ * Must be a number or a decimal without symbols.
11617
+ */
11618
+ price?: string;
11619
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
11620
+ priceDescription?: PriceDescription$7;
11621
+ /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
11622
+ descriptionLines?: DescriptionLine$7[];
11623
+ /** Custom line item's media. */
11624
+ media?: Image$4;
11625
+ /**
11626
+ * Custom line item ID. If passed, `id` must be unique.
11627
+ * Default: auto-generated ID.
11628
+ */
11629
+ id?: string | null;
11630
+ /** Tax group ID for this custom line item. */
11631
+ taxGroupId?: string | null;
11632
+ /** Name of the item or product. */
11633
+ productName?: ProductName$7;
11634
+ /**
11635
+ * 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.
11636
+ * The URL is optional and if not provided, the site URL will be used.
11637
+ */
11638
+ url?: PageUrlV2$2;
11639
+ /** Item type. Either a preset type or custom. */
11640
+ itemType?: ItemType$7;
11641
+ /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
11642
+ fullPrice?: string | null;
11643
+ /**
11644
+ * Optional - Item quantity available for purchase. Only return this if inventory is managed.
11645
+ * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
11646
+ */
11647
+ quantityAvailable?: number | null;
11648
+ /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
11649
+ physicalProperties?: PhysicalProperties$7;
11650
+ /**
11651
+ * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
11652
+ * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
11653
+ * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
11654
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
11655
+ * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
11656
+ */
11657
+ paymentOption?: PaymentOptionType$7;
11658
+ /**
11659
+ * Optional - Service properties. When relevant, this contains information such as date and number of participants.
11660
+ * Used, among other things, when checking for valid memberships.
11661
+ */
11662
+ serviceProperties?: ServiceProperties$3;
11663
+ /**
11664
+ * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
11665
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
11666
+ * + in most cases, this field is the name as `catalogReference.catalogItemId`.
11667
+ * + Used in membership validation.
11668
+ */
11669
+ rootCatalogItemId?: string | null;
11670
+ /**
11671
+ * Optional - partial payment for the given item to be paid upfront during the checkout.
11672
+ * Eligible for catalog items with type `DEPOSIT_ONLINE`.
11673
+ * If omitted - item's price will not be split and is expected to be paid in single installment
11674
+ */
11675
+ depositAmount?: string | null;
11676
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
11677
+ catalogReference?: CatalogReference$7;
11678
+ }
11571
11679
  interface CreateCheckoutResponse$1 {
11572
11680
  /** Newly created checkout. */
11573
11681
  checkout?: Checkout$1;
@@ -11615,6 +11723,8 @@ interface UpdateCheckoutRequest$1 {
11615
11723
  * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
11616
11724
  */
11617
11725
  overrideCheckoutUrl?: string | null;
11726
+ /** Custom line items to be saved on checkout. */
11727
+ customLineItems?: CustomLineItem$5[];
11618
11728
  }
11619
11729
  interface UpdateCheckoutResponse$1 {
11620
11730
  /** Updated checkout. */
@@ -11649,6 +11759,8 @@ interface AddToCheckoutRequest$1 {
11649
11759
  id: string;
11650
11760
  /** Catalog line items. */
11651
11761
  lineItems?: LineItem$1[];
11762
+ /** Custom line items. */
11763
+ customLineItems?: CustomLineItem$5[];
11652
11764
  }
11653
11765
  interface AddToCheckoutResponse$1 {
11654
11766
  /** Updated checkout. */
@@ -12345,6 +12457,12 @@ interface Checkout {
12345
12457
  * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
12346
12458
  */
12347
12459
  customSettings?: CustomSettings;
12460
+ /**
12461
+ * Customize the content of the checkout page.
12462
+ *
12463
+ * Includes IDs for the app and the component providing the content
12464
+ */
12465
+ customContentReference?: CustomContentReference$2;
12348
12466
  }
12349
12467
  interface LineItem {
12350
12468
  /**
@@ -12368,7 +12486,7 @@ interface LineItem {
12368
12486
  * + Events - `ticket.name`
12369
12487
  * @readonly
12370
12488
  */
12371
- productName?: ProductName$4;
12489
+ productName?: ProductName$6;
12372
12490
  /**
12373
12491
  * URL to the item's page on the site.
12374
12492
  * @readonly
@@ -12418,7 +12536,7 @@ interface LineItem {
12418
12536
  * Line item description lines. Used for displaying the cart, checkout and order.
12419
12537
  * @readonly
12420
12538
  */
12421
- descriptionLines?: DescriptionLine$4[];
12539
+ descriptionLines?: DescriptionLine$6[];
12422
12540
  /**
12423
12541
  * Line item image details.
12424
12542
  * @readonly
@@ -12433,12 +12551,12 @@ interface LineItem {
12433
12551
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
12434
12552
  * @readonly
12435
12553
  */
12436
- physicalProperties?: PhysicalProperties$4;
12554
+ physicalProperties?: PhysicalProperties$6;
12437
12555
  /**
12438
12556
  * Item type. Either a preset type or custom.
12439
12557
  * @readonly
12440
12558
  */
12441
- itemType?: ItemType$4;
12559
+ itemType?: ItemType$6;
12442
12560
  /**
12443
12561
  * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
12444
12562
  * + `"FULL_PAYMENT_ONLINE"`: The entire payment for this item happens as part of the checkout.
@@ -12452,7 +12570,7 @@ interface LineItem {
12452
12570
  * Service properties. When relevant, this contains information such as date and number of participants.
12453
12571
  * @readonly
12454
12572
  */
12455
- serviceProperties?: ServiceProperties;
12573
+ serviceProperties?: ServiceProperties$2;
12456
12574
  /**
12457
12575
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
12458
12576
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -12465,7 +12583,7 @@ interface LineItem {
12465
12583
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
12466
12584
  * @readonly
12467
12585
  */
12468
- priceDescription?: PriceDescription$4;
12586
+ priceDescription?: PriceDescription$6;
12469
12587
  /**
12470
12588
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
12471
12589
  * @readonly
@@ -12496,7 +12614,7 @@ interface CatalogReference$6 {
12496
12614
  */
12497
12615
  options?: Record<string, any> | null;
12498
12616
  }
12499
- interface ProductName$4 {
12617
+ interface ProductName$6 {
12500
12618
  /**
12501
12619
  * __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).
12502
12620
  *
@@ -12563,25 +12681,25 @@ declare enum JurisdictionType$4 {
12563
12681
  CITY = "CITY",
12564
12682
  SPECIAL = "SPECIAL"
12565
12683
  }
12566
- interface DescriptionLine$4 extends DescriptionLineValueOneOf$4, DescriptionLineDescriptionLineValueOneOf$4 {
12684
+ interface DescriptionLine$6 extends DescriptionLineValueOneOf$6, DescriptionLineDescriptionLineValueOneOf$6 {
12567
12685
  /** Description line plain text value. */
12568
- plainText?: PlainTextValue$4;
12686
+ plainText?: PlainTextValue$6;
12569
12687
  /** Description line color value. */
12570
- colorInfo?: Color$4;
12688
+ colorInfo?: Color$6;
12571
12689
  /** Description line name. */
12572
- name?: DescriptionLineName$4;
12690
+ name?: DescriptionLineName$6;
12573
12691
  }
12574
12692
  /** @oneof */
12575
- interface DescriptionLineValueOneOf$4 {
12693
+ interface DescriptionLineValueOneOf$6 {
12576
12694
  /** Description line plain text value. */
12577
- plainText?: PlainTextValue$4;
12695
+ plainText?: PlainTextValue$6;
12578
12696
  /** Description line color value. */
12579
- colorInfo?: Color$4;
12697
+ colorInfo?: Color$6;
12580
12698
  }
12581
12699
  /** @oneof */
12582
- interface DescriptionLineDescriptionLineValueOneOf$4 {
12700
+ interface DescriptionLineDescriptionLineValueOneOf$6 {
12583
12701
  }
12584
- interface DescriptionLineName$4 {
12702
+ interface DescriptionLineName$6 {
12585
12703
  /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
12586
12704
  original?: string;
12587
12705
  /**
@@ -12591,7 +12709,7 @@ interface DescriptionLineName$4 {
12591
12709
  */
12592
12710
  translated?: string | null;
12593
12711
  }
12594
- interface PlainTextValue$4 {
12712
+ interface PlainTextValue$6 {
12595
12713
  /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
12596
12714
  original?: string;
12597
12715
  /**
@@ -12601,7 +12719,7 @@ interface PlainTextValue$4 {
12601
12719
  */
12602
12720
  translated?: string | null;
12603
12721
  }
12604
- interface Color$4 {
12722
+ interface Color$6 {
12605
12723
  /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
12606
12724
  original?: string;
12607
12725
  /**
@@ -12637,7 +12755,7 @@ declare enum ItemAvailabilityStatus {
12637
12755
  /** Available quantity is less than requested */
12638
12756
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
12639
12757
  }
12640
- interface PhysicalProperties$4 {
12758
+ interface PhysicalProperties$6 {
12641
12759
  /** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
12642
12760
  weight?: number | null;
12643
12761
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -12645,14 +12763,14 @@ interface PhysicalProperties$4 {
12645
12763
  /** Whether this line item is shippable. */
12646
12764
  shippable?: boolean;
12647
12765
  }
12648
- interface ItemType$4 extends ItemTypeItemTypeDataOneOf$4 {
12766
+ interface ItemType$6 extends ItemTypeItemTypeDataOneOf$6 {
12649
12767
  /** Preset item type. */
12650
12768
  preset?: ItemTypeItemType$6;
12651
12769
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
12652
12770
  custom?: string;
12653
12771
  }
12654
12772
  /** @oneof */
12655
- interface ItemTypeItemTypeDataOneOf$4 {
12773
+ interface ItemTypeItemTypeDataOneOf$6 {
12656
12774
  /** Preset item type. */
12657
12775
  preset?: ItemTypeItemType$6;
12658
12776
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -12694,7 +12812,7 @@ declare enum PaymentOptionType$6 {
12694
12812
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
12695
12813
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
12696
12814
  }
12697
- interface ServiceProperties {
12815
+ interface ServiceProperties$2 {
12698
12816
  /**
12699
12817
  * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
12700
12818
  * For example, the start time of a class.
@@ -12703,7 +12821,7 @@ interface ServiceProperties {
12703
12821
  /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
12704
12822
  numberOfParticipants?: number | null;
12705
12823
  }
12706
- interface PriceDescription$4 {
12824
+ interface PriceDescription$6 {
12707
12825
  /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
12708
12826
  original?: string;
12709
12827
  /**
@@ -13452,6 +13570,20 @@ interface CustomSettings {
13452
13570
  */
13453
13571
  disabledManualPayment?: boolean;
13454
13572
  }
13573
+ interface CustomContentReference$2 {
13574
+ /**
13575
+ * ID of the app providing the content.
13576
+ *
13577
+ * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
13578
+ */
13579
+ appId?: string;
13580
+ /**
13581
+ * ID of the component within the app it belongs to.
13582
+ *
13583
+ * You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
13584
+ */
13585
+ componentId?: string;
13586
+ }
13455
13587
  interface CreateCheckoutRequest {
13456
13588
  /** Checkout information. */
13457
13589
  checkoutInfo?: Checkout;
@@ -13459,6 +13591,8 @@ interface CreateCheckoutRequest {
13459
13591
  couponCode?: string | null;
13460
13592
  /** Line items to be added to checkout. */
13461
13593
  lineItems?: LineItem[];
13594
+ /** Custom line items to be added to checkout. */
13595
+ customLineItems?: CustomLineItem$4[];
13462
13596
  /**
13463
13597
  * **Required**
13464
13598
  * Sales channel type.
@@ -13479,6 +13613,80 @@ interface CreateCheckoutRequest {
13479
13613
  */
13480
13614
  overrideCheckoutUrl?: string | null;
13481
13615
  }
13616
+ interface CustomLineItem$4 {
13617
+ /**
13618
+ * Custom line item quantity.
13619
+ *
13620
+ * Min: `1`
13621
+ * Max: `100000`
13622
+ */
13623
+ quantity?: number;
13624
+ /** Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend. */
13625
+ price?: string;
13626
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
13627
+ priceDescription?: PriceDescription$6;
13628
+ /** Custom line item description lines. Used for displaying the cart, checkout and order. */
13629
+ descriptionLines?: DescriptionLine$6[];
13630
+ /**
13631
+ * Custom line item media.
13632
+ * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
13633
+ * + An image from the web - `"http(s)://<image url>"`.
13634
+ */
13635
+ media?: string;
13636
+ /**
13637
+ * Custom line item ID. If passed, `id` must be unique.
13638
+ * Default: auto-generated ID.
13639
+ */
13640
+ _id?: string | null;
13641
+ /** Tax group ID for this custom line item. */
13642
+ taxGroupId?: string | null;
13643
+ /** Name of the item or product. */
13644
+ productName?: ProductName$6;
13645
+ /**
13646
+ * 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.
13647
+ * The URL is optional and if not provided, the site URL will be used.
13648
+ */
13649
+ url?: string;
13650
+ /** Item type. Either a preset type or custom. */
13651
+ itemType?: ItemType$6;
13652
+ /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
13653
+ fullPrice?: string | null;
13654
+ /**
13655
+ * Optional - Item quantity available for purchase. Only return this if inventory is managed.
13656
+ * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
13657
+ */
13658
+ quantityAvailable?: number | null;
13659
+ /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
13660
+ physicalProperties?: PhysicalProperties$6;
13661
+ /**
13662
+ * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
13663
+ * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
13664
+ * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
13665
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
13666
+ * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
13667
+ */
13668
+ paymentOption?: PaymentOptionType$6;
13669
+ /**
13670
+ * Optional - Service properties. When relevant, this contains information such as date and number of participants.
13671
+ * Used, among other things, when checking for valid memberships.
13672
+ */
13673
+ serviceProperties?: ServiceProperties$2;
13674
+ /**
13675
+ * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
13676
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
13677
+ * + in most cases, this field is the name as `catalogReference.catalogItemId`.
13678
+ * + Used in membership validation.
13679
+ */
13680
+ rootCatalogItemId?: string | null;
13681
+ /**
13682
+ * Optional - partial payment for the given item to be paid upfront during the checkout.
13683
+ * Eligible for catalog items with type `DEPOSIT_ONLINE`.
13684
+ * If omitted - item's price will not be split and is expected to be paid in single installment
13685
+ */
13686
+ depositAmount?: string | null;
13687
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
13688
+ catalogReference?: CatalogReference$6;
13689
+ }
13482
13690
  interface CreateCheckoutResponse {
13483
13691
  /** Newly created checkout. */
13484
13692
  checkout?: Checkout;
@@ -13520,6 +13728,8 @@ interface UpdateCheckoutRequest {
13520
13728
  * 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`.
13521
13729
  */
13522
13730
  overrideCheckoutUrl?: string | null;
13731
+ /** Custom line items to be saved on checkout. */
13732
+ customLineItems?: CustomLineItem$4[];
13523
13733
  }
13524
13734
  interface UpdateCheckoutResponse {
13525
13735
  /** Updated checkout. */
@@ -13554,6 +13764,8 @@ interface AddToCheckoutRequest {
13554
13764
  _id: string;
13555
13765
  /** Catalog line items. */
13556
13766
  lineItems?: LineItem[];
13767
+ /** Custom line items. */
13768
+ customLineItems?: CustomLineItem$4[];
13557
13769
  }
13558
13770
  interface AddToCheckoutResponse {
13559
13771
  /** Updated checkout. */
@@ -14534,6 +14746,12 @@ interface CheckoutTemplate$1 {
14534
14746
  * Max: 300 items
14535
14747
  */
14536
14748
  lineItems?: V1LineItem$1[];
14749
+ /**
14750
+ * Custom line items.
14751
+ *
14752
+ * Max: 300 items
14753
+ */
14754
+ customLineItems?: CustomLineItem$3[];
14537
14755
  /**
14538
14756
  * Coupon code.
14539
14757
  *
@@ -14541,6 +14759,12 @@ interface CheckoutTemplate$1 {
14541
14759
  * For additional information, see the [Coupons API](https://dev.wix.com/docs/rest/api-reference/coupons/coupons/introduction).
14542
14760
  */
14543
14761
  couponCode?: string | null;
14762
+ /**
14763
+ * Customize the content of the checkout page.
14764
+ *
14765
+ * Includes IDs for the app and the component providing the content
14766
+ */
14767
+ customContentReference?: CustomContentReference$1;
14544
14768
  }
14545
14769
  declare enum Status$3 {
14546
14770
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
@@ -14620,21 +14844,211 @@ interface CatalogReference$5 {
14620
14844
  */
14621
14845
  options?: Record<string, any> | null;
14622
14846
  }
14623
- declare enum DescriptionLineType$5 {
14624
- UNRECOGNISED = "UNRECOGNISED",
14625
- PLAIN_TEXT = "PLAIN_TEXT",
14626
- COLOR = "COLOR"
14627
- }
14628
- declare enum ItemTypeItemType$5 {
14629
- UNRECOGNISED = "UNRECOGNISED",
14630
- PHYSICAL = "PHYSICAL",
14631
- DIGITAL = "DIGITAL",
14632
- GIFT_CARD = "GIFT_CARD",
14633
- SERVICE = "SERVICE"
14634
- }
14635
- /** Frequency unit of recurring payment */
14636
- declare enum SubscriptionFrequency$5 {
14637
- UNDEFINED = "UNDEFINED",
14847
+ interface ProductName$5 {
14848
+ /**
14849
+ * __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).
14850
+ *
14851
+ * Min: 1 character.
14852
+ * Max: 200 characters.
14853
+ */
14854
+ original?: string;
14855
+ /**
14856
+ * Item name translated into the buyer's language.
14857
+ *
14858
+ * Min: 1 character.
14859
+ * Max: 400 characters.
14860
+ * Default: Same as `original`.
14861
+ */
14862
+ translated?: string | null;
14863
+ }
14864
+ interface DescriptionLine$5 extends DescriptionLineValueOneOf$5, DescriptionLineDescriptionLineValueOneOf$5 {
14865
+ /** Description line plain text value. */
14866
+ plainText?: PlainTextValue$5;
14867
+ /** Description line color value. */
14868
+ colorInfo?: Color$5;
14869
+ /** Description line name. */
14870
+ name?: DescriptionLineName$5;
14871
+ }
14872
+ /** @oneof */
14873
+ interface DescriptionLineValueOneOf$5 {
14874
+ /** Description line plain text value. */
14875
+ plainText?: PlainTextValue$5;
14876
+ /** Description line color value. */
14877
+ colorInfo?: Color$5;
14878
+ }
14879
+ /** @oneof */
14880
+ interface DescriptionLineDescriptionLineValueOneOf$5 {
14881
+ }
14882
+ interface DescriptionLineName$5 {
14883
+ /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
14884
+ original?: string;
14885
+ /**
14886
+ * Description line name translated into the buyer's language.
14887
+ *
14888
+ * Default: Same as `original`.
14889
+ */
14890
+ translated?: string | null;
14891
+ }
14892
+ interface PlainTextValue$5 {
14893
+ /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
14894
+ original?: string;
14895
+ /**
14896
+ * Description line plain text value translated into the buyer's language.
14897
+ *
14898
+ * Default: Same as `original`.
14899
+ */
14900
+ translated?: string | null;
14901
+ }
14902
+ interface Color$5 {
14903
+ /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
14904
+ original?: string;
14905
+ /**
14906
+ * Description line color name translated into the buyer's language.
14907
+ *
14908
+ * Default: Same as `original`.
14909
+ */
14910
+ translated?: string | null;
14911
+ /** HEX or RGB color code for display. */
14912
+ code?: string | null;
14913
+ }
14914
+ declare enum DescriptionLineType$5 {
14915
+ UNRECOGNISED = "UNRECOGNISED",
14916
+ PLAIN_TEXT = "PLAIN_TEXT",
14917
+ COLOR = "COLOR"
14918
+ }
14919
+ interface PhysicalProperties$5 {
14920
+ /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
14921
+ weight?: number | null;
14922
+ /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
14923
+ sku?: string | null;
14924
+ /** Whether this line item is shippable. */
14925
+ shippable?: boolean;
14926
+ }
14927
+ interface Image$3 {
14928
+ /** WixMedia image ID. */
14929
+ id?: string;
14930
+ /** Original image height. */
14931
+ height?: number;
14932
+ /** Original image width. */
14933
+ width?: number;
14934
+ /** Image alt text. Optional. */
14935
+ altText?: string | null;
14936
+ /** Image filename. Optional. */
14937
+ filename?: string | null;
14938
+ }
14939
+ interface CustomLineItem$3 {
14940
+ /**
14941
+ * Custom line item quantity.
14942
+ *
14943
+ * Min: `1`
14944
+ * Max: `100000`
14945
+ */
14946
+ quantity?: number;
14947
+ /**
14948
+ * Custom line item price.
14949
+ *
14950
+ * Must be a number or a decimal without symbols.
14951
+ */
14952
+ price?: string;
14953
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
14954
+ priceDescription?: PriceDescription$5;
14955
+ /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
14956
+ descriptionLines?: DescriptionLine$5[];
14957
+ /** Custom line item's media. */
14958
+ media?: Image$3;
14959
+ /**
14960
+ * Custom line item ID. If passed, `id` must be unique.
14961
+ * Default: auto-generated ID.
14962
+ */
14963
+ id?: string | null;
14964
+ /** Tax group ID for this custom line item. */
14965
+ taxGroupId?: string | null;
14966
+ /** Name of the item or product. */
14967
+ productName?: ProductName$5;
14968
+ /**
14969
+ * 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.
14970
+ * The URL is optional and if not provided, the site URL will be used.
14971
+ */
14972
+ url?: PageUrlV2$1;
14973
+ /** Item type. Either a preset type or custom. */
14974
+ itemType?: ItemType$5;
14975
+ /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
14976
+ fullPrice?: string | null;
14977
+ /**
14978
+ * Optional - Item quantity available for purchase. Only return this if inventory is managed.
14979
+ * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
14980
+ */
14981
+ quantityAvailable?: number | null;
14982
+ /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
14983
+ physicalProperties?: PhysicalProperties$5;
14984
+ /**
14985
+ * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
14986
+ * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
14987
+ * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
14988
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
14989
+ * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
14990
+ */
14991
+ paymentOption?: PaymentOptionType$5;
14992
+ /**
14993
+ * Optional - Service properties. When relevant, this contains information such as date and number of participants.
14994
+ * Used, among other things, when checking for valid memberships.
14995
+ */
14996
+ serviceProperties?: ServiceProperties$1;
14997
+ /**
14998
+ * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
14999
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
15000
+ * + in most cases, this field is the name as `catalogReference.catalogItemId`.
15001
+ * + Used in membership validation.
15002
+ */
15003
+ rootCatalogItemId?: string | null;
15004
+ /**
15005
+ * Optional - partial payment for the given item to be paid upfront during the checkout.
15006
+ * Eligible for catalog items with type `DEPOSIT_ONLINE`.
15007
+ * If omitted - item's price will not be split and is expected to be paid in single installment
15008
+ */
15009
+ depositAmount?: string | null;
15010
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
15011
+ catalogReference?: CatalogReference$5;
15012
+ }
15013
+ interface PriceDescription$5 {
15014
+ /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
15015
+ original?: string;
15016
+ /**
15017
+ * Price description translated into the buyer's language.
15018
+ *
15019
+ * Default: Same as `original`.
15020
+ */
15021
+ translated?: string | null;
15022
+ }
15023
+ interface PageUrlV2$1 {
15024
+ /** The relative path for the page within the site. For example, `/product-page/a-product`. */
15025
+ relativePath?: string;
15026
+ /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
15027
+ url?: string | null;
15028
+ }
15029
+ interface ItemType$5 extends ItemTypeItemTypeDataOneOf$5 {
15030
+ /** Preset item type. */
15031
+ preset?: ItemTypeItemType$5;
15032
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
15033
+ custom?: string;
15034
+ }
15035
+ /** @oneof */
15036
+ interface ItemTypeItemTypeDataOneOf$5 {
15037
+ /** Preset item type. */
15038
+ preset?: ItemTypeItemType$5;
15039
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
15040
+ custom?: string;
15041
+ }
15042
+ declare enum ItemTypeItemType$5 {
15043
+ UNRECOGNISED = "UNRECOGNISED",
15044
+ PHYSICAL = "PHYSICAL",
15045
+ DIGITAL = "DIGITAL",
15046
+ GIFT_CARD = "GIFT_CARD",
15047
+ SERVICE = "SERVICE"
15048
+ }
15049
+ /** Frequency unit of recurring payment */
15050
+ declare enum SubscriptionFrequency$5 {
15051
+ UNDEFINED = "UNDEFINED",
14638
15052
  DAY = "DAY",
14639
15053
  WEEK = "WEEK",
14640
15054
  MONTH = "MONTH",
@@ -14661,6 +15075,29 @@ declare enum PaymentOptionType$5 {
14661
15075
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
14662
15076
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
14663
15077
  }
15078
+ interface ServiceProperties$1 {
15079
+ /**
15080
+ * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
15081
+ * For example, the start time of a class.
15082
+ */
15083
+ scheduledDate?: Date;
15084
+ /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
15085
+ numberOfParticipants?: number | null;
15086
+ }
15087
+ interface CustomContentReference$1 {
15088
+ /**
15089
+ * ID of the app providing the content.
15090
+ *
15091
+ * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
15092
+ */
15093
+ appId?: string;
15094
+ /**
15095
+ * ID of the component within the app it belongs to.
15096
+ *
15097
+ * You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
15098
+ */
15099
+ componentId?: string;
15100
+ }
14664
15101
  interface CreateCheckoutTemplateRequest$1 {
14665
15102
  /** Checkout template to create. */
14666
15103
  checkoutTemplate: CheckoutTemplate$1;
@@ -14954,6 +15391,12 @@ interface CheckoutTemplate {
14954
15391
  * Max: 300 items
14955
15392
  */
14956
15393
  lineItems?: V1LineItem[];
15394
+ /**
15395
+ * Custom line items.
15396
+ *
15397
+ * Max: 300 items
15398
+ */
15399
+ customLineItems?: CustomLineItem$2[];
14957
15400
  /**
14958
15401
  * Coupon code.
14959
15402
  *
@@ -14961,6 +15404,12 @@ interface CheckoutTemplate {
14961
15404
  * For additional information, see the Coupons API.
14962
15405
  */
14963
15406
  couponCode?: string | null;
15407
+ /**
15408
+ * Customize the content of the checkout page.
15409
+ *
15410
+ * Includes IDs for the app and the component providing the content
15411
+ */
15412
+ customContentReference?: CustomContentReference;
14964
15413
  }
14965
15414
  declare enum Status$2 {
14966
15415
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
@@ -15040,11 +15489,183 @@ interface CatalogReference$4 {
15040
15489
  */
15041
15490
  options?: Record<string, any> | null;
15042
15491
  }
15492
+ interface ProductName$4 {
15493
+ /**
15494
+ * __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).
15495
+ *
15496
+ * Min: 1 character.
15497
+ * Max: 200 characters.
15498
+ */
15499
+ original?: string;
15500
+ /**
15501
+ * Item name translated into the buyer's language.
15502
+ *
15503
+ * Min: 1 character.
15504
+ * Max: 400 characters.
15505
+ * Default: Same as `original`.
15506
+ */
15507
+ translated?: string | null;
15508
+ }
15509
+ interface DescriptionLine$4 extends DescriptionLineValueOneOf$4, DescriptionLineDescriptionLineValueOneOf$4 {
15510
+ /** Description line plain text value. */
15511
+ plainText?: PlainTextValue$4;
15512
+ /** Description line color value. */
15513
+ colorInfo?: Color$4;
15514
+ /** Description line name. */
15515
+ name?: DescriptionLineName$4;
15516
+ }
15517
+ /** @oneof */
15518
+ interface DescriptionLineValueOneOf$4 {
15519
+ /** Description line plain text value. */
15520
+ plainText?: PlainTextValue$4;
15521
+ /** Description line color value. */
15522
+ colorInfo?: Color$4;
15523
+ }
15524
+ /** @oneof */
15525
+ interface DescriptionLineDescriptionLineValueOneOf$4 {
15526
+ }
15527
+ interface DescriptionLineName$4 {
15528
+ /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
15529
+ original?: string;
15530
+ /**
15531
+ * Description line name translated into the buyer's language.
15532
+ *
15533
+ * Default: Same as `original`.
15534
+ */
15535
+ translated?: string | null;
15536
+ }
15537
+ interface PlainTextValue$4 {
15538
+ /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
15539
+ original?: string;
15540
+ /**
15541
+ * Description line plain text value translated into the buyer's language.
15542
+ *
15543
+ * Default: Same as `original`.
15544
+ */
15545
+ translated?: string | null;
15546
+ }
15547
+ interface Color$4 {
15548
+ /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
15549
+ original?: string;
15550
+ /**
15551
+ * Description line color name translated into the buyer's language.
15552
+ *
15553
+ * Default: Same as `original`.
15554
+ */
15555
+ translated?: string | null;
15556
+ /** HEX or RGB color code for display. */
15557
+ code?: string | null;
15558
+ }
15043
15559
  declare enum DescriptionLineType$4 {
15044
15560
  UNRECOGNISED = "UNRECOGNISED",
15045
15561
  PLAIN_TEXT = "PLAIN_TEXT",
15046
15562
  COLOR = "COLOR"
15047
15563
  }
15564
+ interface PhysicalProperties$4 {
15565
+ /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
15566
+ weight?: number | null;
15567
+ /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
15568
+ sku?: string | null;
15569
+ /** Whether this line item is shippable. */
15570
+ shippable?: boolean;
15571
+ }
15572
+ interface CustomLineItem$2 {
15573
+ /**
15574
+ * Custom line item quantity.
15575
+ *
15576
+ * Min: `1`
15577
+ * Max: `100000`
15578
+ */
15579
+ quantity?: number;
15580
+ /**
15581
+ * Custom line item price.
15582
+ *
15583
+ * Must be a number or a decimal without symbols.
15584
+ */
15585
+ price?: string;
15586
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
15587
+ priceDescription?: PriceDescription$4;
15588
+ /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
15589
+ descriptionLines?: DescriptionLine$4[];
15590
+ /** Custom line item's media. */
15591
+ media?: string;
15592
+ /**
15593
+ * Custom line item ID. If passed, `id` must be unique.
15594
+ * Default: auto-generated ID.
15595
+ */
15596
+ _id?: string | null;
15597
+ /** Tax group ID for this custom line item. */
15598
+ taxGroupId?: string | null;
15599
+ /** Name of the item or product. */
15600
+ productName?: ProductName$4;
15601
+ /**
15602
+ * 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.
15603
+ * The URL is optional and if not provided, the site URL will be used.
15604
+ */
15605
+ url?: string;
15606
+ /** Item type. Either a preset type or custom. */
15607
+ itemType?: ItemType$4;
15608
+ /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
15609
+ fullPrice?: string | null;
15610
+ /**
15611
+ * Optional - Item quantity available for purchase. Only return this if inventory is managed.
15612
+ * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
15613
+ */
15614
+ quantityAvailable?: number | null;
15615
+ /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
15616
+ physicalProperties?: PhysicalProperties$4;
15617
+ /**
15618
+ * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
15619
+ * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
15620
+ * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
15621
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
15622
+ * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
15623
+ */
15624
+ paymentOption?: PaymentOptionType$4;
15625
+ /**
15626
+ * Optional - Service properties. When relevant, this contains information such as date and number of participants.
15627
+ * Used, among other things, when checking for valid memberships.
15628
+ */
15629
+ serviceProperties?: ServiceProperties;
15630
+ /**
15631
+ * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
15632
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
15633
+ * + in most cases, this field is the name as `catalogReference.catalogItemId`.
15634
+ * + Used in membership validation.
15635
+ */
15636
+ rootCatalogItemId?: string | null;
15637
+ /**
15638
+ * Optional - partial payment for the given item to be paid upfront during the checkout.
15639
+ * Eligible for catalog items with type `DEPOSIT_ONLINE`.
15640
+ * If omitted - item's price will not be split and is expected to be paid in single installment
15641
+ */
15642
+ depositAmount?: string | null;
15643
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
15644
+ catalogReference?: CatalogReference$4;
15645
+ }
15646
+ interface PriceDescription$4 {
15647
+ /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
15648
+ original?: string;
15649
+ /**
15650
+ * Price description translated into the buyer's language.
15651
+ *
15652
+ * Default: Same as `original`.
15653
+ */
15654
+ translated?: string | null;
15655
+ }
15656
+ interface ItemType$4 extends ItemTypeItemTypeDataOneOf$4 {
15657
+ /** Preset item type. */
15658
+ preset?: ItemTypeItemType$4;
15659
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
15660
+ custom?: string;
15661
+ }
15662
+ /** @oneof */
15663
+ interface ItemTypeItemTypeDataOneOf$4 {
15664
+ /** Preset item type. */
15665
+ preset?: ItemTypeItemType$4;
15666
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
15667
+ custom?: string;
15668
+ }
15048
15669
  declare enum ItemTypeItemType$4 {
15049
15670
  UNRECOGNISED = "UNRECOGNISED",
15050
15671
  PHYSICAL = "PHYSICAL",
@@ -15081,6 +15702,29 @@ declare enum PaymentOptionType$4 {
15081
15702
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
15082
15703
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
15083
15704
  }
15705
+ interface ServiceProperties {
15706
+ /**
15707
+ * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
15708
+ * For example, the start time of a class.
15709
+ */
15710
+ scheduledDate?: Date;
15711
+ /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
15712
+ numberOfParticipants?: number | null;
15713
+ }
15714
+ interface CustomContentReference {
15715
+ /**
15716
+ * ID of the app providing the content.
15717
+ *
15718
+ * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
15719
+ */
15720
+ appId?: string;
15721
+ /**
15722
+ * ID of the component within the app it belongs to.
15723
+ *
15724
+ * You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
15725
+ */
15726
+ componentId?: string;
15727
+ }
15084
15728
  interface CreateCheckoutTemplateRequest {
15085
15729
  /** Checkout template to create. */
15086
15730
  checkoutTemplate: CheckoutTemplate;