addTipDistributionsToOrder( )

Developer Preview

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

Adds tip distributions to an eCommerce order.

If no tip exists on the order, an additionalFee is added and the total tip amount is equal to the sum of all distribution amounts. If a tip is already present, the existing additionalFee is replaced and the total tip amount is increased by the sum of the new tip distributions.

The call fails if:

  • The order's paymentStatus is either FULLY_REFUNDED or PARTIALLY_REFUNDED.
  • Any of the tip distribution amounts is zero or negative.
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 addTipDistributionsToOrder(
  options: AddTipDistributionsToOrderOptions,
): Promise<AddTipDistributionsToOrderResponse>;
Method Parameters
optionsAddTipDistributionsToOrderOptions

Options to use when adding tip distributions to an order.

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

async function addTipDistributionsToOrder(options) {
  const response = await tips.addTipDistributionsToOrder(options);
}
Errors
400Invalid Argument

There is 1 error with this status code.

404Not Found

There are 2 errors with this status code.

409Already Exists

There is 1 error with this status code.

428Failed Precondition

There are 2 errors with this status code.

500Internal

There are 3 errors with this status code.

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

Did this help?