PHPackages                             donotcarry/shipengine - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. donotcarry/shipengine

ActiveLibrary[API Development](/categories/api)

donotcarry/shipengine
=====================

PHP library for the ShipEngine API.

1.0.0(1y ago)0435↓100%Apache-2.0PHPPHP >=7.4

Since Dec 16Pushed 1y agoCompare

[ Source](https://github.com/DoNotCarry/shipengine-php)[ Packagist](https://packagist.org/packages/donotcarry/shipengine)[ Docs](https://github.com/ShipEngine/shipengine-php)[ RSS](/packages/donotcarry-shipengine/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (21)Versions (2)Used By (0)

[![ShipEngine](https://camo.githubusercontent.com/bee7dc79c7997c147248759794ba013aacbbd37cba4a79173eecff6ed1075243/68747470733a2f2f73686970656e67696e652e6769746875622e696f2f696d672f73686970656e67696e652d6c6f676f2d776964652e706e67)](https://shipengine.com)

ShipEngine PHP
==============

[](#shipengine-php)

[![Build Status](https://github.com/ShipEngine/shipengine-php/workflows/shipengine-php/badge.svg)](https://github.com/ShipEngine/shipengine-php/actions)[![Coverage Status](https://camo.githubusercontent.com/23ceb04fa5766fa795b421e6a0457081e4b5d9becceb121d783e36ae5e915e6a/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f53686970456e67696e652f73686970656e67696e652d7068702f62616467652e7376673f6272616e63683d6d61696e26743d536b58714945)](https://coveralls.io/github/ShipEngine/shipengine-php?branch=main)[![Latest Version](https://camo.githubusercontent.com/606b70582de1738f1a38fe8cd85948a6deb228712974a87e5b3579a7a20d76b0/68747470733a2f2f706f7365722e707567782e6f72672f73686970656e67696e652f73686970656e67696e652f76)](//packagist.org/packages/shipengine/shipengine)[![License](https://camo.githubusercontent.com/1e5b9b9749ebc96bd384eb01061d29c420484df10a6698f6527d87024a39ebc0/68747470733a2f2f706f7365722e707567782e6f72672f73686970656e67696e652f73686970656e67696e652f6c6963656e7365)](//packagist.org/packages/shipengine/shipengine)[![OS Compatibility](https://camo.githubusercontent.com/5c442debb0825412c17ee2627659101f503501a30bafb8f55f20ef4acf75e4b4/68747470733a2f2f73686970656e67696e652e6769746875622e696f2f696d672f6261646765732f6f732d6261646765732e737667)](https://camo.githubusercontent.com/5c442debb0825412c17ee2627659101f503501a30bafb8f55f20ef4acf75e4b4/68747470733a2f2f73686970656e67696e652e6769746875622e696f2f696d672f6261646765732f6f732d6261646765732e737667)

A PHP library built on the [ShipEngine API](https://shipengine.com) offering low-level access as well as convenience methods.

**Table of Contents**

- [Quick Start](#quick-start)
- [Examples](#examples)
    - [Methods](#methods)
    - [Class Objects](#class-objects)
    - [Instantiate ShipEngine Class](#instantiate-shipengine-class)
- [Testing](#testing)
- [Linting](#linting)
- [Contributing](#contributing)

Quick Start
===========

[](#quick-start)

Install ShipEngine via [Composer](https://getcomposer.org/):

```
composer require shipengine/shipengine
```

- The only configuration requirement is an [API Key](https://www.shipengine.com/docs/auth/#api-keys).

> The following example assumes that you have already set the `SHIPENGINE_API_KEY` environment variable with your Api Key using `putenv()`.

Examples
========

[](#examples)

Methods
-------

[](#methods)

- [validateAddress](./docs/addressValidateExample.md "Validate Address method documentation") - Indicates whether the provided address is valid. If the address is valid, the method returns a normalized version of the address based on the standards of the country in which the address resides.
- [normalizeAddress](./docs/normalizeAddressExample.md "Normalize Address method documentation") - Returns a normalized, or standardized, version of the address. If the address cannot be normalized, an error is returned.
- [trackPackage](./docs/trackPackageExample.md "Track Package method documentation") - Track a package by `packageId` or by `carrierCode` and `trackingNumber`. This method returns the all tracking events for a given shipment.

Class Objects
-------------

[](#class-objects)

- ShipEngine - A configurable entry point to the ShipEngine API SDK, this class provides convenience methods for various ShipEngine API Services.

Instantiate ShipEngine Class
----------------------------

[](#instantiate-shipengine-class)

```