Taxi Supplier API

Home

References

Sharing Meeting Point data

The Meeting Points endpoint enables you to share meeting point data and pickup instructions for a booking. 

POST /v1/bookings/:customerReference/:bookingReference/meetingPoints

The fields name and pickupInstructions are not both mandatory fields. However, at least one of them must be provided. If you have both then send both.

The field location is also not mandatory, but it is preferred if the pickup is from an airport, so that we can tell the customer which terminal to meet the driver in.

Request

Field Type Description Required
name String The name of the meeting point, e.g. “Starbucks”. Limited to 255 characters. Yes, unless pickupInstructions field is provided
location String The location of the meeting point. For example, at an airport, this might be "Terminal 2A". Limited to 255 characters. No
pickupInstructions String If meeting point “name” and “location” are not available, you may send the pickup instructions as free text instead. Limited to 1000 characters. Yes, unless name field is provided
latitude Number (10,8) The latitude of the meeting point. No
longitude Number (11,8) The longitude of the meeting point. No
pickupType Enum The type of pickup. For example, HOST, DESK, MEET_AND_GREET. Not required, but will default to MEET_AND_GREET if not provided. No
buildingLevel String The building level, e.g. for locations on the 2nd floor the value would be 2. Limited to 255 characters. English only. No
pickupImages Array Images of the meeting point. See table below for the structure of the objects within the array. Maximum number of images is 3. No, but if images are provided then refer to the below table for the required fields per image.

Note

If you have already provided pickup images for a meeting point, and then update the meeting point with this field missing or set to an empty array, then the pickup images will be deleted.

Pickup Image Object

Field Type Description Required
imageURL String The URL pointing to the photo. Limited to 2000 characters. Yes
description String A caption to be displayed alongside the image. Limited to 300 characters. No
altText String Accessibility text used by screen readers to describe the image. Limited to 300 characters. No

Example request

POST /v1/bookings/12345678/12984576/meetingPoints

{
  "name": "Starbucks",
  "location": "Terminal 2A",
  "pickupInstructions": "Meet your driver on the right, in the arrival hall, opposite the Starbucks Coffee",
  "latitude": 53.36241476,
  "longitude": -2.27437037,
  "pickupType": "MEET_AND_GREET",
  "pickupImages": [
    {
      "imageURL": "https://example.com/arrival_hall.jpg",
      "description": "Your driver will be waiting in the arrival hall.",
      "altText": "An image of the arrival hall at Terminal 2A. There are rows of seats with shops in the background."
    },
    {
      "imageURL": "https://example.com/starbucks.png",
      "description": "You will find your driver opposite this Starbucks Coffee shop.",
      "altText": "An image of Starbucks coffee shop in Terminal 2A."
    }
  ]
}

Response

HTTP 200 - OK

HTTP 400 - Bad Request

Example 400 response:

{
  "errorCode": "9e753833-36db-4922-9167-e5fed5f0cb7d",
  "errorMessage": "pickupImages: size must be between 0 and 3"
}
Is this page helpful?    Yes   |    No