{"id":18649952,"url":"https://github.com/bkuhl/simple-ups","last_synced_at":"2025-09-11T10:37:37.609Z","repository":{"id":62494853,"uuid":"21111729","full_name":"bkuhl/simple-ups","owner":"bkuhl","description":"Fetch rates, track packages and verify addresses via the UPS API","archived":false,"fork":false,"pushed_at":"2016-06-02T16:37:45.000Z","size":80,"stargazers_count":15,"open_issues_count":2,"forks_count":11,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-07-23T17:24:06.495Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bkuhl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-23T02:36:39.000Z","updated_at":"2020-02-11T04:49:59.000Z","dependencies_parsed_at":"2022-11-02T11:45:29.031Z","dependency_job_id":null,"html_url":"https://github.com/bkuhl/simple-ups","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/bkuhl/simple-ups","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhl%2Fsimple-ups","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhl%2Fsimple-ups/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhl%2Fsimple-ups/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhl%2Fsimple-ups/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bkuhl","download_url":"https://codeload.github.com/bkuhl/simple-ups/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhl%2Fsimple-ups/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270149345,"owners_count":24535728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-12T02:00:09.011Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T06:41:53.288Z","updated_at":"2025-08-12T23:08:23.946Z","avatar_url":"https://github.com/bkuhl.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SimpleUPS\n\nAn easy to use PHP UPS Library for tracking, rates and address validation\n\n[![Total Downloads](https://poser.pugx.org/bkuhl/simple-ups/downloads.svg)](https://packagist.org/packages/bkuhl/simple-ups) [![License](https://poser.pugx.org/bkuhl/simple-ups/license.svg)](https://packagist.org/packages/bkuhl/simple-ups) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bkuhl/simple-ups/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/bkuhl/simple-ups/?branch=master)\n\n## README Contents\n\n* [Features](#features)\n* [Installation](#installation)\n* [Requirements](#requirements)\n* [Usage](#usage)\n  * [Address Validation](#address-validation)\n  * [Region Validation](#region-validation)\n  * [Tracking Shipments](#tracking-shiments)\n  * [Fetching Rates](#fetching-rates)\n\n\u003ca name=\"features\" /\u003e\n## Features\n\n * **Address Validation** - Ensure an address is valid before it's accepted by your application\n * **Address Correction** - If an address is invalid, we'll help you correct it\n * **Track Packages** - See current status, recent activity, delivery requirements (signature, etc.), insurance details and more\n * **Shipping Rates** - Get shipping estimates for packages\n\n\u003ca name=\"installation\" /\u003e\n## Installation\n\nYou can install the library via [Composer](http://getcomposer.org) by running:\n\n````\ncomposer require bkuhl/simple-ups:1.*\n````\n\n \u003e 1.* versions will maintain PHP 5.3 compatibility.  `dev-master` will increase the PHP version requirement for future, 2.* versions.\n\n\u003ca name=\"usage\" /\u003e\n## Usage\n\nSimpleUPS is currently only available in a static context with the following methods:\n\n * SimpleUPS::getRates()\n * SimpleUPS::isValidRegion()\n * SimpleUPS::getSuggestedRegions()\n * SimpleUPS::trackByTrackingNumber()\n * SimpleUPS::isValidAddress()\n * SimpleUPS::getCorrectedAddress()\n * SimpleUPS::getSuggestedAddresses()\n * SimpleUPS::setAuthentication()\n * SimpleUPS::getAccountNumber()\n * SimpleUPS::getAccessLicenseNumber()\n * SimpleUPS::getPassword()\n * SimpleUPS::getUserId()\n * SimpleUPS::setShipper()\n * SimpleUPS::getShipper()\n * SimpleUPS::setCurrencyCode()\n * SimpleUPS::setDebug()\n * SimpleUPS::getDebugOutput()\n\n\u003ca name=\"address-validation\" /\u003e\n### Address Validation\n\nValidating an address can be useful to ensure an address that a user provides can be shipped to.\n\n```php\n$address = new Address();\n$address-\u003esetStreet('1001 North Alameda Street');\n$address-\u003esetStateProvinceCode('CA');\n$address-\u003esetCity('Los Angeles');\n$address-\u003esetPostalCode(90012);\n$address-\u003esetCountryCode('US');\n \ntry {\n    var_dump(UPS::isValidAddress($address)); // true\n} catch(Exception $e) {\n    //unable to validate address\n}\n```\n\n\u003ca name=\"region-validation\" /\u003e\n### Region Validation\n\nIf an address fails, validating the region can help you determine if the city, state and zip is valid even if the street address isn't.\n\n```php\n$address = new Address();\n$address-\u003esetStreet('xx North Alameda Street');\n$address-\u003esetStateProvinceCode('CA');\n$address-\u003esetCity('Los Angeles');\n$address-\u003esetPostalCode(90012);\n$address-\u003esetCountryCode('US');\n \ntry {\n    if (!UPS::isValidAddress($address))\n        var_dump(UPS::isValidRegion($address)); // true\n} catch(Exception $e) {\n    //unable to validate region or address\n}\n```\n\n\u003ca name=\"tracking-shipments\" /\u003e\n### Tracking Shipments\n\nTracking numbers may contain multiple shipments, and shipments may contain multiple packages, and activity is associated with packages.\n\n```php\ntry {\n    /* @var $shipment \\SimpleUPS\\Track\\SmallPackage\\Shipment */\n    foreach (UPS::trackByTrackingNumber('1Z4861WWE194914215') as $shipment)\n        foreach ($shipment-\u003egetPackages() as $package)\n            foreach ($package-\u003egetActivity() as $activity)\n                if ($activity-\u003egetStatusType()-\u003eisDelivered())\n                    echo 'DELIVERED';\n} catch (TrackingNumberNotFoundException $e) {\n    //Tracking number does not exist\n} catch (Exception $e) {\n    //Unable to track package\n}\n \nvar_dump(UPS::isValidAddress($address)); // false\n```\n\n\u003ca name=\"fetching-rates\" /\u003e\n### Fetching Rates\n\n```php\ntry {\n    //set shipper\n    $fromAddress = new \\SimpleUPS\\InstructionalAddress();\n    $fromAddress-\u003esetAddressee('Mark Stevens');\n    $fromAddress-\u003esetStreet('10571 Pico Blvd');\n    $fromAddress-\u003esetStateProvinceCode('CA');\n    $fromAddress-\u003esetCity('Los Angeles');\n    $fromAddress-\u003esetPostalCode(90064);\n    $fromAddress-\u003esetCountryCode('US');\n \n    $shipper = new \\SimpleUPS\\Shipper();\n    $shipper-\u003esetNumber('xxxxxxx');\n    $shipper-\u003esetAddress($fromAddress);\n \n    UPS::setShipper($shipper);\n \n    //define a shipping destination\n    $shippingDestination = new \\SimpleUPS\\InstructionalAddress();\n    $shippingDestination-\u003esetStreet('220 Bowery');\n    $shippingDestination-\u003esetStateProvinceCode('NY');\n    $shippingDestination-\u003esetCity('New York');\n    $shippingDestination-\u003esetPostalCode(10453);\n    $shippingDestination-\u003esetCountryCode('US');\n \n    //define a package, we could specify the dimensions of the box if we wanted a more accurate estimate\n    $package = new \\SimpleUPS\\Rates\\Package();\n    $package-\u003esetWeight('7');\n \n    $shipment = new \\SimpleUPS\\Rates\\Shipment();\n    $shipment-\u003esetDestination($shippingDestination);\n    $shipment-\u003eaddPackage($package);\n \n    echo 'Rates: ';\n \n    echo '\u003cul\u003e';\n        foreach (UPS::getRates($shipment) as $shippingMethod)\n            echo '\u003cli\u003e'.$shippingMethod-\u003egetService()-\u003egetDescription().' ($'.$shippingMethod-\u003egetTotalCharges().')\u003c/li\u003e';\n \n    echo '\u003c/ul\u003e';\n \n} catch (Exception $e) {\n    //doh, something went wrong\n    echo 'Failed: ('.get_class($e).') '.$e-\u003egetMessage().'\u003cbr/\u003e';\n    echo 'Stack trace:\u003cbr/\u003e\u003cpre\u003e'.$e-\u003egetTraceAsString().'\u003c/pre\u003e';\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkuhl%2Fsimple-ups","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbkuhl%2Fsimple-ups","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkuhl%2Fsimple-ups/lists"}