Postman Docs
Connect your own systems to Helm WMS using the Helm API, with every request documented in Postman.
What the Postman Docs Cover
The Postman Docs are the full reference for the Helm API. Developers use them to connect Helm with the other systems your business runs on, such as an accounting package, an eCommerce platform or your own reports, so orders, stock and shipments move between them without anyone keying them in by hand.
Example: your finance team wants each day's despatched orders in your accounting system. Your developer uses the Orders section of the Postman Docs to fetch them from Helm every evening and send them across automatically.
Each area of Helm you work with day to day has its own section, for example:
Note: open the Postman Docs at any time from here. They are also linked at the bottom of the help centre, next to Get Support and Our Website.
Before You Start
Someone to build the integration. The API is used by writing code, so share this page with your developer or integration partner. Anyone can read the Postman Docs, but building the connection needs someone comfortable working with APIs.
An API token. Every request is sent with a Personal Access Token. If you do not have one yet, contact Support.
The right permissions. A token can only do what its role allows. If a request is refused, check that the role has permission for that area of Helm.
Warning: treat your API token like a password. Anyone who has it can reach your Helm data within that role's permissions, so never paste it into emails, tickets or screenshots.
How to Use the Postman Docs
Open the Postman Docs.
Read the Introduction first. It explains the address every request goes to, how to send your token with each request and how long lists are split into pages.
Choose an area from the list on the left, such as Orders or Inventory, to see what you can do there.
Open a request to see what to send and an example of what Helm sends back.
Use the Language setting at the top to show the examples in the programming language your developer works in.
Best Practices
Start Small
Connect one flow first, such as despatched orders, and check the results in Helm before adding more. A mapping problem is far easier to spot in one flow than in five.
Stay Within the Limits
Each request has its own limit on how often it can be called. If your integration goes over it, Helm tells it how many seconds to wait, so build in that pause rather than retrying straight away.
Tip: ask for related records in the same request. An order can come back with its items and customer already included, which saves calls and keeps you well inside the limits.
FAQ
Do I need to be a developer to use the Postman Docs?
Do I need to be a developer to use the Postman Docs?
No, anyone can read them. Building an integration does need someone comfortable working with APIs, so share this page with your developer or integration partner.
What is the difference between the API and an app?
What is the difference between the API and an app?
The API lets your other systems swap data with Helm in the background. An app runs inside Helm itself, so your team can use it without leaving Helm. Apps are uploaded through the Partner Portal.
How do I get an API token?
How do I get an API token?
If you do not have a Personal Access Token yet, contact Support.
Why does a request come back as Unauthorized?
Why does a request come back as Unauthorized?
The token is missing or not valid. Check that it is sent with every request and has been copied in full.
Why does a request come back as Forbidden?
Why does a request come back as Forbidden?
The token's role does not have permission for that area of Helm. Use a token whose role includes it.
Why does a request come back as Too Many Requests?
Why does a request come back as Too Many Requests?
Your integration has gone over the limit for that request. Wait the number of seconds Helm gives in its reply, then try again.
Need a hand with your integration? Contact Support and the team will help.
Was this helpful?
Still need help? Share an idea