The Sortly API lets you connect Sortly to other tools and automate parts of your workflow, like keeping inventory in sync with another system or triggering purchase orders automatically. The API is self-service, so you'll want a developer on hand to build and maintain the integration using our documentation.
In this article
How the API works
You'll connect using a key pair generated right in your Sortly account. Authentication uses OAuth 2.0, your secret key is passed as a Bearer token in the request's Authorization header, and all requests are made over HTTPS. Responses come back in a standard format that's easy to build against.
The API allows up to 1,000 requests every 15 minutes. Each response includes headers showing your limit, how many requests you have left, and when the window resets. Going over the limit returns an HTTP 429 error until it resets.
For technical questions about building your integration, reach our developer support team at dev-support@sortly.com. For account or billing questions, please contact our Support team instead.
Who has access
Finding your API key
-
1Go to the Integrations tab, then click Public API
-
2Click Create Key Pair
This generates a unique API key for your account.
-
3Name your key and set an expiration date if you'd like, then click Create
-
4Save your Public Key and Secret Key
You'll only see the Secret Key once, so make sure to save it somewhere safe before closing the window.
5Click Close this window, I have a key pair
-
6Find your active key anytime under Integrations, Public API
You can edit or delete your key from there using the options next to it.
What you can do with the API
The Sortly API can be used to work with:
- Items and folders
- Item variants (called Item Groups in the API)
- Units of measure
- Custom fields
- Alerts
- Jobs
- Purchase orders
For full technical details on each of these, visit our API Documentation.
Automating Jobs
If you manage inventory for specific jobs, you're probably already using a folder for each one, the same way you would for a location or work order. The Jobs API builds on that idea: it creates a dedicated folder for each job and tracks its status as work moves from not started to in progress to completed.
With it, you can create jobs, move items into and out of the job folder, and update a job's status automatically. This is useful if you're syncing jobs from a field service or scheduling system and want Sortly to stay in step without manual updates.
See the Jobs API documentation for full details.
Automating Purchase Orders
The API can also create purchase orders, add items to them from your inventory, and record what's been received as stock comes in. This is helpful if you want to trigger reorders automatically when stock runs low, or feed purchase order data into another system like your accounting or ERP software.
See the API Documentation for the Purchase Orders section and full details.