Documentation

The BackResto Partner API, end to end. Start with the quickstart if you already hold a key.

Getting started

What the Partner API is and how to make your first call.

What the BackResto Partner API exposes today, what it deliberately does not, and who decides.

How to ask for a Partner API key, what to put in the request, and what comes back.

From a key to a delivery and a collection record in five minutes, with curl.

Authentication, errors, pagination and rate limits.

Partner keys, the twenty-six scopes, what a grant means, and how to rotate without downtime.

One machine-readable problem document for every failure, and what each type means for your retry logic.

How to walk deliveries and collection records with an opaque cursor, and why one takes a time range and the other does not.

The per-key budget, the one header that describes it, and how to stay under it.

The endpoints, field by field.

The goods-in record — every field, its type, and what it means on the shop floor.

The pictures taken at reception, served as signed URLs that expire in fifteen minutes.

The twenty-four record types beyond deliveries — the snapshot envelope they share, what a snapshot is, and how to walk one.

Connect BackResto to an AI client over MCP.

Connect Claude, Cursor, Codex or any MCP client to a restaurant's compliance records with one URL and your API key.

Versioning, limits of the current data, and how to reach us.

What the current data does and does not cover, how the API is versioned, and how to reach a human.