Skip to content

Book

Used to place a new booking. The returned id enables us to contact you and make further changes or cancel the booking if required.

Details

Urlhttps://<your custom url>/book
MethodPOST
HTTP HeaderContent-Type: application/json
HTTP HeaderAccept: application/json
FormatJSON

Payloads

Request

json
{
  "operatorId": "12345789",
  "pickup": "2023-02-01T18:30:00+01:00",
  "stops": [
    {
      "pickupPoint": "Round he back of the main building",
      "address1": "17 The Street",
      "address2": "Over here",
      "town": "Testsville",
      "region": "Testchester",
      "postcode": "AA1 1AA",
      "country": "England",
      "isoCountry": "GB",
      "lat": 52.42553,
      "lng": -1.2974
    },
    {
      "pickupPoint": null,
      "address1": "45 Destination Avenue",
      "address2": "Over there",
      "town": "Somewhere else",
      "region": null,
      "postcode": "SH4 6WE",
      "country": "England",
      "isoCountry": "GB",
      "lat": 53.9173,
      "lng": -1.3254
    }
  ],
  "vehicle": {
    "type": "Saloon",
    "attributes": ["Pets"]
  },
  "paxCount": 2,
  "reference": "ABC123:XYZ456",
  "passenger": {
    "name": "Mr McTestit",
    "number": "0778899955"
  },
  "price": {
    "type": "JourneyNet",
    "amount": 3250,
    "currency": "GBP"
  },
  "distance": 5164,
  "notes": "Meet round by the side entrance",
  "flightNumber": "BA1234"
}
{
  "operatorId": "12345789",
  "pickup": "2023-02-01T18:30:00+01:00",
  "stops": [
    {
      "pickupPoint": "Round he back of the main building",
      "address1": "17 The Street",
      "address2": "Over here",
      "town": "Testsville",
      "region": "Testchester",
      "postcode": "AA1 1AA",
      "country": "England",
      "isoCountry": "GB",
      "lat": 52.42553,
      "lng": -1.2974
    },
    {
      "pickupPoint": null,
      "address1": "45 Destination Avenue",
      "address2": "Over there",
      "town": "Somewhere else",
      "region": null,
      "postcode": "SH4 6WE",
      "country": "England",
      "isoCountry": "GB",
      "lat": 53.9173,
      "lng": -1.3254
    }
  ],
  "vehicle": {
    "type": "Saloon",
    "attributes": ["Pets"]
  },
  "paxCount": 2,
  "reference": "ABC123:XYZ456",
  "passenger": {
    "name": "Mr McTestit",
    "number": "0778899955"
  },
  "price": {
    "type": "JourneyNet",
    "amount": 3250,
    "currency": "GBP"
  },
  "distance": 5164,
  "notes": "Meet round by the side entrance",
  "flightNumber": "BA1234"
}

Response

json
{
  "id": "any unique id",
  "eta": 620
}
{
  "id": "any unique id",
  "eta": 620
}