wheesnoza/laravel-ship24

A Ship24 API Rapper for Laravel.

1.0.4 2024-08-31 02:44 UTC

Requires

• php: ^8.0
• illuminate/contracts: ^10.0|^11.0
• spatie/laravel-data: ^4.8

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.63
• orchestra/testbench: ^9.4
• phpstan/phpstan: ^1.12
• phpunit/phpunit: ^11.3

MIT

• wheesnoza

• package
• api
• laravel
• tracking
• ship24

README

Laravel Ship24 is a powerful package that integrates the Ship24 API seamlessly into your Laravel application. With this package, you can easily track shipments, create new trackers, and manage your tracking information.

Features

• Easy Installation: Quickly set up and integrate the Ship24 API.
• API Integration: Full support for Ship24's tracking API.
• Extensible: Customize and extend the package according to your needs.
• Compatible with Laravel 10 and 11: Works with the latest versions of Laravel.

Installation

You can install the package via Composer:

composer require wheesnoza/laravel-ship24

After installing, you may publish the configuration file:

php artisan vendor:publish --provider="Wheesnoza\Ship24\Providers\Ship24ServiceProvider" --tag=config

Configuration

The package requires an API token, which you should add to your .env file:

SHIP24_ACCESS_TOKEN=your-access-token

Usage

Retrieve a Tracker by ID

use Wheesnoza\Ship24\Facades\Ship24;

$tracker = Ship24::tracker('TRACKER_ID');

Retrieve Multiple Trackers

use Wheesnoza\Ship24\Facades\Ship24;

$trackers = Ship24::trackers();

Create a New Tracker

use Wheesnoza\Ship24\Facades\Ship24;

$tracker = Ship24::createTracker('TRACKING_NUMBER');

Testing

To run the tests, execute the following command:

composer test

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue on GitHub.

License

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