Channel Reservations

Preview an update of a reservation

post/v3/channels/{channel_id}/reservations/{id}/preview

Request

Path parameters

channel_idstring required

Channel ID

idstring required

Resource ID

Query parameters

fields[reservation]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

validate_minimum_advance_noticeboolean

If set to true, validates that the reservation preview satisfies the minimum advance notice requirements.

validate_length_of_stay_does_not_exceed_max_av_cache_length_of_stayboolean

If set to true, validates that the stay of the reservation preview does not exceed the maximum length of stay supported by the availability cache (30).

rent_order_update_mode'based_on_current_prices' | 'based_on_current_order' | 'extend_with_current_prices'

Update mode for the rent of the order. based_on_current_prices: Recalculates the rent based on current prices. based_on_current_order: Retains the rent of the current order. extend_with_current_prices: Retains the rent of the current stay and adds the current prices of the nights the stay is extended with. Only possible when the stay is extended within the same type. When omitted, the deprecated order_update_mode is used if passed.

costs_order_update_mode'based_on_current_prices' | 'based_on_current_order'

Update mode for the costs of the order. based_on_current_prices: Recalculates the costs based on current prices. based_on_current_order: Retains the costs of the current order. When omitted, the deprecated order_update_mode is used if passed.

order_update_mode'based_on_current_prices' | 'based_on_current_order'

Deprecated, use rent_order_update_mode and costs_order_update_mode instead. Update mode for both the rent and costs of the order. based_on_current_prices: Recalculates the order based on current prices. based_on_current_order: Retains the main order items of the current order.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Request body

Example request

{
  "data": {
    "id": "1",
    "type": "reservation",
    "attributes": {
      "payment_guarantee": "none",
      "price_according_to_channel_calculation": "total",
      "license_plates": [
        "75-DN-GP"
      ],
      "currency": "EUR"
    },
    "relationships": {
      "category": {
        "data": {
          "type": "category"
        }
      },
      "rentable_type": {
        "data": {
          "type": "rentable_type"
        }
      },
      "rentable_identity": {
        "data": {
          "type": "rentable_identity"
        }
      },
      "inventory_object": {
        "data": {
          "type": "inventory_object"
        }
      },
      "booking": {
        "data": {
          "type": "booking"
        }
      },
      "order": {
        "data": {
          "type": "order"
        }
      },
      "discount_card": {
        "data": {
          "type": "discount_card"
        }
      },
      "primary_package": {
        "data": {
          "type": "primary_package"
        }
      },
      "extra_packages": {
        "data": [
          {
            "type": "extra_package"
          }
        ]
      },
      "extra_order_items": {
        "data": [
          {
            "type": "extra_order_item"
          }
        ]
      },
      "cancellation_rules": {
        "data": [
          {
            "type": "cancellation_rule"
          }
        ]
      },
      "reservation_amenities": {
        "data": [
          {
            "type": "reservation_amenity"
          }
        ]
      },
      "available_optional_amenities": {
        "data": [
          {
            "type": "amenity"
          }
        ]
      },
      "labels": {
        "data": [
          {
            "type": "label"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "category",
      "attributes": {
        "country_code": "NL"
      },
      "relationships": {
        "city": {
          "data": {
            "type": "city"
          }
        },
        "terms": {
          "data": {
            "type": "terms"
          }
        },
        "rentable_segment": {
          "data": {
            "type": "rentable_segment"
          }
        },
        "master_price_list": {
          "data": {
            "type": "master_price_list"
          }
        },
        "guest_group_limits": {
          "data": [
            {
              "type": "guest_group_limit"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "rent_earned_ledger_account": {
          "data": {
            "type": "ledger_account"
          }
        },
        "checkin_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "checkout_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "images": {
          "data": [
            {
              "type": "image"
            }
          ]
        },
        "rooms": {
          "data": [
            {
              "type": "room"
            }
          ]
        },
        "rentable_type_amenities": {
          "data": [
            {
              "type": "rentable_type_amenity"
            }
          ]
        },
        "optional_amenities": {
          "data": [
            {
              "type": "amenity"
            }
          ]
        },
        "attachments": {
          "data": [
            {
              "type": "attachment"
            }
          ]
        },
        "accommodation_type": {
          "data": {
            "type": "accommodation_type"
          }
        },
        "category_amenities": {
          "data": [
            {
              "type": "category_amenity"
            }
          ]
        }
      }
    }
  ]
}

Response

ReservationResponse

Example response

{
  "data": {
    "id": "1",
    "type": "reservation",
    "attributes": {
      "payment_guarantee": "none",
      "price_according_to_channel_calculation": "total",
      "license_plates": [
        "75-DN-GP"
      ],
      "currency": "EUR",
      "checkin_time": "14:00",
      "checkout_time": "10:00",
      "access_code": "1337",
      "stay_reason": "tourism, business"
    },
    "relationships": {
      "category": {
        "data": {
          "type": "category"
        }
      },
      "rentable_type": {
        "data": {
          "type": "rentable_type"
        }
      },
      "rentable_identity": {
        "data": {
          "type": "rentable_identity"
        }
      },
      "inventory_object": {
        "data": {
          "type": "inventory_object"
        }
      },
      "booking": {
        "data": {
          "type": "booking"
        }
      },
      "order": {
        "data": {
          "type": "order"
        }
      },
      "discount_card": {
        "data": {
          "type": "discount_card"
        }
      },
      "primary_package": {
        "data": {
          "type": "primary_package"
        }
      },
      "extra_packages": {
        "data": [
          {
            "type": "extra_package"
          }
        ]
      },
      "extra_order_items": {
        "data": [
          {
            "type": "extra_order_item"
          }
        ]
      },
      "cancellation_rules": {
        "data": [
          {
            "type": "cancellation_rule"
          }
        ]
      },
      "reservation_amenities": {
        "data": [
          {
            "type": "reservation_amenity"
          }
        ]
      },
      "available_optional_amenities": {
        "data": [
          {
            "type": "amenity"
          }
        ]
      },
      "labels": {
        "data": [
          {
            "type": "label"
          }
        ]
      },
      "administration": {
        "data": {
          "type": "administration"
        }
      },
      "discount_action": {
        "data": {
          "type": "discount_action"
        }
      },
      "order_items": {
        "data": [
          {
            "type": "order_item"
          }
        ]
      },
      "main_order_items": {
        "data": [
          {
            "type": "main_order_item"
          }
        ]
      },
      "available_discount_cards": {
        "data": [
          {
            "type": "discount_card"
          }
        ]
      },
      "available_primary_packages": {
        "data": [
          {
            "type": "primary_package"
          }
        ]
      },
      "available_extra_packages": {
        "data": [
          {
            "type": "extra_package"
          }
        ]
      },
      "available_extras": {
        "data": [
          {
            "type": "extra"
          }
        ]
      },
      "question_answers": {
        "data": [
          {
            "type": "question_answer"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "category",
      "attributes": {
        "country_code": "NL"
      },
      "relationships": {
        "city": {
          "data": {
            "type": "city"
          }
        },
        "terms": {
          "data": {
            "type": "terms"
          }
        },
        "rentable_segment": {
          "data": {
            "type": "rentable_segment"
          }
        },
        "master_price_list": {
          "data": {
            "type": "master_price_list"
          }
        },
        "guest_group_limits": {
          "data": [
            {
              "type": "guest_group_limit"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "rent_earned_ledger_account": {
          "data": {
            "type": "ledger_account"
          }
        },
        "checkin_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "checkout_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "images": {
          "data": [
            {
              "type": "image"
            }
          ]
        },
        "rooms": {
          "data": [
            {
              "type": "room"
            }
          ]
        },
        "rentable_type_amenities": {
          "data": [
            {
              "type": "rentable_type_amenity"
            }
          ]
        },
        "optional_amenities": {
          "data": [
            {
              "type": "amenity"
            }
          ]
        },
        "attachments": {
          "data": [
            {
              "type": "attachment"
            }
          ]
        },
        "accommodation_type": {
          "data": {
            "type": "accommodation_type"
          }
        },
        "category_amenities": {
          "data": [
            {
              "type": "category_amenity"
            }
          ]
        }
      }
    }
  ]
}

Changes

    • breaking

      the query request parameter order_update_mode was restricted to a list of enum values

    • warning

      added the new da-DK enum value to the // response property for the response status

    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the // response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the // response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • info

      added the new optional query request parameter costs_order_update_mode

    • info

      added the new optional query request parameter rent_order_update_mode

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      the request optional property /////// became read-only

    • info

      the request optional property /////// became read-only

    • info

      the request optional property /////// became read-only

    • info

      the request optional property /////// became read-only

    • info

      the request optional property /////// became read-only

    • info

      the request optional property /////// became read-only

    • info

      added the new enum value based_on_current_order to the query request parameter order_update_mode

    • info

      added the new enum value based_on_current_prices to the query request parameter order_update_mode

    • info

      added the new da-DK enum value to the request property //

    • info

      added the new da-DK enum value to the request property ///////

    • info

      added the new da-DK enum value to the request property ///////

    • info

      added the new en-GB enum value to the request property //

    • info

      added the new en-GB enum value to the request property ///////

    • info

      added the new en-GB enum value to the request property ///////

    • info

      added the new en-US enum value to the request property //

    • info

      added the new en-US enum value to the request property ///////

    • info

      added the new en-US enum value to the request property ///////

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/id deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/meta deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/meta/method deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/meta/temp_id deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/type deprecated