Scheduling ยท CONNECTIONMake, change, search and manage Planyo reservations, availability, resources, prices, products, users, coupons, vouchers and carts.
Explore 116 workflow actions for Planyo Online Booking, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Use this function to add a new additional product to your Planyo site.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a new coupon type.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to add a new custom product to a reservation. Note that custom products are different from regular additional products in that they have no fixed definition. Each time they are added the name and price must be specified. As with the additional products, these custom products will...
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a new custom property definition to your site or metasite. This will show the new property in resource settings / general info in the backend UI (for resource properties), or in site settings / company info (for site properties) or in site settings / custom user properties (for user...
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds site's notification email message.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a new rule to Pricing Manager.
A repeated request may repeat the external action. Review the previous result before retrying a write.
This function lets you add an image to an additional product.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a new recurring vacation for given resource or entire Planyo site.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to add a new resource to your Planyo site. The new resource is created by making an exact copy of an existing resource (it can be an unpublished resource which you can keep on your site free of charge just for this purpose), including custom resource properties (images are not...
A repeated request may repeat the external action. Review the previous result before retrying a write.
This function lets you add an image to a resource.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a new season for given resource or entire Planyo site.
A repeated request may repeat the external action. Review the previous result before retrying a write.
This function lets you add an image to your site.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds an easily-accessible favorite page to the backend of all the moderators and admins of a site or just for a specific user. This is the equivalent of clicking on the star icon on the title of any backend page
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to insert a new user associated with your Planyo site. You can optionally specify a login/password and assign any number of user-specific properties. Note: for existing users, custom user properties (prop_user_xyz) and personal details will be updated, the login data will not be...
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds a new one-time vacation for given resource or entire Planyo site. To add weekly vacations, see the function set_weekly_schedule .
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to apply a coupon to an existing reservation. Coupon is passed as either the coupon_id or coupon_code parameter. Please note that coupons can be only applied to unconfirmed reservations.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to apply a voucher to an existing reservation. Note that a voucher code can be also passed to make_reservation .
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns true if reservation can be made or false if it's not possible. A reservation may not be possible because of lack of availability or because of other constraints such as required start/end weekday, not enough free time after previous rental etc.
Use this function to create a new shopping cart. Reservations created with the function make_reservation can then use this cart id to group reservations into a single cart.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to create a new voucher. Vouchers can be limited to a metasite, to a single site, or to specific resources. Other settings correspond to the settings from the backend UI.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to delete a shopping cart. Note that the shopping cart must be empty (no reservations in cart).
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a property by name. Properties can be of different types -- Planyo allows assigning custom properties to users, sites, resources and reservations.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Permanently deletes a reservation. Warning: this action cannot be undone. Note that if you only wish to cancel a reservation, use the do_reservation_action method.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a custom unit property previously set for a specific date/time.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Call to perform an administrative action (such as confirmation or cancellation) on a reservation
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to add a new coupon to your site.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Generates a new invoice if one hasn't already been created for given reservation or if the reserved items have changed since the last invoice. This function will work only when using parent&corrective invoices.
A repeated request may repeat the external action. Review the previous result before retrying a write.
This function returns the list of resources and coupons included in a bundle
Lists all reservations included in a shopping cart. A maximum of 500 reservations will be listed. For further items use the 'page' parameter.
Returns value of a property. Properties can be of different types -- Planyo allows assigning custom properties to users, sites, resources and reservations. Please note that custom properties will be visible in the backend UI (for site administrators) unless the property name starts with 'hidden'....
Use this function to retrieve details of a custom resource property, a custom user property or a custom site property (metasites only). In case of a custom user property, the output will also include the following fields: default_value, form_item_name (associated reservation form item)
Lists all event times of an event-type resource.
Returns reservation form items for given resource (if resource_id is specified) or for the global form (if resource_id is not specified) or the all possible reservation forms of the site, including both the global form and resource-specific forms (if resource_id has the special value of -1).
Returns all products (invoice items) included with the reservation (same as products used on the invoice). The invoice items can include (besides reservations): additional products, custom products, payment surcharge. In case of the shopping cart, all shopping cart reservations will be included.
This function returns detailed information about a package, including package type and the contents (resources included in the package)
Lists pricing manager rules.
Lists all waiting list requests which can be promoted to a valid reservation. You must specify the ID of an existing waiting list placeholder vacation (which you can get by calling list_vacations ) that was automatically created by Planyo after the resource was made available (a reservation was...
Returns the price of a rental for given resource and start/end times. Price is returned even if resource is not available in given period (because of vacations defined or existing reservations). Note that if you want to fetch prices for multiple periods (up to 50), you can pass optional parameters...
This function lists reservation actions (events), such as modifications, cancellations etc. You can optionally narrow down the events returned to a specific reservation ID, to all reservations of a specific customer, to specific time range, or to a specific event.
This method returns details of a reservation.
This method returns payment information (total amount paid and number of payments made) for given reservation.
This method returns detailed information about the additional products reserved for given reservation ID.
Returns information for given resource, including photos and resource-specific properties defined in the admin panel in: Site settings / Custom resource properties
Returns complete pricing information for all resources of a site. Pricing is returned in two separate arrays: one with the default prices and one with the additional pricing rules. Keys of both arrays are resource IDs.
Returns seasonal settings for a resource
This function will return usage/availability information of given resource (or entire site) for specified period of time. Note that the output is minimized, so only periods with usage (reservations or vacations) will be returned.
This function will return usage/availability information of given resource (or entire site) for an entire month.
Use this function for day-based resources if you need to get daily pricing for a range of dates (max 2 years). This function is mostly used for accommodations in order to convert the prices defined in Pricing Manager to prices understood by channel managers (price for given day and for given number...
Use this function if you need to get daily restrictions for a range of dates (max 2 years). This function is mostly used for accommodations in order to convert the restrictions defined in seasonal settings and in time-related settings to restrictions understood by channel managers. Note that Planyo...
Returns information for given site, including photos and site-specific properties defined in the admin panel in: Site settings / Custom resource properties
Returns value of a custom unit property. Unit properties can have different values at different dates/times (e.g. odometer reading at rental start/end) and so the values are always retrieved for a specific time.
Returns details of a user. The users which can be found are those who made at least one reservation, were created by the admins, or they must administer the site (as main administrator, resource admin or moderator). You must pass either the email address or the user ID.
Use this function to get a listing of all weekly vacations of a resource (or all resources; see the resource_id parameter) or to get a listing of all working hours during the week.
Returns resource availability for given time period. Please note that making a reservation may be impossible even if the resource is available. This may be caused by additional constraints such as required start/end weekday, not enough free time after previous rental etc. Use can_make_reservation...
Returns additional products defined in a Planyo site.
List payments made for all reservations of a shopping cart. Note that in case of a shopping cart, payments are always assigned to specific reservations belonging to a shopping cart, even though the payment is made for all cart reservations.
Lists shopping carts for a site or metasite. You can limit the carts listed to specific dates or only the ones that were checked out. A maximum of 500 carts will be listed. For further items use the 'page' parameter.
Lists coupon payments. See blow for the parameters to filter the results.
Lists coupons (coupon definitions) that can be purchased for your site.
Lists the purchased coupons. You can specify a number of parameters to filter the results.
Returns a listing of custom user property definitions for a site.
Lists invoices for given reservation or invoices generated in given period. This function only works with parent&corrective invoices. In case of multiple invoices, a maximum of 50 invoices will be listed. For further items use the 'page' parameter.
List payments made for your reservations. You can specify a number of parameters to filter the results.
List payments made for a reservation, including coupon usage.
Lists all reservations that either start within given time period or that were entered into the system within given time period (when list_by_creation_date is true). A maximum of 500 reservations will be listed. For further items use the 'page' parameter.
Returns resources defined in a Planyo site or meta site along with additional information and photos. You can specify a resource filter. Note: old name of this function was get_all_resources . You can still use that function name instead.
Use this function to list the reviews added by clients.
Returns all moderators of a Planyo site.
Returns sites defined in a Planyo meta site along with additional information and photos. You can specify a site filter.
Lists user-defined translations for given metasite, site or resource.
Returns all users with at least one reservation (unless list_created_by_admin is set to true in which case users created by the admins are returned, also with no reservations). You can specify a user filter. A single API call returns at most 1000 results. If you want to get further results, change...
Lists all vacations within specified time range. You can specify either site_id or resource_id to get site-wide vacations in the first case and resource-specific vacations in the second case. Pass resource_id=all and include_site_vacations to list all vacations.
Lists vouchers. You can specify a number of parameters to filter the results, for example only so that the vouchers which can be used for a specific reservation parameters (dates/resource id) can be returned.
Enters a new reservation into the system. The ID of the new reservation is available in 'reservation_id' in case of success. If you're using the PRO-COMM payment model, the commission will be calculated for API-entered reservations.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to make modifications to an existing additional product. You can modify any number of fields in a single call
A repeated request may repeat the external action. Review the previous result before retrying a write.
Makes modifications to an existing coupon. The parameters which you don't want to modify should not be passed.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Make modifications to an existing reservation using this function. You can modify the resource, rental time, quantity, and the custom reservation form items. The parameters which you don't want to modify should not be passed.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to make modifications to an existing resource. You can modify any number of fields in a single call
A repeated request may repeat the external action. Review the previous result before retrying a write.
Modifies an existing season. You can use this function to modify one or more properties of the season. All the parameters representing season's properties are optional.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to make modifications to an existing site. You can modify any number of fields in a single call
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to modify an existing user's data. The user must be identified by one of the following fields: email, user_id, user_login. Access to modify user's data is possible only when the user was either added manually or via CSV import by one of your admins, or if they made at least one...
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to modify an existing voucher identified by voucher_id. Voucher IDs are returned by the functions list_vouchers and create_voucher
A repeated request may repeat the external action. Review the previous result before retrying a write.
Move reservations into a new or existing shopping cart.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Template processor. This works the same way as in the email notifications or other templates. Depending on the context given by input parameters, you can use tags from Q204 and/or Q205. You can always use tags from Q206 and Q221 and the conditional tags from Q207. You must specify one of: site_id,...
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to recalculate the price of an existing reservation. A recalculation may be needed for example if the pricing manager rules were changed since the reservation was made, or if a voucher was applied at a later time, etc.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes an existing additional product. WARNING: removing a product will also remove its usage from all reservations where the product was used; this operation cannot be undone. The extra parameters (site_id, product_id_md5) are required for verification purposes.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a coupon.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a coupon type.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes an existing custom product. You can get the custom product ID from the calls to either add_custom_product or get_reservation_products
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a custom resource property, a custom user property, or a custom site property (metasites only)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes a pricing manager rule.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes an additional product image identified by ID.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes an existing resource. WARNING: all existing reservations for the resource will be also removed and this operation cannot be undone. The extra parameters (resource_name, site_id, resource_id_md5) are required for verification purposes.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a resource image identified by ID.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a season (for a single resource or for entire Planyo site) identified by ID. The functions get_resource_seasons and add_resource_season return unique season IDs which are used to identify a specific season.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a site image identified by ID.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to remove the moderator role from a user.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a URL from the list of favorites in the backend. See add_url_to_admin_favorites for more info.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes an existing user. A user can be deleted only if they have no reservations made for given Planyo site or if their only reservations have been cancelled and they have no other reservations outside of given Planyo site (or its parent metasite).
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes an existing vacation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Removes a voucher.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Finds all reservations containing text specified in the query parameter (this works in the same was as the Search tab in the admin panel). You can search for one or more of the following: first and/or last name, login name, user ID, reservation ID, email address, phone number, resource name.
Searches for available resources for given time period. The results can be returned as raw data or as HTML code depending on the value of the optional 'output' parameter.
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.
Finds all users whose custom user property has the specified value. This function will return max 500 users.
Allows you to send a message to the customer -- it's the same operation as clicking on Add new message on the reservation details page. The message being sent will be also registered in the history on that page for all administrators and the customer to see. Warning: this function will only work...
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sets a new value for the property. Properties can be of different types -- Planyo allows assigning custom properties to users, sites, resources and reservations. Please note that custom properties will be visible in the backend UI (for site administrators) unless the property name starts with...
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sets new times for an event-type resource.
A repeated request may repeat the external action. Review the previous result before retrying a write.
This function will import the reservation form for the specified resource from a CSV file. Warning: this function will override the existing form items for the resource.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to add or remove additional products for given reservation ID. This won't trigger notifications, web hooks or price recalculation. See set_reservation_products for this functionality or if you'd like to set usage of all products for given reservation in a single call.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set a new color for the reservation. Currently the following colors can be used: #A8314F,#33FF33,#4D4DFF,yellow,#B84DFF,#999999,#81FCF6,#FFBAF1,#DADAD2,#ECDC81,#CEF0FF,#D1FFB3,#FFA4A4
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set new user and/or admin notes for a reservation
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set a custom price for a reservation. This does the same as changing the price by an admin on the reservation details page.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use this function to add text translations for your site or metasite. This is equivant to going to Settings / Customized translations. There you'll also find the existing text identifiers you can set with this function (S_xxx). Please note that you should always set the target language for the...
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sets the unit names of a resource. The number of units must be equal to the quantity of the resource. Use the function list_resources or get_resource_info in order to fetch existing unit names.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sets a custom unit property. Unit properties can have different values at different dates/times (e.g. odometer reading at rental start/end) and so the values are always set for a specific time.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in Planyo Online Booking. A saved workflow is not a completed provider action.
