{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/stays/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Using the Stays Help","description":"Create AI-native travel products with Travelport's powerful, flexible APIs.","siteUrl":"https://developer.travelport.com/","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"using-the-stays-help","__idx":0},"children":["Using the Stays Help"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This online help provides three basic kinds of information about the TripServices APIs: Guides, API references, and workflow diagrams."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"guides","__idx":1},"children":["Guides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each functional area of managing travel with the TripServices APIs has a Guide. Guides cover basic concepts and usage information. In addition to the functional guide, any API with a lengthy request and response has its own guide as well. Most API guides include layout diagrams illustrating the basic structure of that API's request and response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-references","__idx":2},"children":["API References"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For every API, an API Reference provides object-level details including supported formats and values. API references always include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["method and endpoint"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["any query parameters"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["reference tables for the request and response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["request and response examples"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"workflows","__idx":3},"children":["Workflows"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Many of the TripServices APIs are linked together in workflows. For example, you must send a search request before you can create a reservation. The workflow diagrams provide a high-level overview of the Stays API call workflow."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"notes-and-warnings","__idx":4},"children":["Notes and Warnings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each page for a Guide, API Reference, and Workflow uses a standard format to present the same types of information consistently across the help."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Notes like this are called out with a light blue background color."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["and"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Information that can help prevent an unexpected result or error message is called out with a yellow background color."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"search-tips","__idx":5},"children":["Search Tips"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you've checked the guide and the API reference for an API and/or its functional area without finding what you need, try a search at the top of any page."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All supported objects are documented in the help. To search for technical details in the API reference, enter the exact object name; e.g., ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["PropertyKey"]}," instead of ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["property key"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For terms, use quotation marks as needed. For example, \"passive segment\" returns results with the phrase ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["passive segment"]},". However, ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["passive segment"]}," without quotation marks returns all pages that have both words (",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["passive"]}," and ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["segment"]},") anywhere in the page."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The search is not case-sensitive, and you can enter partial words using at least four characters. Words with variant endings are returned in results. For example, a search for ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["book"]}," returns topics with book, booking, and booked."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The search supports the following symbols and Boolean operators, which are not case-sensitive:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AND"]}," or plus (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["+"]},") or ampersand (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["&"]},") narrows the search to only topics that contain all of the words in the same topic but not necessarily together as a phrase."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OR"]}," a pipe (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["|"]},") broadens the results by retrieving topics that contain any of the words it separates."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NOT"]}," a caret (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["^"]},") finds topics that contain one term but not the other."]}]}]},"headings":[{"value":"Using the Stays Help","id":"using-the-stays-help","depth":1},{"value":"Guides","id":"guides","depth":3},{"value":"API References","id":"api-references","depth":3},{"value":"Workflows","id":"workflows","depth":3},{"value":"Notes and Warnings","id":"notes-and-warnings","depth":3},{"value":"Search Tips","id":"search-tips","depth":3}],"frontmatter":{"seo":{"title":"Using the Stays Help"}},"lastModified":"2026-05-27T15:34:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/stays/downloads-and-support/using-the-stays-help","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}