applyBookingFeesToOrder( )


Developer Preview

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

Applies booking fees to an eCommerce order.

The booking fees are added as a single additional fee to the eCommerce order. The order's additionalFee.lineItemIds array is set to the list of corresponding booking IDs. By default, the additionalFee.price.amount is the sum of all booking fee prices. But you may provide a priceOverride instead. The override price can't be higher than the sum of all booking fees.

Apply Booking Fees to Order also updates the prices of all affected line items in the relevant eCommerce order to zero. After a cancellation fee is applied to an eCommerce order, the cancellation fee's price.value is updated to 0.00 and its trigger is set to UNKNOWN_TRIGGER. You can retrieve the fee amount from the corresponding additionalFee object of the eCommerce order with getOrder().

If you apply multiple booking fees to an eCommerce order, they either all fail or all succeed together. For example, the call fails if the booking fees are associated with different eCommmerce orders. In case of failure, onFailedToApplyBookingFeeToOrder() is triggered multiple times, once for each individual fee.

Method Declaration
Copy
Method Parameters
bookingIdsArray<string>Required

IDs of the bookings for which to apply booking fees to an eCommerce order.


optionsApplyBookingFeesToOrderOptions

Options to use when applying booking fees to an eCommerce order.

Returns
Return Type:Promise<ApplyBookingFeesToOrderResponse>
Was this helpful?
Yes
No