External API

The External API lets other systems read from your workspace, such as a merchant’s online shop showing delivery prices at checkout, or a tracking page on your own website.

Get an API key

An admin opens Settings → API Key and chooses Generate API Key. Copy it straight away; it is shown only once. You can regenerate it (the old key stops working immediately) or revoke it.

Caution

Treat the key like a password. Use it only from a server, never in a website’s front-end code or a mobile app where people can read it.

Making requests

Send requests to your company’s address, with the key in the X-API-Key header:

curl https://shwe-express.mmdeliapp.com/api/external/townships \
  -H "X-API-Key: YOUR_KEY" \
  -H "Accept: application/json"

A missing or wrong key returns 401 with {"error": {"code": "invalid_api_key"}}.

Endpoints

List townships

GET /api/external/townships

Returns your townships with their IDs and codes. Use the IDs for pricing.

Quote a delivery price

POST /api/external/pricing

{
  "township_id": 12,
  "from_township_id": 3,
  "weight_kg": 2.5
}

from_township_id is optional. The response breaks down the fee:

{
  "data": {
    "township_id": 12,
    "township_name": "Hlaing",
    "weight_kg": 2.5,
    "delivery_fee": "2500.00",
    "kg_fee": "500.00",
    "transfer_fee": "0.00",
    "total_fee": "3000.00",
    "currency": "MMK"
  }
}

If you have no price for that route, the response is 404 with Pricing not found for this route.

Track a parcel

GET /api/external/parcels/{public_tracking_code}

Returns the parcel’s current status, recipient, township, key dates (pickup, delivery, received), and its status history. Use the public tracking code, not the VR code. See the parcel lifecycle for what each status means.