Validate a Remote Order

Validate Order Endpoint

POST /validate/order

Required Headers

Authorization: Bearer <token>

Body

Submit a single JSON encoded Remote Order as the POST body.

Returns

  • HTTP 200 on success
  • HTTP 400 on malformed RemoteOrder (do not resubmit without fixes - the response will contain more information)
  • HTTP 401 on invalid/missing Authorization token (do not resubmit without updating Authorization)
  • HTTP 5XX on an error internal to ROS.

On success the response body will contain a single JSON encoded EntityValidationResponse containing a report on any validation issues found.

Remarks

This endpoint is designed for generating a development/debug report for a RemoteOrder. It's not designed for use in a normal workflow. Do not use this endpoint as part of a normal add order workflow.

The report will contain developer readable strings that should highlight common validation issues with an incoming order. These message will cover validation issues that can cause issues on the POS (even if the POS is able to still confirm the order - eg incorrect prices/totals/taxes)

As part of the validation process the current menu(s) being utilised by the outlet will be cross referenced. The tests aren't completely exhaustive but should cover a large number of common validation issues.