setTipOnOrder( )

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 (SDK | REST).

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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings - all permissions
Manage Bookings
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsSetTipOnOrderOptionsRequired

Options to use when setting a tip on an order.

Returns
Return Type:Promise<SetTipOnOrderResponse>
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?