APapaleo
ReservationActions

Assign a specific unit to a reservation.

Changed on

Assigns a specific unit to a reservation which is in state 'Confirmed' or 'InHouse'. If the unit is not available, the call will return an error, and no unit will be assigned.<br>You must have at least one of these scopes: 'reservations.assign-unit, reservations.manage'.<br>For fine-grained clients, you must have this permission: 'core.reservations.modify'.

put/booking/v1/reservation-actions/{id}/assign-unit/{unitId}

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/booking/v1/reservation-actions/{id}/assign-unit/{unitId}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: reservations.assign-unit, reservations.manage, admin

Path parameters

idstring required

Id of the reservation the unit should be assigned to.

unitIdstring required

The id of the unit to be assigned.

Query parameters

fromstring

The start date and optional time for the unit assignment. If not specified, the reservation's arrival will be used.<br />Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring

The end date and optional time for the unit assignment. If not specified, the reservation's departure will be used.<br />Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

lockUnitboolean

Whether to lock the unit for the duration of the reservation. If not specified, the unit will not be locked.

Response

Unit assignment was successful.

Example response

{
  "unit": {
    "id": "MUC-JQI",
    "name": "A.102",
    "description": "Double room",
    "unitGroupId": "MUC-DBL"
  }
}

Changes

  • 6510a7df7143Revision changes
    • info

      added the new optional query request parameter lockUnit

    • info

      added the non-success response with the status