previewTip( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Previews a tip for a list of line items.

If you provide the Wix Bookings app ID 13d21c63-b5ec-5912-8397-c3a5ddb27a97 as lineItemInfo.catalogReference.appId, the response includes tip distributions for each associated Bookings staff member.

If you don't provide a tipSettingsId, the staffDistributionMethod is based on the site's default tip settings.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Manage Bookings
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
lineItemInfoArray<LineItemInfo>Required

Information about the line items to preview the tip for.

Min: 1 line item Max: 50 line items


optionsPreviewTipOptions

Options to use when previewing a tip.

Returns
Return Type:Promise<PreviewTipResponse>
Errors
404Not Found

There are 2 errors with this status code:

See the entire list and learn more about Wix errors.

Did this help?