booking/journal does not seem to work in API

edited August 2013 in Developers
Using the example code from the PHP SDK as a basis, I have tried to get a list of bookings using "booking/journal", but it does not return any data, or errors. I have used the exact same code substituting the call for "item", which returns a list of items. Any information on required parameters and how these should be formatted? Is there a working example of PHP code using "booking/journal"?


  • Have had this same problem for about 6 months now, when trying to return bookings for a set date or date range and have realised that the API is just broken. Have had no response from any one on the checkfront end, so no idea if this is something they're looking to update.
  • Dear Checkfront,

    Sorry to bump, but it would be nice just to get some kind of answer.

    Is booking/journal broken or is is just me?
    If it is broken, then is there a plan to actually fix it?

  • Have been told there is a plan to fix, but no fixed date as of yet
  • The booking journal, when not requesting a specific booking, requires you to specify either a [customer_id] or a [customer_email] for a specific customer to get detailed information on bookings for that customer.  
    If you have a simple user database for your application (containing, for example, as simple as just a facebook/twitter/google login token, maybe a timestamp, and a Checkfront customer ID after the first booking), this is especially useful for handling situations in which you often have repeat customers (including allowing you to prefill their address details on new bookings) and/or want to allow managing their bookings via the API.
  • So would it be fair to say that the API has no way to build custom reports because we cannot get a booking dump from the system?
  • edited April 2015
    The comments made previously were in relation to the v2 API, which was being phased out even at the time of the original posting, and is no longer used.
    If you check the v3 API documentation, you can find information on getting a list of bookings from the booking/index, and can request more data on individual bookings from that response by calling booking/[booking_id]

    Beyond what's there and what you can test in your developer console for version 3 of the API, and to gain the most extensive external reporting capabilities without the added latency needed to request all of that data, you can utilize the webhook system to send updates on booking information directly to your own server to collect and save data locally for processing -- which would make for a much faster way for any application to generate or even automate reports.

    You can also ask about any questions or problems you have working with these systems, and we'll always do whatever we can to help out.
  • Hi Kris

    Thanks - I just found booking/index and can see that the data is accessible. I will also investigate using web hooks. The plugins seem to be things for our web sites to query/access checkfront. Is there any mechanism to extend checkfront itself (or our sandbox) so we can add these reports to CF rather than build another security domain on our (simple customer facing) site?
  • Ultimately, no, because the application is housed in a controlled environment in our network, and because the software platform must always remain secure and maintainable, there's no way to run any third party code in the core. We are however working on the system non-stop, so we're always taking input and trying to improve the usability for everyone as best we can.

    Admittedly creating your own integration does require a bit of know-how and effort, so using the API outside the scope of some projects, but for cases where there's a defined need, it can be very useful and worthwhile to do -- although for most businesses this primarily applies to a custom workflow in how they'd like their customers to book. Reporting using the API isn't done quire as often, although it is done, and the webhooks really do make it easy to have the data immediately on hand.

    Use of the webhooks does require your site to have a certificate authority signed and valid security certificate, but personally, I would recommend any business to have this regardless of necessity.
    Having a secure site with an encrypted connection is fast becoming an indicator of trust to your customers, and on the whole, when they feel comfortable that their connection is safe, they'll be more inclined to trust you with their personal information. Additionally, it has the added benefit that as of last year, search engines have begun treating HTTPS as a ranking signal, which can improve your visibility.
    When using our booking page plugin or droplet with one of the inline gateways (such as Stripe), it also allows the customer to remain on your site throughout the checkout process without being redirected to a secure page. SSL Certificates aren't a huge expense (typically less than $10 per year of a single domain certifcate), so it's definitely worth considering in many cases.

    As far as reporting capabilities internally, we are aiming to extend what we currently have available and add new reports for a variety of business cases that we cover, and ideally should be releasing some of these over the course of the next few months.
Sign In or Register to comment.