Skip to content
A Ruby wrapper for the ShipStation API
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test Updated test app gemfile. Sep 9, 2018
.gitignore
Gemfile Initial plugin migration and set up. Sep 15, 2016
Gemfile.lock
MIT-LICENSE
README.md
Rakefile
shipstation.gemspec Updated gem dependency version. Sep 19, 2016

README.md

Shipstation

Gem Version

A Ruby wrapper for the Shipstation API.

Release Notes

Installation

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

Usage

This gem provides a collection of operations for use within the Shipstation API.

List

List all records for a resource.

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

Retrieve

Retrieve a single record of a resource.

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

Create a single record of a resource.

Shipstation::Order.create(order_params)
Shipstation::Warehouse.create(warehouse_params)

Update

Update a single record of a resource.

Shipstation::Product.update(product_params)
Shipstation::Store.update(store_params)
Shipstation::Warehouse.update(warehouse_params)

Apart from the standard CRUD operations, there are also some custom operations for specific use cases.

Create a new Order Label.

Shipstation::Order.create_label(order_label_params)

Assign Tag to an Order.

Shipstation::Order.assign_tag(assign_tag_params)

Delete an Order

Shipstation::Order.delete(order_id)

Versioning

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

How to contribute

  • 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

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

You can’t perform that action at this time.