A Ruby wrapper for the Shipstation API.

Release Notes

Please note, this gem is currently under construction. Use at your own risk when deploying to a production environment!

Add module to your Gemfile:

gem 'shipstation'

Then run bundle to install the Gem:

bundle install

Set up an initializer file with your Shipstation API keys:

Shipstation.username  = 'shipstation_api_key'
Shipstation.password  = 'shipstation_api_secret'

e.g. config/initializers/shipstation.rb

Get all records for a source:

Shipstation::Carrier.list
Shipstation::Customer.list
Shipstation::Order.list
Shipstation::Product.list
Shipstation::Shipment.list
Shipstation::Store.list
Shipstation::Warehouse.list

Retrieve a record:

Shipstation::Customer.retrieve(customer_id)
Shipstation::Order.retrieve(order_id)
Shipstation::Product.retrieve(product_id)
Shipstation::Store.retrieve(store_id)
Shipstation::Warehouse.retrieve(warehouse_id)

Create a new Order:

Shipstation::Order.create(order_params)

Create a new Order Label:

Shipstation::Order.create_label(order_label_params)

Create a new Warehouse:

ShipStation::Warehouse.create(warehouse_params)

Shipstation Ruby wrapper follows Semantic Versioning 2.0 as defined at http://semver.org.

• Fork the project
• Create your feature or bug fix
• Add the requried tests for it.
• Commit (do not change version or history)
• Send a pull request against the development branch

Copyright (c) 2016 Tom Dallimore (@tom_dallimore)
Licenced under the MIT licence.