What's New in API v2023.07.31

A changelog of what has changed in API v2023.07.31 (07/23)

Overview

Welcome to the "What's New?" page for our Partner-API versioned release changes. In this section, we will provide an overview of the updates that have been made from the /dev and /beta versions to the versioned Partner-API.


New Endpoints

The Partner-API v2023.07.31 introduces the following new endpoints:

  • /ratesets endpoint which enables the Agent to retrieve comprehensive Rate Set details and Manage Rate Sets through the API.


  • /payments endpoint allows the Agent to access payment information related to bookings and transactions.


  • /reviews endpoint which enables the Agent to Retrieve Reviews for units within their available Inventory


  • /emails endpoint enables Agents to automate email sending, and manage their integrated email subaccount.

Availability Endpoint

Added

  • GET /availability
    • mcUserId query parameter, which can be used to filter the response to only return objects for the specified Property Manager
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties
  • POST /availability
    • lastUpdateDate query parameter, which can be used to filter the response to only return objects which have been modified after the specified date
    • mcUserId query parameter, which can be used to filter the response to only return objects for the specified Property Manager
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties

Removed

  • All Methods
    • guid query parameter


Content Endpoint

Changed

  • {propertyId} is now referred to as {unitId}
  • GET /content/amenities various endpoints have been consolidated

Added

  • GET /content/amenities
    • mcUserId query parameter, which can be used to filter the response to only return objects for the specified Property Manager
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties
    • channel query parameter, which can be used to filter the response to return Amenities configured for the specified channel
  • GET /content/amenities/{unitId}
    • channel query parameter, which can be used to filter the response to return Amenities configured for the specified channel
  • GET /content/details
    • mcUserId query parameter, which can be used to filter the response to only return objects for the specified Property Manager
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties
  • GET /content/images
    • mcUserId query parameter, which can be used to filter the response to only return objects for the specified Property Manager
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties
    • channel query parameter, which can be used to filter the response to return Images for the specified channel
  • GET /content/images/{unitId}
    • channel query parameter, which can be used to filter the response to return Images for the specified channel

Removed

  • /content/amenities/airbnb and /content/amenities/airbnb/{propertyid} endpoints
  • /content/amenities/vrbo and /content/amenities/vrbo/{propertyid} endpoints
  • /content/amenities/bdc and /content/amenities/bdc/{propertyid} endpoints
  • All Methods
    • guid query parameter


Inventory Endpoint

Changed

  • {propertyId} is now referred to as {unitId}
  • GET /inventory/{unitId}
    • enabled query parameter will be overridden by the enabled body parameter on /inventory endpoint

Added

  • GET /inventory
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties
  • PUT /inventory
    • enabled query parameter, which will filter results by enabled or disabled units
    • permissions query parameter, which will return additional Property information
    • airbnb query parameter, which will return additional Property information relating to Airbnb

Removed

  • GET /inventory
    • airbnbSyncEnabled parameter
  • All Methods
    • guid query parameter


Quote Endpoint

Removed

  • All Methods
    • guid query parameter


Rates Endpoint

Changed

  • GET /rates/extras
    • Unique Identifier for inventory supplier. query parameter corrected to mcUserId

Added

  • GET /rates
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties
  • GET /rates/extras
    • lastUpdateDate query parameter, which can be used to filter the response to only return objects which have been modified after the specified date
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties
  • GET /rates/fees
    • lastUpdateDate query parameter, which can be used to filter the response to only return objects which have been modified after the specified date
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties
  • GET /rates/taxes
    • lastUpdateDate query parameter, which can be used to filter the response to only return objects which have been modified after the specified date
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties

Removed

  • All Methods
    • guid query parameter
  • POST /rates endpoint removed and replaced with Update Rate Set


Reservations Endpoint

Changed

  • {propertyId} is now referred to as {unitId}
  • {bookingId} is now referred to as {reservationId}
  • {supplierId} is now referred to as {mcUserId}
  • GET /reservations/ various endpoints have been consolidated

Added

  • GET /reservations
    • page query parameter, which can be used to filter the response to show the page specified
    • pageSize query parameter, which can be used to limit the number of results returned in the response
    • lastUpdateDate query parameter, which can be used to filter the response to only return objects which have been modified after the specified date
    • mcUserId query parameter, which can be used to filter the response to only return objects for the specified Property Manager
    • mcUserIds query parameter, which can be used to filter the response to only return objects for the specified Property Managers
    • reference query parameter, which can be used to filter the response to only return objects for the specified Booking Reference
    • references query parameter, which can be used to filter the response to only return objects for the specified Booking References
    • unitId query parameter, which can be used to filter the response to only return objects for the specified Property
    • unitIds query parameter, which can be used to filter the response to only return objects for the specified Properties
    • modifiedStart query parameter, which can be used to filter the response to only return objects that have been modified after the specified date
    • modifiedEnd query parameter, which can be used to filter the response to only return objects that have been modified before the specified date
    • arrivalStart query parameter, which can be used to filter the response to only return objects that arrive after the specified date
    • arrivalEnd query parameter, which can be used to filter the response to only return objects that arrive before the specified date
    • departureStart query parameter, which can be used to filter the response to only return objects that depart after the specified date
    • departureEnd query parameter, which can be used to filter the response to only return objects that depart before the specified date
    • cancelledStart query parameter, which can be used to filter the response to only return objects that have been cancelled after the specified date
    • cancelledEnd query parameter, which can be used to filter the response to only return objects that have been cancelled before the specified date
    • addedStart query parameter, which can be used to filter the response to only return objects that have been added after the specified date
    • addedEnd query parameter, which can be used to filter the response to only return objects that have been added before the specified date
    • cancelled query parameter, which can be used to filter the response to only return objects that have been cancelled
    • quote query parameter, which can be used to filter the response to only return objects that are quotes
    • tentative query parameter, which can be used to filter the response to only return objects that are tentative

Removed

  • All Methods
    • guid query parameter
  • GET /reservations/
    • /reservations/property/{propertyId} endpoint
    • /reservations/reference/{reference} endpoint
    • /reservations/supplier/{supplierId} endpoint


Suppliers Endpoint

Removed

  • guid query parameter