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.

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

dev(wix-bookings-frontend)| add service page shareable link #3012

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<!-- This article was published using the Doc Push single-sourcing tool. Any changes to this article MUST be made in the source file. Find it at www.github.com/wix-private/velo-docs.-->

# Creating a Shareable Booking Service Page Link

With booking service page [query parameters](#query-parameters), you can:

+ Create a link to a Wix site's [booking service page](https://support.wix.com/en/article/wix-bookings-customizing-your-service-pages) with preset values you choose.

## Introduction

When a site visitor navigates to see a service details on a Wix site, they are taken to a booking service page.
Here they can see the service in more details, upcoming sessions and cancellation policy if set.
With query parameters, you can create and share a direct link to a booking service page with a pre-selected location.
A site visitor who visits the page via your custom link can still change their selections, but the values you define appear as default choices.
Using query parameters, you can select default values for these fields:

+ Locations

## Creating your shareable link

To create your customized shareable link, follow these steps:

1. Obtain the Wix site's [booking service page URL](#booking-service-page-url).
2. Determine which [query parameters](#query-parameters) you want to use.
3. Find the values you need for the query parameters. For a location read more about [finding IDs](#finding-ids).

### Booking service page URL

The booking service page is the page where a Wix site visitor can get details of the service
(appointment, class and course) requests for a booking.
Query parameters are added at the end of the URL for this page.
You can find the full URL for a Wix site's booking service page by navigating to the page in a browser and looking in the address b
Alternatively, you can construct the full URL for a booking service page on the basis of the site URL and the slug for the service.
The full URL for a booking service page is structured as follows:


```url
https://<SITE_URL>/service-page/<SERVICE_SLUG>
```

To find the service slug using the site dashboard, follow these steps:

1. Log into the site dashboard.
2. Click "Booking Services" in the sidebar menu.
3. Hover over the desired service in the list of services to make the "Edit" button appear, then click the "Edit" button. This opens the page for managing the service.
4. Scroll down to the "Marketing & SEO" section on the right, then click "Edit SEO Settings". This opens the "SEO Settings" section.
5. The service slug appears in the "URL slug" section.

Choose a reason for hiding this comment

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

In Services V2 we also have a documented mainSlug property we can link to, or add a code example of how to fetch it using Velo.

Copy link
Author

Choose a reason for hiding this comment

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

but we are talking here before the user have the service v2, it is just velo code on service page to read the url.


For example, if a Wix site's URL is `www.my-example-site.com` and the service slug is `initial-consultation`, the URL will be:

```url
https://www.my-example-site.com/service-page/initial-consultation
```

### Query parameters

Attach any of the following query parameters to a Wix site booking service page URL to preset customized default settings of your choice:

| Query Parameter | Description |
| --------------- | ----------- |
| `location` | One or more business locations, identified by ID. Use commas to separate multiple location IDs.|

### Finding IDs

To set customized default locations, you need to obtain the relevant IDs. You can do this as follows:


#### Locations

To find the ID for a business location, use [`listLocations()`](/wix-business-tools-v2/locations/listlocations) or [`queryLocations()`](/wix-business-tools-v2/locations/querylocations).

## Examples

The following are examples of shareable links for a Wix site's booking service page with query parameters that set customized default values.

location:

```url
www.your-site.com/service-page/your-service?location=70a4f77e-cd37-455f-bb1d-ce1f0a55ddb
```

Choose a reason for hiding this comment

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

This is an article within the Velo implementation, do we want some Velo example? fetching the locations query from the URL? getting the service with a filter by its slug?

Copy link
Author

Choose a reason for hiding this comment

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

i think to read query param is common case and not required a velo code, it is simple for velo users.
again we follow our same docs about other pages.