https://github.com/developifynet/leopardscod-php
Leopards Courier COD (Cash on Delivery) API Wrapper for PHP
https://github.com/developifynet/leopardscod-php
api courier leopards leopards-cod leopards-cod-php leopards-courier leopards-courier-php leopards-php leopardscod leopardscourier leopardscourierphp package php sdk sdk-php
Last synced: 5 months ago
JSON representation
Leopards Courier COD (Cash on Delivery) API Wrapper for PHP
- Host: GitHub
- URL: https://github.com/developifynet/leopardscod-php
- Owner: developifynet
- License: mit
- Created: 2019-07-30T08:39:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-29T12:55:53.000Z (almost 2 years ago)
- Last Synced: 2025-05-28T02:06:25.864Z (5 months ago)
- Topics: api, courier, leopards, leopards-cod, leopards-cod-php, leopards-courier, leopards-courier-php, leopards-php, leopardscod, leopardscourier, leopardscourierphp, package, php, sdk, sdk-php
- Language: PHP
- Size: 8.79 KB
- Stars: 9
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Leopards Courier COD (Cash on Delivery) API Wrapper for PHP
This composer package offers quick booking packets via APIs on Leopards COD (Cash on Delivery) for your Laravel applications.
## Installation
Begin by pulling in the package through Composer.
```bash
composer require developifynet/leopardscod-php
```
## Laravel Framework Usage
Within your controllers, you can call LeopardsCOD facade and can send perform different operations.
### Set Credentials
```php
use \Developifynet\LeopardsCOD\LeopardsCOD;
public function index()
{
LeopardsCOD::setCredentials(array(
'api_key' => '', // API Key provided by LCS
'api_password' => '', // API Password provided by LCS
'enable_test_mode' => true, // [Optional] default value is 'false', true|false to set mode test or live
));
}
```
or setting up with data. See below endpoints where credentials are porvided within function data
### Get All Cities
```php
use \Developifynet\LeopardsCOD\LeopardsCOD;
public function index()
{
$response = LeopardsCOD::setCredentials(array(
'api_key' => '', // API Key provided by LCS
'api_password' => '', // API Password provided by LCS
'enable_test_mode' => true, // [Optional] default value is 'false', true|false to set mode test or live
))->getAllCities();
}
```
### Book a Packet
```php
use \Developifynet\LeopardsCOD\LeopardsCOD;
public function index()
{
$response = LeopardsCOD::setCredentials(array(
'api_key' => '', // API Key provided by LCS
'api_password' => '', // API Password provided by LCS
'enable_test_mode' => true, // [Optional] default value is 'false', true|false to set mode test or live
))->bookPacket(array(
'booked_packet_weight' => '200',
'booked_packet_vol_weight_w' => '',
'booked_packet_vol_weight_h' => '',
'booked_packet_vol_weight_l' => '',
'booked_packet_no_piece' => '1',
'booked_packet_collect_amount' => '1000',
'booked_packet_order_id' => '1001',
'origin_city' => 'string', /** Params: 'self' or 'integer_value' e.g. 'origin_city' => 'self' or 'origin_city' => 789 (where 789 is Lahore ID)
* If 'self' is used then Your City ID will be used.
* 'integer_value' provide integer value (for integer values read 'Get All Cities' api documentation)
*/
'destination_city' => 'string', /** Params: 'self' or 'integer_value' e.g. 'destination_city' => 'self' or 'destination_city' => 789 (where 789 is Lahore ID)
* If 'self' is used then Your City ID will be used.
* 'integer_value' provide integer value (for integer values read 'Get All Cities' api documentation)
*/
// Shipper Information
'shipment_name_eng' => 'self',
'shipment_email' => 'self',
'shipment_phone' => 'self',
'shipment_address' => 'self',
// Consingee Information
'consignment_name_eng' => 'John Doe',
'consignment_email' => 'johndoe@example.com',
'consignment_phone' => '+923330000000',
'consignment_address' => 'Test Address is used here',
'special_instructions' => 'n/a',
));
}
```
### Track Packet(s)
```php
use \Developifynet\LeopardsCOD\LeopardsCOD;
public function index()
{
$response = LeopardsCOD::setCredentials(array(
'api_key' => '', // API Key provided by LCS
'api_password' => '', // API Password provided by LCS
'enable_test_mode' => true, // [Optional] default value is 'false', true|false to set mode test or live
))->trackPacket(array(
'track_numbers' => 'LEXXXXXXXX', // E.g. 'XXYYYYYYYY' OR 'XXYYYYYYYY,XXYYYYYYYY,XXYYYYYY' 10 Digits each number
));
}
```
## Other Usage
Within your controllers, you can call LeopardsCODClient Object and call approperiate functions for your need.
You can set credentials in various ways. See below
### Set Credentials
```php
use \Developifynet\LeopardsCOD\LeopardsCODClient;
public function index()
{
$leopards = new LeopardsCODClient(array(
'api_key' => '', // API Key provided by LCS
'api_password' => '', // API Password provided by LCS
'enable_test_mode' => true, // [Optional] default value is 'false', true|false to set mode test or live
));
}
```
or using 'setCredentials'
```php
use \Developifynet\LeopardsCOD\LeopardsCODClient;
public function index()
{
$leopards = new LeopardsCODClient();
$leopards->setCredentials(array(
'api_key' => '', // API Key provided by LCS
'api_password' => '', // API Password provided by LCS
'enable_test_mode' => true, // [Optional] default value is 'false', true|false to set mode test or live
));
}
```
or setting up with data. See below endpoints where credentials are porvided within function data
### Get All Cities
```php
use \Developifynet\LeopardsCOD\LeopardsCODClient;
public function index()
{
$leopards = new LeopardsCODClient();
$response = $leopards->getAllCities(array(
'api_key' => '', // API Key provided by LCS
'api_password' => '', // API Password provided by LCS
'enable_test_mode' => true, // [Optional] default value is 'false', true|false to set mode test or live
));
}
```
### Book a Packet
```php
use \Developifynet\LeopardsCOD\LeopardsCODClient;
public function index()
{
$leopards = new LeopardsCODClient();
$response = $leopards->bookPacket(array(
'api_key' => '', // API Key provided by LCS
'api_password' => '', // API Password provided by LCS
'enable_test_mode' => true, // [Optional] default value is 'false', true|false to set mode test or live
'booked_packet_weight' => '200',
'booked_packet_vol_weight_w' => '',
'booked_packet_vol_weight_h' => '',
'booked_packet_vol_weight_l' => '',
'booked_packet_no_piece' => '1',
'booked_packet_collect_amount' => '1000',
'booked_packet_order_id' => '1001',
'origin_city' => 'string', /** Params: 'self' or 'integer_value' e.g. 'origin_city' => 'self' or 'origin_city' => 789 (where 789 is Lahore ID)
* If 'self' is used then Your City ID will be used.
* 'integer_value' provide integer value (for integer values read 'Get All Cities' api documentation)
*/
'destination_city' => 'string', /** Params: 'self' or 'integer_value' e.g. 'destination_city' => 'self' or 'destination_city' => 789 (where 789 is Lahore ID)
* If 'self' is used then Your City ID will be used.
* 'integer_value' provide integer value (for integer values read 'Get All Cities' api documentation)
*/
// Shipper Information
'shipment_name_eng' => 'self',
'shipment_email' => 'self',
'shipment_phone' => 'self',
'shipment_address' => 'self',
// Consingee Information
'consignment_name_eng' => 'John Doe',
'consignment_email' => 'johndoe@example.com',
'consignment_phone' => '+923330000000',
'consignment_address' => 'Test Address is used here',
'special_instructions' => 'n/a',
));
}
```
### Track Packet(s)
```php
use \Developifynet\LeopardsCOD\LeopardsCODClient;
public function index()
{
$leopards = new LeopardsCODClient();
$response = $leopards->trackPacket(array(
'api_key' => '', // API Key provided by LCS
'api_password' => '', // API Password provided by LCS
'enable_test_mode' => true, // [Optional] default value is 'false', true|false to set mode test or live
'track_numbers' => 'LEXXXXXXXX', // E.g. 'XXYYYYYYYY' OR 'XXYYYYYYYY,XXYYYYYYYY,XXYYYYYY' 10 Digits each number
));
}
```