README

A Laravel package for Pathao Courier API integration in Bangladesh. Create Pathao courier orders, calculate delivery price, get stores, cities, zones, and areas, track parcels, cancel orders, and receive parcel status updates through a webhook.

kejubayer/pathao-api-integration provides a Laravel service, facade, config file, route, migration, and model for common Pathao Courier merchant API workflows.

Features

• Pathao Courier order creation from Laravel
• Pathao delivery price calculation
• Pathao merchant store list
• City, zone, and area lookup
• Parcel tracking by consignment ID
• Order cancellation
• Parcel status webhook route
• Webhook event storage in database
• Laravel facade and dependency injection support
• Laravel package auto-discovery

Keywords

Pathao Laravel package, Pathao Courier API, Pathao API integration, Laravel courier API, Bangladesh courier API, Pathao parcel tracking, Pathao webhook, Pathao delivery charge, Pathao merchant API.

Requirements

• PHP 7.4 or higher
• Laravel 8, 9, 10, or 11
• Guzzle 7

Laravel Pathao API Installation

Install the package with Composer:

composer require kejubayer/pathao-api-integration

Publish the configuration file:

php artisan vendor:publish --tag=pathao-config

Add your Pathao credentials to .env:

PATHAO_BASE_URL=https://api-hermes.pathao.com
PATHAO_CLIENT_ID=your-client-id
PATHAO_CLIENT_SECRET=your-client-secret
PATHAO_USERNAME=your-username (pathao merchant email)
PATHAO_PASSWORD=your-password (pathao merchant password)
PATHAO_WEBHOOK_ROUTE=pathao/webhook/parcel-status

Laravel package auto-discovery will register the service provider and facade automatically.

Run the migrations to create the parcel status webhook table:

php artisan migrate

Pathao API Configuration

The package configuration is stored in config/pathao.php.

Pathao Courier API Usage

Import the facade:

use Pathao;

Get Access Token

$token = Pathao::getAccessToken();

Create Pathao Courier Order

$stores = Pathao::stores();
$storeId = $stores['data']['data'][0]['store_id'];

$order = Pathao::createOrder([
    'store_id' => $storeId,
    'merchant_order_id' => 'ORD-1001',
    'recipient_name' => 'Customer Name',
    'recipient_phone' => '017XXXXXXXX',
    'recipient_address' => 'House 1, Road 2, Dhaka',
    'delivery_type' => 48,
    'item_type' => 2,
    'special_instruction' => 'Handle with care',
    'item_quantity' => 1,
    'item_weight' => 0.5,
    'amount_to_collect' => 1200,
    'item_description' => 'Product description',
]);

Pathao requires store_id when creating an order. Use Pathao::stores() to get your available stores, then pass the selected store_id to Pathao::createOrder().

Pathao Delivery Price Calculation

$price = Pathao::priceCalculation([
    'store_id' => 12345,
    'item_type' => 2,
    'delivery_type' => 48,
    'item_weight' => 0.5,
    'recipient_city' => 1,
    'recipient_zone' => 2,
]);

Pathao Store List

$stores = Pathao::stores();

Pathao City List

$cities = Pathao::cities();

Pathao Zone List

$zones = Pathao::zones($cityId);

Pathao Area List

$areas = Pathao::areas($zoneId);

Track Pathao Parcel

$tracking = Pathao::trackOrder($consignmentId);

Cancel Pathao Order

$cancelled = Pathao::cancelOrder($consignmentId);

Pathao Parcel Status Webhook

The package registers a POST webhook route for Pathao parcel status updates:

POST /pathao/webhook/parcel-status

Use this URL in your Pathao webhook/callback settings:

https://your-domain.com/pathao/webhook/parcel-status

When Pathao sends a parcel status callback, the package stores the event in the pathao_parcel_statuses table.

Stored columns:

Example webhook payload:

{
    "consignment_id": "12ABC345",
    "merchant_order_id": "ORD-1001",
    "updated_at": "2024-12-27 23:49:43",
    "timestamp": "2024-12-27T17:49:43+00:00",
    "store_id": 130820,
    "event": "order.created",
    "delivery_fee": 83.46
}

Read saved parcel statuses:

use Kejubayer\PathaoIntegration\Models\PathaoParcelStatus;

$statuses = PathaoParcelStatus::latest()->get();

To customize the webhook URL, change PATHAO_WEBHOOK_ROUTE:

PATHAO_WEBHOOK_ROUTE=api/pathao/parcel-status

Pathao API Data Reference

Pathao Create Order Data

Pathao Price Calculation Data

Laravel Method Reference

Pathao API Endpoints Used

Dependency Injection

You can also inject the contract instead of using the facade:

use Kejubayer\PathaoIntegration\Contracts\PathaoInterface;

class OrderController
{
    public function store(PathaoInterface $pathao)
    {
        return $pathao->cities();
    }
}

License

This package is open-sourced software licensed under the MIT license.