@wix/ecom 1.0.687 → 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$3;
2126
+ image?: Image$7;
2127
2127
  }
2128
- interface Image$3 {
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,6 +3194,18 @@ interface SelectedMembership$5 {
3194
3194
  /** ID of the app providing this payment option. */
3195
3195
  appId?: string;
3196
3196
  }
3197
+ interface Image$6 {
3198
+ /** WixMedia image ID. */
3199
+ id?: string;
3200
+ /** Original image height. */
3201
+ height?: number;
3202
+ /** Original image width. */
3203
+ width?: number;
3204
+ /** Image alt text. Optional. */
3205
+ altText?: string | null;
3206
+ /** Image filename. Optional. */
3207
+ filename?: string | null;
3208
+ }
3197
3209
  /** Buyer Info */
3198
3210
  interface BuyerInfo$9 extends BuyerInfoIdOneOf$9 {
3199
3211
  /**
@@ -3353,6 +3365,8 @@ interface UpdateCartRequest$3 {
3353
3365
  merchantDiscounts?: MerchantDiscountInput$3[];
3354
3366
  /** Catalog line items. */
3355
3367
  lineItems?: LineItem$5[];
3368
+ /** Custom line items. */
3369
+ customLineItems?: CustomLineItem$9[];
3356
3370
  }
3357
3371
  interface MerchantDiscountInput$3 {
3358
3372
  /** Discount amount. */
@@ -3360,6 +3374,80 @@ interface MerchantDiscountInput$3 {
3360
3374
  /** IDs of line items the discount applies to. */
3361
3375
  lineItemIds?: string[];
3362
3376
  }
3377
+ interface CustomLineItem$9 {
3378
+ /**
3379
+ * Custom line item quantity.
3380
+ *
3381
+ * Min: `1`
3382
+ * Max: `100000`
3383
+ */
3384
+ quantity?: number;
3385
+ /**
3386
+ * Custom line item price.
3387
+ *
3388
+ * Must be a number or a decimal without symbols.
3389
+ */
3390
+ price?: string;
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$b;
3393
+ /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
3394
+ descriptionLines?: DescriptionLine$b[];
3395
+ /** Custom line item's media. */
3396
+ media?: Image$6;
3397
+ /**
3398
+ * Custom line item ID. If passed, `id` must be unique.
3399
+ * Default: auto-generated ID.
3400
+ */
3401
+ id?: string | null;
3402
+ /** Tax group ID for this custom line item. */
3403
+ taxGroupId?: string | null;
3404
+ /** Name of the item or product. */
3405
+ productName?: ProductName$b;
3406
+ /**
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
+ * The URL is optional and if not provided, the site URL will be used.
3409
+ */
3410
+ url?: PageUrlV2$4;
3411
+ /** Item type. Either a preset type or custom. */
3412
+ itemType?: ItemType$b;
3413
+ /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
3414
+ fullPrice?: string | null;
3415
+ /**
3416
+ * Optional - Item quantity available for purchase. Only return this if inventory is managed.
3417
+ * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
3418
+ */
3419
+ quantityAvailable?: number | null;
3420
+ /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
3421
+ physicalProperties?: PhysicalProperties$b;
3422
+ /**
3423
+ * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
3424
+ * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
3425
+ * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
3426
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
3427
+ * + `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.
3428
+ */
3429
+ paymentOption?: PaymentOptionType$b;
3430
+ /**
3431
+ * Optional - Service properties. When relevant, this contains information such as date and number of participants.
3432
+ * Used, among other things, when checking for valid memberships.
3433
+ */
3434
+ serviceProperties?: ServiceProperties$7;
3435
+ /**
3436
+ * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
3437
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
3438
+ * + in most cases, this field is the name as `catalogReference.catalogItemId`.
3439
+ * + Used in membership validation.
3440
+ */
3441
+ rootCatalogItemId?: string | null;
3442
+ /**
3443
+ * Optional - partial payment for the given item to be paid upfront during the checkout.
3444
+ * Eligible for catalog items with type `DEPOSIT_ONLINE`.
3445
+ * If omitted - item's price will not be split and is expected to be paid in single installment
3446
+ */
3447
+ depositAmount?: string | null;
3448
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
3449
+ catalogReference?: CatalogReference$b;
3450
+ }
3363
3451
  interface UpdateCartResponse$3 {
3364
3452
  /** Updated Cart. */
3365
3453
  cart?: Cart$3;
@@ -4054,6 +4142,8 @@ interface CreateCartRequest$1 {
4054
4142
  merchantDiscounts?: MerchantDiscountInput$3[];
4055
4143
  /** Catalog line items. */
4056
4144
  lineItems?: LineItem$5[];
4145
+ /** Custom line items. */
4146
+ customLineItems?: CustomLineItem$9[];
4057
4147
  }
4058
4148
  interface CreateCartResponse$1 {
4059
4149
  /** Cart. */
@@ -4072,6 +4162,8 @@ interface AddToCartRequest$1 {
4072
4162
  id: string;
4073
4163
  /** Catalog line items. */
4074
4164
  lineItems?: LineItem$5[];
4165
+ /** Custom line items. */
4166
+ customLineItems?: CustomLineItem$9[];
4075
4167
  }
4076
4168
  interface RemoveLineItemsRequest$3 {
4077
4169
  /** Cart ID. */
@@ -4671,7 +4763,7 @@ interface LineItem$4 {
4671
4763
  * + Events - `ticket.name`
4672
4764
  * @readonly
4673
4765
  */
4674
- productName?: ProductName$8;
4766
+ productName?: ProductName$a;
4675
4767
  /**
4676
4768
  * URL to the item's page on the site.
4677
4769
  * @readonly
@@ -4696,7 +4788,7 @@ interface LineItem$4 {
4696
4788
  * Line item description lines. Used for displaying the cart, checkout and order.
4697
4789
  * @readonly
4698
4790
  */
4699
- descriptionLines?: DescriptionLine$8[];
4791
+ descriptionLines?: DescriptionLine$a[];
4700
4792
  /**
4701
4793
  * Line item image details.
4702
4794
  * @readonly
@@ -4711,12 +4803,12 @@ interface LineItem$4 {
4711
4803
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
4712
4804
  * @readonly
4713
4805
  */
4714
- physicalProperties?: PhysicalProperties$8;
4806
+ physicalProperties?: PhysicalProperties$a;
4715
4807
  /**
4716
4808
  * Item type. Either a preset type or custom.
4717
4809
  * @readonly
4718
4810
  */
4719
- itemType?: ItemType$8;
4811
+ itemType?: ItemType$a;
4720
4812
  /**
4721
4813
  * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
4722
4814
  * + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item happens as part of the checkout.
@@ -4729,7 +4821,7 @@ interface LineItem$4 {
4729
4821
  * Service properties. When relevant, this contains information such as date and number of participants.
4730
4822
  * @readonly
4731
4823
  */
4732
- serviceProperties?: ServiceProperties$4;
4824
+ serviceProperties?: ServiceProperties$6;
4733
4825
  /**
4734
4826
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
4735
4827
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -4742,7 +4834,7 @@ interface LineItem$4 {
4742
4834
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
4743
4835
  * @readonly
4744
4836
  */
4745
- priceDescription?: PriceDescription$8;
4837
+ priceDescription?: PriceDescription$a;
4746
4838
  /**
4747
4839
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
4748
4840
  * @readonly
@@ -4780,7 +4872,7 @@ interface CatalogReference$a {
4780
4872
  */
4781
4873
  options?: Record<string, any> | null;
4782
4874
  }
4783
- interface ProductName$8 {
4875
+ interface ProductName$a {
4784
4876
  /** **Required** - Original product name (in site's default language). */
4785
4877
  original?: string;
4786
4878
  /** Description product name translated into buyer's language. Defaults to `original` when not defined. */
@@ -4805,37 +4897,37 @@ interface MultiCurrencyPrice$4 {
4805
4897
  */
4806
4898
  formattedConvertedAmount?: string;
4807
4899
  }
4808
- interface DescriptionLine$8 extends DescriptionLineValueOneOf$8, DescriptionLineDescriptionLineValueOneOf$8 {
4900
+ interface DescriptionLine$a extends DescriptionLineValueOneOf$a, DescriptionLineDescriptionLineValueOneOf$a {
4809
4901
  /** Description line plain text value. */
4810
- plainText?: PlainTextValue$8;
4902
+ plainText?: PlainTextValue$a;
4811
4903
  /** Description line color value. */
4812
- colorInfo?: Color$8;
4904
+ colorInfo?: Color$a;
4813
4905
  /** Description line name. */
4814
- name?: DescriptionLineName$8;
4906
+ name?: DescriptionLineName$a;
4815
4907
  }
4816
4908
  /** @oneof */
4817
- interface DescriptionLineValueOneOf$8 {
4909
+ interface DescriptionLineValueOneOf$a {
4818
4910
  /** Description line plain text value. */
4819
- plainText?: PlainTextValue$8;
4911
+ plainText?: PlainTextValue$a;
4820
4912
  /** Description line color value. */
4821
- colorInfo?: Color$8;
4913
+ colorInfo?: Color$a;
4822
4914
  }
4823
4915
  /** @oneof */
4824
- interface DescriptionLineDescriptionLineValueOneOf$8 {
4916
+ interface DescriptionLineDescriptionLineValueOneOf$a {
4825
4917
  }
4826
- interface DescriptionLineName$8 {
4918
+ interface DescriptionLineName$a {
4827
4919
  /** Description line name in site's default language. */
4828
4920
  original?: string;
4829
4921
  /** Description line name translated into buyer's language. Defaults to `original` when not defined. */
4830
4922
  translated?: string | null;
4831
4923
  }
4832
- interface PlainTextValue$8 {
4924
+ interface PlainTextValue$a {
4833
4925
  /** Description line plain text value in site's default language. */
4834
4926
  original?: string;
4835
4927
  /** Description line plain text value translated into buyer's language. Defaults to `original` when not defined. */
4836
4928
  translated?: string | null;
4837
4929
  }
4838
- interface Color$8 {
4930
+ interface Color$a {
4839
4931
  /** Description line color name in site's default language. */
4840
4932
  original?: string;
4841
4933
  /** Description line color name translated into buyer's language. Defaults to `original` when not defined. */
@@ -4871,7 +4963,7 @@ declare enum ItemAvailabilityStatus$4 {
4871
4963
  /** Available quantity is less than requested */
4872
4964
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
4873
4965
  }
4874
- interface PhysicalProperties$8 {
4966
+ interface PhysicalProperties$a {
4875
4967
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
4876
4968
  weight?: number | null;
4877
4969
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -4879,14 +4971,14 @@ interface PhysicalProperties$8 {
4879
4971
  /** Whether this line item is shippable. */
4880
4972
  shippable?: boolean;
4881
4973
  }
4882
- interface ItemType$8 extends ItemTypeItemTypeDataOneOf$8 {
4974
+ interface ItemType$a extends ItemTypeItemTypeDataOneOf$a {
4883
4975
  /** Preset item type. */
4884
4976
  preset?: ItemTypeItemType$a;
4885
4977
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
4886
4978
  custom?: string;
4887
4979
  }
4888
4980
  /** @oneof */
4889
- interface ItemTypeItemTypeDataOneOf$8 {
4981
+ interface ItemTypeItemTypeDataOneOf$a {
4890
4982
  /** Preset item type. */
4891
4983
  preset?: ItemTypeItemType$a;
4892
4984
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -4928,13 +5020,13 @@ declare enum PaymentOptionType$a {
4928
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`. */
4929
5021
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
4930
5022
  }
4931
- interface ServiceProperties$4 {
5023
+ interface ServiceProperties$6 {
4932
5024
  /** The date and time for which the service is supposed to be provided. For example, the time of the class. */
4933
5025
  scheduledDate?: Date;
4934
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. */
4935
5027
  numberOfParticipants?: number | null;
4936
5028
  }
4937
- interface PriceDescription$8 {
5029
+ interface PriceDescription$a {
4938
5030
  /**
4939
5031
  * **Required** - Original price description (in site's default language).
4940
5032
  *
@@ -5099,6 +5191,8 @@ interface UpdateCartRequest$2 {
5099
5191
  merchantDiscounts?: MerchantDiscountInput$2[];
5100
5192
  /** Catalog line items. */
5101
5193
  lineItems?: LineItem$4[];
5194
+ /** Custom line items. */
5195
+ customLineItems?: CustomLineItem$8[];
5102
5196
  }
5103
5197
  interface MerchantDiscountInput$2 {
5104
5198
  /** Discount amount. */
@@ -5106,6 +5200,84 @@ interface MerchantDiscountInput$2 {
5106
5200
  /** IDs of the line items the discount applies to. */
5107
5201
  lineItemIds?: string[];
5108
5202
  }
5203
+ interface CustomLineItem$8 {
5204
+ /**
5205
+ * Custom line item quantity.
5206
+ *
5207
+ * Min: `1`
5208
+ * Max: `100000`
5209
+ */
5210
+ quantity?: number;
5211
+ /**
5212
+ * Custom line item price.
5213
+ *
5214
+ * Must be a number or a decimal without symbols.
5215
+ */
5216
+ price?: string;
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$a;
5219
+ /** Custom line item description lines. Used for displaying the cart, checkout and order. */
5220
+ descriptionLines?: DescriptionLine$a[];
5221
+ /**
5222
+ * Custom line item media. Supported formats:
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"`.
5224
+ * + An image from the web - `"http(s)://<image url>"`.
5225
+ */
5226
+ media?: string;
5227
+ /**
5228
+ * Custom line item ID. If passed, `id` must be unique.
5229
+ * Default: auto-generated ID.
5230
+ */
5231
+ _id?: string | null;
5232
+ /** Tax group ID for this custom line item. */
5233
+ taxGroupId?: string | null;
5234
+ /** Name of the item or product. */
5235
+ productName?: ProductName$a;
5236
+ /**
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
+ * The URL is optional and if not provided, the site URL will be used.
5239
+ */
5240
+ url?: string;
5241
+ /** Item type. Either a preset type or custom. */
5242
+ itemType?: ItemType$a;
5243
+ /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
5244
+ fullPrice?: string | null;
5245
+ /**
5246
+ * Optional - Item quantity available for purchase. Only return this if inventory is managed.
5247
+ * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
5248
+ */
5249
+ quantityAvailable?: number | null;
5250
+ /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
5251
+ physicalProperties?: PhysicalProperties$a;
5252
+ /**
5253
+ * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
5254
+ * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
5255
+ * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
5256
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
5257
+ * + `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.
5258
+ */
5259
+ paymentOption?: PaymentOptionType$a;
5260
+ /**
5261
+ * Optional - Service properties. When relevant, this contains information such as date and number of participants.
5262
+ * Used, among other things, when checking for valid memberships.
5263
+ */
5264
+ serviceProperties?: ServiceProperties$6;
5265
+ /**
5266
+ * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
5267
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
5268
+ * + in most cases, this field is the name as `catalogReference.catalogItemId`.
5269
+ * + Used in membership validation.
5270
+ */
5271
+ rootCatalogItemId?: string | null;
5272
+ /**
5273
+ * Optional - partial payment for the given item to be paid upfront during the checkout.
5274
+ * Eligible for catalog items with type `DEPOSIT_ONLINE`.
5275
+ * If omitted - item's price will not be split and is expected to be paid in single installment
5276
+ */
5277
+ depositAmount?: string | null;
5278
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
5279
+ catalogReference?: CatalogReference$a;
5280
+ }
5109
5281
  interface UpdateCartResponse$2 {
5110
5282
  /** Updated Cart. */
5111
5283
  cart?: Cart$2;
@@ -5809,6 +5981,8 @@ interface CreateCartRequest {
5809
5981
  merchantDiscounts?: MerchantDiscountInput$2[];
5810
5982
  /** Catalog line items. */
5811
5983
  lineItems?: LineItem$4[];
5984
+ /** Custom line items. */
5985
+ customLineItems?: CustomLineItem$8[];
5812
5986
  }
5813
5987
  interface CreateCartResponse {
5814
5988
  /** Cart. */
@@ -5827,6 +6001,8 @@ interface AddToCartRequest {
5827
6001
  _id: string;
5828
6002
  /** Catalog line items. */
5829
6003
  lineItems?: LineItem$4[];
6004
+ /** Custom line items. */
6005
+ customLineItems?: CustomLineItem$8[];
5830
6006
  }
5831
6007
  interface RemoveLineItemsRequest$2 {
5832
6008
  /** Cart ID. */
@@ -6463,12 +6639,12 @@ interface LineItem$3 {
6463
6639
  * + Events - `ticket.name`
6464
6640
  * @readonly
6465
6641
  */
6466
- productName?: ProductName$7;
6642
+ productName?: ProductName$9;
6467
6643
  /**
6468
6644
  * URL to the item's page on the site.
6469
6645
  * @readonly
6470
6646
  */
6471
- url?: PageUrlV2$2;
6647
+ url?: PageUrlV2$3;
6472
6648
  /**
6473
6649
  * Item price **after** catalog-defined discount and line item discounts.
6474
6650
  * @readonly
@@ -6488,7 +6664,7 @@ interface LineItem$3 {
6488
6664
  * Line item description lines. Used for displaying the cart, checkout and order.
6489
6665
  * @readonly
6490
6666
  */
6491
- descriptionLines?: DescriptionLine$7[];
6667
+ descriptionLines?: DescriptionLine$9[];
6492
6668
  /**
6493
6669
  * Line item image details.
6494
6670
  * @readonly
@@ -6503,12 +6679,12 @@ interface LineItem$3 {
6503
6679
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
6504
6680
  * @readonly
6505
6681
  */
6506
- physicalProperties?: PhysicalProperties$7;
6682
+ physicalProperties?: PhysicalProperties$9;
6507
6683
  /**
6508
6684
  * Item type. Either a preset type or custom.
6509
6685
  * @readonly
6510
6686
  */
6511
- itemType?: ItemType$7;
6687
+ itemType?: ItemType$9;
6512
6688
  /**
6513
6689
  * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
6514
6690
  * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
@@ -6523,7 +6699,7 @@ interface LineItem$3 {
6523
6699
  * Service properties. When relevant, this contains information such as date and number of participants.
6524
6700
  * @readonly
6525
6701
  */
6526
- serviceProperties?: ServiceProperties$3;
6702
+ serviceProperties?: ServiceProperties$5;
6527
6703
  /**
6528
6704
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
6529
6705
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -6536,7 +6712,7 @@ interface LineItem$3 {
6536
6712
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
6537
6713
  * @readonly
6538
6714
  */
6539
- priceDescription?: PriceDescription$7;
6715
+ priceDescription?: PriceDescription$9;
6540
6716
  /**
6541
6717
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
6542
6718
  * @readonly
@@ -6572,7 +6748,7 @@ interface CatalogReference$9 {
6572
6748
  */
6573
6749
  options?: Record<string, any> | null;
6574
6750
  }
6575
- interface ProductName$7 {
6751
+ interface ProductName$9 {
6576
6752
  /**
6577
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).
6578
6754
  *
@@ -6589,7 +6765,7 @@ interface ProductName$7 {
6589
6765
  */
6590
6766
  translated?: string | null;
6591
6767
  }
6592
- interface PageUrlV2$2 {
6768
+ interface PageUrlV2$3 {
6593
6769
  /** The relative path for the page within the site. For example, `/product-page/a-product`. */
6594
6770
  relativePath?: string;
6595
6771
  /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
@@ -6614,25 +6790,25 @@ interface MultiCurrencyPrice$3 {
6614
6790
  */
6615
6791
  formattedConvertedAmount?: string;
6616
6792
  }
6617
- interface DescriptionLine$7 extends DescriptionLineValueOneOf$7, DescriptionLineDescriptionLineValueOneOf$7 {
6793
+ interface DescriptionLine$9 extends DescriptionLineValueOneOf$9, DescriptionLineDescriptionLineValueOneOf$9 {
6618
6794
  /** Description line plain text value. */
6619
- plainText?: PlainTextValue$7;
6795
+ plainText?: PlainTextValue$9;
6620
6796
  /** Description line color value. */
6621
- colorInfo?: Color$7;
6797
+ colorInfo?: Color$9;
6622
6798
  /** Description line name. */
6623
- name?: DescriptionLineName$7;
6799
+ name?: DescriptionLineName$9;
6624
6800
  }
6625
6801
  /** @oneof */
6626
- interface DescriptionLineValueOneOf$7 {
6802
+ interface DescriptionLineValueOneOf$9 {
6627
6803
  /** Description line plain text value. */
6628
- plainText?: PlainTextValue$7;
6804
+ plainText?: PlainTextValue$9;
6629
6805
  /** Description line color value. */
6630
- colorInfo?: Color$7;
6806
+ colorInfo?: Color$9;
6631
6807
  }
6632
6808
  /** @oneof */
6633
- interface DescriptionLineDescriptionLineValueOneOf$7 {
6809
+ interface DescriptionLineDescriptionLineValueOneOf$9 {
6634
6810
  }
6635
- interface DescriptionLineName$7 {
6811
+ interface DescriptionLineName$9 {
6636
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). */
6637
6813
  original?: string;
6638
6814
  /**
@@ -6642,7 +6818,7 @@ interface DescriptionLineName$7 {
6642
6818
  */
6643
6819
  translated?: string | null;
6644
6820
  }
6645
- interface PlainTextValue$7 {
6821
+ interface PlainTextValue$9 {
6646
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). */
6647
6823
  original?: string;
6648
6824
  /**
@@ -6652,7 +6828,7 @@ interface PlainTextValue$7 {
6652
6828
  */
6653
6829
  translated?: string | null;
6654
6830
  }
6655
- interface Color$7 {
6831
+ interface Color$9 {
6656
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). */
6657
6833
  original?: string;
6658
6834
  /**
@@ -6711,7 +6887,7 @@ declare enum ItemAvailabilityStatus$3 {
6711
6887
  /** Available quantity is less than requested */
6712
6888
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
6713
6889
  }
6714
- interface PhysicalProperties$7 {
6890
+ interface PhysicalProperties$9 {
6715
6891
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
6716
6892
  weight?: number | null;
6717
6893
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -6719,14 +6895,14 @@ interface PhysicalProperties$7 {
6719
6895
  /** Whether this line item is shippable. */
6720
6896
  shippable?: boolean;
6721
6897
  }
6722
- interface ItemType$7 extends ItemTypeItemTypeDataOneOf$7 {
6898
+ interface ItemType$9 extends ItemTypeItemTypeDataOneOf$9 {
6723
6899
  /** Preset item type. */
6724
6900
  preset?: ItemTypeItemType$9;
6725
6901
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
6726
6902
  custom?: string;
6727
6903
  }
6728
6904
  /** @oneof */
6729
- interface ItemTypeItemTypeDataOneOf$7 {
6905
+ interface ItemTypeItemTypeDataOneOf$9 {
6730
6906
  /** Preset item type. */
6731
6907
  preset?: ItemTypeItemType$9;
6732
6908
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -6768,7 +6944,7 @@ declare enum PaymentOptionType$9 {
6768
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`. */
6769
6945
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
6770
6946
  }
6771
- interface ServiceProperties$3 {
6947
+ interface ServiceProperties$5 {
6772
6948
  /**
6773
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.
6774
6950
  * For example, the start time of a class.
@@ -6777,7 +6953,7 @@ interface ServiceProperties$3 {
6777
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. */
6778
6954
  numberOfParticipants?: number | null;
6779
6955
  }
6780
- interface PriceDescription$7 {
6956
+ interface PriceDescription$9 {
6781
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). */
6782
6958
  original?: string;
6783
6959
  /**
@@ -6794,6 +6970,18 @@ interface SelectedMembership$3 {
6794
6970
  /** ID of the app providing this payment option. */
6795
6971
  appId?: string;
6796
6972
  }
6973
+ interface Image$5 {
6974
+ /** WixMedia image ID. */
6975
+ id?: string;
6976
+ /** Original image height. */
6977
+ height?: number;
6978
+ /** Original image width. */
6979
+ width?: number;
6980
+ /** Image alt text. Optional. */
6981
+ altText?: string | null;
6982
+ /** Image filename. Optional. */
6983
+ filename?: string | null;
6984
+ }
6797
6985
  /** Buyer Info */
6798
6986
  interface BuyerInfo$7 extends BuyerInfoIdOneOf$7 {
6799
6987
  /**
@@ -6959,6 +7147,8 @@ interface UpdateCartRequest$1 {
6959
7147
  merchantDiscounts?: MerchantDiscountInput$1[];
6960
7148
  /** Catalog line items. */
6961
7149
  lineItems?: LineItem$3[];
7150
+ /** Custom line items. */
7151
+ customLineItems?: CustomLineItem$7[];
6962
7152
  }
6963
7153
  interface MerchantDiscountInput$1 {
6964
7154
  /** Discount amount. */
@@ -6966,6 +7156,80 @@ interface MerchantDiscountInput$1 {
6966
7156
  /** IDs of line items the discount applies to. */
6967
7157
  lineItemIds?: string[];
6968
7158
  }
7159
+ interface CustomLineItem$7 {
7160
+ /**
7161
+ * Custom line item quantity.
7162
+ *
7163
+ * Min: `1`
7164
+ * Max: `100000`
7165
+ */
7166
+ quantity?: number;
7167
+ /**
7168
+ * Custom line item price.
7169
+ *
7170
+ * Must be a number or a decimal without symbols.
7171
+ */
7172
+ price?: string;
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$9;
7175
+ /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
7176
+ descriptionLines?: DescriptionLine$9[];
7177
+ /** Custom line item's media. */
7178
+ media?: Image$5;
7179
+ /**
7180
+ * Custom line item ID. If passed, `id` must be unique.
7181
+ * Default: auto-generated ID.
7182
+ */
7183
+ id?: string | null;
7184
+ /** Tax group ID for this custom line item. */
7185
+ taxGroupId?: string | null;
7186
+ /** Name of the item or product. */
7187
+ productName?: ProductName$9;
7188
+ /**
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
+ * The URL is optional and if not provided, the site URL will be used.
7191
+ */
7192
+ url?: PageUrlV2$3;
7193
+ /** Item type. Either a preset type or custom. */
7194
+ itemType?: ItemType$9;
7195
+ /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
7196
+ fullPrice?: string | null;
7197
+ /**
7198
+ * Optional - Item quantity available for purchase. Only return this if inventory is managed.
7199
+ * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
7200
+ */
7201
+ quantityAvailable?: number | null;
7202
+ /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
7203
+ physicalProperties?: PhysicalProperties$9;
7204
+ /**
7205
+ * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
7206
+ * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
7207
+ * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
7208
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
7209
+ * + `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.
7210
+ */
7211
+ paymentOption?: PaymentOptionType$9;
7212
+ /**
7213
+ * Optional - Service properties. When relevant, this contains information such as date and number of participants.
7214
+ * Used, among other things, when checking for valid memberships.
7215
+ */
7216
+ serviceProperties?: ServiceProperties$5;
7217
+ /**
7218
+ * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
7219
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
7220
+ * + in most cases, this field is the name as `catalogReference.catalogItemId`.
7221
+ * + Used in membership validation.
7222
+ */
7223
+ rootCatalogItemId?: string | null;
7224
+ /**
7225
+ * Optional - partial payment for the given item to be paid upfront during the checkout.
7226
+ * Eligible for catalog items with type `DEPOSIT_ONLINE`.
7227
+ * If omitted - item's price will not be split and is expected to be paid in single installment
7228
+ */
7229
+ depositAmount?: string | null;
7230
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
7231
+ catalogReference?: CatalogReference$9;
7232
+ }
6969
7233
  interface UpdateCartResponse$1 {
6970
7234
  /** Updated Cart. */
6971
7235
  cart?: Cart$1;
@@ -6973,6 +7237,8 @@ interface UpdateCartResponse$1 {
6973
7237
  interface AddToCurrentCartRequest$1 {
6974
7238
  /** Catalog line items. */
6975
7239
  lineItems?: LineItem$3[];
7240
+ /** Custom line items. */
7241
+ customLineItems?: CustomLineItem$7[];
6976
7242
  }
6977
7243
  interface AddToCartResponse$1 {
6978
7244
  /** Updated cart. */
@@ -8238,7 +8504,7 @@ interface LineItem$2 {
8238
8504
  * + Events - `ticket.name`
8239
8505
  * @readonly
8240
8506
  */
8241
- productName?: ProductName$6;
8507
+ productName?: ProductName$8;
8242
8508
  /**
8243
8509
  * URL to the item's page on the site.
8244
8510
  * @readonly
@@ -8263,7 +8529,7 @@ interface LineItem$2 {
8263
8529
  * Line item description lines. Used for displaying the cart, checkout and order.
8264
8530
  * @readonly
8265
8531
  */
8266
- descriptionLines?: DescriptionLine$6[];
8532
+ descriptionLines?: DescriptionLine$8[];
8267
8533
  /**
8268
8534
  * Line item image details.
8269
8535
  * @readonly
@@ -8278,12 +8544,12 @@ interface LineItem$2 {
8278
8544
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
8279
8545
  * @readonly
8280
8546
  */
8281
- physicalProperties?: PhysicalProperties$6;
8547
+ physicalProperties?: PhysicalProperties$8;
8282
8548
  /**
8283
8549
  * Item type. Either a preset type or custom.
8284
8550
  * @readonly
8285
8551
  */
8286
- itemType?: ItemType$6;
8552
+ itemType?: ItemType$8;
8287
8553
  /**
8288
8554
  * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
8289
8555
  * + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item happens as part of the checkout.
@@ -8296,7 +8562,7 @@ interface LineItem$2 {
8296
8562
  * Service properties. When relevant, this contains information such as date and number of participants.
8297
8563
  * @readonly
8298
8564
  */
8299
- serviceProperties?: ServiceProperties$2;
8565
+ serviceProperties?: ServiceProperties$4;
8300
8566
  /**
8301
8567
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
8302
8568
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -8309,7 +8575,7 @@ interface LineItem$2 {
8309
8575
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
8310
8576
  * @readonly
8311
8577
  */
8312
- priceDescription?: PriceDescription$6;
8578
+ priceDescription?: PriceDescription$8;
8313
8579
  /**
8314
8580
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
8315
8581
  * @readonly
@@ -8347,7 +8613,7 @@ interface CatalogReference$8 {
8347
8613
  */
8348
8614
  options?: Record<string, any> | null;
8349
8615
  }
8350
- interface ProductName$6 {
8616
+ interface ProductName$8 {
8351
8617
  /** **Required** - Original product name (in site's default language). */
8352
8618
  original?: string;
8353
8619
  /** Description product name translated into buyer's language. Defaults to `original` when not defined. */
@@ -8372,37 +8638,37 @@ interface MultiCurrencyPrice$2 {
8372
8638
  */
8373
8639
  formattedConvertedAmount?: string;
8374
8640
  }
8375
- interface DescriptionLine$6 extends DescriptionLineValueOneOf$6, DescriptionLineDescriptionLineValueOneOf$6 {
8641
+ interface DescriptionLine$8 extends DescriptionLineValueOneOf$8, DescriptionLineDescriptionLineValueOneOf$8 {
8376
8642
  /** Description line plain text value. */
8377
- plainText?: PlainTextValue$6;
8643
+ plainText?: PlainTextValue$8;
8378
8644
  /** Description line color value. */
8379
- colorInfo?: Color$6;
8645
+ colorInfo?: Color$8;
8380
8646
  /** Description line name. */
8381
- name?: DescriptionLineName$6;
8647
+ name?: DescriptionLineName$8;
8382
8648
  }
8383
8649
  /** @oneof */
8384
- interface DescriptionLineValueOneOf$6 {
8650
+ interface DescriptionLineValueOneOf$8 {
8385
8651
  /** Description line plain text value. */
8386
- plainText?: PlainTextValue$6;
8652
+ plainText?: PlainTextValue$8;
8387
8653
  /** Description line color value. */
8388
- colorInfo?: Color$6;
8654
+ colorInfo?: Color$8;
8389
8655
  }
8390
8656
  /** @oneof */
8391
- interface DescriptionLineDescriptionLineValueOneOf$6 {
8657
+ interface DescriptionLineDescriptionLineValueOneOf$8 {
8392
8658
  }
8393
- interface DescriptionLineName$6 {
8659
+ interface DescriptionLineName$8 {
8394
8660
  /** Description line name in site's default language. */
8395
8661
  original?: string;
8396
8662
  /** Description line name translated into buyer's language. Defaults to `original` when not defined. */
8397
8663
  translated?: string | null;
8398
8664
  }
8399
- interface PlainTextValue$6 {
8665
+ interface PlainTextValue$8 {
8400
8666
  /** Description line plain text value in site's default language. */
8401
8667
  original?: string;
8402
8668
  /** Description line plain text value translated into buyer's language. Defaults to `original` when not defined. */
8403
8669
  translated?: string | null;
8404
8670
  }
8405
- interface Color$6 {
8671
+ interface Color$8 {
8406
8672
  /** Description line color name in site's default language. */
8407
8673
  original?: string;
8408
8674
  /** Description line color name translated into buyer's language. Defaults to `original` when not defined. */
@@ -8438,7 +8704,7 @@ declare enum ItemAvailabilityStatus$2 {
8438
8704
  /** Available quantity is less than requested */
8439
8705
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
8440
8706
  }
8441
- interface PhysicalProperties$6 {
8707
+ interface PhysicalProperties$8 {
8442
8708
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
8443
8709
  weight?: number | null;
8444
8710
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -8446,14 +8712,14 @@ interface PhysicalProperties$6 {
8446
8712
  /** Whether this line item is shippable. */
8447
8713
  shippable?: boolean;
8448
8714
  }
8449
- interface ItemType$6 extends ItemTypeItemTypeDataOneOf$6 {
8715
+ interface ItemType$8 extends ItemTypeItemTypeDataOneOf$8 {
8450
8716
  /** Preset item type. */
8451
8717
  preset?: ItemTypeItemType$8;
8452
8718
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
8453
8719
  custom?: string;
8454
8720
  }
8455
8721
  /** @oneof */
8456
- interface ItemTypeItemTypeDataOneOf$6 {
8722
+ interface ItemTypeItemTypeDataOneOf$8 {
8457
8723
  /** Preset item type. */
8458
8724
  preset?: ItemTypeItemType$8;
8459
8725
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -8495,13 +8761,13 @@ declare enum PaymentOptionType$8 {
8495
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`. */
8496
8762
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
8497
8763
  }
8498
- interface ServiceProperties$2 {
8764
+ interface ServiceProperties$4 {
8499
8765
  /** The date and time for which the service is supposed to be provided. For example, the time of the class. */
8500
8766
  scheduledDate?: Date;
8501
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. */
8502
8768
  numberOfParticipants?: number | null;
8503
8769
  }
8504
- interface PriceDescription$6 {
8770
+ interface PriceDescription$8 {
8505
8771
  /**
8506
8772
  * **Required** - Original price description (in site's default language).
8507
8773
  *
@@ -8672,6 +8938,8 @@ interface UpdateCartRequest {
8672
8938
  merchantDiscounts?: MerchantDiscountInput[];
8673
8939
  /** Catalog line items. */
8674
8940
  lineItems?: LineItem$2[];
8941
+ /** Custom line items. */
8942
+ customLineItems?: CustomLineItem$6[];
8675
8943
  }
8676
8944
  interface MerchantDiscountInput {
8677
8945
  /** Discount amount. */
@@ -8679,6 +8947,84 @@ interface MerchantDiscountInput {
8679
8947
  /** IDs of the line items the discount applies to. */
8680
8948
  lineItemIds?: string[];
8681
8949
  }
8950
+ interface CustomLineItem$6 {
8951
+ /**
8952
+ * Custom line item quantity.
8953
+ *
8954
+ * Min: `1`
8955
+ * Max: `100000`
8956
+ */
8957
+ quantity?: number;
8958
+ /**
8959
+ * Custom line item price.
8960
+ *
8961
+ * Must be a number or a decimal without symbols.
8962
+ */
8963
+ price?: string;
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$8;
8966
+ /** Custom line item description lines. Used for displaying the cart, checkout and order. */
8967
+ descriptionLines?: DescriptionLine$8[];
8968
+ /**
8969
+ * Custom line item media. Supported formats:
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"`.
8971
+ * + An image from the web - `"http(s)://<image url>"`.
8972
+ */
8973
+ media?: string;
8974
+ /**
8975
+ * Custom line item ID. If passed, `id` must be unique.
8976
+ * Default: auto-generated ID.
8977
+ */
8978
+ _id?: string | null;
8979
+ /** Tax group ID for this custom line item. */
8980
+ taxGroupId?: string | null;
8981
+ /** Name of the item or product. */
8982
+ productName?: ProductName$8;
8983
+ /**
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
+ * The URL is optional and if not provided, the site URL will be used.
8986
+ */
8987
+ url?: string;
8988
+ /** Item type. Either a preset type or custom. */
8989
+ itemType?: ItemType$8;
8990
+ /** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
8991
+ fullPrice?: string | null;
8992
+ /**
8993
+ * Optional - Item quantity available for purchase. Only return this if inventory is managed.
8994
+ * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
8995
+ */
8996
+ quantityAvailable?: number | null;
8997
+ /** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
8998
+ physicalProperties?: PhysicalProperties$8;
8999
+ /**
9000
+ * Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
9001
+ * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
9002
+ * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
9003
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
9004
+ * + `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.
9005
+ */
9006
+ paymentOption?: PaymentOptionType$8;
9007
+ /**
9008
+ * Optional - Service properties. When relevant, this contains information such as date and number of participants.
9009
+ * Used, among other things, when checking for valid memberships.
9010
+ */
9011
+ serviceProperties?: ServiceProperties$4;
9012
+ /**
9013
+ * Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
9014
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
9015
+ * + in most cases, this field is the name as `catalogReference.catalogItemId`.
9016
+ * + Used in membership validation.
9017
+ */
9018
+ rootCatalogItemId?: string | null;
9019
+ /**
9020
+ * Optional - partial payment for the given item to be paid upfront during the checkout.
9021
+ * Eligible for catalog items with type `DEPOSIT_ONLINE`.
9022
+ * If omitted - item's price will not be split and is expected to be paid in single installment
9023
+ */
9024
+ depositAmount?: string | null;
9025
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
9026
+ catalogReference?: CatalogReference$8;
9027
+ }
8682
9028
  interface UpdateCartResponse {
8683
9029
  /** Updated Cart. */
8684
9030
  cart?: Cart;
@@ -8686,6 +9032,8 @@ interface UpdateCartResponse {
8686
9032
  interface AddToCurrentCartRequest {
8687
9033
  /** Catalog line items. */
8688
9034
  lineItems?: LineItem$2[];
9035
+ /** Custom line items. */
9036
+ customLineItems?: CustomLineItem$6[];
8689
9037
  }
8690
9038
  interface AddToCartResponse {
8691
9039
  /** Updated cart. */
@@ -10037,6 +10385,12 @@ interface Checkout$1 {
10037
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).
10038
10386
  */
10039
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;
10040
10394
  }
10041
10395
  interface LineItem$1 {
10042
10396
  /**
@@ -10060,12 +10414,12 @@ interface LineItem$1 {
10060
10414
  * + Events - `ticket.name`
10061
10415
  * @readonly
10062
10416
  */
10063
- productName?: ProductName$5;
10417
+ productName?: ProductName$7;
10064
10418
  /**
10065
10419
  * URL to the item's page on the site.
10066
10420
  * @readonly
10067
10421
  */
10068
- url?: PageUrlV2$1;
10422
+ url?: PageUrlV2$2;
10069
10423
  /**
10070
10424
  * Item price **after** catalog-defined discount and line item discounts.
10071
10425
  * @readonly
@@ -10110,7 +10464,7 @@ interface LineItem$1 {
10110
10464
  * Line item description lines. Used for display purposes for the cart, checkout and order.
10111
10465
  * @readonly
10112
10466
  */
10113
- descriptionLines?: DescriptionLine$5[];
10467
+ descriptionLines?: DescriptionLine$7[];
10114
10468
  /**
10115
10469
  * Line item image details.
10116
10470
  * @readonly
@@ -10125,12 +10479,12 @@ interface LineItem$1 {
10125
10479
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
10126
10480
  * @readonly
10127
10481
  */
10128
- physicalProperties?: PhysicalProperties$5;
10482
+ physicalProperties?: PhysicalProperties$7;
10129
10483
  /**
10130
10484
  * Item type. Either a preset type or custom.
10131
10485
  * @readonly
10132
10486
  */
10133
- itemType?: ItemType$5;
10487
+ itemType?: ItemType$7;
10134
10488
  /**
10135
10489
  * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
10136
10490
  * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
@@ -10145,7 +10499,7 @@ interface LineItem$1 {
10145
10499
  * Service properties. When relevant, this contains information such as date and number of participants.
10146
10500
  * @readonly
10147
10501
  */
10148
- serviceProperties?: ServiceProperties$1;
10502
+ serviceProperties?: ServiceProperties$3;
10149
10503
  /**
10150
10504
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
10151
10505
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -10158,7 +10512,7 @@ interface LineItem$1 {
10158
10512
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
10159
10513
  * @readonly
10160
10514
  */
10161
- priceDescription?: PriceDescription$5;
10515
+ priceDescription?: PriceDescription$7;
10162
10516
  /**
10163
10517
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
10164
10518
  * @readonly
@@ -10187,7 +10541,7 @@ interface CatalogReference$7 {
10187
10541
  */
10188
10542
  options?: Record<string, any> | null;
10189
10543
  }
10190
- interface ProductName$5 {
10544
+ interface ProductName$7 {
10191
10545
  /**
10192
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).
10193
10547
  *
@@ -10204,7 +10558,7 @@ interface ProductName$5 {
10204
10558
  */
10205
10559
  translated?: string | null;
10206
10560
  }
10207
- interface PageUrlV2$1 {
10561
+ interface PageUrlV2$2 {
10208
10562
  /** The relative path for the page within the site. For example, `/product-page/a-product`. */
10209
10563
  relativePath?: string;
10210
10564
  /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
@@ -10260,25 +10614,25 @@ declare enum JurisdictionType$5 {
10260
10614
  CITY = "CITY",
10261
10615
  SPECIAL = "SPECIAL"
10262
10616
  }
10263
- interface DescriptionLine$5 extends DescriptionLineValueOneOf$5, DescriptionLineDescriptionLineValueOneOf$5 {
10617
+ interface DescriptionLine$7 extends DescriptionLineValueOneOf$7, DescriptionLineDescriptionLineValueOneOf$7 {
10264
10618
  /** Description line plain text value. */
10265
- plainText?: PlainTextValue$5;
10619
+ plainText?: PlainTextValue$7;
10266
10620
  /** Description line color value. */
10267
- colorInfo?: Color$5;
10621
+ colorInfo?: Color$7;
10268
10622
  /** Description line name. */
10269
- name?: DescriptionLineName$5;
10623
+ name?: DescriptionLineName$7;
10270
10624
  }
10271
10625
  /** @oneof */
10272
- interface DescriptionLineValueOneOf$5 {
10626
+ interface DescriptionLineValueOneOf$7 {
10273
10627
  /** Description line plain text value. */
10274
- plainText?: PlainTextValue$5;
10628
+ plainText?: PlainTextValue$7;
10275
10629
  /** Description line color value. */
10276
- colorInfo?: Color$5;
10630
+ colorInfo?: Color$7;
10277
10631
  }
10278
10632
  /** @oneof */
10279
- interface DescriptionLineDescriptionLineValueOneOf$5 {
10633
+ interface DescriptionLineDescriptionLineValueOneOf$7 {
10280
10634
  }
10281
- interface DescriptionLineName$5 {
10635
+ interface DescriptionLineName$7 {
10282
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). */
10283
10637
  original?: string;
10284
10638
  /**
@@ -10288,7 +10642,7 @@ interface DescriptionLineName$5 {
10288
10642
  */
10289
10643
  translated?: string | null;
10290
10644
  }
10291
- interface PlainTextValue$5 {
10645
+ interface PlainTextValue$7 {
10292
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). */
10293
10647
  original?: string;
10294
10648
  /**
@@ -10298,7 +10652,7 @@ interface PlainTextValue$5 {
10298
10652
  */
10299
10653
  translated?: string | null;
10300
10654
  }
10301
- interface Color$5 {
10655
+ interface Color$7 {
10302
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). */
10303
10657
  original?: string;
10304
10658
  /**
@@ -10357,7 +10711,7 @@ declare enum ItemAvailabilityStatus$1 {
10357
10711
  /** Available quantity is less than requested */
10358
10712
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
10359
10713
  }
10360
- interface PhysicalProperties$5 {
10714
+ interface PhysicalProperties$7 {
10361
10715
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
10362
10716
  weight?: number | null;
10363
10717
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -10365,14 +10719,14 @@ interface PhysicalProperties$5 {
10365
10719
  /** Whether this line item is shippable. */
10366
10720
  shippable?: boolean;
10367
10721
  }
10368
- interface ItemType$5 extends ItemTypeItemTypeDataOneOf$5 {
10722
+ interface ItemType$7 extends ItemTypeItemTypeDataOneOf$7 {
10369
10723
  /** Preset item type. */
10370
10724
  preset?: ItemTypeItemType$7;
10371
10725
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
10372
10726
  custom?: string;
10373
10727
  }
10374
10728
  /** @oneof */
10375
- interface ItemTypeItemTypeDataOneOf$5 {
10729
+ interface ItemTypeItemTypeDataOneOf$7 {
10376
10730
  /** Preset item type. */
10377
10731
  preset?: ItemTypeItemType$7;
10378
10732
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -10414,7 +10768,7 @@ declare enum PaymentOptionType$7 {
10414
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`. */
10415
10769
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
10416
10770
  }
10417
- interface ServiceProperties$1 {
10771
+ interface ServiceProperties$3 {
10418
10772
  /**
10419
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.
10420
10774
  * For example, the start time of a class.
@@ -10423,7 +10777,7 @@ interface ServiceProperties$1 {
10423
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. */
10424
10778
  numberOfParticipants?: number | null;
10425
10779
  }
10426
- interface PriceDescription$5 {
10780
+ interface PriceDescription$7 {
10427
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). */
10428
10782
  original?: string;
10429
10783
  /**
@@ -10433,6 +10787,18 @@ interface PriceDescription$5 {
10433
10787
  */
10434
10788
  translated?: string | null;
10435
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
+ }
10436
10802
  /** Billing Info and shipping details */
10437
10803
  interface AddressWithContact$5 {
10438
10804
  /** Address. */
@@ -11182,6 +11548,20 @@ interface CustomSettings$1 {
11182
11548
  */
11183
11549
  disabledManualPayment?: boolean;
11184
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
+ }
11185
11565
  interface CreateCheckoutRequest$1 {
11186
11566
  /** Checkout information. */
11187
11567
  checkoutInfo?: Checkout$1;
@@ -11189,6 +11569,8 @@ interface CreateCheckoutRequest$1 {
11189
11569
  couponCode?: string | null;
11190
11570
  /** Line items to be added to checkout. */
11191
11571
  lineItems?: LineItem$1[];
11572
+ /** Custom line items to be added to checkout. */
11573
+ customLineItems?: CustomLineItem$5[];
11192
11574
  /**
11193
11575
  * Sales channel that submitted the order.
11194
11576
  * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
@@ -11220,6 +11602,80 @@ interface CreateCheckoutRequest$1 {
11220
11602
  */
11221
11603
  overrideCheckoutUrl?: string | null;
11222
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
+ }
11223
11679
  interface CreateCheckoutResponse$1 {
11224
11680
  /** Newly created checkout. */
11225
11681
  checkout?: Checkout$1;
@@ -11267,6 +11723,8 @@ interface UpdateCheckoutRequest$1 {
11267
11723
  * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
11268
11724
  */
11269
11725
  overrideCheckoutUrl?: string | null;
11726
+ /** Custom line items to be saved on checkout. */
11727
+ customLineItems?: CustomLineItem$5[];
11270
11728
  }
11271
11729
  interface UpdateCheckoutResponse$1 {
11272
11730
  /** Updated checkout. */
@@ -11301,6 +11759,8 @@ interface AddToCheckoutRequest$1 {
11301
11759
  id: string;
11302
11760
  /** Catalog line items. */
11303
11761
  lineItems?: LineItem$1[];
11762
+ /** Custom line items. */
11763
+ customLineItems?: CustomLineItem$5[];
11304
11764
  }
11305
11765
  interface AddToCheckoutResponse$1 {
11306
11766
  /** Updated checkout. */
@@ -11997,6 +12457,12 @@ interface Checkout {
11997
12457
  * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
11998
12458
  */
11999
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;
12000
12466
  }
12001
12467
  interface LineItem {
12002
12468
  /**
@@ -12020,7 +12486,7 @@ interface LineItem {
12020
12486
  * + Events - `ticket.name`
12021
12487
  * @readonly
12022
12488
  */
12023
- productName?: ProductName$4;
12489
+ productName?: ProductName$6;
12024
12490
  /**
12025
12491
  * URL to the item's page on the site.
12026
12492
  * @readonly
@@ -12070,7 +12536,7 @@ interface LineItem {
12070
12536
  * Line item description lines. Used for displaying the cart, checkout and order.
12071
12537
  * @readonly
12072
12538
  */
12073
- descriptionLines?: DescriptionLine$4[];
12539
+ descriptionLines?: DescriptionLine$6[];
12074
12540
  /**
12075
12541
  * Line item image details.
12076
12542
  * @readonly
@@ -12085,12 +12551,12 @@ interface LineItem {
12085
12551
  * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
12086
12552
  * @readonly
12087
12553
  */
12088
- physicalProperties?: PhysicalProperties$4;
12554
+ physicalProperties?: PhysicalProperties$6;
12089
12555
  /**
12090
12556
  * Item type. Either a preset type or custom.
12091
12557
  * @readonly
12092
12558
  */
12093
- itemType?: ItemType$4;
12559
+ itemType?: ItemType$6;
12094
12560
  /**
12095
12561
  * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
12096
12562
  * + `"FULL_PAYMENT_ONLINE"`: The entire payment for this item happens as part of the checkout.
@@ -12104,7 +12570,7 @@ interface LineItem {
12104
12570
  * Service properties. When relevant, this contains information such as date and number of participants.
12105
12571
  * @readonly
12106
12572
  */
12107
- serviceProperties?: ServiceProperties;
12573
+ serviceProperties?: ServiceProperties$2;
12108
12574
  /**
12109
12575
  * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
12110
12576
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
@@ -12117,7 +12583,7 @@ interface LineItem {
12117
12583
  * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
12118
12584
  * @readonly
12119
12585
  */
12120
- priceDescription?: PriceDescription$4;
12586
+ priceDescription?: PriceDescription$6;
12121
12587
  /**
12122
12588
  * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
12123
12589
  * @readonly
@@ -12148,7 +12614,7 @@ interface CatalogReference$6 {
12148
12614
  */
12149
12615
  options?: Record<string, any> | null;
12150
12616
  }
12151
- interface ProductName$4 {
12617
+ interface ProductName$6 {
12152
12618
  /**
12153
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).
12154
12620
  *
@@ -12215,25 +12681,25 @@ declare enum JurisdictionType$4 {
12215
12681
  CITY = "CITY",
12216
12682
  SPECIAL = "SPECIAL"
12217
12683
  }
12218
- interface DescriptionLine$4 extends DescriptionLineValueOneOf$4, DescriptionLineDescriptionLineValueOneOf$4 {
12684
+ interface DescriptionLine$6 extends DescriptionLineValueOneOf$6, DescriptionLineDescriptionLineValueOneOf$6 {
12219
12685
  /** Description line plain text value. */
12220
- plainText?: PlainTextValue$4;
12686
+ plainText?: PlainTextValue$6;
12221
12687
  /** Description line color value. */
12222
- colorInfo?: Color$4;
12688
+ colorInfo?: Color$6;
12223
12689
  /** Description line name. */
12224
- name?: DescriptionLineName$4;
12690
+ name?: DescriptionLineName$6;
12225
12691
  }
12226
12692
  /** @oneof */
12227
- interface DescriptionLineValueOneOf$4 {
12693
+ interface DescriptionLineValueOneOf$6 {
12228
12694
  /** Description line plain text value. */
12229
- plainText?: PlainTextValue$4;
12695
+ plainText?: PlainTextValue$6;
12230
12696
  /** Description line color value. */
12231
- colorInfo?: Color$4;
12697
+ colorInfo?: Color$6;
12232
12698
  }
12233
12699
  /** @oneof */
12234
- interface DescriptionLineDescriptionLineValueOneOf$4 {
12700
+ interface DescriptionLineDescriptionLineValueOneOf$6 {
12235
12701
  }
12236
- interface DescriptionLineName$4 {
12702
+ interface DescriptionLineName$6 {
12237
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). */
12238
12704
  original?: string;
12239
12705
  /**
@@ -12243,7 +12709,7 @@ interface DescriptionLineName$4 {
12243
12709
  */
12244
12710
  translated?: string | null;
12245
12711
  }
12246
- interface PlainTextValue$4 {
12712
+ interface PlainTextValue$6 {
12247
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). */
12248
12714
  original?: string;
12249
12715
  /**
@@ -12253,7 +12719,7 @@ interface PlainTextValue$4 {
12253
12719
  */
12254
12720
  translated?: string | null;
12255
12721
  }
12256
- interface Color$4 {
12722
+ interface Color$6 {
12257
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). */
12258
12724
  original?: string;
12259
12725
  /**
@@ -12289,7 +12755,7 @@ declare enum ItemAvailabilityStatus {
12289
12755
  /** Available quantity is less than requested */
12290
12756
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
12291
12757
  }
12292
- interface PhysicalProperties$4 {
12758
+ interface PhysicalProperties$6 {
12293
12759
  /** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
12294
12760
  weight?: number | null;
12295
12761
  /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
@@ -12297,14 +12763,14 @@ interface PhysicalProperties$4 {
12297
12763
  /** Whether this line item is shippable. */
12298
12764
  shippable?: boolean;
12299
12765
  }
12300
- interface ItemType$4 extends ItemTypeItemTypeDataOneOf$4 {
12766
+ interface ItemType$6 extends ItemTypeItemTypeDataOneOf$6 {
12301
12767
  /** Preset item type. */
12302
12768
  preset?: ItemTypeItemType$6;
12303
12769
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
12304
12770
  custom?: string;
12305
12771
  }
12306
12772
  /** @oneof */
12307
- interface ItemTypeItemTypeDataOneOf$4 {
12773
+ interface ItemTypeItemTypeDataOneOf$6 {
12308
12774
  /** Preset item type. */
12309
12775
  preset?: ItemTypeItemType$6;
12310
12776
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
@@ -12346,7 +12812,7 @@ declare enum PaymentOptionType$6 {
12346
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`. */
12347
12813
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
12348
12814
  }
12349
- interface ServiceProperties {
12815
+ interface ServiceProperties$2 {
12350
12816
  /**
12351
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.
12352
12818
  * For example, the start time of a class.
@@ -12355,7 +12821,7 @@ interface ServiceProperties {
12355
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. */
12356
12822
  numberOfParticipants?: number | null;
12357
12823
  }
12358
- interface PriceDescription$4 {
12824
+ interface PriceDescription$6 {
12359
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). */
12360
12826
  original?: string;
12361
12827
  /**
@@ -13104,6 +13570,20 @@ interface CustomSettings {
13104
13570
  */
13105
13571
  disabledManualPayment?: boolean;
13106
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
+ }
13107
13587
  interface CreateCheckoutRequest {
13108
13588
  /** Checkout information. */
13109
13589
  checkoutInfo?: Checkout;
@@ -13111,6 +13591,8 @@ interface CreateCheckoutRequest {
13111
13591
  couponCode?: string | null;
13112
13592
  /** Line items to be added to checkout. */
13113
13593
  lineItems?: LineItem[];
13594
+ /** Custom line items to be added to checkout. */
13595
+ customLineItems?: CustomLineItem$4[];
13114
13596
  /**
13115
13597
  * **Required**
13116
13598
  * Sales channel type.
@@ -13131,19 +13613,93 @@ interface CreateCheckoutRequest {
13131
13613
  */
13132
13614
  overrideCheckoutUrl?: string | null;
13133
13615
  }
13134
- interface CreateCheckoutResponse {
13135
- /** Newly created checkout. */
13136
- checkout?: Checkout;
13137
- }
13138
- interface GetCheckoutRequest {
13139
- /** Checkout ID. */
13140
- _id: string;
13141
- }
13142
- interface GetCheckoutResponse {
13143
- /** The requested checkout. */
13144
- checkout?: Checkout;
13145
- }
13146
- interface GetCheckoutByCartIdRequest {
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
+ }
13690
+ interface CreateCheckoutResponse {
13691
+ /** Newly created checkout. */
13692
+ checkout?: Checkout;
13693
+ }
13694
+ interface GetCheckoutRequest {
13695
+ /** Checkout ID. */
13696
+ _id: string;
13697
+ }
13698
+ interface GetCheckoutResponse {
13699
+ /** The requested checkout. */
13700
+ checkout?: Checkout;
13701
+ }
13702
+ interface GetCheckoutByCartIdRequest {
13147
13703
  /** Cart ID. */
13148
13704
  _id: string;
13149
13705
  }
@@ -13172,6 +13728,8 @@ interface UpdateCheckoutRequest {
13172
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`.
13173
13729
  */
13174
13730
  overrideCheckoutUrl?: string | null;
13731
+ /** Custom line items to be saved on checkout. */
13732
+ customLineItems?: CustomLineItem$4[];
13175
13733
  }
13176
13734
  interface UpdateCheckoutResponse {
13177
13735
  /** Updated checkout. */
@@ -13206,6 +13764,8 @@ interface AddToCheckoutRequest {
13206
13764
  _id: string;
13207
13765
  /** Catalog line items. */
13208
13766
  lineItems?: LineItem[];
13767
+ /** Custom line items. */
13768
+ customLineItems?: CustomLineItem$4[];
13209
13769
  }
13210
13770
  interface AddToCheckoutResponse {
13211
13771
  /** Updated checkout. */
@@ -14186,6 +14746,12 @@ interface CheckoutTemplate$1 {
14186
14746
  * Max: 300 items
14187
14747
  */
14188
14748
  lineItems?: V1LineItem$1[];
14749
+ /**
14750
+ * Custom line items.
14751
+ *
14752
+ * Max: 300 items
14753
+ */
14754
+ customLineItems?: CustomLineItem$3[];
14189
14755
  /**
14190
14756
  * Coupon code.
14191
14757
  *
@@ -14193,6 +14759,12 @@ interface CheckoutTemplate$1 {
14193
14759
  * For additional information, see the [Coupons API](https://dev.wix.com/docs/rest/api-reference/coupons/coupons/introduction).
14194
14760
  */
14195
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;
14196
14768
  }
14197
14769
  declare enum Status$3 {
14198
14770
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
@@ -14272,11 +14844,201 @@ interface CatalogReference$5 {
14272
14844
  */
14273
14845
  options?: Record<string, any> | null;
14274
14846
  }
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
+ }
14275
14914
  declare enum DescriptionLineType$5 {
14276
14915
  UNRECOGNISED = "UNRECOGNISED",
14277
14916
  PLAIN_TEXT = "PLAIN_TEXT",
14278
14917
  COLOR = "COLOR"
14279
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
+ }
14280
15042
  declare enum ItemTypeItemType$5 {
14281
15043
  UNRECOGNISED = "UNRECOGNISED",
14282
15044
  PHYSICAL = "PHYSICAL",
@@ -14313,6 +15075,29 @@ declare enum PaymentOptionType$5 {
14313
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`. */
14314
15076
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
14315
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
+ }
14316
15101
  interface CreateCheckoutTemplateRequest$1 {
14317
15102
  /** Checkout template to create. */
14318
15103
  checkoutTemplate: CheckoutTemplate$1;
@@ -14606,6 +15391,12 @@ interface CheckoutTemplate {
14606
15391
  * Max: 300 items
14607
15392
  */
14608
15393
  lineItems?: V1LineItem[];
15394
+ /**
15395
+ * Custom line items.
15396
+ *
15397
+ * Max: 300 items
15398
+ */
15399
+ customLineItems?: CustomLineItem$2[];
14609
15400
  /**
14610
15401
  * Coupon code.
14611
15402
  *
@@ -14613,6 +15404,12 @@ interface CheckoutTemplate {
14613
15404
  * For additional information, see the Coupons API.
14614
15405
  */
14615
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;
14616
15413
  }
14617
15414
  declare enum Status$2 {
14618
15415
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
@@ -14692,11 +15489,183 @@ interface CatalogReference$4 {
14692
15489
  */
14693
15490
  options?: Record<string, any> | null;
14694
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
+ }
14695
15559
  declare enum DescriptionLineType$4 {
14696
15560
  UNRECOGNISED = "UNRECOGNISED",
14697
15561
  PLAIN_TEXT = "PLAIN_TEXT",
14698
15562
  COLOR = "COLOR"
14699
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
+ }
14700
15669
  declare enum ItemTypeItemType$4 {
14701
15670
  UNRECOGNISED = "UNRECOGNISED",
14702
15671
  PHYSICAL = "PHYSICAL",
@@ -14733,6 +15702,29 @@ declare enum PaymentOptionType$4 {
14733
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`. */
14734
15703
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
14735
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
+ }
14736
15728
  interface CreateCheckoutTemplateRequest {
14737
15729
  /** Checkout template to create. */
14738
15730
  checkoutTemplate: CheckoutTemplate;