BookingFlow

Updates passengers FOID on an order - not to be used generally, only supported on a select number of suppliers for specific purposes

Changed on
post/updatepaxfoid/{orderId}/{orderKey}/{productId}

Request

Path parameters

orderIdinteger required

Numeric order Id.

orderKeystring required

36-character order security key.

productIdinteger required

Numeric product Id.

Request body

emailAddressstring email nullable

Contact email address

Example request

{
  "passengers": [
    {
      "firstname": "Joe",
      "middleNames": "B",
      "surname": "Bloggs",
      "dateOfBirth": "1970-01-25",
      "nationality": "GB",
      "foidNumber": "ABC123456",
      "foidStartDate": "2015-01-10",
      "foidExpiryDate": "2025-01-10",
      "foidIssuingCountry": "GB",
      "telephone": {
        "countryPrefix": "44",
        "number": "0123456789"
      }
    }
  ],
  "telephone": {
    "countryPrefix": "44",
    "number": "0123456789"
  }
}

Response

Success - Returns the status of the confirmation request.

successboolean

Indicator as to whether API request was successful.

errorstring nullable

Returns an error if success is returned as false.

dataunknown

Changes