Phorest API - Common Use Cases

Integration with the Phorest API requires your own development team for setup. Third-party software providers wishing to partner with Phorest might be subject to integration charges.

Overview

At Phorest, we want to give you open access to all your data, so you can build features we haven’t created yet or support use cases we may not have imagined.

With help from your developer, our APIs let you access your data whenever you need it and build features and functionality beyond the core Phorest experience.

This guide includes a few examples of what you can do with the Phorest 3rd Party API.

We’re continually updating this information, so if you can’t find what you’re looking for, please feel free to contact us. You can find all our APIs here.

The Phorest API does not currently support webhooks. Instead, you can regularly check for updates by polling the API.

Reporting

If you require custom reporting for your salon, extracting the raw data for every sale processed through Phorest over a specific date range is possible. This will provide you with a wealth of information, including the name of a staff member, client details, price per line item, applied discounts, and more.

With the help of your developer, you can utilize this information to create custom reports tailored to your specific needs. See the CSV Export Job API.

Online Retail

If you want to sell your retail products through your website using WooCommerce, Shopify, or similar, you can use 2 of our APIs to achieve this. The product API will enable you to check stock levels, pricing, and barcodes, while the purchase API will allow you to process the sale for the item in Phorest. This will automatically update your stock levels in Phorest and include those sales in the standard Phorest reporting.

Bespoke Online Booking

If you wish to build a custom online booking flow, use our Booking API and Client API. You could also use this to take your custom deposits and payments upfront. While a lot is achievable using this, considerable time and effort will be required by your development team to achieve it.

Building out a bespoke booking flow can often be a very expensive and time-consuming development project. Alternatively, you can embed the Phorest book now button on your website instead of using the API, if you prefer.

Online Vouchers & Gift Cards

Our Voucher API can be used to add a gift card to Phorest. Your developer would need to build the entire web experience of purchasing the gift card, handling the payment (for example, through Stripe), and sending an email to your client.

Another option is to use a standalone service to sell them online and then manually enter those gift card sales into Phorest, allowing the end-user to redeem them. This requires minimal to no development work on your part.

Call Centre/Smartphone Systems

Call Centres can utilize our Client API to display which client is calling automatically and their service history/future appointments, allowing for a more personal experience for your clients.

Staff Reviews

The Review API can be used to get a list of reviews. The list can be filtered by client ID, client's first name or last name, staff member's first name or last name, and date of review. This could be leveraged to share reviews on external platforms, like your website.

Newsletter/Mailing List Subscriptions

If you would like clients to sign up for your newsletter or special offers on your site, the Client API will allow your developer to create a widget on your site and add the client to your Phorest client list. You can assign a client category during client card creation or update to facilitate easier future marketing campaigns.

 Next Steps!

Check out this guide to learn how to get started with the Phorest API.


API FAQs

Is it possible to integrate with third-party terminals for payments?

While it is possible to use a PhorestPay Card Terminal (powered by Stripe), it's not possible to integrate other third-party payment solutions with Phorest.

Was this article helpful?
45 out of 83 found this helpful