POST

Query Tip Settings


Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of up to 100 tip settings, given the provided paging, filtering, and sorting.

Query Tip Settings runs with these defaults, which you can override:

  • cursorPaging.limit is 50.
  • Sorted by id in ascending order.

For field support for filters and sorting, see Tip Settings: Supported Filters and Sorting.

Use UTC time when setting a filter for dates.

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

PropertyFiltersSort
_id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
locationId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
paymentTerminalId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
default$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
allowCustomerTip$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
allowBusinessTipAtPayment$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
allowEditDistribution$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
allowCustomAmount$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
tipType$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
Permissions
Manage Bookings
Learn more about app permissions.
Method Declaration
Copy
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?