API - Planyo Web Services - search_reservations_by_form_item

You are here: Planyo » Help » API » search_reservations_by_form_item

search_reservations_by_form_item

Description:

Finds all reservations whose form item (name specified in item_name) has the specified value. This is useful especially for hidden form items which can have a special meaning to you, e.g. booking ID in an external system. This function will return max 500 reservations.

Input:

item_name string required

Name of the form item.

item_value string required

Value of the form item. It can include star (*) to match a pattern, e.g. abc* would match both abc and abcdef.

detail_level int optional

Sum of one or more of the following integers (ORed value): 1=reservation info, 2=reservation properties (reservation form items), 4=pricing info and flexible package assignments, 8=custom resource properties, 16=site properties, 32=user properties. Default value is 1.

method string required

must be set to search_reservations_by_form_item

language string optional

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key string required

your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

results array

Array whose items are named arrays with the following keys: id (reservation_id), resource_id, user_id, start_time, end_time, status, quantity, creation_date, custom_color, resource_name, site_id, cart_id, unit_assignment, user_notes, admin_notes, custom_color, night_reservation, currency, first_name, last_name, email, mobile_number, mobile_country_code, phone, phone_country_code,, address, state, city, zip, country

API playground:

Click here to test this function in the API playground.