Get car search results for a booking modification

API reference

Car

Get car search results for a booking modification

Request

Get the available car search results when you're modifying an existing booking.

Security

Bearer

Path

pnrIdstringrequired

Pnr Id of the Pnr to be modified.

Example:4974a66b

Bodyapplication/jsonrequired

pickupobject(SearchParams)required

Search Parameter including location and datetime for a given search.

dropOffobject(SearchParams)required

Search Parameter including location and datetime for a given search.

filtersobject(CarFilters)

Filters for car search.

sortOptionsobject(CarSortOption)

Car sorting option parameters.

renterAgeinteger

Age of the renter

Example:30

citizenCountryCodestring

Citizen code of the renter

Example:"US"

pickupCountryCodestring

Country code of the pick up location

Example:"US"

loyaltyCodeArray of objects(CarLoyaltyCode)

Loyalty codes to be applied

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/car/pnrs/4974a66b/modify-search \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pickup": {
      "location": {
        "airportCode": "SFO",
        "cityCode": "JFK",
        "coordinates": {
          "latitude": 77.1025,
          "longitude": 28.7041
        }
      },
      "datetime": {
        "iso8601": "2017-07-21T17:32"
      },
      "searchQuery": "London",
      "address": {
        "addressLines": [
          "Golden Gate Bridge"
        ],
        "administrativeArea": "CA",
        "administrativeAreaName": "California",
        "description": "San Francisco Home",
        "isDefault": true,
        "languageCode": "en",
        "locality": "San Francisco",
        "locationCode": "LAX",
        "organization": "Spotnana",
        "postalCode": "94130",
        "continentCode": "AF",
        "recipients": [
          "string"
        ],
        "regionCode": "US",
        "regionName": "America",
        "revision": 1,
        "sortingCode": "Jamaica",
        "sublocality": "string",
        "timezone": "America/Los_Angeles",
        "coordinates": {
          "latitude": 77.1025,
          "longitude": 28.7041
        }
      }
    },
    "dropOff": {
      "location": {
        "airportCode": "SFO",
        "cityCode": "JFK",
        "coordinates": {
          "latitude": 77.1025,
          "longitude": 28.7041
        }
      },
      "datetime": {
        "iso8601": "2017-07-21T17:32"
      },
      "searchQuery": "London",
      "address": {
        "addressLines": [
          "Golden Gate Bridge"
        ],
        "administrativeArea": "CA",
        "administrativeAreaName": "California",
        "description": "San Francisco Home",
        "isDefault": true,
        "languageCode": "en",
        "locality": "San Francisco",
        "locationCode": "LAX",
        "organization": "Spotnana",
        "postalCode": "94130",
        "continentCode": "AF",
        "recipients": [
          "string"
        ],
        "regionCode": "US",
        "regionName": "America",
        "revision": 1,
        "sortingCode": "Jamaica",
        "sublocality": "string",
        "timezone": "America/Los_Angeles",
        "coordinates": {
          "latitude": 77.1025,
          "longitude": 28.7041
        }
      }
    },
    "filters": {
      "carTypes": [
        "ECONOMY"
      ],
      "numPassengers": {
        "min": 0,
        "max": 0
      },
      "vendors": [
        "ZI",
        "ZD"
      ],
      "excludeTransmissions": [
        "AUTOMATIC"
      ],
      "engineTypes": [
        "PETROL"
      ],
      "hasAirConditioning": true,
      "carExtraTypes": [
        "CHILD_SEAT_INFANT"
      ],
      "preferredOnly": false,
      "price": {
        "min": {
          "amount": 510,
          "currencyCode": "GBP"
        },
        "max": {
          "amount": 510,
          "currencyCode": "GBP"
        }
      },
      "paymentTypes": [
        "CARD"
      ],
      "fareTypes": [
        "CORPORATE"
      ],
      "hasUnlimitedMileage": false
    },
    "sortOptions": {
      "sortBy": "PRICE",
      "sortOrder": "ASCENDING"
    },
    "renterAge": 30,
    "citizenCountryCode": "US",
    "pickupCountryCode": "US",
    "loyaltyCode": [
      {
        "vendor": "ZI",
        "code": "1924047077",
        "type": "PROMOTIONAL_COUPON"
      }
    ]
  }'

Responses

Bodyapplication/json

searchIdstring

Unique searchID associated to the car search

Example:"9585821762922174"

carsArray of objects(CarSearchItinerary)

metadataobject(CarSearchMetadata)

Metadata for car search

Response

{
  "searchId": "9585821762922174",
  "cars": [
    { … }
  ],
  "metadata": {
    "availableVendors": [ … ],
    "showOnlyBaseFare": false,
    "promoCodeWarnings": [ … ]
  }
}