MRPeasy API

MRPeasy has a REST API, it is accessible in Unlimited pricing plan for paying clients. It allows to create new objects or view, update and delete them using standard methods.

Disclaimer! Our API is an Application Programming Interface. This is not a function of the MRPeasy software. Our Support Department cannot help you using the API. To use it, you must have your own highly qualified software development partner.

Requests must be in UTF-8.

Response data is JSON encoded in UTF-8.

Also, API can return the following codes:

• 401 - Unauthorized. Please see section Authentication for details.
• 429 - Too Many Requests. MRPeasy allows one request per client at a time. In this case please retry the same request after previous request is completed. Also, MRPeasy allows 100 requests per 10 seconds only.
• 503 - MRPeasy is under maintenance. In this case please retry the same request later.

Authentication

MRPeasy REST API uses Basic access authentication. Each request must contain the HTTP header Authorization:

Authorization: Basic base64([api-key]:[api-secret])

• api-key - your MRPeasy API key, that can be found in Settings - Integration - API access;
• api-secret - a secret key that can be defined in Settings - Integration - API access. Please note that it must be confidential. Never give it to anybody. We will never ask you for this key.
  We advise to change this key from time to time. If you do not need to do API requests all the time, we advise do delete it after each usage. Empty API access key disables API and this increases security.

For example:

api-key: z1g41b3d0a7c2
api-secret: AbC123

Authorization: Basic ejFnNDFiM2QwYTdjMjpBYkMxMjM=

Typically, we would write a cUrl request as follows:

curl -X "GET" "https://api.mrpeasy.com/rest/v1/items" \
-H 'content-type: application/json' \
-u 'z1g41b3d0a7c2:AbC123'

curl -X "PUT" "https://api.mrpeasy.com/rest/v1/items/5" \
-H 'content-type: application/json' \
-u 'z1g41b3d0a7c2:AbC123' \
-d '{"selling_price": "2.54"}'

In the examples above, you can replace the URLs with the ones you find from the documentation. In case of a PUT request, there is a payload (the last parameter -d). You can supply it with any field found in the documentation for the corresponding URL.

Objects

MRPeasy REST API provides the access to the following objects:

• Bills of materials
• Customer orders
• Customers
• Manufacturing orders
• Parameters
• Product groups
• Purchase orders
• Relations
• RMA orders
• Routings
• Sales invoices
• Serial numbers
• Shipments
• Stock items
• Stock lots
• Units of measurement
• Users actions
• Vendors
• Work station types
• Work stations

Bills of materials

https://api.mrpeasy.com/rest/v1/boms

Sample POST data

• product_id=1&components%5B0%5D%5Barticle_id%5D=2&components%5B0%5D%5Bquantity%5D=5&components%5B0%5D%5Bord%5D=1&components%5B1%5D%5Barticle_id%5D=3&components%5B1%5D%5Bquantity%5D=7&components%5B1%5D%5Bord%5D=2
• { "product_id": 1, "components": [ { "article_id": 2, "quantity": 5, "ord": 1 }, { "article_id": 3, "quantity": 7, "ord": 2 } ] }

Customer orders

https://api.mrpeasy.com/rest/v1/customer-orders[?cust_ord_id=...&code=...]

To create a customer order, provide the following data:

• customer_id;
• products
  • article_id - whether article_id from MRPeasy database;
    sku - or SKU that must match part number in MRPeasy;
    product_id with param [parameter_id => value_id, parameter_id => value_id, ...] - or, if Matrix BOM is turned on, product_id from MRPeasy database with array of parameters.
  • quantity;
  • total_price_cur
• status - optional. If the status is Confirmed (30) or greater, the software tries to book available products from stock immediately. If the status is Shipped (70) or Delivered (80), and products are booked, the software creates a shipment document and picks products from the stock.
• site_id - optional, integer. If provided, products are booked from this site. Otherwise, products are booked from the customer order's site.
• lot_id - optional, integer or array. If provided, products are booked from these stock lots. Otherwise, products are booked from any stock lots.
• location_id - optional, integer or array. If provided, products are booked from these storage locations. Otherwise, products are booked from any storage location.
• Other fields not marked as read-only may also be provided.

Sample POST data

• customer_id=1&status=30&products%5B0%5D%5Barticle_id%5D=2&products%5B0%5D%5Bquantity%5D=5&products%5B0%5D%5Btotal_price_cur%5D=100&products%5B1%5D%5Barticle_id%5D=3&products%5B1%5D%5Bquantity%5D=7&products%5B1%5D%5Btotal_price_cur%5D=70
• { "customer_id": 1, "status": 30, "products": [ { "article_id": 2, "quantity": 5, "total_price_cur": 100 }, { "article_id": 3, "quantity": 7, "total_price_cur": 70 } ] }

Customers

https://api.mrpeasy.com/rest/v1/customers[?code=...&title=...]

Customers can be added, viewed, and updated. Only GET, POST, and PUT methods are supported. Other methods are disabled.

To create a customer, provide the following data:

• title;
• contact_data
  • type;
  • value

Sample POST data

• title=Tester&contact_data%5B0%5D%5Btype%5D=phone&contact_data%5B0%5D%5Bvalue%5D=123456789&contact_data%5B1%5D%5Btype%5D=email&contact_data%5B1%5D%5Bvalue%5D=info%40tester.com&contact_data%5B2%5D%5Btype%5D=address&contact_data%5B2%5D%5Bvalue%5D%5Bfirst_name%5D=John&contact_data%5B2%5D%5Bvalue%5D%5Blast_name%5D=Doe&contact_data%5B2%5D%5Bvalue%5D%5Bcompany%5D=JD+Ltd&contact_data%5B2%5D%5Bvalue%5D%5Bstreet_line_1%5D=123+Maple+Street&contact_data%5B2%5D%5Bvalue%5D%5Bstreet_line_2%5D=&contact_data%5B2%5D%5Bvalue%5D%5Bcity%5D=Any-town&contact_data%5B2%5D%5Bvalue%5D%5Bpostal_code%5D=17101&contact_data%5B2%5D%5Bvalue%5D%5Bstate%5D=PA&contact_data%5B2%5D%5Bvalue%5D%5Bcountry_code%5D=US&contact_data%5B2%5D%5Bvalue%5D%5Bphone%5D=999-999-9999
• { "title": "Tester", "contact_data": [ { "type": "phone", "value": "123456789" }, { "type": "email", "value": "info@tester.com" }, { "type": "address", "value": { "first_name": "John", "last_name": "Doe", "company": "JD Ltd", "street_line_1": "123 Maple Street", "street_line_2": "", "city": "Any-town", "postal_code": "17101", "state": "PA", "country_code": "US", "phone": "999-999-9999" } } ] }

Manufacturing orders

https://api.mrpeasy.com/rest/v1/manufacturing-orders[?man_ord_id=...&code=...]

To add a manufacturing order, provide the following data:

• article_id;
• quantity;
• assigned_id;
• site_id (only if Enterprise function "Multiple Production Sites/Stocks" is enabled);
• no_bookings - optional, if the Professional function "Unscheduled Manufacturing Orders" is enabled, and the value is 1, parts will not be booked;
• no_scheduling - optional, if the Professional function "Unscheduled Manufacturing Orders" is enabled, and the value is 1, workstations will not be booked.

Sample POST data

• article_id=1&quantity=10&assigned_id=3&site_id=1
• { "article_id": 1, "quantity": 10, "assigned_id": 3, "site_id": 1 }

Via API, it is possible to update the following fields only. Other changed must be done in the software.

• code;
• quantity;
• due_date;
• assigned_id;
• custom fields.

Parameters

https://api.mrpeasy.com/rest/v1/parameters[?parameter_id=...&title=...]

Sample POST data

• title=Size&changes_quantity=1&values%5B0%5D%5Bcode%5D=s&values%5B0%5D%5Bvalue%5D=S&values%5B0%5D%5Bord%5D=1&values%5B1%5D%5Bcode%5D=m&values%5B1%5D%5Bvalue%5D=M&values%5B1%5D%5Bord%5D=2&values%5B2%5D%5Bcode%5D=l&values%5B2%5D%5Bvalue%5D=L&values%5B2%5D%5Bord%5D=3&values%5B3%5D%5Bcode%5D=xl&values%5B3%5D%5Bvalue%5D=XL&values%5B3%5D%5Bord%5D=4
• { "title": "Size", "changes_quantity": true, "values": [ { "code": "s", "value": "S", "ord": 1 }, { "code": "m", "value": "M", "ord": 2 }, { "code": "l", "value": "L", "ord": 3 }, { "code": "xl", "value": "XL", "ord": 4 } ] }

Product groups

https://api.mrpeasy.com/rest/v1/product-groups[?group_id=...&code=...]

Sample POST data

• title=Ready+products
• { "title": "Ready products" }

Purchase orders

https://api.mrpeasy.com/rest/v1/purchase-orders[?pur_ord_id=...&code=...]

Purchase orders are read-only. Only GET method is supported. Other methods are disabled.

Relations

https://api.mrpeasy.com/rest/v1/relations[?relation_id=...&code=...]

Sample POST data

• title=Relation+A&lines%5B0%5D%5Barticle_id%5D=2&lines%5B0%5D%5Bord%5D=1&lines%5B0%5D%5Bvalues%5D%5B0%5D%5Bparameter_id%5D=1&lines%5B0%5D%5Bvalues%5D%5B0%5D%5Bvalue_id%5D=11&lines%5B0%5D%5Bvalues%5D%5B1%5D%5Bparameter_id%5D=2&lines%5B0%5D%5Bvalues%5D%5B1%5D%5Bvalue_id%5D=21&lines%5B1%5D%5Barticle_id%5D=3&lines%5B1%5D%5Bord%5D=2&lines%5B1%5D%5Bvalues%5D%5B0%5D%5Bparameter_id%5D=1&lines%5B1%5D%5Bvalues%5D%5B0%5D%5Bvalue_id%5D=12&lines%5B1%5D%5Bvalues%5D%5B1%5D%5Bparameter_id%5D=2&lines%5B1%5D%5Bvalues%5D%5B1%5D%5Bvalue_id%5D=22
• { "title": "Relation A", "lines": [ { "article_id": 2, "ord": 1, "values": [ { "parameter_id": 1, "value_id": 11 }, { "parameter_id": 2, "value_id": 21 } ] }, { "article_id": 3, "ord": 2, "values": [ { "parameter_id": 1, "value_id": 12 }, { "parameter_id": 2, "value_id": 22 } ] } ] }

RMA orders

https://api.mrpeasy.com/rest/v1/rma[?rma_ord_id=...&code=...]

Routings

https://api.mrpeasy.com/rest/v1/routings

Sample POST data

• product_id=1&title=Routing+A&operations%5B0%5D%5Btype_id%5D=1&operations%5B0%5D%5Bord%5D=1&operations%5B0%5D%5Bvariable_time%5D=30&operations%5B1%5D%5Btype_id%5D=4&operations%5B1%5D%5Bord%5D=2&operations%5B1%5D%5Bvariable_time%5D=60
• { "product_id": 1, "title": "Routing A", "operations": [ { "type_id": 1, "ord": 1, "variable_time": 30 }, { "type_id": 4, "ord": 2, "variable_time": 60 } ] }

Sales invoices

https://api.mrpeasy.com/rest/v1/invoices[?invoice=...&code=...]

Serial numbers

https://api.mrpeasy.com/rest/v1/serials[?serial_id=...&serial=...]

Serial numbers are read-only. Only GET method is supported. Other methods are disabled.

Shipments

https://api.mrpeasy.com/rest/v1/shipments[?shipment_id=...&code=...]

Shipments are read-only. Only GET method is supported. Other methods are disabled.

It is not possible to create a shipment directly. To ship the entire customer order, please update a CO and set the status 70 Shipped or 80 Delivered. This will create a shipment with all products and pick it up.

Stock items

https://api.mrpeasy.com/rest/v1/items[?article_id=...&code=...]

Sample POST data

• title=Wooden+table&unit_id=5&group_id=3&is_raw=0
• { "title": "Wooden table", "unit_id": 5, "group_id": 3, "is_raw": false }

Stock lots

https://api.mrpeasy.com/rest/v1/lots[?lot_id=...&code=...]

Stock lots are read-only. Only GET method is supported. Other methods are disabled.

Units of measurement

https://api.mrpeasy.com/rest/v1/units

Sample POST data

• title=pcs
• { "title": "pcs" }

User actions

https://api.mrpeasy.com/rest/v1/users/actions[?log_id=...&created_min=...]

User actions are read-only. Only GET method is supported. Other methods are disabled.

It is possible to get a list of all possible activities by making a GET request to https://api.mrpeasy.com/rest/v1/users/actions/list.

Vendors

https://api.mrpeasy.com/rest/v1/vendors

Purchase orders are read-only. Only GET method is supported. Other methods are disabled.

* the default period is this year. To change the period, set the GET parameters start and end (YYYY-MM-DD).

Work station types

https://api.mrpeasy.com/rest/v1/work-center-types

Sample POST data

• title=Bench
• { "title": "Bench" }

Work stations

https://api.mrpeasy.com/rest/v1/work-centers

Sample POST data

• type_id=2&title=Bench+1
• { "type_id": 2, "title": "Bench 1" }

Inventory

To fetch inventory, make a GET request to https://api.mrpeasy.com/rest/v1/stock/inventory. This returns a list of stock items with on hand quantities and costs.

To fetch inventory at a specific date, add a date parameter to request URL (for example, https://api.mrpeasy.com/rest/v1/stock/inventory?date=2024-01-01).

To fetch on hand quantity of a particular stock item, use request URL https://api.mrpeasy.com/rest/v1/stock/inventory/[article_id] (replace [article_id] with a number).

To get a total cost of inventory make a request to URL https://api.mrpeasy.com/rest/v1/stock/inventory/sum. A DATE parameter can be used to receive total cost at a specific date.

The following parameters can be added to a request URL to filter the result:

• group_id
• group_code
• group_title
• site_id

For example: https://api.mrpeasy.com/rest/v1/stock/inventory?group_id=1&site_id=2

Reports

MRPeasy API provides access to some reports.

To fetch a report, make a GET request to https://api.mrpeasy.com/rest/v1/report/[REPORT_TYPE].

The default period for reports is current month. You can adjust the period by setting dates like https://api.mrpeasy.com/rest/v1/report/[REPORT_TYPE]?from=2024 -01-01&to=2024-01-31. Maximum period length is one month.

The following reports are available:

Sample request:

https://api.mrpeasy.com/rest/v1/report/production/products?from=2024 -01-01&to=2024-01-31.

Sample response:

Object (
[from] => 2024-01-01
[to] => 2024 -01-31
[report] => production/products
[data] => Array (...)
)

Webhooks

Webhooks can be configured in Settings - Integration - API access - Webhooks.

A webhook enables MRPeasy to send a request to a provided URL whenever the status of a Customer order, Manufacturing order, Purchase order, or Shipment changes.

To set up a webhook, please provide the following information:

• URL - the endpoint where the webhook data will be sent.
• Object - customer, manufacturing, purchase order, or shipment.
• Action - depending on object, Status changed or Payment status changed events are supported.
• HTTP auth username - optional, if your URL requires authentication, you can provide the username here.
• HTTP auth password - optional, along with the username, you can provide the authentication password.

Up to 5 webhooks can be configured in total.

Code sample

Download a sample API client in PHP.

If cUrl is not configured to validate SSL certificates, please uncomment lines 279 and 280.

Troubleshooting

HTTP Response Code 403 returned

The 403 response code is returned when a GET request includes a body or a content-length header.

This commonly occurs when a client employs a single cURL session for multiple requests, and a GET request follows a prior POST or PUT request. By default, cURL accumulates request headers and includes all headers from preceding requests. Consequently, a POST or PUT request appends the content-length header, and the subsequent GET request is transmitted with this unintended header.

To avoid this issue, use the --next option in subsequent requests ( curl_reset in PHP ). This ensures that the headers are appropriately managed, preventing the inadvertent inclusion of headers from previous requests.

Are HTTP header names lowercase or Pascal-Case?

According to HTTP/2 standard, all headers are lowercase.