Open Network overview
What the Localoy Open Network is, what you can build with it, and how its pieces fit together.
The Open Network connects a Localoy partner's own software — a point-of-sale, a booking system, an e-commerce store or a custom backend — to Localoy. Your server talks to Localoy over a REST API authenticated with an API key, and Localoy talks back to your server with signed HTTP calls.
What you can build#
| Capability | Direction | What it does |
|---|---|---|
| Catalogue sync | You → Localoy | Keep your items, prices and stock in Localoy, addressed by your own IDs. |
| Payments | Both | Charge a Localoy order through your own payment gateway and report the outcome. |
| Live inventory checks | Localoy → you | Localoy asks your system whether an item is available before it accepts a booking. |
| Webhooks | Localoy → you | Receive booking, payment and catalogue events as they happen. |
How it fits together#
A typical booking touches every part: your catalogue, a live inventory check, and a webhook.
- Your server → Localoy: POST /catalog/items (with localoyRef)
- Localoy → Your server: 201 Created
- Customer → Localoy: Book a table for 2
- Localoy → Your server: GET inventory check
- Your server → Localoy: 200 { available: true }
- Localoy → Customer: Booking created
- Localoy → Your server: Webhook: booking.created
- Your server → Localoy: 2xx
Before you start#
- You need a Localoy partner account with an approved business profile.
- Creating new API keys and webhook endpoints requires an active Partner+ subscription with the Open Network benefit. Keys you already hold keep working if the subscription lapses.
- All setup — keys, webhook endpoints, the checkout URL and the inventory endpoint — is done in the Partner Portal under Open Network. The API itself is only for your server's day-to-day calls.
Technology Providers
If you run your business on a platform — a ticketing system, a point-of-sale, a booking engine or a WooCommerce store — you may not need to call this API yourself. Connect the platform from the Partner Portal's Open Network → Technology Providers page: a Technology Provider then acts for you with the scopes you grant, and a WooCommerce store is mirrored every hour. Building such a platform? Read the Technology Providers book.