Transfers

Transfer Quotation

post

This endpoint provides a quotation for a transfer service between two specified locations, based on transfer details such as pick-up, drop-off, type of transfer, and passenger information.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
octo-capabilitiesstringOptional

Comma-separated list of capabilities supported by the client. Possible values are: - octo/pricing

Example: octo/pricing
Body
dropOffone ofOptional
  • When transferType is any other value, this must be an object.
  • When transferType is HOURLY, this must be NULL.
or
anyOptional

Allows null (indicating no value provided)

transferTypestring · enumOptional

Specifies the type of transfer, with possible values being ARRIVAL, DEPARTURE, STATION, and PORT

Example: ARRIVALPossible values:
serviceReferenceone ofOptional
  • When transferType is HOURLY, this must be an integer.
  • When transferType is any other value, this must be a string.
stringOptional

Must be a string when transferType is diferent to HOURLY

Example: Flight-456
or
numberOptional

Must be a integer when transferType is HOURLY

Default: 0Example: 123
startTimestringOptional

Specifies the start time of the transfer in HH:mm format (24-hour format)

Example: 18:00
localDateStartstringOptional

Specifies the date of the transfer in YYYY-MM-DD format

Example: 2024-12-19
Responses
200

Transfer quotation successfully returned

application/json
post
/transfers
JS
200

Transfer quotation successfully returned

Last updated