@wix/auto_sdk_bookings_bookings 1.0.82 → 1.0.84
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/index.d.ts +49 -65
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +97 -124
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +47 -57
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +49 -65
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +97 -124
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +47 -57
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +49 -65
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +97 -124
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +47 -57
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +49 -65
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +97 -124
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +47 -57
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -4,14 +4,13 @@ import { NonNullablePaths } from '@wix/sdk-types';
|
|
|
4
4
|
interface Booking extends BookingParticipantsInfoOneOf {
|
|
5
5
|
/**
|
|
6
6
|
* Total number of participants.
|
|
7
|
-
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer variants and options
|
|
7
|
+
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
8
8
|
* @min 1
|
|
9
9
|
*/
|
|
10
10
|
totalParticipants?: number;
|
|
11
11
|
/**
|
|
12
12
|
* Information about the booked service choices and participant count for each choice.
|
|
13
|
-
* When creating a booking, use this field only if the booking includes multiple service variants
|
|
14
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
13
|
+
* When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
15
14
|
*
|
|
16
15
|
* For example, use this for a spa package booking that includes different service levels:
|
|
17
16
|
* - 2 participants chose "Standard Package".
|
|
@@ -42,8 +41,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
42
41
|
*/
|
|
43
42
|
bookedEntity?: BookedEntity;
|
|
44
43
|
/**
|
|
45
|
-
* Contact details of the site visitor or member
|
|
46
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/introduction))
|
|
44
|
+
* Contact details of the site visitor or [member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction))
|
|
47
45
|
* making the booking.
|
|
48
46
|
*/
|
|
49
47
|
contactDetails?: ContactDetails;
|
|
@@ -69,8 +67,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
69
67
|
status?: BookingStatusWithLiterals;
|
|
70
68
|
/**
|
|
71
69
|
* The payment status of the booking. This field automatically syncs with the
|
|
72
|
-
* `paymentStatus` of the corresponding eCommerce order
|
|
73
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup)| [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction))
|
|
70
|
+
* `paymentStatus` of the corresponding [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/introduction)
|
|
74
71
|
* when customers use Wix eCommerce checkout.
|
|
75
72
|
*
|
|
76
73
|
* ### Integration patterns
|
|
@@ -78,17 +75,17 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
78
75
|
* __When using Wix eCommerce checkout__: Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status.
|
|
79
76
|
* Do not manually update this field.
|
|
80
77
|
*
|
|
81
|
-
* __When using custom payment flows__: You can manually update the payment status with Confirm Booking or Decline Booking
|
|
78
|
+
* __When using custom payment flows__: You can manually update the payment status with [Confirm Booking or Decline Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to reflect the customer's payment state.
|
|
82
79
|
*
|
|
83
|
-
* __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active pricing plan
|
|
80
|
+
* __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active [pricing plan](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/introduction) subscription.
|
|
84
81
|
*
|
|
85
82
|
* All payment statuses are supported for every booking `status`.
|
|
86
83
|
*/
|
|
87
84
|
paymentStatus?: PaymentStatusWithLiterals;
|
|
88
85
|
/**
|
|
89
|
-
* Payment option selected by the customer. If the customer hasn't completed their checkout, they may still change the payment method. Must be one of the payment options offered by the service
|
|
86
|
+
* Payment option selected by the customer. If the customer hasn't completed their checkout, they may still change the payment method. Must be one of the payment options offered by the [service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction), unless `skipSelectedPaymentOptionValidation` is `true`.
|
|
90
87
|
*
|
|
91
|
-
* When undefined during an eCommerce checkout
|
|
88
|
+
* When undefined during an [eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/checkout/introduction), Wix Bookings uses the service's default payment option
|
|
92
89
|
*/
|
|
93
90
|
selectedPaymentOption?: SelectedPaymentOptionWithLiterals;
|
|
94
91
|
/**
|
|
@@ -138,15 +135,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
138
135
|
*/
|
|
139
136
|
doubleBooked?: boolean | null;
|
|
140
137
|
/**
|
|
141
|
-
* ID of the form submission
|
|
142
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction))
|
|
138
|
+
* ID of the [form submission](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction)
|
|
143
139
|
* associated with this booking.
|
|
144
140
|
* @format GUID
|
|
145
141
|
*/
|
|
146
142
|
formSubmissionId?: string | null;
|
|
147
143
|
/**
|
|
148
|
-
* ID of the form
|
|
149
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/introduction) | [REST](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object))
|
|
144
|
+
* ID of the [form](https://dev.wix.com/docs/rest/crm/forms/form-schemas/form-object)
|
|
150
145
|
* associated with this booking. The value depends on how the
|
|
151
146
|
* booking was created:
|
|
152
147
|
* - For bookings created with Create Booking or Bulk Create Booking, `formId`
|
|
@@ -163,14 +158,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
163
158
|
interface BookingParticipantsInfoOneOf {
|
|
164
159
|
/**
|
|
165
160
|
* Total number of participants.
|
|
166
|
-
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer variants and options
|
|
161
|
+
* When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
167
162
|
* @min 1
|
|
168
163
|
*/
|
|
169
164
|
totalParticipants?: number;
|
|
170
165
|
/**
|
|
171
166
|
* Information about the booked service choices and participant count for each choice.
|
|
172
|
-
* When creating a booking, use this field only if the booking includes multiple service variants
|
|
173
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
167
|
+
* When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
174
168
|
*
|
|
175
169
|
* For example, use this for a spa package booking that includes different service levels:
|
|
176
170
|
* - 2 participants chose "Standard Package".
|
|
@@ -196,8 +190,7 @@ declare enum MultiServiceBookingType {
|
|
|
196
190
|
type MultiServiceBookingTypeWithLiterals = MultiServiceBookingType | 'SEQUENTIAL_BOOKINGS' | 'SEPARATE_BOOKINGS' | 'PARALLEL_BOOKINGS';
|
|
197
191
|
interface BookedEntity extends BookedEntityItemOneOf {
|
|
198
192
|
/**
|
|
199
|
-
* Booked slot
|
|
200
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability)).
|
|
193
|
+
* [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).
|
|
201
194
|
*
|
|
202
195
|
* Specify `slot` when creating bookings for:
|
|
203
196
|
* - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
|
|
@@ -209,8 +202,7 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
209
202
|
*/
|
|
210
203
|
slot?: BookedSlot;
|
|
211
204
|
/**
|
|
212
|
-
* Booked schedule
|
|
213
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
|
|
205
|
+
* [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).
|
|
214
206
|
*
|
|
215
207
|
* Specify `schedule` when creating bookings for:
|
|
216
208
|
* - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
@@ -236,8 +228,7 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
236
228
|
/** @oneof */
|
|
237
229
|
interface BookedEntityItemOneOf {
|
|
238
230
|
/**
|
|
239
|
-
* Booked slot
|
|
240
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability)).
|
|
231
|
+
* [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).
|
|
241
232
|
*
|
|
242
233
|
* Specify `slot` when creating bookings for:
|
|
243
234
|
* - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
|
|
@@ -249,8 +240,7 @@ interface BookedEntityItemOneOf {
|
|
|
249
240
|
*/
|
|
250
241
|
slot?: BookedSlot;
|
|
251
242
|
/**
|
|
252
|
-
* Booked schedule
|
|
253
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
|
|
243
|
+
* [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).
|
|
254
244
|
*
|
|
255
245
|
* Specify `schedule` when creating bookings for:
|
|
256
246
|
* - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
@@ -259,15 +249,27 @@ interface BookedEntityItemOneOf {
|
|
|
259
249
|
schedule?: BookedSchedule;
|
|
260
250
|
}
|
|
261
251
|
interface BookedSlot {
|
|
262
|
-
/**
|
|
252
|
+
/**
|
|
253
|
+
* Session ID. For class bookings, this is the ID of the existing session.
|
|
254
|
+
* For appointment bookings, this field is typically empty during booking creation and gets populated when the booking is confirmed.
|
|
255
|
+
*
|
|
256
|
+
* __Migration Guidance__: Replace usage of this field with `eventId` from the [Time Slots V2 API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/introduction).
|
|
257
|
+
* You can follow [these sample flows](https://dev.wix.com/docs/api-reference/business-solutions/bookings/end-to-end-booking-flows) for step-by-step guidance about determining availability and creating bookings.
|
|
258
|
+
* @deprecated Session ID. For class bookings, this is the ID of the existing session.
|
|
259
|
+
* For appointment bookings, this field is typically empty during booking creation and gets populated when the booking is confirmed.
|
|
260
|
+
*
|
|
261
|
+
* __Migration Guidance__: Replace usage of this field with `eventId` from the [Time Slots V2 API](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/introduction).
|
|
262
|
+
* You can follow [these sample flows](https://dev.wix.com/docs/api-reference/business-solutions/bookings/end-to-end-booking-flows) for step-by-step guidance about determining availability and creating bookings.
|
|
263
|
+
* @replacedBy event_id
|
|
264
|
+
* @targetRemovalDate 2026-03-31
|
|
265
|
+
*/
|
|
263
266
|
sessionId?: string | null;
|
|
264
267
|
/** Service ID. */
|
|
265
268
|
serviceId?: string;
|
|
266
269
|
/** Schedule ID. */
|
|
267
270
|
scheduleId?: string;
|
|
268
271
|
/**
|
|
269
|
-
* ID of the corresponding event
|
|
270
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)).
|
|
272
|
+
* ID of the corresponding [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction).
|
|
271
273
|
* Available for both appointment and class bookings, not available for course bookings.
|
|
272
274
|
* For appointment-based services, Wix Bookings automatically populates `eventId` when the booking `status` changes to `CONFIRMED`.
|
|
273
275
|
* For class bookings, Wix Bookings automatically populates `eventId` upon booking creation.
|
|
@@ -285,9 +287,8 @@ interface BookedSlot {
|
|
|
285
287
|
*/
|
|
286
288
|
timezone?: string | null;
|
|
287
289
|
/**
|
|
288
|
-
* Primary resource
|
|
289
|
-
*
|
|
290
|
-
* For example, the staff member ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)) providing the service.
|
|
290
|
+
* [Primary resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) for the booking.
|
|
291
|
+
* For example, the [staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction) providing the service.
|
|
291
292
|
*/
|
|
292
293
|
resource?: BookedResource;
|
|
293
294
|
/** Location where the session takes place. */
|
|
@@ -369,7 +370,7 @@ declare enum SelectionMethod {
|
|
|
369
370
|
/** @enumType */
|
|
370
371
|
type SelectionMethodWithLiterals = SelectionMethod | 'UNKNOWN_SELECTION_METHOD' | 'SPECIFIC_RESOURCE' | 'ANY_RESOURCE' | 'NO_SELECTION';
|
|
371
372
|
interface BookedSchedule {
|
|
372
|
-
/** Schedule ID
|
|
373
|
+
/** [Schedule ID](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction). */
|
|
373
374
|
scheduleId?: string;
|
|
374
375
|
/**
|
|
375
376
|
* Booked service ID.
|
|
@@ -377,7 +378,7 @@ interface BookedSchedule {
|
|
|
377
378
|
*/
|
|
378
379
|
serviceId?: string | null;
|
|
379
380
|
/**
|
|
380
|
-
* Location
|
|
381
|
+
* [Location](https://dev.wix.com/docs/rest/business-management/locations/introduction) where the schedule's sessions take place.
|
|
381
382
|
* @readonly
|
|
382
383
|
*/
|
|
383
384
|
location?: Location;
|
|
@@ -521,26 +522,18 @@ type ValueTypeWithLiterals = ValueType | 'SHORT_TEXT' | 'LONG_TEXT' | 'CHECK_BOX
|
|
|
521
522
|
declare enum BookingStatus {
|
|
522
523
|
/** The booking was created, but the customer hasn't completed the related eCommerce order yet. */
|
|
523
524
|
CREATED = "CREATED",
|
|
524
|
-
/**
|
|
525
|
-
* The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their services
|
|
526
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)) to automatically confirm all `PENDING` bookings.
|
|
527
|
-
*/
|
|
525
|
+
/** The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) to automatically confirm all `PENDING` bookings. */
|
|
528
526
|
CONFIRMED = "CONFIRMED",
|
|
529
527
|
/**
|
|
530
|
-
* The customer has canceled the booking. Depending on the relevant service's policy snapshot
|
|
531
|
-
*
|
|
532
|
-
* they may have to pay a cancellation fee ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction)).
|
|
528
|
+
* The customer has canceled the booking. Depending on the relevant service's [policy snapshot](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction)
|
|
529
|
+
* they may have to pay a [cancellation fee](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction).
|
|
533
530
|
*/
|
|
534
531
|
CANCELED = "CANCELED",
|
|
535
532
|
/** The merchant must manually confirm the booking before it appears in the business calendar. */
|
|
536
533
|
PENDING = "PENDING",
|
|
537
534
|
/** The merchant has declined the booking before the customer was charged. */
|
|
538
535
|
DECLINED = "DECLINED",
|
|
539
|
-
/**
|
|
540
|
-
* The booking is on a waitlist.
|
|
541
|
-
* Currently, you can't call Register to Waitlist ([REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist)) for course or appointment bookings, even though this is supported in live sites.
|
|
542
|
-
* You can call Register to Waitlist only for class session bookings.
|
|
543
|
-
*/
|
|
536
|
+
/** Currently, you can't call [Register to Waitlist](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist) for course or appointment bookings, even though this is supported in live sites. */
|
|
544
537
|
WAITING_LIST = "WAITING_LIST"
|
|
545
538
|
}
|
|
546
539
|
/** @enumType */
|
|
@@ -707,8 +700,7 @@ interface FlowControlSettings {
|
|
|
707
700
|
skipAvailabilityValidation?: boolean;
|
|
708
701
|
/**
|
|
709
702
|
* Whether the booking's `status` is automatically updated to `CONFIRMED` when
|
|
710
|
-
* the customer completes the eCommerce checkout
|
|
711
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)),
|
|
703
|
+
* the customer completes the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction),
|
|
712
704
|
* regardless of whether the relevant service requires manual business confirmation.
|
|
713
705
|
*/
|
|
714
706
|
skipBusinessConfirmation?: boolean;
|
|
@@ -745,7 +737,7 @@ interface ParticipantChoices {
|
|
|
745
737
|
}
|
|
746
738
|
interface ServiceChoices {
|
|
747
739
|
/**
|
|
748
|
-
* Number of participants for this variant
|
|
740
|
+
* Number of participants for this [variant](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
749
741
|
* @min 1
|
|
750
742
|
*/
|
|
751
743
|
numberOfParticipants?: number | null;
|
|
@@ -1613,8 +1605,7 @@ interface ConfirmOrDeclineBookingRequest {
|
|
|
1613
1605
|
bookingId: string;
|
|
1614
1606
|
/**
|
|
1615
1607
|
* Current payment status of the booking when using a custom checkout page and
|
|
1616
|
-
* not the
|
|
1617
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
|
|
1608
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
1618
1609
|
*
|
|
1619
1610
|
* The booking is declined if there is a double booking conflict and you provide
|
|
1620
1611
|
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
@@ -1643,8 +1634,7 @@ interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
|
1643
1634
|
bookingId?: string;
|
|
1644
1635
|
/**
|
|
1645
1636
|
* Current payment status of the booking when using a custom checkout page and
|
|
1646
|
-
* not the
|
|
1647
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
|
|
1637
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
1648
1638
|
*
|
|
1649
1639
|
* The booking is declined if there is a double booking conflict and you provide
|
|
1650
1640
|
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
@@ -2865,12 +2855,12 @@ interface RescheduleMultiServiceBookingRequest {
|
|
|
2865
2855
|
}
|
|
2866
2856
|
interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
|
|
2867
2857
|
/**
|
|
2868
|
-
* Total number of participants. Available only for services with
|
|
2858
|
+
* Total number of participants. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
2869
2859
|
* Specify when all participants book the same variant.
|
|
2870
2860
|
*/
|
|
2871
2861
|
totalParticipants?: number;
|
|
2872
2862
|
/**
|
|
2873
|
-
* Information about the service choices to book. Available only for services with
|
|
2863
|
+
* Information about the service choices to book. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
2874
2864
|
* Specify when not all participants book the same variant.
|
|
2875
2865
|
*/
|
|
2876
2866
|
participantsChoices?: ParticipantChoices;
|
|
@@ -2890,12 +2880,12 @@ interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOne
|
|
|
2890
2880
|
/** @oneof */
|
|
2891
2881
|
interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
2892
2882
|
/**
|
|
2893
|
-
* Total number of participants. Available only for services with
|
|
2883
|
+
* Total number of participants. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
2894
2884
|
* Specify when all participants book the same variant.
|
|
2895
2885
|
*/
|
|
2896
2886
|
totalParticipants?: number;
|
|
2897
2887
|
/**
|
|
2898
|
-
* Information about the service choices to book. Available only for services with
|
|
2888
|
+
* Information about the service choices to book. Available only for services with [variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
2899
2889
|
* Specify when not all participants book the same variant.
|
|
2900
2890
|
*/
|
|
2901
2891
|
participantsChoices?: ParticipantChoices;
|
|
@@ -3979,11 +3969,9 @@ interface RescheduleBookingAnonymouslyOptions {
|
|
|
3979
3969
|
* ### eCommerce checkout restriction
|
|
3980
3970
|
*
|
|
3981
3971
|
* Call this method only when using a custom checkout page. Don't
|
|
3982
|
-
* call it when using a
|
|
3983
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
|
|
3972
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
3984
3973
|
* In such cases, Wix automatically updates the booking status based on
|
|
3985
|
-
* the `paymentStatus` of the corresponding
|
|
3986
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)).
|
|
3974
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
3987
3975
|
*
|
|
3988
3976
|
* ### New booking status
|
|
3989
3977
|
*
|
|
@@ -4025,8 +4013,7 @@ declare function confirmOrDeclineBooking(bookingId: string, options?: ConfirmOrD
|
|
|
4025
4013
|
interface ConfirmOrDeclineBookingOptions {
|
|
4026
4014
|
/**
|
|
4027
4015
|
* Current payment status of the booking when using a custom checkout page and
|
|
4028
|
-
* not the
|
|
4029
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
|
|
4016
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4030
4017
|
*
|
|
4031
4018
|
* The booking is declined if there is a double booking conflict and you provide
|
|
4032
4019
|
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
@@ -4037,8 +4024,7 @@ interface ConfirmOrDeclineBookingOptions {
|
|
|
4037
4024
|
* Confirms or declines up to 300 bookings.
|
|
4038
4025
|
*
|
|
4039
4026
|
*
|
|
4040
|
-
* See
|
|
4041
|
-
* ([SDK](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/bookings/confirm-or-decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking))
|
|
4027
|
+
* See [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)
|
|
4042
4028
|
* for details about when a booking is confirmed or declined.
|
|
4043
4029
|
* @param details - Bookings to confirm or decline.
|
|
4044
4030
|
* @public
|
|
@@ -4061,23 +4047,19 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
4061
4047
|
*
|
|
4062
4048
|
* ### Appointment booking
|
|
4063
4049
|
*
|
|
4064
|
-
* For appointment-based services, specify the relevant
|
|
4065
|
-
*
|
|
4066
|
-
*
|
|
4067
|
-
*
|
|
4068
|
-
* in your call's request to avoid failed calls due to unavailability.
|
|
4050
|
+
* For appointment-based services, specify the relevant time slot in `bookedEntity.slot`.
|
|
4051
|
+
*
|
|
4052
|
+
* We recommend following the [appointment booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-an-appointment) using Time Slots V2.
|
|
4053
|
+
* Specify the slot's `startDate`, `endDate`, `resource`, and `location` in `booking.bookedEntity.slot`.
|
|
4069
4054
|
*
|
|
4070
4055
|
* ### Class session booking
|
|
4071
4056
|
*
|
|
4072
|
-
* For class services, specify the relevant event ID
|
|
4073
|
-
*
|
|
4074
|
-
*
|
|
4075
|
-
*
|
|
4076
|
-
*
|
|
4077
|
-
* `
|
|
4078
|
-
* Specifying an event ID leads to automatic calculations of `slot.startDate`, `slot.endDate`,
|
|
4079
|
-
* `slot.timezone`, `slot.resource`, and `slot.location`. All manually specified
|
|
4080
|
-
* values are overridden.
|
|
4057
|
+
* For class services, specify the relevant event ID as `bookedEntity.slot.eventId`.
|
|
4058
|
+
*
|
|
4059
|
+
* We recommend following the [class session booking sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#book-a-class-session) using Time Slots V2.
|
|
4060
|
+
* Specify the `eventId` from the selected time slot in `booking.bookedEntity.slot.eventId`.
|
|
4061
|
+
*
|
|
4062
|
+
* When you specify `eventId`, Wix Bookings automatically derives `startDate`, `endDate`, `timezone`, `resource`, and `location` based on the event details. Manually specified values are ignored.
|
|
4081
4063
|
*
|
|
4082
4064
|
* ### Course booking
|
|
4083
4065
|
*
|
|
@@ -4102,8 +4084,7 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
4102
4084
|
*
|
|
4103
4085
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
4104
4086
|
* The call fails if the specified `participantsChoices` aren't among the supported
|
|
4105
|
-
*
|
|
4106
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
4087
|
+
* [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
4107
4088
|
*
|
|
4108
4089
|
* ### Notify customers
|
|
4109
4090
|
*
|
|
@@ -4122,9 +4103,9 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
4122
4103
|
*
|
|
4123
4104
|
* All bookings are created with `paymentStatus=UNDEFINED`, ignoring the payment status you specify.
|
|
4124
4105
|
*
|
|
4125
|
-
* For customers paying with a Wix eCommerce checkout
|
|
4106
|
+
* For customers paying with a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/checkout/introduction), Wix Bookings automatically syncs the booking's payment status from the corresponding [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
4126
4107
|
*
|
|
4127
|
-
* For customers using a custom checkout, call Confirm or Decline Booking
|
|
4108
|
+
* For customers using a custom checkout, call [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to update booking's payment status manually.
|
|
4128
4109
|
*
|
|
4129
4110
|
* ### Booking form data
|
|
4130
4111
|
*
|
|
@@ -4135,6 +4116,8 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
4135
4116
|
* don't match, Create Booking fails. Therefore, we recommend specifying
|
|
4136
4117
|
* only `booking.contactDetails.contactId` when providing `formSubmission`.
|
|
4137
4118
|
*
|
|
4119
|
+
* You can follow [this sample flow](https://dev.wix.com/docs/api-reference/business-solutions/bookings/wix-forms-integration#create-a-booking-with-a-filled-out-booking-form) to create bookings with booking form submissions.
|
|
4120
|
+
*
|
|
4138
4121
|
* ### Admin overwrites
|
|
4139
4122
|
*
|
|
4140
4123
|
* There are small but important differences when you specify special
|
|
@@ -4195,8 +4178,7 @@ interface CreateBookingOptions {
|
|
|
4195
4178
|
* Creates up to 8 bookings.
|
|
4196
4179
|
*
|
|
4197
4180
|
*
|
|
4198
|
-
* See Create Booking
|
|
4199
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/create-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking))
|
|
4181
|
+
* See [Create Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking)
|
|
4200
4182
|
* for more information.
|
|
4201
4183
|
*
|
|
4202
4184
|
* If any of the specified bookings is missing a required field the entire call
|
|
@@ -4236,16 +4218,14 @@ interface BulkCreateBookingOptions {
|
|
|
4236
4218
|
* ### Appointment sessions
|
|
4237
4219
|
*
|
|
4238
4220
|
* For appointments, the old session is removed from the business calendar
|
|
4239
|
-
* while a new session is added. We recommend calling Query Availability
|
|
4240
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability))
|
|
4221
|
+
* while a new session is added. We recommend calling [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
4241
4222
|
* first and specifying the entire retrieved `slot`.
|
|
4242
4223
|
*
|
|
4243
4224
|
* ### Class sessions
|
|
4244
4225
|
*
|
|
4245
4226
|
* For classes, the new session must be an existing session belonging to the
|
|
4246
4227
|
* same class. We recommend retrieving `availabilityEntries.slot.eventId`
|
|
4247
|
-
* from Query Availability
|
|
4248
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/availability-calendar/query-availability) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability))
|
|
4228
|
+
* from [Query Availability](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/query-availability)
|
|
4249
4229
|
* to avoid failed Reschedule Booking calls due to unavailability. Specify
|
|
4250
4230
|
* only `slot.eventId` instead of the entire `slot` object.
|
|
4251
4231
|
*
|
|
@@ -4346,16 +4326,14 @@ interface RescheduleBookingOptionsParticipantsInfoOneOf {
|
|
|
4346
4326
|
* ### eCommerce checkout restriction
|
|
4347
4327
|
*
|
|
4348
4328
|
* Call this method only when using a custom checkout page. Don't
|
|
4349
|
-
* call it when using a Wix eCommerce checkout
|
|
4350
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
|
|
4329
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4351
4330
|
* In such cases, Wix automatically updates the booking status based on
|
|
4352
|
-
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
4353
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)).
|
|
4331
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
4354
4332
|
*
|
|
4355
4333
|
* ### When to call Confirm Or Decline Booking instead
|
|
4356
4334
|
*
|
|
4357
4335
|
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
4358
|
-
* For these checks, call Confirm or Decline Booking
|
|
4336
|
+
* For these checks, call [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) instead.
|
|
4359
4337
|
*
|
|
4360
4338
|
* ### Original status validation
|
|
4361
4339
|
*
|
|
@@ -4478,17 +4456,14 @@ interface UpdateExtendedFieldsOptions {
|
|
|
4478
4456
|
* ### eCommerce checkout restriction
|
|
4479
4457
|
*
|
|
4480
4458
|
* Call this method only when using a custom checkout page. Don't
|
|
4481
|
-
* call it when using a Wix eCommerce checkout
|
|
4482
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
|
|
4459
|
+
* call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4483
4460
|
* In such cases, Wix automatically updates the booking status based on
|
|
4484
|
-
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
4485
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction)).
|
|
4461
|
+
* the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
4486
4462
|
*
|
|
4487
4463
|
* ### When to call Confirm Or Decline Booking instead
|
|
4488
4464
|
*
|
|
4489
4465
|
* The method doesn't check whether a slot or schedule is still available. For
|
|
4490
|
-
* these checks you can call Confirm or Decline Booking
|
|
4491
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/confirm-or-decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)).
|
|
4466
|
+
* these checks you can call [Confirm or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking).
|
|
4492
4467
|
*
|
|
4493
4468
|
* ### Original status validation
|
|
4494
4469
|
*
|
|
@@ -4629,8 +4604,7 @@ interface CancelBookingOptions {
|
|
|
4629
4604
|
*
|
|
4630
4605
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
4631
4606
|
* The call fails if the specified `participantsChoices` aren't among the
|
|
4632
|
-
* supported service options and variants
|
|
4633
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
4607
|
+
* supported [service options and variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).
|
|
4634
4608
|
* @param bookingId - ID of the booking to update the number of participants for.
|
|
4635
4609
|
* @public
|
|
4636
4610
|
* @requiredField bookingId
|
|
@@ -4680,7 +4654,7 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
|
4680
4654
|
*
|
|
4681
4655
|
* ### Service requirement
|
|
4682
4656
|
*
|
|
4683
|
-
* By default, this method only works for
|
|
4657
|
+
* By default, this method only works for [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) with `service.onlineBooking.requireManualApproval` set to `true`.
|
|
4684
4658
|
* If you attempt to mark a booking as pending for a service that doesn't require approval, the call fails unless you use the `skipPendingApprovalServiceValidation` admin overwrite.
|
|
4685
4659
|
*
|
|
4686
4660
|
* ### Status requirements
|
|
@@ -4690,15 +4664,15 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
|
4690
4664
|
*
|
|
4691
4665
|
* ### Checkout restrictions
|
|
4692
4666
|
*
|
|
4693
|
-
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts
|
|
4667
|
+
* Only call this method if the customer paid via a custom checkout. For [Wix eCommerce checkouts](https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/introduction), Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
4694
4668
|
*
|
|
4695
4669
|
* When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
|
|
4696
4670
|
*
|
|
4697
4671
|
* ### Business workflow
|
|
4698
4672
|
*
|
|
4699
4673
|
* After marking a booking as `PENDING`, the business must manually approve or reject it. You can call these methods:
|
|
4700
|
-
* - Confirm Booking
|
|
4701
|
-
* - Decline Booking
|
|
4674
|
+
* - [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
|
|
4675
|
+
* - [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
|
|
4702
4676
|
*
|
|
4703
4677
|
* ### Resource availability and scheduling
|
|
4704
4678
|
*
|
|
@@ -4706,7 +4680,7 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
|
4706
4680
|
*
|
|
4707
4681
|
* - **Calendar impact**: The booking appears on the business calendar.
|
|
4708
4682
|
* - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
|
|
4709
|
-
* - **Resource assignment**: Available
|
|
4683
|
+
* - **Resource assignment**: Available [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) are automatically assigned if none were explicitly selected during booking creation.
|
|
4710
4684
|
*
|
|
4711
4685
|
* ### Double bookings
|
|
4712
4686
|
*
|
|
@@ -4779,7 +4753,7 @@ interface MarkBookingAsPendingOptions {
|
|
|
4779
4753
|
*
|
|
4780
4754
|
* ### When to call this method
|
|
4781
4755
|
*
|
|
4782
|
-
* Create sequential appointments where customers book related services together. For adding existing single-service bookings to an existing multi-service booking, call Add Bookings to Multi Service Booking
|
|
4756
|
+
* Create sequential appointments where customers book related services together. For adding existing single-service bookings to an existing multi-service booking, call [Add Bookings to Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) instead.
|
|
4783
4757
|
*
|
|
4784
4758
|
* ### Requirements and behavior
|
|
4785
4759
|
*
|
|
@@ -4787,15 +4761,15 @@ interface MarkBookingAsPendingOptions {
|
|
|
4787
4761
|
*
|
|
4788
4762
|
* __Timing specification__: You must provide complete `slot` details (`scheduleId`, `startDate`, `endDate`) for each single-service booking. Wix Bookings validates sequential timing but doesn't auto-calculate it.
|
|
4789
4763
|
*
|
|
4790
|
-
* __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding Wix eCommerce order
|
|
4764
|
+
* __Package pricing__: The total price equals the sum of individual services. Wix Bookings automatically syncs the payment status from the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) if the customer paid via an [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4791
4765
|
*
|
|
4792
4766
|
* __Package notifications__: Customers receive 1 unified notification for the entire multi-service booking. Wix Bookings doesn't send notifications for the package's individual single-service bookings.
|
|
4793
4767
|
*
|
|
4794
4768
|
* ### Related methods
|
|
4795
4769
|
*
|
|
4796
|
-
* Verify availability first with List Multi Service Availability Time Slots
|
|
4770
|
+
* Verify availability first with [List Multi Service Availability Time Slots](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots).
|
|
4797
4771
|
*
|
|
4798
|
-
* See Create Booking
|
|
4772
|
+
* See [Create Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking) for more details about constraints and effects of creating single-service bookings.
|
|
4799
4773
|
* @param bookings - Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
4800
4774
|
*
|
|
4801
4775
|
* Each single-service booking specification must include `slot` details (`scheduleId`, `startDate`, and `endDate`).
|
|
@@ -4852,7 +4826,7 @@ interface CreateMultiServiceBookingOptions {
|
|
|
4852
4826
|
*
|
|
4853
4827
|
* This method fails if it can't reschedule at least 1 single-service booking. You must provide the current revision number for each single-service booking you're rescheduling to prevent conflicting changes.
|
|
4854
4828
|
*
|
|
4855
|
-
* See Reschedule Booking
|
|
4829
|
+
* See [Reschedule Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking) for single-service booking rescheduling details.
|
|
4856
4830
|
* @param multiServiceBookingId - ID of the multi-service booking to reschedule.
|
|
4857
4831
|
* @param rescheduleBookingsInfo - Information about the single-service bookings to reschedule.
|
|
4858
4832
|
* @public
|
|
@@ -4886,14 +4860,13 @@ interface RescheduleMultiServiceBookingOptions {
|
|
|
4886
4860
|
*
|
|
4887
4861
|
*
|
|
4888
4862
|
* Wix Bookings considers:
|
|
4889
|
-
* - The relevant services' booking policies
|
|
4890
|
-
* - The availability of all required
|
|
4863
|
+
* - The relevant services' [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction).
|
|
4864
|
+
* - The availability of all required [resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction).
|
|
4891
4865
|
*
|
|
4892
4866
|
* Call this method to check if an existing multi-service booking is still valid after business configuration changes.
|
|
4893
4867
|
* For example, staff changes, policy updates, or capacity modifications.
|
|
4894
4868
|
*
|
|
4895
|
-
* For checking availability before creating new multi-service bookings, call List Multi Service Availability Time Slots
|
|
4896
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/time-slots/multi-service-availability-time-slots/list-multi-service-availability-time-slots) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots)) instead.
|
|
4869
|
+
* For checking availability before creating new multi-service bookings, call [List Multi Service Availability Time Slots](https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots) instead.
|
|
4897
4870
|
* @param multiServiceBookingId - ID of the multi-service booking to retrieve.
|
|
4898
4871
|
* @public
|
|
4899
4872
|
* @documentationMaturity preview
|
|
@@ -4912,7 +4885,7 @@ declare function getMultiServiceBookingAvailability(multiServiceBookingId: strin
|
|
|
4912
4885
|
* Cancels the entire multi-service booking, updating the status of all single-service bookings to `CANCELED`.
|
|
4913
4886
|
* The call fails if all single-service bookings are already canceled or declined.
|
|
4914
4887
|
*
|
|
4915
|
-
* See Cancel Booking
|
|
4888
|
+
* See [Cancel Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking) for single-service booking cancellation details.
|
|
4916
4889
|
* @param multiServiceBookingId - ID of the multi-service booking to cancel.
|
|
4917
4890
|
* @public
|
|
4918
4891
|
* @documentationMaturity preview
|
|
@@ -4958,7 +4931,7 @@ interface CancelMultiServiceBookingOptions {
|
|
|
4958
4931
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
4959
4932
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
4960
4933
|
*
|
|
4961
|
-
* See Mark Booking as Pending
|
|
4934
|
+
* See [Mark Booking as Pending](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/mark-booking-as-pending) for more details about marking single-service bookings as pending.
|
|
4962
4935
|
* @param multiServiceBookingId - ID of the multi-service booking to mark as `PENDING`.
|
|
4963
4936
|
* @public
|
|
4964
4937
|
* @documentationMaturity preview
|
|
@@ -5018,7 +4991,7 @@ interface MarkMultiServiceBookingAsPendingOptions {
|
|
|
5018
4991
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
5019
4992
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
5020
4993
|
*
|
|
5021
|
-
* See Confirm Booking
|
|
4994
|
+
* See [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking) for more details about confirming single-service bookings.
|
|
5022
4995
|
* @param multiServiceBookingId - ID of the multi-service booking to confirm its related bookings.
|
|
5023
4996
|
* @public
|
|
5024
4997
|
* @documentationMaturity preview
|
|
@@ -5074,7 +5047,7 @@ interface ConfirmMultiServiceBookingOptions {
|
|
|
5074
5047
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
5075
5048
|
* - __Revision control__: Requires current revision numbers for all single-service bookings.
|
|
5076
5049
|
*
|
|
5077
|
-
* Refer to Decline Booking
|
|
5050
|
+
* Refer to [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking) for more details about declining single-service bookings.
|
|
5078
5051
|
* @param multiServiceBookingId - ID of the multi-service booking to decline.
|
|
5079
5052
|
* @public
|
|
5080
5053
|
* @documentationMaturity preview
|
|
@@ -5111,7 +5084,7 @@ interface DeclineMultiServiceBookingOptions {
|
|
|
5111
5084
|
*
|
|
5112
5085
|
* Bear the following considerations in mind when calling this method:
|
|
5113
5086
|
*
|
|
5114
|
-
* __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, booking policies
|
|
5087
|
+
* __Real-time validation__: Wix Bookings calculates allowed actions based on current multi-service booking status, [booking policies](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction), and [available resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) at the time of the call.
|
|
5115
5088
|
*
|
|
5116
5089
|
* __Permission context__: Depending on the permissions of the calling [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities), you may see different allowed actions for the same multi-service booking. For example, if the identity has permissions to read only part of the multi-service booking, the response indicates which single-service bookings the identity can read.
|
|
5117
5090
|
*
|
|
@@ -5135,7 +5108,7 @@ declare function bulkGetMultiServiceBookingAllowedActions(multiServiceBookingIds
|
|
|
5135
5108
|
* If you call on behalf of an [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) with permissions to read only part of the multi-service booking, only the permitted single-service bookings are retrieved.
|
|
5136
5109
|
* The returned total number includes single-service bookings for which you don't have permissions.
|
|
5137
5110
|
*
|
|
5138
|
-
* See Query Extended Bookings
|
|
5111
|
+
* See [Query Extended Bookings](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/query-extended-bookings) for details about retrieving individual single-service bookings and additional metadata.
|
|
5139
5112
|
* @param multiServiceBookingId - ID of the multi-service booking.
|
|
5140
5113
|
* @public
|
|
5141
5114
|
* @documentationMaturity preview
|
|
@@ -5153,7 +5126,7 @@ declare function getMultiServiceBooking(multiServiceBookingId: string): Promise<
|
|
|
5153
5126
|
* ### When to call this method
|
|
5154
5127
|
*
|
|
5155
5128
|
* Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
|
|
5156
|
-
* For creating a new multi-service booking with new single-service bookings, call Create Multi Service Booking
|
|
5129
|
+
* For creating a new multi-service booking with new single-service bookings, call [Create Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking) instead.
|
|
5157
5130
|
*
|
|
5158
5131
|
* ### Package integration
|
|
5159
5132
|
*
|
|
@@ -5202,7 +5175,7 @@ interface AddBookingsToMultiServiceBookingOptions {
|
|
|
5202
5175
|
*
|
|
5203
5176
|
* __Selective removal__: Specify single-service booking IDs and revisions to remove only specific single-service bookings from the package.
|
|
5204
5177
|
*
|
|
5205
|
-
* __Sequential scheduling__: To maintain sequential scheduling, remove only first or last single-service bookings. For middle bookings, first reschedule all relevant single-service bookings to eliminate gaps. To do so, call Reschedule Multi Service Booking
|
|
5178
|
+
* __Sequential scheduling__: To maintain sequential scheduling, remove only first or last single-service bookings. For middle bookings, first reschedule all relevant single-service bookings to eliminate gaps. To do so, call [Reschedule Multi Service Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-multi-service-booking) before removing the unwanted bookings.
|
|
5206
5179
|
*
|
|
5207
5180
|
* ### Removal behavior
|
|
5208
5181
|
*
|