NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Planyo Online Booking

planyo_online_booking

Planyo is an online reservation system which can be used by any business taking bookings: for days, nights, hours or minutes, or scheduled events.

Scheduling & BookingWeb del proveedor
Acciones
7
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool to create a new reservation. Use after gathering resource, timing, and customer details.

Parámetros de entrada

  • forceboolean

    Set to True to override conflicts and limits

  • site_idintegerObligatorio

    ID of the Planyo site to reserve on

  • user_idinteger

    Existing Planyo user ID; if not provided, user_email, first_name, and last_name are required

  • end_timestringdate-time

    Reservation end time; will be converted to UNIX timestamp

  • languagestring

    Language for reservation notifications (e.g., 'en', 'fr')

  • quantityintegerObligatorio

    Number of items or seats to reserve

  • last_namestring

    Customer last name; required if user_id not provided

  • admin_modeboolean

    Set to True to run in admin mode

  • first_namestring

    Customer first name; required if user_id not provided

  • start_timestringdate-time

    Reservation start time; will be converted to UNIX timestamp

  • user_emailstring

    Customer email; required if user_id not provided

  • resource_idintegerObligatorio

    ID of the resource to reserve

  • voucher_codestring

    Voucher code to apply

  • custom_fieldsobject

    Additional custom form fields; keys are field IDs or names; 'req_' prefix will be added automatically

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add UserPLANYO_ONLINE_BOOKING_ADD_USERAcción

Tool to add a new user in Planyo. Use when you need to create a user account after gathering user details.

Parámetros de entrada

  • faxstring

    User's fax number

  • zipstring

    User's postal code

  • citystring

    User's city

  • emailstringObligatorioemail

    User's email address

  • phonestring

    User's phone number

  • statestring

    User's state or province

  • mobilestring

    User's mobile phone number

  • vat_idstring

    VAT identification number

  • addressstring

    User's street address

  • companystring

    Company name associated with the user

  • countrystring

    User's country (2-letter ISO code)

  • last_namestring

    User's last name

  • first_namestring

    User's first name

  • custom_fieldsobject

    Custom fields mapping using field IDs, e.g. {'3': 'value'}

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Add-on ListPLANYO_ONLINE_BOOKING_GET_ADDON_LISTAcción

Tool 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_idinteger

    Site ID to query; deduced from api_key or resource_id if omitted

  • user_idinteger

    Numeric user ID for authentication; alternative to login_name/password

  • passwordstring

    Password for authentication; required if api_key is not provided

  • admin_modeboolean

    If true, list add-ons in admin mode when no resource_id is given

  • login_namestring

    Username for authentication; required if api_key is not provided

  • session_idstring

    Session token for authentication; alternative to login_name/password

  • resource_idinteger

    Resource ID for which to retrieve add-ons; omit to fetch all site-wide add-ons

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Coupon ListPLANYO_ONLINE_BOOKING_GET_COUPON_LISTAcción

Tool 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_idinteger

    ID of the site to fetch coupons for. Required if no resource_id is provided.

  • admin_emailstring

    Admin email for authentication if required.

  • resource_idinteger

    ID of the resource to filter coupons. If omitted, returns all coupons for the site.

  • admin_passwordstring

    Admin password for authentication if required.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Resource AvailabilityPLANYO_ONLINE_BOOKING_GET_RESOURCE_AVAILABILITYAcción

Tool 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-time

    End of the interval; will be converted to UNIX timestamp

  • quantityinteger

    Number of units requested

  • test_modeintegerenum

    If set to 1, simulate without creating a reservation

    01
  • start_timestringdate-time

    Start of the interval; will be converted to UNIX timestamp

  • end_user_idinteger

    End user ID for checking membership or restrictions

  • ignore_cartboolean

    If true, ignore items in the shopping cart

  • resource_idintegerObligatorio

    ID of the resource to check availability for

  • min_durationinteger

    Minimum required availability in minutes

  • ignore_reservationsboolean

    If true, ignore existing reservations

  • check_specific_slotsintegerenum

    If set to 1, return specific time slots within interval

    01
  • preliminary_filteringintegerenum

    If set to 1, only check restrictions, skip conflict checks

    01

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Resource BlackoutsPLANYO_ONLINE_BOOKING_GET_RESOURCE_BLACKOUTSAcción

Tool to fetch blackout periods for a resource. Use when determining unavailable timeslots before booking.

Parámetros de entrada

  • end_timeinteger

    UNIX timestamp to return blackouts up to this time (inclusive).

  • start_timeinteger

    UNIX timestamp to return blackouts starting from this time (inclusive).

  • admin_emailstring

    Admin email for authentication, if required.

  • resource_idintegerObligatorio

    ID of the resource to retrieve blackouts for.

  • admin_passwordstring

    Password for the admin email, if required.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Resource ReviewsPLANYO_ONLINE_BOOKING_GET_RESOURCE_REVIEWSAcción

Tool 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

  • limitinteger

    Maximum number of reviews to return (1-500)

  • resource_idintegerObligatorio

    ID of the resource to fetch reviews for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not