Sign in
Block

Returns a specific block.

Retrieves a block, specified by its ID.<br>You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'.

get/booking/v1/blocks/{id}

Path parameters

idstring required

Id of the block to be retrieved.

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions, timeSlices. All other values will be silently ignored.

Response

Success

idstring required

Block id

status'Tentative' | 'Definite' | 'Canceled' | 'Optional' required

Status of the block. Tentative will just mark inventory as requested, but still allows to sell it through other channels. Definite will block the inventory for selling through other channels

fromstring date-time required

Start date and time from which the inventory will be blocked<br />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 date-time required

End date and time until which the inventory will be blocked<br />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>

pickedReservationsinteger required

Number of reservations already picked from this block

promoCodestring nullable

The promo code associated with a certain special offer used to create the block

corporateCodestring nullable

The corporate code associated with a certain special offer used to create the block

createdstring date-time required

Date of creation<br />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>

modifiedstring date-time required

Date of last modification<br />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>

optionalCutoffstring date-time nullable

Optional cutoff date, populated only when the block is in status Optional<br />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>

optionalCutoffBehavior'DoNothing' | 'AutoRelease' nullable

Optional cutoff behavior, populated only when the block is in status Optional

isOptionalDeductingInventoryboolean nullable

Whether this optional block reduces availability, populated only when the block is in status Optional

Example response

{
  "id": "MUC-HSGTDG",
  "group": {
    "id": "XPGMSXGF",
    "name": "apaleo Summer Festival 2027"
  },
  "status": "Tentative",
  "property": {
    "id": "MUC",
    "code": "MUC",
    "name": "Demo Hotel Munich",
    "description": "This is the demo hotel Munich"
  },
  "ratePlan": {
    "id": "MUC-NONREF_SGL",
    "code": "NONREF",
    "name": "Non Refundable",
    "description": "Non Refundable",
    "isSubjectToCityTax": false
  },
  "unitGroup": {
    "id": "MUC-SGL",
    "code": "SGL",
    "name": "Single",
    "description": "Single",
    "type": "BedRoom"
  },
  "grossDailyRate": {
    "amount": 160,
    "currency": "EUR"
  },
  "from": "2026-09-06T17:00:00+02:00",
  "to": "2026-09-08T11:00:00+02:00",
  "pickedReservations": 0,
  "marketSegment": {
    "id": "CORP",
    "code": "CORP",
    "name": "Corporate Groups"
  },
  "created": "0001-01-01T00:00:00Z",
  "modified": "0001-01-01T00:00:00Z",
  "timeSlices": [
    {
      "from": "2026-09-06T17:00:00+02:00",
      "to": "2026-09-07T11:00:00+02:00",
      "blockedUnits": 2,
      "pickedUnits": 0,
      "baseAmount": {
        "grossAmount": 115,
        "netAmount": 100,
        "vatType": "Special",
        "vatPercent": 15,
        "currency": "EUR"
      },
      "totalGrossAmount": {
        "amount": 120,
        "currency": "EUR"
      }
    },
    {
      "from": "2026-09-07T17:00:00+02:00",
      "to": "2026-09-08T11:00:00+02:00",
      "blockedUnits": 3,
      "pickedUnits": 0,
      "baseAmount": {
        "grossAmount": 1071,
        "netAmount": 900,
        "vatType": "Special",
        "vatPercent": 19,
        "currency": "EUR"
      },
      "totalGrossAmount": {
        "amount": 120,
        "currency": "EUR"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.