Get started

* This documentation is incomplete *

The Gourmet API provides programmatic access to all your venue data. Retrieve your venue and Get/Create/Update orders for each one.

To use this API, you need at least one valid Gourmet venue created at https://my.gourmet.app/

API Base URL: https://api.gourmet.app/

AUTHENTICATION

In order to use the API you must first authenticate your device
The API returns a token and a hash which will need to be passed for any subsequent requests
/auth/token/get


QUERY PARAMETERS

Field Type Description
username String Your account username
password String Your account password
hash String A hash representing the unique ID of the device you're using
tag String A tag representing the model of the device you're using. This could be the manufacturer name

RETURNS

Field Type Description
account Object An object containing all the user data of the logged in account including a user_id field required for subsequent requests
token String Authentication needed for subsequent requests
hash String Hash needed for subsequent requests

RETRIEVE VENUES

Retrieve all venues that are registered under your account
/manager/venues/list


QUERY PARAMETERS

Field Type Description
user_id String Unique user ID retrieved from authentication
token String Unique token retrieved from authentication
hash String Unique hash retrieved from authentication

RETURNS

Field Type Description
results Array An array of objects representing information about each venue owned by this user

RETRIEVE VENUE INFORMATION

Retrieve all information for a particular venue
manager/venues/get


QUERY PARAMETERS

Field Type Description
user_id String Unique user ID retrieved from authentication
token String Unique token retrieved from authentication
hash String Unique hash retrieved from authentication
store_id String Unique ID for your store

RETURNS

Field Type Description
results Object An object containing all the relevant information for this venue

Retrieves all venue menu items and categories
/manager/menu/get


QUERY PARAMETERS

Field Type Description
user_id String Unique user ID retrieved from authentication
token String Unique token retrieved from authentication
hash String Unique hash retrieved from authentication
store_id String Unique ID for your store

RETURNS

Field Type Description
results Object An object containing all of the relevant information including all menu categories and items for a particular venue

RETRIEVE ORDERS

Retrieve all open orders for a particular venue
/manager/orders/get


QUERY PARAMETERS

Field Type Description
user_id String Unique user ID retrieved from authentication
token String Unique token retrieved from authentication
hash String Unique hash retrieved from authentication
store_id String Unique ID for your store

RETURNS

Field Type Description
results Array An array of objects representing all open orders for this particular venue

UPDATE ORDER

Update the status of an order for a particular venue
/manager/orders/update


QUERY PARAMETERS

Field Type Description
user_id String Unique user ID retrieved from authentication
token String Unique token retrieved from authentication
hash String Unique hash retrieved from authentication
store_id String Unique ID for your store
order_id String Unique ID for a particular order retrived from /manager/orders/get
status Integer A number representing the new state of the order. The different statuses are represented as follows:
  • 0: CANCELLED ORDER
  • 1: PENDING ORDER
  • 2: ACCEPTED ORDER
  • 3: COMPLETED ORDER

RETURNS

Field Type Description
order Object An object representing the updated order

CREATE ORDERS

Create a new order for a particular venue
/orders/create


QUERY PARAMETERS

Field Type Description
user_id String Unique user ID retrieved from authentication
token String Unique token retrieved from authentication
hash String Unique hash retrieved from authentication
store_id String Unique ID for your store
cart Array Array of items included in the order
total Double An decimal based number representing the total amount of the order

RETURNS

Field Type Description
order Object An object representing the newly created order