setTipOnOrder( )

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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Bookings
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?