Planyo Online Booking
planyo_online_bookingPlanyo is an online reservation system which can be used by any business taking bookings: for days, nights, hours or minutes, or scheduled events.
Acciones disponibles (7)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add ReservationPLANYO_ONLINE_BOOKING_ADD_RESERVATIONAcciónTool to create a new reservation. Use after gathering resource, timing, and customer details.
PLANYO_ONLINE_BOOKING_ADD_RESERVATIONAcciónTool to create a new reservation. Use after gathering resource, timing, and customer details.
Parámetros de entrada
forcebooleanSet to True to override conflicts and limits
site_idintegerObligatorioID of the Planyo site to reserve on
user_idintegerExisting Planyo user ID; if not provided, user_email, first_name, and last_name are required
end_timestringdate-timeReservation end time; will be converted to UNIX timestamp
languagestringLanguage for reservation notifications (e.g., 'en', 'fr')
quantityintegerObligatorioNumber of items or seats to reserve
last_namestringCustomer last name; required if user_id not provided
admin_modebooleanSet to True to run in admin mode
first_namestringCustomer first name; required if user_id not provided
start_timestringdate-timeReservation start time; will be converted to UNIX timestamp
user_emailstringCustomer email; required if user_id not provided
resource_idintegerObligatorioID of the resource to reserve
voucher_codestringVoucher code to apply
custom_fieldsobjectAdditional custom form fields; keys are field IDs or names; 'req_' prefix will be added automatically
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add UserPLANYO_ONLINE_BOOKING_ADD_USERAcciónTool to add a new user in Planyo. Use when you need to create a user account after gathering user details.
PLANYO_ONLINE_BOOKING_ADD_USERAcciónTool to add a new user in Planyo. Use when you need to create a user account after gathering user details.
Parámetros de entrada
faxstringUser's fax number
zipstringUser's postal code
citystringUser's city
emailstringObligatorioemailUser's email address
phonestringUser's phone number
statestringUser's state or province
mobilestringUser's mobile phone number
vat_idstringVAT identification number
addressstringUser's street address
companystringCompany name associated with the user
countrystringUser's country (2-letter ISO code)
last_namestringUser's last name
first_namestringUser's first name
custom_fieldsobjectCustom fields mapping using field IDs, e.g. {'3': 'value'}
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Add-on ListPLANYO_ONLINE_BOOKING_GET_ADDON_LISTAcciónTool 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.
PLANYO_ONLINE_BOOKING_GET_ADDON_LISTAcciónTool 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.
Parámetros de entrada
site_idintegerSite ID to query; deduced from api_key or resource_id if omitted
user_idintegerNumeric user ID for authentication; alternative to login_name/password
passwordstringPassword for authentication; required if api_key is not provided
admin_modebooleanIf true, list add-ons in admin mode when no resource_id is given
login_namestringUsername for authentication; required if api_key is not provided
session_idstringSession token for authentication; alternative to login_name/password
resource_idintegerResource ID for which to retrieve add-ons; omit to fetch all site-wide add-ons
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Coupon ListPLANYO_ONLINE_BOOKING_GET_COUPON_LISTAcciónTool 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).
PLANYO_ONLINE_BOOKING_GET_COUPON_LISTAcciónTool 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).
Parámetros de entrada
site_idintegerID of the site to fetch coupons for. Required if no resource_id is provided.
admin_emailstringAdmin email for authentication if required.
resource_idintegerID of the resource to filter coupons. If omitted, returns all coupons for the site.
admin_passwordstringAdmin password for authentication if required.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Resource AvailabilityPLANYO_ONLINE_BOOKING_GET_RESOURCE_AVAILABILITYAcciónTool to check resource availability within a specified date/time range. Use when validating if a resource can be reserved before creating a reservation.
PLANYO_ONLINE_BOOKING_GET_RESOURCE_AVAILABILITYAcciónTool to check resource availability within a specified date/time range. Use when validating if a resource can be reserved before creating a reservation.
Parámetros de entrada
end_timestringdate-timeEnd of the interval; will be converted to UNIX timestamp
quantityintegerNumber of units requested
test_modeintegerenumIf set to 1, simulate without creating a reservation
01start_timestringdate-timeStart of the interval; will be converted to UNIX timestamp
end_user_idintegerEnd user ID for checking membership or restrictions
ignore_cartbooleanIf true, ignore items in the shopping cart
resource_idintegerObligatorioID of the resource to check availability for
min_durationintegerMinimum required availability in minutes
ignore_reservationsbooleanIf true, ignore existing reservations
check_specific_slotsintegerenumIf set to 1, return specific time slots within interval
01preliminary_filteringintegerenumIf set to 1, only check restrictions, skip conflict checks
01
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Resource BlackoutsPLANYO_ONLINE_BOOKING_GET_RESOURCE_BLACKOUTSAcciónTool to fetch blackout periods for a resource. Use when determining unavailable timeslots before booking.
PLANYO_ONLINE_BOOKING_GET_RESOURCE_BLACKOUTSAcciónTool to fetch blackout periods for a resource. Use when determining unavailable timeslots before booking.
Parámetros de entrada
end_timeintegerUNIX timestamp to return blackouts up to this time (inclusive).
start_timeintegerUNIX timestamp to return blackouts starting from this time (inclusive).
admin_emailstringAdmin email for authentication, if required.
resource_idintegerObligatorioID of the resource to retrieve blackouts for.
admin_passwordstringPassword for the admin email, if required.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Resource ReviewsPLANYO_ONLINE_BOOKING_GET_RESOURCE_REVIEWSAcciónTool to fetch reviews and ratings for a specific resource. Use when you have a resource_id and need to display customer feedback.
PLANYO_ONLINE_BOOKING_GET_RESOURCE_REVIEWSAcciónTool to fetch reviews and ratings for a specific resource. Use when you have a resource_id and need to display customer feedback.
Parámetros de entrada
limitintegerMaximum number of reviews to return (1-500)
resource_idintegerObligatorioID of the resource to fetch reviews for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not