Skip to content

Commit

Permalink
Built somewhat of a readme
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelbonds committed Feb 15, 2016
1 parent 084ae74 commit d000d8b
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,44 @@
# ship-station
# ShipStation Api Wrapper for PHP

## Install
---
```
composer require michaelb/ship-station
```

## Docs
---

Using ShipStationApi
```php

use MichaelB\ShipStation\ShipStationApi;

$apiKey = ''; // Your ShipStation Api Key
$apiSecret = ''; // Your ShipStation Api Secret
$options = []; // Options to be merged into the normal GuzzleHttp\Client options

// ShipStationApi Extends GuzzleHttp\Client
$shipstation = new ShipStationApi($apiKey, $apiSecret, $options);

/*
* Get a service instance
*/

// Orders
$orderService = $shipstation->orders;

// Products
$products = $shipstation->products;

// ...

/*
* Use the service
*/
$order = $orderService->getOrder('1234');

// All service methods return a GuzzleHttp\Psr7\Response object
$json = $order->getBody(); // { 'order': {...} }
$status = $order->getStatusCode(); // 200
```

0 comments on commit d000d8b

Please sign in to comment.