API Reference
The Deliverant API is organized around REST. All requests and responses use JSON. Authenticate with a Bearer token and use prefixed IDs for all resources.
Base URL
https://api.deliverant.co/v1Authentication
All API requests require a Bearer token in the Authorization header.
Request headerShell
Authorization: Bearer dk_live_your_api_key_hereID Format
All resource IDs use a prefixed format for easy identification. Pass prefixed IDs in URL paths, query parameters, and request bodies.
ResourcePrefix
Event
evt_Delivery
del_Endpoint
ep_Attempt
att_Batch
bat_API Sections
Status Codes
200Success201Created202Accepted (async processing)204No Content400Validation error401Unauthorized404Not found409Conflict (idempotency or state)