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
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
notOptional

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
JS
const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "pickUp": {
    "name": "International Airport",
    "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
    "latitude": -33.8688,
    "longitude": 151.2093,
    "country": "IT"
  },
  "dropOff": {
    "name": "Hotel",
    "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
    "latitude": -33.9258,
    "longitude": 151.2456,
    "country": "IT"
  },
  "transferType": "ARRIVAL",
  "serviceReference": "QF400",
  "startTime": "14:30",
  "localDateStart": "2024-09-17",
  "units": [
    {
      "id": "ADULT",
      "quantity": 2
    }
  ]
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch('/transfers', requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
200

Transfer quotation successfully returned

{
  "id": "67331ca43070a6fb19a24443",
  "status": "AVAILABLE",
  "utcExpiresAt": "2024-11-15T09:15:16.965Z",
  "utcCreatedAt": "2024-11-12T09:15:16.981Z",
  "pickUp": {
    "name": "Aeropuerto Josep Tarradellas Barcelona-El Prat",
    "googlePlaceId": null,
    "latitude": 41.2890205,
    "longitude": 2.0649989,
    "country": "ES"
  },
  "dropOff": {
    "name": "Alexandra Barcelona Hotel, Curio Collection by Hilton",
    "googlePlaceId": null,
    "latitude": 41.3932199,
    "longitude": 2.1589192,
    "country": "ES"
  },
  "distanceUnit": "KM",
  "distanceInclude": 18.24,
  "options": [
    {
      "id": "29b38b9b-cbd6-4214-9272-c10393a2d32c",
      "reference": "5dfb86d284b03e663dd92364",
      "vehicle": {
        "seats": 3,
        "suitcases": 3,
        "type": "SEDAN",
        "category": "STANDARD",
        "name": "Skoda Octavia",
        "image": "https://app.rhombuss.com/api/public/services/sedan-skoda-octavia.png"
      },
      "cancellationPolicy": [
        {
          "type": "FULL_REFUND",
          "cutoffAmount": 24,
          "cutoffUnit": "HOURS",
          "description": "For a full refund, you must cancel at least 24 Hours before the experience's start time."
        }
      ]
    }
  ]
}

Last updated