Skip to content

Latest commit

 

History

History
98 lines (74 loc) · 2.96 KB

README.md

File metadata and controls

98 lines (74 loc) · 2.96 KB
Raw

laravel-ups

Latest Version on Packagist Tests Total Downloads

This package acts as an api wrapper for the UPS Api. Currently this package allows you to validate addresses, create shipments, void shipments, recover labels, and track shipments. Before using this package, you should have at least a basic understanding of the UPS Api.

Installation

You can install the package via composer:

composer require rawilk/laravel-ups

You can publish the config file with:

php artisan vendor:publish --provider="Rawilk\Ups\UpsServiceProvider" --tag="config"

This is the contents of the published config file:

return [
    /*
    |--------------------------------------------------------------------------
    | Credentials
    |--------------------------------------------------------------------------
    |
    | Here are the credentials needed when making requests through the
    } the UPS api.
    |
    */
    'access_key' => env('UPS_ACCESS_KEY'),
    'user_id' => env('UPS_USER_ID'),
    'password' => env('UPS_PASSWORD'),
    'shipper_number' => env('UPS_SHIPPER_NUMBER'),
    'negotiated_rates' => env('UPS_NEGOTIATED_RATES', false),

    /*
    |--------------------------------------------------------------------------
    | Sandbox
    |--------------------------------------------------------------------------
    |
    | Enabling "sandbox" mode instructs the package to send any api requests
    | to the customer integrated environment (testing environment) instead
    | of the production api, with the exception of the address validation
    | api.
    |
    */
    'sandbox' => env('UPS_SANDBOX', true),

    /*
    |--------------------------------------------------------------------------
    | Logging
    |--------------------------------------------------------------------------
    |
    | Enable/Disable logging when requests are made and received
    | through the UPS api.
    |
    */
    'logging' => env('UPS_LOGGING', false),
];

Documentation

For documentation, please visit: https://randallwilk.dev/docs/laravel-ups.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

Please review my security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.