API Documentation

TrueOrder Developer API

Check delivery history across 6 Bangladeshi couriers in one API call. Simple REST API, JSON responses, no SDK required.

Quickstart

Get a result in three steps:

Create a free account and confirm a plan.
Generate an API key from your dashboard under API Keys.
Call the check endpoint with your key in the X-API-Key header.

Authentication

Every request must include your API key in the X-API-Key header.

X-API-Key: to_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Keep your API key secret. Never expose it in client-side/browser code — call it from your own server.

Check Endpoint

GET /v1/check/{phone}

Base URL: https://api.trueorderbd.com

Parameter	Type	Description
phone	path, string	Bangladeshi mobile number, e.g. 01712345678

Response Format

{
  "status": "success",
  "data": {
    "pathao": {
      "name": "Pathao",
      "logo": "https://trueorderbd.com/assets/courier/pathao.png",
      "total_parcel": 20, "success_parcel": 19, "cancelled_parcel": 1, "success_ratio": 95.0
    },
    "steadfast": { "name": "SteadFast", "logo": "...", "total_parcel": 41, "success_parcel": 34, "cancelled_parcel": 7, "success_ratio": 82.93 },
    "redx": { "...": "..." },
    "paperfly": { "...": "..." },
    "carrybee": { "...": "..." },
    "summary": {
      "total_parcel": 89,
      "success_parcel": 75,
      "cancelled_parcel": 14,
      "success_ratio": 84.27
    }
  }
}

Error Codes

Status	Meaning
401	Missing or invalid API key
403	Account inactive or no active subscription
422	Invalid phone number format
429	Monthly quota exceeded
502	Upstream courier check failed

Code Examples

curl -H "X-API-Key: YOUR_KEY" \
  https://api.trueorderbd.com/v1/check/01712345678

$ch = curl_init('https://api.trueorderbd.com/v1/check/01712345678');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-API-Key: YOUR_KEY']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const res = await fetch('https://api.trueorderbd.com/v1/check/01712345678', {
  headers: { 'X-API-Key': 'YOUR_KEY' }
});
const data = await res.json();

import requests

r = requests.get(
    "https://api.trueorderbd.com/v1/check/01712345678",
    headers={"X-API-Key": "YOUR_KEY"}
)
data = r.json()

Rate Limits & Quota

Your monthly check quota depends on your plan and resets every calendar month. See pricing for quota per plan. Once your quota is used, requests return 429 until the next cycle or an upgrade.

Ready to integrate?

Create a free account and get your API key in under a minute.

Get started free