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, or follow an order through its 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. You can use HTTP Basic Auth or apiID/apiSecret parameters — see the Authentication page for details and examples.
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.
Note:
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 mirrors these endpoints if you'd like to try them interactively:
Open the published Postman collection to explore and run the PIMS Open API endpoints interactively.
Endpoints
API ID / API Secret credentials, HTTP Basic Auth vs. query parameters, 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.
Need Help?
For assistance, please send a message to our Support page.