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.

Updates the tip choice that's currently selected by the customer for a specific eCommerce checkout.

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
Learn more about app permissions.
Method Declaration
Copy
function setTipOnOrder(
  options: SetTipOnOrderOptions,
): Promise<SetTipOnOrderResponse>;
Method Parameters
optionsSetTipOnOrderOptions

Options to use when setting a tip on an order.

Returns
Return Type:Promise<SetTipOnOrderResponse>
JavaScript
import { tips } from "@wix/ecom";

async function setTipOnOrder(options) {
  const response = await tips.setTipOnOrder(options);
}
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?