Postman Collection

Test every Food Trace API endpoint instantly using our ready-made Postman collection.

What is Postman?

Postman is a free API testing tool that lets you send HTTP requests, inspect responses, and organise requests into collections — all without writing any code. It's the fastest way to explore and verify API behaviour before building your integration.

Pre-built requests
Every endpoint is already set up — just add your API key and go.
Environment variables
Switch between local and production with one click.
Instant response view
See formatted JSON, headers, and status codes in real time.

Download the Collection

Food-Trace Developer API (Live)

Contains every endpoint — Users, Products, Newlines, Suppliers, and Audits — pointed at the production base_url, with a placeholder api_key variable for you to fill in.

Download Collection

How to Import & Use

If you don't already have Postman, download the free desktop app from postman.com/downloads. It's available for Windows, macOS, and Linux. You can also use Postman Web directly in your browser without installing anything.

A free Postman account is required to save collections and environments.

Click the Download Collection button above to save FoodTrace_API.postman_collection.json to your computer.

  1. Open Postman.
  2. Click Import in the top-left corner (or press Ctrl + O / + O).
  3. Drag and drop the .json file onto the import window, or click Upload Files and browse to it.
  4. Click Import. The Food-Trace Developer API (Live) collection will appear in your left sidebar.

The collection uses a {{api_key}} variable so you only need to set your key once.

  1. In the Collections sidebar, click the Food-Trace Developer API (Live) collection name.
  2. Select the Variables tab.
  3. Find the api_key row and paste your key into the Current Value column.
  4. Click Save (Ctrl/ + S).

  1. Expand the Food-Trace Developer API collection in the sidebar.
  2. Open a folder — for example Users — and click Get User.
  3. Update any path variables shown in the Params tab (e.g. set user_id to a real ID).
  4. Click Send.
  5. The JSON response will appear in the lower panel with the HTTP status code.
Example successful response
{
  "success": true,
  "data": {
    "userid": 14,
    "firstname": "John",
    "lastname": "Doe",
    ...
  }
}

What's Inside the Collection

Requests marked PUT* are sent as POST with an X-HTTP-Method-Override: PUT header — this is the most compatible way to send an update, and it's exactly what these requests do in the collection.

Users

POSTCreate User
GETGet User
PUT*Update User
DELETEDelete User

Products

POSTCreate Product
GETGet Product
PUT*Update Product
DELETEDelete Product

Newlines

POSTCreate Newline
POSTCreate Newline Bulk
GETGet Newline
PUT*Update Newline
DELETEDelete Newline

Suppliers

POSTCreate Supplier
POSTCreate Supplier Bulk
GETGet Supplier By Id
PUT*Update Supplier
DELETEDelete Supplier

Audits

GETList Audits
POSTCreate Audit
GETGet Audit Sections
PUT*Save Audit Item Response
POSTUpload Audit Photo
DELETEDelete Audit Photo
POSTComplete Audit

Tips & Troubleshooting

401 Unauthorized

Your api_key variable is empty or incorrect. Double-check the Variables tab on the collection and make sure Current Value is set.

Could not connect

Check that base_url is pointing at the correct server. For local development use http://localhost/developer/api/v1.

SSL certificate error

If you're testing locally with a self-signed certificate, go to Settings → General and turn off SSL certificate verification. Never disable this in production.

400 Missing required field

POST and PUT request bodies already include all required fields. Be sure to fill them in with real values — the placeholders in the collection are examples only.