What is the EasyScan API?
The EasyScan API gives your external systems secure, read-only access to selected purchasing and inventory information held in EasyScan. It is designed for businesses that want to connect EasyScan to an ERP, warehouse management system, reporting platform, accounting workflow or their own internal tools.
The API cannot create, edit or delete anything in EasyScan or Shopify.
What can you use it for?
You can use the API to:
Send EasyScan purchase and transfer information to an ERP or WMS
Build purchasing, supplier and inventory dashboards
Reconcile stock movements with another business system
Automate reporting without exporting files manually
Move an existing Stocky-based reporting or integration workflow to EasyScan
What information is available?
The API provides read-only access to the main records used by purchasing and inventory integrations, including:
Purchase orders and their line items
Transfer orders and their line items
Suppliers
Stock adjustments and individual inventory changes
Purchase tax information
Locations referenced by EasyScan purchasing and transfer records
Detailed field definitions, filters and request examples are available inside EasyScan to eligible Pro stores.
Who can use the API?
The EasyScan API is available to stores with an active Pro or Pro Yearly subscription.
For security, API keys must be managed by the Shopify store owner. If EasyScan user passwords are enabled, the owner must also sign in to an EasyScan account with API access permission.
The API is intended for server-to-server integrations. Do not place an API key in storefront code, browser scripts or other public locations.
How to activate the EasyScan API
Open EasyScan from Shopify Admin.
Go to Settings → General.
Scroll to API access.
Select Read the API documentation to review the technical guide.
Select Generate API key and give the key a clear name, such as the system that will use it.
Copy the key immediately and save it in your integration's secure secret store. The full key is shown only once.
Follow the Pro-only technical documentation to connect and test your system.
Create a separate key for each integration. This makes it easier to rotate or revoke one connection without interrupting the others.
Keeping API keys secure
Treat every API key like a password
Store keys in a proper secret manager or secure server configuration
Never share keys in email, support tickets, spreadsheets or chat
Revoke a key immediately if it may have been exposed
Rotate keys by creating a replacement, switching the integration and then revoking the old key
Revoking a key takes effect immediately. EasyScan never displays the full key again after it has been created.
Moving from Stocky
EasyScan covers the main read-only resource groups previously available through Stocky, including purchase orders, suppliers, stock adjustments, adjustment items and tax information. EasyScan also provides its own transfer-order information and referenced locations.
An existing Stocky integration will usually need some mapping work. EasyScan has its own URLs, response fields and pagination, so changing only the base URL is not enough. The Pro-only technical guide includes migration notes for developers.
What happens if the plan changes?
If the store moves from Pro to a lower plan, existing API keys stop working. The keys are retained, so access can resume after the store returns to Pro without creating every key again.
Uninstalling EasyScan removes the store's API keys.
Troubleshooting
I cannot see API access or the documentation
Confirm that the store has an active Pro subscription and that you are signed in as the Shopify store owner. If EasyScan user passwords are enabled, confirm that your EasyScan account has API access permission.
My integration has stopped working
Check that the key has not been revoked, the store still has an active Pro subscription and your integration is sending the key exactly as shown in the technical documentation.
My integration is being rate limited
Reduce how often it requests data, request larger result pages where appropriate and follow the retry guidance in the technical documentation.
Frequently asked questions
Can the API change my data?
No. Version 1 is read-only and cannot create, update or delete records.
Can one key access another store?
No. Every key is tied to the EasyScan store that created it.
Where are the full technical details?
Open EasyScan → Settings → General → API access and select Read the API documentation. Detailed documentation is available only to stores with an active Pro subscription.
Need help?
If you need help planning an integration or moving from Stocky, contact us through the EasyScan app and tell us which system you want to connect.