PathaoParcel
DocsUse CasesContact

Documentation

  • Getting Started
  • Authentication
  • API Reference
  • Webhooks
  • Error Codes
  • SDKs & Tools
  • Sandbox
  • Rate Limiting
  • Idempotency
  • Changelog
PathaoParcel
DocumentationPricingContactUse Cases

© 2026 Pathao Ltd. All rights reserved.

Getting Started

Integrate Pathao Parcel into your platform in five steps. You will obtain an API key, get a delivery quote, create your first order, and set up tracking -- all in under ten minutes.

1

Get your sandbox API key

When you sign up as a Pathao Parcel business partner, you receive a sandbox API key during onboarding. The key follows the format sandbox_key_test_* and grants full access to the sandbox environment.

Include the key in every request using the X-API-Key header.

Request Header
2

Set up your environment

Install an HTTP client for your language of choice. If you are using Node.js 18 or later, the built-in fetch API works out of the box.

# cURL comes pre-installed on macOS, Linux, and Windows 10+.
curl --version
3

Get a delivery quote

Before creating an order, call the quotation endpoint to preview the delivery fee, estimated distance, and duration. This lets you show pricing to your customers upfront.

curl -X POST https://api.pathao.com/v1/business/order/quotation \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "pickup_address_text": "House 42, Road 11, Banani, Dhaka 1213",
    "estimated_pickup_address_latitude": 23.7937,
    "estimated_pickup_address_longitude": 90.4066,
    "receiver_address_text": "Flat 5B, Green Valley Apartments, Dhanmondi, Dhaka 1205",
    "estimated_receiver_address_latitude": 23.7465,
    "estimated_receiver_address_longitude": 90.3762,
    "parcel_type": 1
  }'

A successful response returns the quote details:

Response
4

Create your first order

Once your customer confirms, create a delivery order by providing pickup and delivery coordinates, receiver information, and parcel details. The API returns an order ID and a live tracking URL.

curl -X POST https://api.pathao.com/v1/business/order/create \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -H "X-Idempotency-Key: unique-order-key-123" \
  -d '{
    "pickup_address_text": "House 42, Road 11, Banani, Dhaka 1213",
    "estimated_pickup_address_latitude": 23.7937,
    "estimated_pickup_address_longitude": 90.4066,
    "receiver_address_text": "Flat 5B, Green Valley Apartments, Dhanmondi",
    "estimated_receiver_address_latitude": 23.7465,
    "estimated_receiver_address_longitude": 90.3762,
    "receiver_name": "Mohammad Rahman",
    "receiver_phone_number": "01712345678",
    "parcel_type": 1,
    "driver_type": 1,
    "is_freelancer": true,
    "partner_reference_id": "ORD-2025-00123"
  }'

The response includes a tracking URL you can share with your customer:

Response
5

Track the delivery

Pathao sends real-time status updates via webhooks. Register your webhook URL in the partner dashboard and you will receive POST requests whenever the order status changes (e.g. ASSIGNED, PICKED, COMPLETED).

As a fallback -- or if you cannot receive webhooks -- use the lightweight status polling endpoint instead:

curl -X GET https://api.pathao.com/v1/business/order/PTH-PRC-2025-0001234/status \
  -H "X-API-Key: your_api_key"
Request Header
X-API-Key: sandbox_key_test_1234567890
Response
{
  "charge": 120,
  "distance": 8.5,
  "duration": 25,
  "time_to_pickup": 12
}
Response
{
  "order_id": "PTH-PRC-2025-0001234",
  "partner_reference_id": "ORD-2025-00123",
  "charge": 120,
  "distance": 8.5,
  "duration": 25,
  "time_to_pickup": 12,
  "parcel_status": "PENDING",
  "rider_id": null,
  "tracking_url": "https://track.pathao.com/parcel/PTH-PRC-2025-0001234",
  "created_at": "2025-01-19T14:30:00+06:00"
}