MRPeasy API documentation: authentication, endpoints and examples
mrpeasy api documentation
Also searched as
- mrpeasy rest api
- mrpeasy api authentication
- mrpeasy api customer orders items
- mrpeasy api example
Short answer
The MRPeasy REST API returns JSON over HTTPS and is authenticated with an API key and secret that you generate in your account. You read and write resources such as customer orders, manufacturing orders, items and stock, and page through lists with a Range header. Always confirm the exact resource names against MRPeasy's own API documentation.
Applies to: MRPeasy cloud accounts where API access is enabled for the user. The REST API is versioned, so use the version path shown in the current documentation.
How to call the MRPeasy API
- 1Sign in as an administrator and open the API settings in your user or system settings to generate an API key and secret.
- 2Keep the secret in a secrets manager. Treat it like a password and create separate keys for separate integrations.
- 3Open the official API documentation and pick the resource, for example customer orders, items or stock.
- 4Send a GET request over HTTPS using HTTP Basic authentication with the key as user name and the secret as password.
- 5For lists, add a Range header such as items=0-99 and read the Content-Range response header to continue paging.
- 6To create or change data, send a POST or PUT with a JSON body that follows the documented fields, then read the response for validation errors.
- 7Respect the rate limit stated in the documentation. Back off and retry when you receive a 429 response.
- 8Log the status code and body of every non-2xx response so failures can be diagnosed.
Authentication details
MRPeasy uses a key and secret pair rather than a user password in the integration. Because the key inherits access from the account that created it, create the key from a user whose permissions match the job. A reporting integration should not hold write access to orders.
Rotate keys when staff change, and revoke any key that appears in a shared repository or ticket.
curl -s -u '<API_KEY>:<API_SECRET>' \ -H 'Accept: application/json' \ -H 'Range: items=0-49' \ 'https://app.mrpeasy.com/rest/v1/customer-orders'
Common resources and uses
Typical resources include customer orders, manufacturing orders, items, products with bills of materials, purchase orders, stock and customers. Teams use them to import web-store orders, export production status to a dashboard, or sync stock levels to an e-commerce channel.
Not every field is writable. Status transitions and costs are often controlled by MRPeasy's own logic, so create a record and let the system move it through its workflow rather than forcing values.
Paging, filtering and errors
A list call returns a partial response with the range you asked for. Loop until the Content-Range total is reached. Add filters from the documentation, such as a modified-since filter, to keep runs short.
Handle 400 responses as data problems (read the message and fix the payload), 401 or 403 as credential or permission problems, and 429 or 5xx as retry cases.
Design tips
Sync incrementally and reconcile fully once a night. Store the MRPeasy id next to your system's id so updates are idempotent.
Where you only need a few automations, a connector platform such as Zapier or Make can call the same API without custom code.
Try it here, free
MRPeasy vs Katana Selection Scorecard
A 10-question fit test that scores how much planning depth and shop floor control your operation needs, to compare MRPeasy and Katana style cloud MRPs.
Common pitfalls
- !Putting the API secret in browser code or a public repository.
- !Ignoring the Range header and assuming one call returns every record.
- !Polling too frequently and hitting rate limits.
- !Writing status or cost fields that MRPeasy expects to calculate itself.
- !Using one shared key for every integration, which makes revocation disruptive.
How an ERP-grounded AI assistant handles this
A read-only assistant on top of the MRPeasy API can answer questions like 'which customer orders ship this week and are short of material' by calling the right list endpoints, joining the results and showing the calls it made. A model hosted on your own server means order and cost data is not sent to a third-party AI service, and any write-back, such as creating a purchase order, waits for a person to approve.
Frequently asked questions
Does MRPeasy have a REST API?
Yes. MRPeasy provides a REST API with JSON responses for resources such as customer orders, items and stock. Access requires an API key and secret created in your account.
How do I authenticate to the MRPeasy API?
Use HTTP Basic authentication over HTTPS, with the API key and secret generated in your MRPeasy settings. Create the key from a user with only the permissions the integration needs.
How does MRPeasy paging work?
Send a Range header such as items=0-99 to request a slice. The response includes a Content-Range header with the total, which tells you whether more pages remain.
Is there an API rate limit?
Yes, limits apply. Check the number in the current documentation, throttle your client, and retry with backoff when you get a 429 response.
Related
MRPeasy integration with QuickBooks, Xero, Sage and HubSpot
MRPeasy is an operations system (inventory, MRP, production, purchasing, sales) and expects a separate accounting package for the general ledger. It offers integrations for accounting tools such as QuickBooks Online and Xero, and reaches others like Sage and HubSpot through its REST API or connector tools. Treat sync as invoices, bills and contacts, not as a full ledger replacement.
How-toMRPeasy Materials Shortage: Plan Purchases Correctly
MRPeasy compares the demand from customer orders and manufacturing orders with available stock, booked stock and open purchase orders, and flags what is short. To act on it, review the shortages, confirm item lead times and minimum stock levels, then create purchase or manufacturing orders and re-check planned dates.
Error fixAcumatica REST API 401 Unauthorized and API Login Limit: How to Fix
A 401 from the Acumatica contract-based REST API usually means the login call failed or the session cookie was not sent back, and an API login limit error means too many API sessions are open for your license. Post to /entity/auth/login with name, password and company, reuse the cookie, and always call /entity/auth/logout when done. For integrations, prefer OAuth 2.0 through a Connected Application.
How-toHow to Create a Generic Inquiry in Acumatica
Generic Inquiries (GI) are Acumatica's no-code query builder for joining tables, adding filters, and exposing the result as an inquiry screen, dashboard data source, or API endpoint. Open System > Customization > Generic Inquiry, add your base table, define joins and conditions, then run and save. No SQL or customization project is required.
Error fixFix Odoo AccessError: You Are Not Allowed to Access Records
Odoo raises AccessError when a user's security groups do not grant a CRUD right on a model through ir.model.access.csv, or when an ir.rule record rule filters the specific record out for that user or company. Fix it by adding the user to the group named in the error, editing the model's access rights, or reviewing the record rule's domain under Settings > Technical > Security.
How-toHow to Void a Check in Sage 100
Sage 100 voids checks through Accounts Payable > Main > Check and Payment Voiding. Select the bank code, choose the check number, and Sage reverses the Cash Disbursements Journal entry and reopens the invoice it paid. A check that already cleared in Bank Reconciliation or falls in a closed period needs an extra step before it can be voided cleanly.
AI for ERPAI for Odoo Manufacturing That Reads Your Own Database, Not a Vendor's Cloud
Add grounded, natural-language AI to Odoo Manufacturing without sending MRP, BoM, or work order data to a public model. On-prem or private cloud, ORM-native.
AI for ERPAI shop floor assistant for operators working inside your ERP
An on-prem AI copilot answers operator questions against your ERP work instructions, travelers, and routings in plain language, at the machine, without a screen full of menus.
Stuck on MRPeasy?
Talk to engineers who work inside MRPeasy every week, and who build private AI that answers these questions from your own ERP data.
Keep exploring
Free tools
- MRPeasy vs Katana Selection ScorecardA 10-question fit test that scores how much planning depth and shop floor control your operation needs, to compare MRPeasy and Katana style cloud MRPs.
- ERPNext REST API BOM and Stock Query GeneratorBuild ERPNext REST requests with correct filters and fields for BOMs, stock bins and work orders, ready to paste into curl or Postman.
- OpenAPI Spec Skeleton Generator for ERP EndpointsCreate an OpenAPI 3.0 YAML starting point for an ERP resource with list and get operations, paging and a record schema.
ERP fixes and how-tos
- MRPeasy Custom FieldsHow to approach custom fields in MRPeasy on items, customer orders and BOMs: where to add them, what they can drive, reporting limits and API alternatives.
- Fishbowl Inventory API Documentation: Auth, Endpoints and ExamplesA practical guide to the Fishbowl Inventory REST API: where the docs live, how login and tokens work, the main endpoints and example requests you can try.
- Katana MRP Integrations and the MRPeasy REST APIKatana MRP integrations and the MRPeasy REST API: what the Shopify, accounting and marketplace connectors sync, where the API fits and how to avoid sync gaps.
Guides
- SyteLine REST API Development: Working with IDO EndpointsPractical SyteLine REST API development guide: calling IDO endpoints over REST, token authentication, JSON payloads, filter syntax, and error handling.
- How to Set Up SyteLine REST API EndpointsComplete guide to configuring REST API endpoints in SyteLine CloudSuite Industrial. Learn IDO-based API exposure, authentication, rate limiting, and endpoint security.
- SyteLine REST API Development GuideBuild REST API integrations with Infor SyteLine. Access IDOs via REST endpoints, configure OAuth 2.0 authentication, and implement CRUD operations efficiently.
Integrations
- How to add AI agents to MRPeasyHow to add AI agents to MRPeasy using its REST API: PO expediting, shortage triage and quote drafting, with human approval before any write-back.
- How to connect Power BI to MRPeasyConnect Power BI to MRPeasy via the REST API or a data warehouse, with key manufacturing dashboards, refresh and gateway notes, and natural-language Q&A.
Software
- MRPeasyMRPeasy is a cloud MRP and ERP system for small manufacturers. See its modules, integrations, limitations and alternatives for shortlisting.
- KatanaKatana is a cloud inventory and manufacturing system for small product makers. See its modules, integrations, limits and alternatives before you choose.