Dropoffs [NEW]

Adds structured dropoff support, allowing predefined or customer-defined end-of-tour return locations, including time-window details.

Business Context

Dropoff service is commonly offered for tours and activities. It allows customers to be returned to one of the designated locations, or even to a customer-defined point within a supported dropoff area, instead of being left at the main ending point.

This service may be included for free or offered at an additional cost.

The OCTO Dropoffs Capability allows:

  • Supplier systems to indicate whether a product option supports dropoff, whether dropoff is required, and to provide structured dropoff locations and areas.

  • Reseller systems to obtain dropoff data, display available choices to customers during the booking flow, pass the customer’s selected dropoff location when creating, confirming, or updating a booking, and leverage a capability-specific endpoint to validate dropoff availability based on a customer-defined point (e.g., latitude/longitude).

Identical functionality is also available for pickups through the Pickups, which mirrors dropoffs and provides structured or customer-defined start-of-tour collection options.

Capability Summary

To enable this capability when supported by a supplier system’s OCTO API, the reseller system must include dropoffs in the Octo-Capabilities header of its requests to the supplier system.

Adding dropoffs to your Octo-Capabilities header will alter OCTO Core endpoint behavior as follows:

Endpoint
Dropoffs Capability Enhancements to OCTO Core

No additional functionality.

Response payload includes, per product option, whether dropoff is available, required for booking, and a list of supported locations/areas with their details.

Response payload includes, per product option, whether dropoff is available, required for booking, and a list of supported locations/areas with their details.

Request can specify if the customer wants dropoff and the chosen location. Response includes, per calendar day, whether dropoff is available, required, and the list of supported locations/areas with details.

Request can specify if the customer wants dropoff and the chosen location. Response includes, per availability, whether dropoff is available, required, the list of supported locations/areas with details, including dropoff time window.

Request can specify if the customer wants dropoff, the chosen location, as well as any dropoff notes for booking. Response includes if the dropoff is requested for the booking, the selected dropoff location with details, including the dropoff time window.

Response includes if the dropoff is requested for the booking, the selected dropoff location with details, including the dropoff time window.

Response includes if the dropoff is requested for the booking, the selected dropoff location with details, including the dropoff time window.

Response includes if the dropoff is requested for the booking, the selected dropoff location with details, including the dropoff time window.

Request can specify if the customer wants dropoff, the chosen location, as well as any dropoff notes for booking. Response includes if the dropoff is requested for the booking, the selected dropoff location with details, including the dropoff time window.

Response includes if the dropoff is requested for the booking, the selected dropoff location with details, including the dropoff time window.

Response includes if the dropoff is requested for the booking, the selected dropoff location with details, including the dropoff time window.

GET Booking Dropoff Locations Endpoint

Additionally, this capability provides a dedicated endpoint GET Booking Dropoffs Locations, which enables searching for dropoff locations based on a customer-defined latitude and longitude, and validates whether dropoff service is available at that exact location or recommends alternate dropoff locations.

Additional OCTO Core Parameters & Schemas

GET Product List AND GET Product (with dropoffs)

Request Body:

Request Body:

Field
Type
Required
Description

dropoffRequested

boolean

optional

Whether the customer requested dropoff.

dropoffLocationId

string

optional

The dropoff location ID selected by the customer (must match one of dropoffLocations[].id).

Response Body:

Field
Type
Required
Description

dropoffAvailable

boolean

required

Indicates whether dropoff service is offered for this date.

dropoffRequired

boolean

required

Indicates whether selecting a dropoff location is mandatory for booking.

POST Availability Check (with dropoffs)

Request Body:

Field
Type
Required
Description

dropoffRequested

boolean

optional

Whether the customer requested dropoff.

dropoffLocationId

string

optional

The dropoff location ID selected by the customer (must match one of dropoffLocations[].id).

Response Body:

Field
Type
Required
Description

localDropoffDateTimeStart

string (ISO 8601, i.e. YYYY-MM-DD)

optional

Start of the dropoff time window in the local time zone of the dropoff location. Indicates the earliest time the customer can be collected.

localDropoffDateTimeEnd

string (ISO 8601, i.e. YYYY-MM-DD)

optional

End of the dropoff time window in the local time zone of the dropoff location. Indicates the latest time the customer can be collected.

Request Body:

Field
Type
Required
Description

dropoffRequested

boolean

optional

Whether the customer requested dropoff.

dropoffLocationId

string

optional

The dropoff location ID selected by the customer (must match one of dropoffLocations[].id).

dropoffpNotes

string

optional

Free-text notes provided by the customer for dropoff (e.g., Airbnb directions, gate code, nearby landmark, hotel room, etc).

Response Body:

GET Booking Dropoff Locations

GET {host}/bookings/{uuid}/dropoffLocations?latitude={lat}&longitude={lng}

Query Parameters:

Name
Type
Required
Description

latitude

number

required

Customer-defined latitude (WGS84).

longitude

number

required

Customer-defined longitude (WGS84).

When latitude and longitude are not provided, the supplier system should return the full list of dropoff locations.

When latitude and longitude are provided, the supplier system may choose to either:

  • return the full list of dropoff locations in any order,

  • return the full list ordered in a way that reflects the lat/lon query,

  • return only a subset of locations that best match the passenger’s position, or

  • generate a new, virtual dropoff location on the fly that corresponds to the provided coordinates and can be used for booking creation or updates.

Reseller systems must be prepared for scenarios where a dropoff location ID returned during availability or booking does not appear in the static list retrieved via the general dropoffLocations query for that product option.

Response Body:

Last updated

Was this helpful?