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

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Manage Bookings
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsAddTipDistributionsToOrderOptions

Options to use when adding tip distributions to an order.

Returns
Return Type:Promise<AddTipDistributionsToOrderResponse>
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:

See the entire list and learn more about Wix errors.

Did this help?