POST

Set Tip On Order

Developer Preview

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

Creates or updates a tip on an eCommerce order.

If no tip exists on the order, an additionalFee is added. If a tip is already present, the existing additionalFee is replaced.

If you specify tip.distributions.transaction, that distribution amount can't be changed in the future. Then, you also can't remove any of the other distributions.

The call fails if:

  • The order's paymentStatus is either FULLY_REFUNDED or PARTIALLY_REFUNDED.
  • The total tip amount is zero or negative.
  • The sum of all tip distribution amounts and undistributedAmount doesn't match the total tip amount.
  • You omit tip.distributions with an existing transaction.
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.
Endpoint
POST
https://www.wixapis.com/tips/v1/tips/set
Errors
400Invalid Argument

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Did this help?