githubEdit

Price Adjustments

Allows you to adjust the retail rate of a booking

To use this capability, add octo/adjustments to your Octo-Capabilities header.

This capability lets you adjust the retail rate of a booking. The adjustment amount can be positive (to increase the price) or negative (to decrease the price).

The adjustment is deducted from or added to your commission on the booking. You cannot adjust a booking below commission (commission = retail - net).

Supported Endpoints

This capability extends booking write routes documented in Bookings and, when octo/cart is enabled, order write routes documented in Multi-Booking Cart.

Affecting booking routes:

  • POST /bookings

  • PATCH /bookings/{uuid}

  • POST /bookings/{uuid}/confirm

When octo/cart is enabled, the same additions are supported on nested bookings[] payloads in order write routes.

The only addition to the booking object in the request is the adjustments array:

adjustments is an array, so you can send multiple adjustments.

Request Fields

If request values are invalid, the API returns booking errors including ADJUSTMENTS_INVALID_PER, ADJUSTMENTS_INVALID_NET_DISCOUNT, and ADJUSTMENTS_NET_DISCOUNT_NOT_ALLOWED.

Schema Additions (JSON)

These are additive fragments showing only fields introduced by this capability.

Booking

Last updated