home > support > API > Marketplace API > API: search bookings
| Purpose | Get a list of bookings. | |
|---|---|---|
| Notes | Allows searching by several criteria, returns just a basic overview of each booking. | |
| REST info | Call | /p/bookings/search /c/bookings/search |
| Formats | XML | |
| Example | /p/bookings/search.xml?page=2&per_page=20 | |
| Verb | GET | |
| Code |
PHP examples use the PHP Client Library with SimpleXML Description
Parameters
Example
C# examples use the .Net Client Library Overload list
Parameters
Example
VB examples use the .Net Client Library Overload list
Parameters
Example
|
|
| Parameter | Notes |
|---|---|
| made_date_start | Use this parameter to specify the earliest booking date to search, if specified bookings made prior to this date will not be returned. YYYY-MM-DD |
| made_date_end | Use this parameter to specify the latest booking date to search, if specified bookings made after to this date will not be returned. YYYY-MM-DD |
| active | Pass in a value of 1 to exclude cancelled or expired bookings (bookings may be quotes that weren't taken up by the customer and subsequently expire) |
| lead_customer_surname | Lead customer surname (part matches also checked) |
| booking_name | Booking name (part matches also checked) (Often the main tour/hotel name becomes the booking name) |
| customer_id | Use to search for bookings by a specific customer, only works if the channel ID is also supplied (channel id is passed in the header if calling the API directly or as the second parameter if using the PHP/.Net API wrappers) |
| per_page | Number of results to return per page. Max is 500. |
| page | Integer for which page number to return. Default is page 1 |
| XML Node | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| request | Confirmation of the request that you sent | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| error | Any error message returned, if there is no error this will just contain the text OK | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| total_bookings_count | Total number of bookings returned by the search (i.e. not just the number on this page) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| total_bookings_quotprov | Total number of bookings that are at the "Quotation" or "Provisional" status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| total_bookings_canc | Total number of bookings that are cancelled | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| total_bookings_conf | Total number of confirmed bookings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| booking |
There will be one booking node for each result on this page. Each booking node contains the following child nodes.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
© 2003-2012 Travel UCD Limited. All rights reserved. TourCMS® is a registered trademark of Travel UCD Limited, United Kingdom. View Privacy policy.