NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Planyo Online Booking connects to a Nagent workspace with an API key. Once it is connected, agents can call 7 Planyo Online Booking actions, such as "Add Reservation", "Add User" and "Get Add-on List". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Planyo Online Booking, with input parameters and output schema.
PLANYO_ONLINE_BOOKING_ADD_RESERVATIONTool to create a new reservation. Use after gathering resource, timing, and customer details.
Input parameters
Set to True to override conflicts and limits
ID of the Planyo site to reserve on
Existing Planyo user ID; if not provided, user_email, first_name, and last_name are required
Reservation end time; will be converted to UNIX timestamp
Language for reservation notifications (e.g., 'en', 'fr')
Number of items or seats to reserve
Customer last name; required if user_id not provided
Set to True to run in admin mode
Customer first name; required if user_id not provided
Reservation start time; will be converted to UNIX timestamp
Customer email; required if user_id not provided
ID of the resource to reserve
Voucher code to apply
Additional custom form fields; keys are field IDs or names; 'req_' prefix will be added automatically
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PLANYO_ONLINE_BOOKING_ADD_USERTool to add a new user in Planyo. Use when you need to create a user account after gathering user details.
Input parameters
User's fax number
User's postal code
User's city
User's email address
User's phone number
User's state or province
User's mobile phone number
VAT identification number
User's street address
Company name associated with the user
User's country (2-letter ISO code)
User's last name
User's first name
Custom fields mapping using field IDs, e.g. {'3': 'value'}
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PLANYO_ONLINE_BOOKING_GET_ADDON_LISTTool to retrieve a list of add-ons. Use when you need to inspect or manage add-ons for a specific resource or across the entire site after setting up credentials.
Input parameters
Site ID to query; deduced from api_key or resource_id if omitted
Numeric user ID for authentication; alternative to login_name/password
Password for authentication; required if api_key is not provided
If true, list add-ons in admin mode when no resource_id is given
Username for authentication; required if api_key is not provided
Session token for authentication; alternative to login_name/password
Resource ID for which to retrieve add-ons; omit to fetch all site-wide add-ons
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PLANYO_ONLINE_BOOKING_GET_COUPON_LISTTool to retrieve a list of coupons. Use when you need to fetch all coupons for a specific resource or the entire site (if no resource_id provided).
Input parameters
Zero-based page number for pagination. Each page returns up to 5000 coupons. Omit to get the first page.
ID of the site to fetch coupons for. Required if no resource_id is provided.
Admin email for authentication if required.
ID of the resource to filter coupons. If omitted, returns all coupons for the site.
Admin password for authentication if required.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PLANYO_ONLINE_BOOKING_GET_RESOURCE_AVAILABILITYTool to check resource availability within a specified date/time range. Use when validating if a resource can be reserved before creating a reservation.
Input parameters
End of the interval; will be converted to UNIX timestamp
Number of units requested
If set to 1, simulate without creating a reservation
Start of the interval; will be converted to UNIX timestamp
End user ID for checking membership or restrictions
If true, ignore items in the shopping cart
ID of the resource to check availability for
Minimum required availability in minutes
If true, ignore existing reservations
If set to 1, return specific time slots within interval
If set to 1, only check restrictions, skip conflict checks
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PLANYO_ONLINE_BOOKING_GET_RESOURCE_BLACKOUTSTool to fetch blackout periods for a resource. Use when determining unavailable timeslots before booking.
Input parameters
UNIX timestamp to return blackouts up to this time (inclusive).
UNIX timestamp to return blackouts starting from this time (inclusive).
Admin email for authentication, if required.
ID of the resource to retrieve blackouts for.
Password for the admin email, if required.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PLANYO_ONLINE_BOOKING_GET_RESOURCE_REVIEWSTool to fetch reviews and ratings for a specific resource. Use when you have a resource_id and need to display customer feedback.
Input parameters
Maximum number of reviews to return (1-500)
ID of the resource to fetch reviews for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 7 Planyo Online Booking actions on Nagent, including "Add Reservation", "Add User" and "Get Add-on List". Add Reservation: Create a new reservation. Each action is listed on this page with its input parameters and its output.
Planyo Online Booking connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Add Reservation takes 3 required inputs: site_id, quantity and resource_id. It also takes 11 optional inputs: force, user_id, end_time, language, last_name, admin_mode, first_name, start_time, user_email, voucher_code and custom_fields. It returns data, error and successful.