We have corrected the listing availability query parameter example. Previously, we showed a colon (':') after available. This has been replaced by the equals ('=') sign.
A new guide on how to retrieve the payment provider ID needed for tokenizing guest credit cards correctly has been published to the Open API. You may view it here.
GuestyPay customers can now safely collect credit card details and store them as tokens via the Open API to use as the guest payment method. Learn more at the links below.
- Tokenizing Payment Methods
- Create payment method (OPTION 3)
GuestyPay is available to our US customers only, learn more here.
You can now add conditionals to percentage-based taxes to simplify your tax operations and ensure compliance with local regulations and fewer manual errors. Look for the conditionalOverrides object in the list of body parameters when creating and updating taxes.
To learn more about taxes in our Help Center.
Guesty accounting customers can now retrieve vendor data quickly and easily, without the hassle of managing large spreadsheets or inefficient processes. Read our guide or head straight to the developer docs.
A new payment method enumeration table has been added. It represents all the supported methods for recording external guest payments or refunds on a reservation. Check it out.
New webhook guides are available completing our coverage of them. Learn more at the links below.
These are the latest Guest Experience endpoint developments you can benefit from
Classify Guests by Age Group
Endpoint
- /inquiries-api/alteration
The ability to classify your guests by age group, available in our app, has been released to our Open API. Specifically, you can define the number of guests that match each of the following age groups:
- Children
- Infants
- Adults
Learn more here.
NoteThis endpoint is still in Beta. If you have access to it, expect some bugs and if you wish to gain access, please speak with your Account Manager or contact us.
Spaces
Endpoints
- /properties/spaces/bed-types
- /properties/spaces/room-types
- /properties/spaces/unit-type/{unitTypeId}
- /properties/spaces/space/{spaceId}/details
- /properties/spaces/space/{spaceId}/remove
- /properties/spaces/space/{spaceId}/edit
Ensure that your properties are properly described with our new Spaces API. This API provides you with the following capabilities:
Enumerators
- Retrieve a list of all the supported Bed types
- Retrieve a list of all the supported Room types (space)
Retrieve Existing Spaces
Manage Spaces
- Create a space on a listing
- Edit a space on a listing
- Remove a space from a listing
- Edit the bed arrangement within a space
House Rules
Endpoints
- /properties/house-rules/unit-type/{unitTypeId}
- /properties/house-rules/
You've asked and we've obliged. Finally, we have brought the functionality of the House Rules in the app to the API. Using the new endpoint you can:
- Retrieve house rules for a single property or multiple properties; and
- Edit the house rules on individual listings or in bulk.
This update makes it easier to manage your guest policy to set better expectations, and to better reflect expected guest behavior leading to better quality reservations.
These are the latest Financial endpoint developments you can now benefit from:
Add a Reservation Reference to the Payment Method
Endpoint
- /business-models-api/light-business-models
- /business-models-api/assignment/{businessModelId}
- /guests/{id}/payment-methods
Easily track which guest payment method was used for a reservation by adding the reservation ID to the guest's payment method. This field is optional for now, but will become a requirement from April.
Channel Commissions
Endpoints
- /channel-commission/account
- /channel-commission/listings
You can now define booking channel commissions and taxes on these commissions via our Open API. Specifically, you can update the commissions on an account and listing level. Likewise you can retrieve them too.
To view a list of booking channels and their supported configurations, see this table of enumerators.
Business Models
Endpoints
Our accounting customers can now view their business models via the Open API and assign listings to them.
We’re continuously enhancing our Open API capabilities to seamlessly and securely extend the reach of the Guesty platform across your internal activities. These are the latest significant Open API developments you can now benefit from:
1. New Additional Fee Settings via API
Easily track your invoices and provide transparency to your guests by defining your Additional Fee Settings via our new API.
2. New Tax Settings API
Define more comprehensive Tax Settings and Tax Conditions while ensuring a stable and clear environment, all via unique API endpoints.
3. New API for Detailed Guest Data Collection
Know your guests better and offer them extraordinary, personalized guest experiences, using a new detailed API, including rich guest data fields.
4. New API for Retrieving a Filtered Tasks List
Retrieve any specific set of tasks to support your operations via our upgraded API with enhanced filtering support.
5. New Accounting APIs (only available for Accounting Add-On users)
Ensure financial accuracy by accessing new APIs for Accounting Journal entries and folio balances.
Important
- To enjoy all these new fields and capabilities, remember to switch to the upgraded API before October 31 2022.
- If you haven’t migrated to the Open Authorization 2.0, please make sure you complete the upgrade process and tests before October 31 2022. Learn more about the new Authentication flow here.
- To ensure success and stability of your API calls please allocate time and development resources to complete upgrade processes before the effective dates. After these dates, Guesty will fade out the existing versions and you might experience failed API calls.