The PIMS Open API lets your own applications read and write PIMS data through Weevio Cloud, without integrating against PIMS directly. It is intended for external apps and integration partners that need to manage customers, inventory, and orders, submit repair intakes, or follow orders and repairs through their PIMS lifecycle.
Getting started
To use the PIMS Open API you must have purchased an API plan from Weevio — contact Weevio customer support if you'd like one. By using the API you agree to the API terms of service. We strongly recommend testing against a PIMS test server rather than a live production PIMS server.
Then generate your credentials and authenticate every request — see Authentication.
Base URL
All endpoints live under:
https://cloud.weevio.co/tenant/api/pims/v1
Authentication
Every request is authenticated with your tenant's API ID and API Secret, plus a teamID. Use HTTPS and HTTP Basic Auth for new integrations. Keep keys on your server and out of query strings — see Authentication for setup and legacy credential options.
Rate limits
The Pending SRO and SRO routes have these limits:
| Routes | Budget |
|---|---|
POST /pending_sros | 60 requests per minute per tenant for creation. |
GET /pending_sros/:id, GET /sros/:sro_number, serial lookup, batch status, and GET /sros/status_choices | One combined budget of 60 requests per minute per tenant for all these reads. |
Paths above are relative to /tenant/api/pims/v1. The creation and read budgets are separate and enforced per tenant per server process.
A limit returns 429 Too Many Requests with Retry-After: 60. Wait at least the indicated number of seconds before retrying. Authenticated requests count toward API usage, including those rejected by these route limits.
For ongoing repair tracking, poll open SROs in batches every 15–30 minutes. Back off on temporary 502 read failures. These limits describe the routes above, not a global limit for every PIMS Open API endpoint.
Pricing
Access to the PIMS Open API is $99 per month, which includes your first 50,000 API requests each month. Additional requests beyond 50,000 are billed at $0.002 each.
| Item | Cost |
|---|---|
| Monthly access | $99 / month |
| Included requests | First 50,000 requests / month |
| Additional requests | $0.002 per request beyond 50,000 |
Every authenticated call to a PIMS Open API endpoint counts toward your monthly request total.
Use the calculator below to estimate your monthly cost based on how many API calls your team expects to make.
- Monthly access
- $99.00
- Included requests (50,000)
- $0.00
- Additional requests (0 × $0.002)
- $0.00
- Estimated monthly total
- $99.00
Estimate only. Your actual bill is based on the API calls your team makes during the month.
Warning
Once your team starts using the PIMS Open API, this usage is added to your monthly bill automatically.
Run in Postman
A published Postman collection is available for exploring the PIMS Open API. Use the endpoint pages below for the current Pending SRO and SRO contracts and examples:
Open the published Postman collection to explore and run the PIMS Open API endpoints interactively.
Endpoints
Server-side API credentials, HTTP Basic Auth, the required teamID, and how to generate keys.
Read, query, create, and update PIMS customer records.
Read and query PIMS inventory items.
Read, query, and create PIMS orders, and add or update order line items.
Look up an order's current PIMS state by its Shopify order number, returning every matching PIMS record so you can derive fulfillment state.
Create a repair intake, retry safely with an external reference, and retrieve SRO numbers after staff receive devices.
Read repair details, find SROs by serial, poll status in batches, and retrieve status choices.