Main docs page Auth API Ordering API Menu API Venue API Inventory API Payment API Loyalty API Wallet API
Documentation Powered by ReDoc

Ordering API (1.0)

Download OpenAPI specification:Download

OrderingStack ordering API

Authentication

oauth2

Standard token auth

Security Scheme Type OAuth2

oauth2-client

Internal authorization between microservices

Security Scheme Type OAuth2

stats

getGlobalStats

Get paginated list of globals stats. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_ORDERS)
query Parameters
required
object (StatsFilter)
header Parameters
x-tenant
string <uuid>

Responses

getVenueStats

Get paginated list of single venue stats. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_ORDERSROLE_{venue}_MANAGERROLE_{venue}_ORDERS)
path Parameters
venue
required
string [ 1 .. 128 ] characters [a-zA-Z0-9_.-]+
query Parameters
required
object (StatsFilter)
header Parameters
x-tenant
string <uuid>

Responses

getTodayStats

Get paginated list of all venues stats for today. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_ORDERS)
query Parameters
required
object (StatsTodayFilter)
header Parameters
x-tenant
string <uuid>

Responses

order

getList

Get paginated list of orders. This endpoint is compatible with React AdminOnRest framework to provide DataSource.

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_ORDERSROLE_{venue}_MANAGERROLE_{venue}_ORDERS)
query Parameters
required
object (OrdersFilter)
header Parameters
x-tenant
string <uuid>

Responses

commentOrder

Add comment to order.

Authorizations:
oauth2
path Parameters
uid
required
string <uuid>

Order id

Request Body schema: */*
string

Responses

commentOrderLine

Add comment to order line.

Authorizations:
oauth2
path Parameters
uid
required
string <uuid>

Order id

lid
required
string <uuid>

Line id

Request Body schema: */*
string

Responses

setQueuePos

Manually set queue pos for order. Tenant configuration must allow it.

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_QUEUE)
path Parameters
uid
required
string <uuid>

Order id

Request Body schema: */*
venue
required
string [ 1 .. 128 ] characters [a-zA-Z0-9_.-]+
queuePos
required
string [ 1 .. 32 ] characters [a-zA-Z0-9_.-]+

Responses

kdsTraceView

Track order visibility on KDS.

Authorizations:
oauth2 (ROLE_SUROLE_MANAGERROLE_ORDERSROLE_KDSROLE_COOKROLE_WAITERROLE_{venue}_MANAGERROLE_{venue}_ORDERSROLE_{venue}_KDSROLE_{venue}_COOKROLE_{venue}_WAITER)
path Parameters
uid
required
string <uuid>

Order id

query Parameters
config
string

KDS config

Responses

verifyOrder

Mark order as verified.

Authorizations:
oauth2-clientoauth2 (ROLE_SUROLE_MANAGERROLE_ORDERSROLE_VERIFYROLE_{venue}_MANAGERROLE_{venue}_ORDERSROLE_{venue}_VERIFY)
path Parameters
uid
required
string <uuid>

Order id

Responses

newAggregatorOrder

Create new order from aggregator (already paid).

Authorizations:
oauth2-client