Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Build Status devportal

Need to know more about how shipcloud works from a developers standpoint? You've come to the right place! This Jekyll based repository will aid you in understanding the ideas and concepts behind and will also give you a handy reference for using our api.

Run locally

If you want to run our developer portal locally you can do it by following these simple steps:

~ $ git clone
~ $ cd shipcloud-developer-portal
~/shipcloud-developer-portal $ bundle install
~/shipcloud-developer-portal $ bundle exec rake

Deployment locally

To deploy to firebase you need to follow the following steps:

JEKYLL_ENV=production bundle exec rake build
yarn run firebase login
yarn run firebase use default
yarn run firebase deploy --only hosting


Our developer portal strives from participation. If you find anything that is not right our out of the ordinary, we've added a link to the corresponding file on GitHub on almost every page (except this one). If you follow it, you can edit the file directly on GitHub or you do it "the manual way" by cloning the repository and submitting pull requests.

If you don't have the time or find that something we've written isn't clear, you can also open an issue through GitHub or send us an email at

What about feature requests?

We're constantly working on the shipcloud platform and our backlog is filled with lots of cool things. That doesn't mean, that we've covered all bases. So if there's anything you absolutely need from shipcloud to be part of your use case, feel free to send us an email at, describing what it is that you need shipcloud to be doing. If you aren't a customer already, please also send us data on how many shipments your platform or shop will be submitting. This way we can better prioritize feature requests.

Please don't put feature requests into GitHub Issues.

New platform or shop integrations

Because we simply don't have enough developers or the needed expertise to create integrations for every shop or platform, we're more than happy to work with partners who know the ins and outs of a specific platform. If you want to create a shipcloud plugin / extension / addon please contact us at and we'll find a way to work together.