GuideLab Docs

Read an order snapshot

The same snapshot the order.updated event carries. Drafts and other practices' orders are not found.

GET
/smileline/v1/orders/{id}

The same snapshot the order.updated event carries. Drafts and other practices' orders are not found.

Authorization

smilelineBearer
AuthorizationBearer <token>

Smileline cell credential gl_sl_v1_<cell>_<secret>, one per Smileline cell; accepted only on /smileline/v1. A practice belongs to one cell and is not found from any other.

In: header

Path Parameters

id*string
Length1 <= length <= 200

Query Parameters

practiceRef*string
Match^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/u

Response Body

application/json

application/json

curl -X GET "https://example.com/smileline/v1/orders/string?practiceRef=string"
{  "orderId": "string",  "orderNumber": "string",  "revision": 0,  "practiceRef": "string",  "labId": "string",  "labName": "string",  "patientRef": "string",  "externalRefs": {    "procedureId": "string",    "planId": "string",    "appointmentId": "string"  },  "createdByRef": "string",  "status": "string",  "stage": {    "code": "string",    "label": "string",    "tone": "start"  },  "needsAction": {    "kind": "surgical_report",    "label": "string"  },  "dueDate": "string",  "submittedAt": "string",  "completedAt": "string",  "cancelledAt": "string",  "shipment": {    "status": "string",    "trackingUrl": "string"  },  "summary": "string",  "total": {    "amountMinor": 0,    "currency": "string"  },  "invoice": {    "status": "string",    "amountDueMinor": 0,    "currency": "string",    "dueDate": "string"  },  "lastLabMessageAt": "string",  "unreadLabMessages": 0,  "remakeOfOrderId": "string",  "updatedAt": "string"}
Empty
Empty
Empty
{  "error": "string",  "code": "string"}
Empty