Delivery API
Confirm delivery
Confirm receipt of a completed delivery and record proof-of-delivery information.
POST
/v1/deliveries/{id}/confirmOAuth 2.0 (PKCE)Scopes: delivery.writeDescription
Confirm receipt and proof
Access
Authorized organization
Scopes
delivery.write
Rate limit
100 requests / min
Endpoint summary
Confirm delivery when the goods have been received and the delivery is eligible for confirmation.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | ID of the delivery to confirm |
Request body
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| delivered_at | date-time | No | Actual completion time | 2026-08-20T17:45:00Z |
| received_by | string | No | Recipient name/reference | Reception desk |
| proof_url | url | No | Proof of delivery document/image | https://files.example/pod/123 |
| notes | string | No | Receipt notes | Received in good condition |
Example request
Confirm delivery
curl -X POST "https://api.mediloop.com/v1/deliveries/del_01H.../confirm" \
-H "Authorization: Bearer $MEDILOOP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"received_by":"Reception desk","notes":"Received in good condition"}'Example response
200 OK{ "data": { "id":"del_01H...", "status":"confirmed", "received_by":"Reception desk" } }Example response
The confirmation result is idempotent at the business-operation level; clients should still avoid submitting duplicate proof or side effects.
Responses
| HTTP | Description |
|---|---|
| 200 | Delivery confirmed |
| 400 | Invalid confirmation data |
| 403 | Insufficient write scope |
| 404 | Delivery not found |
| 409 | Delivery cannot be confirmed from current state |
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 |
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 |
Common use cases
| Use case | Purpose |
|---|---|
| Pharmacy receipt | Record received shipment |
| Patient delivery | Confirm last-mile handoff |
| Proof of delivery | Store evidence reference |
| Order completion | Close fulfilment workflow |