Delivery API
Delivery API
Integrate delivery tracking and fulfilment workflows into your healthcare application. Track shipments, update carrier information, confirm receipt and manage delivery exceptions through secure APIs.
Delivery API provides a reusable delivery layer for healthcare commerce and fulfilment. Use it to connect carrier workflows, patient/pharmacy delivery experiences and operational tracking without coupling applications to a single courier implementation.
What you can build
End-to-end tracking
Track shipments from dispatch to final receipt.
Receipt & validation
Confirm receipt and capture proof of delivery.
Status visibility
Keep delivery state synchronized in real time.
Exception management
Handle delays, cancellations and delivery issues.
Available endpoints
| Method | Endpoint | Description | Scope |
|---|---|---|---|
| GET | /v1/deliveries | List deliveries with filters | delivery.read |
| GET | /v1/deliveries/{id} | Get a specific delivery | delivery.read |
| PUT | /v1/deliveries/{id} | Update delivery details/status | delivery.write |
| POST | /v1/deliveries/{id}/confirm | Confirm delivery receipt | delivery.write |
| POST | /v1/deliveries/{id}/cancel | Cancel eligible delivery | delivery.write |
Delivery lifecycle
pendingAwaiting dispatch
in_transitIn transit
out_for_deliveryOut for delivery
deliveredDelivered
confirmedReceipt confirmed
Delivery model
| Field | Meaning |
|---|---|
| id | Delivery identifier |
| order_id | Related order |
| status | Current delivery lifecycle state |
| carrier | Carrier / delivery provider |
| tracking_number | External tracking reference |
| shipped_at | Dispatch timestamp |
| estimated_delivery_at | Estimated arrival |
| delivered_at | Actual delivery time |
| notes | Operational notes |
Delivery resource
{
"id":"del_01H...",
"order_id":"ord_01H...",
"status":"in_transit",
"carrier":"DHL",
"tracking_number":"DHL1234567890",
"estimated_delivery_at":"2026-08-20T18:00:00Z"
}Status values
| Status | Meaning |
|---|---|
| pending | Delivery created and awaiting dispatch |
| in_transit | Shipment has left origin |
| out_for_delivery | Carrier is completing final mile |
| delivered | Items delivered |
| confirmed | Recipient confirmed receipt |
| cancelled | Delivery cancelled |
Integration guidance
Treat Mediloop delivery IDs as stable application references and carrier tracking numbers as external references. Consume status changes idempotently and keep patient-facing information free of sensitive clinical detail.