Postman collections
Test Rapid API endpoints and see concrete request/response formats with Postman
Currently available
As of right now, we offer Postman collections for:
- Rapid Lodging API (with the exception of the Notifications service)
- Rapid Car API
Additional collections are coming for the Rapid Flight and Activities APIs, which are not yet in general availability.
Note: These requests are grouped in relation to the Swagger material on the site.
The collections have been written to be as self-contained as possible - they encapsulate authentication logic and the check-in/check-out self-update with each request. Each collection also has some basic tests that can be used in conjunction with the Postman collection runner feature.
Learn more about Postman collections
Installation
Download the collections from the Download Postman collections section, then import them into Postman.
Prerequisites and system requirements
See the Postman documentation for more information.
- An
api_keyandshared_secret. - An up-to-date version of Postman.
Note: Do not edit or change the “Edit Collection” section. The variables and code must remain the same to ensure requests work as expected.
Configuration
Postman handles variables in its own format. You'll need to set up some environment variables before you can use the collections.
The following parameters can be defined, only two of which are required:
| Key | Default | Required | Description |
|---|---|---|---|
api_key | N/A | Yes | An API key. |
shared_secret | N/A | Yes | Your shared secret. |
eanapi_url | https://test.ean.com/ | — | Which host to target, you may wish to override it with "https://api.ean.com" |
property_id | 3609882 | — | The LCM/Expedia property_id to request in Content and Availability calls. |
region_id | 178248 | — | The region to request in Geography-related calls. |
iata_airport_code | ORD | — | The IATA airport code to request in Geography-related calls. |
iata_airport_metro_code | CHI | — | The IATA airport metro code to request in Geography-related calls. |
language | en-US | — | The localised language to request, a subset of the BCP47 format. |
occupancy | 2 | — | The number of people per room to request, format is numberOfAdults[-firstChildAge[,nextChildAge]]- "2-9,3" would represent two adults, a 9 year old, and a 3 year old. |
booking_email | john@example.com | — | The email used in Booking requests. |
hold_itinerary_creation | true | — | Whether the itinerary will be created in a held state. |
billing_terms | N/A | —* | The terms of how a resulting booking should be billed. |
partner_point_of_sale | N/A | —* | What point of sale to be used for the Shopping and Booking APIs. |
payment_terms | N/A | —* | What payment terms should be used when being paid for a resulting booking. |
platform_name | N/A | —* | What platform to use for Shop and Book. |
* Note: These variables are only required for api.ean.com; they are not required for test.ean.com.
The following parameters are auto-generated and will automatically be set in your environment:
| Key | Global | Description |
|---|---|---|
authorizaton | Yes | This authorization code is generated from your api_key and shared_secret and used as a request header. |
checkin | Yes | The checkin date is auto-generated for Availability requests. It will always be 30 days from the day you make a request. |
checkout | Yes | The checkout date is auto-generated for Availability requests. It will always be 32 days from the day you make a request. |
arrival | Yes | The arrival time is auto-generated for cross-sell requests. It will always be 30 days from the time you make a request. |
affiliate_reference_id | — | The affiliate_reference_id is used in a Create Booking request and can be used to retrieve subsequent bookings. |
price_check_link | — | The price_check_link is set following an Availability, Cross-Sell, or Recommendation request, if the returned property has that link. It can be used to make a Price Check request. |
payment_options_link | — | The payment_options_link is set following an Availability, Cross-Sell, or Recommendation request, if the returned property has that link. It can be used to make a Payment Options request. |
deposit_policies_link | — | The deposit_policies_link is set following an Availability, Cross-Sell, or Recommendation request, if the returned property has that link. It can be used to make a Deposit Policies request. |
book_link | — | The book_link is set following a Price Check request, if the returned property has that link. It can be used to make a Booking request. |
retrieve_link | — | The retrieve_link is set following a Book request, if the returned itinerary has that link. It can be used to make a Retrieve request. |
resume_link | — | The resume_link is set following a Book request, if the returned itinerary has that link. It can be used to make a Resume request. |
cancel_link | — | The cancel_link is set following a Book request, if the returned itinerary has that link. It can be used to make a Cancel request. |
cancel_room_link | — | The cancel_room_link is set following a Book request, if the returned itinerary has that link. It can be used to make a Cancel Room request. |
change_room_link | — | The change_room_link is set following a Book request, if the returned itinerary has that link. It can be used to make a Change Room request. |
complete_payment_session_link | — | The complete_payment_session_link is set following a Book request, if the returned itinerary has that link. It can be used to make a Complete Payment Session request. |
pagination_link | — | The pagination_link is set following any request made to any paginated endpoint. It can be used to demonstrate how pagination works in the API. |
Recommended configuration
We recommended that you define the variables in an environment with only eanapi_url and api_keyshared_secret set.
Download template configuration
Download Postman collections
Be sure to read the instructions on this page before downloading these collections.