Skip to Content
OpenRoam Docs
Hotels

Get hotel catalog files

Returns download links for the current hotel catalog files.

GET
/v1/hotels/catalog/files

Returns download links for the current hotel catalog files.

Returns { generatedAt, hotelCount, files: [{ variant, url, sizeBytes }] }, one zip per variant. Each zip holds hotels.jsonl: one hotel per line, in the item shape that search and properties/{id} return, with offers empty. withoutImages carries each hotel's main image as logoUrl and an empty details.imageUrls; withImages also lists every gallery image there. generatedAt is null and files empty before the first catalog is built, and after a release that changes the line format until the first build in the new format: the route never links a file whose lines have another format. The route takes no query parameters.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Response Body

OK

  1. response
generatedAt?|

When the current files were built (UTC); null before the first build, and after a release that changes the line format until the first build in the new format.

Formatdate-time
hotelCount*integer

Hotels in each file; 0 when there are no files.

Formatint32
files*array<>

The current catalog zips, one per variant; empty whenever generatedAt is null.

replacements?|

The complete confirmed ID replacement map for this build; null before its first build.

Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/hotels/catalog/files'
Example Response
{  "generatedAt": "2019-08-24T14:15:22Z",  "hotelCount": 0,  "files": [    {      "variant": "withoutImages",      "url": "string",      "sizeBytes": 0    }  ],  "replacements": {    "url": "string",    "sizeBytes": 0,    "count": 0  }}