Skip to content
Last updated

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[4.10.0] - 2025-12-05

Deploy on stage Deploy on production

Changed

  • X-Booking-Source header in POST venues/bookings is now an enumeration.

[4.9.0] - 2025-12-03

Added

  • Added sorting capabilities to GET /venues endpoint:

    New Query Parameters

    • sortBy (optional): Field to sort results by
      • default - Sort by composite ID (venue_group_id, rms_id, venue_id)
      • name - Sort alphabetically by venue name
      • city - Sort by city name, then venue name
      • area - Sort by area, then venue name
      • venueGroup - Sort by venue group name (requires venueGroupName filter)
      • relevance - Sort by semantic similarity using vector embeddings (requires embedding filters)
    • sortDirection (optional): Sort direction
      • ASC - Ascending (A-Z, 0-9, most to least similar)
      • DESC - Descending (Z-A, 9-0, least to most similar)

[4.8.0] - 2025-12-01

Added

  • Operator Booking Id and Partner Booking Id support to GET venues/bookings by operatorBookingId and partnerBookingId fields
  • Partner Booking Id support to POST venues/bookings bypartnerBookingId field

Changed

  • Reference field is deprecated in GET venues/bookings ; use operatorBookingId instead.

[4.7.0] - 2025-10-13

Added

  • Booking Overrides support to GET venues and GET venues\{venueId} by bookingOverrides field
  • Operator availability rule support to GET venues and GET venues\{venueId} by operatorAvailabilityRules field

[4.6.0] - 2025-10-13

Added

  • Preorders support to GET venues/bookings by preorders field
  • Preorder menus support to GET venues/bookings by preorderMenus field

[4.5.0] - 2025-09-29

Added

  • Possibility to filter by date and time within the GET /venues endpoint.

[4.4.0] - 2025-09-26

Added

  • X-Booking-Source header which identifies the source or channel through which the booking was created.

[4.3.0] - 2025-09-22

Added

  • X-Partner-Reference header is now mandatory on all the endpoints for Bookable Agent clients.

[4.2.0] - 2025-09-15

Added

  • noAvailabilityAction support to GET venues/:venueId/availability
  • autoConfirmRule support to GET venues/:venueId/availability

[4.1.0] - 2025-09-08

Added

  • Preorder menu support to GET venues and GET venues/:venueId by menus field
  • Preorder menu support to POST venues/:venueId/booking by preorderMenus field
  • Preorder menu email triggering on submit booking
  • Preorder menu support to GET venues/bookings/:bookingId by preorderMenus field

Removed

  • packageId field on POST venues/:venueId/booking request

[4.0.0] - 2025-09-02

Added

  • BREAKING CHANGE: Booking PUT request now requires compositeId

Removed

  • GET /venues/products/{compositeId} endpoint

[3.4.0] - 2025-08-20

Added

  • Venue packages detail by packages
  • Booking POST request now accepts packageId
  • Booking POST request now accepts preorders

[3.3.0] - 2025-08-13

Added

  • Endpoint to get a venue product detail by compositeId

[3.2.0] - 2025-08-12

Changed

  • Venue Schema Fields: Deprecated is_active and created_at fields in venue responses
  • Booking POST request now accepts null value for duration field

[3.1.0] - 2025-07-30

Added

  • Booking POST request includes admin_notes, comments & labels field

[3.0.0] - 2025-07-29

Added

  • Standardized error handling across all endpoints

Changed

  • BREAKING CHANGE: Modified venue composition - products are now contained within the venue structure

[2.3.0] - 2025-07-02

Added

  • X-Partner-Reference header for Bookable Agents. The header specifies the partner reference for whom the booking is being made.

[2.2.0] - 2025-06-06

Added

  • Endpoint to update an existing booking by its unique ID
  • Endpoint to cancel a booking by its unique ID

[2.1.0] - 2025-05-30

Added

  • Endpoint to retrieve a paginated list of bookings
  • Endpoint to retrieve a specific booking by its unique ID

[2.0.0] - 2025-05-16

Added

  • Support for paginated venue listings

Changed

  • Rename shut into bookingCutoff

[1.2.0] - 2025-05-14

Added

  • bookingRules: Insert booking rules on Venue to show information about the opening/ close time, max min number of people, and other

[1.1.1] - 2025-05-08

Fixed

  • Validation on require field (#TS-948)

[1.1.0] - 2025-05-02

Unified API

  • Add the unified api

Added

  • VenueId: Introduced the concept of composite Id to manage id into the system
  • type into avalability response: Specifies how an operators time slot can be handled.
  • type into revervation request
  • product_name: the name of product offer from venue