Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rgodiyal authored May 10, 2024
1 parent 48691b3 commit d0b62f5
Showing 1 changed file with 31 additions and 5 deletions.
36 changes: 31 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,34 @@

Latest OAuth 2.0 Rest API Wrapper for UPS web services.

## Table Of Content

1. [Requirements](#requirements)
2. [Installation](#installation)
3. [Address Validation](#addressvalidation)
4. [Create Shipment | Shipping Label](#create-shipment)
5. [Tracking API](#tracking)
6. [Documentation](#api-docs)
7. [License](#license-section)

<a name="requirements"></a>
## Requirements

This library uses PHP 7.4+.

To integrate with the UPS API using OAuth 2.0 authentication, you'll need to [obtain a Client ID and Client Secret from UPS](https://developer.ups.com). These credentials must be included with each API request you make.

<a name="installation"></a>
## Installation

Install with composer

```bash
composer require rahul-godiyal/php-ups-api-wrapper
```

## Usage/Examples

UPS Address Validation
<a name="addressvalidation"></a>
## Address Validation
```php
<?php

Expand Down Expand Up @@ -46,7 +60,8 @@ die();

```

Create Shipment | Shipping Label
<a name="create-shipment"></a>
## Create Shipment | Shipping Label
```php
<?php

Expand Down Expand Up @@ -248,7 +263,9 @@ echo '<pre>'; print_r($shipRes); echo '</pre>';
</html>

```
Tracking API

<a name="tracking"></a>
## Tracking API
```php
<?php

Expand All @@ -268,3 +285,12 @@ echo '</pre>';
die();
```

<a name="api-docs"></a>
## Documentation
[UPS API docs](https://developer.ups.com/catalog)


<a name="license-section"></a>
## License

PHP UPS API is licensed under [The MIT License (MIT)](LICENSE).

0 comments on commit d0b62f5

Please sign in to comment.