Car

API reference

Car

These endpoints provide comprehensive functionality for managing car bookings. They enable users to search for cars, check rates and availability, create and modify bookings, and handle cancellations and rebooking.

Operations

Get car search results

Request

Search for available cars using the pickup and dropoff locations, and the traveler's user ID.

Security

Bearer

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.

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

userIdobject(Car User Identifier)required

filtersobject(CarFilters)

Filters for car search.

sortOptionsobject(CarSortOption)

Car sorting option parameters.

tripIdstring

Id of the trip.

corporateInfoobject(CorporateInfoV2)

Corporate information related to the car search.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/car/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
        }
      }
    },
    "renterAge": 30,
    "citizenCountryCode": "US",
    "pickupCountryCode": "US",
    "loyaltyCode": [
      {
        "vendor": "ZI",
        "code": "1924047077",
        "type": "PROMOTIONAL_COUPON"
      }
    ],
    "userId": {
      "userIdType": "USER_ID",
      "userId": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    },
    "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"
    },
    "tripId": "string",
    "corporateInfo": {
      "preSearchAnswers": {
        "answers": [
          {
            "entityId": "string",
            "userInput": "string",
            "itemIds": [
              0
            ],
            "answers": [
              {
                "item": "string",
                "value": "string",
                "description": "string"
              }
            ],
            "customFieldType": "QUESTION",
            "questionDisplayText": "string",
            "question": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "questionFormat": "CHECKBOX",
              "optionInfo": {
                "source": "MANUAL",
                "sourceMetadata": {},
                "totalNumOptions": 0,
                "options": [
                  null
                ]
              },
              "isRequired": true,
              "isDisabled": true,
              "includeInItinerary": true,
              "customFieldLocations": [
                "POLICY_APPROVAL_EMAIL"
              ],
              "matchConditions": {
                "travelerConditions": {
                  "workerTypes": [],
                  "countries": [],
                  "legalEntities": [],
                  "departments": [],
                  "costCenters": [],
                  "offices": []
                },
                "travelTypes": [
                  null
                ],
                "travelRegionTypes": [
                  null
                ],
                "tripUsageTypes": [
                  null
                ]
              },
              "questionType": {
                "preSearchQuestionType": "PURPOSE_OF_TRIP",
                "preCheckoutQuestionType": "OOP_REASON_CODE"
              }
            }
          }
        ],
        "userEntitiesResponseId": "string"
      },
      "customFieldV3Responses": [
        {
          "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
          "fieldName": "string",
          "armId": "0fd508db-63ff-4444-bfb1-b89c43061433",
          "includeLocations": [
            "APPROVAL_EMAILS"
          ],
          "selectedOptions": [
            {
              "name": "string",
              "translatedName": "string",
              "description": "string",
              "translatedDescription": "string",
              "additionalUserInput": "string",
              "additionalInfos": [
                "string"
              ],
              "additionalInfoConfigs": [
                {}
              ],
              "optionId": "dee15a0e-f1fe-4cd8-88ac-c090810707f8"
            }
          ]
        }
      ]
    }
  }'

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": [ … ]
  }
}