Pickups
Adds hotel pickup functionality to the API
To use this capability add ventrata/pickups to your Octo-Capabilities header.
Hotel pickup is sometimes offered by products where the guest can opt to be picked up from a different location instead to where the general meeting point is.
Product Pickups
GET https://api.ventrata.com/octo/products/:id
Returns top level pickup information on each product.
Path Parameters
id
string
The product id, leave this out to get every product.
Query Parameters
pickupRequested
boolean
Whether pickup was requested by the customer. May alter the pricing.
With this capability enabled we'll add pickupAvailable pickupRequired and pickupPoints to each product. A sample of just these changes are:
Field
Definition
pickupAvailable
Whether pickup is available for this product.
pickupRequired
If true, then a pickup point must be supplied during booking. Otherwise it's optional whether the customer wants to be picked up or not.
pickupPoints
This is a list of all the possible pickup points. Use this list for mapping purposes (if necessary) not all these pickup points are available for every departure. To know which are, check the pickup availability below.
If you're using the octo/pricing capability you should add pickupRequested=true to the product request and it will quote you the pricing with pickup. Setting it tofalse will show you the pricing without.
Pickup Check
POST https://api.ventrata.com/octo/availability
Returns a list of pickups for each departure.
Request Body
pickupRequested
boolean
Whether the customer requested pickup
pickupPointId
string
The pickup point id selected
In the availability response we add pickupAvailable pickupRequired and pickupPoints to each product. A sample of just these changes are:
The only difference from the pickup list provided on the product endpoint is the addition of localDateTime which is the pickup time for that pickup in the local time zone.
If you're using the octo/pricing capability you should add pickupRequested=true to any pricing request and it will quote you the pricing with pickup. Setting it to false will show you the pricing without.
Booking Reservation
POST https://api.ventrata.com/octo/bookings
Adding pickup information to the booking request
Request Body
pickupRequested
boolean
Whether the customer requested pickup
pickupPointId
string
The id of the chosen pickup point
pickupHotel
string
The hotel address (optional)
pickupHotelRoom
string
The hotel room number (optional)
You can also add these parameters to the booking confirmation request if you collect this data at a later stage.
An example request body will be like:
Note if you do not have the ability to list the available pickup points, but you do know the hotel which the customer is staying and want to request pickup you can make the request with the pickupHotel field instead:
The pickupHotelRoom field is optional, but gives the guest the ability to specify their hotel room in case they are late and can be contacted.
Ventrata will then attempt to geolocate that address (so please try and make it as accurate as possible) and will match it to the nearest possible pickup location.
The response will be the booking object with two extra fields: pickupRequested and pickupPoint. The result looks like this:
Last updated