Get Order Status

GET /api/v2/orders/{orderIdentifier}/status

This endpoint is used to retrieve the status of an order.

Accepts

An order identifier, which can be the order number, tray number, or purchase order number
- This order can be retrieved using 72544, 337178, or Example
- Tray numbers can only be used to look up active orders
- If lookup is done by po number then you must be using unique values in this field

Returns

Success

A JSON object representing the requested order

Property	Description
orderNumber	string The identifier for the order
trayNumber	string The tray number the order is attached to
poNumber	string Job reference (PO NUM field)
calculationDesc	string The current calculation status of the order (for humans) Both eyes calculated Right eye calculated Left eye calculated Calculations not done
currentStation	string The current status/station for the order
currentStationCustomerDesc	string The current customer status description for the order
currentStationDateTime	string\|null The date and time the current status was applied to the order in format yyyy-mm-ddThh:mm:ss.fffZ (ISO 8601) or null
currentStationDesc	string The current status/station description for the order
status	string The current status of the order (U = Unvalid, V = Valid, P = Process, C = Complete, W = Hold)
statusDesc	string The current status of the order (for humans) Unvalid Valid Process Completed On Hold Other
onHold	boolean Whether or not the order is on hold
unvalidMessage	string The reason why the order was last set unvalid (if any)
rtCalculated	boolean Whether or not calculations have been done for the right eye
ltCalculated	boolean Whether or not calculations have been done for the right eye

Error

If the orderIdentifier parameter does not match an order number, tray number, or purchase order number for any order in the system an HTTP 404 code will be returned with the standard error body

{
  "error": "No record found",
  "details": [
    "Provided: 999999"
  ]
}