PHPackages                             mdeschermeier/shiphero - 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. mdeschermeier/shiphero

ActiveLibrary

mdeschermeier/shiphero
======================

1.1.2(9y ago)71.0k2MITPHP

Since Nov 2Pushed 9y ago2 watchersCompare

[ Source](https://github.com/mdeschermeier/Shiphero)[ Packagist](https://packagist.org/packages/mdeschermeier/shiphero)[ RSS](/packages/mdeschermeier-shiphero/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)DependenciesVersions (3)Used By (0)

Shiphero
========

[](#shiphero)

Simple PHP Wrapper for the Shiphero API

***IMPORTANT: I am not currently, nor previously have been, affiliated with Shiphero or any of Shiphero's professional associates. This wrapper is purely my own work and carries no endorsements other than my own.***

Installation
------------

[](#installation)

The easiest way to install this package is via composer. Use the following to install this package: `composer require mdeschermeier/shiphero`

Alternatively, these files can be downloaded and stored for use in any location you see fit, so long as `Shiphero.php` and `Shiphero_const.php` remain in the same directory.

Introduction
------------

[](#introduction)

This is a *bare-bones* wrapper for Shiphero's REST API. While fully capable of interacting with the Shiphero interface, please note that most methods require multi-dimensional associative arrays that mimic the structure of the JSON objects that ultimately get passed into cURL.

Be sure to [look at Shiphero's API Documentation](http://docs.shipheropublic.apiary.io/#) in order to understand how to structure your arrays and format your data.

Examples are provided to assist you with understanding this wrapper, ***but it is not a replacement for understanding the actual API documentation***.

This wrapper will handle all required cURL functions and JSON encoding/decoding. In the event that additional cURL options need to be modified, a method is provided to [accomodate this need](#shipherosetadditionalcurloptopt-val). Additionally, once the API Key is set via `Shiphero::setKey($k)`, the `'token' => ''` element of the arrays passed into the various methods of the wrapper will not be required and should be omitted from the arrays.

Table of Contents
-----------------

[](#table-of-contents)

##### [Set Up](#set-up)

[](#set-up)

##### [Product](#products)

[](#product)

##### [Order](#orders)

[](#order)

##### [Vendor](#vendors)

[](#vendor)

##### [Fulfillment Status](#fulfillment-statuses)

[](#fulfillment-status)

##### [Purchase Order](#purchase-orders)

[](#purchase-order)

##### [Shipment](#shipments)

[](#shipment)

##### [Webhook](#webhooks)

[](#webhook)

##### [Contact](#contact-me)

[](#contact)

Set Up
------

[](#set-up-1)

### Shiphero::setKey($k) - ***Required***

[](#shipherosetkeyk---required)

**Parameters:** $k *string*

This method sets the variable that holds your API Key. *This method MUST be executed prior to making API calls!*

```
Shiphero::setKey('');
```

### Shiphero::verifyPeer($b)

[](#shipheroverifypeerb)

**Parameters:** $b *bool*

Toggle Host/Peer verification on cURL requests. Can be toggled as needed. *set to true by default*

```
Shiphero::verifyPeer(true); //Enables Host/Peer Verification

    /*==== or ====*/

Shiphero::verifyPeer(false); //Disables Host/Peer Verification
```

### Shiphero::setAdditionalCurlOpt($opt, $val)

[](#shipherosetadditionalcurloptopt-val)

**Parameters:** $opt *const*, $val *mixed*

In the event that additional cURL options need to be configured with your requests, they can be set via this method. *NOTE: CURLOPT\_POST, CURLOPT\_HTTPHEADER, and CURLOPT\_POSTFIELDS are blacklisted and will NOT be modified!*

```
Shiphero::setAdditionalCurlOpt(CURLOPT_VERBOSE, true);
```

### Shiphero::preserveAdditionalCurlOpt($b)

[](#shipheropreserveadditionalcurloptb)

**Parameters:** $b *bool*

If you need cURL to remember your options for concurrent requests, this method will allow for it. Once passed a true value, the Shiphero class will remember your cURL option settings for each request until this method is passed a false value. *Default setting is false*

```
Shiphero::setAdditionalCurlOpt(CURLOPT_VERBOSE, true); // - set a custom cURL option for next API request.

Shiphero::preserveAdditionalCurlOpt(true); // - Will remember cURL option settings until turned off

//send some requests
Shiphero::getOrderById(383484); // - cURL options remembered (CURLOPT_VERBOSE = true)
Shiphero::getProducts();        // - cURL options remembered (CURLOPT_VERBOSE = true)

Shiphero::preserveAdditionalCurlOpt(false); //Turn off cURL option rememberance and clear out stored values.

Shiphero::getVendorList(): // - Request ran with default options (CURLOPT_VERBOSE = false)
```

Products
--------

[](#products)

### Shiphero::getProduct($prod = null)

[](#shipherogetproductprod--null)

**Parameters:** $prod *array* - *optional*

Query the API for product information. This method handles both the retrieval of a single product (by sku) and the retrieval of *all* items using default settings.

```
$prod = array('sku' => 12345);
$response = Shiphero::getProduct($prod) // - Get one item.

$prod = array('page'=>2, 'count'=>150);
$response = Shiphero::getProduct($prod); // - Of all items, return second page, limit 150 items per page.

$response = Shiphero::getProduct(); // - Get all items, no paging (returns the first 50 products).
```

### Shiphero::createProduct($sku, $prod, $type = 'simple')

[](#shipherocreateproductsku-prod-type--simple)

**Parameters:** $sku *string*, $prod *array*, $type *string - default "simple"*

Given a sku and an array containing product information, this method will create a product. There are two types of products: `simple` and `configurable`. Configurable is generally used for creating products with variants. This method uses the `$type` parameter to distinguish between the two. Defaults to `simple`.

```
$sku = 'abc-123';
$product =  array('title'=>'Sample Item Name', 'available_inventory'=>500, 'value'=>5.00, 'price'=>5000.00,
            'images'=> array(
                   array('url' => 'http://made.up.domain.com/super_rad_product.png',
                   'position' => 1),
                   array('url' => 'http://another.made.up.domain.co.uk/more-rad-product.jpg',
                   'position' => 2)
             ));

Shiphero::createProduct($sku, $product); // - Create the simple product.
```

To create a Configurable Product (a product with Variants), the same structure for the `$product` array should be followed. [Please see the API documentation](http://docs.shipheropublic.apiary.io/#reference/products/create-product/create-and-update-product-with-variants) for a complete list of parameters that can be set.

### Shiphero::addProductToUpdateQueue($prod)

[](#shipheroaddproducttoupdatequeueprod)

**Parameters:** $prod *array*

This method will add a product to the Product Inventory Update Queue. When used in conjunction with `Shiphero::updateInventory()`, basic product information can be updated. [Please see the API documentation](http://docs.shipheropublic.apiary.io/#reference/products/update-inventory/update-product-inventory) for a complete list of parameters that can be set.

```
$product_1 = array('sku'=>'abc-123', 'quantity'=> -2, 'warehouse'=>'Secondary', 'width'=>'2.5');
Shiphero::addProductToUpdateQueue($product_1);

//Product Inventory Update Queue Contains: $product_1

$product_2 = array('sku'=>'def-456', 'new_quantity'=>200);
Shiphero::adddProductToUpdateInventoryQueue($product_2);

//Product Inventory Update Queue Now Contains: $product_1, $product_2
```

### Shiphero::updateInventory()

[](#shipheroupdateinventory)

**Parameters:**

This method will update the inventory of all products in the Product Inventory Update Queue. This method will then empty the Product Inventory Update Queue.

```
// Define Product Update Information
$product_1 = array('sku'=>'abc-123', 'quantity'=> -2, 'warehouse'=>'Secondary', 'width'=>'2.5');
$product_2 = array('sku'=>'def-456', 'new_quantity'=>200);

//Add Products to Update Queue
Shiphero::addProductToUpdateQueue($product_1);
Shiphero::addProductToUpdateQueue($product_2);

//Update Products in Queue
Shiphero::updateInventory();
```

### Shiphero::addKitToCreationQueue($kit)

[](#shipheroaddkittocreationqueuekit)

**Parameters:** $kit *array*

Add a kit to the Kit Creation Queue. Used in conjunction with `Shiphero::createKits()`.

```
$kit = array(
            'parent_sku' => 'kit-sku-123',
            'components' => array(
	    			array(
                                 'sku'=>'product_1-sku-123',
                                 'qty'=> 3
                            	),
                            	array(
                                 'sku'=>'product_2-sku-456',
                                 'qty'=>1
                            	)
			    )
            );

Shiphero::addKitToCreationQueue($kit);

//Kit Creation Queue Contains: $kit (3 of 'product_1-sku-123, 1 of 'product_2-sku-456')

$another_kit = array(
            'parent_sku' => 'kit-sku-456',
            'components' => array(
	    			array(
                                 'sku'=>'product_1-sku-123',
                                 'qty'=> 10
                            	),
                            	array(
                                 'sku'=>'product_2-sku-456',
                                 'qty'=>3
                            	)
			   )
            );

Shiphero::addKitToCreationQueue($another_kit);

//Kit Creation Queue Contains: $kit (3 of 'product_1-sku-123, 1 of 'product_2-sku-456')
//                             $another_kit (10 of 'product_1-sku-123, 3 of 'product_2-sku-456')
```

### Shiphero::createKits()

[](#shipherocreatekits)

**Parameters:**

Creates a kit for each kit in the Kit Creation Queue. Clears Kit Creation Queue when finished. Example below continued from [Shiphero::addKitToCreationQueue($kit) Example](#shipheroaddkittocreationqueuekit).

```
//Kit Creation Queue Contains: $kit (3 of 'product_1-sku-123, 1 of 'product_2-sku-456')
//                             $another_kit (10 of 'product_1-sku-123, 3 of 'product_2-sku-456')

Shiphero::createKits();  // - Kits are now created in Shiphero.

//Kit Creation Queue Contains: Nothing (empty)
```

### Shiphero::addToRemoveKitComponentQueue($kit\_sku, $component\_skus)

[](#shipheroaddtoremovekitcomponentqueuekit_sku-component_skus)

**Parameters:** $kit\_sku *string*, $component\_skus *array*

Adds a component or list of components to be removed from a kit. `$kit_sku` is the sku of the kit you want to remove components from. `$component_skus` is an array of component skus.

```
// Kit 1 (sku 'abc-123') Components (skus): p-123, p-456, p-789
// Kit 2 (sku 'def-456') Components (skus): p-456, p-111, p-222

// - Queue Removal of Item Skus 'p-456' and 'p-789' from Kit 1
Shiphero::addToRemoveKitComponentQueue('abc-123', array('p-456', 'p-789'));

// - Queue Removal of Item Sku 'p-111' from Kit 2
Shiphero::addToRemoveKitComponentQueue('def-456', array('p-111'));
```

### Shiphero::removeKitComponents()

[](#shipheroremovekitcomponents)

**Parameters:**

Removes queued items from specified kits. Queue is cleared when this method is finished. The example below assumes a continuation of the [Shiphero::addToRemoveKitComponentQueue($kit\_sku, $component\_skus) Example](#shipheroaddtoremovekitcomponentqueuekit_sku-component_skus)

```
// Kit 1 (sku 'abc-123') Components (skus): p-123, p-456, p-789
// Kit 2 (sku 'def-456') Components (skus): p-456, p-111, p-222

//Removal Queue:
//      Kit 1: p-456, p-789
//      Kit 2: p-111

Shiphero::removeKitComponents();

// Kit 1 (sku 'abc-123') Components (skus): p-123
// Kit 2 (sku 'def-456') Components (skus): p-456, p-222

//Removal Queue:
//      Nothing (empty)
```

### Shiphero::clearKit($sku)

[](#shipheroclearkitsku)

**Parameters:** $sku *string*

This method removes all components from a kit, given the kit's sku.

```
// Kit 1 (sku 'abc-123') Components (skus): p-123, p-456, p-789

Shiphero::clearKit('abc-123');

// Kit 1 (sku 'abc-123') Components (skus): Nothing (empty)
```

Orders
------

[](#orders)

### Shiphero::getOrders($filter, $all\_stores=0)

[](#shipherogetordersfilter-all_stores0)

**Parameters:** $filter *array*, $all\_stores *int*

Returns all orders that fit the parameters set in the `$filter` array. Setting `$all_stores` to `1` will return all orders associated with the current Shiphero account. Setting `$all_stores` to `0` will only return orders associated with the store tied to the API Key being used. *Default `$all_stores` value is `0`.*

Please see the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/orders/get-orders/get-orders) for more information on the parameters being set in the `$filter` array.

```
$filter = array('page'=>1, 'from'=>'2016-9-1', 'to'=>'2016-9-28');

//Return all orders matching filter for current store
Shiphero::getOrders($filter)

//return all orders matching filter for ALL stores
Shiphero::getOrders($filter, 1);
```

### Shiphero::getOrderById($id)

[](#shipherogetorderbyidid)

**Parameters:** $id *string*

Return an order by ID.

```
//Returns order with ID: 12345
Shiphero::getOrderById('12345');
```

### Shiphero::getOrder($order\_num)

[](#shipherogetorderorder_num)

**Parameters:** $order\_num *string*

Return an order by order number.

```
//Returns order number: 427895-Fri-1
Shiphero::getOrder('427895-Fri-1');
```

### Shiphero::createOrder($order)

[](#shipherocreateorderorder)

**Parameters:** $order *array*

This method creates an order. Due to the size of the array needing to be passed in, please see the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/orders/create-order/create-order) for a detailed list of all required and optional parameters. The following example shows the basic structure of the array.

*Note: There are plans to add methods to this class to aid in the construction of an order, so as to make this process less painful.*

```
// Define the order
$order = array(
    'email' => 'name@email.com,
    'line_items' => array(
        array(
            'sku' => 'abc-123',
            'name' => 'Item 1',
            ...
        ),
        array(
            'sku' => 'def-456',
            'name' => 'Item 2',
            ...
        )
    ),
    'note_attributes' => array(
        ...
    ),
    'shipping_address' => array(
        'address1' => '123 Address Ave',
        'address2' => 'Apt 202',
        'city'     => 'Anytown',
        ...
    ),
    'order_id' => '1234567890',
    ...
);

// Create the Order
Shiphero::createOrder($order);
```

### Shiphero::updateOrder($order)

[](#shipheroupdateorderorder)

**Parameters:** $order *array*

Similar to the `Shiphero::createOrder($order)` method, this method updates order information. As with the `Shiphero::createOrder($order)` method, please refer to the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/orders/update-order/update-order) for a detailed list of parameters.

Additionally, the only *required* parameters are the `'order_number'` and the parameters you wish to update.

```
$order = array(
    'order_number' => '1234-123',
    ...
);

Shiphero::updateOrder($order);
```

### Shiphero::createOrderHistory($hist)

[](#shipherocreateorderhistoryhist)

**Parameters:** $hist *array*

This method adds an order history to a given order. Please note that `'order_id'` is *not* the same as `'order_number'`.

```
$hist = array(
    'order_id' => 123456,
    'username' => 'user@email.com',
    'information' => 'A note on the order history'
);

Shiphero::createOrderHistory($hist);
```

Vendors
-------

[](#vendors)

### Shiphero::getVendorList()

[](#shipherogetvendorlist)

**Parameters:**

This method returns the full list of vendors.

```
$vendors = Shiphero::getVendorList();
```

### Shiphero::createVendor($vendor)

[](#shipherocreatevendorvendor)

**Parameters:** $vendor *array*

Creates a vendor. See the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/vendors/create-vendor/create-vendor) for a complete list of parameters that can be set.

```
$vendor = array('vendor_name' => 'Wyld Stallyn Guitars', // - vendor_name is the only required parameter.
                'vendor_city' => 'San Dimas',
                'vendor_state' => 'California'
          );

Shiphero::createVendor($vendor);
```

### Shiphero::addProductToVendorQueue($data)

[](#shipheroaddproducttovendorqueuedata)

**Parameters:** $data *array*Adds a product to the Vendor Queue. When used in conjunction with `Shiphero::addProductsToVendor()`, products can be added to vendors. For a full list of required/optional parameters, see the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/vendors/add-products-to-vendors/add-products-to-vendors).

```
$product1 = array('sku' => 'abc-123', 'vendor_id' => '1234');
Shiphero::addProductToVendorQueue($product1);

// Products in Vendor Queue:
//          $product1:
//              sku: '1234'
//              vendor_id: '1234'
//

$product2 = array('sku' => '5678', 'vendor_id' => '9012', 'price' => 40.99, 'manufacturer_sku' => 'mSku-494');
Shiphero::addProductToVendorQueue($product2);
// Products in Vendor Queue:
//          $product1:
//              sku: '1234'
//              vendor_id: '1234'
//
//          $product2:
//              sku: '5678'
//              vendor_id: '9012'
//              price: 40.99
//              manufacturer_sku: 'msku-494'
//
```

### Shiphero::addProductsToVendors()

[](#shipheroaddproductstovendors)

**Parameters:**

Takes products from the Vendor Queue and adds them to vendors. Once this method is complete, the Vendor Queue is emptied. Example below is a continuation of the example for [Shiphero::addProductToVendorQueue($data)](#shipheroaddproducttovendorqueuedata).

```
// Products in Vendor Queue:
//          $product1:
//              sku: '1234'
//              vendor_id: '1234'
//
//          $product2:
//              sku: '5678'
//              vendor_id: '9012'
//              price: 40.99
//              manufacturer_sku: 'msku-494'
//

Shiphero::addProductsToVendors();

// Products in Vendor Queue:
//          Nothing (empty)
//
```

### Shiphero::removeProductFromVendor($vendor\_id, $sku)

[](#shipheroremoveproductfromvendorvendor_id-sku)

**Parameters:** $vendor\_id *int*, $sku *string*

This method will remove a product from a vendor.

```
//Vendor ID: 123456
//      contains items (skus):
//          'abc-123'
//          'def-456'
//          'ghi-789'
//

Shiphero::removeProductFromVendor(123456, 'def-456');

//Vendor ID: 123456
//      contains items (skus):
//          'abc-123'
//          'ghi-789'
//
```

Fulfillment Statuses
--------------------

[](#fulfillment-statuses)

### Shiphero::createFulfillmentStatus($status)

[](#shipherocreatefulfillmentstatusstatus)

**Parameters:** $status *string*

Creates a fulfillment status.

```
Shiphero::createFulfillmentStatus('My Custom Status');
```

### Shiphero::deleteFulfillmentStatus($status)

[](#shipherodeletefulfillmentstatusstatus)

**Parameters:** $status *string*

Deletes a fulfillment status.

```
Shiphero::deleteFulfillmentStatus('My Custom Status');
```

Purchase Orders
---------------

[](#purchase-orders)

### Shiphero::addProductToPoQueue($line\_item)

[](#shipheroaddproducttopoqueueline_item)

**Parameters:** $line\_item *array*

This method will add line items to the PO Line Item Queue. The queue (similar in functionality to all other queues) will store line items for a PO until the method `Shiphero::createPO($po)` is called.

***NOTE:*** *Per the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/purchase-orders/create-po/create-po) (specifically the parameters prefixed by `line_items[n]`),* ***BOTH `id` and `sku` parameters must be set in addition to all other required parameters.***

```
	$line_item1 = array('id'=>3456789012, 'sku'=>'abc-123', 'name'=>'Test1',
						'price'=>'25.00', 'quantity'=>30, 'sell_ahead'=>0);

    //PO Line Item Queue Contains: $line_item1

	$line_item2 = array('id'=>2345678901, 'sku'=>'def-456', 'name'=>'Test2',
						'price'=>'0.00', 'quantity'=>40, 'sell_ahead'=>0);

    //PO Line Item Queue Contains: $line_item1, $line_item2

    $line_item3 = array('id'=>1234567890, 'sku'=>'ghi-789', 'name'=>'Item 3',
						'price'=>'25.00', 'quantity'=>20, 'sell_ahead'=>0);

    //PO Line Item Queue Contains: $line_item1, $line_item2, $line_item3

```

### Shiphero::createPO($po)

[](#shipherocreatepopo)

**Parameters:** $po *array*

Given basic information about a Purchase Order in the form of an array, this method will construct a Purchase Order using the information provided both in the `$po` array and PO Line Item Queue (see [Shiphero::addProductToPoQueue($line\_item)](#shipheroaddproducttopoqueueline_item)). For a complete list of required/optional parameters, please see the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/purchase-orders/create-po/create-po), and note that the `line_items` parameter in its entirety *does not pertain to this method.*

Upon completion, this method clears the PO Line Item Queue.

*NOTE: While optional, if the `expected_date` parameter is not set, Shiphero defaults to setting the date as `11/30/-0001`. In Shiphero, this is an invalid date, and when updating PO's the system will reject the updates until this date is manually corrected. Therefore, this wrapper automatically sets the `expected_date` parameter to the current date if the parameter is not already set.*

The following example is a continuation of the example for [Shiphero::addProductToPoQueue($line\_item)](#shipheroaddproducttopoqueueline_item).

```
    ...
    Shiphero::addProductToPoQueue($line_item1);
	Shiphero::addProductToPoQueue($line_item2);
	Shiphero::addProductToPoQueue($line_item3);

    //PO Line Item Queue Contains: $line_item1, $line_item2, $line_item3

    $po = array('email'=>'example@email.com', 'vendor_name'=>'A. Vendor, Inc', 'created_at'=>'2016-10-03 10:42:25');

    Shiphero::createPO($po);

    //PO Line Item Queue Contains: Nothing (empty)
```

### Shiphero::getPO($po\_id)

[](#shipherogetpopo_id)

**Parameters:** $po\_id *int*

This method retrieves information about a given PO.

```

    $po_1 = Shiphero::getPO(1);     // - Return information from PO ID: 1
    $po_2 = Shiphero::getPO(2);     // - Return information from PO ID: 2
    $po_3 = Shiphero::getPO(456789); // - Return information from PO ID: 456789

```

Shipments
---------

[](#shipments)

### Shiphero::getShipments($filter)

[](#shipherogetshipmentsfilter)

**Parameters:** $filter *array*

This method returns a collection of Shipments based on filtering criteria. See the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/shipment/get-shipments/get-shipments) for a full list of parameters.

*NOTE: All returned collections come back from the Shiphero API as a paginated response. Do not forget to set your page parameter!*

```

    //Get page 1 of all shipments from Sept. 28, 2016
    $filter = array('page'=>1, 'from'=>'2016-09-28', 'to'=>'2016-09-28');
    $collection1 = Shiphero::getShipments($filter);

    //Get page 6 of all shipments from Sept. 28, 2016 to Oct. 2, 2016
    $filter = array('page'=>6, 'from'=>'2016-09-28', 'to'=>'2016-10-2');
    $collection2 = Shiphero::getShipments($filter);

```

### Shiphero::createShipment($shipment)

[](#shipherocreateshipmentshipment)

**Parameters:** $shipment *array*

This method creates a Shipment. As the input array is quite long, viewing the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/shipment/create-shipment/create-shipment) is highly encouraged.

*NOTE: Future plans include breaking this process up into smaller chunks to make things more easily managable.*

```
    $shipment = array('warehouse'=>'Primary',
                      'profile'=>'default',
                      'shipment'=>array(
                            'shipment_id'=>'123456',
                            'order_id'=>'78901',
                            'carrier'=>'UPS',
                            'shipping_method'=>'UPS GROUND',
                            'tracking_number'=>'abcde1234567890',
                            'cost'=>10.76,
                            'dimensions'=>array(
                                'weight'=>20,
                                'length'=>5,
                                'width'=>8,
                                'height'=>4
                            ),
                            'address'=>array(
                                'name'=>'John Doe',
                                'address1'=>'123 Anywhere St.',
                                'address2'=>'Apt 2',
                                'city'=>'Anytown',
                                'state'=>'CA',
                                'postal_code'=>'12345',
                                'country'=>'US'
                            ),
                            'label'=>array(
                                'pdf'=>'http://example.url.to/pdf/file.pdf',
                                'png'=>array(
                                    'http://example.url.to/png/page1.png',
                                    'http://example.url.to/png/page2.png'
                                )
                            ),
                            'customs_info'=>array(
                                'http://example.url.to/customs/info/page1.png',
                                'http://example.url.to/customs/info/page2.png'
                            )
                        )
                    );

    Shiphero::createShipment($shipment);

```

Webhooks
--------

[](#webhooks)

### Shiphero::registerWebhook($hook\_info)

[](#shipheroregisterwebhookhook_info)

**Parameters:** $hook\_info *array*

This method will register a webhook with the Shiphero API. Take special note of the parameters `name` and `source` in the [Shiphero API Documentation](http://docs.shipheropublic.apiary.io/#reference/webhooks/register-webhook/register-webhook), as these are pre-defined values.

*NOTE: Webhooks for `Capture Payment` and `Return Update` are still in development at Shiphero. This file will be updated to reflect the changes when they become available. Additionally, the Shiphero API requires a response header from any created webhooks, else the transaction will not be complete!*

```
    //register a webhook to post to URL 'http://my.owned.url.for/webhooks/' every time inventory is updated on my bigcommerce store.
    $hook_info = array('name'=>'Inventory Update', 'url'=>'http://my.owned.url.for/webhooks/', 'source'=>'bigcommerce');
    Shiphero::registerWebhook($hook_info);
```

### Shiphero::getWebhooks()

[](#shipherogetwebhooks)

**Parameters:**

This method returns a list of all currently created webhooks.

```

    $webhook_list = Shiphero::getWebhooks();

```

Contact Me
----------

[](#contact-me)

Please feel free to contact me at  with any questions or concerns. Please include the words "Shiphero API Wrapper" in the subject line, and I will be sure to respond as soon as possible.

Additionally, please log any issues/bugs with GitHub's issue tracker.

###  Health Score

32

—

LowBetter than 71% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 96.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~106 days

Total

2

Last Release

3368d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/61b7964010e3dcdf9b0778bef21c176b17f139301537989179c35b27a4bbc81c?d=identicon)[mdeschermeier](/maintainers/mdeschermeier)

---

Top Contributors

[![mdeschermeier](https://avatars.githubusercontent.com/u/16123463?v=4)](https://github.com/mdeschermeier "mdeschermeier (50 commits)")[![Mahmoudz](https://avatars.githubusercontent.com/u/1983984?v=4)](https://github.com/Mahmoudz "Mahmoudz (2 commits)")

### Embed Badge

![Health badge](/badges/mdeschermeier-shiphero/health.svg)

```
[![Health](https://phpackages.com/badges/mdeschermeier-shiphero/health.svg)](https://phpackages.com/packages/mdeschermeier-shiphero)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)