GuideLab Docs

Orders

Endpoints

MethodEndpoint
POSTAdd component to order
POSTAdd line item to an existing order
POSTAdd tag to order
POSTApprove CAD design (clinic only)
POSTApprove surgical report (clinic only)
PATCHAssign or unassign a work tray to a stage (lab only)
POSTBulk delete or cancel orders
POSTCancel an order with an explicit refund decision
DELETECancel order
PUTChange a submitted order's shipping
DELETEClear an incorrectly recorded remake link
POSTCreate draft order
DELETEDelete draft order
GETFind original orders for the same client and active reasons
GETGet an order's revision-aware QC state
GETGet calendar data
GETGet current CAD design review state
GETGet current surgical report review state
GETGet dispatched orders
GETGet filter options for orders
GETGet hold requirements for order
GETGet most recent draft order
GETGet order by ID
GETGet order components
GETGet order files
GETGet order messages
GETGet order print data
GETGet order status history
GETGet order tags
GETGet orders for a specific day
GETGet orders needing approval
GETGet replacement order metadata
GETGet specific draft order
GETGet subscription status
PATCHInvestigate, answer, close or reopen a report
POSTIssue a delivery note (DDT) for an order
POSTIssue the statement of a completed order, or get the issued one
GETList order delivery notes (DDT)
GETList orders
GETList tasks of an order's current phase
GETProblem reports on an order
POSTPut order on hold
GETQuote the shipping options for an order
POSTRecord an immutable QC inspection
PUTRecord or correct a remake link
DELETERemove a line item from an existing order
DELETERemove component from order
DELETERemove tag from order
POSTReport a problem with a delivered order
POSTRequest a new CAD design revision (clinic only)
POSTRequest a new surgical report revision (clinic only)
POSTRequest phase advancement (clinic only)
POSTReview hold requirement
POSTSubmit an existing order draft
POSTSubmit hold requirement
POSTSubscribe to order
GETThe lab's problem reports, newest first
GETThe statement that accompanies a completed order's devices
DELETEUnsubscribe from order
PATCHUpdate a line item on an existing order
PATCHUpdate draft order
PATCHUpdate order
PATCHUpdate order status
GETWhat a new shipment for an order can carry

Update an order tag PUT

Updates an existing order tag's name, color, description, active status, or sort order. Lab-only endpoint.

Add component to order POST

Adds a component to an order with item name, lot number, and optional reference to the lab's component catalog. Only labs can add components to their orders.

On this page

Endpoints