@wix/ecom 1.0.688 → 1.0.690
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/context.d.ts +1 -0
- package/build/cjs/context.js +2 -1
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +2 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +2 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +1 -0
- package/build/es/context.js +1 -0
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +1 -0
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +1 -0
- package/build/es/meta.js.map +1 -1
- package/package.json +5 -4
- package/type-bundles/context.bundle.d.ts +172 -45
- package/type-bundles/index.bundle.d.ts +172 -45
- package/type-bundles/meta.bundle.d.ts +1088 -334
|
@@ -1,3 +1,113 @@
|
|
|
1
|
+
interface GetCheckoutContentRequest$1 {
|
|
2
|
+
/** ID of the app that provides the content. */
|
|
3
|
+
appId: string;
|
|
4
|
+
/** ID of the specific component content. */
|
|
5
|
+
componentId: string;
|
|
6
|
+
/** When a language is specified, it will be retrieved the content in that language. */
|
|
7
|
+
languageCode?: string | null;
|
|
8
|
+
}
|
|
9
|
+
interface GetCheckoutContentResponse$1 {
|
|
10
|
+
/** The requested CheckoutContent. */
|
|
11
|
+
checkoutContent?: CheckoutContent$1;
|
|
12
|
+
}
|
|
13
|
+
interface CheckoutContent$1 {
|
|
14
|
+
/**
|
|
15
|
+
* Text to display in place of the "Continue shopping" link.
|
|
16
|
+
* @readonly
|
|
17
|
+
*/
|
|
18
|
+
continueShoppingLink?: string | null;
|
|
19
|
+
/**
|
|
20
|
+
* Text to display in place of the "Order summary" title.
|
|
21
|
+
* @readonly
|
|
22
|
+
*/
|
|
23
|
+
orderSummary?: string | null;
|
|
24
|
+
/**
|
|
25
|
+
* Text to display in place of the "Customer details" title.
|
|
26
|
+
* @readonly
|
|
27
|
+
*/
|
|
28
|
+
customerDetails?: string | null;
|
|
29
|
+
/**
|
|
30
|
+
* Text to display in place of the "Review and place order" title.
|
|
31
|
+
* @readonly
|
|
32
|
+
*/
|
|
33
|
+
reviewAndPlaceOrder?: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* Text to display in place of the "Place order" button.
|
|
36
|
+
* @readonly
|
|
37
|
+
*/
|
|
38
|
+
placeOrderButton?: string | null;
|
|
39
|
+
/**
|
|
40
|
+
* Text to display in place of the "Place order & pay" button.
|
|
41
|
+
* @readonly
|
|
42
|
+
*/
|
|
43
|
+
placeOrderPayButton?: string | null;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
interface GetCheckoutContentRequest {
|
|
47
|
+
/** ID of the app that provides the content. */
|
|
48
|
+
appId: string;
|
|
49
|
+
/** ID of the specific component content. */
|
|
50
|
+
componentId: string;
|
|
51
|
+
/** When a language is specified, it will be retrieved the content in that language. */
|
|
52
|
+
languageCode?: string | null;
|
|
53
|
+
}
|
|
54
|
+
interface GetCheckoutContentResponse {
|
|
55
|
+
/** The requested CheckoutContent. */
|
|
56
|
+
checkoutContent?: CheckoutContent;
|
|
57
|
+
}
|
|
58
|
+
interface CheckoutContent {
|
|
59
|
+
/**
|
|
60
|
+
* Text to display in place of the "Continue shopping" link.
|
|
61
|
+
* @readonly
|
|
62
|
+
*/
|
|
63
|
+
continueShoppingLink?: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* Text to display in place of the "Order summary" title.
|
|
66
|
+
* @readonly
|
|
67
|
+
*/
|
|
68
|
+
orderSummary?: string | null;
|
|
69
|
+
/**
|
|
70
|
+
* Text to display in place of the "Customer details" title.
|
|
71
|
+
* @readonly
|
|
72
|
+
*/
|
|
73
|
+
customerDetails?: string | null;
|
|
74
|
+
/**
|
|
75
|
+
* Text to display in place of the "Review and place order" title.
|
|
76
|
+
* @readonly
|
|
77
|
+
*/
|
|
78
|
+
reviewAndPlaceOrder?: string | null;
|
|
79
|
+
/**
|
|
80
|
+
* Text to display in place of the "Place order" button.
|
|
81
|
+
* @readonly
|
|
82
|
+
*/
|
|
83
|
+
placeOrderButton?: string | null;
|
|
84
|
+
/**
|
|
85
|
+
* Text to display in place of the "Place order & pay" button.
|
|
86
|
+
* @readonly
|
|
87
|
+
*/
|
|
88
|
+
placeOrderPayButton?: string | null;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
type __PublicMethodMetaInfo$o<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
92
|
+
getUrl: (context: any) => string;
|
|
93
|
+
httpMethod: K;
|
|
94
|
+
path: string;
|
|
95
|
+
pathParams: M;
|
|
96
|
+
__requestType: T;
|
|
97
|
+
__originalRequestType: S;
|
|
98
|
+
__responseType: Q;
|
|
99
|
+
__originalResponseType: R;
|
|
100
|
+
};
|
|
101
|
+
declare function getCheckoutContent(): __PublicMethodMetaInfo$o<'GET', {
|
|
102
|
+
appId: string;
|
|
103
|
+
componentId: string;
|
|
104
|
+
}, GetCheckoutContentRequest, GetCheckoutContentRequest$1, GetCheckoutContentResponse, GetCheckoutContentResponse$1>;
|
|
105
|
+
|
|
106
|
+
declare const meta$o_getCheckoutContent: typeof getCheckoutContent;
|
|
107
|
+
declare namespace meta$o {
|
|
108
|
+
export { type __PublicMethodMetaInfo$o as __PublicMethodMetaInfo, meta$o_getCheckoutContent as getCheckoutContent };
|
|
109
|
+
}
|
|
110
|
+
|
|
1
111
|
interface ListTriggersRequest$1 {
|
|
2
112
|
}
|
|
3
113
|
interface ListTriggersResponse$1 {
|
|
@@ -2123,9 +2233,9 @@ interface BackInStockItemDetails$1 {
|
|
|
2123
2233
|
/** Item price. */
|
|
2124
2234
|
price?: string;
|
|
2125
2235
|
/** Item image. */
|
|
2126
|
-
image?: Image$
|
|
2236
|
+
image?: Image$7;
|
|
2127
2237
|
}
|
|
2128
|
-
interface Image$
|
|
2238
|
+
interface Image$7 {
|
|
2129
2239
|
/** WixMedia image ID. */
|
|
2130
2240
|
id?: string;
|
|
2131
2241
|
/** Image URL. */
|
|
@@ -2863,12 +2973,12 @@ interface LineItem$5 {
|
|
|
2863
2973
|
* + Events - `ticket.name`
|
|
2864
2974
|
* @readonly
|
|
2865
2975
|
*/
|
|
2866
|
-
productName?: ProductName$
|
|
2976
|
+
productName?: ProductName$b;
|
|
2867
2977
|
/**
|
|
2868
2978
|
* URL to the item's page on the site.
|
|
2869
2979
|
* @readonly
|
|
2870
2980
|
*/
|
|
2871
|
-
url?: PageUrlV2$
|
|
2981
|
+
url?: PageUrlV2$4;
|
|
2872
2982
|
/**
|
|
2873
2983
|
* Item price **after** catalog-defined discount and line item discounts.
|
|
2874
2984
|
* @readonly
|
|
@@ -2888,7 +2998,7 @@ interface LineItem$5 {
|
|
|
2888
2998
|
* Line item description lines. Used for displaying the cart, checkout and order.
|
|
2889
2999
|
* @readonly
|
|
2890
3000
|
*/
|
|
2891
|
-
descriptionLines?: DescriptionLine$
|
|
3001
|
+
descriptionLines?: DescriptionLine$b[];
|
|
2892
3002
|
/**
|
|
2893
3003
|
* Line item image details.
|
|
2894
3004
|
* @readonly
|
|
@@ -2903,12 +3013,12 @@ interface LineItem$5 {
|
|
|
2903
3013
|
* Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
|
|
2904
3014
|
* @readonly
|
|
2905
3015
|
*/
|
|
2906
|
-
physicalProperties?: PhysicalProperties$
|
|
3016
|
+
physicalProperties?: PhysicalProperties$b;
|
|
2907
3017
|
/**
|
|
2908
3018
|
* Item type. Either a preset type or custom.
|
|
2909
3019
|
* @readonly
|
|
2910
3020
|
*/
|
|
2911
|
-
itemType?: ItemType$
|
|
3021
|
+
itemType?: ItemType$b;
|
|
2912
3022
|
/**
|
|
2913
3023
|
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
2914
3024
|
* + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
|
|
@@ -2923,7 +3033,7 @@ interface LineItem$5 {
|
|
|
2923
3033
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
2924
3034
|
* @readonly
|
|
2925
3035
|
*/
|
|
2926
|
-
serviceProperties?: ServiceProperties$
|
|
3036
|
+
serviceProperties?: ServiceProperties$7;
|
|
2927
3037
|
/**
|
|
2928
3038
|
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
2929
3039
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -2936,7 +3046,7 @@ interface LineItem$5 {
|
|
|
2936
3046
|
* Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
|
|
2937
3047
|
* @readonly
|
|
2938
3048
|
*/
|
|
2939
|
-
priceDescription?: PriceDescription$
|
|
3049
|
+
priceDescription?: PriceDescription$b;
|
|
2940
3050
|
/**
|
|
2941
3051
|
* Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
2942
3052
|
* @readonly
|
|
@@ -2972,7 +3082,7 @@ interface CatalogReference$b {
|
|
|
2972
3082
|
*/
|
|
2973
3083
|
options?: Record<string, any> | null;
|
|
2974
3084
|
}
|
|
2975
|
-
interface ProductName$
|
|
3085
|
+
interface ProductName$b {
|
|
2976
3086
|
/**
|
|
2977
3087
|
* __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
3088
|
*
|
|
@@ -2989,7 +3099,7 @@ interface ProductName$9 {
|
|
|
2989
3099
|
*/
|
|
2990
3100
|
translated?: string | null;
|
|
2991
3101
|
}
|
|
2992
|
-
interface PageUrlV2$
|
|
3102
|
+
interface PageUrlV2$4 {
|
|
2993
3103
|
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
2994
3104
|
relativePath?: string;
|
|
2995
3105
|
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
@@ -3014,25 +3124,25 @@ interface MultiCurrencyPrice$5 {
|
|
|
3014
3124
|
*/
|
|
3015
3125
|
formattedConvertedAmount?: string;
|
|
3016
3126
|
}
|
|
3017
|
-
interface DescriptionLine$
|
|
3127
|
+
interface DescriptionLine$b extends DescriptionLineValueOneOf$b, DescriptionLineDescriptionLineValueOneOf$b {
|
|
3018
3128
|
/** Description line plain text value. */
|
|
3019
|
-
plainText?: PlainTextValue$
|
|
3129
|
+
plainText?: PlainTextValue$b;
|
|
3020
3130
|
/** Description line color value. */
|
|
3021
|
-
colorInfo?: Color$
|
|
3131
|
+
colorInfo?: Color$b;
|
|
3022
3132
|
/** Description line name. */
|
|
3023
|
-
name?: DescriptionLineName$
|
|
3133
|
+
name?: DescriptionLineName$b;
|
|
3024
3134
|
}
|
|
3025
3135
|
/** @oneof */
|
|
3026
|
-
interface DescriptionLineValueOneOf$
|
|
3136
|
+
interface DescriptionLineValueOneOf$b {
|
|
3027
3137
|
/** Description line plain text value. */
|
|
3028
|
-
plainText?: PlainTextValue$
|
|
3138
|
+
plainText?: PlainTextValue$b;
|
|
3029
3139
|
/** Description line color value. */
|
|
3030
|
-
colorInfo?: Color$
|
|
3140
|
+
colorInfo?: Color$b;
|
|
3031
3141
|
}
|
|
3032
3142
|
/** @oneof */
|
|
3033
|
-
interface DescriptionLineDescriptionLineValueOneOf$
|
|
3143
|
+
interface DescriptionLineDescriptionLineValueOneOf$b {
|
|
3034
3144
|
}
|
|
3035
|
-
interface DescriptionLineName$
|
|
3145
|
+
interface DescriptionLineName$b {
|
|
3036
3146
|
/** 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
3147
|
original?: string;
|
|
3038
3148
|
/**
|
|
@@ -3042,7 +3152,7 @@ interface DescriptionLineName$9 {
|
|
|
3042
3152
|
*/
|
|
3043
3153
|
translated?: string | null;
|
|
3044
3154
|
}
|
|
3045
|
-
interface PlainTextValue$
|
|
3155
|
+
interface PlainTextValue$b {
|
|
3046
3156
|
/** 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
3157
|
original?: string;
|
|
3048
3158
|
/**
|
|
@@ -3052,7 +3162,7 @@ interface PlainTextValue$9 {
|
|
|
3052
3162
|
*/
|
|
3053
3163
|
translated?: string | null;
|
|
3054
3164
|
}
|
|
3055
|
-
interface Color$
|
|
3165
|
+
interface Color$b {
|
|
3056
3166
|
/** 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
3167
|
original?: string;
|
|
3058
3168
|
/**
|
|
@@ -3111,7 +3221,7 @@ declare enum ItemAvailabilityStatus$5 {
|
|
|
3111
3221
|
/** Available quantity is less than requested */
|
|
3112
3222
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
3113
3223
|
}
|
|
3114
|
-
interface PhysicalProperties$
|
|
3224
|
+
interface PhysicalProperties$b {
|
|
3115
3225
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
3116
3226
|
weight?: number | null;
|
|
3117
3227
|
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
@@ -3119,14 +3229,14 @@ interface PhysicalProperties$9 {
|
|
|
3119
3229
|
/** Whether this line item is shippable. */
|
|
3120
3230
|
shippable?: boolean;
|
|
3121
3231
|
}
|
|
3122
|
-
interface ItemType$
|
|
3232
|
+
interface ItemType$b extends ItemTypeItemTypeDataOneOf$b {
|
|
3123
3233
|
/** Preset item type. */
|
|
3124
3234
|
preset?: ItemTypeItemType$b;
|
|
3125
3235
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
3126
3236
|
custom?: string;
|
|
3127
3237
|
}
|
|
3128
3238
|
/** @oneof */
|
|
3129
|
-
interface ItemTypeItemTypeDataOneOf$
|
|
3239
|
+
interface ItemTypeItemTypeDataOneOf$b {
|
|
3130
3240
|
/** Preset item type. */
|
|
3131
3241
|
preset?: ItemTypeItemType$b;
|
|
3132
3242
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
@@ -3168,7 +3278,7 @@ declare enum PaymentOptionType$b {
|
|
|
3168
3278
|
/** 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
3279
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
3170
3280
|
}
|
|
3171
|
-
interface ServiceProperties$
|
|
3281
|
+
interface ServiceProperties$7 {
|
|
3172
3282
|
/**
|
|
3173
3283
|
* 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
3284
|
* For example, the start time of a class.
|
|
@@ -3177,7 +3287,7 @@ interface ServiceProperties$5 {
|
|
|
3177
3287
|
/** 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
3288
|
numberOfParticipants?: number | null;
|
|
3179
3289
|
}
|
|
3180
|
-
interface PriceDescription$
|
|
3290
|
+
interface PriceDescription$b {
|
|
3181
3291
|
/** __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
3292
|
original?: string;
|
|
3183
3293
|
/**
|
|
@@ -3194,7 +3304,7 @@ interface SelectedMembership$5 {
|
|
|
3194
3304
|
/** ID of the app providing this payment option. */
|
|
3195
3305
|
appId?: string;
|
|
3196
3306
|
}
|
|
3197
|
-
interface Image$
|
|
3307
|
+
interface Image$6 {
|
|
3198
3308
|
/** WixMedia image ID. */
|
|
3199
3309
|
id?: string;
|
|
3200
3310
|
/** Original image height. */
|
|
@@ -3366,7 +3476,7 @@ interface UpdateCartRequest$3 {
|
|
|
3366
3476
|
/** Catalog line items. */
|
|
3367
3477
|
lineItems?: LineItem$5[];
|
|
3368
3478
|
/** Custom line items. */
|
|
3369
|
-
customLineItems?: CustomLineItem$
|
|
3479
|
+
customLineItems?: CustomLineItem$9[];
|
|
3370
3480
|
}
|
|
3371
3481
|
interface MerchantDiscountInput$3 {
|
|
3372
3482
|
/** Discount amount. */
|
|
@@ -3374,7 +3484,7 @@ interface MerchantDiscountInput$3 {
|
|
|
3374
3484
|
/** IDs of line items the discount applies to. */
|
|
3375
3485
|
lineItemIds?: string[];
|
|
3376
3486
|
}
|
|
3377
|
-
interface CustomLineItem$
|
|
3487
|
+
interface CustomLineItem$9 {
|
|
3378
3488
|
/**
|
|
3379
3489
|
* Custom line item quantity.
|
|
3380
3490
|
*
|
|
@@ -3389,11 +3499,11 @@ interface CustomLineItem$5 {
|
|
|
3389
3499
|
*/
|
|
3390
3500
|
price?: string;
|
|
3391
3501
|
/** 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$
|
|
3502
|
+
priceDescription?: PriceDescription$b;
|
|
3393
3503
|
/** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
|
|
3394
|
-
descriptionLines?: DescriptionLine$
|
|
3504
|
+
descriptionLines?: DescriptionLine$b[];
|
|
3395
3505
|
/** Custom line item's media. */
|
|
3396
|
-
media?: Image$
|
|
3506
|
+
media?: Image$6;
|
|
3397
3507
|
/**
|
|
3398
3508
|
* Custom line item ID. If passed, `id` must be unique.
|
|
3399
3509
|
* Default: auto-generated ID.
|
|
@@ -3402,14 +3512,14 @@ interface CustomLineItem$5 {
|
|
|
3402
3512
|
/** Tax group ID for this custom line item. */
|
|
3403
3513
|
taxGroupId?: string | null;
|
|
3404
3514
|
/** Name of the item or product. */
|
|
3405
|
-
productName?: ProductName$
|
|
3515
|
+
productName?: ProductName$b;
|
|
3406
3516
|
/**
|
|
3407
3517
|
* 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
3518
|
* The URL is optional and if not provided, the site URL will be used.
|
|
3409
3519
|
*/
|
|
3410
|
-
url?: PageUrlV2$
|
|
3520
|
+
url?: PageUrlV2$4;
|
|
3411
3521
|
/** Item type. Either a preset type or custom. */
|
|
3412
|
-
itemType?: ItemType$
|
|
3522
|
+
itemType?: ItemType$b;
|
|
3413
3523
|
/** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
3414
3524
|
fullPrice?: string | null;
|
|
3415
3525
|
/**
|
|
@@ -3418,7 +3528,7 @@ interface CustomLineItem$5 {
|
|
|
3418
3528
|
*/
|
|
3419
3529
|
quantityAvailable?: number | null;
|
|
3420
3530
|
/** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
3421
|
-
physicalProperties?: PhysicalProperties$
|
|
3531
|
+
physicalProperties?: PhysicalProperties$b;
|
|
3422
3532
|
/**
|
|
3423
3533
|
* Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
3424
3534
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
@@ -3431,7 +3541,7 @@ interface CustomLineItem$5 {
|
|
|
3431
3541
|
* Optional - Service properties. When relevant, this contains information such as date and number of participants.
|
|
3432
3542
|
* Used, among other things, when checking for valid memberships.
|
|
3433
3543
|
*/
|
|
3434
|
-
serviceProperties?: ServiceProperties$
|
|
3544
|
+
serviceProperties?: ServiceProperties$7;
|
|
3435
3545
|
/**
|
|
3436
3546
|
* Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
3437
3547
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -4143,7 +4253,7 @@ interface CreateCartRequest$1 {
|
|
|
4143
4253
|
/** Catalog line items. */
|
|
4144
4254
|
lineItems?: LineItem$5[];
|
|
4145
4255
|
/** Custom line items. */
|
|
4146
|
-
customLineItems?: CustomLineItem$
|
|
4256
|
+
customLineItems?: CustomLineItem$9[];
|
|
4147
4257
|
}
|
|
4148
4258
|
interface CreateCartResponse$1 {
|
|
4149
4259
|
/** Cart. */
|
|
@@ -4163,7 +4273,7 @@ interface AddToCartRequest$1 {
|
|
|
4163
4273
|
/** Catalog line items. */
|
|
4164
4274
|
lineItems?: LineItem$5[];
|
|
4165
4275
|
/** Custom line items. */
|
|
4166
|
-
customLineItems?: CustomLineItem$
|
|
4276
|
+
customLineItems?: CustomLineItem$9[];
|
|
4167
4277
|
}
|
|
4168
4278
|
interface RemoveLineItemsRequest$3 {
|
|
4169
4279
|
/** Cart ID. */
|
|
@@ -4763,7 +4873,7 @@ interface LineItem$4 {
|
|
|
4763
4873
|
* + Events - `ticket.name`
|
|
4764
4874
|
* @readonly
|
|
4765
4875
|
*/
|
|
4766
|
-
productName?: ProductName$
|
|
4876
|
+
productName?: ProductName$a;
|
|
4767
4877
|
/**
|
|
4768
4878
|
* URL to the item's page on the site.
|
|
4769
4879
|
* @readonly
|
|
@@ -4788,7 +4898,7 @@ interface LineItem$4 {
|
|
|
4788
4898
|
* Line item description lines. Used for displaying the cart, checkout and order.
|
|
4789
4899
|
* @readonly
|
|
4790
4900
|
*/
|
|
4791
|
-
descriptionLines?: DescriptionLine$
|
|
4901
|
+
descriptionLines?: DescriptionLine$a[];
|
|
4792
4902
|
/**
|
|
4793
4903
|
* Line item image details.
|
|
4794
4904
|
* @readonly
|
|
@@ -4803,12 +4913,12 @@ interface LineItem$4 {
|
|
|
4803
4913
|
* Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
|
|
4804
4914
|
* @readonly
|
|
4805
4915
|
*/
|
|
4806
|
-
physicalProperties?: PhysicalProperties$
|
|
4916
|
+
physicalProperties?: PhysicalProperties$a;
|
|
4807
4917
|
/**
|
|
4808
4918
|
* Item type. Either a preset type or custom.
|
|
4809
4919
|
* @readonly
|
|
4810
4920
|
*/
|
|
4811
|
-
itemType?: ItemType$
|
|
4921
|
+
itemType?: ItemType$a;
|
|
4812
4922
|
/**
|
|
4813
4923
|
* Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
|
|
4814
4924
|
* + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item happens as part of the checkout.
|
|
@@ -4821,7 +4931,7 @@ interface LineItem$4 {
|
|
|
4821
4931
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
4822
4932
|
* @readonly
|
|
4823
4933
|
*/
|
|
4824
|
-
serviceProperties?: ServiceProperties$
|
|
4934
|
+
serviceProperties?: ServiceProperties$6;
|
|
4825
4935
|
/**
|
|
4826
4936
|
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
4827
4937
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -4834,7 +4944,7 @@ interface LineItem$4 {
|
|
|
4834
4944
|
* Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
|
|
4835
4945
|
* @readonly
|
|
4836
4946
|
*/
|
|
4837
|
-
priceDescription?: PriceDescription$
|
|
4947
|
+
priceDescription?: PriceDescription$a;
|
|
4838
4948
|
/**
|
|
4839
4949
|
* Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
4840
4950
|
* @readonly
|
|
@@ -4872,7 +4982,7 @@ interface CatalogReference$a {
|
|
|
4872
4982
|
*/
|
|
4873
4983
|
options?: Record<string, any> | null;
|
|
4874
4984
|
}
|
|
4875
|
-
interface ProductName$
|
|
4985
|
+
interface ProductName$a {
|
|
4876
4986
|
/** **Required** - Original product name (in site's default language). */
|
|
4877
4987
|
original?: string;
|
|
4878
4988
|
/** Description product name translated into buyer's language. Defaults to `original` when not defined. */
|
|
@@ -4897,37 +5007,37 @@ interface MultiCurrencyPrice$4 {
|
|
|
4897
5007
|
*/
|
|
4898
5008
|
formattedConvertedAmount?: string;
|
|
4899
5009
|
}
|
|
4900
|
-
interface DescriptionLine$
|
|
5010
|
+
interface DescriptionLine$a extends DescriptionLineValueOneOf$a, DescriptionLineDescriptionLineValueOneOf$a {
|
|
4901
5011
|
/** Description line plain text value. */
|
|
4902
|
-
plainText?: PlainTextValue$
|
|
5012
|
+
plainText?: PlainTextValue$a;
|
|
4903
5013
|
/** Description line color value. */
|
|
4904
|
-
colorInfo?: Color$
|
|
5014
|
+
colorInfo?: Color$a;
|
|
4905
5015
|
/** Description line name. */
|
|
4906
|
-
name?: DescriptionLineName$
|
|
5016
|
+
name?: DescriptionLineName$a;
|
|
4907
5017
|
}
|
|
4908
5018
|
/** @oneof */
|
|
4909
|
-
interface DescriptionLineValueOneOf$
|
|
5019
|
+
interface DescriptionLineValueOneOf$a {
|
|
4910
5020
|
/** Description line plain text value. */
|
|
4911
|
-
plainText?: PlainTextValue$
|
|
5021
|
+
plainText?: PlainTextValue$a;
|
|
4912
5022
|
/** Description line color value. */
|
|
4913
|
-
colorInfo?: Color$
|
|
5023
|
+
colorInfo?: Color$a;
|
|
4914
5024
|
}
|
|
4915
5025
|
/** @oneof */
|
|
4916
|
-
interface DescriptionLineDescriptionLineValueOneOf$
|
|
5026
|
+
interface DescriptionLineDescriptionLineValueOneOf$a {
|
|
4917
5027
|
}
|
|
4918
|
-
interface DescriptionLineName$
|
|
5028
|
+
interface DescriptionLineName$a {
|
|
4919
5029
|
/** Description line name in site's default language. */
|
|
4920
5030
|
original?: string;
|
|
4921
5031
|
/** Description line name translated into buyer's language. Defaults to `original` when not defined. */
|
|
4922
5032
|
translated?: string | null;
|
|
4923
5033
|
}
|
|
4924
|
-
interface PlainTextValue$
|
|
5034
|
+
interface PlainTextValue$a {
|
|
4925
5035
|
/** Description line plain text value in site's default language. */
|
|
4926
5036
|
original?: string;
|
|
4927
5037
|
/** Description line plain text value translated into buyer's language. Defaults to `original` when not defined. */
|
|
4928
5038
|
translated?: string | null;
|
|
4929
5039
|
}
|
|
4930
|
-
interface Color$
|
|
5040
|
+
interface Color$a {
|
|
4931
5041
|
/** Description line color name in site's default language. */
|
|
4932
5042
|
original?: string;
|
|
4933
5043
|
/** Description line color name translated into buyer's language. Defaults to `original` when not defined. */
|
|
@@ -4963,7 +5073,7 @@ declare enum ItemAvailabilityStatus$4 {
|
|
|
4963
5073
|
/** Available quantity is less than requested */
|
|
4964
5074
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
4965
5075
|
}
|
|
4966
|
-
interface PhysicalProperties$
|
|
5076
|
+
interface PhysicalProperties$a {
|
|
4967
5077
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
4968
5078
|
weight?: number | null;
|
|
4969
5079
|
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
@@ -4971,14 +5081,14 @@ interface PhysicalProperties$8 {
|
|
|
4971
5081
|
/** Whether this line item is shippable. */
|
|
4972
5082
|
shippable?: boolean;
|
|
4973
5083
|
}
|
|
4974
|
-
interface ItemType$
|
|
5084
|
+
interface ItemType$a extends ItemTypeItemTypeDataOneOf$a {
|
|
4975
5085
|
/** Preset item type. */
|
|
4976
5086
|
preset?: ItemTypeItemType$a;
|
|
4977
5087
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
4978
5088
|
custom?: string;
|
|
4979
5089
|
}
|
|
4980
5090
|
/** @oneof */
|
|
4981
|
-
interface ItemTypeItemTypeDataOneOf$
|
|
5091
|
+
interface ItemTypeItemTypeDataOneOf$a {
|
|
4982
5092
|
/** Preset item type. */
|
|
4983
5093
|
preset?: ItemTypeItemType$a;
|
|
4984
5094
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
@@ -5020,13 +5130,13 @@ declare enum PaymentOptionType$a {
|
|
|
5020
5130
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
5021
5131
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
5022
5132
|
}
|
|
5023
|
-
interface ServiceProperties$
|
|
5133
|
+
interface ServiceProperties$6 {
|
|
5024
5134
|
/** The date and time for which the service is supposed to be provided. For example, the time of the class. */
|
|
5025
5135
|
scheduledDate?: Date;
|
|
5026
5136
|
/** The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room. */
|
|
5027
5137
|
numberOfParticipants?: number | null;
|
|
5028
5138
|
}
|
|
5029
|
-
interface PriceDescription$
|
|
5139
|
+
interface PriceDescription$a {
|
|
5030
5140
|
/**
|
|
5031
5141
|
* **Required** - Original price description (in site's default language).
|
|
5032
5142
|
*
|
|
@@ -5192,7 +5302,7 @@ interface UpdateCartRequest$2 {
|
|
|
5192
5302
|
/** Catalog line items. */
|
|
5193
5303
|
lineItems?: LineItem$4[];
|
|
5194
5304
|
/** Custom line items. */
|
|
5195
|
-
customLineItems?: CustomLineItem$
|
|
5305
|
+
customLineItems?: CustomLineItem$8[];
|
|
5196
5306
|
}
|
|
5197
5307
|
interface MerchantDiscountInput$2 {
|
|
5198
5308
|
/** Discount amount. */
|
|
@@ -5200,7 +5310,7 @@ interface MerchantDiscountInput$2 {
|
|
|
5200
5310
|
/** IDs of the line items the discount applies to. */
|
|
5201
5311
|
lineItemIds?: string[];
|
|
5202
5312
|
}
|
|
5203
|
-
interface CustomLineItem$
|
|
5313
|
+
interface CustomLineItem$8 {
|
|
5204
5314
|
/**
|
|
5205
5315
|
* Custom line item quantity.
|
|
5206
5316
|
*
|
|
@@ -5215,9 +5325,9 @@ interface CustomLineItem$4 {
|
|
|
5215
5325
|
*/
|
|
5216
5326
|
price?: string;
|
|
5217
5327
|
/** 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$
|
|
5328
|
+
priceDescription?: PriceDescription$a;
|
|
5219
5329
|
/** Custom line item description lines. Used for displaying the cart, checkout and order. */
|
|
5220
|
-
descriptionLines?: DescriptionLine$
|
|
5330
|
+
descriptionLines?: DescriptionLine$a[];
|
|
5221
5331
|
/**
|
|
5222
5332
|
* Custom line item media. Supported formats:
|
|
5223
5333
|
* + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
|
|
@@ -5232,14 +5342,14 @@ interface CustomLineItem$4 {
|
|
|
5232
5342
|
/** Tax group ID for this custom line item. */
|
|
5233
5343
|
taxGroupId?: string | null;
|
|
5234
5344
|
/** Name of the item or product. */
|
|
5235
|
-
productName?: ProductName$
|
|
5345
|
+
productName?: ProductName$a;
|
|
5236
5346
|
/**
|
|
5237
5347
|
* 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
5348
|
* The URL is optional and if not provided, the site URL will be used.
|
|
5239
5349
|
*/
|
|
5240
5350
|
url?: string;
|
|
5241
5351
|
/** Item type. Either a preset type or custom. */
|
|
5242
|
-
itemType?: ItemType$
|
|
5352
|
+
itemType?: ItemType$a;
|
|
5243
5353
|
/** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
5244
5354
|
fullPrice?: string | null;
|
|
5245
5355
|
/**
|
|
@@ -5248,7 +5358,7 @@ interface CustomLineItem$4 {
|
|
|
5248
5358
|
*/
|
|
5249
5359
|
quantityAvailable?: number | null;
|
|
5250
5360
|
/** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
5251
|
-
physicalProperties?: PhysicalProperties$
|
|
5361
|
+
physicalProperties?: PhysicalProperties$a;
|
|
5252
5362
|
/**
|
|
5253
5363
|
* Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
5254
5364
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
@@ -5261,7 +5371,7 @@ interface CustomLineItem$4 {
|
|
|
5261
5371
|
* Optional - Service properties. When relevant, this contains information such as date and number of participants.
|
|
5262
5372
|
* Used, among other things, when checking for valid memberships.
|
|
5263
5373
|
*/
|
|
5264
|
-
serviceProperties?: ServiceProperties$
|
|
5374
|
+
serviceProperties?: ServiceProperties$6;
|
|
5265
5375
|
/**
|
|
5266
5376
|
* Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
5267
5377
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -5982,7 +6092,7 @@ interface CreateCartRequest {
|
|
|
5982
6092
|
/** Catalog line items. */
|
|
5983
6093
|
lineItems?: LineItem$4[];
|
|
5984
6094
|
/** Custom line items. */
|
|
5985
|
-
customLineItems?: CustomLineItem$
|
|
6095
|
+
customLineItems?: CustomLineItem$8[];
|
|
5986
6096
|
}
|
|
5987
6097
|
interface CreateCartResponse {
|
|
5988
6098
|
/** Cart. */
|
|
@@ -6002,7 +6112,7 @@ interface AddToCartRequest {
|
|
|
6002
6112
|
/** Catalog line items. */
|
|
6003
6113
|
lineItems?: LineItem$4[];
|
|
6004
6114
|
/** Custom line items. */
|
|
6005
|
-
customLineItems?: CustomLineItem$
|
|
6115
|
+
customLineItems?: CustomLineItem$8[];
|
|
6006
6116
|
}
|
|
6007
6117
|
interface RemoveLineItemsRequest$2 {
|
|
6008
6118
|
/** Cart ID. */
|
|
@@ -6639,12 +6749,12 @@ interface LineItem$3 {
|
|
|
6639
6749
|
* + Events - `ticket.name`
|
|
6640
6750
|
* @readonly
|
|
6641
6751
|
*/
|
|
6642
|
-
productName?: ProductName$
|
|
6752
|
+
productName?: ProductName$9;
|
|
6643
6753
|
/**
|
|
6644
6754
|
* URL to the item's page on the site.
|
|
6645
6755
|
* @readonly
|
|
6646
6756
|
*/
|
|
6647
|
-
url?: PageUrlV2$
|
|
6757
|
+
url?: PageUrlV2$3;
|
|
6648
6758
|
/**
|
|
6649
6759
|
* Item price **after** catalog-defined discount and line item discounts.
|
|
6650
6760
|
* @readonly
|
|
@@ -6664,7 +6774,7 @@ interface LineItem$3 {
|
|
|
6664
6774
|
* Line item description lines. Used for displaying the cart, checkout and order.
|
|
6665
6775
|
* @readonly
|
|
6666
6776
|
*/
|
|
6667
|
-
descriptionLines?: DescriptionLine$
|
|
6777
|
+
descriptionLines?: DescriptionLine$9[];
|
|
6668
6778
|
/**
|
|
6669
6779
|
* Line item image details.
|
|
6670
6780
|
* @readonly
|
|
@@ -6679,12 +6789,12 @@ interface LineItem$3 {
|
|
|
6679
6789
|
* Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
|
|
6680
6790
|
* @readonly
|
|
6681
6791
|
*/
|
|
6682
|
-
physicalProperties?: PhysicalProperties$
|
|
6792
|
+
physicalProperties?: PhysicalProperties$9;
|
|
6683
6793
|
/**
|
|
6684
6794
|
* Item type. Either a preset type or custom.
|
|
6685
6795
|
* @readonly
|
|
6686
6796
|
*/
|
|
6687
|
-
itemType?: ItemType$
|
|
6797
|
+
itemType?: ItemType$9;
|
|
6688
6798
|
/**
|
|
6689
6799
|
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
6690
6800
|
* + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
|
|
@@ -6699,7 +6809,7 @@ interface LineItem$3 {
|
|
|
6699
6809
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
6700
6810
|
* @readonly
|
|
6701
6811
|
*/
|
|
6702
|
-
serviceProperties?: ServiceProperties$
|
|
6812
|
+
serviceProperties?: ServiceProperties$5;
|
|
6703
6813
|
/**
|
|
6704
6814
|
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
6705
6815
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -6712,7 +6822,7 @@ interface LineItem$3 {
|
|
|
6712
6822
|
* Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
|
|
6713
6823
|
* @readonly
|
|
6714
6824
|
*/
|
|
6715
|
-
priceDescription?: PriceDescription$
|
|
6825
|
+
priceDescription?: PriceDescription$9;
|
|
6716
6826
|
/**
|
|
6717
6827
|
* Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
6718
6828
|
* @readonly
|
|
@@ -6748,7 +6858,7 @@ interface CatalogReference$9 {
|
|
|
6748
6858
|
*/
|
|
6749
6859
|
options?: Record<string, any> | null;
|
|
6750
6860
|
}
|
|
6751
|
-
interface ProductName$
|
|
6861
|
+
interface ProductName$9 {
|
|
6752
6862
|
/**
|
|
6753
6863
|
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
6754
6864
|
*
|
|
@@ -6765,7 +6875,7 @@ interface ProductName$7 {
|
|
|
6765
6875
|
*/
|
|
6766
6876
|
translated?: string | null;
|
|
6767
6877
|
}
|
|
6768
|
-
interface PageUrlV2$
|
|
6878
|
+
interface PageUrlV2$3 {
|
|
6769
6879
|
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
6770
6880
|
relativePath?: string;
|
|
6771
6881
|
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
@@ -6790,25 +6900,25 @@ interface MultiCurrencyPrice$3 {
|
|
|
6790
6900
|
*/
|
|
6791
6901
|
formattedConvertedAmount?: string;
|
|
6792
6902
|
}
|
|
6793
|
-
interface DescriptionLine$
|
|
6903
|
+
interface DescriptionLine$9 extends DescriptionLineValueOneOf$9, DescriptionLineDescriptionLineValueOneOf$9 {
|
|
6794
6904
|
/** Description line plain text value. */
|
|
6795
|
-
plainText?: PlainTextValue$
|
|
6905
|
+
plainText?: PlainTextValue$9;
|
|
6796
6906
|
/** Description line color value. */
|
|
6797
|
-
colorInfo?: Color$
|
|
6907
|
+
colorInfo?: Color$9;
|
|
6798
6908
|
/** Description line name. */
|
|
6799
|
-
name?: DescriptionLineName$
|
|
6909
|
+
name?: DescriptionLineName$9;
|
|
6800
6910
|
}
|
|
6801
6911
|
/** @oneof */
|
|
6802
|
-
interface DescriptionLineValueOneOf$
|
|
6912
|
+
interface DescriptionLineValueOneOf$9 {
|
|
6803
6913
|
/** Description line plain text value. */
|
|
6804
|
-
plainText?: PlainTextValue$
|
|
6914
|
+
plainText?: PlainTextValue$9;
|
|
6805
6915
|
/** Description line color value. */
|
|
6806
|
-
colorInfo?: Color$
|
|
6916
|
+
colorInfo?: Color$9;
|
|
6807
6917
|
}
|
|
6808
6918
|
/** @oneof */
|
|
6809
|
-
interface DescriptionLineDescriptionLineValueOneOf$
|
|
6919
|
+
interface DescriptionLineDescriptionLineValueOneOf$9 {
|
|
6810
6920
|
}
|
|
6811
|
-
interface DescriptionLineName$
|
|
6921
|
+
interface DescriptionLineName$9 {
|
|
6812
6922
|
/** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
6813
6923
|
original?: string;
|
|
6814
6924
|
/**
|
|
@@ -6818,7 +6928,7 @@ interface DescriptionLineName$7 {
|
|
|
6818
6928
|
*/
|
|
6819
6929
|
translated?: string | null;
|
|
6820
6930
|
}
|
|
6821
|
-
interface PlainTextValue$
|
|
6931
|
+
interface PlainTextValue$9 {
|
|
6822
6932
|
/** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
6823
6933
|
original?: string;
|
|
6824
6934
|
/**
|
|
@@ -6828,7 +6938,7 @@ interface PlainTextValue$7 {
|
|
|
6828
6938
|
*/
|
|
6829
6939
|
translated?: string | null;
|
|
6830
6940
|
}
|
|
6831
|
-
interface Color$
|
|
6941
|
+
interface Color$9 {
|
|
6832
6942
|
/** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
6833
6943
|
original?: string;
|
|
6834
6944
|
/**
|
|
@@ -6887,7 +6997,7 @@ declare enum ItemAvailabilityStatus$3 {
|
|
|
6887
6997
|
/** Available quantity is less than requested */
|
|
6888
6998
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
6889
6999
|
}
|
|
6890
|
-
interface PhysicalProperties$
|
|
7000
|
+
interface PhysicalProperties$9 {
|
|
6891
7001
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
6892
7002
|
weight?: number | null;
|
|
6893
7003
|
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
@@ -6895,14 +7005,14 @@ interface PhysicalProperties$7 {
|
|
|
6895
7005
|
/** Whether this line item is shippable. */
|
|
6896
7006
|
shippable?: boolean;
|
|
6897
7007
|
}
|
|
6898
|
-
interface ItemType$
|
|
7008
|
+
interface ItemType$9 extends ItemTypeItemTypeDataOneOf$9 {
|
|
6899
7009
|
/** Preset item type. */
|
|
6900
7010
|
preset?: ItemTypeItemType$9;
|
|
6901
7011
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
6902
7012
|
custom?: string;
|
|
6903
7013
|
}
|
|
6904
7014
|
/** @oneof */
|
|
6905
|
-
interface ItemTypeItemTypeDataOneOf$
|
|
7015
|
+
interface ItemTypeItemTypeDataOneOf$9 {
|
|
6906
7016
|
/** Preset item type. */
|
|
6907
7017
|
preset?: ItemTypeItemType$9;
|
|
6908
7018
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
@@ -6944,7 +7054,7 @@ declare enum PaymentOptionType$9 {
|
|
|
6944
7054
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
6945
7055
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
6946
7056
|
}
|
|
6947
|
-
interface ServiceProperties$
|
|
7057
|
+
interface ServiceProperties$5 {
|
|
6948
7058
|
/**
|
|
6949
7059
|
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
6950
7060
|
* For example, the start time of a class.
|
|
@@ -6953,7 +7063,7 @@ interface ServiceProperties$3 {
|
|
|
6953
7063
|
/** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
|
|
6954
7064
|
numberOfParticipants?: number | null;
|
|
6955
7065
|
}
|
|
6956
|
-
interface PriceDescription$
|
|
7066
|
+
interface PriceDescription$9 {
|
|
6957
7067
|
/** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
6958
7068
|
original?: string;
|
|
6959
7069
|
/**
|
|
@@ -6970,7 +7080,7 @@ interface SelectedMembership$3 {
|
|
|
6970
7080
|
/** ID of the app providing this payment option. */
|
|
6971
7081
|
appId?: string;
|
|
6972
7082
|
}
|
|
6973
|
-
interface Image$
|
|
7083
|
+
interface Image$5 {
|
|
6974
7084
|
/** WixMedia image ID. */
|
|
6975
7085
|
id?: string;
|
|
6976
7086
|
/** Original image height. */
|
|
@@ -7148,7 +7258,7 @@ interface UpdateCartRequest$1 {
|
|
|
7148
7258
|
/** Catalog line items. */
|
|
7149
7259
|
lineItems?: LineItem$3[];
|
|
7150
7260
|
/** Custom line items. */
|
|
7151
|
-
customLineItems?: CustomLineItem$
|
|
7261
|
+
customLineItems?: CustomLineItem$7[];
|
|
7152
7262
|
}
|
|
7153
7263
|
interface MerchantDiscountInput$1 {
|
|
7154
7264
|
/** Discount amount. */
|
|
@@ -7156,7 +7266,7 @@ interface MerchantDiscountInput$1 {
|
|
|
7156
7266
|
/** IDs of line items the discount applies to. */
|
|
7157
7267
|
lineItemIds?: string[];
|
|
7158
7268
|
}
|
|
7159
|
-
interface CustomLineItem$
|
|
7269
|
+
interface CustomLineItem$7 {
|
|
7160
7270
|
/**
|
|
7161
7271
|
* Custom line item quantity.
|
|
7162
7272
|
*
|
|
@@ -7171,11 +7281,11 @@ interface CustomLineItem$3 {
|
|
|
7171
7281
|
*/
|
|
7172
7282
|
price?: string;
|
|
7173
7283
|
/** 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$
|
|
7284
|
+
priceDescription?: PriceDescription$9;
|
|
7175
7285
|
/** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
|
|
7176
|
-
descriptionLines?: DescriptionLine$
|
|
7286
|
+
descriptionLines?: DescriptionLine$9[];
|
|
7177
7287
|
/** Custom line item's media. */
|
|
7178
|
-
media?: Image$
|
|
7288
|
+
media?: Image$5;
|
|
7179
7289
|
/**
|
|
7180
7290
|
* Custom line item ID. If passed, `id` must be unique.
|
|
7181
7291
|
* Default: auto-generated ID.
|
|
@@ -7184,14 +7294,14 @@ interface CustomLineItem$3 {
|
|
|
7184
7294
|
/** Tax group ID for this custom line item. */
|
|
7185
7295
|
taxGroupId?: string | null;
|
|
7186
7296
|
/** Name of the item or product. */
|
|
7187
|
-
productName?: ProductName$
|
|
7297
|
+
productName?: ProductName$9;
|
|
7188
7298
|
/**
|
|
7189
7299
|
* 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
7300
|
* The URL is optional and if not provided, the site URL will be used.
|
|
7191
7301
|
*/
|
|
7192
|
-
url?: PageUrlV2$
|
|
7302
|
+
url?: PageUrlV2$3;
|
|
7193
7303
|
/** Item type. Either a preset type or custom. */
|
|
7194
|
-
itemType?: ItemType$
|
|
7304
|
+
itemType?: ItemType$9;
|
|
7195
7305
|
/** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
7196
7306
|
fullPrice?: string | null;
|
|
7197
7307
|
/**
|
|
@@ -7200,7 +7310,7 @@ interface CustomLineItem$3 {
|
|
|
7200
7310
|
*/
|
|
7201
7311
|
quantityAvailable?: number | null;
|
|
7202
7312
|
/** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
7203
|
-
physicalProperties?: PhysicalProperties$
|
|
7313
|
+
physicalProperties?: PhysicalProperties$9;
|
|
7204
7314
|
/**
|
|
7205
7315
|
* Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
7206
7316
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
@@ -7213,7 +7323,7 @@ interface CustomLineItem$3 {
|
|
|
7213
7323
|
* Optional - Service properties. When relevant, this contains information such as date and number of participants.
|
|
7214
7324
|
* Used, among other things, when checking for valid memberships.
|
|
7215
7325
|
*/
|
|
7216
|
-
serviceProperties?: ServiceProperties$
|
|
7326
|
+
serviceProperties?: ServiceProperties$5;
|
|
7217
7327
|
/**
|
|
7218
7328
|
* Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
7219
7329
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -7238,7 +7348,7 @@ interface AddToCurrentCartRequest$1 {
|
|
|
7238
7348
|
/** Catalog line items. */
|
|
7239
7349
|
lineItems?: LineItem$3[];
|
|
7240
7350
|
/** Custom line items. */
|
|
7241
|
-
customLineItems?: CustomLineItem$
|
|
7351
|
+
customLineItems?: CustomLineItem$7[];
|
|
7242
7352
|
}
|
|
7243
7353
|
interface AddToCartResponse$1 {
|
|
7244
7354
|
/** Updated cart. */
|
|
@@ -8504,7 +8614,7 @@ interface LineItem$2 {
|
|
|
8504
8614
|
* + Events - `ticket.name`
|
|
8505
8615
|
* @readonly
|
|
8506
8616
|
*/
|
|
8507
|
-
productName?: ProductName$
|
|
8617
|
+
productName?: ProductName$8;
|
|
8508
8618
|
/**
|
|
8509
8619
|
* URL to the item's page on the site.
|
|
8510
8620
|
* @readonly
|
|
@@ -8529,7 +8639,7 @@ interface LineItem$2 {
|
|
|
8529
8639
|
* Line item description lines. Used for displaying the cart, checkout and order.
|
|
8530
8640
|
* @readonly
|
|
8531
8641
|
*/
|
|
8532
|
-
descriptionLines?: DescriptionLine$
|
|
8642
|
+
descriptionLines?: DescriptionLine$8[];
|
|
8533
8643
|
/**
|
|
8534
8644
|
* Line item image details.
|
|
8535
8645
|
* @readonly
|
|
@@ -8544,12 +8654,12 @@ interface LineItem$2 {
|
|
|
8544
8654
|
* Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
|
|
8545
8655
|
* @readonly
|
|
8546
8656
|
*/
|
|
8547
|
-
physicalProperties?: PhysicalProperties$
|
|
8657
|
+
physicalProperties?: PhysicalProperties$8;
|
|
8548
8658
|
/**
|
|
8549
8659
|
* Item type. Either a preset type or custom.
|
|
8550
8660
|
* @readonly
|
|
8551
8661
|
*/
|
|
8552
|
-
itemType?: ItemType$
|
|
8662
|
+
itemType?: ItemType$8;
|
|
8553
8663
|
/**
|
|
8554
8664
|
* Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
|
|
8555
8665
|
* + `"FULL_PAYMENT_ONLINE"` - The entire payment for this item happens as part of the checkout.
|
|
@@ -8562,7 +8672,7 @@ interface LineItem$2 {
|
|
|
8562
8672
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
8563
8673
|
* @readonly
|
|
8564
8674
|
*/
|
|
8565
|
-
serviceProperties?: ServiceProperties$
|
|
8675
|
+
serviceProperties?: ServiceProperties$4;
|
|
8566
8676
|
/**
|
|
8567
8677
|
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
8568
8678
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -8575,7 +8685,7 @@ interface LineItem$2 {
|
|
|
8575
8685
|
* Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
|
|
8576
8686
|
* @readonly
|
|
8577
8687
|
*/
|
|
8578
|
-
priceDescription?: PriceDescription$
|
|
8688
|
+
priceDescription?: PriceDescription$8;
|
|
8579
8689
|
/**
|
|
8580
8690
|
* Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
8581
8691
|
* @readonly
|
|
@@ -8613,7 +8723,7 @@ interface CatalogReference$8 {
|
|
|
8613
8723
|
*/
|
|
8614
8724
|
options?: Record<string, any> | null;
|
|
8615
8725
|
}
|
|
8616
|
-
interface ProductName$
|
|
8726
|
+
interface ProductName$8 {
|
|
8617
8727
|
/** **Required** - Original product name (in site's default language). */
|
|
8618
8728
|
original?: string;
|
|
8619
8729
|
/** Description product name translated into buyer's language. Defaults to `original` when not defined. */
|
|
@@ -8638,37 +8748,37 @@ interface MultiCurrencyPrice$2 {
|
|
|
8638
8748
|
*/
|
|
8639
8749
|
formattedConvertedAmount?: string;
|
|
8640
8750
|
}
|
|
8641
|
-
interface DescriptionLine$
|
|
8751
|
+
interface DescriptionLine$8 extends DescriptionLineValueOneOf$8, DescriptionLineDescriptionLineValueOneOf$8 {
|
|
8642
8752
|
/** Description line plain text value. */
|
|
8643
|
-
plainText?: PlainTextValue$
|
|
8753
|
+
plainText?: PlainTextValue$8;
|
|
8644
8754
|
/** Description line color value. */
|
|
8645
|
-
colorInfo?: Color$
|
|
8755
|
+
colorInfo?: Color$8;
|
|
8646
8756
|
/** Description line name. */
|
|
8647
|
-
name?: DescriptionLineName$
|
|
8757
|
+
name?: DescriptionLineName$8;
|
|
8648
8758
|
}
|
|
8649
8759
|
/** @oneof */
|
|
8650
|
-
interface DescriptionLineValueOneOf$
|
|
8760
|
+
interface DescriptionLineValueOneOf$8 {
|
|
8651
8761
|
/** Description line plain text value. */
|
|
8652
|
-
plainText?: PlainTextValue$
|
|
8762
|
+
plainText?: PlainTextValue$8;
|
|
8653
8763
|
/** Description line color value. */
|
|
8654
|
-
colorInfo?: Color$
|
|
8764
|
+
colorInfo?: Color$8;
|
|
8655
8765
|
}
|
|
8656
8766
|
/** @oneof */
|
|
8657
|
-
interface DescriptionLineDescriptionLineValueOneOf$
|
|
8767
|
+
interface DescriptionLineDescriptionLineValueOneOf$8 {
|
|
8658
8768
|
}
|
|
8659
|
-
interface DescriptionLineName$
|
|
8769
|
+
interface DescriptionLineName$8 {
|
|
8660
8770
|
/** Description line name in site's default language. */
|
|
8661
8771
|
original?: string;
|
|
8662
8772
|
/** Description line name translated into buyer's language. Defaults to `original` when not defined. */
|
|
8663
8773
|
translated?: string | null;
|
|
8664
8774
|
}
|
|
8665
|
-
interface PlainTextValue$
|
|
8775
|
+
interface PlainTextValue$8 {
|
|
8666
8776
|
/** Description line plain text value in site's default language. */
|
|
8667
8777
|
original?: string;
|
|
8668
8778
|
/** Description line plain text value translated into buyer's language. Defaults to `original` when not defined. */
|
|
8669
8779
|
translated?: string | null;
|
|
8670
8780
|
}
|
|
8671
|
-
interface Color$
|
|
8781
|
+
interface Color$8 {
|
|
8672
8782
|
/** Description line color name in site's default language. */
|
|
8673
8783
|
original?: string;
|
|
8674
8784
|
/** Description line color name translated into buyer's language. Defaults to `original` when not defined. */
|
|
@@ -8704,7 +8814,7 @@ declare enum ItemAvailabilityStatus$2 {
|
|
|
8704
8814
|
/** Available quantity is less than requested */
|
|
8705
8815
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
8706
8816
|
}
|
|
8707
|
-
interface PhysicalProperties$
|
|
8817
|
+
interface PhysicalProperties$8 {
|
|
8708
8818
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
8709
8819
|
weight?: number | null;
|
|
8710
8820
|
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
@@ -8712,14 +8822,14 @@ interface PhysicalProperties$6 {
|
|
|
8712
8822
|
/** Whether this line item is shippable. */
|
|
8713
8823
|
shippable?: boolean;
|
|
8714
8824
|
}
|
|
8715
|
-
interface ItemType$
|
|
8825
|
+
interface ItemType$8 extends ItemTypeItemTypeDataOneOf$8 {
|
|
8716
8826
|
/** Preset item type. */
|
|
8717
8827
|
preset?: ItemTypeItemType$8;
|
|
8718
8828
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
8719
8829
|
custom?: string;
|
|
8720
8830
|
}
|
|
8721
8831
|
/** @oneof */
|
|
8722
|
-
interface ItemTypeItemTypeDataOneOf$
|
|
8832
|
+
interface ItemTypeItemTypeDataOneOf$8 {
|
|
8723
8833
|
/** Preset item type. */
|
|
8724
8834
|
preset?: ItemTypeItemType$8;
|
|
8725
8835
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
@@ -8761,13 +8871,13 @@ declare enum PaymentOptionType$8 {
|
|
|
8761
8871
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
8762
8872
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
8763
8873
|
}
|
|
8764
|
-
interface ServiceProperties$
|
|
8874
|
+
interface ServiceProperties$4 {
|
|
8765
8875
|
/** The date and time for which the service is supposed to be provided. For example, the time of the class. */
|
|
8766
8876
|
scheduledDate?: Date;
|
|
8767
8877
|
/** The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room. */
|
|
8768
8878
|
numberOfParticipants?: number | null;
|
|
8769
8879
|
}
|
|
8770
|
-
interface PriceDescription$
|
|
8880
|
+
interface PriceDescription$8 {
|
|
8771
8881
|
/**
|
|
8772
8882
|
* **Required** - Original price description (in site's default language).
|
|
8773
8883
|
*
|
|
@@ -8939,7 +9049,7 @@ interface UpdateCartRequest {
|
|
|
8939
9049
|
/** Catalog line items. */
|
|
8940
9050
|
lineItems?: LineItem$2[];
|
|
8941
9051
|
/** Custom line items. */
|
|
8942
|
-
customLineItems?: CustomLineItem$
|
|
9052
|
+
customLineItems?: CustomLineItem$6[];
|
|
8943
9053
|
}
|
|
8944
9054
|
interface MerchantDiscountInput {
|
|
8945
9055
|
/** Discount amount. */
|
|
@@ -8947,7 +9057,7 @@ interface MerchantDiscountInput {
|
|
|
8947
9057
|
/** IDs of the line items the discount applies to. */
|
|
8948
9058
|
lineItemIds?: string[];
|
|
8949
9059
|
}
|
|
8950
|
-
interface CustomLineItem$
|
|
9060
|
+
interface CustomLineItem$6 {
|
|
8951
9061
|
/**
|
|
8952
9062
|
* Custom line item quantity.
|
|
8953
9063
|
*
|
|
@@ -8962,9 +9072,9 @@ interface CustomLineItem$2 {
|
|
|
8962
9072
|
*/
|
|
8963
9073
|
price?: string;
|
|
8964
9074
|
/** 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$
|
|
9075
|
+
priceDescription?: PriceDescription$8;
|
|
8966
9076
|
/** Custom line item description lines. Used for displaying the cart, checkout and order. */
|
|
8967
|
-
descriptionLines?: DescriptionLine$
|
|
9077
|
+
descriptionLines?: DescriptionLine$8[];
|
|
8968
9078
|
/**
|
|
8969
9079
|
* Custom line item media. Supported formats:
|
|
8970
9080
|
* + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
|
|
@@ -8979,14 +9089,14 @@ interface CustomLineItem$2 {
|
|
|
8979
9089
|
/** Tax group ID for this custom line item. */
|
|
8980
9090
|
taxGroupId?: string | null;
|
|
8981
9091
|
/** Name of the item or product. */
|
|
8982
|
-
productName?: ProductName$
|
|
9092
|
+
productName?: ProductName$8;
|
|
8983
9093
|
/**
|
|
8984
9094
|
* 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
9095
|
* The URL is optional and if not provided, the site URL will be used.
|
|
8986
9096
|
*/
|
|
8987
9097
|
url?: string;
|
|
8988
9098
|
/** Item type. Either a preset type or custom. */
|
|
8989
|
-
itemType?: ItemType$
|
|
9099
|
+
itemType?: ItemType$8;
|
|
8990
9100
|
/** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
8991
9101
|
fullPrice?: string | null;
|
|
8992
9102
|
/**
|
|
@@ -8995,7 +9105,7 @@ interface CustomLineItem$2 {
|
|
|
8995
9105
|
*/
|
|
8996
9106
|
quantityAvailable?: number | null;
|
|
8997
9107
|
/** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
8998
|
-
physicalProperties?: PhysicalProperties$
|
|
9108
|
+
physicalProperties?: PhysicalProperties$8;
|
|
8999
9109
|
/**
|
|
9000
9110
|
* Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
9001
9111
|
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
@@ -9008,7 +9118,7 @@ interface CustomLineItem$2 {
|
|
|
9008
9118
|
* Optional - Service properties. When relevant, this contains information such as date and number of participants.
|
|
9009
9119
|
* Used, among other things, when checking for valid memberships.
|
|
9010
9120
|
*/
|
|
9011
|
-
serviceProperties?: ServiceProperties$
|
|
9121
|
+
serviceProperties?: ServiceProperties$4;
|
|
9012
9122
|
/**
|
|
9013
9123
|
* Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
9014
9124
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -9033,7 +9143,7 @@ interface AddToCurrentCartRequest {
|
|
|
9033
9143
|
/** Catalog line items. */
|
|
9034
9144
|
lineItems?: LineItem$2[];
|
|
9035
9145
|
/** Custom line items. */
|
|
9036
|
-
customLineItems?: CustomLineItem$
|
|
9146
|
+
customLineItems?: CustomLineItem$6[];
|
|
9037
9147
|
}
|
|
9038
9148
|
interface AddToCartResponse {
|
|
9039
9149
|
/** Updated cart. */
|
|
@@ -10385,6 +10495,12 @@ interface Checkout$1 {
|
|
|
10385
10495
|
* Custom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout).
|
|
10386
10496
|
*/
|
|
10387
10497
|
customSettings?: CustomSettings$1;
|
|
10498
|
+
/**
|
|
10499
|
+
* Customize the content of the checkout page.
|
|
10500
|
+
*
|
|
10501
|
+
* Includes IDs for the app and the component providing the content
|
|
10502
|
+
*/
|
|
10503
|
+
customContentReference?: CustomContentReference$3;
|
|
10388
10504
|
}
|
|
10389
10505
|
interface LineItem$1 {
|
|
10390
10506
|
/**
|
|
@@ -10408,12 +10524,12 @@ interface LineItem$1 {
|
|
|
10408
10524
|
* + Events - `ticket.name`
|
|
10409
10525
|
* @readonly
|
|
10410
10526
|
*/
|
|
10411
|
-
productName?: ProductName$
|
|
10527
|
+
productName?: ProductName$7;
|
|
10412
10528
|
/**
|
|
10413
10529
|
* URL to the item's page on the site.
|
|
10414
10530
|
* @readonly
|
|
10415
10531
|
*/
|
|
10416
|
-
url?: PageUrlV2$
|
|
10532
|
+
url?: PageUrlV2$2;
|
|
10417
10533
|
/**
|
|
10418
10534
|
* Item price **after** catalog-defined discount and line item discounts.
|
|
10419
10535
|
* @readonly
|
|
@@ -10458,7 +10574,7 @@ interface LineItem$1 {
|
|
|
10458
10574
|
* Line item description lines. Used for display purposes for the cart, checkout and order.
|
|
10459
10575
|
* @readonly
|
|
10460
10576
|
*/
|
|
10461
|
-
descriptionLines?: DescriptionLine$
|
|
10577
|
+
descriptionLines?: DescriptionLine$7[];
|
|
10462
10578
|
/**
|
|
10463
10579
|
* Line item image details.
|
|
10464
10580
|
* @readonly
|
|
@@ -10473,12 +10589,12 @@ interface LineItem$1 {
|
|
|
10473
10589
|
* Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
|
|
10474
10590
|
* @readonly
|
|
10475
10591
|
*/
|
|
10476
|
-
physicalProperties?: PhysicalProperties$
|
|
10592
|
+
physicalProperties?: PhysicalProperties$7;
|
|
10477
10593
|
/**
|
|
10478
10594
|
* Item type. Either a preset type or custom.
|
|
10479
10595
|
* @readonly
|
|
10480
10596
|
*/
|
|
10481
|
-
itemType?: ItemType$
|
|
10597
|
+
itemType?: ItemType$7;
|
|
10482
10598
|
/**
|
|
10483
10599
|
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
10484
10600
|
* + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
|
|
@@ -10493,7 +10609,7 @@ interface LineItem$1 {
|
|
|
10493
10609
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
10494
10610
|
* @readonly
|
|
10495
10611
|
*/
|
|
10496
|
-
serviceProperties?: ServiceProperties$
|
|
10612
|
+
serviceProperties?: ServiceProperties$3;
|
|
10497
10613
|
/**
|
|
10498
10614
|
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
10499
10615
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -10506,7 +10622,7 @@ interface LineItem$1 {
|
|
|
10506
10622
|
* Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
|
|
10507
10623
|
* @readonly
|
|
10508
10624
|
*/
|
|
10509
|
-
priceDescription?: PriceDescription$
|
|
10625
|
+
priceDescription?: PriceDescription$7;
|
|
10510
10626
|
/**
|
|
10511
10627
|
* Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
10512
10628
|
* @readonly
|
|
@@ -10535,7 +10651,7 @@ interface CatalogReference$7 {
|
|
|
10535
10651
|
*/
|
|
10536
10652
|
options?: Record<string, any> | null;
|
|
10537
10653
|
}
|
|
10538
|
-
interface ProductName$
|
|
10654
|
+
interface ProductName$7 {
|
|
10539
10655
|
/**
|
|
10540
10656
|
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
10541
10657
|
*
|
|
@@ -10552,7 +10668,7 @@ interface ProductName$5 {
|
|
|
10552
10668
|
*/
|
|
10553
10669
|
translated?: string | null;
|
|
10554
10670
|
}
|
|
10555
|
-
interface PageUrlV2$
|
|
10671
|
+
interface PageUrlV2$2 {
|
|
10556
10672
|
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
10557
10673
|
relativePath?: string;
|
|
10558
10674
|
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
@@ -10608,25 +10724,25 @@ declare enum JurisdictionType$5 {
|
|
|
10608
10724
|
CITY = "CITY",
|
|
10609
10725
|
SPECIAL = "SPECIAL"
|
|
10610
10726
|
}
|
|
10611
|
-
interface DescriptionLine$
|
|
10727
|
+
interface DescriptionLine$7 extends DescriptionLineValueOneOf$7, DescriptionLineDescriptionLineValueOneOf$7 {
|
|
10612
10728
|
/** Description line plain text value. */
|
|
10613
|
-
plainText?: PlainTextValue$
|
|
10729
|
+
plainText?: PlainTextValue$7;
|
|
10614
10730
|
/** Description line color value. */
|
|
10615
|
-
colorInfo?: Color$
|
|
10731
|
+
colorInfo?: Color$7;
|
|
10616
10732
|
/** Description line name. */
|
|
10617
|
-
name?: DescriptionLineName$
|
|
10733
|
+
name?: DescriptionLineName$7;
|
|
10618
10734
|
}
|
|
10619
10735
|
/** @oneof */
|
|
10620
|
-
interface DescriptionLineValueOneOf$
|
|
10736
|
+
interface DescriptionLineValueOneOf$7 {
|
|
10621
10737
|
/** Description line plain text value. */
|
|
10622
|
-
plainText?: PlainTextValue$
|
|
10738
|
+
plainText?: PlainTextValue$7;
|
|
10623
10739
|
/** Description line color value. */
|
|
10624
|
-
colorInfo?: Color$
|
|
10740
|
+
colorInfo?: Color$7;
|
|
10625
10741
|
}
|
|
10626
10742
|
/** @oneof */
|
|
10627
|
-
interface DescriptionLineDescriptionLineValueOneOf$
|
|
10743
|
+
interface DescriptionLineDescriptionLineValueOneOf$7 {
|
|
10628
10744
|
}
|
|
10629
|
-
interface DescriptionLineName$
|
|
10745
|
+
interface DescriptionLineName$7 {
|
|
10630
10746
|
/** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
10631
10747
|
original?: string;
|
|
10632
10748
|
/**
|
|
@@ -10636,7 +10752,7 @@ interface DescriptionLineName$5 {
|
|
|
10636
10752
|
*/
|
|
10637
10753
|
translated?: string | null;
|
|
10638
10754
|
}
|
|
10639
|
-
interface PlainTextValue$
|
|
10755
|
+
interface PlainTextValue$7 {
|
|
10640
10756
|
/** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
10641
10757
|
original?: string;
|
|
10642
10758
|
/**
|
|
@@ -10646,7 +10762,7 @@ interface PlainTextValue$5 {
|
|
|
10646
10762
|
*/
|
|
10647
10763
|
translated?: string | null;
|
|
10648
10764
|
}
|
|
10649
|
-
interface Color$
|
|
10765
|
+
interface Color$7 {
|
|
10650
10766
|
/** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
10651
10767
|
original?: string;
|
|
10652
10768
|
/**
|
|
@@ -10705,7 +10821,7 @@ declare enum ItemAvailabilityStatus$1 {
|
|
|
10705
10821
|
/** Available quantity is less than requested */
|
|
10706
10822
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
10707
10823
|
}
|
|
10708
|
-
interface PhysicalProperties$
|
|
10824
|
+
interface PhysicalProperties$7 {
|
|
10709
10825
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
10710
10826
|
weight?: number | null;
|
|
10711
10827
|
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
@@ -10713,14 +10829,14 @@ interface PhysicalProperties$5 {
|
|
|
10713
10829
|
/** Whether this line item is shippable. */
|
|
10714
10830
|
shippable?: boolean;
|
|
10715
10831
|
}
|
|
10716
|
-
interface ItemType$
|
|
10832
|
+
interface ItemType$7 extends ItemTypeItemTypeDataOneOf$7 {
|
|
10717
10833
|
/** Preset item type. */
|
|
10718
10834
|
preset?: ItemTypeItemType$7;
|
|
10719
10835
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
10720
10836
|
custom?: string;
|
|
10721
10837
|
}
|
|
10722
10838
|
/** @oneof */
|
|
10723
|
-
interface ItemTypeItemTypeDataOneOf$
|
|
10839
|
+
interface ItemTypeItemTypeDataOneOf$7 {
|
|
10724
10840
|
/** Preset item type. */
|
|
10725
10841
|
preset?: ItemTypeItemType$7;
|
|
10726
10842
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
@@ -10762,7 +10878,7 @@ declare enum PaymentOptionType$7 {
|
|
|
10762
10878
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
10763
10879
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
10764
10880
|
}
|
|
10765
|
-
interface ServiceProperties$
|
|
10881
|
+
interface ServiceProperties$3 {
|
|
10766
10882
|
/**
|
|
10767
10883
|
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
10768
10884
|
* For example, the start time of a class.
|
|
@@ -10771,7 +10887,7 @@ interface ServiceProperties$1 {
|
|
|
10771
10887
|
/** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
|
|
10772
10888
|
numberOfParticipants?: number | null;
|
|
10773
10889
|
}
|
|
10774
|
-
interface PriceDescription$
|
|
10890
|
+
interface PriceDescription$7 {
|
|
10775
10891
|
/** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
10776
10892
|
original?: string;
|
|
10777
10893
|
/**
|
|
@@ -10781,6 +10897,18 @@ interface PriceDescription$5 {
|
|
|
10781
10897
|
*/
|
|
10782
10898
|
translated?: string | null;
|
|
10783
10899
|
}
|
|
10900
|
+
interface Image$4 {
|
|
10901
|
+
/** WixMedia image ID. */
|
|
10902
|
+
id?: string;
|
|
10903
|
+
/** Original image height. */
|
|
10904
|
+
height?: number;
|
|
10905
|
+
/** Original image width. */
|
|
10906
|
+
width?: number;
|
|
10907
|
+
/** Image alt text. Optional. */
|
|
10908
|
+
altText?: string | null;
|
|
10909
|
+
/** Image filename. Optional. */
|
|
10910
|
+
filename?: string | null;
|
|
10911
|
+
}
|
|
10784
10912
|
/** Billing Info and shipping details */
|
|
10785
10913
|
interface AddressWithContact$5 {
|
|
10786
10914
|
/** Address. */
|
|
@@ -11530,6 +11658,20 @@ interface CustomSettings$1 {
|
|
|
11530
11658
|
*/
|
|
11531
11659
|
disabledManualPayment?: boolean;
|
|
11532
11660
|
}
|
|
11661
|
+
interface CustomContentReference$3 {
|
|
11662
|
+
/**
|
|
11663
|
+
* ID of the app providing the content.
|
|
11664
|
+
*
|
|
11665
|
+
* You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
11666
|
+
*/
|
|
11667
|
+
appId?: string;
|
|
11668
|
+
/**
|
|
11669
|
+
* ID of the component within the app it belongs to.
|
|
11670
|
+
*
|
|
11671
|
+
* You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
11672
|
+
*/
|
|
11673
|
+
componentId?: string;
|
|
11674
|
+
}
|
|
11533
11675
|
interface CreateCheckoutRequest$1 {
|
|
11534
11676
|
/** Checkout information. */
|
|
11535
11677
|
checkoutInfo?: Checkout$1;
|
|
@@ -11537,6 +11679,8 @@ interface CreateCheckoutRequest$1 {
|
|
|
11537
11679
|
couponCode?: string | null;
|
|
11538
11680
|
/** Line items to be added to checkout. */
|
|
11539
11681
|
lineItems?: LineItem$1[];
|
|
11682
|
+
/** Custom line items to be added to checkout. */
|
|
11683
|
+
customLineItems?: CustomLineItem$5[];
|
|
11540
11684
|
/**
|
|
11541
11685
|
* Sales channel that submitted the order.
|
|
11542
11686
|
* + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
|
|
@@ -11568,6 +11712,80 @@ interface CreateCheckoutRequest$1 {
|
|
|
11568
11712
|
*/
|
|
11569
11713
|
overrideCheckoutUrl?: string | null;
|
|
11570
11714
|
}
|
|
11715
|
+
interface CustomLineItem$5 {
|
|
11716
|
+
/**
|
|
11717
|
+
* Custom line item quantity.
|
|
11718
|
+
*
|
|
11719
|
+
* Min: `1`
|
|
11720
|
+
* Max: `100000`
|
|
11721
|
+
*/
|
|
11722
|
+
quantity?: number;
|
|
11723
|
+
/**
|
|
11724
|
+
* Custom line item price.
|
|
11725
|
+
*
|
|
11726
|
+
* Must be a number or a decimal without symbols.
|
|
11727
|
+
*/
|
|
11728
|
+
price?: string;
|
|
11729
|
+
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
11730
|
+
priceDescription?: PriceDescription$7;
|
|
11731
|
+
/** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
|
|
11732
|
+
descriptionLines?: DescriptionLine$7[];
|
|
11733
|
+
/** Custom line item's media. */
|
|
11734
|
+
media?: Image$4;
|
|
11735
|
+
/**
|
|
11736
|
+
* Custom line item ID. If passed, `id` must be unique.
|
|
11737
|
+
* Default: auto-generated ID.
|
|
11738
|
+
*/
|
|
11739
|
+
id?: string | null;
|
|
11740
|
+
/** Tax group ID for this custom line item. */
|
|
11741
|
+
taxGroupId?: string | null;
|
|
11742
|
+
/** Name of the item or product. */
|
|
11743
|
+
productName?: ProductName$7;
|
|
11744
|
+
/**
|
|
11745
|
+
* 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.
|
|
11746
|
+
* The URL is optional and if not provided, the site URL will be used.
|
|
11747
|
+
*/
|
|
11748
|
+
url?: PageUrlV2$2;
|
|
11749
|
+
/** Item type. Either a preset type or custom. */
|
|
11750
|
+
itemType?: ItemType$7;
|
|
11751
|
+
/** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
11752
|
+
fullPrice?: string | null;
|
|
11753
|
+
/**
|
|
11754
|
+
* Optional - Item quantity available for purchase. Only return this if inventory is managed.
|
|
11755
|
+
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
11756
|
+
*/
|
|
11757
|
+
quantityAvailable?: number | null;
|
|
11758
|
+
/** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
11759
|
+
physicalProperties?: PhysicalProperties$7;
|
|
11760
|
+
/**
|
|
11761
|
+
* Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
11762
|
+
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
11763
|
+
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
11764
|
+
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
11765
|
+
* + `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.
|
|
11766
|
+
*/
|
|
11767
|
+
paymentOption?: PaymentOptionType$7;
|
|
11768
|
+
/**
|
|
11769
|
+
* Optional - Service properties. When relevant, this contains information such as date and number of participants.
|
|
11770
|
+
* Used, among other things, when checking for valid memberships.
|
|
11771
|
+
*/
|
|
11772
|
+
serviceProperties?: ServiceProperties$3;
|
|
11773
|
+
/**
|
|
11774
|
+
* Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
11775
|
+
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
11776
|
+
* + in most cases, this field is the name as `catalogReference.catalogItemId`.
|
|
11777
|
+
* + Used in membership validation.
|
|
11778
|
+
*/
|
|
11779
|
+
rootCatalogItemId?: string | null;
|
|
11780
|
+
/**
|
|
11781
|
+
* Optional - partial payment for the given item to be paid upfront during the checkout.
|
|
11782
|
+
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
11783
|
+
* If omitted - item's price will not be split and is expected to be paid in single installment
|
|
11784
|
+
*/
|
|
11785
|
+
depositAmount?: string | null;
|
|
11786
|
+
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
11787
|
+
catalogReference?: CatalogReference$7;
|
|
11788
|
+
}
|
|
11571
11789
|
interface CreateCheckoutResponse$1 {
|
|
11572
11790
|
/** Newly created checkout. */
|
|
11573
11791
|
checkout?: Checkout$1;
|
|
@@ -11615,6 +11833,8 @@ interface UpdateCheckoutRequest$1 {
|
|
|
11615
11833
|
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
11616
11834
|
*/
|
|
11617
11835
|
overrideCheckoutUrl?: string | null;
|
|
11836
|
+
/** Custom line items to be saved on checkout. */
|
|
11837
|
+
customLineItems?: CustomLineItem$5[];
|
|
11618
11838
|
}
|
|
11619
11839
|
interface UpdateCheckoutResponse$1 {
|
|
11620
11840
|
/** Updated checkout. */
|
|
@@ -11649,6 +11869,8 @@ interface AddToCheckoutRequest$1 {
|
|
|
11649
11869
|
id: string;
|
|
11650
11870
|
/** Catalog line items. */
|
|
11651
11871
|
lineItems?: LineItem$1[];
|
|
11872
|
+
/** Custom line items. */
|
|
11873
|
+
customLineItems?: CustomLineItem$5[];
|
|
11652
11874
|
}
|
|
11653
11875
|
interface AddToCheckoutResponse$1 {
|
|
11654
11876
|
/** Updated checkout. */
|
|
@@ -12345,6 +12567,12 @@ interface Checkout {
|
|
|
12345
12567
|
* Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
|
|
12346
12568
|
*/
|
|
12347
12569
|
customSettings?: CustomSettings;
|
|
12570
|
+
/**
|
|
12571
|
+
* Customize the content of the checkout page.
|
|
12572
|
+
*
|
|
12573
|
+
* Includes IDs for the app and the component providing the content
|
|
12574
|
+
*/
|
|
12575
|
+
customContentReference?: CustomContentReference$2;
|
|
12348
12576
|
}
|
|
12349
12577
|
interface LineItem {
|
|
12350
12578
|
/**
|
|
@@ -12368,7 +12596,7 @@ interface LineItem {
|
|
|
12368
12596
|
* + Events - `ticket.name`
|
|
12369
12597
|
* @readonly
|
|
12370
12598
|
*/
|
|
12371
|
-
productName?: ProductName$
|
|
12599
|
+
productName?: ProductName$6;
|
|
12372
12600
|
/**
|
|
12373
12601
|
* URL to the item's page on the site.
|
|
12374
12602
|
* @readonly
|
|
@@ -12418,7 +12646,7 @@ interface LineItem {
|
|
|
12418
12646
|
* Line item description lines. Used for displaying the cart, checkout and order.
|
|
12419
12647
|
* @readonly
|
|
12420
12648
|
*/
|
|
12421
|
-
descriptionLines?: DescriptionLine$
|
|
12649
|
+
descriptionLines?: DescriptionLine$6[];
|
|
12422
12650
|
/**
|
|
12423
12651
|
* Line item image details.
|
|
12424
12652
|
* @readonly
|
|
@@ -12433,12 +12661,12 @@ interface LineItem {
|
|
|
12433
12661
|
* Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
|
|
12434
12662
|
* @readonly
|
|
12435
12663
|
*/
|
|
12436
|
-
physicalProperties?: PhysicalProperties$
|
|
12664
|
+
physicalProperties?: PhysicalProperties$6;
|
|
12437
12665
|
/**
|
|
12438
12666
|
* Item type. Either a preset type or custom.
|
|
12439
12667
|
* @readonly
|
|
12440
12668
|
*/
|
|
12441
|
-
itemType?: ItemType$
|
|
12669
|
+
itemType?: ItemType$6;
|
|
12442
12670
|
/**
|
|
12443
12671
|
* Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
|
|
12444
12672
|
* + `"FULL_PAYMENT_ONLINE"`: The entire payment for this item happens as part of the checkout.
|
|
@@ -12452,7 +12680,7 @@ interface LineItem {
|
|
|
12452
12680
|
* Service properties. When relevant, this contains information such as date and number of participants.
|
|
12453
12681
|
* @readonly
|
|
12454
12682
|
*/
|
|
12455
|
-
serviceProperties?: ServiceProperties;
|
|
12683
|
+
serviceProperties?: ServiceProperties$2;
|
|
12456
12684
|
/**
|
|
12457
12685
|
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
12458
12686
|
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
@@ -12465,7 +12693,7 @@ interface LineItem {
|
|
|
12465
12693
|
* Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
|
|
12466
12694
|
* @readonly
|
|
12467
12695
|
*/
|
|
12468
|
-
priceDescription?: PriceDescription$
|
|
12696
|
+
priceDescription?: PriceDescription$6;
|
|
12469
12697
|
/**
|
|
12470
12698
|
* Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
|
|
12471
12699
|
* @readonly
|
|
@@ -12496,7 +12724,7 @@ interface CatalogReference$6 {
|
|
|
12496
12724
|
*/
|
|
12497
12725
|
options?: Record<string, any> | null;
|
|
12498
12726
|
}
|
|
12499
|
-
interface ProductName$
|
|
12727
|
+
interface ProductName$6 {
|
|
12500
12728
|
/**
|
|
12501
12729
|
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
12502
12730
|
*
|
|
@@ -12563,25 +12791,25 @@ declare enum JurisdictionType$4 {
|
|
|
12563
12791
|
CITY = "CITY",
|
|
12564
12792
|
SPECIAL = "SPECIAL"
|
|
12565
12793
|
}
|
|
12566
|
-
interface DescriptionLine$
|
|
12794
|
+
interface DescriptionLine$6 extends DescriptionLineValueOneOf$6, DescriptionLineDescriptionLineValueOneOf$6 {
|
|
12567
12795
|
/** Description line plain text value. */
|
|
12568
|
-
plainText?: PlainTextValue$
|
|
12796
|
+
plainText?: PlainTextValue$6;
|
|
12569
12797
|
/** Description line color value. */
|
|
12570
|
-
colorInfo?: Color$
|
|
12798
|
+
colorInfo?: Color$6;
|
|
12571
12799
|
/** Description line name. */
|
|
12572
|
-
name?: DescriptionLineName$
|
|
12800
|
+
name?: DescriptionLineName$6;
|
|
12573
12801
|
}
|
|
12574
12802
|
/** @oneof */
|
|
12575
|
-
interface DescriptionLineValueOneOf$
|
|
12803
|
+
interface DescriptionLineValueOneOf$6 {
|
|
12576
12804
|
/** Description line plain text value. */
|
|
12577
|
-
plainText?: PlainTextValue$
|
|
12805
|
+
plainText?: PlainTextValue$6;
|
|
12578
12806
|
/** Description line color value. */
|
|
12579
|
-
colorInfo?: Color$
|
|
12807
|
+
colorInfo?: Color$6;
|
|
12580
12808
|
}
|
|
12581
12809
|
/** @oneof */
|
|
12582
|
-
interface DescriptionLineDescriptionLineValueOneOf$
|
|
12810
|
+
interface DescriptionLineDescriptionLineValueOneOf$6 {
|
|
12583
12811
|
}
|
|
12584
|
-
interface DescriptionLineName$
|
|
12812
|
+
interface DescriptionLineName$6 {
|
|
12585
12813
|
/** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
12586
12814
|
original?: string;
|
|
12587
12815
|
/**
|
|
@@ -12591,7 +12819,7 @@ interface DescriptionLineName$4 {
|
|
|
12591
12819
|
*/
|
|
12592
12820
|
translated?: string | null;
|
|
12593
12821
|
}
|
|
12594
|
-
interface PlainTextValue$
|
|
12822
|
+
interface PlainTextValue$6 {
|
|
12595
12823
|
/** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
12596
12824
|
original?: string;
|
|
12597
12825
|
/**
|
|
@@ -12601,7 +12829,7 @@ interface PlainTextValue$4 {
|
|
|
12601
12829
|
*/
|
|
12602
12830
|
translated?: string | null;
|
|
12603
12831
|
}
|
|
12604
|
-
interface Color$
|
|
12832
|
+
interface Color$6 {
|
|
12605
12833
|
/** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
12606
12834
|
original?: string;
|
|
12607
12835
|
/**
|
|
@@ -12637,7 +12865,7 @@ declare enum ItemAvailabilityStatus {
|
|
|
12637
12865
|
/** Available quantity is less than requested */
|
|
12638
12866
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
12639
12867
|
}
|
|
12640
|
-
interface PhysicalProperties$
|
|
12868
|
+
interface PhysicalProperties$6 {
|
|
12641
12869
|
/** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
|
|
12642
12870
|
weight?: number | null;
|
|
12643
12871
|
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
@@ -12645,14 +12873,14 @@ interface PhysicalProperties$4 {
|
|
|
12645
12873
|
/** Whether this line item is shippable. */
|
|
12646
12874
|
shippable?: boolean;
|
|
12647
12875
|
}
|
|
12648
|
-
interface ItemType$
|
|
12876
|
+
interface ItemType$6 extends ItemTypeItemTypeDataOneOf$6 {
|
|
12649
12877
|
/** Preset item type. */
|
|
12650
12878
|
preset?: ItemTypeItemType$6;
|
|
12651
12879
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
12652
12880
|
custom?: string;
|
|
12653
12881
|
}
|
|
12654
12882
|
/** @oneof */
|
|
12655
|
-
interface ItemTypeItemTypeDataOneOf$
|
|
12883
|
+
interface ItemTypeItemTypeDataOneOf$6 {
|
|
12656
12884
|
/** Preset item type. */
|
|
12657
12885
|
preset?: ItemTypeItemType$6;
|
|
12658
12886
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
@@ -12694,7 +12922,7 @@ declare enum PaymentOptionType$6 {
|
|
|
12694
12922
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
12695
12923
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
12696
12924
|
}
|
|
12697
|
-
interface ServiceProperties {
|
|
12925
|
+
interface ServiceProperties$2 {
|
|
12698
12926
|
/**
|
|
12699
12927
|
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
12700
12928
|
* For example, the start time of a class.
|
|
@@ -12703,7 +12931,7 @@ interface ServiceProperties {
|
|
|
12703
12931
|
/** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
|
|
12704
12932
|
numberOfParticipants?: number | null;
|
|
12705
12933
|
}
|
|
12706
|
-
interface PriceDescription$
|
|
12934
|
+
interface PriceDescription$6 {
|
|
12707
12935
|
/** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
|
|
12708
12936
|
original?: string;
|
|
12709
12937
|
/**
|
|
@@ -13452,6 +13680,20 @@ interface CustomSettings {
|
|
|
13452
13680
|
*/
|
|
13453
13681
|
disabledManualPayment?: boolean;
|
|
13454
13682
|
}
|
|
13683
|
+
interface CustomContentReference$2 {
|
|
13684
|
+
/**
|
|
13685
|
+
* ID of the app providing the content.
|
|
13686
|
+
*
|
|
13687
|
+
* You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
13688
|
+
*/
|
|
13689
|
+
appId?: string;
|
|
13690
|
+
/**
|
|
13691
|
+
* ID of the component within the app it belongs to.
|
|
13692
|
+
*
|
|
13693
|
+
* You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
13694
|
+
*/
|
|
13695
|
+
componentId?: string;
|
|
13696
|
+
}
|
|
13455
13697
|
interface CreateCheckoutRequest {
|
|
13456
13698
|
/** Checkout information. */
|
|
13457
13699
|
checkoutInfo?: Checkout;
|
|
@@ -13459,6 +13701,8 @@ interface CreateCheckoutRequest {
|
|
|
13459
13701
|
couponCode?: string | null;
|
|
13460
13702
|
/** Line items to be added to checkout. */
|
|
13461
13703
|
lineItems?: LineItem[];
|
|
13704
|
+
/** Custom line items to be added to checkout. */
|
|
13705
|
+
customLineItems?: CustomLineItem$4[];
|
|
13462
13706
|
/**
|
|
13463
13707
|
* **Required**
|
|
13464
13708
|
* Sales channel type.
|
|
@@ -13479,47 +13723,123 @@ interface CreateCheckoutRequest {
|
|
|
13479
13723
|
*/
|
|
13480
13724
|
overrideCheckoutUrl?: string | null;
|
|
13481
13725
|
}
|
|
13482
|
-
interface
|
|
13483
|
-
/**
|
|
13484
|
-
|
|
13485
|
-
|
|
13486
|
-
|
|
13487
|
-
|
|
13488
|
-
|
|
13489
|
-
|
|
13490
|
-
|
|
13491
|
-
|
|
13492
|
-
|
|
13493
|
-
|
|
13494
|
-
|
|
13495
|
-
|
|
13496
|
-
|
|
13497
|
-
|
|
13498
|
-
|
|
13499
|
-
|
|
13500
|
-
|
|
13501
|
-
|
|
13502
|
-
|
|
13503
|
-
|
|
13504
|
-
|
|
13505
|
-
|
|
13506
|
-
|
|
13507
|
-
/**
|
|
13508
|
-
|
|
13509
|
-
|
|
13510
|
-
|
|
13511
|
-
/**
|
|
13512
|
-
|
|
13513
|
-
|
|
13514
|
-
|
|
13515
|
-
|
|
13516
|
-
|
|
13726
|
+
interface CustomLineItem$4 {
|
|
13727
|
+
/**
|
|
13728
|
+
* Custom line item quantity.
|
|
13729
|
+
*
|
|
13730
|
+
* Min: `1`
|
|
13731
|
+
* Max: `100000`
|
|
13732
|
+
*/
|
|
13733
|
+
quantity?: number;
|
|
13734
|
+
/** Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend. */
|
|
13735
|
+
price?: string;
|
|
13736
|
+
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
13737
|
+
priceDescription?: PriceDescription$6;
|
|
13738
|
+
/** Custom line item description lines. Used for displaying the cart, checkout and order. */
|
|
13739
|
+
descriptionLines?: DescriptionLine$6[];
|
|
13740
|
+
/**
|
|
13741
|
+
* Custom line item media.
|
|
13742
|
+
* + 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"`.
|
|
13743
|
+
* + An image from the web - `"http(s)://<image url>"`.
|
|
13744
|
+
*/
|
|
13745
|
+
media?: string;
|
|
13746
|
+
/**
|
|
13747
|
+
* Custom line item ID. If passed, `id` must be unique.
|
|
13748
|
+
* Default: auto-generated ID.
|
|
13749
|
+
*/
|
|
13750
|
+
_id?: string | null;
|
|
13751
|
+
/** Tax group ID for this custom line item. */
|
|
13752
|
+
taxGroupId?: string | null;
|
|
13753
|
+
/** Name of the item or product. */
|
|
13754
|
+
productName?: ProductName$6;
|
|
13755
|
+
/**
|
|
13756
|
+
* 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.
|
|
13757
|
+
* The URL is optional and if not provided, the site URL will be used.
|
|
13758
|
+
*/
|
|
13759
|
+
url?: string;
|
|
13760
|
+
/** Item type. Either a preset type or custom. */
|
|
13761
|
+
itemType?: ItemType$6;
|
|
13762
|
+
/** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
13763
|
+
fullPrice?: string | null;
|
|
13764
|
+
/**
|
|
13765
|
+
* Optional - Item quantity available for purchase. Only return this if inventory is managed.
|
|
13766
|
+
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
13767
|
+
*/
|
|
13768
|
+
quantityAvailable?: number | null;
|
|
13769
|
+
/** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
13770
|
+
physicalProperties?: PhysicalProperties$6;
|
|
13771
|
+
/**
|
|
13772
|
+
* Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
13773
|
+
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
13774
|
+
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
13775
|
+
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
13776
|
+
* + `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.
|
|
13777
|
+
*/
|
|
13778
|
+
paymentOption?: PaymentOptionType$6;
|
|
13779
|
+
/**
|
|
13780
|
+
* Optional - Service properties. When relevant, this contains information such as date and number of participants.
|
|
13781
|
+
* Used, among other things, when checking for valid memberships.
|
|
13782
|
+
*/
|
|
13783
|
+
serviceProperties?: ServiceProperties$2;
|
|
13784
|
+
/**
|
|
13785
|
+
* Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
13786
|
+
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
13787
|
+
* + in most cases, this field is the name as `catalogReference.catalogItemId`.
|
|
13788
|
+
* + Used in membership validation.
|
|
13789
|
+
*/
|
|
13790
|
+
rootCatalogItemId?: string | null;
|
|
13791
|
+
/**
|
|
13792
|
+
* Optional - partial payment for the given item to be paid upfront during the checkout.
|
|
13793
|
+
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
13794
|
+
* If omitted - item's price will not be split and is expected to be paid in single installment
|
|
13795
|
+
*/
|
|
13796
|
+
depositAmount?: string | null;
|
|
13797
|
+
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
13798
|
+
catalogReference?: CatalogReference$6;
|
|
13799
|
+
}
|
|
13800
|
+
interface CreateCheckoutResponse {
|
|
13801
|
+
/** Newly created checkout. */
|
|
13802
|
+
checkout?: Checkout;
|
|
13803
|
+
}
|
|
13804
|
+
interface GetCheckoutRequest {
|
|
13805
|
+
/** Checkout ID. */
|
|
13806
|
+
_id: string;
|
|
13807
|
+
}
|
|
13808
|
+
interface GetCheckoutResponse {
|
|
13809
|
+
/** The requested checkout. */
|
|
13810
|
+
checkout?: Checkout;
|
|
13811
|
+
}
|
|
13812
|
+
interface GetCheckoutByCartIdRequest {
|
|
13813
|
+
/** Cart ID. */
|
|
13814
|
+
_id: string;
|
|
13815
|
+
}
|
|
13816
|
+
interface GetCheckoutByCartIdResponse {
|
|
13817
|
+
/** The requested checkout. */
|
|
13818
|
+
checkout?: Checkout;
|
|
13819
|
+
}
|
|
13820
|
+
interface GetCheckoutURLRequest {
|
|
13821
|
+
/** Checkout ID. */
|
|
13822
|
+
_id: string;
|
|
13823
|
+
}
|
|
13824
|
+
interface GetCheckoutURLResponse {
|
|
13825
|
+
/** Checkout URL. */
|
|
13826
|
+
checkoutUrl?: string;
|
|
13827
|
+
}
|
|
13828
|
+
interface UpdateCheckoutRequest {
|
|
13829
|
+
/** Checkout information. */
|
|
13830
|
+
checkout: Checkout;
|
|
13831
|
+
/** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
|
|
13832
|
+
couponCode?: string | null;
|
|
13833
|
+
/** Gift card code. */
|
|
13834
|
+
giftCardCode?: string | null;
|
|
13517
13835
|
/**
|
|
13518
13836
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
13519
13837
|
*
|
|
13520
13838
|
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
13521
13839
|
*/
|
|
13522
13840
|
overrideCheckoutUrl?: string | null;
|
|
13841
|
+
/** Custom line items to be saved on checkout. */
|
|
13842
|
+
customLineItems?: CustomLineItem$4[];
|
|
13523
13843
|
}
|
|
13524
13844
|
interface UpdateCheckoutResponse {
|
|
13525
13845
|
/** Updated checkout. */
|
|
@@ -13554,6 +13874,8 @@ interface AddToCheckoutRequest {
|
|
|
13554
13874
|
_id: string;
|
|
13555
13875
|
/** Catalog line items. */
|
|
13556
13876
|
lineItems?: LineItem[];
|
|
13877
|
+
/** Custom line items. */
|
|
13878
|
+
customLineItems?: CustomLineItem$4[];
|
|
13557
13879
|
}
|
|
13558
13880
|
interface AddToCheckoutResponse {
|
|
13559
13881
|
/** Updated checkout. */
|
|
@@ -14534,6 +14856,12 @@ interface CheckoutTemplate$1 {
|
|
|
14534
14856
|
* Max: 300 items
|
|
14535
14857
|
*/
|
|
14536
14858
|
lineItems?: V1LineItem$1[];
|
|
14859
|
+
/**
|
|
14860
|
+
* Custom line items.
|
|
14861
|
+
*
|
|
14862
|
+
* Max: 300 items
|
|
14863
|
+
*/
|
|
14864
|
+
customLineItems?: CustomLineItem$3[];
|
|
14537
14865
|
/**
|
|
14538
14866
|
* Coupon code.
|
|
14539
14867
|
*
|
|
@@ -14541,6 +14869,12 @@ interface CheckoutTemplate$1 {
|
|
|
14541
14869
|
* For additional information, see the [Coupons API](https://dev.wix.com/docs/rest/api-reference/coupons/coupons/introduction).
|
|
14542
14870
|
*/
|
|
14543
14871
|
couponCode?: string | null;
|
|
14872
|
+
/**
|
|
14873
|
+
* Customize the content of the checkout page.
|
|
14874
|
+
*
|
|
14875
|
+
* Includes IDs for the app and the component providing the content
|
|
14876
|
+
*/
|
|
14877
|
+
customContentReference?: CustomContentReference$1;
|
|
14544
14878
|
}
|
|
14545
14879
|
declare enum Status$3 {
|
|
14546
14880
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
@@ -14620,126 +14954,339 @@ interface CatalogReference$5 {
|
|
|
14620
14954
|
*/
|
|
14621
14955
|
options?: Record<string, any> | null;
|
|
14622
14956
|
}
|
|
14623
|
-
|
|
14624
|
-
UNRECOGNISED = "UNRECOGNISED",
|
|
14625
|
-
PLAIN_TEXT = "PLAIN_TEXT",
|
|
14626
|
-
COLOR = "COLOR"
|
|
14627
|
-
}
|
|
14628
|
-
declare enum ItemTypeItemType$5 {
|
|
14629
|
-
UNRECOGNISED = "UNRECOGNISED",
|
|
14630
|
-
PHYSICAL = "PHYSICAL",
|
|
14631
|
-
DIGITAL = "DIGITAL",
|
|
14632
|
-
GIFT_CARD = "GIFT_CARD",
|
|
14633
|
-
SERVICE = "SERVICE"
|
|
14634
|
-
}
|
|
14635
|
-
/** Frequency unit of recurring payment */
|
|
14636
|
-
declare enum SubscriptionFrequency$5 {
|
|
14637
|
-
UNDEFINED = "UNDEFINED",
|
|
14638
|
-
DAY = "DAY",
|
|
14639
|
-
WEEK = "WEEK",
|
|
14640
|
-
MONTH = "MONTH",
|
|
14641
|
-
YEAR = "YEAR"
|
|
14642
|
-
}
|
|
14643
|
-
declare enum FileType$1 {
|
|
14644
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
14645
|
-
SECURE_PICTURE = "SECURE_PICTURE",
|
|
14646
|
-
SECURE_VIDEO = "SECURE_VIDEO",
|
|
14647
|
-
SECURE_DOCUMENT = "SECURE_DOCUMENT",
|
|
14648
|
-
SECURE_MUSIC = "SECURE_MUSIC",
|
|
14649
|
-
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
14650
|
-
}
|
|
14651
|
-
/** Type of selected payment option for catalog item */
|
|
14652
|
-
declare enum PaymentOptionType$5 {
|
|
14653
|
-
/** The entire payment for this item happens as part of the checkout. */
|
|
14654
|
-
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
14655
|
-
/** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
|
|
14656
|
-
FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
|
|
14657
|
-
/** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
|
|
14658
|
-
MEMBERSHIP = "MEMBERSHIP",
|
|
14659
|
-
/** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
|
|
14660
|
-
DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
|
|
14661
|
-
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
14662
|
-
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
14663
|
-
}
|
|
14664
|
-
interface CreateCheckoutTemplateRequest$1 {
|
|
14665
|
-
/** Checkout template to create. */
|
|
14666
|
-
checkoutTemplate: CheckoutTemplate$1;
|
|
14667
|
-
}
|
|
14668
|
-
interface CreateCheckoutTemplateResponse$1 {
|
|
14669
|
-
/** Created checkout template. */
|
|
14670
|
-
checkoutTemplate?: CheckoutTemplate$1;
|
|
14671
|
-
}
|
|
14672
|
-
interface GetCheckoutTemplateRequest$1 {
|
|
14673
|
-
/** ID of the checkout template to retrieve. */
|
|
14674
|
-
checkoutTemplateId: string;
|
|
14675
|
-
}
|
|
14676
|
-
interface GetCheckoutTemplateResponse$1 {
|
|
14677
|
-
/** Retrieved checkout template. */
|
|
14678
|
-
checkoutTemplate?: CheckoutTemplate$1;
|
|
14679
|
-
}
|
|
14680
|
-
interface UpdateCheckoutTemplateRequest$1 {
|
|
14681
|
-
/** Checkout template info to update. */
|
|
14682
|
-
checkoutTemplate: CheckoutTemplate$1;
|
|
14683
|
-
}
|
|
14684
|
-
interface UpdateCheckoutTemplateResponse$1 {
|
|
14685
|
-
/** Updated checkout template. */
|
|
14686
|
-
checkoutTemplate?: CheckoutTemplate$1;
|
|
14687
|
-
}
|
|
14688
|
-
interface DeleteCheckoutTemplateRequest$1 {
|
|
14689
|
-
/** ID of the checkout template to delete. */
|
|
14690
|
-
checkoutTemplateId: string;
|
|
14691
|
-
}
|
|
14692
|
-
interface DeleteCheckoutTemplateResponse$1 {
|
|
14693
|
-
}
|
|
14694
|
-
interface QueryCheckoutTemplatesRequest$1 {
|
|
14695
|
-
/** Query options. */
|
|
14696
|
-
query?: CursorQuery$b;
|
|
14697
|
-
}
|
|
14698
|
-
interface CursorQuery$b extends CursorQueryPagingMethodOneOf$b {
|
|
14699
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
14700
|
-
cursorPaging?: CursorPaging$f;
|
|
14957
|
+
interface ProductName$5 {
|
|
14701
14958
|
/**
|
|
14702
|
-
*
|
|
14703
|
-
* `"filter" : {
|
|
14704
|
-
* "fieldName1": "value1",
|
|
14705
|
-
* "fieldName2":{"$operator":"value2"}
|
|
14706
|
-
* }`
|
|
14959
|
+
* __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).
|
|
14707
14960
|
*
|
|
14708
|
-
*
|
|
14961
|
+
* Min: 1 character.
|
|
14962
|
+
* Max: 200 characters.
|
|
14709
14963
|
*/
|
|
14710
|
-
|
|
14964
|
+
original?: string;
|
|
14711
14965
|
/**
|
|
14712
|
-
*
|
|
14713
|
-
*
|
|
14966
|
+
* Item name translated into the buyer's language.
|
|
14967
|
+
*
|
|
14968
|
+
* Min: 1 character.
|
|
14969
|
+
* Max: 400 characters.
|
|
14970
|
+
* Default: Same as `original`.
|
|
14714
14971
|
*/
|
|
14715
|
-
|
|
14972
|
+
translated?: string | null;
|
|
14716
14973
|
}
|
|
14717
|
-
|
|
14718
|
-
|
|
14719
|
-
|
|
14720
|
-
|
|
14974
|
+
interface DescriptionLine$5 extends DescriptionLineValueOneOf$5, DescriptionLineDescriptionLineValueOneOf$5 {
|
|
14975
|
+
/** Description line plain text value. */
|
|
14976
|
+
plainText?: PlainTextValue$5;
|
|
14977
|
+
/** Description line color value. */
|
|
14978
|
+
colorInfo?: Color$5;
|
|
14979
|
+
/** Description line name. */
|
|
14980
|
+
name?: DescriptionLineName$5;
|
|
14721
14981
|
}
|
|
14722
|
-
|
|
14723
|
-
|
|
14724
|
-
|
|
14725
|
-
|
|
14726
|
-
|
|
14982
|
+
/** @oneof */
|
|
14983
|
+
interface DescriptionLineValueOneOf$5 {
|
|
14984
|
+
/** Description line plain text value. */
|
|
14985
|
+
plainText?: PlainTextValue$5;
|
|
14986
|
+
/** Description line color value. */
|
|
14987
|
+
colorInfo?: Color$5;
|
|
14727
14988
|
}
|
|
14728
|
-
|
|
14729
|
-
|
|
14730
|
-
DESC = "DESC"
|
|
14989
|
+
/** @oneof */
|
|
14990
|
+
interface DescriptionLineDescriptionLineValueOneOf$5 {
|
|
14731
14991
|
}
|
|
14732
|
-
interface
|
|
14733
|
-
/**
|
|
14734
|
-
|
|
14992
|
+
interface DescriptionLineName$5 {
|
|
14993
|
+
/** 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). */
|
|
14994
|
+
original?: string;
|
|
14735
14995
|
/**
|
|
14736
|
-
*
|
|
14996
|
+
* Description line name translated into the buyer's language.
|
|
14737
14997
|
*
|
|
14738
|
-
*
|
|
14739
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
14740
|
-
* Not relevant for the first request.
|
|
14998
|
+
* Default: Same as `original`.
|
|
14741
14999
|
*/
|
|
14742
|
-
|
|
15000
|
+
translated?: string | null;
|
|
15001
|
+
}
|
|
15002
|
+
interface PlainTextValue$5 {
|
|
15003
|
+
/** 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). */
|
|
15004
|
+
original?: string;
|
|
15005
|
+
/**
|
|
15006
|
+
* Description line plain text value translated into the buyer's language.
|
|
15007
|
+
*
|
|
15008
|
+
* Default: Same as `original`.
|
|
15009
|
+
*/
|
|
15010
|
+
translated?: string | null;
|
|
15011
|
+
}
|
|
15012
|
+
interface Color$5 {
|
|
15013
|
+
/** 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). */
|
|
15014
|
+
original?: string;
|
|
15015
|
+
/**
|
|
15016
|
+
* Description line color name translated into the buyer's language.
|
|
15017
|
+
*
|
|
15018
|
+
* Default: Same as `original`.
|
|
15019
|
+
*/
|
|
15020
|
+
translated?: string | null;
|
|
15021
|
+
/** HEX or RGB color code for display. */
|
|
15022
|
+
code?: string | null;
|
|
15023
|
+
}
|
|
15024
|
+
declare enum DescriptionLineType$5 {
|
|
15025
|
+
UNRECOGNISED = "UNRECOGNISED",
|
|
15026
|
+
PLAIN_TEXT = "PLAIN_TEXT",
|
|
15027
|
+
COLOR = "COLOR"
|
|
15028
|
+
}
|
|
15029
|
+
interface PhysicalProperties$5 {
|
|
15030
|
+
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
15031
|
+
weight?: number | null;
|
|
15032
|
+
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
15033
|
+
sku?: string | null;
|
|
15034
|
+
/** Whether this line item is shippable. */
|
|
15035
|
+
shippable?: boolean;
|
|
15036
|
+
}
|
|
15037
|
+
interface Image$3 {
|
|
15038
|
+
/** WixMedia image ID. */
|
|
15039
|
+
id?: string;
|
|
15040
|
+
/** Original image height. */
|
|
15041
|
+
height?: number;
|
|
15042
|
+
/** Original image width. */
|
|
15043
|
+
width?: number;
|
|
15044
|
+
/** Image alt text. Optional. */
|
|
15045
|
+
altText?: string | null;
|
|
15046
|
+
/** Image filename. Optional. */
|
|
15047
|
+
filename?: string | null;
|
|
15048
|
+
}
|
|
15049
|
+
interface CustomLineItem$3 {
|
|
15050
|
+
/**
|
|
15051
|
+
* Custom line item quantity.
|
|
15052
|
+
*
|
|
15053
|
+
* Min: `1`
|
|
15054
|
+
* Max: `100000`
|
|
15055
|
+
*/
|
|
15056
|
+
quantity?: number;
|
|
15057
|
+
/**
|
|
15058
|
+
* Custom line item price.
|
|
15059
|
+
*
|
|
15060
|
+
* Must be a number or a decimal without symbols.
|
|
15061
|
+
*/
|
|
15062
|
+
price?: string;
|
|
15063
|
+
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
15064
|
+
priceDescription?: PriceDescription$5;
|
|
15065
|
+
/** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
|
|
15066
|
+
descriptionLines?: DescriptionLine$5[];
|
|
15067
|
+
/** Custom line item's media. */
|
|
15068
|
+
media?: Image$3;
|
|
15069
|
+
/**
|
|
15070
|
+
* Custom line item ID. If passed, `id` must be unique.
|
|
15071
|
+
* Default: auto-generated ID.
|
|
15072
|
+
*/
|
|
15073
|
+
id?: string | null;
|
|
15074
|
+
/** Tax group ID for this custom line item. */
|
|
15075
|
+
taxGroupId?: string | null;
|
|
15076
|
+
/** Name of the item or product. */
|
|
15077
|
+
productName?: ProductName$5;
|
|
15078
|
+
/**
|
|
15079
|
+
* 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.
|
|
15080
|
+
* The URL is optional and if not provided, the site URL will be used.
|
|
15081
|
+
*/
|
|
15082
|
+
url?: PageUrlV2$1;
|
|
15083
|
+
/** Item type. Either a preset type or custom. */
|
|
15084
|
+
itemType?: ItemType$5;
|
|
15085
|
+
/** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
15086
|
+
fullPrice?: string | null;
|
|
15087
|
+
/**
|
|
15088
|
+
* Optional - Item quantity available for purchase. Only return this if inventory is managed.
|
|
15089
|
+
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
15090
|
+
*/
|
|
15091
|
+
quantityAvailable?: number | null;
|
|
15092
|
+
/** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
15093
|
+
physicalProperties?: PhysicalProperties$5;
|
|
15094
|
+
/**
|
|
15095
|
+
* Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
15096
|
+
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
15097
|
+
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
15098
|
+
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
15099
|
+
* + `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.
|
|
15100
|
+
*/
|
|
15101
|
+
paymentOption?: PaymentOptionType$5;
|
|
15102
|
+
/**
|
|
15103
|
+
* Optional - Service properties. When relevant, this contains information such as date and number of participants.
|
|
15104
|
+
* Used, among other things, when checking for valid memberships.
|
|
15105
|
+
*/
|
|
15106
|
+
serviceProperties?: ServiceProperties$1;
|
|
15107
|
+
/**
|
|
15108
|
+
* Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
15109
|
+
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
15110
|
+
* + in most cases, this field is the name as `catalogReference.catalogItemId`.
|
|
15111
|
+
* + Used in membership validation.
|
|
15112
|
+
*/
|
|
15113
|
+
rootCatalogItemId?: string | null;
|
|
15114
|
+
/**
|
|
15115
|
+
* Optional - partial payment for the given item to be paid upfront during the checkout.
|
|
15116
|
+
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
15117
|
+
* If omitted - item's price will not be split and is expected to be paid in single installment
|
|
15118
|
+
*/
|
|
15119
|
+
depositAmount?: string | null;
|
|
15120
|
+
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
15121
|
+
catalogReference?: CatalogReference$5;
|
|
15122
|
+
}
|
|
15123
|
+
interface PriceDescription$5 {
|
|
15124
|
+
/** __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). */
|
|
15125
|
+
original?: string;
|
|
15126
|
+
/**
|
|
15127
|
+
* Price description translated into the buyer's language.
|
|
15128
|
+
*
|
|
15129
|
+
* Default: Same as `original`.
|
|
15130
|
+
*/
|
|
15131
|
+
translated?: string | null;
|
|
15132
|
+
}
|
|
15133
|
+
interface PageUrlV2$1 {
|
|
15134
|
+
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
15135
|
+
relativePath?: string;
|
|
15136
|
+
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
15137
|
+
url?: string | null;
|
|
15138
|
+
}
|
|
15139
|
+
interface ItemType$5 extends ItemTypeItemTypeDataOneOf$5 {
|
|
15140
|
+
/** Preset item type. */
|
|
15141
|
+
preset?: ItemTypeItemType$5;
|
|
15142
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
15143
|
+
custom?: string;
|
|
15144
|
+
}
|
|
15145
|
+
/** @oneof */
|
|
15146
|
+
interface ItemTypeItemTypeDataOneOf$5 {
|
|
15147
|
+
/** Preset item type. */
|
|
15148
|
+
preset?: ItemTypeItemType$5;
|
|
15149
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
15150
|
+
custom?: string;
|
|
15151
|
+
}
|
|
15152
|
+
declare enum ItemTypeItemType$5 {
|
|
15153
|
+
UNRECOGNISED = "UNRECOGNISED",
|
|
15154
|
+
PHYSICAL = "PHYSICAL",
|
|
15155
|
+
DIGITAL = "DIGITAL",
|
|
15156
|
+
GIFT_CARD = "GIFT_CARD",
|
|
15157
|
+
SERVICE = "SERVICE"
|
|
15158
|
+
}
|
|
15159
|
+
/** Frequency unit of recurring payment */
|
|
15160
|
+
declare enum SubscriptionFrequency$5 {
|
|
15161
|
+
UNDEFINED = "UNDEFINED",
|
|
15162
|
+
DAY = "DAY",
|
|
15163
|
+
WEEK = "WEEK",
|
|
15164
|
+
MONTH = "MONTH",
|
|
15165
|
+
YEAR = "YEAR"
|
|
15166
|
+
}
|
|
15167
|
+
declare enum FileType$1 {
|
|
15168
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
15169
|
+
SECURE_PICTURE = "SECURE_PICTURE",
|
|
15170
|
+
SECURE_VIDEO = "SECURE_VIDEO",
|
|
15171
|
+
SECURE_DOCUMENT = "SECURE_DOCUMENT",
|
|
15172
|
+
SECURE_MUSIC = "SECURE_MUSIC",
|
|
15173
|
+
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
15174
|
+
}
|
|
15175
|
+
/** Type of selected payment option for catalog item */
|
|
15176
|
+
declare enum PaymentOptionType$5 {
|
|
15177
|
+
/** The entire payment for this item happens as part of the checkout. */
|
|
15178
|
+
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
15179
|
+
/** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
|
|
15180
|
+
FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
|
|
15181
|
+
/** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
|
|
15182
|
+
MEMBERSHIP = "MEMBERSHIP",
|
|
15183
|
+
/** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
|
|
15184
|
+
DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
|
|
15185
|
+
/** 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`. */
|
|
15186
|
+
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
15187
|
+
}
|
|
15188
|
+
interface ServiceProperties$1 {
|
|
15189
|
+
/**
|
|
15190
|
+
* 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.
|
|
15191
|
+
* For example, the start time of a class.
|
|
15192
|
+
*/
|
|
15193
|
+
scheduledDate?: Date;
|
|
15194
|
+
/** 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. */
|
|
15195
|
+
numberOfParticipants?: number | null;
|
|
15196
|
+
}
|
|
15197
|
+
interface CustomContentReference$1 {
|
|
15198
|
+
/**
|
|
15199
|
+
* ID of the app providing the content.
|
|
15200
|
+
*
|
|
15201
|
+
* You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
15202
|
+
*/
|
|
15203
|
+
appId?: string;
|
|
15204
|
+
/**
|
|
15205
|
+
* ID of the component within the app it belongs to.
|
|
15206
|
+
*
|
|
15207
|
+
* You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
15208
|
+
*/
|
|
15209
|
+
componentId?: string;
|
|
15210
|
+
}
|
|
15211
|
+
interface CreateCheckoutTemplateRequest$1 {
|
|
15212
|
+
/** Checkout template to create. */
|
|
15213
|
+
checkoutTemplate: CheckoutTemplate$1;
|
|
15214
|
+
}
|
|
15215
|
+
interface CreateCheckoutTemplateResponse$1 {
|
|
15216
|
+
/** Created checkout template. */
|
|
15217
|
+
checkoutTemplate?: CheckoutTemplate$1;
|
|
15218
|
+
}
|
|
15219
|
+
interface GetCheckoutTemplateRequest$1 {
|
|
15220
|
+
/** ID of the checkout template to retrieve. */
|
|
15221
|
+
checkoutTemplateId: string;
|
|
15222
|
+
}
|
|
15223
|
+
interface GetCheckoutTemplateResponse$1 {
|
|
15224
|
+
/** Retrieved checkout template. */
|
|
15225
|
+
checkoutTemplate?: CheckoutTemplate$1;
|
|
15226
|
+
}
|
|
15227
|
+
interface UpdateCheckoutTemplateRequest$1 {
|
|
15228
|
+
/** Checkout template info to update. */
|
|
15229
|
+
checkoutTemplate: CheckoutTemplate$1;
|
|
15230
|
+
}
|
|
15231
|
+
interface UpdateCheckoutTemplateResponse$1 {
|
|
15232
|
+
/** Updated checkout template. */
|
|
15233
|
+
checkoutTemplate?: CheckoutTemplate$1;
|
|
15234
|
+
}
|
|
15235
|
+
interface DeleteCheckoutTemplateRequest$1 {
|
|
15236
|
+
/** ID of the checkout template to delete. */
|
|
15237
|
+
checkoutTemplateId: string;
|
|
15238
|
+
}
|
|
15239
|
+
interface DeleteCheckoutTemplateResponse$1 {
|
|
15240
|
+
}
|
|
15241
|
+
interface QueryCheckoutTemplatesRequest$1 {
|
|
15242
|
+
/** Query options. */
|
|
15243
|
+
query?: CursorQuery$b;
|
|
15244
|
+
}
|
|
15245
|
+
interface CursorQuery$b extends CursorQueryPagingMethodOneOf$b {
|
|
15246
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
15247
|
+
cursorPaging?: CursorPaging$f;
|
|
15248
|
+
/**
|
|
15249
|
+
* Filter object in the following format:
|
|
15250
|
+
* `"filter" : {
|
|
15251
|
+
* "fieldName1": "value1",
|
|
15252
|
+
* "fieldName2":{"$operator":"value2"}
|
|
15253
|
+
* }`
|
|
15254
|
+
*
|
|
15255
|
+
* Example of operators: `$eq`, `$ne`, `$in`, `$startsWith`, `$exists`, `$hasSome`
|
|
15256
|
+
*/
|
|
15257
|
+
filter?: Record<string, any> | null;
|
|
15258
|
+
/**
|
|
15259
|
+
* Sort object in the following format:
|
|
15260
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
15261
|
+
*/
|
|
15262
|
+
sort?: Sorting$f[];
|
|
15263
|
+
}
|
|
15264
|
+
/** @oneof */
|
|
15265
|
+
interface CursorQueryPagingMethodOneOf$b {
|
|
15266
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
15267
|
+
cursorPaging?: CursorPaging$f;
|
|
15268
|
+
}
|
|
15269
|
+
interface Sorting$f {
|
|
15270
|
+
/** Name of the field to sort by. */
|
|
15271
|
+
fieldName?: string;
|
|
15272
|
+
/** Sort order. */
|
|
15273
|
+
order?: SortOrder$f;
|
|
15274
|
+
}
|
|
15275
|
+
declare enum SortOrder$f {
|
|
15276
|
+
ASC = "ASC",
|
|
15277
|
+
DESC = "DESC"
|
|
15278
|
+
}
|
|
15279
|
+
interface CursorPaging$f {
|
|
15280
|
+
/** Number of items to load. */
|
|
15281
|
+
limit?: number | null;
|
|
15282
|
+
/**
|
|
15283
|
+
* Pointer to the next or previous page in the list of results. </ br>
|
|
15284
|
+
*
|
|
15285
|
+
* You can get the relevant cursor token
|
|
15286
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
15287
|
+
* Not relevant for the first request.
|
|
15288
|
+
*/
|
|
15289
|
+
cursor?: string | null;
|
|
14743
15290
|
}
|
|
14744
15291
|
interface QueryCheckoutTemplatesResponse$1 {
|
|
14745
15292
|
/** Retrieved checkout templates. */
|
|
@@ -14954,6 +15501,12 @@ interface CheckoutTemplate {
|
|
|
14954
15501
|
* Max: 300 items
|
|
14955
15502
|
*/
|
|
14956
15503
|
lineItems?: V1LineItem[];
|
|
15504
|
+
/**
|
|
15505
|
+
* Custom line items.
|
|
15506
|
+
*
|
|
15507
|
+
* Max: 300 items
|
|
15508
|
+
*/
|
|
15509
|
+
customLineItems?: CustomLineItem$2[];
|
|
14957
15510
|
/**
|
|
14958
15511
|
* Coupon code.
|
|
14959
15512
|
*
|
|
@@ -14961,6 +15514,12 @@ interface CheckoutTemplate {
|
|
|
14961
15514
|
* For additional information, see the Coupons API.
|
|
14962
15515
|
*/
|
|
14963
15516
|
couponCode?: string | null;
|
|
15517
|
+
/**
|
|
15518
|
+
* Customize the content of the checkout page.
|
|
15519
|
+
*
|
|
15520
|
+
* Includes IDs for the app and the component providing the content
|
|
15521
|
+
*/
|
|
15522
|
+
customContentReference?: CustomContentReference;
|
|
14964
15523
|
}
|
|
14965
15524
|
declare enum Status$2 {
|
|
14966
15525
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
@@ -15040,11 +15599,183 @@ interface CatalogReference$4 {
|
|
|
15040
15599
|
*/
|
|
15041
15600
|
options?: Record<string, any> | null;
|
|
15042
15601
|
}
|
|
15602
|
+
interface ProductName$4 {
|
|
15603
|
+
/**
|
|
15604
|
+
* __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).
|
|
15605
|
+
*
|
|
15606
|
+
* Min: 1 character.
|
|
15607
|
+
* Max: 200 characters.
|
|
15608
|
+
*/
|
|
15609
|
+
original?: string;
|
|
15610
|
+
/**
|
|
15611
|
+
* Item name translated into the buyer's language.
|
|
15612
|
+
*
|
|
15613
|
+
* Min: 1 character.
|
|
15614
|
+
* Max: 400 characters.
|
|
15615
|
+
* Default: Same as `original`.
|
|
15616
|
+
*/
|
|
15617
|
+
translated?: string | null;
|
|
15618
|
+
}
|
|
15619
|
+
interface DescriptionLine$4 extends DescriptionLineValueOneOf$4, DescriptionLineDescriptionLineValueOneOf$4 {
|
|
15620
|
+
/** Description line plain text value. */
|
|
15621
|
+
plainText?: PlainTextValue$4;
|
|
15622
|
+
/** Description line color value. */
|
|
15623
|
+
colorInfo?: Color$4;
|
|
15624
|
+
/** Description line name. */
|
|
15625
|
+
name?: DescriptionLineName$4;
|
|
15626
|
+
}
|
|
15627
|
+
/** @oneof */
|
|
15628
|
+
interface DescriptionLineValueOneOf$4 {
|
|
15629
|
+
/** Description line plain text value. */
|
|
15630
|
+
plainText?: PlainTextValue$4;
|
|
15631
|
+
/** Description line color value. */
|
|
15632
|
+
colorInfo?: Color$4;
|
|
15633
|
+
}
|
|
15634
|
+
/** @oneof */
|
|
15635
|
+
interface DescriptionLineDescriptionLineValueOneOf$4 {
|
|
15636
|
+
}
|
|
15637
|
+
interface DescriptionLineName$4 {
|
|
15638
|
+
/** 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). */
|
|
15639
|
+
original?: string;
|
|
15640
|
+
/**
|
|
15641
|
+
* Description line name translated into the buyer's language.
|
|
15642
|
+
*
|
|
15643
|
+
* Default: Same as `original`.
|
|
15644
|
+
*/
|
|
15645
|
+
translated?: string | null;
|
|
15646
|
+
}
|
|
15647
|
+
interface PlainTextValue$4 {
|
|
15648
|
+
/** 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). */
|
|
15649
|
+
original?: string;
|
|
15650
|
+
/**
|
|
15651
|
+
* Description line plain text value translated into the buyer's language.
|
|
15652
|
+
*
|
|
15653
|
+
* Default: Same as `original`.
|
|
15654
|
+
*/
|
|
15655
|
+
translated?: string | null;
|
|
15656
|
+
}
|
|
15657
|
+
interface Color$4 {
|
|
15658
|
+
/** 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). */
|
|
15659
|
+
original?: string;
|
|
15660
|
+
/**
|
|
15661
|
+
* Description line color name translated into the buyer's language.
|
|
15662
|
+
*
|
|
15663
|
+
* Default: Same as `original`.
|
|
15664
|
+
*/
|
|
15665
|
+
translated?: string | null;
|
|
15666
|
+
/** HEX or RGB color code for display. */
|
|
15667
|
+
code?: string | null;
|
|
15668
|
+
}
|
|
15043
15669
|
declare enum DescriptionLineType$4 {
|
|
15044
15670
|
UNRECOGNISED = "UNRECOGNISED",
|
|
15045
15671
|
PLAIN_TEXT = "PLAIN_TEXT",
|
|
15046
15672
|
COLOR = "COLOR"
|
|
15047
15673
|
}
|
|
15674
|
+
interface PhysicalProperties$4 {
|
|
15675
|
+
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
15676
|
+
weight?: number | null;
|
|
15677
|
+
/** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
|
|
15678
|
+
sku?: string | null;
|
|
15679
|
+
/** Whether this line item is shippable. */
|
|
15680
|
+
shippable?: boolean;
|
|
15681
|
+
}
|
|
15682
|
+
interface CustomLineItem$2 {
|
|
15683
|
+
/**
|
|
15684
|
+
* Custom line item quantity.
|
|
15685
|
+
*
|
|
15686
|
+
* Min: `1`
|
|
15687
|
+
* Max: `100000`
|
|
15688
|
+
*/
|
|
15689
|
+
quantity?: number;
|
|
15690
|
+
/**
|
|
15691
|
+
* Custom line item price.
|
|
15692
|
+
*
|
|
15693
|
+
* Must be a number or a decimal without symbols.
|
|
15694
|
+
*/
|
|
15695
|
+
price?: string;
|
|
15696
|
+
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
15697
|
+
priceDescription?: PriceDescription$4;
|
|
15698
|
+
/** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
|
|
15699
|
+
descriptionLines?: DescriptionLine$4[];
|
|
15700
|
+
/** Custom line item's media. */
|
|
15701
|
+
media?: string;
|
|
15702
|
+
/**
|
|
15703
|
+
* Custom line item ID. If passed, `id` must be unique.
|
|
15704
|
+
* Default: auto-generated ID.
|
|
15705
|
+
*/
|
|
15706
|
+
_id?: string | null;
|
|
15707
|
+
/** Tax group ID for this custom line item. */
|
|
15708
|
+
taxGroupId?: string | null;
|
|
15709
|
+
/** Name of the item or product. */
|
|
15710
|
+
productName?: ProductName$4;
|
|
15711
|
+
/**
|
|
15712
|
+
* 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.
|
|
15713
|
+
* The URL is optional and if not provided, the site URL will be used.
|
|
15714
|
+
*/
|
|
15715
|
+
url?: string;
|
|
15716
|
+
/** Item type. Either a preset type or custom. */
|
|
15717
|
+
itemType?: ItemType$4;
|
|
15718
|
+
/** Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
|
|
15719
|
+
fullPrice?: string | null;
|
|
15720
|
+
/**
|
|
15721
|
+
* Optional - Item quantity available for purchase. Only return this if inventory is managed.
|
|
15722
|
+
* Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
|
|
15723
|
+
*/
|
|
15724
|
+
quantityAvailable?: number | null;
|
|
15725
|
+
/** Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
15726
|
+
physicalProperties?: PhysicalProperties$4;
|
|
15727
|
+
/**
|
|
15728
|
+
* Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
15729
|
+
* + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
|
|
15730
|
+
* + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
15731
|
+
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
15732
|
+
* + `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.
|
|
15733
|
+
*/
|
|
15734
|
+
paymentOption?: PaymentOptionType$4;
|
|
15735
|
+
/**
|
|
15736
|
+
* Optional - Service properties. When relevant, this contains information such as date and number of participants.
|
|
15737
|
+
* Used, among other things, when checking for valid memberships.
|
|
15738
|
+
*/
|
|
15739
|
+
serviceProperties?: ServiceProperties;
|
|
15740
|
+
/**
|
|
15741
|
+
* Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
15742
|
+
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
15743
|
+
* + in most cases, this field is the name as `catalogReference.catalogItemId`.
|
|
15744
|
+
* + Used in membership validation.
|
|
15745
|
+
*/
|
|
15746
|
+
rootCatalogItemId?: string | null;
|
|
15747
|
+
/**
|
|
15748
|
+
* Optional - partial payment for the given item to be paid upfront during the checkout.
|
|
15749
|
+
* Eligible for catalog items with type `DEPOSIT_ONLINE`.
|
|
15750
|
+
* If omitted - item's price will not be split and is expected to be paid in single installment
|
|
15751
|
+
*/
|
|
15752
|
+
depositAmount?: string | null;
|
|
15753
|
+
/** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
|
|
15754
|
+
catalogReference?: CatalogReference$4;
|
|
15755
|
+
}
|
|
15756
|
+
interface PriceDescription$4 {
|
|
15757
|
+
/** __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). */
|
|
15758
|
+
original?: string;
|
|
15759
|
+
/**
|
|
15760
|
+
* Price description translated into the buyer's language.
|
|
15761
|
+
*
|
|
15762
|
+
* Default: Same as `original`.
|
|
15763
|
+
*/
|
|
15764
|
+
translated?: string | null;
|
|
15765
|
+
}
|
|
15766
|
+
interface ItemType$4 extends ItemTypeItemTypeDataOneOf$4 {
|
|
15767
|
+
/** Preset item type. */
|
|
15768
|
+
preset?: ItemTypeItemType$4;
|
|
15769
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
15770
|
+
custom?: string;
|
|
15771
|
+
}
|
|
15772
|
+
/** @oneof */
|
|
15773
|
+
interface ItemTypeItemTypeDataOneOf$4 {
|
|
15774
|
+
/** Preset item type. */
|
|
15775
|
+
preset?: ItemTypeItemType$4;
|
|
15776
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
15777
|
+
custom?: string;
|
|
15778
|
+
}
|
|
15048
15779
|
declare enum ItemTypeItemType$4 {
|
|
15049
15780
|
UNRECOGNISED = "UNRECOGNISED",
|
|
15050
15781
|
PHYSICAL = "PHYSICAL",
|
|
@@ -15081,6 +15812,29 @@ declare enum PaymentOptionType$4 {
|
|
|
15081
15812
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
15082
15813
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
15083
15814
|
}
|
|
15815
|
+
interface ServiceProperties {
|
|
15816
|
+
/**
|
|
15817
|
+
* 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.
|
|
15818
|
+
* For example, the start time of a class.
|
|
15819
|
+
*/
|
|
15820
|
+
scheduledDate?: Date;
|
|
15821
|
+
/** 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. */
|
|
15822
|
+
numberOfParticipants?: number | null;
|
|
15823
|
+
}
|
|
15824
|
+
interface CustomContentReference {
|
|
15825
|
+
/**
|
|
15826
|
+
* ID of the app providing the content.
|
|
15827
|
+
*
|
|
15828
|
+
* You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
15829
|
+
*/
|
|
15830
|
+
appId?: string;
|
|
15831
|
+
/**
|
|
15832
|
+
* ID of the component within the app it belongs to.
|
|
15833
|
+
*
|
|
15834
|
+
* You can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
15835
|
+
*/
|
|
15836
|
+
componentId?: string;
|
|
15837
|
+
}
|
|
15084
15838
|
interface CreateCheckoutTemplateRequest {
|
|
15085
15839
|
/** Checkout template to create. */
|
|
15086
15840
|
checkoutTemplate: CheckoutTemplate;
|
|
@@ -29452,4 +30206,4 @@ declare namespace meta {
|
|
|
29452
30206
|
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_convertCurrency as convertCurrency, meta_getConversionRate as getConversionRate, meta_listCurrencies as listCurrencies };
|
|
29453
30207
|
}
|
|
29454
30208
|
|
|
29455
|
-
export { meta$j as abandonedCheckouts, meta$i as backInStockNotifications, meta$h as backInStockSettings, meta$g as cart, meta$e as checkout, meta$d as checkoutSettings, meta$c as checkoutTemplates, meta as currencies, meta$f as currentCart, meta$b as deliveryProfile, meta$m as discountRules, meta$n as discountsCustomTrigger, meta$a as draftOrders, meta$8 as localDeliveryOptions, meta$9 as orderFulfillments, meta$l as orderInvoices, meta$6 as orderPaymentRequests, meta$5 as orderTransactions, meta$7 as orders, meta$4 as ordersSettings, meta$3 as pickupLocations, meta$k as recommendations, meta$2 as shippingOptions, meta$1 as shippoConfigurations };
|
|
30209
|
+
export { meta$j as abandonedCheckouts, meta$i as backInStockNotifications, meta$h as backInStockSettings, meta$g as cart, meta$e as checkout, meta$o as checkoutContent, meta$d as checkoutSettings, meta$c as checkoutTemplates, meta as currencies, meta$f as currentCart, meta$b as deliveryProfile, meta$m as discountRules, meta$n as discountsCustomTrigger, meta$a as draftOrders, meta$8 as localDeliveryOptions, meta$9 as orderFulfillments, meta$l as orderInvoices, meta$6 as orderPaymentRequests, meta$5 as orderTransactions, meta$7 as orders, meta$4 as ordersSettings, meta$3 as pickupLocations, meta$k as recommendations, meta$2 as shippingOptions, meta$1 as shippoConfigurations };
|