Connect your other systems

Reports, the join link and an open API

Take your group bookings, guests and payments into the tools you already use: a spreadsheet, your accounts, a dashboard or your own system.

Three ways to connect

  • Reports

    Download PreOrders, payments, money outstanding, guests and hosts for any dates as a spreadsheet. Part of the Pro plan.

  • Join link and QR code

    Every PreOrder has one link for guests, with a QR code you can print on a poster or table card, on every plan.

  • Open API

    Let another system read your PreOrders, guests, payments and hosts, with a key you control. Part of the Pro plan.

Getting started with the API

  1. On the Pro plan, an Admin opens Settings, API and chooses Make a key.
  2. Name it after the system that will use it (for example “Accounts”), pick the venue, and tick only what that system needs.
  3. Copy the key. It is shown once and PreOrderly keeps only a scrambled copy, so it can't be shown again. Lose it and you make a new one.
  4. Give the key to the person setting up the other system. They send it as Authorization: Bearer <key> to https://preorderly.app/api/v1.

Keys can last 30 days, 90 days, 1 year or never expire, and an Admin can switch one off at any time. An organisation can have up to 20 live keys.

What each key may do

Each key gets only the permissions you tick. It only ever sees your own organisation's venues.

Read PreOrders
PreOrders: name, status, dates, times, guest counts, money totals, room, location, series.
Change PreOrders
Change a PreOrder's notes, guest message, maximum guests and times. Never money, status or hosts.
Read guests
Guest names, email, whether they replied, and the counts. Nothing about food or allergies.
Read dietary and allergy data
Each guest's dietary menu, allergies and severity. Special-category data: every response that includes it is logged with the guests it covered.
Read payments
Payments and refunds taken against PreOrders.
Read hosts
Hosts: name, email, phone and company.

Allergy and dietary details are special-category data, so they are behind their own permission: creating that key needs a tick to confirm you have a lawful reason to share them, and every response that includes them is logged.

What it can do today

The API's routes
WhatAddressNeeds
List PreOrdersget /api/v1/preordersRead PreOrders
Get a PreOrderget /api/v1/preorders/{id}Read PreOrders
Change a PreOrderpatch /api/v1/preorders/{id}Change PreOrders
List a PreOrder's guestsget /api/v1/preorders/{id}/guestsRead guests
List paymentsget /api/v1/paymentsRead payments
List hostsget /api/v1/hostsRead hosts

It reads PreOrders, guests, payments and hosts, and changes a few safe things on a PreOrder: its notes, the message to guests, the maximum number of guests and times. It never changes money, status or hosts, and it can't create or cancel a PreOrder. Money is in whole pence. Lists are paged, up to 100 at a time.

Each key can make 120 requests a minute. Every call is recorded on the API page, so you can see what a system has been doing.

A machine-readable description (OpenAPI 3.1) is at /api/v1/openapi.json, for anyone building against it.

Need something more?

We add integrations when venues ask for them, such as a booking system, a till or an accounts package, or creating a PreOrder from another system. If you need one, email support@preorderly.app and tell us what you use and what you'd like it to do. See pricing for the plans.

Your next big table, sorted before it arrives.

Set up your menu and send your first PreOrder today.

30 days free, extended to your first event (up to 60 days) · No contract

Connect PreOrderly: reports and an open API for your systems · PreOrderly