XML to Demand API mapping reference

Use this reference to identify where information returned by the legacy XML Cars API is available in Demand API v3.2 and Beta. This page complements the Migrate from XML to Demand API v3.2 guide.

The legacy XML Cars API returned most vehicle, supplier, policy, pricing, and redirect information in the SearchRS response.

Demand API v3.2 distributes this information across multiple specialised endpoints. As a result, some XML fields map directly to Demand API fields, while others are retrieved from dedicated resources using identifiers returned by /cars/search.

Use this guide to:

• Identify the Demand API endpoint that replaces each XML data source.
• Map commonly used XML fields to their Demand API equivalents.
• Understand when additional endpoint calls are required.
• Identify mappings that are available only in Beta.

There are some new functionalities that are not available in XML API but in Demand API:

The following table summarises common XML fields and their Demand API equivalents.

Primary endpoint: cars/search

The XML SearchRS response returned most information needed to build a search-results page.

In Demand API, /cars/search returns the core dynamic information for each available offer, including:

• Car ID.
• Offer ID.
• Policies.
• Pricing.
• Supplier ID.
• Included insurance information.
• Route information.
• Redirect URLs.

The response also returns a top-level search_token that identifies the context of the search.

Example:

{
  "request_id": "01h00fr9y7qkbxtc6kyv97j49z",
  "data": [
    {
      "car": 344450,
      "offer": 854389021,
      "supplier": 137,
      "price": {
        "currency": "EUR",
        "total": 311.60
      },
      "route": {
        "pickup": {
          "depot": 6029
        },
        "dropoff": {
          "depot": 6029
        }
      }
    }
  ],
  "metadata": {
    "next_page": null,
    "total_results": 1
  },
  "search_token": "..."
}

Use the returned identifiers to retrieve additional vehicle, supplier, and depot information from their corresponding endpoints.

Primary endpoint: /cars/details

Vehicle specifications are retrieved separately from /cars/details instead of being fully embedded in each search result.

The endpoint can return information such as:

• Make
• Model
• Vehicle classification
• Fuel type
• Transmission
• Vehicle features
• Seat capacity
• Door count
• Luggage capacity
• Images

Example:

{
  "request_id": "01ksfat75dpscqj4cqhgdpjqtp",
  "data": [
    {
      "id": 218492,
      "capacity": {
        "bags": {
          "large": 1,
          "small": 1
        },
        "doors": "4",
        "seats": "5"
      },
      "country": "ie",
      "features": [
        "air_conditioning"
      ],
      "image": "https://cdn2.rcstatic.com/images/car_images/web/bmw/1_series_lrg.jpg",
      "make": "BMW",
      "model": "1 Series",
      "specification": {
        "code": "CDAR",
        "description": "compact",
        "fuel": "unspecified",
        "transmission": "automatic"
      },
      "supplier": 17
    }
  ]
}

Primary endpoint: /cars/search

<DepositExcessFees>
  <TheftExcess
    amount="1500.0"
    currency="GBP"
    taxIncluded="true" />
  <DamageExcess
    amount="1500.0"
    currency="GBP"
    taxIncluded="true" />
  <Deposit
    amount="1500.0"
    currency="GBP"
    taxIncluded="true" />
</DepositExcessFees>

Primary endpoint: /cars/search

<FuelPolicy type="RETURN_SAME" />

Primary endpoint: /cars/search

<Fees>
  <KnownFees>
    <Fee
      feeTypeName="MILEAGE"
      alwaysPayable="false"
      amount="0.5"
      currency="GBP"
      taxIncluded="true"
      perDuration="rental"
      feeDistance="1.0"
      distance="700.0"
      iskM="false"
      unlimited="false" />
  </KnownFees>
</Fees>

Primary endpoint: /cars/search

The XML Price element contains several concepts that are represented separately in Demand API:

The price object can also include extra_charges[], which provides a breakdown of applicable taxes and fees included in the total price.

<Price
  currency="EUR"
  baseCurrency="GBP"
  basePrice="465.8"
  commission="0.00"
  discount="0.00"
  driveAwayPrice="563.92"
  quoteAllowed="yes"
  creditCardRequired="false">
  563.92
</Price>

Not every attribute in the XML Price element maps directly to the Demand API price object.

Demand API represents some pricing concepts separately:

Primary endpoints: /cars/search and /cars/depots

The XML response included detailed pickup and drop-off location information directly in the search response.

Demand API separates the depot identifier from the depot metadata:

• /cars/search returns the pickup and drop-off depot IDs.
• /cars/depots returns the corresponding depot details.

<Route>
  <PickUp>
    <Location 
      id="4608557" 
      locationId="37766" 
      locCode="LHR" 
      locName="London Heathrow Airport" 
      onAirport="no" />
  </PickUp>
  <DropOff>
    <Location 
      id="4608557" 
      locationId="37766" 
      locCode="LHR" 
      locName="London Heathrow Airport" 
      onAirport="no" />
  </DropOff>
</Route>

Use /cars/depots to retrieve information such as:

• Depot name.
• Address.
• Coordinates.
• Pickup instructions.
• Drop-off instructions.

Primary endpoints: /cars/search and /cars/suppliers

The XML response returned supplier metadata directly as part of each result.

Demand API instead returns a supplier ID from /cars/search. Use that ID with /cars/suppliers to retrieve the supplier metadata.

<Supplier 
  long="-0.39796924" 
  lat="51.47040086" 
  dropOffLong="-0.39796924" 
  dropOffLat="51.47040086" 
  address="Vista Centre Salisbury Road, Cranford, Hounslow, London, UK, TW4 6JQ" 
  dropOffAddress="Vista Centre Salisbury Road, Cranford, Hounslow, London, UK, TW4 6JQ&quot;" 
  small_logo="https://cdn2.rcstatic.com/images/suppliers/wrp/flat/1463_logo_lrg.gif" 
  locType="Off Airport - Shuttle Service" 
  supplierName="Surprice" 
  pickUpInstructions="Please call 00443300949033 on arrival to arrange the shuttle service. Then, follow the signs to the Short Stay Car Park and wait at the corresponding level. T2: Level 4, lift area near row H. T3: Level 3, lift area near row A. T4: Level 2, lift area near row E. T5: Level 1, lift area near row R." 
  dropOffInstructions="Please call 00443300949033 on arrival to arrange the shuttle service. Then, follow the signs to the Short Stay Car Park and wait at the corresponding level. T2: Level 4, lift area near row H. T3: Level 3, lift area near row A. T4: Level 2, lift area near row E. T5: Level 1, lift area near row R." />

Primary endpoint: /cars/depots/reviews/scores

<![CDATA[Surprice (Flex)]]>
</Supplier>

<Ratings>
  <Average>7.1</Average>
  <AverageText>Very good</AverageText>
  <NumRatings>126</NumRatings>
  <ValForMoney>6.7</ValForMoney>
  <Efficiency>7.8</Efficiency>
  <CollectTime>7.3</CollectTime>
  <DropOffTime>8.2</DropOffTime>
  <Cleanliness>7.5</Cleanliness>
  <Condition>5.8</Condition>
  <Locating>7.5</Locating>
</Ratings>

Primary endpoint: /cars/search

The XML ForwardURL is replaced by platform-specific redirect URLs.

<ForwardURL>https:/rentalcars.com/SearchResults.do......</ForwardURL>

The following functionality is available through Demand API Beta and does not form part of the stable v3.2 Search, look and redirect migration.

Primary endpoint: /cars/availability

The XML API returned most availability and booking information as part of search.

Demand API Beta introduces a dedicated /cars/availability step for validating the selected offer before booking.

The /cars/availability endpoint returns:

• Latest availability.
• Updated pricing.
• Policies.
• Payment requirements.
• Optional products.
• Route information.
• Supplier information.
• Search context.

For example:

{
  "request_id": "01kxn1dxkb8hj1w0b7wd4xwa5t",
  "data": {
    "offer": 853519316,
    "currency": "GBP",
    "policies": {
      "cancellation": {
        "type": "free_cancellation",
        "details": {
          "context": "before_pickup",
          "duration": "PT48H"
        }
      },
      "damage_excess": {
        "amount": 1641.72
      },
      "deposit": {
        "amount": 254.53
      },
      "insurance_package": "inclusive",
      "payment": {
        "timing": "pay_online_now"
      },
      "fuel": "return_same",
      "mileage": {
        "distance_limit": 1000,
        "distance_unit": "kilometers",
        "amount": 0.61,
        "currency": "EUR",
        "type": "limited"
      },
      "theft_excess": {
        "amount": 1641.72
      }
    },
    "price": {
      "base": 394.51,
      "credit_card_required": null,
      "total": 394.51,
      "extra_charges": []
    },
    "products": [
      {
        "id": "14646288116010",
        "type": "gps",
        "maximum_available": 1,
        "mode": "per_rental",
        "price": {
          "unit_amount": {
            "display": {
              "value": 65.7,
              "currency": "GBP"
            },
            "pay": {
              "value": 77.45,
              "currency": "EUR",
              "timing": "pay_at_pickup"
            }
          }
        }
      }
    ],
    "deal": null,
    "special_offer": null,
    "supplier": 207,
    "route": {
      "pickup": {
        "depot": 6054,
        "depot_location_type": "in_terminal"
      },
      "dropoff": {
        "depot": 6054,
        "depot_location_type": "in_terminal"
      }
    },
    "insurance": null,
    "search_token": "eyJhbGciOiJIUzI1NiJ9..."
  }
}

Direct car rental booking is available in Beta and uses the Cars and Orders API collections.

Selected post-booking functionality is also available in Beta.

After completing the XML field mappings: