⌘K

Partner APIReference

Orders (Partner API)

Create, retrieve and cancel orders.

On this page

Endpoints

GET/v1/programs/{programId}/requirementsDiscover what an order must carry
POST/v1/ordersCreate an order
GET/v1/orders/{orderId}Retrieve order status
POST/v1/orders/{orderId}/cancelCancel while cancellation is still possible
GET/v1/orders/{orderId}/exceptionsRead canonical specimen, sample and result exceptions

Read the program requirements first: they tell you exactly which fields, answers and subject references an order in that program must carry.

bash
curl -s -X POST https://app.soliadirect.com/api/public/partner/v1/orders \
  -H "Authorization: Bearer $SOLIA_API_KEY" \
  -H "Idempotency-Key: order-1001" \
  -H "Content-Type: application/json" \
  -d '{"external_order_id":"order-1001","program_id":"...","item_id":"...","external_subject_id":"subject-1001","collection":"..."}'

Projection is not order authority

Continue using the canonical generated Partner API requests and server-side eligibility/clinical/collection checks. ULC projections and imported Live status are not executable order authorization. On uncertain native send, preserve the original identity and reconcile rather than creating a replacement order.

Reference laboratory engineering boundary

Reference/send-out is source-only and unavailable in Sandbox or Production. Existing integration, buyer, publication and clinical authorities remain unchanged; a directory listing or relationship never authorizes a referral.

Related resources