About the Tippable Staff API

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:

• Use custom filtering to identify staff members eligible to receive tips via the eCommerce platform.

See also:

• Tips API
• Tip Settings API
• Bookings Staff Members API

Before you begin

It's important to note the following points before starting to code:

• Ensure that the site owner has installed Wix Tips on their site. Wix Tips is automatically installed with every Wix Bookings installation.
• Currently, only Bookings staff members and site collaborators can receive tip distributions.
• Not all staff members have a Wix user identity, and not all site collaborators qualify as staff members.

Sample use cases

• Implement a staff performance dashboard.

Terminology

• Tip: Details the tip amount, how it’s distributed among staff, and the associated order’s line item subtotal.
• Tip distribution: How the total tip is divided among staff. The business receives the undistributed tip amount.
• Staff: Team members eligible to receive a portion of the tip. Currently, only Bookings staff members and site collaborators are eligible for tip distributions.
  • Bookings staff member: A business resource used to manage and provide services through Wix Bookings. Manage staff members, see via the Bookings Resources API.
  • Site collaborator: A Wix user authorized to edit or manage the business website.

For a comprehensive glossary of Wix Bookings terms, see Terminology.

Tippable Staff API: Sample Use Cases and Flows

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.

Implement a staff performance dashboard

Your app could help business owners evaluate staff performance based on various metrics, including tips received.

To implement a staff performance dashboard:

1. Use List Tippable Staff to retrieve all tippable staff and save their IDs.
2. Calculate the total tip amount for each staff member in your desired time range. Use Sum Tip Distributions and filter using the relevant staff ID and your desired range for createdDate. Alternatively, you can use Query Tip Distributions with the same filter and calculate the total tip per staff on your servers.
3. Display each staff member's information and their associated tip total to the business owners.