Get Outlet Menu

This page is primarily for describing the endpoint. Please see Menu Sync for a longer description of the Menu model.

Requesting Latest Menu

To request the latest set of menus for an outlet:

GET /remoteorders/menu/{providerId}/{outletid}

Headers

Authorisation: Bearer <ros token for organisation>

See Access Token for info on getting the token.

Response

  • HTTP 200 - JSON Encoded MenuResponse
  • HTTP 401 on invalid/missing Authorization token (do not resubmit without updating Authorization)
  • HTTP 403 on a correct authorization token but for the wrong outlet (or the outlet has disabled the integration). Do not resubmit.
  • HTTP 503 on service is starting up or is not yet ready to process your request, please wait 30 seconds and retry.
  • HTTP 5XX on an error internal to ROS. This would typically only occur due to an internal transient connection issue, please retry for a limited number of attempts after a short delay.

The menu response will include the requested menus as well as metadata about the outlet.