Libraries

shipcloud-ruby

We’ve written a shipcloud wrapper for the ruby language that you can use for integrating shipcloud into your own ruby projects. Just head over to our Github repository, clone it and off you go!

How to use our ruby gem

Setup

Before using the shipcloud API, you need to set the API access key:

Shipcloud.api_key = 'be51608682014a3adf620fc252d63390'

Since Version 0.3.0, you can also do this via a configuration block, e.g. in an initializer:

Shipcloud.configure do |config|
  config.api_key = 'be51608682014a3adf620fc252d63390'
end

Creating a new shipment

To create a new shipment on the shipclod platform, you need to provide the name of the carrier, to and from address, and the package dimensions. For details, see our API reference.

Shipcloud::Shipment.create(
  carrier: 'ups',
  from: from-address-params,
  to: to-address-params,
  package: package-params,
  create_shipping_label: true
)

Shipment#create will return shipping label and tracking information, encapsulated in a Shipcloud::Shipment object:

shipment = Shipcloud::Shipment.create(...) # parameters ommitted
shipment.tracking_url # -> http://track.shipcloud.io/86afb143f9c9c0cfd4eb7a7c26a5c616585a6271

Plugins / Extensions / Modules

Why reinvent the wheel? There are already a lot of plugins / extensions / modules / libraries for existing services or coding languages available. So maybe you won’t have to write your own code for integrating shipcloud into your system. Just have a look at our integrations page and see for yourself.

Integrations wanted!

You’re developing for a platform that we’re missing? Great! We’re always looking for new partners who’d like to integrate us into their platform or the platform they’re using. Feel free to contact us so we can put up links to your work on our sites once the integration is available.

Notice: To make things easier for our support team we’d kindly ask you to send a custom header with every request you’re making. This way we can identify problems with a specific platform easier. The headers key is ‘Affiliate-ID’. To know which value you need to specify, please contact us at developers@shipcloud.io.