Sign in
Account

Add item to hotlist

post/account/hotlist

Query parameters

idinteger

Hotlist identifier (only if adding to existing hotlist)

keystring

Hotlist security key (only if adding to existing hotlist)

Request body

bookStage1 | 2 | 3 | 4 | 5 | 6 | 7

Enumerator defining booking stages:<br>1=Search, 2=GetInformation, 3=PricingAndExtras, 4=Reserve, 5=Pay, 6=Book, 7=Cancel

searchRefstring required

Search reference

ridstring required

Result ID

riD2string nullable

Result ID2 (Only use for DP when adding a flight and accommodation)

agentMarkupnumber double nullable

Optional agent markup for the package

Example request

{
  "routes": [
    {
      "extras": [
        {
          "participants": [
            {
              "firstname": "Joe",
              "middleNames": "B",
              "surname": "Bloggs",
              "dateOfBirth": "1970-01-25",
              "nationality": "GB",
              "foidNumber": "ABC123456",
              "foidStartDate": "2015-01-10",
              "foidExpiryDate": "2025-01-10",
              "foidIssuingCountry": "GB"
            }
          ]
        }
      ]
    }
  ],
  "transfer": {
    "extras": [
      {
        "participants": [
          {
            "firstname": "Joe",
            "middleNames": "B",
            "surname": "Bloggs",
            "dateOfBirth": "1970-01-25",
            "nationality": "GB",
            "foidNumber": "ABC123456",
            "foidStartDate": "2015-01-10",
            "foidExpiryDate": "2025-01-10",
            "foidIssuingCountry": "GB"
          }
        ]
      }
    ],
    "travellers": [
      {
        "firstname": "Joe",
        "middleNames": "B",
        "surname": "Bloggs",
        "dateOfBirth": "1970-01-25",
        "nationality": "GB",
        "foidNumber": "ABC123456",
        "foidStartDate": "2015-01-10",
        "foidExpiryDate": "2025-01-10",
        "foidIssuingCountry": "GB"
      }
    ]
  },
  "carRental": {
    "extras": [
      {
        "participants": [
          {
            "firstname": "Joe",
            "middleNames": "B",
            "surname": "Bloggs",
            "dateOfBirth": "1970-01-25",
            "nationality": "GB",
            "foidNumber": "ABC123456",
            "foidStartDate": "2015-01-10",
            "foidExpiryDate": "2025-01-10",
            "foidIssuingCountry": "GB"
          }
        ]
      }
    ],
    "driver": {
      "firstname": "Joe",
      "middleNames": "B",
      "surname": "Bloggs",
      "dateOfBirth": "1970-01-25",
      "nationality": "GB",
      "foidNumber": "ABC123456",
      "foidStartDate": "2015-01-10",
      "foidExpiryDate": "2025-01-10",
      "foidIssuingCountry": "GB"
    },
    "additionalDriver": {
      "firstname": "Joe",
      "middleNames": "B",
      "surname": "Bloggs",
      "dateOfBirth": "1970-01-25",
      "nationality": "GB",
      "foidNumber": "ABC123456",
      "foidStartDate": "2015-01-10",
      "foidExpiryDate": "2025-01-10",
      "foidIssuingCountry": "GB"
    }
  },
  "airportExtras": [
    {
      "travellers": [
        {
          "firstname": "Joe",
          "middleNames": "B",
          "surname": "Bloggs",
          "dateOfBirth": "1970-01-25",
          "nationality": "GB",
          "foidNumber": "ABC123456",
          "foidStartDate": "2015-01-10",
          "foidExpiryDate": "2025-01-10",
          "foidIssuingCountry": "GB"
        }
      ]
    }
  ],
  "extras": [
    {
      "participants": [
        {
          "firstname": "Joe",
          "middleNames": "B",
          "surname": "Bloggs",
          "dateOfBirth": "1970-01-25",
          "nationality": "GB",
          "foidNumber": "ABC123456",
          "foidStartDate": "2015-01-10",
          "foidExpiryDate": "2025-01-10",
          "foidIssuingCountry": "GB"
        }
      ]
    }
  ]
}

Response

OK

Changes

No recorded changes to this endpoint across all 1 revision of this API.