search

Pickups

Adds hotel pickup functionality to the API

To use this capability add octo/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.

hashtag
Product Pickups

GET {host}/products/:id

Returns top level pickup information on each product.

Path Parameters

Name
Type
Description

id

string

The product id, leave this out to get every product.

Query Parameters

Name
Type
Description

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:

{
  //...rest of the product object
  "pickupAvailable": true,
  "pickupRequired": true,
  "pickupPoints": [
    {
      "id": "0274665c-f047-42bd-a971-f31fcff24862",
      "name": "Cornell Hotel de France - 715 Bush St",
      "directions": null,
      "latitude": 37.7900142,
      "longitude": -122.4091263,
      "googlePlaceId": "ChIJs6F3JYyAhYARDiVdBrmivCs",
      "street": "715 Bush Street",
      "postal_code": "94108",
      "locality": "San Francisco",
      "region": "California",
      "state": "CA",
      "country": "US" 
    },
    {
      "id": "02f44fe5-c1e1-4173-b557-2f23c68e53ab",
      "name": "SF Plaza Hotel - 510 Bush St",
      "directions": null,
      "latitude": 37.7906443,
      "longitude": -122.4058728,
      "googlePlaceId": "ChIJfyuv4YuAhYAR3MOypx9cg3Q",
      "street": "510 Bush Street",
      "postal_code": "94108",
      "locality": "San Francisco",
      "region": "California",
      "state": "CA",
      "country": "US"
    },
    {
      "id": "07a1f50c-da65-4a82-9799-676c58946d15",
      "name": "Hilton Financial District - 750 Kearny St",
      "directions": "Meet at Hilton Fincial District at 750 Kearny St.",
      "latitude": 37.7952284,
      "longitude": -122.4040729,
      "googlePlaceId": "ChIJOzt_KIuAhYARNdt9T_gCmKQ",
      "street": "750 Kearny Street",
      "postal_code": "94108",
      "locality": "San Francisco",
      "region": "California",
      "state": "CA",
      "country": "US"
    }
  ]
}
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.

hashtag
Pickup Check

POST {host}/availability

Returns a list of pickups for each departure.

Request Body

Name
Type
Description

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.

hashtag
Booking Reservation

POST {host}/bookings

Adding pickup information to the booking request

Request Body

Name
Type
Description

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.

The response will be the booking object with two extra fields: pickupRequested and pickupPoint. The result looks like this:

PreviousPricing (Mandatory)NextQuestions (Coming Soon)

Last updated