Delivery API
Get delivery
Retrieve the details of a specific delivery by its ID.
GET
/v1/deliveries/{id}OAuth 2.0 (PKCE)Scopes: delivery.readDescription
Full delivery details
Access
Authorized organization
Scopes
delivery.read
Rate limit
100 requests / min
Endpoint summary
Returns the complete delivery resource, including lifecycle state, carrier information, timing, order linkage and operational notes.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | ID of the delivery |
Example request
Get delivery
GET /v1/deliveries/del_01H7X90Q1 HTTP/1.1
Host: api.mediloop.com
Authorization: Bearer $MEDILOOP_API_KEY
X-Tenant-Id: $TENANT_IDExample response
200 OK{
"data":{
"id":"del_01H7X90Q1", "order_id":"ord_42", "status":"in_transit",
"carrier":"DHL", "tracking_number":"DHL1234567890",
"estimated_delivery_at":"2026-08-20T18:00:00Z"
}
}Example response
Use the returned
updated_at and status values to decide whether a local cached representation is still current.Responses
| HTTP | Description |
|---|---|
| 200 | Delivery retrieved successfully |
| 401 | Authentication required |
| 403 | Access denied |
| 404 | Delivery not found |
| 409 | Delivery unavailable in current context |
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 | Why |
|---|---|
| Shipment detail page | Show current carrier/tracking information |
| Receipt validation | Check whether confirmation is allowed |
| Customer support | Inspect timing and exception details |
| Audit timeline | Link delivery to order history |