The Tippable Staff API allows app developers to retrieve information about which business staff members are eligible to receive tips via the eCommerce platform. Currently, the API supports only staff members from Wix Bookings and site collaborators.
With the Tippable Staff API, your app can:
See also:
It's important to note the following points before starting to code:
For a comprehensive glossary of Wix Bookings terms, see Terminology.
This article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.
Your app could help business owners evaluate staff performance based on various metrics, including tips received.
To implement a staff performance dashboard:
createdDate
.
Alternatively, you can use
Query Tip Distributions
with the same filter and calculate the total tip per staff on your servers.Information about a team member who's eligible to receive a portion of the tip. Currently, only Bookings staff members and site collaborators are eligible for tip distributions.
Staff ID. Matches staffMemberId
if available, or
identificationData.wixUserId
if not.
Staff name. Matches the name of the Bookings staff member if available.
Staff member ID. Available only if the staff is connected to a Bookings staff member.
Identification data of the staff. Available only if the staff is a site collaborator.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of up to 100 staff who are eligible to receive tips, given the provided filtering.
You can only call this method when authenticated as a Wix app or Wix user identity.
Whether to include staff who are only Wix users and not
Bookings staff members
in the response. Setting {"includeWixUsers": true}
returns all tippable
staff, including Bookings staff, site collaborators, or those who are both.
By default, or if you provide {"includeWixUsers": false}
, only Bookings
staff members or those who are both are returned.
Default: false
.
Filters the returned staff by name. If you provide a name as filter, only staff whose names start with the given input are returned. The filter isn't case sensitive.
Max: 500 characters
Filters the returned staff by ID. If you provide a list of IDs as filter, only staff members with exact matching IDs are returned.
Max: 100 IDs
Retrieved staff.
curl -X POST \
'https://www.wixapis.com/tips-staff-service/v1/eligible-staff' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
{
"staff": [
{
"id": "79ee2a33-6937-39a4-ab46-6859171c5ad7",
"name": "Malakah Mada",
"staffMemberId": "79ee2a33-6937-39a4-ab46-6859171c5ad7",
"identificationData": null
},
{
"id": "7ec295cd-120c-3bff-9f43-a7e10c387f02",
"name": "Tiago Melo Correia",
"staffMemberId": "7ec295cd-120c-3bff-9f43-a7e10c387f02",
"identification_data": null
},
{
"id": "bdf56958-d4dd-306e-843c-e1196ed10cf5",
"name": "Cornelia Brandybuck",
"staffMemberId": "bdf56958-d4dd-306e-843c-e1196ed10cf5",
"identificationData": null
}
]
}