PHPackages                             wqqas1/aramex - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. wqqas1/aramex

ActiveLibrary[Utility & Helpers](/categories/utility)

wqqas1/aramex
=============

Integrate Laravel project with Aramex.

0.8(1y ago)02MITPHPPHP >=7.1.0

Since Nov 8Pushed 1y agoCompare

[ Source](https://github.com/wqqas1/laravel-aramex)[ Packagist](https://packagist.org/packages/wqqas1/aramex)[ RSS](/packages/wqqas1-aramex/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (1)Versions (10)Used By (0)

Laravel Aramex
==============

[](#laravel-aramex)

Adds Aramex Functionality to your Laravel project.

This repo is a full rebuild of DigitalCloud/aramex.

Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [QuickStart](#quickstart)
    - [Location](#location)
        - [Fetch Countries](#fetch-countries)
        - [Fetch Country](#fetch-country)
        - [Fetch States](#fetch-states)
        - [Fetch Cities](#fetch-cities)
        - [Validate Address](#validate-address)
    - [Rate](#rate)
        - [Calculate Rate](#calculate-rate)
    - [Shipping](#shipping)
        - [Create Pickup](#create-pickup)
        - [Cancel Pickup](#cancel-Pickup)
        - [Create Shipments](#create-shipments)
        - [Get Last Shipments Numbers Range](#get-last-shipments-numbers-range)
        - [Print Label](#print-label)
        - [Reserve Shipment Number Range](#reserve-shipment-number-range)
        - [Schedule Delivery](#schedule-delivery)
    - [Tracking](#tracking)
        - [Track Pickup](#track-pickup)
        - [Track Shipments](#track-shipments)
- [Credits](#credits)

Installation
------------

[](#installation)

Run the following command to install the latest applicable version of the package:

```
composer require extremesa/aramex

```

You can publish the config-file with:

```
php artisan vendor:publish --provider="ExtremeSa\Aramex\AramexServiceProvider" --tag="config"

```

You can publish the resources files with:

```
php artisan vendor:publish --provider="ExtremeSa\Aramex\AramexServiceProvider" --tag="lang"

```

QuickStart
----------

[](#quickstart)

### Location

[](#location)

#### Fetch Countries

[](#fetch-countries)

This method allows users to get the world countries list.

```
Aramex::fetchCountries()->run();

```

#### Fetch Country

[](#fetch-country)

This method allows users to get details of a certain country.

```
Aramex::fetchCountry()
    ->setCode('PS')
    ->run();

```

#### Fetch States

[](#fetch-states)

This method allows users to get all the states within a certain country (country code).

```
Aramex::fetchStates()
    ->setCountryCode('AE')
    ->run();

```

#### Fetch Cities

[](#fetch-cities)

This method allows users to get all the cities within a certain country (country code). And allows users to get list of the cities that start with a specific prefix. The required nodes to be filled are Client Info and Country Code.

```
Aramex::fetchCities()
    ->setCountryCode('AE')
    ->run();

```

#### Validate Address

[](#validate-address)

This method Allows users to search for certain addresses and make sure that the address structure is correct.

```
Aramex::validateAddress()
    ->setAddress(
        (new Address()) ...
    )->run();

```

### Rate

[](#rate)

#### Calculate Rate

[](#calculate-rate)

This method allows users to get rate for source/destinations shipment.

```
$source = (new Address()) ... ;

$destination = (new Address()) ...;

$details = (new ShipmentDetails()) ...;

Aramex::calculateRate()
    ->setOriginalAddress($source)
    ->setDestinationAddress($destination)
    ->setShipmentDetails($details)
    ->setPreferredCurrencyCode('USD')
    ->run();

```

### Shipping

[](#shipping)

#### Create Pickup

[](#create-pickup)

This method allows users to create a pickup request.

```
$source = (new Address());

$contact = (new Contact());

$pickupItem = (new PickupItem());

$pickup = (new Pickup())
    ->setPickupAddress($source)
    ->setPickupContact($contact)
    ->setPickupLocation('Reception')
    ->setPickupDate(Carbon::now()->timestamp)
    ->setReadyTime(Carbon::now()->timestamp)
    ->setLastPickupTime(Carbon::now()->addDay()->timestamp)
    ->setClosingTime(Carbon::now()->addDay()->timestamp)
    ->setStatus('Pending')
    ->setReference1('')
    ->addPickupItem($pickupItem);

$labelInfo = (new LabelInfo())
    ->setReportId(9201)
    ->setReportType('URL');

Aramex::createPickup()
    ->setLabelInfo($labelInfo)
    ->setPickup($pickup)
    ->run();

```

#### Cancel Pickup

[](#cancel-pickup)

This method allows you to cancel a pickup as long as it is un-assigned or pending details.

```
Aramex::cancelPickup()
    ->setPickupGUID('PICKUP_GUID')
    ->run();

```

#### Create Shipments

[](#create-shipments)

This method allows users to create shipments on Aramex’s system.

```
Aramex::createShipments()->run();

```

#### Get Last Shipments Numbers Range

[](#get-last-shipments-numbers-range)

This method allows you to inquire about the last reserved range using a specific entity and product group

```
Aramex::getLastShipmentsNumbersRange()
    ->setEntity('ENTITY')
    ->setProductGroup('PRODUCT_GROUP')
    ->run();

```

#### Print Label

[](#print-label)

This method allows the user to print a label for an existing shipment.

```
$labelInfo = (new \ExtremeSa\Aramex\API\Classes\LabelInfo())
    ->setReportId(9201)
    ->setReportType('URL');

Aramex::printLabel()
    ->setShipmentNumber('SHIPMENT_NO')
    ->setLabelInfo()
    ->run();

```

#### Reserve Shipment Number Range

[](#reserve-shipment-number-range)

This method allows you to reserve a range of shipment numbers.

```
Aramex::reserveShipmentNumberRange()->run();

```

#### Schedule Delivery

[](#schedule-delivery)

This method allows you to schedule the delivery of a shipment at a specified time and place (Longitude and Latitude)

```
Aramex::scheduleDelivery()->run();

```

### Tracking

[](#tracking)

#### Track Pickup

[](#track-pickup)

This method allows the user to track an existing pickup’s updates and latest status.

```
Aramex::trackPickup()
    ->setReference('PICKUP_NO')
    ->setPickup('PICKUP') // any number
    ->run();

```

#### Track Shipments

[](#track-shipments)

This method allows the user to track an existing shipment’s updates and latest status.

```
Aramex::trackShipments()
    ->setShipments(['SHIPMENT_NO'])
    ->run();

```

Credits
-------

[](#credits)

- [Ismail Ashour](https://github.com/drashoor/)
- All Contributors

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance42

Moderate activity, may be stable

Popularity2

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 92.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~236 days

Recently: every ~472 days

Total

9

Last Release

484d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c3ce052151f525a84914d77a4ebab24512ae4cd56131f0006fdda8ec84417af1?d=identicon)[wqqas](/maintainers/wqqas)

---

Top Contributors

[![IsmailAshour](https://avatars.githubusercontent.com/u/6551562?v=4)](https://github.com/IsmailAshour "IsmailAshour (24 commits)")[![wqqas1](https://avatars.githubusercontent.com/u/20567910?v=4)](https://github.com/wqqas1 "wqqas1 (2 commits)")

### Embed Badge

![Health badge](/badges/wqqas1-aramex/health.svg)

```
[![Health](https://phpackages.com/badges/wqqas1-aramex/health.svg)](https://phpackages.com/packages/wqqas1-aramex)
```

###  Alternatives

[wireui/wireui

TallStack components

1.8k1.3M16](/packages/wireui-wireui)[livewire/volt

An elegantly crafted functional API for Laravel Livewire.

4195.3M84](/packages/livewire-volt)[ramonrietdijk/livewire-tables

Dynamic tables for models with Laravel Livewire

21147.4k](/packages/ramonrietdijk-livewire-tables)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)