Postman

Postman collections offer a convenient way to quickly onboard with Sendcloud APIs

Once you have created your account and completed the setup, you can use our Postman collections which you can find over our Postman public workspace.

Forking

The best way to experiment with the collection is to create a fork. A fork allows you to set up your private environments and create a tailored experience for your specific needs. A fork is a new instance of an element that you can change without changing the parent element. In Postman, you can fork collections, environments, and flows. Forking enables you to contribute to a component without having editor access to that element.

Once you have forked a collection, you need to define your environment to experiment with it. We provide an environment template that you can also fork and use to get started.

If you work as part of a team, you can use environments to group related sets of values together and manage access to shared data. If you need to set the value for your API keys, use the environment templates. They already have sets of variables and values to start using the APIs.

API versions

We currently support two versions of our APIs: it is stable v2 and it is v3 which is in development. We have a Postman collection for each of them, along with a template environment for each version.

Version Collection Environment
v2 Sendcloud API Sendcloud Environment Template Run in Postman
v3 Sendcloud API [v3] Sendcloud [v3] Environment Template Run in Postman
Note that the REST API v3 is still in development. If you are working with this version, you should prepare for potential changes in functionality, performance, and security. You can use Returns and the beta version of Orders. Don’t hesitate to reach out if you have any questions or concerns.

On this page

Go to top