Endpoints Overview
ROS offers a variety of endpoints for submitting orders/querying for menus and other tasks. This page is designed to be a quick overview of the various endpoints and what they do.
Please note that all of the endpoints will require an Access Token
| Endpoint | Purpose | Body | Response | More Info |
|---|---|---|---|---|
POST /remoteorders/add |
Submitting new orders for the outlet to prepare | RemoteOrder | AddResponse | Endpoint Page |
POST /remoteorders/cancel |
Cancelling an order that an outlet has already accepted/confirmed | RemoteOrderCancellation | CancelResponse | Endpoint Page |
GET /remoteorders/menu/{providerId}/{outletId} |
Fetching the current version of an Outlet's menu | N/A | MenuResponse | Endpoint Page |
GET /remoteorders/activeoutlets/{providerId} |
Fetching a snapshot of all outlets currently registered to the provider | N/A | ActiveOutletsResponse | Endpoint Page |
GET /remoteorders/stocklevels/{providerId}/{outletId} |
Fetching a snapshot of an outlet's stock levels | N/A | FetchProductStockLevelResponse | Endpoint Page |
POST /validate/order |
Debug validation of a RemoteOrder | RemoteOrder | EntityValidationResponse | Endpoint Page |