Download the PHP package amdadulhaq/bd-courier-laravel without Composer

BD Courier for Laravel

Create shipments and track parcels from Laravel via popular Bangladeshi courier services (Pathao, Steadfast, RedX, eCourier, Paperfly, Sundarban, SA Paribahan, Karatoa), all behind one driver-based API.

Contents

• Requirements
• Installation
• Configuration
• Which driver do I need?
• Booking a shipment
• Handling webhooks
• API reference
• Adding your own courier
• Testing
• Troubleshooting
• Running the package's own test suite
• License

Requirements

• PHP 8.2, 8.3, 8.4, or 8.5
• Laravel 11, 12, or 13

Installation

The service provider and Courier facade are auto-discovered. Publish the config file:

Configuration

Set the default driver and credentials in your .env:

steadfast has the simplest signup of the bunch, so it's the default — start there if you don't have merchant credentials for anything else yet.

Or, for Pathao:

Or, for RedX:

Or, for eCourier:

Or, for Paperfly:

Or, for Sundarban:

Or, for SA Paribahan:

Or, for Karatoa:

See config/courier.php for every driver's options. COURIER_DRIVER defaults to steadfast.

Which driver do I need?

Every driver throws AmdadulHaq\BdCourier\Exceptions\CourierException for operations it doesn't support, so calling code can rely on the same contract regardless of which courier is active.

Booking a shipment

Track a shipment any time without mutating anything:

Cancel a shipment (not every courier/driver supports this):

Estimate the delivery fee before booking (not every courier/driver supports this):

Use a specific driver, or a driver other than the default, for one call — same as Storage::disk():

Handling webhooks

Some couriers notify your server directly with status updates instead of (or in addition to) you polling track(). Point that URL at a route in your app and hand the request straight to the driver:

None of the couriers supported out of the box sign their webhook payload, so every driver treats the incoming payload as a hint at most: it extracts the consignment/tracking ID and calls the courier's own track() endpoint to get the real, authoritative status rather than trusting the payload directly. Drivers with no webhook mechanism at all throw AmdadulHaq\BdCourier\Exceptions\CourierException.

API reference

ShipmentRequest

Everything a driver might need to book a shipment — pass what applies, ignore the rest (e.g. drivers without a price calculator ignore fields they don't read).

ShipmentResponse

What every driver method returns, so calling code never branches on which courier answered.

ShipmentStatus

$status->isFinal() is true for every case except Pending, PickupRequested, PickedUp, and InTransit.

Adding your own courier

Register a custom driver:

Any driver just needs to implement AmdadulHaq\BdCourier\Contracts\CourierDriver:

Testing

Use CourierManager::fake() to swap the real courier with an in-memory fake and assert on what would have been booked, without dispatching anything or hitting the network:

Troubleshooting

Pathao: "Failed to issue an access token." Double-check PATHAO_USERNAME/PATHAO_PASSWORD (your Pathao Merchant Panel credentials, not a courier account PIN) and that PATHAO_BASE_URL matches your environment — the sandbox and production base URLs are different hosts, not just different credentials.

Steadfast / RedX / others: createShipment() throws a gateway error with no useful message Most of these couriers return a generic HTTP 4xx with the real reason buried in the JSON body. Catch AmdadulHaq\BdCourier\Exceptions\CourierException and inspect $exception->context — it holds the courier's raw decoded response.

A webhook route never fires handleWebhook() Make sure the route excludes Laravel's CSRF middleware (none of these couriers can obtain a CSRF token) and that you're passing the entire raw POST payload — $request->all() — since each driver looks for a specific ID field (consignment_id, tracking_id, tracking_number, etc.) that varies by courier.

"Nothing happens" in local development COURIER_DRIVER defaults to steadfast. If you're expecting a different courier, confirm .env actually sets COURIER_DRIVER and that you ran php artisan config:clear after changing it (cached config wins over .env).

Running the package's own test suite

License

MIT. See LICENSE.md.