Read-only API: your orders and forecasts in other tools
Your site can share order, menu and inventory data with an outside tool, such as a forecasting or accounting system, through a read-only API.
Turning it on
The API is the API access (read only) feature. It is listed under Active Features or Disabled Features on the Features page, and we turn it on per site. Once on, an API page appears in the admin.
Keys
A manager creates keys on the API page. Each key has its own permissions, and you can edit those permissions later without issuing a new key. Revoke a key at any time. Every call is logged against the key that made it, and keys are rate limited.
What a key can read
- Inventory, sales and menu (checked when you create a key): the remaining quantity on limited items, and order and meal counts for a window. The default window is the last 7 days, up to 90 days, or one menu cycle. The counts carry no dollar amounts. It also reads your menus: the live menu with the items for sale and their base prices, your most recent menus, and the menus coming up next.
- Order detail: one row per finalized order with the customer name, delivery address, amount charged and the meal lines. It is off on every key until a manager grants it.
- Customer contact on orders: adds the customer's email and phone to each order row.
- Discount codes on orders: adds the discount codes used on each order.
The last two only add to Order detail, so a key needs that one as well. A key returns these fields only after a manager grants them.
For your vendor
The API page carries the integration documentation your vendor needs: endpoints, parameters and examples. Send them the key and a link to the page.
Keywords: developer, export data, api key
Related