No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


Ruby gem to integrate with Shipwire's API.


Install locally with

gem install shipwire

Add this line to your application's Gemfile:

gem 'shipwire'

Note: The master branch is not guaranteed to be in a fully functioning state. It is unwise to use this branch in a production environment.

Run the bundle command:

bundle install

If you are using Rails, run the generator:

rails g shipwire:install


Basic configuration

Shipwire.configure do |config|
  config.username = "<%= ENV['SHIPWIRE_USERNAME'] %>"
  config.password = "<%= ENV['SHIPWIRE_PASSWORD'] %>"

username - (required) Shipwire username (email address) used for basic auth login to Shipwire

password - (required) Shipwire password used for basic auth login to Shipwire.

open_timeout - Read timeout in seconds. Default is 2.

timeout - Open/read timeout in seconds. Default is 5.

endpoint - Endpoint base URL to use for requests. Default is

logger - Log requests to STDOUT. Default is false.

Note: There is a difference between an account registered from and one registered from If you create an account from and then request data from the beta URL, the API will throw errors about an invalid account. Accounts are only valid from that registration point.


Tests are using a throwaway Shipwire Beta account that is only meant for testing. A personal Shipwire Beta account of your own is not required.

Tests require a product named TEST-PRODUCT and TEST-PRODUCT2 to function properly.

bundle exec rake spec


bundle exec rspec spec


If making contributions to this gem, make sure you write tests for any new functionality. Contributions will be rejected if there are no tests or tests do not pass.


  1. Fork it ( )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request