API - Planyo Web Services - do_reservation_action

Jesteś tutaj: Planyo » Pomoc » API » do_reservation_action

do_reservation_action

Description:

Call to perform an administrative action (such as confirmation or cancellation) on a reservation

Input:

reservation_id int optional

ID of the reservation. Required unless reservation_ids is used.

reservation_ids string optional

You can optionally pass multiple comma-separated reservation IDs (max 50) in this parameter. In such case the same action will be applied to all the reservation IDs passed using the same parameters. If this parameter is passed, you may NOT pass any value in the parameter reservation_id. Note that the JSON data returned by an API call with this parameter will be different. The 'data' key will be an array with reservation IDs as keys and the values corresponding to the standard output of this function (see the Output section below) for given reservation ID.

action string required

One of: Reserve (period is marked as occupied), Verify (email address verified), Confirm, Preapprove (automatically confirm this and all future reservations of this user), Fraud (cancel this reservation and prevent this customer from making future reservations), Cancel (reservation cancelled by the administrator), User_cancel (reservation cancelled by the customer), Checkin (customer is checking in), Clear_checkin (remove the checked-in status), Checkout (customer is checking out), Noshow (customer hasn't showed up), Clear_noshow (remove the no-show status), Unconfirm (remove the confirmed status), Uncancel (remove the canceled status), Make_not_completed (remove both the reserved and confirmed statuses), Mark_as_quote (remove the reserved status and mark reservation as a quotation), Lock (prevent the reservation from being modified), Unlock (clear the locked status), Promote (promote waiting list request to valid reservation)

custom_data string optional

If action is verify, this is the verification code (required). In other cases this is ignored

comment string optional

Optional comment for the action

admin_id int optional

Optionally you can assign the action to a specific administrator/moderator by passing their user id. The administrator must have access to the resource used by the reservation.

is_quiet bool optional

Set this to true if you don't want any emails to be sent out as a result of this action. By default the emails will be sent as configured by you in notification settings.

method string required

must be set to do_reservation_action

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:

status ReservationStatus

New (updated) status of the reservation

user_text string

Text to be displayed to the user with the status of their reservation

API playground:

Click here to test this function in the API playground.