@wix/auto_sdk_bookings_bookings 1.0.57 → 1.0.58
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 +58 -58
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +77 -74
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +19 -16
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +58 -58
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +77 -74
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +19 -16
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +58 -58
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +77 -74
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +19 -16
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +58 -58
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +77 -74
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +19 -16
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -29,13 +29,13 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
29
29
|
*
|
|
30
30
|
* The structure depends on the type of service being booked:
|
|
31
31
|
*
|
|
32
|
-
*
|
|
32
|
+
* __For appointment services__: Use `slot` to book a specific time slot with a
|
|
33
33
|
* service provider. Appointments are typically one-time sessions at a specific date and time.
|
|
34
34
|
*
|
|
35
|
-
*
|
|
35
|
+
* __For class services__: Use `slot` to book a specific class session. Classes
|
|
36
36
|
* are individual sessions that can have multiple participants.
|
|
37
37
|
*
|
|
38
|
-
*
|
|
38
|
+
* __For course services__: Use `schedule` to book an entire course consisting of
|
|
39
39
|
* multiple sessions over time. Courses are recurring, multi-session offerings.
|
|
40
40
|
*
|
|
41
41
|
* Choose the appropriate field based on your service type and booking requirements.
|
|
@@ -62,14 +62,14 @@ interface Booking extends BookingParticipantsInfoOneOf {
|
|
|
62
62
|
* ([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))
|
|
63
63
|
* when customers use Wix eCommerce checkout.
|
|
64
64
|
*
|
|
65
|
-
*
|
|
65
|
+
* ### Integration patterns
|
|
66
66
|
*
|
|
67
|
-
*
|
|
67
|
+
* __When using Wix eCommerce checkout__: Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status.
|
|
68
68
|
* Do not manually update this field.
|
|
69
69
|
*
|
|
70
|
-
*
|
|
70
|
+
* __When using custom payment flows__: You can manually update the payment status with Confirm Booking or Decline Booking ([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)) to reflect the customer's payment state.
|
|
71
71
|
*
|
|
72
|
-
*
|
|
72
|
+
* __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active pricing plan ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/pricing-plans/pricing-plans/introduction)) subscription.
|
|
73
73
|
*
|
|
74
74
|
* All payment statuses are supported for every booking `status`.
|
|
75
75
|
*/
|
|
@@ -168,9 +168,9 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
168
168
|
* ([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)).
|
|
169
169
|
*
|
|
170
170
|
* Specify `slot` when creating bookings for:
|
|
171
|
-
* -
|
|
171
|
+
* - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
|
|
172
172
|
* Wix Bookings creates a new session when the booking is confirmed.
|
|
173
|
-
* -
|
|
173
|
+
* - __Class services__: Group sessions at specific times (fitness classes, workshops).
|
|
174
174
|
* Wix Bookings links the booking to an existing scheduled session.
|
|
175
175
|
*
|
|
176
176
|
* For course services, specify `schedule` instead of `slot`.
|
|
@@ -181,7 +181,7 @@ interface BookedEntity extends BookedEntityItemOneOf {
|
|
|
181
181
|
* ([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)).
|
|
182
182
|
*
|
|
183
183
|
* Specify `schedule` when creating bookings for:
|
|
184
|
-
* -
|
|
184
|
+
* - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
185
185
|
* Wix Bookings enrolls participants in all sessions defined by the course schedule.
|
|
186
186
|
*/
|
|
187
187
|
schedule?: BookedSchedule;
|
|
@@ -208,9 +208,9 @@ interface BookedEntityItemOneOf {
|
|
|
208
208
|
* ([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)).
|
|
209
209
|
*
|
|
210
210
|
* Specify `slot` when creating bookings for:
|
|
211
|
-
* -
|
|
211
|
+
* - __Appointment-based services__: Individual sessions with service providers (consultations, treatments).
|
|
212
212
|
* Wix Bookings creates a new session when the booking is confirmed.
|
|
213
|
-
* -
|
|
213
|
+
* - __Class services__: Group sessions at specific times (fitness classes, workshops).
|
|
214
214
|
* Wix Bookings links the booking to an existing scheduled session.
|
|
215
215
|
*
|
|
216
216
|
* For course services, specify `schedule` instead of `slot`.
|
|
@@ -221,7 +221,7 @@ interface BookedEntityItemOneOf {
|
|
|
221
221
|
* ([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)).
|
|
222
222
|
*
|
|
223
223
|
* Specify `schedule` when creating bookings for:
|
|
224
|
-
* -
|
|
224
|
+
* - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs).
|
|
225
225
|
* Wix Bookings enrolls participants in all sessions defined by the course schedule.
|
|
226
226
|
*/
|
|
227
227
|
schedule?: BookedSchedule;
|
|
@@ -247,7 +247,10 @@ interface BookedSlot {
|
|
|
247
247
|
startDate?: string | null;
|
|
248
248
|
/** The end time of this slot in `YYYY-MM-DDThh:mm:ss`, `YYYY-MM-DDThh:mm:ss:SSS`, or `YYYY-MM-DDThh:mm:ss:SSSZZ` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`, `2026-01-30T13:30:00:000`, or `2026-01-30T13:30:00:000-05:00`. */
|
|
249
249
|
endDate?: string | null;
|
|
250
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
|
|
252
|
+
* For example, `America/New_York` or `UTC`. This is the time zone in which the slot was shown to the customer at the time of booking. Wix Bookings ensures that the slot is always displayed in this same time zone to the customer, including when they view or edit their booking in the future.
|
|
253
|
+
*/
|
|
251
254
|
timezone?: string | null;
|
|
252
255
|
/**
|
|
253
256
|
* Primary resource
|
|
@@ -327,8 +330,8 @@ interface BookedSchedule {
|
|
|
327
330
|
*/
|
|
328
331
|
location?: Location;
|
|
329
332
|
/**
|
|
330
|
-
* Time zone in
|
|
331
|
-
*
|
|
333
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
|
|
334
|
+
* For example, `America/New_York` or `UTC`. This is the time zone in which the schedule was shown to the customer at the time of booking. Wix Bookings ensures that the schedule is always displayed in this same time zone to the customer, including when they view or edit their booking in the future.
|
|
332
335
|
*/
|
|
333
336
|
timezone?: string | null;
|
|
334
337
|
/**
|
|
@@ -3887,7 +3890,7 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
3887
3890
|
* Creates a booking.
|
|
3888
3891
|
*
|
|
3889
3892
|
*
|
|
3890
|
-
*
|
|
3893
|
+
* ### Appointment booking
|
|
3891
3894
|
*
|
|
3892
3895
|
* For appointment-based services, specify the relevant `slot` in
|
|
3893
3896
|
* `bookedEntity.slot`. We recommend specifying the complete
|
|
@@ -3895,7 +3898,7 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
3895
3898
|
* ([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))
|
|
3896
3899
|
* in your call's request to avoid failed calls due to unavailability.
|
|
3897
3900
|
*
|
|
3898
|
-
*
|
|
3901
|
+
* ### Class session booking
|
|
3899
3902
|
*
|
|
3900
3903
|
* For class services, specify the relevant event ID
|
|
3901
3904
|
* ([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))
|
|
@@ -3907,27 +3910,27 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
3907
3910
|
* `slot.timezone`, `slot.resource`, and `slot.location`. All manually specified
|
|
3908
3911
|
* values are overridden.
|
|
3909
3912
|
*
|
|
3910
|
-
*
|
|
3913
|
+
* ### Course booking
|
|
3911
3914
|
*
|
|
3912
3915
|
* For course services, specify the course's schedule ID in `bookedEntity.schedule.scheduleId`.
|
|
3913
3916
|
* We recommend following [this sample flow](https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-a-course)
|
|
3914
3917
|
* to minimize failed calls due to unavailability.
|
|
3915
3918
|
*
|
|
3916
|
-
*
|
|
3919
|
+
* ### Related resources
|
|
3917
3920
|
*
|
|
3918
3921
|
* Specifying a `resource` triggers an availability check, resulting in a failed
|
|
3919
3922
|
* call if the resource is unavailable. Omitting a resource allows Wix Bookings
|
|
3920
3923
|
* to assign a resource belonging to the relevant type randomly when the merchant
|
|
3921
3924
|
* confirms the booking.
|
|
3922
3925
|
*
|
|
3923
|
-
*
|
|
3926
|
+
* ### Participant information
|
|
3924
3927
|
*
|
|
3925
3928
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
3926
3929
|
* The call fails if the specified `participantsChoices` aren't among the supported
|
|
3927
3930
|
* _service options and variants_
|
|
3928
3931
|
* ([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)).
|
|
3929
3932
|
*
|
|
3930
|
-
*
|
|
3933
|
+
* ### Notify customers
|
|
3931
3934
|
*
|
|
3932
3935
|
* You can specify a `participantNotification.message` for the customer that's send
|
|
3933
3936
|
* immediately. Ensure `participantNotification.notifyParticipants` is set to `true`
|
|
@@ -3936,19 +3939,19 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
3936
3939
|
* If you specify `{"sendSmsReminder": true}`, the customer receives an SMS 24 hours
|
|
3937
3940
|
* before the session starts. The phone number is taken from `contactDetails.phone`.
|
|
3938
3941
|
*
|
|
3939
|
-
*
|
|
3942
|
+
* ### Booking status
|
|
3940
3943
|
*
|
|
3941
3944
|
* Bookings default to the `CREATED` status, not affecting the business calendar
|
|
3942
3945
|
* or resource availability. You can specify a different status when the calling
|
|
3943
3946
|
* [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities)
|
|
3944
3947
|
* has `Manage Bookings` permissions.
|
|
3945
3948
|
*
|
|
3946
|
-
*
|
|
3949
|
+
* ### Payment options
|
|
3947
3950
|
*
|
|
3948
3951
|
* The specified `selectedPaymentOption` indicates how the customer intends to
|
|
3949
3952
|
* pay, allowing for later changes to a different method supported by the service.
|
|
3950
3953
|
*
|
|
3951
|
-
*
|
|
3954
|
+
* ### Payment status
|
|
3952
3955
|
*
|
|
3953
3956
|
* A booking is initially created with `{"paymentStatus": "UNDEFINED"}` regardless
|
|
3954
3957
|
* of the payment status specified in Create Booking. If a customer uses an
|
|
@@ -3963,7 +3966,7 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
3963
3966
|
* payment status with Confirm Or Decline Booking
|
|
3964
3967
|
* ([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)).
|
|
3965
3968
|
*
|
|
3966
|
-
*
|
|
3969
|
+
* ### Booking form data
|
|
3967
3970
|
*
|
|
3968
3971
|
* When customers sign up for a service, they must fill out the booking form.
|
|
3969
3972
|
* To create a booking with a completed booking form, specify the relevant data in
|
|
@@ -3972,7 +3975,7 @@ interface BulkConfirmOrDeclineBookingOptions {
|
|
|
3972
3975
|
* don't match, Create Booking fails. Therefore, we recommend specifying
|
|
3973
3976
|
* only `booking.contactDetails.contactId` when providing `formSubmission`.
|
|
3974
3977
|
*
|
|
3975
|
-
*
|
|
3978
|
+
* ### Admin overwrites
|
|
3976
3979
|
*
|
|
3977
3980
|
* There are small but important differences when you specify special
|
|
3978
3981
|
* `flowControlSettings`:
|
|
@@ -4066,18 +4069,18 @@ interface BulkCreateBookingOptions {
|
|
|
4066
4069
|
* a different session.
|
|
4067
4070
|
*
|
|
4068
4071
|
*
|
|
4069
|
-
*
|
|
4072
|
+
* ### Course booking limitation
|
|
4070
4073
|
*
|
|
4071
4074
|
* You can't reschedule course bookings.
|
|
4072
4075
|
*
|
|
4073
|
-
*
|
|
4076
|
+
* ### Appointment sessions
|
|
4074
4077
|
*
|
|
4075
4078
|
* For appointments, the old session is removed from the business calendar
|
|
4076
4079
|
* while a new session is added. We recommend calling Query Availability
|
|
4077
4080
|
* ([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))
|
|
4078
4081
|
* first and specifying the entire retrieved `slot`.
|
|
4079
4082
|
*
|
|
4080
|
-
*
|
|
4083
|
+
* ### Class sessions
|
|
4081
4084
|
*
|
|
4082
4085
|
* For classes, the new session must be an existing session belonging to the
|
|
4083
4086
|
* same class. We recommend retrieving `availabilityEntries.slot.eventId`
|
|
@@ -4086,13 +4089,13 @@ interface BulkCreateBookingOptions {
|
|
|
4086
4089
|
* to avoid failed Reschedule Booking calls due to unavailability. Specify
|
|
4087
4090
|
* only `slot.eventId` instead of the entire `slot` object.
|
|
4088
4091
|
*
|
|
4089
|
-
*
|
|
4092
|
+
* ### Notify customers
|
|
4090
4093
|
*
|
|
4091
4094
|
* You can specify a `participantNotification.message` for the customer. To send
|
|
4092
4095
|
* the message, you must also specify `participantNotification.notifyParticipants`
|
|
4093
4096
|
* as `true`.
|
|
4094
4097
|
*
|
|
4095
|
-
*
|
|
4098
|
+
* ### Admin overwrites
|
|
4096
4099
|
*
|
|
4097
4100
|
* There are small but important differences when you specify special
|
|
4098
4101
|
* `flowControlSettings`:
|
|
@@ -4180,7 +4183,7 @@ interface RescheduleBookingOptionsParticipantsInfoOneOf {
|
|
|
4180
4183
|
* Updates the booking status to `CONFIRMED` without checking whether the relevant slot or schedule is still available.
|
|
4181
4184
|
*
|
|
4182
4185
|
*
|
|
4183
|
-
*
|
|
4186
|
+
* ### eCommerce checkout restriction
|
|
4184
4187
|
*
|
|
4185
4188
|
* Call this method only when using a custom checkout page. Don't
|
|
4186
4189
|
* call it when using a Wix eCommerce checkout
|
|
@@ -4189,17 +4192,17 @@ interface RescheduleBookingOptionsParticipantsInfoOneOf {
|
|
|
4189
4192
|
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
4190
4193
|
* ([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)).
|
|
4191
4194
|
*
|
|
4192
|
-
*
|
|
4195
|
+
* ### When to call Confirm Or Decline Booking instead
|
|
4193
4196
|
*
|
|
4194
4197
|
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
4195
4198
|
* For these checks, call Confirm or Decline Booking ([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)) instead.
|
|
4196
4199
|
*
|
|
4197
|
-
*
|
|
4200
|
+
* ### Original status validation
|
|
4198
4201
|
*
|
|
4199
4202
|
* You can only confirm bookings with a status of `PENDING`, `CREATED`, or
|
|
4200
4203
|
* `WAITING_LIST`.
|
|
4201
4204
|
*
|
|
4202
|
-
*
|
|
4205
|
+
* ### Double bookings
|
|
4203
4206
|
*
|
|
4204
4207
|
* Confirm Booking doesn't check whether a slot or schedule is still available.
|
|
4205
4208
|
* You can specify
|
|
@@ -4218,12 +4221,12 @@ interface RescheduleBookingOptionsParticipantsInfoOneOf {
|
|
|
4218
4221
|
* `{"checkAvailabilityValidation": false}`, the specified `doubleBooked` value
|
|
4219
4222
|
* is ignored.
|
|
4220
4223
|
*
|
|
4221
|
-
*
|
|
4224
|
+
* ### Payment status
|
|
4222
4225
|
*
|
|
4223
4226
|
* Also updates the booking's `paymentStatus`, if you specify a new payment
|
|
4224
4227
|
* status.
|
|
4225
4228
|
*
|
|
4226
|
-
*
|
|
4229
|
+
* ### Notify customers
|
|
4227
4230
|
*
|
|
4228
4231
|
* You can specify a `participantNotification.message` for the customer. To send
|
|
4229
4232
|
* the message, you must also specify `participantNotification.notifyParticipants`
|
|
@@ -4312,7 +4315,7 @@ interface UpdateExtendedFieldsOptions {
|
|
|
4312
4315
|
* slot or schedule is still available.
|
|
4313
4316
|
*
|
|
4314
4317
|
*
|
|
4315
|
-
*
|
|
4318
|
+
* ### eCommerce checkout restriction
|
|
4316
4319
|
*
|
|
4317
4320
|
* Call this method only when using a custom checkout page. Don't
|
|
4318
4321
|
* call it when using a Wix eCommerce checkout
|
|
@@ -4321,23 +4324,23 @@ interface UpdateExtendedFieldsOptions {
|
|
|
4321
4324
|
* the `paymentStatus` of the corresponding Wix eCommerce order
|
|
4322
4325
|
* ([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)).
|
|
4323
4326
|
*
|
|
4324
|
-
*
|
|
4327
|
+
* ### When to call Confirm Or Decline Booking instead
|
|
4325
4328
|
*
|
|
4326
4329
|
* The method doesn't check whether a slot or schedule is still available. For
|
|
4327
4330
|
* these checks you can call Confirm or Decline Booking
|
|
4328
4331
|
* ([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)).
|
|
4329
4332
|
*
|
|
4330
|
-
*
|
|
4333
|
+
* ### Original status validation
|
|
4331
4334
|
*
|
|
4332
4335
|
* You can only decline bookings with a `status` of `PENDING`, `CREATED`, or
|
|
4333
4336
|
* `WAITING_LIST`.
|
|
4334
4337
|
*
|
|
4335
|
-
*
|
|
4338
|
+
* ### Payment status
|
|
4336
4339
|
*
|
|
4337
4340
|
* Also updates the booking's `paymentStatus`, if you specify a new payment
|
|
4338
4341
|
* status.
|
|
4339
4342
|
*
|
|
4340
|
-
*
|
|
4343
|
+
* ### Notify customers
|
|
4341
4344
|
*
|
|
4342
4345
|
* You can specify a `participantNotification.message` for the customer. To send
|
|
4343
4346
|
* the message, you must also specify `participantNotification.notifyParticipants`
|
|
@@ -4378,24 +4381,24 @@ interface DeclineBookingOptions {
|
|
|
4378
4381
|
* Updates the booking status to `CANCELED`.
|
|
4379
4382
|
*
|
|
4380
4383
|
*
|
|
4381
|
-
*
|
|
4384
|
+
* ### Appointments
|
|
4382
4385
|
*
|
|
4383
4386
|
* For appointments, the corresponding event is removed from the Bookings
|
|
4384
4387
|
* calendar.
|
|
4385
4388
|
*
|
|
4386
|
-
*
|
|
4389
|
+
* ### Class and course bookings
|
|
4387
4390
|
*
|
|
4388
4391
|
* For class or course bookings, the relevant participants are removed
|
|
4389
4392
|
* from the class session or the course. However, the class session or course
|
|
4390
4393
|
* remain on the business calendar.
|
|
4391
4394
|
*
|
|
4392
|
-
*
|
|
4395
|
+
* ### Notify customers
|
|
4393
4396
|
*
|
|
4394
4397
|
* You can specify a `participantNotification.message` for the customer. To send
|
|
4395
4398
|
* the message, you must also specify `participantNotification.notifyParticipants`
|
|
4396
4399
|
* as `true`.
|
|
4397
4400
|
*
|
|
4398
|
-
*
|
|
4401
|
+
* ### Admin overwrites
|
|
4399
4402
|
*
|
|
4400
4403
|
* There are small but important differences when you specify special
|
|
4401
4404
|
* `flowControlSettings`:
|
|
@@ -4458,11 +4461,11 @@ interface CancelBookingOptions {
|
|
|
4458
4461
|
* the `totalNumberOfParticipants` for the relevant sessions.
|
|
4459
4462
|
*
|
|
4460
4463
|
*
|
|
4461
|
-
*
|
|
4464
|
+
* ### Appointment limitation
|
|
4462
4465
|
*
|
|
4463
4466
|
* You can't update the number of participants for appointment bookings.
|
|
4464
4467
|
*
|
|
4465
|
-
*
|
|
4468
|
+
* ### Participant information
|
|
4466
4469
|
*
|
|
4467
4470
|
* You must specify either `participantsChoices` or `totalParticipants`.
|
|
4468
4471
|
* The call fails if the specified `participantsChoices` aren't among the
|
|
@@ -4515,29 +4518,29 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
|
4515
4518
|
* Updates the booking status to `PENDING`.
|
|
4516
4519
|
*
|
|
4517
4520
|
*
|
|
4518
|
-
*
|
|
4521
|
+
* ### Service requirement
|
|
4519
4522
|
*
|
|
4520
4523
|
* By default, this method only works for services ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction)) with `service.onlineBooking.requireManualApproval` set to `true`.
|
|
4521
4524
|
* 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.
|
|
4522
4525
|
*
|
|
4523
|
-
*
|
|
4526
|
+
* ### Status requirements
|
|
4524
4527
|
*
|
|
4525
4528
|
* - __Original status__: Booking must have `CREATED` status.
|
|
4526
4529
|
* - __Target status__: Booking moves to `PENDING`.
|
|
4527
4530
|
*
|
|
4528
|
-
*
|
|
4531
|
+
* ### Checkout restrictions
|
|
4529
4532
|
*
|
|
4530
4533
|
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](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.
|
|
4531
4534
|
*
|
|
4532
4535
|
* When using custom checkouts, you can also update the booking's `paymentStatus` by specifying a new payment status.
|
|
4533
4536
|
*
|
|
4534
|
-
*
|
|
4537
|
+
* ### Business workflow
|
|
4535
4538
|
*
|
|
4536
4539
|
* After marking a booking as `PENDING`, the business must manually approve or reject it. You can call these methods:
|
|
4537
4540
|
* - Confirm Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/confirm-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking)).
|
|
4538
4541
|
* - Decline Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/decline-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking)).
|
|
4539
4542
|
*
|
|
4540
|
-
*
|
|
4543
|
+
* ### Resource availability and scheduling
|
|
4541
4544
|
*
|
|
4542
4545
|
* Marking a booking as `PENDING` immediately affects resource availability:
|
|
4543
4546
|
*
|
|
@@ -4545,16 +4548,16 @@ interface UpdateNumberOfParticipantsOptionsParticipantsInfoOneOf {
|
|
|
4545
4548
|
* - **Availability**: The time slot becomes unavailable for other bookings, even while pending approval.
|
|
4546
4549
|
* - **Resource assignment**: Available resources ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction)) are automatically assigned if none were explicitly selected during booking creation.
|
|
4547
4550
|
*
|
|
4548
|
-
*
|
|
4551
|
+
* ### Double bookings
|
|
4549
4552
|
*
|
|
4550
4553
|
* By default, the method doesn't check for availability conflicts. To detect and handle double bookings, use the `checkAvailabilityValidation: true` admin overwrite.
|
|
4551
4554
|
*
|
|
4552
|
-
*
|
|
4555
|
+
* ### Notify customers
|
|
4553
4556
|
*
|
|
4554
4557
|
* You can specify a `participantNotification.message` for the customer.
|
|
4555
4558
|
* To send the message, you must also specify `participantNotification.notifyParticipants` as `true`.
|
|
4556
4559
|
*
|
|
4557
|
-
*
|
|
4560
|
+
* ### Admin overwrites
|
|
4558
4561
|
*
|
|
4559
4562
|
* There are small but important differences when you specify special
|
|
4560
4563
|
* `flowControlSettings`:
|
|
@@ -4614,11 +4617,11 @@ interface MarkBookingAsPendingOptions {
|
|
|
4614
4617
|
* Creates a multi-service booking and all included single-service bookings simultaneously.
|
|
4615
4618
|
*
|
|
4616
4619
|
*
|
|
4617
|
-
*
|
|
4620
|
+
* ### When to call this method
|
|
4618
4621
|
*
|
|
4619
4622
|
* 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking)) instead.
|
|
4620
4623
|
*
|
|
4621
|
-
*
|
|
4624
|
+
* ### Requirements and behavior
|
|
4622
4625
|
*
|
|
4623
4626
|
* __Package constraints__: Multi-service bookings support 2-8 appointment-based single-service bookings only (course and class bookings aren't supported). All single-service bookings must be at the same location with sequential scheduling and no gaps between appointments.
|
|
4624
4627
|
*
|
|
@@ -4628,7 +4631,7 @@ interface MarkBookingAsPendingOptions {
|
|
|
4628
4631
|
*
|
|
4629
4632
|
* __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.
|
|
4630
4633
|
*
|
|
4631
|
-
*
|
|
4634
|
+
* ### Related methods
|
|
4632
4635
|
*
|
|
4633
4636
|
* Verify availability first with List Multi Service Availability Time Slots ([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)).
|
|
4634
4637
|
*
|
|
@@ -4779,17 +4782,17 @@ interface CancelMultiServiceBookingOptions {
|
|
|
4779
4782
|
*
|
|
4780
4783
|
* Call this method for multi-service bookings requiring manual business approval before confirmation.
|
|
4781
4784
|
*
|
|
4782
|
-
*
|
|
4785
|
+
* ### Status requirements
|
|
4783
4786
|
*
|
|
4784
4787
|
* - __Original status__: All single-service bookings must have `CREATED` status.
|
|
4785
4788
|
* - __Target status__: All bookings move to `PENDING` together (all-or-nothing operation).
|
|
4786
4789
|
*
|
|
4787
|
-
*
|
|
4790
|
+
* ### Checkout restrictions
|
|
4788
4791
|
*
|
|
4789
4792
|
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
4790
4793
|
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
4791
4794
|
*
|
|
4792
|
-
*
|
|
4795
|
+
* ### Additional updates
|
|
4793
4796
|
*
|
|
4794
4797
|
* - __Payment status__: Updates if you specify a new `markAsPendingBookingsInfo.paymentStatus`.
|
|
4795
4798
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
@@ -4839,17 +4842,17 @@ interface MarkMultiServiceBookingAsPendingOptions {
|
|
|
4839
4842
|
*
|
|
4840
4843
|
* Call this method for multi-service bookings requiring manual business approval.
|
|
4841
4844
|
*
|
|
4842
|
-
*
|
|
4845
|
+
* ### Status requirements
|
|
4843
4846
|
*
|
|
4844
4847
|
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
4845
4848
|
* - __Target status__: All bookings move to `CONFIRMED` together (all-or-nothing operation).
|
|
4846
4849
|
*
|
|
4847
|
-
*
|
|
4850
|
+
* ### Checkout restrictions
|
|
4848
4851
|
*
|
|
4849
4852
|
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
4850
4853
|
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
4851
4854
|
*
|
|
4852
|
-
*
|
|
4855
|
+
* ### Additional updates
|
|
4853
4856
|
*
|
|
4854
4857
|
* - __Payment status__: Updates if you specify a new `confirmBookingsInfo.paymentStatus`.
|
|
4855
4858
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
@@ -4895,17 +4898,17 @@ interface ConfirmMultiServiceBookingOptions {
|
|
|
4895
4898
|
*
|
|
4896
4899
|
* Call this method to reject multi-service bookings that can't be accommodated or don't meet business requirements.
|
|
4897
4900
|
*
|
|
4898
|
-
*
|
|
4901
|
+
* ### Status requirements
|
|
4899
4902
|
*
|
|
4900
4903
|
* - __Original status__: All single-service bookings must have `PENDING`, `CREATED`, or `WAITING_LIST` status.
|
|
4901
4904
|
* - __Target status__: All bookings move to `DECLINED` together (all-or-nothing operation).
|
|
4902
4905
|
*
|
|
4903
|
-
*
|
|
4906
|
+
* ### Checkout restrictions
|
|
4904
4907
|
*
|
|
4905
4908
|
* Only call this method if the customer paid via a custom checkout. For Wix eCommerce checkouts,
|
|
4906
4909
|
* Wix Bookings automatically manages the bookings' statuses based on payment processing.
|
|
4907
4910
|
*
|
|
4908
|
-
*
|
|
4911
|
+
* ### Additional updates
|
|
4909
4912
|
*
|
|
4910
4913
|
* - __Payment status__: Updates if you specify a new `declineBookingsInfo.paymentStatus`.
|
|
4911
4914
|
* - __Customer notifications__: Send messages using `participantNotification`.
|
|
@@ -4987,16 +4990,16 @@ declare function getMultiServiceBooking(multiServiceBookingId: string): Promise<
|
|
|
4987
4990
|
* Expands an existing multi-service booking by adding existing single-service bookings to the package.
|
|
4988
4991
|
*
|
|
4989
4992
|
*
|
|
4990
|
-
*
|
|
4993
|
+
* ### When to call this method
|
|
4991
4994
|
*
|
|
4992
4995
|
* Call this method to add 1 or more existing single-service bookings to an existing multi-service booking.
|
|
4993
4996
|
* For creating a new multi-service booking with new single-service bookings, call Create Multi Service Booking ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/create-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking)) instead.
|
|
4994
4997
|
*
|
|
4995
|
-
*
|
|
4998
|
+
* ### Package integration
|
|
4996
4999
|
*
|
|
4997
5000
|
* The timing of the single-service bookings to add must be compatible with the multi-service booking's sequential schedule to ensure no gaps or overlaps between services in the updated package.
|
|
4998
5001
|
*
|
|
4999
|
-
*
|
|
5002
|
+
* ### Requirements and limitations
|
|
5000
5003
|
*
|
|
5001
5004
|
* - __Maximum capacity__: The total number of single-service bookings can't exceed 8.
|
|
5002
5005
|
* - __Booking eligibility__: You can add only independent single-service bookings that aren't part of another multi-service booking.
|
|
@@ -5032,7 +5035,7 @@ interface AddBookingsToMultiServiceBookingOptions {
|
|
|
5032
5035
|
* Removes single-service bookings from a multi-service booking and converts them to independent single-service bookings.
|
|
5033
5036
|
*
|
|
5034
5037
|
*
|
|
5035
|
-
*
|
|
5038
|
+
* ### Removal options
|
|
5036
5039
|
*
|
|
5037
5040
|
* __Remove all permitted bookings__: If you specify an empty `bookings` array, all single-service bookings for which the call's [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) has read permissions are removed from the multi-service booking.
|
|
5038
5041
|
*
|
|
@@ -5040,7 +5043,7 @@ interface AddBookingsToMultiServiceBookingOptions {
|
|
|
5040
5043
|
*
|
|
5041
5044
|
* __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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/reschedule-multi-service-booking) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-multi-service-booking)) before removing the unwanted bookings.
|
|
5042
5045
|
*
|
|
5043
|
-
*
|
|
5046
|
+
* ### Removal behavior
|
|
5044
5047
|
*
|
|
5045
5048
|
* __Independent bookings__: Removed single-service bookings become independent bookings.
|
|
5046
5049
|
* You can manage them using single-service booking methods.
|