removeTipFromOrder( )

Developer Preview

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

Removes a tip from an eCommerce order.

If no tip exists on the order, the call succeeds and the response contains an empty OrderInfo object.

The call fails if the customer has already been charged for at least one of the associated tip distributions.

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 removeTipFromOrder(
  options: RemoveTipFromOrderOptions,
): Promise<RemoveTipFromOrderResponse>;
Method Parameters
optionsRemoveTipFromOrderOptions

Options to use when removing a tip from an order.

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

async function removeTipFromOrder(options) {
  const response = await tips.removeTipFromOrder(options);
}
Errors
428Failed Precondition

There is 1 error with this status code.

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

Did this help?