README.md

Shipstation

---

This library is now ready to undergo testing in staging & production environments, but it is not production ready.

Shipstation is an unofficial API client library for the Shipstation API. This library implements all the functionality that exists in Shipstation's API, and also provides helpful features like automatic backpressure handling.

Features

• A complete API
• Every API endpoint has been unit tested
• Configurable API endpoints (for using Shipstation's Apiary endpoint in testing, for example).
• Automatically handles backpressure using a backpressure Agent

Installation

The package can be installed as:

1. Add shipstation to your list of dependencies in mix.exs:

```elixir
def deps do
  [{:shipstation, "~> 0.2.0"}]
end
```

2. Ensure shipstation is started before your application:

```elixir
def application do
  [applications: [:shipstation]]
end
```

Todo List:

• Provide a standard for handling dates in the correct format
• Deserialize JSON output into Model structs