shipcloud for developers


staying ahead of the devpack

Welcome

to the shipcloud developer portal where you - the developer - will hopefully get all the information you need to get started with integrating shipcloud into your own service, shop, app or other crazy idea.
This is supposed to be your one stop for all developer needs. If you have any questions, feel free to contact us.
If there's anything missing in this portal, you've found a typo, bug or something isn't clear, the developer portal is build as a public repository on github. Feel free to fork it, change things, make a pull request or even run your own local version of it.

Getting started

If you want to start testing our services fast - this is the way to go! Just follow these simple steps:
  1. First of all you register for our free developer plan.
  2. Afterwards you can get your api keys from our backoffice
  3. Start implementing your first api call using our api reference.

Integration guide

If you like to know the ins and outs of our services and our api or want to write a new plugin, extension, module, or library for your software or programming language, the best way to get started is by downloading and reading the integration guide.
In our integration guide we're trying to give you the best possible overview of what shipcloud is trying to support you with. We're also providing you with an overview of possible use cases and pitfalls when implemeting a shipping solution.

Concepts

Afterwards you should consider reading about a few of the concepts and principles that our api and services are adhering to. On our concepts page we're trying to explain stuff like authentication, versioning, timeouts and a lot more basic and important things you should know about when working with our api.

Postman

To make it easier to test our api we've created a collection that you can import into postman. Just enter your api keys in the form below and click the "Run in postman" button to import it into your postman app. After importing the collection you can select the specific environment (sandbox or production) from within the postman app and make calls to our api.
We've tried to add as many of our examples to the collection, so feel free to explore the collection a bit.

Newsletter

Always stay up to date with our developer journal where we're writing about changes and updates to our api, providing you with useful insights and keeping you up to date about where you can meet us to talk about the development side of our services.

If you want to catch up on the latest newsletters you can always visit our archive and read each journal individually before subscribing to our newsletter and be notified via email.

Not a developer?

Don't panic! We've got you covered! There are already a hand full of plugins written by other developers for a lot of the largest online shopping software solutions. We're also directly integrated into a few shopping services like Gambio, Jimdo and VersaCommerce.

Need help?

If at any point you're getting the feeling that you're lost or you're simply having a question, because something we're describing isn't clear to you. Don't hesitate to contact us. We also have a Slack channel. If you want to join us there, just send an email and we'll invite you.