Changelog Version 3

destination_iata_airport_code, origin_iata_airport_code, and iata_airline_code parameters have been removed. Recommendations link will no longer appear on the response.

EPS Rapid 2.4 Schema Example

  },
      "recommendations": {
        "method": "GET",
        "href": "/2.4/properties/availability?token=abcdef"
      }

Expedia Group no longer maintains a relationship with TripAdvisor, so in Rapid 3 the TripAdvisor Content API endpoint will be deprecated

Added new Vacation Rentals section to EPS Content/File where partners can find property information which is specific to Vacation Rentals, including attributes which would normally be found within the room description for multi-unit properties.

EPS Rapid 3 Schema Example

"vacation_rental_details": {
  "property_registration":{
  },
  "private_host"{
  },
  "property_manager": {
    "name": "Frans Belderbos",
    "links": {
      "image": {
        "method": "GET",
        "href": "https://odis.homeaway.com/odis/story/89cd116a-14fd-4fbc-a0d1-861894171cd0.c1.jpg"
      }
    },
    "rental_agreement": {
      "links": {
        "rental_agreement": {
          "method": "GET",
          "href": "https://www.homeaway.com/td/proxies/ecomQuote/downloadRentalAgreement?unitUrl=/units/0000/1341f175-3550-4c80-b9a1-b6b330b7e032"
        }
      }
    },
    "house_rules": [
        "Children welcome",
        "Pets welcome (restrictions apply)",
        "No smoking",
        "No parties or events"
      ],
    "amenities": { 
        "1073743284": {
            "id": "1073743284",
            "name": "Heating"
        },
        "4296": {
            "id": "4296",
            "name": "Furnished balcony or patio"
        }
    }

A new product to enable partner to use their preferred payment services provider for PSD2 compliance

Requires the cavv, eci, three_ds_version and ds_transaction_id  parameters

EPS Rapid 3 Schema Example

"third_party_authentication": {
        "cavv": "jELUbgG+Tgj0AREBDMLeCad+oIs=",
        "eci": "05",
        "three_ds_version": "2.2.0",
        "ds_transaction_id": "ac01cc2b-c1a1-4981-8c6f-400d4eec88de",
        "pa_res_status": "Y",
        "ve_res_status": "C",
        "xid": "47133847-13be-4ae3-9be9-e4053b9c83c0",
        "cavv_algorithm": "3",
        "ucaf_indicator": "0"
      }

The State Province Code field's description was simplified to be less confusing.

2.4 Schema Example

Customer’s state or province code. Mandatory if the country_code = US, AU or CA

3 Schema Example

2-letter or 3-letter state/province code for Australia, Canada and the USA.

The Postal Code field's description was simplified to be less confusing.

2.4 Schema Example

Customer's postal code. Postal_Code is mandatory if the payment type is a credit card (CC, CCC, VCC) and the country code is US, GB or CA.

3 Schema Example

Postal/zip code.

Special characters in several fields will be re-encoded to prevent a security vulnerability.

A new feature to enable partners to provide hotel loyalty Id 

·         Identifier for a hotel loyalty program associated with this room guest. 

·         Exists under the rooms object

EPS Rapid 3 Schema Example

  "rooms": [
    {
      "given_name": "John",
      "family_name": "Smith",
      "smoking": false,
      "special_request": "Top floor or away from street please",
      "loyalty_id": "ABC123"
    }
  ],

The new field will be located in multiple places 

- Create booking request 

- Itinerary Retrieve 

- Itinerary Change

The Rate Plan Count field's description was updated to include minimum and maximum limits as well as clarifying what the field is trying to return (the best price available).

2.4 Schema Example

The number of rates to return per property. The rate’s price determines which rates are returned e.g. a rateplancount=4 will return the lowest 4 rates, but the rates are not ordered from lowest to highest or vice versa in the response. The lowest rate has been proven to provide the best conversion rate and so a value of 1 is recommended. The value must be greater than 0.

3 Schema Example

The number of rates to return per property. The rates with the best value will be returned, e.g. a rate_plan_count=4 will return the best 4 rates, but the rates are not ordered from lowest to highest or vice versa in the response. Generally lowest rates will be prioritized. The value must be between 1 and 250.

The Fees object was simplified by removing unused fields.

EPS Rapid 2.4 Schema Example

                "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    },
                    "scope": "per_person",
                    "frequency": "per_day"
                  }

EPS Rapid 3 Schema Example

                "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    }
                  }

The DepositPolicyItinerary field was renamed for consistency with Shop.

Several fees-related fields were cleaned up for consistency with Shop.

EPS Rapid 2.4 Schema Example

                "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    },
                    "scope": "per_person",
                    "frequency": "per_day"
                  }

EPS Rapid 3 Schema Example

                "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    }
                  }

The endpoints of Notifications Test API and Notifications Undeliverable API have been changed (the trailing /{event_type} and /undeliverable were removed). The endpoint of Notifications Test API is changed from GET to POST.

The Fees object was simplified by removing fields which were sourced from deprecated information.

EPS Rapid 2.4 Schema Example

                "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    },
                    "scope": "per_person",
                    "frequency": "per_day"
                  }

EPS Rapid 3 Schema Example

                "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    }
                  }

The Deposit Policy object was renamed to Deposits for consistency with Shop.

EPS Rapid 2.4 Schema Example

        "deposit_policies": [
          {
            "amount": "220.75",
            "due": "2018-12-12T01:01:01.000-08:00"
          }
        ],

EPS Rapid 3 Schema Example

        "deposits": [
          {
            "amount": "220.75",
            "due": "2018-12-12T01:01:01.000-08:00"
          }
        ],

An invalid test header for the Price Check call was renamed to match a valid value.

EPS Rapid 2.4 Schema Example

--header "Test: matched"

EPS Rapid 3 Schema Example

--header "Test: available"

Along with removing the need to make an additional call for deposit (payment schedule) data, we will be making the data available in the priceCheck response for higher visibility.

EPS Rapid 3 Schema Example

            "deposits": [
              {
                "value": "70.00",
                "due": "2021-08-21",
                "currency": "CAD"
              }
            ]

Rapid3 will no longer return a deposit_required field, as it would be redundant with the new array of deposits.

EPS Rapid 2.4 Schema Example

 "sale_scenario": {
              "package": false,
              "member": true,
              "corporate": false,
              "distribution": false
            },
            "deposit_required": true,
            "merchant_of_record": "expedia",

EPS Rapid 3 Schema Example

 "sale_scenario": {
              "package": false,
              "member": true,
              "corporate": false,
              "distribution": false
            },
            "merchant_of_record": "expedia",

EPS Rapid 2.4 Schema Example

                "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    },
                    "scope": "per_person",
                    "frequency": "per_day"
                  }

EPS Rapid 3 Schema Example

                "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    }
                  }

EPS Rapid 2.4 Schema Example

     "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    },
                    "scope": "per_person",
                    "frequency": "per_day"
                  }

EPS Rapid 3 Schema Example

                "fees": {
                  "mandatory_fee": {
                    "billable_currency": {
                      "value": "5.00",
                      "currency": "CAD"
                    },
                    "request_currency": {
                      "value": "3.00",
                      "currency": "USD"
                    }
                  }

Rapid 3 will be adding additional data relevant to vacation rentals. The card_on_file_limit is the maximum that can be charged to a card for damages at the property and the refundable_damage_deposit is the deposit amount required for the property. Only one value will be available in the response, we will never be returning both simultanesouly to a partner for a given rate.

EPS Rapid 3 Schema Example

            "card_on_file_limit": {
              "value": "25.00",
              "currency": "CAD"
            },
            "refundable_damage_deposit": {
              "value": "75.00",
              "currency": "CAD"
            }

Rapid3 will be adding additional data relevant to vacation rentals. The card_on_file_limit is the maximum that can be charged to a card for damages at the property and the refundable_damage_deposit is the deposit amount required for the property. Only one value will be available in the response, we will never be returning both simultaneously to a partner for a given rate.

EPS Rapid 3 Schema Example

            "card_on_file_limit": {
              "value": "25.00",
              "currency": "CAD"
            },
            "refundable_damage_deposit": {
              "value": "75.00",
              "currency": "CAD"
            }

Rapid3 will no longer need to return a deposits link for the retrieval of the deposit data. This will be fetched and displayed in the response instead.

EPS Rapid 2.4 Schema Example

 "links": {
              "payment_options": {
                "method": "GET",
                "href": "/2.4/properties/19248/payment-options?token=MY5S3j36cOcL"
              },
              "deposit_policies": {
                "method": "GET",
                "href": "/2.4/properties/19248/deposit-policies?token=MY5S3j36cOcL"
              }
            }

EPS Rapid 3 Schema Example

"links": {
              "payment_options": {
                "method": "GET",
                "href": "/2.4/properties/19248/payment-options?token=MY5S3j36cOcL"
              }
            }

The deposit-policies endpoint will be removed since it's now part of the availability call directly.

EPS Rapid 2.4 Schema Example

[
  {
    "nights": "3",
    "due": "2025-02-20"
  },
  {
    "amount": "70.00",
    "due": "2025-12-21"
  },
  {
    "percent": "90%",
    "due": "2025-02-19"
  },
  {
    "remainder": true,
    "due": "2025-03-01"
  }
]

Fixed typo in customer_account_details enum, changing "fido_authenticaton" to "fido_authentication".

EPS Rapid 2.4 Schema Example

  "customer_account_details": {
    "authentication_method": "fido_authenticaton",
    "authentication_timestamp": "2018-02-12T11:59:00.000Z",
    "create_date": "2018-09-15",
    "change_date": "2018-09-17",
    "password_change_date": "2018-09-17",
    "add_card_attempts": 1,
    "account_purchases": 1
  },

EPS Rapid 3 Schema Example

  "customer_account_details": {
    "authentication_method": "fido_authentication",
    "authentication_timestamp": "2018-02-12T11:59:00.000Z",
    "create_date": "2018-09-15",
    "change_date": "2018-09-17",
    "password_change_date": "2018-09-17",
    "add_card_attempts": 1,
    "account_purchases": 1
  },

A request body is now required.

EPS Rapid 3 Schema Example

{
    "event_type": "itinerary.agent.create"
}

A new query parameter undeliverable is now required.

Added rentalagreement field to the Vacation Rentals section of Rapid content which is required for display of vacation rentals.

EPS Rapid 3 Schema Example

    "rental_agreement": {
      "links": {
        "rental_agreement": {
          "method": "GET",
          "href": "https://www.homeaway.com/td/proxies/ecomQuote/downloadRentalAgreement?unitUrl=/units/0000/1341f175-3550-4c80-b9a1-b6b330b7e032"
        }
      }
    },

reference_property_id parameter have been removed from the request. Recommendations link will no longer appear on the response.

EPS Rapid 2.4 Schema Example

       },
      "recommendations": {
        "method": "GET",
        "href": "/2.4/properties/availability?token=abcdef"
      } 

The Refundable Damage Deposit and Card On File limit fields were moved for consistency with Shop.

EPS Rapid 3 Schema Example

          "card_on_file_limit": {
            "value": "string",
            "currency": "string"
          },
          "refundable_damage_deposit": {
            "value": "string",
            "currency": "string"
          },

A new mandatory supply_source field has been added to the Property Content API/File and the Property Catalog File, to enable partners to specify which type of inventory they want returned. 

Passing a value of 'expedia' will return only inventory from Expedia. 

Passing a value of 'vrbo' will return only inventory from Vrbo.

EPS Rapid 3 Schema Example

"supply_source": "vrbo"

supply_source is now a mandatory field. To achieve the same behaviour as previous versions of the API, partners will need to pass "supply_source": "expedia".

Rapid 3 will remove the need for our partners to make a separate call for deposit (payment schedule) information. Instead we will be surfacing this data as a child of the Rate object.

EPS Rapid 3 Schema Example

            "deposits": [
              {
                "value": "70.00",
                "due": "2021-08-21",
                "currency": "CAD"
              }
            ]