Delivery API
List deliveries
Retrieve a list of deliveries with optional filters and pagination.
GET
/v1/deliveriesOAuth 2.0 (PKCE)Scopes: delivery.readDescription
Paginated delivery search
Access
Authorized organization
Scopes
delivery.read
Rate limit
100 requests / min
Endpoint summary
Returns deliveries visible to the active tenant. Combine status, order, date and carrier filters to narrow operational views.
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| page | integer | No | 1 | Page number |
| limit | integer | No | 20 | Items per page, max 100 |
| status | string | No | — | Filter by lifecycle status |
| order_id | uuid | No | — | Filter by related order |
| carrier | string | No | — | Filter by carrier |
| created_from / created_to | date-time | No | — | Creation date range |
Example request
List in-transit deliveries
curl "https://api.mediloop.com/v1/deliveries?status=in_transit&limit=20" \
-H "Authorization: Bearer $MEDILOOP_API_KEY" \
-H "X-Tenant-Id: $TENANT_ID"Example response
200 OK{
"data":[{ "id":"del_01H...", "status":"in_transit", "carrier":"DHL" }],
"meta":{ "page":1, "limit":20, "total":7 }
}Example response
List responses include pagination metadata so clients can render reliable operational queues without guessing whether more results exist.
Responses
| HTTP | Meaning |
|---|---|
| 200 | Delivery list returned |
| 400 | Invalid filter or pagination value |
| 401 | Authentication required |
| 403 | Insufficient delivery scope |
| 429 | Rate limit exceeded |
Filtering & pagination
Prefer explicit filters and paginated retrieval over repeatedly downloading complete delivery history. For event-driven applications, combine this endpoint with Webhooks.
Common use cases
| Use case | Recommended filter |
|---|---|
| Operations queue | status=pending |
| Track active shipments | status=in_transit |
| Order timeline | order_id={id} |
| Carrier dashboard | carrier={name} |