The Tips API allows app developers to manage tips for
eCommerce orders.
You can also preview tips and how they would be distributed to staff members
before an order is created.
With the Tips API, your app can:
- Preview tips
- Apply or remove tips from eCommerce orders
- Retrieve tips and their distributions
See also:
It's important to note the following points before starting to code:
- Ensure that the site owner has installed Wix Tips
on their site.
- Each tip is applied to an eCommerce order
as a single
additionalFee
. The tip's ID is stored in the additionalFee.code
field of the order.
- You can charge customers in separate transactions for individual tip
distributions. After a tip distribution has an associated transaction,
its amount can't be modified in the future.
- Currently, only Bookings staff members
and site collaborators
can receive tip distributions.
- 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.
- Tip settings: Configure how tips are previewed, applied, and distributed.
Refer to the Tip Settings API
for more information.
- Staff: Team members who receive a portion of the tip. Currently, only
Bookings staff members
and site collaborators
can receive tip distributions. Refer to the
Tippable Staff API
for more information.
- eCommerce order: Contains information about purchased items, price and tax
summaries, shipping, and billing details, any applied discounts, and the status
of payment and fulfillment. Refer to the
eCommerce Orders API
for more information.
For a comprehensive glossary of Wix Bookings terms, see
Terminology.