Multi-booking Cart
Sell more than one booking together in a cart
To use this capability add
octo/cart to your Octo-Capabilities header.This capability gives you the ability to book multiple bookings from the same supplier together in a single "cart". In OCTO Cloud we call a "cart" an "order", and that's what it will be referred to in the rest of this document.
post
https://api.ventrata.com/octo
/bookings
Booking Reservation
This capability adds the following fields to the booking response:
"orderId": "09af0a55-f87a-423e-b27d-f2e38c1c9674",
"primary": true
When using this capability if you omit the
orderId from the original request OCTO Cloud will create a new order (cart) for you behind the scenes and return the orderId in the response. You can then re-use this orderId in any future booking requests and the bookings will all get added to the same order.post
https://api.ventrata.com/octo
/orders
Create Order
The Order object has the following fields:
Field | Description |
id | The order ID. Use this for future booking reservation requests. |
status | The status of the order. Possible values are: ON_HOLD This is the first status when the order is createdCONFIRMED Once the order is confirmedCANCELLED If the order is cancelledEXPIRED If the order wasn't confirmed in time |
utcExpiresAt | The ISO8601 in UTC when the order will expire. |
utcConfirmedAt | The ISO8601 in UTC when the order was confirmed. |
bookings | An array of booking objects within this order |
contact | This is the guest contact information, previously this was on the booking |
get
https://api.ventrata.com/octo
/orders/:id
Retrieve Order
post
https://api.ventrata.com/octo
/orders/:id/extend
Extend Order
post
https://api.ventrata.com/octo
/orders/:id/confirm
Order Confirmation
A typical request body would be:
{
"contact": {
"fullName": "Oliver Morgan",
"emailAddress": "[email protected]",
"phoneNumber": "+447840739436",
"locales": ["en-GB", "en-US", "en"],
"country": "GB"
}
}
If you're using the cart capability and want to set a
resellerReference you should do so as a booking update as there are no reseller references on the order level.Once you call this method, each of the bookings contained within the order will be confirmed too.
delete
https://api.ventrata.com/octo
/orders/:id
Order Cancellation
This endpoint is the same as cancelling the booking except it's on the order level.
Last modified 1yr ago