Mediloop
Docs›APIs›Delivery API›Delivery API Reference
Delivery API

Delivery API Reference

Reference for Delivery API endpoints, authentication, lifecycle rules, status values and response behavior.

Base URL & authentication

Authenticated request

GET /v1/deliveries HTTP/1.1
Host: api.mediloop.com
Authorization: Bearer $MEDILOOP_API_KEY
X-Tenant-Id: $TENANT_ID
Accept: application/json

Resources

MethodEndpointPurposeScope
GET/v1/deliveriesList deliveriesdelivery.read
GET/v1/deliveries/{id}Get deliverydelivery.read
PUT/v1/deliveries/{id}Update deliverydelivery.write
POST/v1/deliveries/{id}/confirmConfirm receiptdelivery.write
POST/v1/deliveries/{id}/cancelCancel eligible deliverydelivery.write

Delivery lifecycle

pending

Awaiting dispatch

in_transit

In transit

out_for_delivery

Out for delivery

delivered

Delivered

confirmed

Receipt confirmed

Status values

StatusMeaning
pendingDelivery created and awaiting dispatch
in_transitShipment has left origin
out_for_deliveryCarrier is completing final mile
deliveredItems delivered
confirmedRecipient confirmed receipt
cancelledDelivery cancelled

Idempotency

Retryable write operations should use an idempotency key where supported. Never use a new key to retry the same logical operation unless you intentionally want a new operation.

Rate limits

FamilyIllustrative default
Delivery reads100 requests / min
Delivery writes100 requests / min
Enterprise capacityContract specific

Response codes

HTTPMeaning
200Successful read/update/action
400Invalid request
401Authentication failed
403Insufficient scope / tenant permission
404Delivery not found
409Lifecycle conflict
429Rate limit exceeded