Using the Orders API

What the Orders API does

The Orders API provides two endpoints:

1. Get Orders API – Returns all orders across all shows (up to each show’s breakdown end date).

2. Get Order Details API – Returns full details of a specific order.

You’ll only ever see your own orders, never another supplier’s.

Enabling the Orders API

1. Log in to FFAIR and go to Supplier Company Settings.

2. Scroll to the Orders API section.

3. Toggle Enable API.

4. An API Secret Key will be generated.

   • The key is hidden by default.

   • Use the Eye button to reveal it.

   • Use Copy to copy it to your clipboard.

   • ⚠️For security reasons, your key will only be shown once. Please copy and store it securely.

5. Click Save to confirm.

If you lose your key, you’ll need to regenerate it.

• A warning will confirm that regenerating a key invalidates the old one.

• Once regenerated, update your systems with the new key.

Get Orders API

Request: Must contain your Supplier ID.

Returns:

• Show ID, Name, and Dates (live, build-up, breakdown).

• Build Type & Stand Number.

• Exhibitor Company Name.

• Ordered by: Email & Telephone.

• Supplier Company Name.

• Order Number, Value, Created Date.

• Organiser revenue (inc VAT).

• Payment Type, Status, Date.

• Sales tax name and amount.

Get Order Details API

Request: Must contain your Supplier ID, Show ID, and Order ID.

Returns:

• Show ID, Name, and Dates.

• Build Type & Stand Number.

• The entire order object, including all details of the specific order.

Benefits of the Orders API

• Automate order management and reconciliation.

• Feed order data directly into your finance or ERP systems.

• Eliminate manual exports and reduce errors.

• Get a complete picture of your exhibitor orders across all shows.

Next steps

• Go to Supplier Company Settings → Orders API to enable your key.

• Store your key securely before leaving the page.

• Start making API requests using your Supplier ID and API key.

What to do with your API key

Once you’ve generated and saved your API key:

Use it to authenticate API requests

• The key acts like a password for your system to talk securely with FFAIR.

• It must be included in the header of each API request when calling the Orders API.

• Example:

Connect to your internal systems

• Most suppliers will use the key in scripts, middleware (e.g., Zapier, Make, custom apps), or integrations with their finance/ERP system.

• This allows your order data to flow automatically into your own tools