Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

first draft #692

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+43 −0
Open

first draft #692

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31bd5e9
first draft
FernandoWix Apr 18, 2023
1fbdf3e
rewrite
FernandoWix Jul 12, 2023
e6fad78
img and +
FernandoWix Jul 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions wix-bookings/guides/Wix Bookings Life Cycle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Wix Bookings Lifecycle

To manage bookings, a life cycle status is used to track their progression through different stages. This status is essential for controlling the possible actions that can be taken, such as confirming a pending booking. By utilizing this life cycle status, the system effectively regulates the booking process from start to finish.
FernandoWix marked this conversation as resolved.
Show resolved Hide resolved
FernandoWix marked this conversation as resolved.
Show resolved Hide resolved
FernandoWix marked this conversation as resolved.
Show resolved Hide resolved
FernandoWix marked this conversation as resolved.
Show resolved Hide resolved

A booking can go through checkout for payment or have no payment, in any case, the validation occurs through [Confirm or decline](https://dev.wix.com/api/rest/wix-bookings/confirmation/confirm-or-decline-booking), where availability, payment and the need for business confirmation are checked.
FernandoWix marked this conversation as resolved.
Show resolved Hide resolved

A booking does not need payment to be confirmed, but payment will make sure that the booking is confirmed, even in a case of `DOUBLEBOOKING`, another way of allowing `DOUBLEBOOKING` is passing `skipAvailability` as `true` when creating the booking.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is not organized well. Please try to rewrite. Here are some things to keep in mind:

  • "A booking does not not need payment to be confirmed" ... First talk about confirming as part of the lifecycle. What does it mean when something is confirmed?
  • Maybe put this paragraph under a heading called "Confirming bookings" or something like that? In tech writing, headings and bullets are our friends. Use them a lot. No one wants to just read paragraphs and paragraphs of flowing text - they want what we call "Signposts" ... things that catch the readers' eyes and help them decide if they need to read the paragraph or not.
  • You have a tendency to throw in code-voiced objects/properties/values instead of first explaining things in regular language. It clutters the virtual page and makes it harder to read. So just talk about double bookings (not the status DOUBLEBOOKING and talk about "disabling availability checks" or "skipping availability checks" instead of "passing skipAvailability as true" ... we're in an article, not in the actual reference. You can always add a link to the place in the reference to the actual status/property either in the API Ref or in the Terminology glossary ... but the words should be regular language.
    -This is not structured as a sentence. Every sentence should have a subject, a verb and usually also an object. Please learn about these things - here is a site that might be helpful but I'm sure you can find other sites: https://ecampusontario.pressbooks.pub/cs050academicwritingandgrammar/chapter/subjects-and-verbs/#:~:text=Every%20complete%20sentence%20has%20both,sentence%20says%20about%20the%20subject.


The following table describes all the possible status for a booking:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

statuses


| Status | Definition |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not reviewing every single word in the table. I will need to see the entire article again. I will just give you some quick comments. But realize that it's not a full review on the table.

|---------------|-------------------------|

| `CREATED` | The booking has been created, but doesn't yet appear in the business calendar.
The first step and status of a booking is created, it can be used for checkout or processed without it.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a sentence - it should be two sentences or rewritten to be one sentence. I think if you ran every sentence through ChatGPT you'd be in a better place.
I do not understand what this means: "it can be used for checkout or processed without it."
Do we always say "business calendar?" Can we just always say "calendar?"
I don't understand what "the first step and status" means, can be worded better.

You can create a booking with [Create booking](https://dev.wix.com/api/rest/wix-bookings/bookings-v2/create-booking)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In REST, the endpoints are capitalized so it would be Create Booking.

Also you are missing a period at the end of the sentence.

| `CONFIRMED` | The site owner has confirmed the booking and it appears in the business calendar.
+ You can manually confirm a booking from pending with [Confirm Booking](https://dev.wix.com/api/rest/wix-bookings/bookings-v2/confirm-booking).
+ Bookings are automatically confirmed when the [service](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service) is configured to do so and the eCommerce order (coming soon) has been approved. An automatic confirmation includes checking the slot's or schedule's availability.
FernandoWix marked this conversation as resolved.
Show resolved Hide resolved
+ Bookings are also automatically confirmed if `skipBusinessConfirmation` is passed as `true` when creating the booking, `false` is default.
| `PENDING` | The booking is waiting to be confirmed or declined by the owner and is displayed in the business calendar.
You can't manually set bookings as `PENDING` via an API.
Bookings are automatically set as `PENDING` when an eCommerce order related to the booking has been created (coming soon).
| `WAITING_LIST` | The booking is pending on a waiting list.
FernandoWix marked this conversation as resolved.
Show resolved Hide resolved
You must use the [Waitlist APIs](https://dev.wix.com/api/rest/wix-bookings/waitlist/introduction)
to create bookings in status `WAITING_LIST`. You can't change a booking's status from `CREATED` to `WAITING_LIST` with the Bookings V2 APIs.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"You can't change a booking's status from CREATED to WAITING_LIST with the Bookings V2 APIs."

Huh? Is this a limitation for now? This should be in the Intro "Before you begin" section also. As is written in our guidelines in the cafe, step 6: "The section helps us inform app developers and Velo users about missing or unexpected functionality. It's important to do this before they start working. This way they won’t get stuck in the middle of their project."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding to before you begin for BV2

| `DECLINED` | The booking has been declined by the site owner.
+ You can manually decline a booking with
[Decline Booking](https://dev.wix.com/api/rest/wix-bookings/bookings-v2/decline-booking).
+ Bookings are automatically declined when an eCommerce order has been
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You forgot your "coming soon"

declined or a double booking happened for free bookings.
| `CANCELED` | The booking has been canceled by the site owner or the customer.
You can cancel bookings with [Cancel Booking](https://dev.wix.com/api/rest/wix-bookings/bookings-v2/cancel-booking).
FernandoWix marked this conversation as resolved.
Show resolved Hide resolved