ShippyProAPI

This is an API wrapper gem for ShippyPro API.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add shippy_pro_api

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install shippy_pro_api

Usage

A client must be initialized with ShippyPro's API key created for the user's account.

client = ShippyProAPI::Client.new(api_key: ENV['SHIPPY_PRO_API_KEY'])

Shipment

Create a shipment

# params is a hash of shipment attributes in snake case
# note: the example below is not a complete list of attributes required to create a shipment

# example:
params = {
  to_address: {
    name: "John Doe",
    company: "ShippyPro",
    street1: "172 Boulevard de la Villette",
    street2: "19ème Arrondissement",
    city: "Paris",
    state: "",
    zip: "75019",
    country: "FR",
    phone: "+33186652533",
    email: "johndoe@gmail.com"
  },
  from_address: {
    name: "Jane Doe",
    company: "ProShippy",
    street1: "198 Avenue de France",
    street2: "",
    city: "Paris",
    state: "",
    zip: "75013",
    country: "FR",
    phone: "+33186652533",
    email: "janedoe@gmail.com"
  },
  parcels: [
    {
      length: 5,
      width: 5,
      height: 5,
      weight: 10
    }
  ],
  insurance: 0,
  insurance_currency: "EUR",
  cash_on_delivery: 0,
  cash_on_delivery_currency: "EUR",
  content_description: "Shoes",
  total_value: "50.25 EUR",
  shipping_service: "Standard"
}

# create a shipment
client.shipment.create(params)

Retrieve rates

# params is a hash of shipment attributes in snake case

client.shipment.retrieve_rates(params)

Track a shipment

client.shipment.track("tracking_number")

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/PostCo/shippy_pro_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ShippyProAPI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.