Contents
The Inventory Pro REST API lets you read and write inventory data programmatically. Use it to connect reporting tools, automate receiving workflows, synchronize with ERP systems, or build custom integrations.
If you need a read-only reporting surface for Power BI, Excel, or other BI tooling, use the OData Feeds alongside the REST API.
https://<your-host>/api/v1All endpoints are relative to this base. HTTPS is required — HTTP requests are rejected.
The current API version is v1. The version is embedded in the URL path. Every response includes an X-API-Version header confirming the version that handled the request.
Send JSON bodies with Content-Type: application/json. Authenticate with Authorization: Bearer <token>. See Authentication for token details.
Rate limiting: The checked-in default throttle policy is 4 requests per minute per client/IP, with a tighter token endpoint rule of 4 requests per minute. Exceeding it returns HTTP 429:
{ "message": "Rate Limit Exceeded. 4 per Minute" }| Resource | Read | Write | Details |
|---|---|---|---|
| Items | List, get by ID, aliases | Create, update, discontinue | Core inventory catalog |
| Inventory | Lots, stock levels, material in/out | Receive, move, issue | Warehouse inventory operations |
| Purchase Orders | List, get by ID | Create, finalize | Procurement workflow |
| Shipping Orders | List, get by ID | Create | Outbound shipments |
| Work Orders | List, get by ID | — | Manufacturing/assembly |
| Assets | List, get by ID, types | Create, receive, update, delete | Fixed asset tracking |
| Customers | List, get by ID | Create, delete | Customer master data |
| Vendors | List, get by ID | Create, delete | Supplier master data |
| Categories | List, get by ID | Delete | Part classification |
| Locations | List, get by ID | Hold, release | Warehouse bin positions |
| Warehouses | List, get by ID, items | — | Facility data |
| Reason Codes | List, get by ID | Delete | Transaction reason codes |
| Reports | List, execute | — | Run system reports via API |
| Webhooks | List, get by ID, logs | Create, update, delete, test | Event subscriptions |
Follow the Quickstart to authenticate and make your first request.
On this page